1 use diesel::{result::Error, *};
2 use lemmy_db_queries::{
3 aggregates::comment_aggregates::CommentAggregates,
13 use lemmy_db_schema::{
28 comment::{Comment, CommentAlias1, CommentSaved},
29 community::{Community, CommunityFollower, CommunityPersonBan, CommunitySafe},
30 person::{Person, PersonAlias1, PersonSafe, PersonSafeAlias1},
40 #[derive(Debug, PartialEq, Serialize, Clone)]
41 pub struct CommentView {
43 pub creator: PersonSafe,
44 pub recipient: Option<PersonSafeAlias1>, // Left joins to comment and person
46 pub community: CommunitySafe,
47 pub counts: CommentAggregates,
48 pub creator_banned_from_community: bool, // Left Join to CommunityPersonBan
49 pub subscribed: bool, // Left join to CommunityFollower
50 pub saved: bool, // Left join to CommentSaved
51 pub my_vote: Option<i16>, // Left join to CommentLike
54 type CommentViewTuple = (
57 Option<CommentAlias1>,
58 Option<PersonSafeAlias1>,
62 Option<CommunityPersonBan>,
63 Option<CommunityFollower>,
71 comment_id: CommentId,
72 my_person_id: Option<PersonId>,
73 ) -> Result<Self, Error> {
74 // The left join below will return None in this case
75 let person_id_join = my_person_id.unwrap_or(PersonId(-1));
85 creator_banned_from_community,
91 .inner_join(person::table)
93 .left_join(comment_alias_1::table.on(comment_alias_1::id.nullable().eq(comment::parent_id)))
94 .left_join(person_alias_1::table.on(person_alias_1::id.eq(comment_alias_1::creator_id)))
95 .inner_join(post::table)
96 .inner_join(community::table.on(post::community_id.eq(community::id)))
97 .inner_join(comment_aggregates::table)
99 community_person_ban::table.on(
101 .eq(community_person_ban::community_id)
102 .and(community_person_ban::person_id.eq(comment::creator_id)),
106 community_follower::table.on(
108 .eq(community_follower::community_id)
109 .and(community_follower::person_id.eq(person_id_join)),
113 comment_saved::table.on(
115 .eq(comment_saved::comment_id)
116 .and(comment_saved::person_id.eq(person_id_join)),
120 comment_like::table.on(
122 .eq(comment_like::comment_id)
123 .and(comment_like::person_id.eq(person_id_join)),
127 comment::all_columns,
128 Person::safe_columns_tuple(),
129 comment_alias_1::all_columns.nullable(),
130 PersonAlias1::safe_columns_tuple().nullable(),
132 Community::safe_columns_tuple(),
133 comment_aggregates::all_columns,
134 community_person_ban::all_columns.nullable(),
135 community_follower::all_columns.nullable(),
136 comment_saved::all_columns.nullable(),
137 comment_like::score.nullable(),
139 .first::<CommentViewTuple>(conn)?;
141 // If a person is given, then my_vote, if None, should be 0, not null
142 // Necessary to differentiate between other person's votes
143 let my_vote = if my_person_id.is_some() && comment_like.is_none() {
156 creator_banned_from_community: creator_banned_from_community.is_some(),
157 subscribed: subscribed.is_some(),
158 saved: saved.is_some(),
163 /// Gets the recipient person id.
164 /// If there is no parent comment, its the post creator
165 pub fn get_recipient_id(&self) -> PersonId {
166 match &self.recipient {
167 Some(parent_commenter) => parent_commenter.id,
168 None => self.post.creator_id,
173 pub struct CommentQueryBuilder<'a> {
174 conn: &'a PgConnection,
175 listing_type: Option<ListingType>,
176 sort: Option<SortType>,
177 community_id: Option<CommunityId>,
178 community_name: Option<String>,
179 post_id: Option<PostId>,
180 creator_id: Option<PersonId>,
181 recipient_id: Option<PersonId>,
182 my_person_id: Option<PersonId>,
183 search_term: Option<String>,
184 saved_only: Option<bool>,
185 unread_only: Option<bool>,
186 show_bot_accounts: Option<bool>,
191 impl<'a> CommentQueryBuilder<'a> {
192 pub fn create(conn: &'a PgConnection) -> Self {
193 CommentQueryBuilder {
198 community_name: None,
206 show_bot_accounts: None,
212 pub fn listing_type<T: MaybeOptional<ListingType>>(mut self, listing_type: T) -> Self {
213 self.listing_type = listing_type.get_optional();
217 pub fn sort<T: MaybeOptional<SortType>>(mut self, sort: T) -> Self {
218 self.sort = sort.get_optional();
222 pub fn post_id<T: MaybeOptional<PostId>>(mut self, post_id: T) -> Self {
223 self.post_id = post_id.get_optional();
227 pub fn creator_id<T: MaybeOptional<PersonId>>(mut self, creator_id: T) -> Self {
228 self.creator_id = creator_id.get_optional();
232 pub fn recipient_id<T: MaybeOptional<PersonId>>(mut self, recipient_id: T) -> Self {
233 self.recipient_id = recipient_id.get_optional();
237 pub fn community_id<T: MaybeOptional<CommunityId>>(mut self, community_id: T) -> Self {
238 self.community_id = community_id.get_optional();
242 pub fn my_person_id<T: MaybeOptional<PersonId>>(mut self, my_person_id: T) -> Self {
243 self.my_person_id = my_person_id.get_optional();
247 pub fn community_name<T: MaybeOptional<String>>(mut self, community_name: T) -> Self {
248 self.community_name = community_name.get_optional();
252 pub fn search_term<T: MaybeOptional<String>>(mut self, search_term: T) -> Self {
253 self.search_term = search_term.get_optional();
257 pub fn saved_only<T: MaybeOptional<bool>>(mut self, saved_only: T) -> Self {
258 self.saved_only = saved_only.get_optional();
262 pub fn unread_only<T: MaybeOptional<bool>>(mut self, unread_only: T) -> Self {
263 self.unread_only = unread_only.get_optional();
267 pub fn show_bot_accounts<T: MaybeOptional<bool>>(mut self, show_bot_accounts: T) -> Self {
268 self.show_bot_accounts = show_bot_accounts.get_optional();
272 pub fn page<T: MaybeOptional<i64>>(mut self, page: T) -> Self {
273 self.page = page.get_optional();
277 pub fn limit<T: MaybeOptional<i64>>(mut self, limit: T) -> Self {
278 self.limit = limit.get_optional();
282 pub fn list(self) -> Result<Vec<CommentView>, Error> {
285 // The left join below will return None in this case
286 let person_id_join = self.my_person_id.unwrap_or(PersonId(-1));
288 let mut query = comment::table
289 .inner_join(person::table)
291 .left_join(comment_alias_1::table.on(comment_alias_1::id.nullable().eq(comment::parent_id)))
292 .left_join(person_alias_1::table.on(person_alias_1::id.eq(comment_alias_1::creator_id)))
293 .inner_join(post::table)
294 .inner_join(community::table.on(post::community_id.eq(community::id)))
295 .inner_join(comment_aggregates::table)
297 community_person_ban::table.on(
299 .eq(community_person_ban::community_id)
300 .and(community_person_ban::person_id.eq(comment::creator_id)),
304 community_follower::table.on(
306 .eq(community_follower::community_id)
307 .and(community_follower::person_id.eq(person_id_join)),
311 comment_saved::table.on(
313 .eq(comment_saved::comment_id)
314 .and(comment_saved::person_id.eq(person_id_join)),
318 comment_like::table.on(
320 .eq(comment_like::comment_id)
321 .and(comment_like::person_id.eq(person_id_join)),
325 comment::all_columns,
326 Person::safe_columns_tuple(),
327 comment_alias_1::all_columns.nullable(),
328 PersonAlias1::safe_columns_tuple().nullable(),
330 Community::safe_columns_tuple(),
331 comment_aggregates::all_columns,
332 community_person_ban::all_columns.nullable(),
333 community_follower::all_columns.nullable(),
334 comment_saved::all_columns.nullable(),
335 comment_like::score.nullable(),
340 if let Some(recipient_id) = self.recipient_id {
342 // TODO needs lots of testing
343 .filter(person_alias_1::id.eq(recipient_id)) // Gets the comment replies
347 .and(post::creator_id.eq(recipient_id)),
348 ) // Gets the top level replies
349 .filter(comment::deleted.eq(false))
350 .filter(comment::removed.eq(false));
353 if self.unread_only.unwrap_or(false) {
354 query = query.filter(comment::read.eq(false));
357 if let Some(creator_id) = self.creator_id {
358 query = query.filter(comment::creator_id.eq(creator_id));
361 if let Some(community_id) = self.community_id {
362 query = query.filter(post::community_id.eq(community_id));
365 if let Some(community_name) = self.community_name {
367 .filter(community::name.eq(community_name))
368 .filter(comment::local.eq(true));
371 if let Some(post_id) = self.post_id {
372 query = query.filter(comment::post_id.eq(post_id));
375 if let Some(search_term) = self.search_term {
376 query = query.filter(comment::content.ilike(fuzzy_search(&search_term)));
379 if let Some(listing_type) = self.listing_type {
380 query = match listing_type {
381 ListingType::Subscribed => query.filter(community_follower::person_id.is_not_null()), // TODO could be this: and(community_follower::person_id.eq(person_id_join)),
382 ListingType::Local => query.filter(community::local.eq(true)),
387 if self.saved_only.unwrap_or(false) {
388 query = query.filter(comment_saved::id.is_not_null());
391 if !self.show_bot_accounts.unwrap_or(true) {
392 query = query.filter(person::bot_account.eq(false));
395 query = match self.sort.unwrap_or(SortType::New) {
396 SortType::Hot | SortType::Active => query
397 .order_by(hot_rank(comment_aggregates::score, comment_aggregates::published).desc())
398 .then_order_by(comment_aggregates::published.desc()),
399 SortType::New | SortType::MostComments | SortType::NewComments => {
400 query.order_by(comment::published.desc())
402 SortType::TopAll => query.order_by(comment_aggregates::score.desc()),
403 SortType::TopYear => query
404 .filter(comment::published.gt(now - 1.years()))
405 .order_by(comment_aggregates::score.desc()),
406 SortType::TopMonth => query
407 .filter(comment::published.gt(now - 1.months()))
408 .order_by(comment_aggregates::score.desc()),
409 SortType::TopWeek => query
410 .filter(comment::published.gt(now - 1.weeks()))
411 .order_by(comment_aggregates::score.desc()),
412 SortType::TopDay => query
413 .filter(comment::published.gt(now - 1.days()))
414 .order_by(comment_aggregates::score.desc()),
417 let (limit, offset) = limit_and_offset(self.page, self.limit);
419 // Note: deleted and removed comments are done on the front side
423 .load::<CommentViewTuple>(self.conn)?;
425 Ok(CommentView::from_tuple_to_vec(res))
429 impl ViewToVec for CommentView {
430 type DbTuple = CommentViewTuple;
431 fn from_tuple_to_vec(items: Vec<Self::DbTuple>) -> Vec<Self> {
435 comment: a.0.to_owned(),
436 creator: a.1.to_owned(),
437 recipient: a.3.to_owned(),
438 post: a.4.to_owned(),
439 community: a.5.to_owned(),
440 counts: a.6.to_owned(),
441 creator_banned_from_community: a.7.is_some(),
442 subscribed: a.8.is_some(),
443 saved: a.9.is_some(),
446 .collect::<Vec<Self>>()
452 use crate::comment_view::*;
453 use lemmy_db_queries::{
454 aggregates::comment_aggregates::CommentAggregates,
455 establish_unpooled_connection,
459 use lemmy_db_schema::source::{comment::*, community::*, person::*, post::*};
460 use serial_test::serial;
465 let conn = establish_unpooled_connection();
467 let new_person = PersonForm {
468 name: "timmy".into(),
469 ..PersonForm::default()
472 let inserted_person = Person::create(&conn, &new_person).unwrap();
474 let new_community = CommunityForm {
475 name: "test community 5".to_string(),
476 title: "nada".to_owned(),
477 ..CommunityForm::default()
480 let inserted_community = Community::create(&conn, &new_community).unwrap();
482 let new_post = PostForm {
483 name: "A test post 2".into(),
484 creator_id: inserted_person.id,
485 community_id: inserted_community.id,
486 ..PostForm::default()
489 let inserted_post = Post::create(&conn, &new_post).unwrap();
491 let comment_form = CommentForm {
492 content: "A test comment 32".into(),
493 creator_id: inserted_person.id,
494 post_id: inserted_post.id,
495 ..CommentForm::default()
498 let inserted_comment = Comment::create(&conn, &comment_form).unwrap();
500 let comment_like_form = CommentLikeForm {
501 comment_id: inserted_comment.id,
502 post_id: inserted_post.id,
503 person_id: inserted_person.id,
507 let _inserted_comment_like = CommentLike::like(&conn, &comment_like_form).unwrap();
509 let agg = CommentAggregates::read(&conn, inserted_comment.id).unwrap();
511 let expected_comment_view_no_person = CommentView {
512 creator_banned_from_community: false,
517 id: inserted_comment.id,
518 content: "A test comment 32".into(),
519 creator_id: inserted_person.id,
520 post_id: inserted_post.id,
525 published: inserted_comment.published,
526 ap_id: inserted_comment.ap_id,
530 creator: PersonSafe {
531 id: inserted_person.id,
532 name: "timmy".into(),
534 published: inserted_person.published,
536 actor_id: inserted_person.actor_id.to_owned(),
545 inbox_url: inserted_person.inbox_url.to_owned(),
546 shared_inbox_url: None,
547 matrix_user_id: None,
551 id: inserted_post.id,
552 name: inserted_post.name.to_owned(),
553 creator_id: inserted_person.id,
556 published: inserted_post.published,
558 community_id: inserted_community.id,
565 embed_description: None,
568 ap_id: inserted_post.ap_id.to_owned(),
571 community: CommunitySafe {
572 id: inserted_community.id,
573 name: "test community 5".to_string(),
578 actor_id: inserted_community.actor_id.to_owned(),
580 title: "nada".to_owned(),
584 published: inserted_community.published,
586 counts: CommentAggregates {
588 comment_id: inserted_comment.id,
592 published: agg.published,
596 let mut expected_comment_view_with_person = expected_comment_view_no_person.to_owned();
597 expected_comment_view_with_person.my_vote = Some(1);
599 let read_comment_views_no_person = CommentQueryBuilder::create(&conn)
600 .post_id(inserted_post.id)
604 let read_comment_views_with_person = CommentQueryBuilder::create(&conn)
605 .post_id(inserted_post.id)
606 .my_person_id(inserted_person.id)
610 let like_removed = CommentLike::remove(&conn, inserted_person.id, inserted_comment.id).unwrap();
611 let num_deleted = Comment::delete(&conn, inserted_comment.id).unwrap();
612 Post::delete(&conn, inserted_post.id).unwrap();
613 Community::delete(&conn, inserted_community.id).unwrap();
614 Person::delete(&conn, inserted_person.id).unwrap();
617 expected_comment_view_no_person,
618 read_comment_views_no_person[0]
621 expected_comment_view_with_person,
622 read_comment_views_with_person[0]
624 assert_eq!(1, num_deleted);
625 assert_eq!(1, like_removed);