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, CommunitySafe, CommunityUserBan},
31 user::{UserAlias1, UserSafe, UserSafeAlias1, User_},
36 #[derive(Debug, PartialEq, Serialize, Clone)]
37 pub struct CommentView {
39 pub creator: UserSafe,
40 pub recipient: Option<UserSafeAlias1>, // Left joins to comment and user
42 pub community: CommunitySafe,
43 pub counts: CommentAggregates,
44 pub creator_banned_from_community: bool, // Left Join to CommunityUserBan
45 pub subscribed: bool, // Left join to CommunityFollower
46 pub saved: bool, // Left join to CommentSaved
47 pub my_vote: Option<i16>, // Left join to CommentLike
50 type CommentViewTuple = (
53 Option<CommentAlias1>,
54 Option<UserSafeAlias1>,
58 Option<CommunityUserBan>,
59 Option<CommunityFollower>,
68 my_user_id: Option<i32>,
69 ) -> Result<Self, Error> {
70 // The left join below will return None in this case
71 let user_id_join = my_user_id.unwrap_or(-1);
81 creator_banned_from_community,
87 .inner_join(user_::table)
89 .left_join(comment_alias_1::table.on(comment_alias_1::id.nullable().eq(comment::parent_id)))
90 .left_join(user_alias_1::table.on(user_alias_1::id.eq(comment_alias_1::creator_id)))
91 .inner_join(post::table)
92 .inner_join(community::table.on(post::community_id.eq(community::id)))
93 .inner_join(comment_aggregates::table)
95 community_user_ban::table.on(
97 .eq(community_user_ban::community_id)
98 .and(community_user_ban::user_id.eq(comment::creator_id)),
102 community_follower::table.on(
104 .eq(community_follower::community_id)
105 .and(community_follower::user_id.eq(user_id_join)),
109 comment_saved::table.on(
111 .eq(comment_saved::comment_id)
112 .and(comment_saved::user_id.eq(user_id_join)),
116 comment_like::table.on(
118 .eq(comment_like::comment_id)
119 .and(comment_like::user_id.eq(user_id_join)),
123 comment::all_columns,
124 User_::safe_columns_tuple(),
125 comment_alias_1::all_columns.nullable(),
126 UserAlias1::safe_columns_tuple().nullable(),
128 Community::safe_columns_tuple(),
129 comment_aggregates::all_columns,
130 community_user_ban::all_columns.nullable(),
131 community_follower::all_columns.nullable(),
132 comment_saved::all_columns.nullable(),
133 comment_like::score.nullable(),
135 .first::<CommentViewTuple>(conn)?;
137 // If a user is given, then my_vote, if None, should be 0, not null
138 // Necessary to differentiate between other user's votes
139 let my_vote = if my_user_id.is_some() && comment_like.is_none() {
152 creator_banned_from_community: creator_banned_from_community.is_some(),
153 subscribed: subscribed.is_some(),
154 saved: saved.is_some(),
159 /// Gets the recipient user id.
160 /// If there is no parent comment, its the post creator
161 pub fn get_recipient_id(&self) -> i32 {
162 match &self.recipient {
163 Some(parent_commenter) => parent_commenter.id,
164 None => self.post.creator_id,
169 pub struct CommentQueryBuilder<'a> {
170 conn: &'a PgConnection,
171 listing_type: ListingType,
173 community_id: Option<i32>,
174 community_name: Option<String>,
175 post_id: Option<i32>,
176 creator_id: Option<i32>,
177 recipient_id: Option<i32>,
178 my_user_id: Option<i32>,
179 search_term: Option<String>,
186 impl<'a> CommentQueryBuilder<'a> {
187 pub fn create(conn: &'a PgConnection) -> Self {
188 CommentQueryBuilder {
190 listing_type: ListingType::All,
191 sort: &SortType::New,
193 community_name: None,
206 pub fn listing_type(mut self, listing_type: ListingType) -> Self {
207 self.listing_type = listing_type;
211 pub fn sort(mut self, sort: &'a SortType) -> Self {
216 pub fn post_id<T: MaybeOptional<i32>>(mut self, post_id: T) -> Self {
217 self.post_id = post_id.get_optional();
221 pub fn creator_id<T: MaybeOptional<i32>>(mut self, creator_id: T) -> Self {
222 self.creator_id = creator_id.get_optional();
226 pub fn recipient_id<T: MaybeOptional<i32>>(mut self, recipient_id: T) -> Self {
227 self.recipient_id = recipient_id.get_optional();
231 pub fn community_id<T: MaybeOptional<i32>>(mut self, community_id: T) -> Self {
232 self.community_id = community_id.get_optional();
236 pub fn my_user_id<T: MaybeOptional<i32>>(mut self, my_user_id: T) -> Self {
237 self.my_user_id = my_user_id.get_optional();
241 pub fn community_name<T: MaybeOptional<String>>(mut self, community_name: T) -> Self {
242 self.community_name = community_name.get_optional();
246 pub fn search_term<T: MaybeOptional<String>>(mut self, search_term: T) -> Self {
247 self.search_term = search_term.get_optional();
251 pub fn saved_only(mut self, saved_only: bool) -> Self {
252 self.saved_only = saved_only;
256 pub fn unread_only(mut self, unread_only: bool) -> Self {
257 self.unread_only = unread_only;
261 pub fn page<T: MaybeOptional<i64>>(mut self, page: T) -> Self {
262 self.page = page.get_optional();
266 pub fn limit<T: MaybeOptional<i64>>(mut self, limit: T) -> Self {
267 self.limit = limit.get_optional();
271 pub fn list(self) -> Result<Vec<CommentView>, Error> {
274 // The left join below will return None in this case
275 let user_id_join = self.my_user_id.unwrap_or(-1);
277 let mut query = comment::table
278 .inner_join(user_::table)
280 .left_join(comment_alias_1::table.on(comment_alias_1::id.nullable().eq(comment::parent_id)))
281 .left_join(user_alias_1::table.on(user_alias_1::id.eq(comment_alias_1::creator_id)))
282 .inner_join(post::table)
283 .inner_join(community::table.on(post::community_id.eq(community::id)))
284 .inner_join(comment_aggregates::table)
286 community_user_ban::table.on(
288 .eq(community_user_ban::community_id)
289 .and(community_user_ban::user_id.eq(comment::creator_id)),
293 community_follower::table.on(
295 .eq(community_follower::community_id)
296 .and(community_follower::user_id.eq(user_id_join)),
300 comment_saved::table.on(
302 .eq(comment_saved::comment_id)
303 .and(comment_saved::user_id.eq(user_id_join)),
307 comment_like::table.on(
309 .eq(comment_like::comment_id)
310 .and(comment_like::user_id.eq(user_id_join)),
314 comment::all_columns,
315 User_::safe_columns_tuple(),
316 comment_alias_1::all_columns.nullable(),
317 UserAlias1::safe_columns_tuple().nullable(),
319 Community::safe_columns_tuple(),
320 comment_aggregates::all_columns,
321 community_user_ban::all_columns.nullable(),
322 community_follower::all_columns.nullable(),
323 comment_saved::all_columns.nullable(),
324 comment_like::score.nullable(),
329 if let Some(recipient_id) = self.recipient_id {
331 // TODO needs lots of testing
332 .filter(user_alias_1::id.eq(recipient_id)) // Gets the comment replies
336 .and(post::creator_id.eq(recipient_id)),
337 ) // Gets the top level replies
338 .filter(comment::deleted.eq(false))
339 .filter(comment::removed.eq(false));
342 if self.unread_only {
343 query = query.filter(comment::read.eq(false));
346 if let Some(creator_id) = self.creator_id {
347 query = query.filter(comment::creator_id.eq(creator_id));
350 if let Some(community_id) = self.community_id {
351 query = query.filter(post::community_id.eq(community_id));
354 if let Some(community_name) = self.community_name {
356 .filter(community::name.eq(community_name))
357 .filter(comment::local.eq(true));
360 if let Some(post_id) = self.post_id {
361 query = query.filter(comment::post_id.eq(post_id));
364 if let Some(search_term) = self.search_term {
365 query = query.filter(comment::content.ilike(fuzzy_search(&search_term)));
368 query = match self.listing_type {
369 // ListingType::Subscribed => query.filter(community_follower::subscribed.eq(true)),
370 ListingType::Subscribed => query.filter(community_follower::user_id.is_not_null()), // TODO could be this: and(community_follower::user_id.eq(user_id_join)),
371 ListingType::Local => query.filter(community::local.eq(true)),
376 query = query.filter(comment_saved::id.is_not_null());
379 query = match self.sort {
380 SortType::Hot | SortType::Active => query
381 .order_by(hot_rank(comment_aggregates::score, comment_aggregates::published).desc())
382 .then_order_by(comment_aggregates::published.desc()),
383 SortType::New | SortType::MostComments | SortType::NewComments => {
384 query.order_by(comment::published.desc())
386 SortType::TopAll => query.order_by(comment_aggregates::score.desc()),
387 SortType::TopYear => query
388 .filter(comment::published.gt(now - 1.years()))
389 .order_by(comment_aggregates::score.desc()),
390 SortType::TopMonth => query
391 .filter(comment::published.gt(now - 1.months()))
392 .order_by(comment_aggregates::score.desc()),
393 SortType::TopWeek => query
394 .filter(comment::published.gt(now - 1.weeks()))
395 .order_by(comment_aggregates::score.desc()),
396 SortType::TopDay => query
397 .filter(comment::published.gt(now - 1.days()))
398 .order_by(comment_aggregates::score.desc()),
401 let (limit, offset) = limit_and_offset(self.page, self.limit);
403 // Note: deleted and removed comments are done on the front side
407 .load::<CommentViewTuple>(self.conn)?;
409 Ok(CommentView::from_tuple_to_vec(res))
413 impl ViewToVec for CommentView {
414 type DbTuple = CommentViewTuple;
415 fn from_tuple_to_vec(items: Vec<Self::DbTuple>) -> Vec<Self> {
419 comment: a.0.to_owned(),
420 creator: a.1.to_owned(),
421 recipient: a.3.to_owned(),
422 post: a.4.to_owned(),
423 community: a.5.to_owned(),
424 counts: a.6.to_owned(),
425 creator_banned_from_community: a.7.is_some(),
426 subscribed: a.8.is_some(),
427 saved: a.9.is_some(),
430 .collect::<Vec<Self>>()
436 use crate::comment_view::*;
437 use lemmy_db_queries::{
438 aggregates::comment_aggregates::CommentAggregates,
439 establish_unpooled_connection,
445 use lemmy_db_schema::source::{comment::*, community::*, post::*, user::*};
446 use serial_test::serial;
451 let conn = establish_unpooled_connection();
453 let new_user = UserForm {
454 name: "timmy".into(),
455 preferred_username: None,
456 password_encrypted: "nope".into(),
458 matrix_user_id: None,
466 theme: "browser".into(),
467 default_sort_type: SortType::Hot as i16,
468 default_listing_type: ListingType::Subscribed as i16,
469 lang: "browser".into(),
471 send_notifications_to_email: false,
477 last_refreshed_at: None,
479 shared_inbox_url: None,
482 let inserted_user = User_::create(&conn, &new_user).unwrap();
484 let new_community = CommunityForm {
485 name: "test community 5".to_string(),
486 title: "nada".to_owned(),
488 creator_id: inserted_user.id,
497 last_refreshed_at: None,
503 shared_inbox_url: None,
506 let inserted_community = Community::create(&conn, &new_community).unwrap();
508 let new_post = PostForm {
509 name: "A test post 2".into(),
510 creator_id: inserted_user.id,
513 community_id: inserted_community.id,
521 embed_description: None,
529 let inserted_post = Post::create(&conn, &new_post).unwrap();
531 let comment_form = CommentForm {
532 content: "A test comment 32".into(),
533 creator_id: inserted_user.id,
534 post_id: inserted_post.id,
545 let inserted_comment = Comment::create(&conn, &comment_form).unwrap();
547 let comment_like_form = CommentLikeForm {
548 comment_id: inserted_comment.id,
549 post_id: inserted_post.id,
550 user_id: inserted_user.id,
554 let _inserted_comment_like = CommentLike::like(&conn, &comment_like_form).unwrap();
556 let agg = CommentAggregates::read(&conn, inserted_comment.id).unwrap();
558 let expected_comment_view_no_user = CommentView {
559 creator_banned_from_community: false,
564 id: inserted_comment.id,
565 content: "A test comment 32".into(),
566 creator_id: inserted_user.id,
567 post_id: inserted_post.id,
572 published: inserted_comment.published,
573 ap_id: inserted_comment.ap_id,
578 id: inserted_user.id,
579 name: "timmy".into(),
580 preferred_username: None,
581 published: inserted_user.published,
583 actor_id: inserted_user.actor_id.to_owned(),
591 matrix_user_id: None,
592 inbox_url: inserted_user.inbox_url.to_owned(),
593 shared_inbox_url: None,
597 id: inserted_post.id,
598 name: inserted_post.name.to_owned(),
599 creator_id: inserted_user.id,
602 published: inserted_post.published,
604 community_id: inserted_community.id,
611 embed_description: None,
614 ap_id: inserted_post.ap_id.to_owned(),
617 community: CommunitySafe {
618 id: inserted_community.id,
619 name: "test community 5".to_string(),
624 actor_id: inserted_community.actor_id.to_owned(),
626 title: "nada".to_owned(),
628 creator_id: inserted_user.id,
631 published: inserted_community.published,
633 counts: CommentAggregates {
635 comment_id: inserted_comment.id,
639 published: agg.published,
643 let mut expected_comment_view_with_user = expected_comment_view_no_user.to_owned();
644 expected_comment_view_with_user.my_vote = Some(1);
646 let read_comment_views_no_user = CommentQueryBuilder::create(&conn)
647 .post_id(inserted_post.id)
651 let read_comment_views_with_user = CommentQueryBuilder::create(&conn)
652 .post_id(inserted_post.id)
653 .my_user_id(inserted_user.id)
657 let like_removed = CommentLike::remove(&conn, inserted_user.id, inserted_comment.id).unwrap();
658 let num_deleted = Comment::delete(&conn, inserted_comment.id).unwrap();
659 Post::delete(&conn, inserted_post.id).unwrap();
660 Community::delete(&conn, inserted_community.id).unwrap();
661 User_::delete(&conn, inserted_user.id).unwrap();
663 assert_eq!(expected_comment_view_no_user, read_comment_views_no_user[0]);
665 expected_comment_view_with_user,
666 read_comment_views_with_user[0]
668 assert_eq!(1, num_deleted);
669 assert_eq!(1, like_removed);