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> {
189 let conn = &mut get_conn(self.pool).await?;
191 // The left join below will return None in this case
192 let person_id_join = self.local_user.map(|l| l.person_id).unwrap_or(PersonId(-1));
193 let local_user_id_join = self.local_user.map(|l| l.id).unwrap_or(LocalUserId(-1));
195 let mut query = comment::table
196 .inner_join(person::table)
197 .inner_join(post::table)
198 .inner_join(community::table.on(post::community_id.eq(community::id)))
199 .inner_join(comment_aggregates::table)
201 community_person_ban::table.on(
203 .eq(community_person_ban::community_id)
204 .and(community_person_ban::person_id.eq(comment::creator_id))
206 community_person_ban::expires
208 .or(community_person_ban::expires.gt(now)),
213 community_follower::table.on(
215 .eq(community_follower::community_id)
216 .and(community_follower::person_id.eq(person_id_join)),
220 comment_saved::table.on(
222 .eq(comment_saved::comment_id)
223 .and(comment_saved::person_id.eq(person_id_join)),
227 person_block::table.on(
229 .eq(person_block::target_id)
230 .and(person_block::person_id.eq(person_id_join)),
234 community_block::table.on(
236 .eq(community_block::community_id)
237 .and(community_block::person_id.eq(person_id_join)),
241 comment_like::table.on(
243 .eq(comment_like::comment_id)
244 .and(comment_like::person_id.eq(person_id_join)),
248 local_user_language::table.on(
250 .eq(local_user_language::language_id)
251 .and(local_user_language::local_user_id.eq(local_user_id_join)),
255 comment::all_columns,
256 Person::safe_columns_tuple(),
258 Community::safe_columns_tuple(),
259 comment_aggregates::all_columns,
260 community_person_ban::all_columns.nullable(),
261 community_follower::all_columns.nullable(),
262 comment_saved::all_columns.nullable(),
263 person_block::all_columns.nullable(),
264 comment_like::score.nullable(),
268 if let Some(creator_id) = self.creator_id {
269 query = query.filter(comment::creator_id.eq(creator_id));
272 if let Some(post_id) = self.post_id {
273 query = query.filter(comment::post_id.eq(post_id));
276 if let Some(parent_path) = self.parent_path.as_ref() {
277 query = query.filter(comment::path.contained_by(parent_path));
280 if let Some(search_term) = self.search_term {
281 query = query.filter(comment::content.ilike(fuzzy_search(&search_term)));
284 if let Some(listing_type) = self.listing_type {
286 ListingType::Subscribed => {
287 query = query.filter(community_follower::person_id.is_not_null())
288 } // TODO could be this: and(community_follower::person_id.eq(person_id_join)),
289 ListingType::Local => {
290 query = query.filter(community::local.eq(true)).filter(
293 .or(community_follower::person_id.eq(person_id_join)),
296 ListingType::All => {
297 query = query.filter(
300 .or(community_follower::person_id.eq(person_id_join)),
306 if let Some(community_id) = self.community_id {
307 query = query.filter(post::community_id.eq(community_id));
310 if let Some(community_actor_id) = self.community_actor_id {
311 query = query.filter(community::actor_id.eq(community_actor_id))
314 if self.saved_only.unwrap_or(false) {
315 query = query.filter(comment_saved::id.is_not_null());
318 if !self.show_deleted_and_removed.unwrap_or(true) {
319 query = query.filter(comment::deleted.eq(false));
320 query = query.filter(comment::removed.eq(false));
323 if !self.local_user.map(|l| l.show_bot_accounts).unwrap_or(true) {
324 query = query.filter(person::bot_account.eq(false));
327 if self.local_user.is_some() {
328 // Filter out the rows with missing languages
329 query = query.filter(local_user_language::id.is_not_null());
331 // Don't show blocked communities or persons
332 query = query.filter(community_block::person_id.is_null());
333 query = query.filter(person_block::person_id.is_null());
336 // A Max depth given means its a tree fetch
337 let (limit, offset) = if let Some(max_depth) = self.max_depth {
338 let depth_limit = if let Some(parent_path) = self.parent_path.as_ref() {
339 parent_path.0.split('.').count() as i32 + max_depth
340 // Add one because of root "0"
345 query = query.filter(nlevel(comment::path).le(depth_limit));
347 // Always order by the parent path first
348 query = query.order_by(subpath(comment::path, 0, -1));
350 // TODO limit question. Limiting does not work for comment threads ATM, only max_depth
351 // For now, don't do any limiting for tree fetches
352 // https://stackoverflow.com/questions/72983614/postgres-ltree-how-to-limit-the-max-number-of-children-at-any-given-level
354 // Don't use the regular error-checking one, many more comments must ofter be fetched.
355 // This does not work for comment trees, and the limit should be manually set to a high number
357 // If a max depth is given, then you know its a tree fetch, and limits should be ignored
360 limit_and_offset_unlimited(self.page, self.limit)
363 query = match self.sort.unwrap_or(CommentSortType::Hot) {
364 CommentSortType::Hot => query
365 .then_order_by(hot_rank(comment_aggregates::score, comment_aggregates::published).desc())
366 .then_order_by(comment_aggregates::published.desc()),
367 CommentSortType::New => query.then_order_by(comment::published.desc()),
368 CommentSortType::Old => query.then_order_by(comment::published.asc()),
369 CommentSortType::Top => query.order_by(comment_aggregates::score.desc()),
372 // Note: deleted and removed comments are done on the front side
376 .load::<CommentViewTuple>(conn)
379 Ok(CommentView::from_tuple_to_vec(res))
383 impl ViewToVec for CommentView {
384 type DbTuple = CommentViewTuple;
385 fn from_tuple_to_vec(items: Vec<Self::DbTuple>) -> Vec<Self> {
394 creator_banned_from_community: a.5.is_some(),
395 subscribed: CommunityFollower::to_subscribed_type(&a.6),
396 saved: a.7.is_some(),
397 creator_blocked: a.8.is_some(),
400 .collect::<Vec<Self>>()
406 use crate::comment_view::*;
407 use lemmy_db_schema::{
408 aggregates::structs::CommentAggregates,
409 newtypes::LanguageId,
411 actor_language::LocalUserLanguage,
416 local_user::LocalUserInsertForm,
418 person_block::PersonBlockForm,
421 traits::{Blockable, Crud, Likeable},
422 utils::build_db_pool_for_tests,
425 use serial_test::serial;
428 inserted_instance: Instance,
429 inserted_comment_0: Comment,
430 inserted_comment_1: Comment,
431 inserted_comment_2: Comment,
433 inserted_person: Person,
434 inserted_local_user: LocalUser,
435 inserted_person_2: Person,
436 inserted_community: Community,
439 async fn init_data(pool: &DbPool) -> Data {
440 let inserted_instance = Instance::create(pool, "my_domain.tld").await.unwrap();
442 let new_person = PersonInsertForm::builder()
443 .name("timmy".into())
444 .public_key("pubkey".to_string())
445 .instance_id(inserted_instance.id)
447 let inserted_person = Person::create(pool, &new_person).await.unwrap();
448 let local_user_form = LocalUserInsertForm::builder()
449 .person_id(inserted_person.id)
450 .password_encrypted("".to_string())
452 let inserted_local_user = LocalUser::create(pool, &local_user_form).await.unwrap();
454 let new_person_2 = PersonInsertForm::builder()
456 .public_key("pubkey".to_string())
457 .instance_id(inserted_instance.id)
459 let inserted_person_2 = Person::create(pool, &new_person_2).await.unwrap();
461 let new_community = CommunityInsertForm::builder()
462 .name("test community 5".to_string())
463 .title("nada".to_owned())
464 .public_key("pubkey".to_string())
465 .instance_id(inserted_instance.id)
468 let inserted_community = Community::create(pool, &new_community).await.unwrap();
470 let new_post = PostInsertForm::builder()
471 .name("A test post 2".into())
472 .creator_id(inserted_person.id)
473 .community_id(inserted_community.id)
476 let inserted_post = Post::create(pool, &new_post).await.unwrap();
478 // Create a comment tree with this hierarchy
486 let comment_form_0 = CommentInsertForm::builder()
487 .content("Comment 0".into())
488 .creator_id(inserted_person.id)
489 .post_id(inserted_post.id)
492 let inserted_comment_0 = Comment::create(pool, &comment_form_0, None).await.unwrap();
494 let comment_form_1 = CommentInsertForm::builder()
495 .content("Comment 1, A test blocked comment".into())
496 .creator_id(inserted_person_2.id)
497 .post_id(inserted_post.id)
500 let inserted_comment_1 = Comment::create(pool, &comment_form_1, Some(&inserted_comment_0.path))
504 let finnish_id = Language::read_id_from_code(pool, "fi").await.unwrap();
505 let comment_form_2 = CommentInsertForm::builder()
506 .content("Comment 2".into())
507 .creator_id(inserted_person.id)
508 .post_id(inserted_post.id)
509 .language_id(Some(finnish_id))
512 let inserted_comment_2 = Comment::create(pool, &comment_form_2, Some(&inserted_comment_0.path))
516 let comment_form_3 = CommentInsertForm::builder()
517 .content("Comment 3".into())
518 .creator_id(inserted_person.id)
519 .post_id(inserted_post.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, "pl").await.unwrap();
528 let comment_form_4 = CommentInsertForm::builder()
529 .content("Comment 4".into())
530 .creator_id(inserted_person.id)
531 .post_id(inserted_post.id)
532 .language_id(Some(polish_id))
535 let inserted_comment_4 = Comment::create(pool, &comment_form_4, Some(&inserted_comment_1.path))
539 let comment_form_5 = CommentInsertForm::builder()
540 .content("Comment 5".into())
541 .creator_id(inserted_person.id)
542 .post_id(inserted_post.id)
545 let _inserted_comment_5 =
546 Comment::create(pool, &comment_form_5, Some(&inserted_comment_4.path))
550 let timmy_blocks_sara_form = PersonBlockForm {
551 person_id: inserted_person.id,
552 target_id: inserted_person_2.id,
555 let inserted_block = PersonBlock::block(pool, &timmy_blocks_sara_form)
559 let expected_block = PersonBlock {
560 id: inserted_block.id,
561 person_id: inserted_person.id,
562 target_id: inserted_person_2.id,
563 published: inserted_block.published,
565 assert_eq!(expected_block, inserted_block);
567 let comment_like_form = CommentLikeForm {
568 comment_id: inserted_comment_0.id,
569 post_id: inserted_post.id,
570 person_id: inserted_person.id,
574 let _inserted_comment_like = CommentLike::like(pool, &comment_like_form).await.unwrap();
591 async fn test_crud() {
592 let pool = &build_db_pool_for_tests().await;
593 let data = init_data(pool).await;
595 let expected_comment_view_no_person = expected_comment_view(&data, pool).await;
597 let mut expected_comment_view_with_person = expected_comment_view_no_person.to_owned();
598 expected_comment_view_with_person.my_vote = Some(1);
600 let read_comment_views_no_person = CommentQuery::builder()
602 .post_id(Some(data.inserted_post.id))
609 expected_comment_view_no_person,
610 read_comment_views_no_person[0]
613 let read_comment_views_with_person = CommentQuery::builder()
615 .post_id(Some(data.inserted_post.id))
616 .local_user(Some(&data.inserted_local_user))
623 expected_comment_view_with_person,
624 read_comment_views_with_person[0]
627 // Make sure its 1, not showing the blocked comment
628 assert_eq!(5, read_comment_views_with_person.len());
630 let read_comment_from_blocked_person = CommentView::read(
632 data.inserted_comment_1.id,
633 Some(data.inserted_person.id),
638 // Make sure block set the creator blocked
639 assert!(read_comment_from_blocked_person.creator_blocked);
641 cleanup(data, pool).await;
646 async fn test_comment_tree() {
647 let pool = &build_db_pool_for_tests().await;
648 let data = init_data(pool).await;
650 let top_path = data.inserted_comment_0.path.clone();
651 let read_comment_views_top_path = CommentQuery::builder()
653 .post_id(Some(data.inserted_post.id))
654 .parent_path(Some(top_path))
660 let child_path = data.inserted_comment_1.path.clone();
661 let read_comment_views_child_path = CommentQuery::builder()
663 .post_id(Some(data.inserted_post.id))
664 .parent_path(Some(child_path))
670 // Make sure the comment parent-limited fetch is correct
671 assert_eq!(6, read_comment_views_top_path.len());
672 assert_eq!(4, read_comment_views_child_path.len());
674 // Make sure it contains the parent, but not the comment from the other tree
675 let child_comments = read_comment_views_child_path
678 .collect::<Vec<Comment>>();
679 assert!(child_comments.contains(&data.inserted_comment_1));
680 assert!(!child_comments.contains(&data.inserted_comment_2));
682 let read_comment_views_top_max_depth = CommentQuery::builder()
684 .post_id(Some(data.inserted_post.id))
691 // Make sure a depth limited one only has the top comment
693 expected_comment_view(&data, pool).await,
694 read_comment_views_top_max_depth[0]
696 assert_eq!(1, read_comment_views_top_max_depth.len());
698 let child_path = data.inserted_comment_1.path.clone();
699 let read_comment_views_parent_max_depth = CommentQuery::builder()
701 .post_id(Some(data.inserted_post.id))
702 .parent_path(Some(child_path))
704 .sort(Some(CommentSortType::New))
710 // Make sure a depth limited one, and given child comment 1, has 3
711 assert!(read_comment_views_parent_max_depth[2]
715 assert_eq!(3, read_comment_views_parent_max_depth.len());
717 cleanup(data, pool).await;
722 async fn test_languages() {
723 let pool = &build_db_pool_for_tests().await;
724 let data = init_data(pool).await;
726 // by default, user has all languages enabled and should see all comments
727 // (except from blocked user)
728 let all_languages = CommentQuery::builder()
730 .local_user(Some(&data.inserted_local_user))
735 assert_eq!(5, all_languages.len());
737 // change user lang to finnish, should only show single finnish comment
738 let finnish_id = Language::read_id_from_code(pool, "fi").await.unwrap();
739 LocalUserLanguage::update(pool, vec![finnish_id], data.inserted_local_user.id)
742 let finnish_comment = CommentQuery::builder()
744 .local_user(Some(&data.inserted_local_user))
749 assert_eq!(1, finnish_comment.len());
751 data.inserted_comment_2.content,
752 finnish_comment[0].comment.content
754 assert_eq!(finnish_id, finnish_comment[0].comment.language_id);
756 // now show all comments with undetermined language (which is the default value)
757 let undetermined_id = Language::read_id_from_code(pool, "und").await.unwrap();
758 LocalUserLanguage::update(pool, vec![undetermined_id], data.inserted_local_user.id)
761 let undetermined_comment = CommentQuery::builder()
763 .local_user(Some(&data.inserted_local_user))
768 assert_eq!(3, undetermined_comment.len());
770 cleanup(data, pool).await;
773 async fn cleanup(data: Data, pool: &DbPool) {
774 CommentLike::remove(pool, data.inserted_person.id, data.inserted_comment_0.id)
777 Comment::delete(pool, data.inserted_comment_0.id)
780 Comment::delete(pool, data.inserted_comment_1.id)
783 Post::delete(pool, data.inserted_post.id).await.unwrap();
784 Community::delete(pool, data.inserted_community.id)
787 Person::delete(pool, data.inserted_person.id).await.unwrap();
788 Person::delete(pool, data.inserted_person_2.id)
791 Instance::delete(pool, data.inserted_instance.id)
796 async fn expected_comment_view(data: &Data, pool: &DbPool) -> CommentView {
797 let agg = CommentAggregates::read(pool, data.inserted_comment_0.id)
801 creator_banned_from_community: false,
803 subscribed: SubscribedType::NotSubscribed,
805 creator_blocked: false,
807 id: data.inserted_comment_0.id,
808 content: "Comment 0".into(),
809 creator_id: data.inserted_person.id,
810 post_id: data.inserted_post.id,
813 published: data.inserted_comment_0.published,
814 ap_id: data.inserted_comment_0.ap_id.clone(),
817 distinguished: false,
818 path: data.inserted_comment_0.to_owned().path,
819 language_id: LanguageId(0),
821 creator: PersonSafe {
822 id: data.inserted_person.id,
823 name: "timmy".into(),
825 published: data.inserted_person.published,
827 actor_id: data.inserted_person.actor_id.to_owned(),
836 inbox_url: data.inserted_person.inbox_url.to_owned(),
837 shared_inbox_url: None,
838 matrix_user_id: None,
840 instance_id: data.inserted_instance.id,
843 id: data.inserted_post.id,
844 name: data.inserted_post.name.to_owned(),
845 creator_id: data.inserted_person.id,
848 published: data.inserted_post.published,
850 community_id: data.inserted_community.id,
857 embed_description: None,
858 embed_video_url: None,
860 ap_id: data.inserted_post.ap_id.to_owned(),
862 language_id: Default::default(),
864 community: CommunitySafe {
865 id: data.inserted_community.id,
866 name: "test community 5".to_string(),
871 actor_id: data.inserted_community.actor_id.to_owned(),
873 title: "nada".to_owned(),
878 posting_restricted_to_mods: false,
879 published: data.inserted_community.published,
880 instance_id: data.inserted_instance.id,
882 counts: CommentAggregates {
884 comment_id: data.inserted_comment_0.id,
888 published: agg.published,