1 use crate::structs::CommentView;
7 NullableExpressionMethods,
8 PgTextExpressionMethods,
11 use diesel_async::RunQueryDsl;
12 use diesel_ltree::{nlevel, subpath, Ltree, LtreeExtensions};
13 use lemmy_db_schema::{
14 aggregates::structs::CommentAggregates,
15 newtypes::{CommentId, CommunityId, LocalUserId, PersonId, PostId},
31 comment::{Comment, CommentSaved},
32 community::{Community, CommunityFollower, CommunityPersonBan},
33 local_user::LocalUser,
35 person_block::PersonBlock,
39 utils::{functions::hot_rank, fuzzy_search, get_conn, limit_and_offset_unlimited, DbPool},
43 use typed_builder::TypedBuilder;
45 type CommentViewTuple = (
51 Option<CommunityPersonBan>,
52 Option<CommunityFollower>,
61 comment_id: CommentId,
62 my_person_id: Option<PersonId>,
63 ) -> Result<Self, Error> {
64 let conn = &mut get_conn(pool).await?;
66 // The left join below will return None in this case
67 let person_id_join = my_person_id.unwrap_or(PersonId(-1));
75 creator_banned_from_community,
82 .inner_join(person::table)
83 .inner_join(post::table)
84 .inner_join(community::table.on(post::community_id.eq(community::id)))
85 .inner_join(comment_aggregates::table)
87 community_person_ban::table.on(
89 .eq(community_person_ban::community_id)
90 .and(community_person_ban::person_id.eq(comment::creator_id)),
94 community_follower::table.on(
96 .eq(community_follower::community_id)
97 .and(community_follower::person_id.eq(person_id_join)),
101 comment_saved::table.on(
103 .eq(comment_saved::comment_id)
104 .and(comment_saved::person_id.eq(person_id_join)),
108 person_block::table.on(
110 .eq(person_block::target_id)
111 .and(person_block::person_id.eq(person_id_join)),
115 comment_like::table.on(
117 .eq(comment_like::comment_id)
118 .and(comment_like::person_id.eq(person_id_join)),
122 comment::all_columns,
125 community::all_columns,
126 comment_aggregates::all_columns,
127 community_person_ban::all_columns.nullable(),
128 community_follower::all_columns.nullable(),
129 comment_saved::all_columns.nullable(),
130 person_block::all_columns.nullable(),
131 comment_like::score.nullable(),
133 .first::<CommentViewTuple>(conn)
136 // If a person is given, then my_vote, if None, should be 0, not null
137 // Necessary to differentiate between other person's votes
138 let my_vote = if my_person_id.is_some() && comment_like.is_none() {
150 creator_banned_from_community: creator_banned_from_community.is_some(),
151 subscribed: CommunityFollower::to_subscribed_type(&follower),
152 saved: saved.is_some(),
153 creator_blocked: creator_blocked.is_some(),
159 #[derive(TypedBuilder)]
160 #[builder(field_defaults(default))]
161 pub struct CommentQuery<'a> {
164 listing_type: Option<ListingType>,
165 sort: Option<CommentSortType>,
166 community_id: Option<CommunityId>,
167 post_id: Option<PostId>,
168 parent_path: Option<Ltree>,
169 creator_id: Option<PersonId>,
170 local_user: Option<&'a LocalUser>,
171 search_term: Option<String>,
172 saved_only: Option<bool>,
173 show_deleted_and_removed: Option<bool>,
176 max_depth: Option<i32>,
179 impl<'a> CommentQuery<'a> {
180 pub async fn list(self) -> Result<Vec<CommentView>, Error> {
181 let conn = &mut get_conn(self.pool).await?;
183 // The left join below will return None in this case
184 let person_id_join = self.local_user.map(|l| l.person_id).unwrap_or(PersonId(-1));
185 let local_user_id_join = self.local_user.map(|l| l.id).unwrap_or(LocalUserId(-1));
187 let mut query = comment::table
188 .inner_join(person::table)
189 .inner_join(post::table)
190 .inner_join(community::table.on(post::community_id.eq(community::id)))
191 .inner_join(comment_aggregates::table)
193 community_person_ban::table.on(
195 .eq(community_person_ban::community_id)
196 .and(community_person_ban::person_id.eq(comment::creator_id)),
200 community_follower::table.on(
202 .eq(community_follower::community_id)
203 .and(community_follower::person_id.eq(person_id_join)),
207 comment_saved::table.on(
209 .eq(comment_saved::comment_id)
210 .and(comment_saved::person_id.eq(person_id_join)),
214 person_block::table.on(
216 .eq(person_block::target_id)
217 .and(person_block::person_id.eq(person_id_join)),
221 community_block::table.on(
223 .eq(community_block::community_id)
224 .and(community_block::person_id.eq(person_id_join)),
228 comment_like::table.on(
230 .eq(comment_like::comment_id)
231 .and(comment_like::person_id.eq(person_id_join)),
235 local_user_language::table.on(
237 .eq(local_user_language::language_id)
238 .and(local_user_language::local_user_id.eq(local_user_id_join)),
242 comment::all_columns,
245 community::all_columns,
246 comment_aggregates::all_columns,
247 community_person_ban::all_columns.nullable(),
248 community_follower::all_columns.nullable(),
249 comment_saved::all_columns.nullable(),
250 person_block::all_columns.nullable(),
251 comment_like::score.nullable(),
255 if let Some(creator_id) = self.creator_id {
256 query = query.filter(comment::creator_id.eq(creator_id));
259 if let Some(post_id) = self.post_id {
260 query = query.filter(comment::post_id.eq(post_id));
263 if let Some(parent_path) = self.parent_path.as_ref() {
264 query = query.filter(comment::path.contained_by(parent_path));
267 if let Some(search_term) = self.search_term {
268 query = query.filter(comment::content.ilike(fuzzy_search(&search_term)));
271 if let Some(community_id) = self.community_id {
272 query = query.filter(post::community_id.eq(community_id));
275 if let Some(listing_type) = self.listing_type {
277 ListingType::Subscribed => {
278 query = query.filter(community_follower::person_id.is_not_null())
279 } // TODO could be this: and(community_follower::person_id.eq(person_id_join)),
280 ListingType::Local => {
281 query = query.filter(community::local.eq(true)).filter(
284 .or(community_follower::person_id.eq(person_id_join)),
287 ListingType::All => {
288 query = query.filter(
291 .or(community_follower::person_id.eq(person_id_join)),
297 if self.saved_only.unwrap_or(false) {
298 query = query.filter(comment_saved::comment_id.is_not_null());
301 if !self.show_deleted_and_removed.unwrap_or(true) {
302 query = query.filter(comment::deleted.eq(false));
303 query = query.filter(comment::removed.eq(false));
306 if !self.local_user.map(|l| l.show_bot_accounts).unwrap_or(true) {
307 query = query.filter(person::bot_account.eq(false));
310 if self.local_user.is_some() {
311 // Filter out the rows with missing languages
312 query = query.filter(local_user_language::language_id.is_not_null());
314 // Don't show blocked communities or persons
315 if self.post_id.is_none() {
316 query = query.filter(community_block::person_id.is_null());
318 query = query.filter(person_block::person_id.is_null());
321 // A Max depth given means its a tree fetch
322 let (limit, offset) = if let Some(max_depth) = self.max_depth {
323 let depth_limit = if let Some(parent_path) = self.parent_path.as_ref() {
324 parent_path.0.split('.').count() as i32 + max_depth
325 // Add one because of root "0"
330 query = query.filter(nlevel(comment::path).le(depth_limit));
332 // Always order by the parent path first
333 query = query.order_by(subpath(comment::path, 0, -1));
335 // TODO limit question. Limiting does not work for comment threads ATM, only max_depth
336 // For now, don't do any limiting for tree fetches
337 // https://stackoverflow.com/questions/72983614/postgres-ltree-how-to-limit-the-max-number-of-children-at-any-given-level
339 // Don't use the regular error-checking one, many more comments must ofter be fetched.
340 // This does not work for comment trees, and the limit should be manually set to a high number
342 // If a max depth is given, then you know its a tree fetch, and limits should be ignored
345 limit_and_offset_unlimited(self.page, self.limit)
348 query = match self.sort.unwrap_or(CommentSortType::Hot) {
349 CommentSortType::Hot => query
350 .then_order_by(hot_rank(comment_aggregates::score, comment_aggregates::published).desc())
351 .then_order_by(comment_aggregates::published.desc()),
352 CommentSortType::New => query.then_order_by(comment::published.desc()),
353 CommentSortType::Old => query.then_order_by(comment::published.asc()),
354 CommentSortType::Top => query.order_by(comment_aggregates::score.desc()),
357 // Note: deleted and removed comments are done on the front side
361 .load::<CommentViewTuple>(conn)
364 Ok(res.into_iter().map(CommentView::from_tuple).collect())
368 impl JoinView for CommentView {
369 type JoinTuple = CommentViewTuple;
370 fn from_tuple(a: Self::JoinTuple) -> Self {
377 creator_banned_from_community: a.5.is_some(),
378 subscribed: CommunityFollower::to_subscribed_type(&a.6),
379 saved: a.7.is_some(),
380 creator_blocked: a.8.is_some(),
388 use crate::comment_view::{
400 use lemmy_db_schema::{
401 aggregates::structs::CommentAggregates,
402 impls::actor_language::UNDETERMINED_ID,
403 newtypes::LanguageId,
405 actor_language::LocalUserLanguage,
406 comment::{CommentInsertForm, CommentLike, CommentLikeForm},
407 community::CommunityInsertForm,
410 local_user::LocalUserInsertForm,
411 person::PersonInsertForm,
412 person_block::PersonBlockForm,
413 post::PostInsertForm,
415 traits::{Blockable, Crud, Likeable},
416 utils::build_db_pool_for_tests,
419 use serial_test::serial;
422 inserted_instance: Instance,
423 inserted_comment_0: Comment,
424 inserted_comment_1: Comment,
425 inserted_comment_2: Comment,
427 inserted_person: Person,
428 inserted_local_user: LocalUser,
429 inserted_person_2: Person,
430 inserted_community: Community,
433 async fn init_data(pool: &DbPool) -> Data {
434 let inserted_instance = Instance::read_or_create(pool, "my_domain.tld".to_string())
438 let new_person = PersonInsertForm::builder()
439 .name("timmy".into())
440 .public_key("pubkey".to_string())
441 .instance_id(inserted_instance.id)
443 let inserted_person = Person::create(pool, &new_person).await.unwrap();
444 let local_user_form = LocalUserInsertForm::builder()
445 .person_id(inserted_person.id)
446 .password_encrypted(String::new())
448 let inserted_local_user = LocalUser::create(pool, &local_user_form).await.unwrap();
450 let new_person_2 = PersonInsertForm::builder()
452 .public_key("pubkey".to_string())
453 .instance_id(inserted_instance.id)
455 let inserted_person_2 = Person::create(pool, &new_person_2).await.unwrap();
457 let new_community = CommunityInsertForm::builder()
458 .name("test community 5".to_string())
459 .title("nada".to_owned())
460 .public_key("pubkey".to_string())
461 .instance_id(inserted_instance.id)
464 let inserted_community = Community::create(pool, &new_community).await.unwrap();
466 let new_post = PostInsertForm::builder()
467 .name("A test post 2".into())
468 .creator_id(inserted_person.id)
469 .community_id(inserted_community.id)
472 let inserted_post = Post::create(pool, &new_post).await.unwrap();
473 let english_id = Language::read_id_from_code(pool, Some("en")).await.unwrap();
475 // Create a comment tree with this hierarchy
483 let comment_form_0 = CommentInsertForm::builder()
484 .content("Comment 0".into())
485 .creator_id(inserted_person.id)
486 .post_id(inserted_post.id)
487 .language_id(english_id)
490 let inserted_comment_0 = Comment::create(pool, &comment_form_0, None).await.unwrap();
492 let comment_form_1 = CommentInsertForm::builder()
493 .content("Comment 1, A test blocked comment".into())
494 .creator_id(inserted_person_2.id)
495 .post_id(inserted_post.id)
496 .language_id(english_id)
499 let inserted_comment_1 = Comment::create(pool, &comment_form_1, Some(&inserted_comment_0.path))
503 let finnish_id = Language::read_id_from_code(pool, Some("fi")).await.unwrap();
504 let comment_form_2 = CommentInsertForm::builder()
505 .content("Comment 2".into())
506 .creator_id(inserted_person.id)
507 .post_id(inserted_post.id)
508 .language_id(finnish_id)
511 let inserted_comment_2 = Comment::create(pool, &comment_form_2, Some(&inserted_comment_0.path))
515 let comment_form_3 = CommentInsertForm::builder()
516 .content("Comment 3".into())
517 .creator_id(inserted_person.id)
518 .post_id(inserted_post.id)
519 .language_id(english_id)
522 let _inserted_comment_3 =
523 Comment::create(pool, &comment_form_3, Some(&inserted_comment_1.path))
527 let polish_id = Language::read_id_from_code(pool, Some("pl"))
531 let comment_form_4 = CommentInsertForm::builder()
532 .content("Comment 4".into())
533 .creator_id(inserted_person.id)
534 .post_id(inserted_post.id)
535 .language_id(Some(polish_id))
538 let inserted_comment_4 = Comment::create(pool, &comment_form_4, Some(&inserted_comment_1.path))
542 let comment_form_5 = CommentInsertForm::builder()
543 .content("Comment 5".into())
544 .creator_id(inserted_person.id)
545 .post_id(inserted_post.id)
548 let _inserted_comment_5 =
549 Comment::create(pool, &comment_form_5, Some(&inserted_comment_4.path))
553 let timmy_blocks_sara_form = PersonBlockForm {
554 person_id: inserted_person.id,
555 target_id: inserted_person_2.id,
558 let inserted_block = PersonBlock::block(pool, &timmy_blocks_sara_form)
562 let expected_block = PersonBlock {
563 id: inserted_block.id,
564 person_id: inserted_person.id,
565 target_id: inserted_person_2.id,
566 published: inserted_block.published,
568 assert_eq!(expected_block, inserted_block);
570 let comment_like_form = CommentLikeForm {
571 comment_id: inserted_comment_0.id,
572 post_id: inserted_post.id,
573 person_id: inserted_person.id,
577 let _inserted_comment_like = CommentLike::like(pool, &comment_like_form).await.unwrap();
594 async fn test_crud() {
595 let pool = &build_db_pool_for_tests().await;
596 let data = init_data(pool).await;
598 let expected_comment_view_no_person = expected_comment_view(&data, pool).await;
600 let mut expected_comment_view_with_person = expected_comment_view_no_person.clone();
601 expected_comment_view_with_person.my_vote = Some(1);
603 let read_comment_views_no_person = CommentQuery::builder()
605 .sort(Some(CommentSortType::Hot))
606 .post_id(Some(data.inserted_post.id))
613 expected_comment_view_no_person,
614 read_comment_views_no_person[0]
617 let read_comment_views_with_person = CommentQuery::builder()
619 .sort(Some(CommentSortType::Hot))
620 .post_id(Some(data.inserted_post.id))
621 .local_user(Some(&data.inserted_local_user))
628 expected_comment_view_with_person,
629 read_comment_views_with_person[0]
632 // Make sure its 1, not showing the blocked comment
633 assert_eq!(5, read_comment_views_with_person.len());
635 let read_comment_from_blocked_person = CommentView::read(
637 data.inserted_comment_1.id,
638 Some(data.inserted_person.id),
643 // Make sure block set the creator blocked
644 assert!(read_comment_from_blocked_person.creator_blocked);
646 cleanup(data, pool).await;
651 async fn test_comment_tree() {
652 let pool = &build_db_pool_for_tests().await;
653 let data = init_data(pool).await;
655 let top_path = data.inserted_comment_0.path.clone();
656 let read_comment_views_top_path = CommentQuery::builder()
658 .post_id(Some(data.inserted_post.id))
659 .parent_path(Some(top_path))
665 let child_path = data.inserted_comment_1.path.clone();
666 let read_comment_views_child_path = CommentQuery::builder()
668 .post_id(Some(data.inserted_post.id))
669 .parent_path(Some(child_path))
675 // Make sure the comment parent-limited fetch is correct
676 assert_eq!(6, read_comment_views_top_path.len());
677 assert_eq!(4, read_comment_views_child_path.len());
679 // Make sure it contains the parent, but not the comment from the other tree
680 let child_comments = read_comment_views_child_path
683 .collect::<Vec<Comment>>();
684 assert!(child_comments.contains(&data.inserted_comment_1));
685 assert!(!child_comments.contains(&data.inserted_comment_2));
687 let read_comment_views_top_max_depth = CommentQuery::builder()
689 .post_id(Some(data.inserted_post.id))
696 // Make sure a depth limited one only has the top comment
698 expected_comment_view(&data, pool).await,
699 read_comment_views_top_max_depth[0]
701 assert_eq!(1, read_comment_views_top_max_depth.len());
703 let child_path = data.inserted_comment_1.path.clone();
704 let read_comment_views_parent_max_depth = CommentQuery::builder()
706 .post_id(Some(data.inserted_post.id))
707 .parent_path(Some(child_path))
709 .sort(Some(CommentSortType::New))
715 // Make sure a depth limited one, and given child comment 1, has 3
716 assert!(read_comment_views_parent_max_depth[2]
720 assert_eq!(3, read_comment_views_parent_max_depth.len());
722 cleanup(data, pool).await;
727 async fn test_languages() {
728 let pool = &build_db_pool_for_tests().await;
729 let data = init_data(pool).await;
731 // by default, user has all languages enabled and should see all comments
732 // (except from blocked user)
733 let all_languages = CommentQuery::builder()
735 .local_user(Some(&data.inserted_local_user))
740 assert_eq!(5, all_languages.len());
742 // change user lang to finnish, should only show one post in finnish and one undetermined
743 let finnish_id = Language::read_id_from_code(pool, Some("fi"))
747 LocalUserLanguage::update(pool, vec![finnish_id], data.inserted_local_user.id)
750 let finnish_comments = CommentQuery::builder()
752 .local_user(Some(&data.inserted_local_user))
757 assert_eq!(2, finnish_comments.len());
758 let finnish_comment = finnish_comments
760 .find(|c| c.comment.language_id == finnish_id);
761 assert!(finnish_comment.is_some());
763 data.inserted_comment_2.content,
764 finnish_comment.unwrap().comment.content
767 // now show all comments with undetermined language (which is the default value)
768 LocalUserLanguage::update(pool, vec![UNDETERMINED_ID], data.inserted_local_user.id)
771 let undetermined_comment = CommentQuery::builder()
773 .local_user(Some(&data.inserted_local_user))
778 assert_eq!(1, undetermined_comment.len());
780 cleanup(data, pool).await;
783 async fn cleanup(data: Data, pool: &DbPool) {
784 CommentLike::remove(pool, data.inserted_person.id, data.inserted_comment_0.id)
787 Comment::delete(pool, data.inserted_comment_0.id)
790 Comment::delete(pool, data.inserted_comment_1.id)
793 Post::delete(pool, data.inserted_post.id).await.unwrap();
794 Community::delete(pool, data.inserted_community.id)
797 Person::delete(pool, data.inserted_person.id).await.unwrap();
798 Person::delete(pool, data.inserted_person_2.id)
801 Instance::delete(pool, data.inserted_instance.id)
806 async fn expected_comment_view(data: &Data, pool: &DbPool) -> CommentView {
807 let agg = CommentAggregates::read(pool, data.inserted_comment_0.id)
811 creator_banned_from_community: false,
813 subscribed: SubscribedType::NotSubscribed,
815 creator_blocked: false,
817 id: data.inserted_comment_0.id,
818 content: "Comment 0".into(),
819 creator_id: data.inserted_person.id,
820 post_id: data.inserted_post.id,
823 published: data.inserted_comment_0.published,
824 ap_id: data.inserted_comment_0.ap_id.clone(),
827 distinguished: false,
828 path: data.inserted_comment_0.clone().path,
829 language_id: LanguageId(37),
832 id: data.inserted_person.id,
833 name: "timmy".into(),
835 published: data.inserted_person.published,
837 actor_id: data.inserted_person.actor_id.clone(),
846 inbox_url: data.inserted_person.inbox_url.clone(),
847 shared_inbox_url: None,
848 matrix_user_id: None,
850 instance_id: data.inserted_instance.id,
851 private_key: data.inserted_person.private_key.clone(),
852 public_key: data.inserted_person.public_key.clone(),
853 last_refreshed_at: data.inserted_person.last_refreshed_at,
856 id: data.inserted_post.id,
857 name: data.inserted_post.name.clone(),
858 creator_id: data.inserted_person.id,
861 published: data.inserted_post.published,
863 community_id: data.inserted_community.id,
869 embed_description: None,
870 embed_video_url: None,
872 ap_id: data.inserted_post.ap_id.clone(),
874 language_id: Default::default(),
875 featured_community: false,
876 featured_local: false,
878 community: Community {
879 id: data.inserted_community.id,
880 name: "test community 5".to_string(),
885 actor_id: data.inserted_community.actor_id.clone(),
887 title: "nada".to_owned(),
892 posting_restricted_to_mods: false,
893 published: data.inserted_community.published,
894 instance_id: data.inserted_instance.id,
895 private_key: data.inserted_community.private_key.clone(),
896 public_key: data.inserted_community.public_key.clone(),
897 last_refreshed_at: data.inserted_community.last_refreshed_at,
898 followers_url: data.inserted_community.followers_url.clone(),
899 inbox_url: data.inserted_community.inbox_url.clone(),
900 shared_inbox_url: data.inserted_community.shared_inbox_url.clone(),
901 moderators_url: data.inserted_community.moderators_url.clone(),
902 featured_url: data.inserted_community.featured_url.clone(),
904 counts: CommentAggregates {
906 comment_id: data.inserted_comment_0.id,
910 published: agg.published,