1 use diesel::{dsl::*, result::Error, *};
3 aggregates::comment_aggregates::CommentAggregates,
7 newtypes::{CommentId, CommunityId, DbUrl, PersonId, PostId},
24 comment::{Comment, CommentAlias1, CommentSaved},
25 community::{Community, CommunityFollower, CommunityPersonBan, CommunitySafe},
26 person::{Person, PersonAlias1, PersonSafe, PersonSafeAlias1},
27 person_block::PersonBlock,
30 traits::{MaybeOptional, ToSafe, ViewToVec},
34 use serde::{Deserialize, Serialize};
36 #[derive(Debug, PartialEq, Serialize, Deserialize, Clone)]
37 pub struct CommentView {
39 pub creator: PersonSafe,
40 pub recipient: Option<PersonSafeAlias1>, // Left joins to comment and person
42 pub community: CommunitySafe,
43 pub counts: CommentAggregates,
44 pub creator_banned_from_community: bool, // Left Join to CommunityPersonBan
45 pub subscribed: bool, // Left join to CommunityFollower
46 pub saved: bool, // Left join to CommentSaved
47 pub creator_blocked: bool, // Left join to PersonBlock
48 pub my_vote: Option<i16>, // Left join to CommentLike
51 type CommentViewTuple = (
54 Option<CommentAlias1>,
55 Option<PersonSafeAlias1>,
59 Option<CommunityPersonBan>,
60 Option<CommunityFollower>,
69 comment_id: CommentId,
70 my_person_id: Option<PersonId>,
71 ) -> Result<Self, Error> {
72 // The left join below will return None in this case
73 let person_id_join = my_person_id.unwrap_or(PersonId(-1));
83 creator_banned_from_community,
90 .inner_join(person::table)
92 .left_join(comment_alias_1::table.on(comment_alias_1::id.nullable().eq(comment::parent_id)))
93 .left_join(person_alias_1::table.on(person_alias_1::id.eq(comment_alias_1::creator_id)))
94 .inner_join(post::table)
95 .inner_join(community::table.on(post::community_id.eq(community::id)))
96 .inner_join(comment_aggregates::table)
98 community_person_ban::table.on(
100 .eq(community_person_ban::community_id)
101 .and(community_person_ban::person_id.eq(comment::creator_id))
103 community_person_ban::expires
105 .or(community_person_ban::expires.gt(now)),
110 community_follower::table.on(
112 .eq(community_follower::community_id)
113 .and(community_follower::person_id.eq(person_id_join)),
117 comment_saved::table.on(
119 .eq(comment_saved::comment_id)
120 .and(comment_saved::person_id.eq(person_id_join)),
124 person_block::table.on(
126 .eq(person_block::target_id)
127 .and(person_block::person_id.eq(person_id_join)),
131 comment_like::table.on(
133 .eq(comment_like::comment_id)
134 .and(comment_like::person_id.eq(person_id_join)),
138 comment::all_columns,
139 Person::safe_columns_tuple(),
140 comment_alias_1::all_columns.nullable(),
141 PersonAlias1::safe_columns_tuple().nullable(),
143 Community::safe_columns_tuple(),
144 comment_aggregates::all_columns,
145 community_person_ban::all_columns.nullable(),
146 community_follower::all_columns.nullable(),
147 comment_saved::all_columns.nullable(),
148 person_block::all_columns.nullable(),
149 comment_like::score.nullable(),
151 .first::<CommentViewTuple>(conn)?;
153 // If a person is given, then my_vote, if None, should be 0, not null
154 // Necessary to differentiate between other person's votes
155 let my_vote = if my_person_id.is_some() && comment_like.is_none() {
168 creator_banned_from_community: creator_banned_from_community.is_some(),
169 subscribed: subscribed.is_some(),
170 saved: saved.is_some(),
171 creator_blocked: creator_blocked.is_some(),
176 /// Gets the recipient person id.
177 /// If there is no parent comment, its the post creator
178 pub fn get_recipient_id(&self) -> PersonId {
179 match &self.recipient {
180 Some(parent_commenter) => parent_commenter.id,
181 None => self.post.creator_id,
185 /// Gets the number of unread replies
186 pub fn get_unread_replies(conn: &PgConnection, my_person_id: PersonId) -> Result<i64, Error> {
191 .left_join(comment_alias_1::table.on(comment_alias_1::id.nullable().eq(comment::parent_id)))
192 .left_join(person_alias_1::table.on(person_alias_1::id.eq(comment_alias_1::creator_id)))
193 .inner_join(post::table)
194 .inner_join(community::table.on(post::community_id.eq(community::id)))
196 person_block::table.on(
198 .eq(person_block::target_id)
199 .and(person_block::person_id.eq(my_person_id)),
203 community_block::table.on(
205 .eq(community_block::community_id)
206 .and(community_block::person_id.eq(my_person_id)),
209 .filter(person_alias_1::id.eq(my_person_id)) // Gets the comment replies
213 .and(post::creator_id.eq(my_person_id)),
214 ) // Gets the top level replies
215 .filter(comment::read.eq(false))
216 .filter(comment::deleted.eq(false))
217 .filter(comment::removed.eq(false))
218 // Don't show blocked communities or persons
219 .filter(community_block::person_id.is_null())
220 .filter(person_block::person_id.is_null())
221 .select(count(comment::id))
226 pub struct CommentQueryBuilder<'a> {
227 conn: &'a PgConnection,
228 listing_type: Option<ListingType>,
229 sort: Option<SortType>,
230 community_id: Option<CommunityId>,
231 community_actor_id: Option<DbUrl>,
232 post_id: Option<PostId>,
233 creator_id: Option<PersonId>,
234 recipient_id: Option<PersonId>,
235 my_person_id: Option<PersonId>,
236 search_term: Option<String>,
237 saved_only: Option<bool>,
238 unread_only: Option<bool>,
239 show_bot_accounts: Option<bool>,
244 impl<'a> CommentQueryBuilder<'a> {
245 pub fn create(conn: &'a PgConnection) -> Self {
246 CommentQueryBuilder {
251 community_actor_id: None,
259 show_bot_accounts: None,
265 pub fn listing_type<T: MaybeOptional<ListingType>>(mut self, listing_type: T) -> Self {
266 self.listing_type = listing_type.get_optional();
270 pub fn sort<T: MaybeOptional<SortType>>(mut self, sort: T) -> Self {
271 self.sort = sort.get_optional();
275 pub fn post_id<T: MaybeOptional<PostId>>(mut self, post_id: T) -> Self {
276 self.post_id = post_id.get_optional();
280 pub fn creator_id<T: MaybeOptional<PersonId>>(mut self, creator_id: T) -> Self {
281 self.creator_id = creator_id.get_optional();
285 pub fn recipient_id<T: MaybeOptional<PersonId>>(mut self, recipient_id: T) -> Self {
286 self.recipient_id = recipient_id.get_optional();
290 pub fn community_id<T: MaybeOptional<CommunityId>>(mut self, community_id: T) -> Self {
291 self.community_id = community_id.get_optional();
295 pub fn my_person_id<T: MaybeOptional<PersonId>>(mut self, my_person_id: T) -> Self {
296 self.my_person_id = my_person_id.get_optional();
300 pub fn community_actor_id<T: MaybeOptional<DbUrl>>(mut self, community_actor_id: T) -> Self {
301 self.community_actor_id = community_actor_id.get_optional();
305 pub fn search_term<T: MaybeOptional<String>>(mut self, search_term: T) -> Self {
306 self.search_term = search_term.get_optional();
310 pub fn saved_only<T: MaybeOptional<bool>>(mut self, saved_only: T) -> Self {
311 self.saved_only = saved_only.get_optional();
315 pub fn unread_only<T: MaybeOptional<bool>>(mut self, unread_only: T) -> Self {
316 self.unread_only = unread_only.get_optional();
320 pub fn show_bot_accounts<T: MaybeOptional<bool>>(mut self, show_bot_accounts: T) -> Self {
321 self.show_bot_accounts = show_bot_accounts.get_optional();
325 pub fn page<T: MaybeOptional<i64>>(mut self, page: T) -> Self {
326 self.page = page.get_optional();
330 pub fn limit<T: MaybeOptional<i64>>(mut self, limit: T) -> Self {
331 self.limit = limit.get_optional();
335 pub fn list(self) -> Result<Vec<CommentView>, Error> {
338 // The left join below will return None in this case
339 let person_id_join = self.my_person_id.unwrap_or(PersonId(-1));
341 let mut query = comment::table
342 .inner_join(person::table)
344 .left_join(comment_alias_1::table.on(comment_alias_1::id.nullable().eq(comment::parent_id)))
345 .left_join(person_alias_1::table.on(person_alias_1::id.eq(comment_alias_1::creator_id)))
346 .inner_join(post::table)
347 .inner_join(community::table.on(post::community_id.eq(community::id)))
348 .inner_join(comment_aggregates::table)
350 community_person_ban::table.on(
352 .eq(community_person_ban::community_id)
353 .and(community_person_ban::person_id.eq(comment::creator_id))
355 community_person_ban::expires
357 .or(community_person_ban::expires.gt(now)),
362 community_follower::table.on(
364 .eq(community_follower::community_id)
365 .and(community_follower::person_id.eq(person_id_join)),
369 comment_saved::table.on(
371 .eq(comment_saved::comment_id)
372 .and(comment_saved::person_id.eq(person_id_join)),
376 person_block::table.on(
378 .eq(person_block::target_id)
379 .and(person_block::person_id.eq(person_id_join)),
383 community_block::table.on(
385 .eq(community_block::community_id)
386 .and(community_block::person_id.eq(person_id_join)),
390 comment_like::table.on(
392 .eq(comment_like::comment_id)
393 .and(comment_like::person_id.eq(person_id_join)),
397 comment::all_columns,
398 Person::safe_columns_tuple(),
399 comment_alias_1::all_columns.nullable(),
400 PersonAlias1::safe_columns_tuple().nullable(),
402 Community::safe_columns_tuple(),
403 comment_aggregates::all_columns,
404 community_person_ban::all_columns.nullable(),
405 community_follower::all_columns.nullable(),
406 comment_saved::all_columns.nullable(),
407 person_block::all_columns.nullable(),
408 comment_like::score.nullable(),
413 if let Some(recipient_id) = self.recipient_id {
415 // TODO needs lots of testing
416 .filter(person_alias_1::id.eq(recipient_id)) // Gets the comment replies
420 .and(post::creator_id.eq(recipient_id)),
421 ) // Gets the top level replies
422 .filter(comment::deleted.eq(false))
423 .filter(comment::removed.eq(false));
426 if self.unread_only.unwrap_or(false) {
427 query = query.filter(comment::read.eq(false));
430 if let Some(creator_id) = self.creator_id {
431 query = query.filter(comment::creator_id.eq(creator_id));
434 if let Some(community_id) = self.community_id {
435 query = query.filter(post::community_id.eq(community_id));
438 if let Some(community_actor_id) = self.community_actor_id {
439 query = query.filter(community::actor_id.eq(community_actor_id))
442 if let Some(post_id) = self.post_id {
443 query = query.filter(comment::post_id.eq(post_id));
446 if let Some(search_term) = self.search_term {
447 query = query.filter(comment::content.ilike(fuzzy_search(&search_term)));
450 if let Some(listing_type) = self.listing_type {
451 query = match listing_type {
452 ListingType::Subscribed => query.filter(community_follower::person_id.is_not_null()), // TODO could be this: and(community_follower::person_id.eq(person_id_join)),
453 ListingType::Local => query.filter(community::local.eq(true)),
458 if self.saved_only.unwrap_or(false) {
459 query = query.filter(comment_saved::id.is_not_null());
462 if !self.show_bot_accounts.unwrap_or(true) {
463 query = query.filter(person::bot_account.eq(false));
466 query = match self.sort.unwrap_or(SortType::New) {
467 SortType::Hot | SortType::Active => query
468 .order_by(hot_rank(comment_aggregates::score, comment_aggregates::published).desc())
469 .then_order_by(comment_aggregates::published.desc()),
470 SortType::New | SortType::MostComments | SortType::NewComments => {
471 query.order_by(comment::published.desc())
473 SortType::TopAll => query.order_by(comment_aggregates::score.desc()),
474 SortType::TopYear => query
475 .filter(comment::published.gt(now - 1.years()))
476 .order_by(comment_aggregates::score.desc()),
477 SortType::TopMonth => query
478 .filter(comment::published.gt(now - 1.months()))
479 .order_by(comment_aggregates::score.desc()),
480 SortType::TopWeek => query
481 .filter(comment::published.gt(now - 1.weeks()))
482 .order_by(comment_aggregates::score.desc()),
483 SortType::TopDay => query
484 .filter(comment::published.gt(now - 1.days()))
485 .order_by(comment_aggregates::score.desc()),
488 // Don't show blocked communities or persons
489 if self.my_person_id.is_some() {
490 query = query.filter(community_block::person_id.is_null());
491 query = query.filter(person_block::person_id.is_null());
494 let (limit, offset) = limit_and_offset(self.page, self.limit);
496 // Note: deleted and removed comments are done on the front side
500 .load::<CommentViewTuple>(self.conn)?;
502 Ok(CommentView::from_tuple_to_vec(res))
506 impl ViewToVec for CommentView {
507 type DbTuple = CommentViewTuple;
508 fn from_tuple_to_vec(items: Vec<Self::DbTuple>) -> Vec<Self> {
512 comment: a.0.to_owned(),
513 creator: a.1.to_owned(),
514 recipient: a.3.to_owned(),
515 post: a.4.to_owned(),
516 community: a.5.to_owned(),
517 counts: a.6.to_owned(),
518 creator_banned_from_community: a.7.is_some(),
519 subscribed: a.8.is_some(),
520 saved: a.9.is_some(),
521 creator_blocked: a.10.is_some(),
524 .collect::<Vec<Self>>()
530 use crate::comment_view::*;
531 use lemmy_db_schema::{
532 aggregates::comment_aggregates::CommentAggregates,
533 establish_unpooled_connection,
534 source::{comment::*, community::*, person::*, person_block::PersonBlockForm, post::*},
535 traits::{Blockable, Crud, Likeable},
537 use serial_test::serial;
542 let conn = establish_unpooled_connection();
544 let new_person = PersonForm {
545 name: "timmy".into(),
546 ..PersonForm::default()
549 let inserted_person = Person::create(&conn, &new_person).unwrap();
551 let new_person_2 = PersonForm {
553 ..PersonForm::default()
556 let inserted_person_2 = Person::create(&conn, &new_person_2).unwrap();
558 let new_community = CommunityForm {
559 name: "test community 5".to_string(),
560 title: "nada".to_owned(),
561 ..CommunityForm::default()
564 let inserted_community = Community::create(&conn, &new_community).unwrap();
566 let new_post = PostForm {
567 name: "A test post 2".into(),
568 creator_id: inserted_person.id,
569 community_id: inserted_community.id,
570 ..PostForm::default()
573 let inserted_post = Post::create(&conn, &new_post).unwrap();
575 let comment_form = CommentForm {
576 content: "A test comment 32".into(),
577 creator_id: inserted_person.id,
578 post_id: inserted_post.id,
579 ..CommentForm::default()
582 let inserted_comment = Comment::create(&conn, &comment_form).unwrap();
584 let comment_form_2 = CommentForm {
585 content: "A test blocked comment".into(),
586 creator_id: inserted_person_2.id,
587 post_id: inserted_post.id,
588 parent_id: Some(inserted_comment.id),
589 ..CommentForm::default()
592 let inserted_comment_2 = Comment::create(&conn, &comment_form_2).unwrap();
594 let timmy_blocks_sara_form = PersonBlockForm {
595 person_id: inserted_person.id,
596 target_id: inserted_person_2.id,
599 let inserted_block = PersonBlock::block(&conn, &timmy_blocks_sara_form).unwrap();
601 let expected_block = PersonBlock {
602 id: inserted_block.id,
603 person_id: inserted_person.id,
604 target_id: inserted_person_2.id,
605 published: inserted_block.published,
608 assert_eq!(expected_block, inserted_block);
610 let comment_like_form = CommentLikeForm {
611 comment_id: inserted_comment.id,
612 post_id: inserted_post.id,
613 person_id: inserted_person.id,
617 let _inserted_comment_like = CommentLike::like(&conn, &comment_like_form).unwrap();
619 let agg = CommentAggregates::read(&conn, inserted_comment.id).unwrap();
621 let expected_comment_view_no_person = CommentView {
622 creator_banned_from_community: false,
626 creator_blocked: false,
628 id: inserted_comment.id,
629 content: "A test comment 32".into(),
630 creator_id: inserted_person.id,
631 post_id: inserted_post.id,
636 published: inserted_comment.published,
637 ap_id: inserted_comment.ap_id,
641 creator: PersonSafe {
642 id: inserted_person.id,
643 name: "timmy".into(),
645 published: inserted_person.published,
647 actor_id: inserted_person.actor_id.to_owned(),
656 inbox_url: inserted_person.inbox_url.to_owned(),
657 shared_inbox_url: None,
658 matrix_user_id: None,
663 id: inserted_post.id,
664 name: inserted_post.name.to_owned(),
665 creator_id: inserted_person.id,
668 published: inserted_post.published,
670 community_id: inserted_community.id,
677 embed_description: None,
680 ap_id: inserted_post.ap_id.to_owned(),
683 community: CommunitySafe {
684 id: inserted_community.id,
685 name: "test community 5".to_string(),
690 actor_id: inserted_community.actor_id.to_owned(),
692 title: "nada".to_owned(),
696 published: inserted_community.published,
698 counts: CommentAggregates {
700 comment_id: inserted_comment.id,
704 published: agg.published,
708 let mut expected_comment_view_with_person = expected_comment_view_no_person.to_owned();
709 expected_comment_view_with_person.my_vote = Some(1);
711 let read_comment_views_no_person = CommentQueryBuilder::create(&conn)
712 .post_id(inserted_post.id)
716 let read_comment_views_with_person = CommentQueryBuilder::create(&conn)
717 .post_id(inserted_post.id)
718 .my_person_id(inserted_person.id)
722 let read_comment_from_blocked_person =
723 CommentView::read(&conn, inserted_comment_2.id, Some(inserted_person.id)).unwrap();
725 let like_removed = CommentLike::remove(&conn, inserted_person.id, inserted_comment.id).unwrap();
726 let num_deleted = Comment::delete(&conn, inserted_comment.id).unwrap();
727 Comment::delete(&conn, inserted_comment_2.id).unwrap();
728 Post::delete(&conn, inserted_post.id).unwrap();
729 Community::delete(&conn, inserted_community.id).unwrap();
730 Person::delete(&conn, inserted_person.id).unwrap();
731 Person::delete(&conn, inserted_person_2.id).unwrap();
733 // Make sure its 1, not showing the blocked comment
734 assert_eq!(1, read_comment_views_with_person.len());
737 expected_comment_view_no_person,
738 read_comment_views_no_person[1]
741 expected_comment_view_with_person,
742 read_comment_views_with_person[0]
745 // Make sure block set the creator blocked
746 assert!(read_comment_from_blocked_person.creator_blocked);
748 assert_eq!(1, num_deleted);
749 assert_eq!(1, like_removed);