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: ListingType,
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>,
190 impl<'a> CommentQueryBuilder<'a> {
191 pub fn create(conn: &'a PgConnection) -> Self {
192 CommentQueryBuilder {
194 listing_type: ListingType::All,
195 sort: &SortType::New,
197 community_name: None,
210 pub fn listing_type(mut self, listing_type: ListingType) -> Self {
211 self.listing_type = listing_type;
215 pub fn sort(mut self, sort: &'a SortType) -> Self {
220 pub fn post_id<T: MaybeOptional<PostId>>(mut self, post_id: T) -> Self {
221 self.post_id = post_id.get_optional();
225 pub fn creator_id<T: MaybeOptional<PersonId>>(mut self, creator_id: T) -> Self {
226 self.creator_id = creator_id.get_optional();
230 pub fn recipient_id<T: MaybeOptional<PersonId>>(mut self, recipient_id: T) -> Self {
231 self.recipient_id = recipient_id.get_optional();
235 pub fn community_id<T: MaybeOptional<CommunityId>>(mut self, community_id: T) -> Self {
236 self.community_id = community_id.get_optional();
240 pub fn my_person_id<T: MaybeOptional<PersonId>>(mut self, my_person_id: T) -> Self {
241 self.my_person_id = my_person_id.get_optional();
245 pub fn community_name<T: MaybeOptional<String>>(mut self, community_name: T) -> Self {
246 self.community_name = community_name.get_optional();
250 pub fn search_term<T: MaybeOptional<String>>(mut self, search_term: T) -> Self {
251 self.search_term = search_term.get_optional();
255 pub fn saved_only(mut self, saved_only: bool) -> Self {
256 self.saved_only = saved_only;
260 pub fn unread_only(mut self, unread_only: bool) -> Self {
261 self.unread_only = unread_only;
265 pub fn page<T: MaybeOptional<i64>>(mut self, page: T) -> Self {
266 self.page = page.get_optional();
270 pub fn limit<T: MaybeOptional<i64>>(mut self, limit: T) -> Self {
271 self.limit = limit.get_optional();
275 pub fn list(self) -> Result<Vec<CommentView>, Error> {
278 // The left join below will return None in this case
279 let person_id_join = self.my_person_id.unwrap_or(PersonId(-1));
281 let mut query = comment::table
282 .inner_join(person::table)
284 .left_join(comment_alias_1::table.on(comment_alias_1::id.nullable().eq(comment::parent_id)))
285 .left_join(person_alias_1::table.on(person_alias_1::id.eq(comment_alias_1::creator_id)))
286 .inner_join(post::table)
287 .inner_join(community::table.on(post::community_id.eq(community::id)))
288 .inner_join(comment_aggregates::table)
290 community_person_ban::table.on(
292 .eq(community_person_ban::community_id)
293 .and(community_person_ban::person_id.eq(comment::creator_id)),
297 community_follower::table.on(
299 .eq(community_follower::community_id)
300 .and(community_follower::person_id.eq(person_id_join)),
304 comment_saved::table.on(
306 .eq(comment_saved::comment_id)
307 .and(comment_saved::person_id.eq(person_id_join)),
311 comment_like::table.on(
313 .eq(comment_like::comment_id)
314 .and(comment_like::person_id.eq(person_id_join)),
318 comment::all_columns,
319 Person::safe_columns_tuple(),
320 comment_alias_1::all_columns.nullable(),
321 PersonAlias1::safe_columns_tuple().nullable(),
323 Community::safe_columns_tuple(),
324 comment_aggregates::all_columns,
325 community_person_ban::all_columns.nullable(),
326 community_follower::all_columns.nullable(),
327 comment_saved::all_columns.nullable(),
328 comment_like::score.nullable(),
333 if let Some(recipient_id) = self.recipient_id {
335 // TODO needs lots of testing
336 .filter(person_alias_1::id.eq(recipient_id)) // Gets the comment replies
340 .and(post::creator_id.eq(recipient_id)),
341 ) // Gets the top level replies
342 .filter(comment::deleted.eq(false))
343 .filter(comment::removed.eq(false));
346 if self.unread_only {
347 query = query.filter(comment::read.eq(false));
350 if let Some(creator_id) = self.creator_id {
351 query = query.filter(comment::creator_id.eq(creator_id));
354 if let Some(community_id) = self.community_id {
355 query = query.filter(post::community_id.eq(community_id));
358 if let Some(community_name) = self.community_name {
360 .filter(community::name.eq(community_name))
361 .filter(comment::local.eq(true));
364 if let Some(post_id) = self.post_id {
365 query = query.filter(comment::post_id.eq(post_id));
368 if let Some(search_term) = self.search_term {
369 query = query.filter(comment::content.ilike(fuzzy_search(&search_term)));
372 query = match self.listing_type {
373 // ListingType::Subscribed => query.filter(community_follower::subscribed.eq(true)),
374 ListingType::Subscribed => query.filter(community_follower::person_id.is_not_null()), // TODO could be this: and(community_follower::person_id.eq(person_id_join)),
375 ListingType::Local => query.filter(community::local.eq(true)),
380 query = query.filter(comment_saved::id.is_not_null());
383 query = match self.sort {
384 SortType::Hot | SortType::Active => query
385 .order_by(hot_rank(comment_aggregates::score, comment_aggregates::published).desc())
386 .then_order_by(comment_aggregates::published.desc()),
387 SortType::New | SortType::MostComments | SortType::NewComments => {
388 query.order_by(comment::published.desc())
390 SortType::TopAll => query.order_by(comment_aggregates::score.desc()),
391 SortType::TopYear => query
392 .filter(comment::published.gt(now - 1.years()))
393 .order_by(comment_aggregates::score.desc()),
394 SortType::TopMonth => query
395 .filter(comment::published.gt(now - 1.months()))
396 .order_by(comment_aggregates::score.desc()),
397 SortType::TopWeek => query
398 .filter(comment::published.gt(now - 1.weeks()))
399 .order_by(comment_aggregates::score.desc()),
400 SortType::TopDay => query
401 .filter(comment::published.gt(now - 1.days()))
402 .order_by(comment_aggregates::score.desc()),
405 let (limit, offset) = limit_and_offset(self.page, self.limit);
407 // Note: deleted and removed comments are done on the front side
411 .load::<CommentViewTuple>(self.conn)?;
413 Ok(CommentView::from_tuple_to_vec(res))
417 impl ViewToVec for CommentView {
418 type DbTuple = CommentViewTuple;
419 fn from_tuple_to_vec(items: Vec<Self::DbTuple>) -> Vec<Self> {
423 comment: a.0.to_owned(),
424 creator: a.1.to_owned(),
425 recipient: a.3.to_owned(),
426 post: a.4.to_owned(),
427 community: a.5.to_owned(),
428 counts: a.6.to_owned(),
429 creator_banned_from_community: a.7.is_some(),
430 subscribed: a.8.is_some(),
431 saved: a.9.is_some(),
434 .collect::<Vec<Self>>()
440 use crate::comment_view::*;
441 use lemmy_db_queries::{
442 aggregates::comment_aggregates::CommentAggregates,
443 establish_unpooled_connection,
447 use lemmy_db_schema::source::{comment::*, community::*, person::*, post::*};
448 use serial_test::serial;
453 let conn = establish_unpooled_connection();
455 let new_person = PersonForm {
456 name: "timmy".into(),
457 preferred_username: None,
469 last_refreshed_at: None,
471 shared_inbox_url: None,
472 matrix_user_id: None,
475 let inserted_person = Person::create(&conn, &new_person).unwrap();
477 let new_community = CommunityForm {
478 name: "test community 5".to_string(),
479 title: "nada".to_owned(),
481 creator_id: inserted_person.id,
490 last_refreshed_at: None,
496 shared_inbox_url: None,
499 let inserted_community = Community::create(&conn, &new_community).unwrap();
501 let new_post = PostForm {
502 name: "A test post 2".into(),
503 creator_id: inserted_person.id,
506 community_id: inserted_community.id,
514 embed_description: None,
522 let inserted_post = Post::create(&conn, &new_post).unwrap();
524 let comment_form = CommentForm {
525 content: "A test comment 32".into(),
526 creator_id: inserted_person.id,
527 post_id: inserted_post.id,
538 let inserted_comment = Comment::create(&conn, &comment_form).unwrap();
540 let comment_like_form = CommentLikeForm {
541 comment_id: inserted_comment.id,
542 post_id: inserted_post.id,
543 person_id: inserted_person.id,
547 let _inserted_comment_like = CommentLike::like(&conn, &comment_like_form).unwrap();
549 let agg = CommentAggregates::read(&conn, inserted_comment.id).unwrap();
551 let expected_comment_view_no_person = CommentView {
552 creator_banned_from_community: false,
557 id: inserted_comment.id,
558 content: "A test comment 32".into(),
559 creator_id: inserted_person.id,
560 post_id: inserted_post.id,
565 published: inserted_comment.published,
566 ap_id: inserted_comment.ap_id,
570 creator: PersonSafe {
571 id: inserted_person.id,
572 name: "timmy".into(),
573 preferred_username: None,
574 published: inserted_person.published,
576 actor_id: inserted_person.actor_id.to_owned(),
583 inbox_url: inserted_person.inbox_url.to_owned(),
584 shared_inbox_url: None,
585 matrix_user_id: None,
589 id: inserted_post.id,
590 name: inserted_post.name.to_owned(),
591 creator_id: inserted_person.id,
594 published: inserted_post.published,
596 community_id: inserted_community.id,
603 embed_description: None,
606 ap_id: inserted_post.ap_id.to_owned(),
609 community: CommunitySafe {
610 id: inserted_community.id,
611 name: "test community 5".to_string(),
616 actor_id: inserted_community.actor_id.to_owned(),
618 title: "nada".to_owned(),
620 creator_id: inserted_person.id,
623 published: inserted_community.published,
625 counts: CommentAggregates {
627 comment_id: inserted_comment.id,
631 published: agg.published,
635 let mut expected_comment_view_with_person = expected_comment_view_no_person.to_owned();
636 expected_comment_view_with_person.my_vote = Some(1);
638 let read_comment_views_no_person = CommentQueryBuilder::create(&conn)
639 .post_id(inserted_post.id)
643 let read_comment_views_with_person = CommentQueryBuilder::create(&conn)
644 .post_id(inserted_post.id)
645 .my_person_id(inserted_person.id)
649 let like_removed = CommentLike::remove(&conn, inserted_person.id, inserted_comment.id).unwrap();
650 let num_deleted = Comment::delete(&conn, inserted_comment.id).unwrap();
651 Post::delete(&conn, inserted_post.id).unwrap();
652 Community::delete(&conn, inserted_community.id).unwrap();
653 Person::delete(&conn, inserted_person.id).unwrap();
656 expected_comment_view_no_person,
657 read_comment_views_no_person[0]
660 expected_comment_view_with_person,
661 read_comment_views_with_person[0]
663 assert_eq!(1, num_deleted);
664 assert_eq!(1, like_removed);