use diesel::{result::Error, *}; use lemmy_db_queries::{ aggregates::comment_aggregates::CommentAggregates, functions::hot_rank, fuzzy_search, limit_and_offset, ListingType, MaybeOptional, SortType, ToSafe, ViewToVec, }; use lemmy_db_schema::{ schema::{ comment, comment_aggregates, comment_alias_1, comment_like, comment_saved, community, community_follower, community_user_ban, post, user_, user_alias_1, }, source::{ comment::{Comment, CommentAlias1, CommentSaved}, community::{Community, CommunityFollower, CommunitySafe, CommunityUserBan}, post::Post, user::{UserAlias1, UserSafe, UserSafeAlias1, User_}, }, }; use serde::Serialize; #[derive(Debug, PartialEq, Serialize, Clone)] pub struct CommentView { pub comment: Comment, pub creator: UserSafe, pub recipient: Option, // Left joins to comment and user pub post: Post, pub community: CommunitySafe, pub counts: CommentAggregates, pub creator_banned_from_community: bool, // Left Join to CommunityUserBan pub subscribed: bool, // Left join to CommunityFollower pub saved: bool, // Left join to CommentSaved pub my_vote: Option, // Left join to CommentLike } type CommentViewTuple = ( Comment, UserSafe, Option, Option, Post, CommunitySafe, CommentAggregates, Option, Option, Option, Option, ); impl CommentView { pub fn read( conn: &PgConnection, comment_id: i32, my_user_id: Option, ) -> Result { // The left join below will return None in this case let user_id_join = my_user_id.unwrap_or(-1); let ( comment, creator, _parent_comment, recipient, post, community, counts, creator_banned_from_community, subscribed, saved, my_vote, ) = comment::table .find(comment_id) .inner_join(user_::table) // recipient here .left_join(comment_alias_1::table.on(comment_alias_1::id.nullable().eq(comment::parent_id))) .left_join(user_alias_1::table.on(user_alias_1::id.eq(comment_alias_1::creator_id))) .inner_join(post::table) .inner_join(community::table.on(post::community_id.eq(community::id))) .inner_join(comment_aggregates::table) .left_join( community_user_ban::table.on( community::id .eq(community_user_ban::community_id) .and(community_user_ban::user_id.eq(comment::creator_id)), ), ) .left_join( community_follower::table.on( post::community_id .eq(community_follower::community_id) .and(community_follower::user_id.eq(user_id_join)), ), ) .left_join( comment_saved::table.on( comment::id .eq(comment_saved::comment_id) .and(comment_saved::user_id.eq(user_id_join)), ), ) .left_join( comment_like::table.on( comment::id .eq(comment_like::comment_id) .and(comment_like::user_id.eq(user_id_join)), ), ) .select(( comment::all_columns, User_::safe_columns_tuple(), comment_alias_1::all_columns.nullable(), UserAlias1::safe_columns_tuple().nullable(), post::all_columns, Community::safe_columns_tuple(), comment_aggregates::all_columns, community_user_ban::all_columns.nullable(), community_follower::all_columns.nullable(), comment_saved::all_columns.nullable(), comment_like::score.nullable(), )) .first::(conn)?; Ok(CommentView { comment, recipient, post, creator, community, counts, creator_banned_from_community: creator_banned_from_community.is_some(), subscribed: subscribed.is_some(), saved: saved.is_some(), my_vote, }) } /// Gets the recipient user id. /// If there is no parent comment, its the post creator pub fn get_recipient_id(&self) -> i32 { match &self.recipient { Some(parent_commenter) => parent_commenter.id, None => self.post.creator_id, } } } pub struct CommentQueryBuilder<'a> { conn: &'a PgConnection, listing_type: ListingType, sort: &'a SortType, community_id: Option, community_name: Option, post_id: Option, creator_id: Option, recipient_id: Option, my_user_id: Option, search_term: Option, saved_only: bool, unread_only: bool, page: Option, limit: Option, } impl<'a> CommentQueryBuilder<'a> { pub fn create(conn: &'a PgConnection) -> Self { CommentQueryBuilder { conn, listing_type: ListingType::All, sort: &SortType::New, community_id: None, community_name: None, post_id: None, creator_id: None, recipient_id: None, my_user_id: None, search_term: None, saved_only: false, unread_only: false, page: None, limit: None, } } pub fn listing_type(mut self, listing_type: ListingType) -> Self { self.listing_type = listing_type; self } pub fn sort(mut self, sort: &'a SortType) -> Self { self.sort = sort; self } pub fn post_id>(mut self, post_id: T) -> Self { self.post_id = post_id.get_optional(); self } pub fn creator_id>(mut self, creator_id: T) -> Self { self.creator_id = creator_id.get_optional(); self } pub fn recipient_id>(mut self, recipient_id: T) -> Self { self.recipient_id = recipient_id.get_optional(); self } pub fn community_id>(mut self, community_id: T) -> Self { self.community_id = community_id.get_optional(); self } pub fn my_user_id>(mut self, my_user_id: T) -> Self { self.my_user_id = my_user_id.get_optional(); self } pub fn community_name>(mut self, community_name: T) -> Self { self.community_name = community_name.get_optional(); self } pub fn search_term>(mut self, search_term: T) -> Self { self.search_term = search_term.get_optional(); self } pub fn saved_only(mut self, saved_only: bool) -> Self { self.saved_only = saved_only; self } pub fn unread_only(mut self, unread_only: bool) -> Self { self.unread_only = unread_only; self } pub fn page>(mut self, page: T) -> Self { self.page = page.get_optional(); self } pub fn limit>(mut self, limit: T) -> Self { self.limit = limit.get_optional(); self } pub fn list(self) -> Result, Error> { use diesel::dsl::*; // The left join below will return None in this case let user_id_join = self.my_user_id.unwrap_or(-1); let mut query = comment::table .inner_join(user_::table) // recipient here .left_join(comment_alias_1::table.on(comment_alias_1::id.nullable().eq(comment::parent_id))) .left_join(user_alias_1::table.on(user_alias_1::id.eq(comment_alias_1::creator_id))) .inner_join(post::table) .inner_join(community::table.on(post::community_id.eq(community::id))) .inner_join(comment_aggregates::table) .left_join( community_user_ban::table.on( community::id .eq(community_user_ban::community_id) .and(community_user_ban::user_id.eq(comment::creator_id)), ), ) .left_join( community_follower::table.on( post::community_id .eq(community_follower::community_id) .and(community_follower::user_id.eq(user_id_join)), ), ) .left_join( comment_saved::table.on( comment::id .eq(comment_saved::comment_id) .and(comment_saved::user_id.eq(user_id_join)), ), ) .left_join( comment_like::table.on( comment::id .eq(comment_like::comment_id) .and(comment_like::user_id.eq(user_id_join)), ), ) .select(( comment::all_columns, User_::safe_columns_tuple(), comment_alias_1::all_columns.nullable(), UserAlias1::safe_columns_tuple().nullable(), post::all_columns, Community::safe_columns_tuple(), comment_aggregates::all_columns, community_user_ban::all_columns.nullable(), community_follower::all_columns.nullable(), comment_saved::all_columns.nullable(), comment_like::score.nullable(), )) .into_boxed(); // The replies if let Some(recipient_id) = self.recipient_id { query = query // TODO needs lots of testing .filter(user_alias_1::id.eq(recipient_id)) // Gets the comment replies .or_filter( comment::parent_id .is_null() .and(post::creator_id.eq(recipient_id)), ) // Gets the top level replies .filter(comment::deleted.eq(false)) .filter(comment::removed.eq(false)); } if self.unread_only { query = query.filter(comment::read.eq(false)); } if let Some(creator_id) = self.creator_id { query = query.filter(comment::creator_id.eq(creator_id)); }; if let Some(community_id) = self.community_id { query = query.filter(post::community_id.eq(community_id)); } if let Some(community_name) = self.community_name { query = query .filter(community::name.eq(community_name)) .filter(comment::local.eq(true)); } if let Some(post_id) = self.post_id { query = query.filter(comment::post_id.eq(post_id)); }; if let Some(search_term) = self.search_term { query = query.filter(comment::content.ilike(fuzzy_search(&search_term))); }; query = match self.listing_type { // ListingType::Subscribed => query.filter(community_follower::subscribed.eq(true)), ListingType::Subscribed => query.filter(community_follower::user_id.is_not_null()), // TODO could be this: and(community_follower::user_id.eq(user_id_join)), ListingType::Local => query.filter(community::local.eq(true)), _ => query, }; if self.saved_only { query = query.filter(comment_saved::id.is_not_null()); } query = match self.sort { SortType::Hot | SortType::Active => query .order_by(hot_rank(comment_aggregates::score, comment_aggregates::published).desc()) .then_order_by(comment_aggregates::published.desc()), SortType::New => query.order_by(comment::published.desc()), SortType::TopAll => query.order_by(comment_aggregates::score.desc()), SortType::TopYear => query .filter(comment::published.gt(now - 1.years())) .order_by(comment_aggregates::score.desc()), SortType::TopMonth => query .filter(comment::published.gt(now - 1.months())) .order_by(comment_aggregates::score.desc()), SortType::TopWeek => query .filter(comment::published.gt(now - 1.weeks())) .order_by(comment_aggregates::score.desc()), SortType::TopDay => query .filter(comment::published.gt(now - 1.days())) .order_by(comment_aggregates::score.desc()), }; let (limit, offset) = limit_and_offset(self.page, self.limit); // Note: deleted and removed comments are done on the front side let res = query .limit(limit) .offset(offset) .load::(self.conn)?; Ok(CommentView::from_tuple_to_vec(res)) } } impl ViewToVec for CommentView { type DbTuple = CommentViewTuple; fn from_tuple_to_vec(items: Vec) -> Vec { items .iter() .map(|a| Self { comment: a.0.to_owned(), creator: a.1.to_owned(), recipient: a.3.to_owned(), post: a.4.to_owned(), community: a.5.to_owned(), counts: a.6.to_owned(), creator_banned_from_community: a.7.is_some(), subscribed: a.8.is_some(), saved: a.9.is_some(), my_vote: a.10, }) .collect::>() } } #[cfg(test)] mod tests { use crate::comment_view::*; use lemmy_db_queries::{ aggregates::comment_aggregates::CommentAggregates, establish_unpooled_connection, Crud, Likeable, ListingType, SortType, }; use lemmy_db_schema::source::{comment::*, community::*, post::*, user::*}; #[test] fn test_crud() { let conn = establish_unpooled_connection(); let new_user = UserForm { name: "timmy".into(), preferred_username: None, password_encrypted: "nope".into(), email: None, matrix_user_id: None, avatar: None, banner: None, admin: false, banned: Some(false), published: None, updated: None, show_nsfw: false, theme: "browser".into(), default_sort_type: SortType::Hot as i16, default_listing_type: ListingType::Subscribed as i16, lang: "browser".into(), show_avatars: true, send_notifications_to_email: false, actor_id: None, bio: None, local: true, private_key: None, public_key: None, last_refreshed_at: None, }; let inserted_user = User_::create(&conn, &new_user).unwrap(); let new_community = CommunityForm { name: "test community 5".to_string(), title: "nada".to_owned(), description: None, category_id: 1, creator_id: inserted_user.id, removed: None, deleted: None, updated: None, nsfw: false, actor_id: None, local: true, private_key: None, public_key: None, last_refreshed_at: None, published: None, icon: None, banner: None, }; let inserted_community = Community::create(&conn, &new_community).unwrap(); let new_post = PostForm { name: "A test post 2".into(), creator_id: inserted_user.id, url: None, body: None, community_id: inserted_community.id, removed: None, deleted: None, locked: None, stickied: None, updated: None, nsfw: false, embed_title: None, embed_description: None, embed_html: None, thumbnail_url: None, ap_id: None, local: true, published: None, }; let inserted_post = Post::create(&conn, &new_post).unwrap(); let comment_form = CommentForm { content: "A test comment 32".into(), creator_id: inserted_user.id, post_id: inserted_post.id, parent_id: None, removed: None, deleted: None, read: None, published: None, updated: None, ap_id: None, local: true, }; let inserted_comment = Comment::create(&conn, &comment_form).unwrap(); let comment_like_form = CommentLikeForm { comment_id: inserted_comment.id, post_id: inserted_post.id, user_id: inserted_user.id, score: 1, }; let _inserted_comment_like = CommentLike::like(&conn, &comment_like_form).unwrap(); let agg = CommentAggregates::read(&conn, inserted_comment.id).unwrap(); let expected_comment_view_no_user = CommentView { creator_banned_from_community: false, my_vote: None, subscribed: false, saved: false, comment: Comment { id: inserted_comment.id, content: "A test comment 32".into(), creator_id: inserted_user.id, post_id: inserted_post.id, parent_id: None, removed: false, deleted: false, read: false, published: inserted_comment.published, ap_id: inserted_comment.ap_id, updated: None, local: true, }, creator: UserSafe { id: inserted_user.id, name: "timmy".into(), preferred_username: None, published: inserted_user.published, avatar: None, actor_id: inserted_user.actor_id.to_owned(), local: true, banned: false, deleted: false, bio: None, banner: None, admin: false, updated: None, matrix_user_id: None, }, recipient: None, post: Post { id: inserted_post.id, name: inserted_post.name.to_owned(), creator_id: inserted_user.id, url: None, body: None, published: inserted_post.published, updated: None, community_id: inserted_community.id, removed: false, deleted: false, locked: false, stickied: false, nsfw: false, embed_title: None, embed_description: None, embed_html: None, thumbnail_url: None, ap_id: inserted_post.ap_id.to_owned(), local: true, }, community: CommunitySafe { id: inserted_community.id, name: "test community 5".to_string(), icon: None, removed: false, deleted: false, nsfw: false, actor_id: inserted_community.actor_id.to_owned(), local: true, title: "nada".to_owned(), description: None, creator_id: inserted_user.id, category_id: 1, updated: None, banner: None, published: inserted_community.published, }, counts: CommentAggregates { id: agg.id, comment_id: inserted_comment.id, score: 1, upvotes: 1, downvotes: 0, published: agg.published, }, }; let mut expected_comment_view_with_user = expected_comment_view_no_user.to_owned(); expected_comment_view_with_user.my_vote = Some(1); let read_comment_views_no_user = CommentQueryBuilder::create(&conn) .post_id(inserted_post.id) .list() .unwrap(); let read_comment_views_with_user = CommentQueryBuilder::create(&conn) .post_id(inserted_post.id) .my_user_id(inserted_user.id) .list() .unwrap(); let like_removed = CommentLike::remove(&conn, inserted_user.id, inserted_comment.id).unwrap(); let num_deleted = Comment::delete(&conn, inserted_comment.id).unwrap(); Post::delete(&conn, inserted_post.id).unwrap(); Community::delete(&conn, inserted_community.id).unwrap(); User_::delete(&conn, inserted_user.id).unwrap(); assert_eq!(expected_comment_view_no_user, read_comment_views_no_user[0]); assert_eq!( expected_comment_view_with_user, read_comment_views_with_user[0] ); assert_eq!(1, num_deleted); assert_eq!(1, like_removed); } }