1 use crate::structs::CommentView;
8 NullableExpressionMethods,
9 PgTextExpressionMethods,
12 use diesel_async::RunQueryDsl;
13 use diesel_ltree::{nlevel, subpath, Ltree, LtreeExtensions};
14 use lemmy_db_schema::{
15 aggregates::structs::CommentAggregates,
16 newtypes::{CommentId, CommunityId, DbUrl, LocalUserId, PersonId, PostId},
32 comment::{Comment, CommentSaved},
33 community::{Community, CommunityFollower, CommunityPersonBan, CommunitySafe},
34 local_user::LocalUser,
35 person::{Person, PersonSafe},
36 person_block::PersonBlock,
39 traits::{ToSafe, ViewToVec},
40 utils::{functions::hot_rank, fuzzy_search, get_conn, limit_and_offset_unlimited, DbPool},
44 use typed_builder::TypedBuilder;
46 type CommentViewTuple = (
52 Option<CommunityPersonBan>,
53 Option<CommunityFollower>,
62 comment_id: CommentId,
63 my_person_id: Option<PersonId>,
64 ) -> Result<Self, Error> {
65 let conn = &mut get_conn(pool).await?;
67 // The left join below will return None in this case
68 let person_id_join = my_person_id.unwrap_or(PersonId(-1));
76 creator_banned_from_community,
83 .inner_join(person::table)
84 .inner_join(post::table)
85 .inner_join(community::table.on(post::community_id.eq(community::id)))
86 .inner_join(comment_aggregates::table)
88 community_person_ban::table.on(
90 .eq(community_person_ban::community_id)
91 .and(community_person_ban::person_id.eq(comment::creator_id))
93 community_person_ban::expires
95 .or(community_person_ban::expires.gt(now)),
100 community_follower::table.on(
102 .eq(community_follower::community_id)
103 .and(community_follower::person_id.eq(person_id_join)),
107 comment_saved::table.on(
109 .eq(comment_saved::comment_id)
110 .and(comment_saved::person_id.eq(person_id_join)),
114 person_block::table.on(
116 .eq(person_block::target_id)
117 .and(person_block::person_id.eq(person_id_join)),
121 comment_like::table.on(
123 .eq(comment_like::comment_id)
124 .and(comment_like::person_id.eq(person_id_join)),
128 comment::all_columns,
129 Person::safe_columns_tuple(),
131 Community::safe_columns_tuple(),
132 comment_aggregates::all_columns,
133 community_person_ban::all_columns.nullable(),
134 community_follower::all_columns.nullable(),
135 comment_saved::all_columns.nullable(),
136 person_block::all_columns.nullable(),
137 comment_like::score.nullable(),
139 .first::<CommentViewTuple>(conn)
142 // If a person is given, then my_vote, if None, should be 0, not null
143 // Necessary to differentiate between other person's votes
144 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: CommunityFollower::to_subscribed_type(&follower),
158 saved: saved.is_some(),
159 creator_blocked: creator_blocked.is_some(),
165 #[derive(TypedBuilder)]
166 #[builder(field_defaults(default))]
167 pub struct CommentQuery<'a> {
170 listing_type: Option<ListingType>,
171 sort: Option<CommentSortType>,
172 community_id: Option<CommunityId>,
173 community_actor_id: Option<DbUrl>,
174 post_id: Option<PostId>,
175 parent_path: Option<Ltree>,
176 creator_id: Option<PersonId>,
177 local_user: Option<&'a LocalUser>,
178 search_term: Option<String>,
179 saved_only: Option<bool>,
180 show_deleted_and_removed: Option<bool>,
183 max_depth: Option<i32>,
186 impl<'a> CommentQuery<'a> {
187 pub async fn list(self) -> Result<Vec<CommentView>, Error> {
188 let conn = &mut get_conn(self.pool).await?;
190 // The left join below will return None in this case
191 let person_id_join = self.local_user.map(|l| l.person_id).unwrap_or(PersonId(-1));
192 let local_user_id_join = self.local_user.map(|l| l.id).unwrap_or(LocalUserId(-1));
194 let mut query = comment::table
195 .inner_join(person::table)
196 .inner_join(post::table)
197 .inner_join(community::table.on(post::community_id.eq(community::id)))
198 .inner_join(comment_aggregates::table)
200 community_person_ban::table.on(
202 .eq(community_person_ban::community_id)
203 .and(community_person_ban::person_id.eq(comment::creator_id))
205 community_person_ban::expires
207 .or(community_person_ban::expires.gt(now)),
212 community_follower::table.on(
214 .eq(community_follower::community_id)
215 .and(community_follower::person_id.eq(person_id_join)),
219 comment_saved::table.on(
221 .eq(comment_saved::comment_id)
222 .and(comment_saved::person_id.eq(person_id_join)),
226 person_block::table.on(
228 .eq(person_block::target_id)
229 .and(person_block::person_id.eq(person_id_join)),
233 community_block::table.on(
235 .eq(community_block::community_id)
236 .and(community_block::person_id.eq(person_id_join)),
240 comment_like::table.on(
242 .eq(comment_like::comment_id)
243 .and(comment_like::person_id.eq(person_id_join)),
247 local_user_language::table.on(
249 .eq(local_user_language::language_id)
250 .and(local_user_language::local_user_id.eq(local_user_id_join)),
254 comment::all_columns,
255 Person::safe_columns_tuple(),
257 Community::safe_columns_tuple(),
258 comment_aggregates::all_columns,
259 community_person_ban::all_columns.nullable(),
260 community_follower::all_columns.nullable(),
261 comment_saved::all_columns.nullable(),
262 person_block::all_columns.nullable(),
263 comment_like::score.nullable(),
267 if let Some(creator_id) = self.creator_id {
268 query = query.filter(comment::creator_id.eq(creator_id));
271 if let Some(post_id) = self.post_id {
272 query = query.filter(comment::post_id.eq(post_id));
275 if let Some(parent_path) = self.parent_path.as_ref() {
276 query = query.filter(comment::path.contained_by(parent_path));
279 if let Some(search_term) = self.search_term {
280 query = query.filter(comment::content.ilike(fuzzy_search(&search_term)));
283 if let Some(listing_type) = self.listing_type {
285 ListingType::Subscribed => {
286 query = query.filter(community_follower::person_id.is_not_null())
287 } // TODO could be this: and(community_follower::person_id.eq(person_id_join)),
288 ListingType::Local => {
289 query = query.filter(community::local.eq(true)).filter(
292 .or(community_follower::person_id.eq(person_id_join)),
295 ListingType::All => {
296 query = query.filter(
299 .or(community_follower::person_id.eq(person_id_join)),
305 if let Some(community_id) = self.community_id {
306 query = query.filter(post::community_id.eq(community_id));
309 if let Some(community_actor_id) = self.community_actor_id {
310 query = query.filter(community::actor_id.eq(community_actor_id))
313 if self.saved_only.unwrap_or(false) {
314 query = query.filter(comment_saved::comment_id.is_not_null());
317 if !self.show_deleted_and_removed.unwrap_or(true) {
318 query = query.filter(comment::deleted.eq(false));
319 query = query.filter(comment::removed.eq(false));
322 if !self.local_user.map(|l| l.show_bot_accounts).unwrap_or(true) {
323 query = query.filter(person::bot_account.eq(false));
326 if self.local_user.is_some() {
327 // Filter out the rows with missing languages
328 query = query.filter(local_user_language::language_id.is_not_null());
330 // Don't show blocked communities or persons
331 query = query.filter(community_block::person_id.is_null());
332 query = query.filter(person_block::person_id.is_null());
335 // A Max depth given means its a tree fetch
336 let (limit, offset) = if let Some(max_depth) = self.max_depth {
337 let depth_limit = if let Some(parent_path) = self.parent_path.as_ref() {
338 parent_path.0.split('.').count() as i32 + max_depth
339 // Add one because of root "0"
344 query = query.filter(nlevel(comment::path).le(depth_limit));
346 // Always order by the parent path first
347 query = query.order_by(subpath(comment::path, 0, -1));
349 // TODO limit question. Limiting does not work for comment threads ATM, only max_depth
350 // For now, don't do any limiting for tree fetches
351 // https://stackoverflow.com/questions/72983614/postgres-ltree-how-to-limit-the-max-number-of-children-at-any-given-level
353 // Don't use the regular error-checking one, many more comments must ofter be fetched.
354 // This does not work for comment trees, and the limit should be manually set to a high number
356 // If a max depth is given, then you know its a tree fetch, and limits should be ignored
359 limit_and_offset_unlimited(self.page, self.limit)
362 query = match self.sort.unwrap_or(CommentSortType::Hot) {
363 CommentSortType::Hot => query
364 .then_order_by(hot_rank(comment_aggregates::score, comment_aggregates::published).desc())
365 .then_order_by(comment_aggregates::published.desc()),
366 CommentSortType::New => query.then_order_by(comment::published.desc()),
367 CommentSortType::Old => query.then_order_by(comment::published.asc()),
368 CommentSortType::Top => query.order_by(comment_aggregates::score.desc()),
371 // Note: deleted and removed comments are done on the front side
375 .load::<CommentViewTuple>(conn)
378 Ok(CommentView::from_tuple_to_vec(res))
382 impl ViewToVec for CommentView {
383 type DbTuple = CommentViewTuple;
384 fn from_tuple_to_vec(items: Vec<Self::DbTuple>) -> Vec<Self> {
393 creator_banned_from_community: a.5.is_some(),
394 subscribed: CommunityFollower::to_subscribed_type(&a.6),
395 saved: a.7.is_some(),
396 creator_blocked: a.8.is_some(),
399 .collect::<Vec<Self>>()
405 use crate::comment_view::{
419 use lemmy_db_schema::{
420 aggregates::structs::CommentAggregates,
421 impls::actor_language::UNDETERMINED_ID,
422 newtypes::LanguageId,
424 actor_language::LocalUserLanguage,
425 comment::{CommentInsertForm, CommentLike, CommentLikeForm},
426 community::CommunityInsertForm,
429 local_user::LocalUserInsertForm,
430 person::PersonInsertForm,
431 person_block::PersonBlockForm,
432 post::PostInsertForm,
434 traits::{Blockable, Crud, Likeable},
435 utils::build_db_pool_for_tests,
438 use serial_test::serial;
441 inserted_instance: Instance,
442 inserted_comment_0: Comment,
443 inserted_comment_1: Comment,
444 inserted_comment_2: Comment,
446 inserted_person: Person,
447 inserted_local_user: LocalUser,
448 inserted_person_2: Person,
449 inserted_community: Community,
452 async fn init_data(pool: &DbPool) -> Data {
453 let inserted_instance = Instance::read_or_create(pool, "my_domain.tld".to_string())
457 let new_person = PersonInsertForm::builder()
458 .name("timmy".into())
459 .public_key("pubkey".to_string())
460 .instance_id(inserted_instance.id)
462 let inserted_person = Person::create(pool, &new_person).await.unwrap();
463 let local_user_form = LocalUserInsertForm::builder()
464 .person_id(inserted_person.id)
465 .password_encrypted(String::new())
467 let inserted_local_user = LocalUser::create(pool, &local_user_form).await.unwrap();
469 let new_person_2 = PersonInsertForm::builder()
471 .public_key("pubkey".to_string())
472 .instance_id(inserted_instance.id)
474 let inserted_person_2 = Person::create(pool, &new_person_2).await.unwrap();
476 let new_community = CommunityInsertForm::builder()
477 .name("test community 5".to_string())
478 .title("nada".to_owned())
479 .public_key("pubkey".to_string())
480 .instance_id(inserted_instance.id)
483 let inserted_community = Community::create(pool, &new_community).await.unwrap();
485 let new_post = PostInsertForm::builder()
486 .name("A test post 2".into())
487 .creator_id(inserted_person.id)
488 .community_id(inserted_community.id)
491 let inserted_post = Post::create(pool, &new_post).await.unwrap();
493 // Create a comment tree with this hierarchy
501 let comment_form_0 = CommentInsertForm::builder()
502 .content("Comment 0".into())
503 .creator_id(inserted_person.id)
504 .post_id(inserted_post.id)
507 let inserted_comment_0 = Comment::create(pool, &comment_form_0, None).await.unwrap();
509 let comment_form_1 = CommentInsertForm::builder()
510 .content("Comment 1, A test blocked comment".into())
511 .creator_id(inserted_person_2.id)
512 .post_id(inserted_post.id)
515 let inserted_comment_1 = Comment::create(pool, &comment_form_1, Some(&inserted_comment_0.path))
519 let finnish_id = Language::read_id_from_code(pool, Some("fi"))
523 let comment_form_2 = CommentInsertForm::builder()
524 .content("Comment 2".into())
525 .creator_id(inserted_person.id)
526 .post_id(inserted_post.id)
527 .language_id(Some(finnish_id))
530 let inserted_comment_2 = Comment::create(pool, &comment_form_2, Some(&inserted_comment_0.path))
534 let comment_form_3 = CommentInsertForm::builder()
535 .content("Comment 3".into())
536 .creator_id(inserted_person.id)
537 .post_id(inserted_post.id)
540 let _inserted_comment_3 =
541 Comment::create(pool, &comment_form_3, Some(&inserted_comment_1.path))
545 let polish_id = Language::read_id_from_code(pool, Some("pl"))
549 let comment_form_4 = CommentInsertForm::builder()
550 .content("Comment 4".into())
551 .creator_id(inserted_person.id)
552 .post_id(inserted_post.id)
553 .language_id(Some(polish_id))
556 let inserted_comment_4 = Comment::create(pool, &comment_form_4, Some(&inserted_comment_1.path))
560 let comment_form_5 = CommentInsertForm::builder()
561 .content("Comment 5".into())
562 .creator_id(inserted_person.id)
563 .post_id(inserted_post.id)
566 let _inserted_comment_5 =
567 Comment::create(pool, &comment_form_5, Some(&inserted_comment_4.path))
571 let timmy_blocks_sara_form = PersonBlockForm {
572 person_id: inserted_person.id,
573 target_id: inserted_person_2.id,
576 let inserted_block = PersonBlock::block(pool, &timmy_blocks_sara_form)
580 let expected_block = PersonBlock {
581 id: inserted_block.id,
582 person_id: inserted_person.id,
583 target_id: inserted_person_2.id,
584 published: inserted_block.published,
586 assert_eq!(expected_block, inserted_block);
588 let comment_like_form = CommentLikeForm {
589 comment_id: inserted_comment_0.id,
590 post_id: inserted_post.id,
591 person_id: inserted_person.id,
595 let _inserted_comment_like = CommentLike::like(pool, &comment_like_form).await.unwrap();
612 async fn test_crud() {
613 let pool = &build_db_pool_for_tests().await;
614 let data = init_data(pool).await;
616 let expected_comment_view_no_person = expected_comment_view(&data, pool).await;
618 let mut expected_comment_view_with_person = expected_comment_view_no_person.clone();
619 expected_comment_view_with_person.my_vote = Some(1);
621 let read_comment_views_no_person = CommentQuery::builder()
623 .post_id(Some(data.inserted_post.id))
630 expected_comment_view_no_person,
631 read_comment_views_no_person[0]
634 let read_comment_views_with_person = CommentQuery::builder()
636 .post_id(Some(data.inserted_post.id))
637 .local_user(Some(&data.inserted_local_user))
644 expected_comment_view_with_person,
645 read_comment_views_with_person[0]
648 // Make sure its 1, not showing the blocked comment
649 assert_eq!(5, read_comment_views_with_person.len());
651 let read_comment_from_blocked_person = CommentView::read(
653 data.inserted_comment_1.id,
654 Some(data.inserted_person.id),
659 // Make sure block set the creator blocked
660 assert!(read_comment_from_blocked_person.creator_blocked);
662 cleanup(data, pool).await;
667 async fn test_comment_tree() {
668 let pool = &build_db_pool_for_tests().await;
669 let data = init_data(pool).await;
671 let top_path = data.inserted_comment_0.path.clone();
672 let read_comment_views_top_path = CommentQuery::builder()
674 .post_id(Some(data.inserted_post.id))
675 .parent_path(Some(top_path))
681 let child_path = data.inserted_comment_1.path.clone();
682 let read_comment_views_child_path = CommentQuery::builder()
684 .post_id(Some(data.inserted_post.id))
685 .parent_path(Some(child_path))
691 // Make sure the comment parent-limited fetch is correct
692 assert_eq!(6, read_comment_views_top_path.len());
693 assert_eq!(4, read_comment_views_child_path.len());
695 // Make sure it contains the parent, but not the comment from the other tree
696 let child_comments = read_comment_views_child_path
699 .collect::<Vec<Comment>>();
700 assert!(child_comments.contains(&data.inserted_comment_1));
701 assert!(!child_comments.contains(&data.inserted_comment_2));
703 let read_comment_views_top_max_depth = CommentQuery::builder()
705 .post_id(Some(data.inserted_post.id))
712 // Make sure a depth limited one only has the top comment
714 expected_comment_view(&data, pool).await,
715 read_comment_views_top_max_depth[0]
717 assert_eq!(1, read_comment_views_top_max_depth.len());
719 let child_path = data.inserted_comment_1.path.clone();
720 let read_comment_views_parent_max_depth = CommentQuery::builder()
722 .post_id(Some(data.inserted_post.id))
723 .parent_path(Some(child_path))
725 .sort(Some(CommentSortType::New))
731 // Make sure a depth limited one, and given child comment 1, has 3
732 assert!(read_comment_views_parent_max_depth[2]
736 assert_eq!(3, read_comment_views_parent_max_depth.len());
738 cleanup(data, pool).await;
743 async fn test_languages() {
744 let pool = &build_db_pool_for_tests().await;
745 let data = init_data(pool).await;
747 // by default, user has all languages enabled and should see all comments
748 // (except from blocked user)
749 let all_languages = CommentQuery::builder()
751 .local_user(Some(&data.inserted_local_user))
756 assert_eq!(5, all_languages.len());
758 // change user lang to finnish, should only show single finnish comment
759 let finnish_id = Language::read_id_from_code(pool, Some("fi"))
763 LocalUserLanguage::update(pool, vec![finnish_id], data.inserted_local_user.id)
766 let finnish_comment = CommentQuery::builder()
768 .local_user(Some(&data.inserted_local_user))
773 assert_eq!(1, finnish_comment.len());
775 data.inserted_comment_2.content,
776 finnish_comment[0].comment.content
778 assert_eq!(finnish_id, finnish_comment[0].comment.language_id);
780 // now show all comments with undetermined language (which is the default value)
781 LocalUserLanguage::update(pool, vec![UNDETERMINED_ID], data.inserted_local_user.id)
784 let undetermined_comment = CommentQuery::builder()
786 .local_user(Some(&data.inserted_local_user))
791 assert_eq!(3, undetermined_comment.len());
793 cleanup(data, pool).await;
796 async fn cleanup(data: Data, pool: &DbPool) {
797 CommentLike::remove(pool, data.inserted_person.id, data.inserted_comment_0.id)
800 Comment::delete(pool, data.inserted_comment_0.id)
803 Comment::delete(pool, data.inserted_comment_1.id)
806 Post::delete(pool, data.inserted_post.id).await.unwrap();
807 Community::delete(pool, data.inserted_community.id)
810 Person::delete(pool, data.inserted_person.id).await.unwrap();
811 Person::delete(pool, data.inserted_person_2.id)
814 Instance::delete(pool, data.inserted_instance.id)
819 async fn expected_comment_view(data: &Data, pool: &DbPool) -> CommentView {
820 let agg = CommentAggregates::read(pool, data.inserted_comment_0.id)
824 creator_banned_from_community: false,
826 subscribed: SubscribedType::NotSubscribed,
828 creator_blocked: false,
830 id: data.inserted_comment_0.id,
831 content: "Comment 0".into(),
832 creator_id: data.inserted_person.id,
833 post_id: data.inserted_post.id,
836 published: data.inserted_comment_0.published,
837 ap_id: data.inserted_comment_0.ap_id.clone(),
840 distinguished: false,
841 path: data.inserted_comment_0.clone().path,
842 language_id: LanguageId(0),
844 creator: PersonSafe {
845 id: data.inserted_person.id,
846 name: "timmy".into(),
848 published: data.inserted_person.published,
850 actor_id: data.inserted_person.actor_id.clone(),
859 inbox_url: data.inserted_person.inbox_url.clone(),
860 shared_inbox_url: None,
861 matrix_user_id: None,
863 instance_id: data.inserted_instance.id,
866 id: data.inserted_post.id,
867 name: data.inserted_post.name.clone(),
868 creator_id: data.inserted_person.id,
871 published: data.inserted_post.published,
873 community_id: data.inserted_community.id,
879 embed_description: None,
880 embed_video_url: None,
882 ap_id: data.inserted_post.ap_id.clone(),
884 language_id: Default::default(),
885 featured_community: false,
886 featured_local: false,
888 community: CommunitySafe {
889 id: data.inserted_community.id,
890 name: "test community 5".to_string(),
895 actor_id: data.inserted_community.actor_id.clone(),
897 title: "nada".to_owned(),
902 posting_restricted_to_mods: false,
903 published: data.inserted_community.published,
904 instance_id: data.inserted_instance.id,
906 counts: CommentAggregates {
908 comment_id: data.inserted_comment_0.id,
912 published: agg.published,