crates/db_views/src/comment_view.rs

   1 use diesel::{result::Error, *};
   2 use lemmy_db_queries::{
   3   aggregates::comment_aggregates::CommentAggregates,
   4   functions::hot_rank,
   5   fuzzy_search,
   6   limit_and_offset,
   7   ListingType,
   8   MaybeOptional,
   9   SortType,
  10   ToSafe,
  11   ViewToVec,
  12 };
  13 use lemmy_db_schema::{
  14   schema::{
  15     comment,
  16     comment_aggregates,
  17     comment_alias_1,
  18     comment_like,
  19     comment_saved,
  20     community,
  21     community_follower,
  22     community_person_ban,
  23     person,
  24     person_alias_1,
  25     post,
  26   },
  27   source::{
  28     comment::{Comment, CommentAlias1, CommentSaved},
  29     community::{Community, CommunityFollower, CommunityPersonBan, CommunitySafe},
  30     person::{Person, PersonAlias1, PersonSafe, PersonSafeAlias1},
  31     post::Post,
  32   },
  33   CommentId,
  34   CommunityId,
  35   PersonId,
  36   PostId,
  37 };
  38 use serde::Serialize;
  39
  40 #[derive(Debug, PartialEq, Serialize, Clone)]
  41 pub struct CommentView {
  42   pub comment: Comment,
  43   pub creator: PersonSafe,
  44   pub recipient: Option<PersonSafeAlias1>, // Left joins to comment and person
  45   pub post: Post,
  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
  52 }
  53
  54 type CommentViewTuple = (
  55   Comment,
  56   PersonSafe,
  57   Option<CommentAlias1>,
  58   Option<PersonSafeAlias1>,
  59   Post,
  60   CommunitySafe,
  61   CommentAggregates,
  62   Option<CommunityPersonBan>,
  63   Option<CommunityFollower>,
  64   Option<CommentSaved>,
  65   Option<i16>,
  66 );
  67
  68 impl CommentView {
  69   pub fn read(
  70     conn: &PgConnection,
  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));
  76
  77     let (
  78       comment,
  79       creator,
  80       _parent_comment,
  81       recipient,
  82       post,
  83       community,
  84       counts,
  85       creator_banned_from_community,
  86       subscribed,
  87       saved,
  88       comment_like,
  89     ) = comment::table
  90       .find(comment_id)
  91       .inner_join(person::table)
  92       // recipient here
  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)
  98       .left_join(
  99         community_person_ban::table.on(
 100           community::id
 101             .eq(community_person_ban::community_id)
 102             .and(community_person_ban::person_id.eq(comment::creator_id)),
 103         ),
 104       )
 105       .left_join(
 106         community_follower::table.on(
 107           post::community_id
 108             .eq(community_follower::community_id)
 109             .and(community_follower::person_id.eq(person_id_join)),
 110         ),
 111       )
 112       .left_join(
 113         comment_saved::table.on(
 114           comment::id
 115             .eq(comment_saved::comment_id)
 116             .and(comment_saved::person_id.eq(person_id_join)),
 117         ),
 118       )
 119       .left_join(
 120         comment_like::table.on(
 121           comment::id
 122             .eq(comment_like::comment_id)
 123             .and(comment_like::person_id.eq(person_id_join)),
 124         ),
 125       )
 126       .select((
 127         comment::all_columns,
 128         Person::safe_columns_tuple(),
 129         comment_alias_1::all_columns.nullable(),
 130         PersonAlias1::safe_columns_tuple().nullable(),
 131         post::all_columns,
 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(),
 138       ))
 139       .first::<CommentViewTuple>(conn)?;
 140
 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() {
 144       Some(0)
 145     } else {
 146       comment_like
 147     };
 148
 149     Ok(CommentView {
 150       comment,
 151       recipient,
 152       post,
 153       creator,
 154       community,
 155       counts,
 156       creator_banned_from_community: creator_banned_from_community.is_some(),
 157       subscribed: subscribed.is_some(),
 158       saved: saved.is_some(),
 159       my_vote,
 160     })
 161   }
 162
 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,
 169     }
 170   }
 171 }
 172
 173 pub struct CommentQueryBuilder<'a> {
 174   conn: &'a PgConnection,
 175   listing_type: &'a ListingType,
 176   sort: &'a SortType,
 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>,
 184   saved_only: bool,
 185   unread_only: bool,
 186   show_bot_accounts: bool,
 187   page: Option<i64>,
 188   limit: Option<i64>,
 189 }
 190
 191 impl<'a> CommentQueryBuilder<'a> {
 192   pub fn create(conn: &'a PgConnection) -> Self {
 193     CommentQueryBuilder {
 194       conn,
 195       listing_type: &ListingType::All,
 196       sort: &SortType::New,
 197       community_id: None,
 198       community_name: None,
 199       post_id: None,
 200       creator_id: None,
 201       recipient_id: None,
 202       my_person_id: None,
 203       search_term: None,
 204       saved_only: false,
 205       unread_only: false,
 206       show_bot_accounts: true,
 207       page: None,
 208       limit: None,
 209     }
 210   }
 211
 212   pub fn listing_type(mut self, listing_type: &'a ListingType) -> Self {
 213     self.listing_type = listing_type;
 214     self
 215   }
 216
 217   pub fn sort(mut self, sort: &'a SortType) -> Self {
 218     self.sort = sort;
 219     self
 220   }
 221
 222   pub fn post_id<T: MaybeOptional<PostId>>(mut self, post_id: T) -> Self {
 223     self.post_id = post_id.get_optional();
 224     self
 225   }
 226
 227   pub fn creator_id<T: MaybeOptional<PersonId>>(mut self, creator_id: T) -> Self {
 228     self.creator_id = creator_id.get_optional();
 229     self
 230   }
 231
 232   pub fn recipient_id<T: MaybeOptional<PersonId>>(mut self, recipient_id: T) -> Self {
 233     self.recipient_id = recipient_id.get_optional();
 234     self
 235   }
 236
 237   pub fn community_id<T: MaybeOptional<CommunityId>>(mut self, community_id: T) -> Self {
 238     self.community_id = community_id.get_optional();
 239     self
 240   }
 241
 242   pub fn my_person_id<T: MaybeOptional<PersonId>>(mut self, my_person_id: T) -> Self {
 243     self.my_person_id = my_person_id.get_optional();
 244     self
 245   }
 246
 247   pub fn community_name<T: MaybeOptional<String>>(mut self, community_name: T) -> Self {
 248     self.community_name = community_name.get_optional();
 249     self
 250   }
 251
 252   pub fn search_term<T: MaybeOptional<String>>(mut self, search_term: T) -> Self {
 253     self.search_term = search_term.get_optional();
 254     self
 255   }
 256
 257   pub fn saved_only(mut self, saved_only: bool) -> Self {
 258     self.saved_only = saved_only;
 259     self
 260   }
 261
 262   pub fn unread_only(mut self, unread_only: bool) -> Self {
 263     self.unread_only = unread_only;
 264     self
 265   }
 266
 267   pub fn show_bot_accounts(mut self, show_bot_accounts: bool) -> Self {
 268     self.show_bot_accounts = show_bot_accounts;
 269     self
 270   }
 271
 272   pub fn page<T: MaybeOptional<i64>>(mut self, page: T) -> Self {
 273     self.page = page.get_optional();
 274     self
 275   }
 276
 277   pub fn limit<T: MaybeOptional<i64>>(mut self, limit: T) -> Self {
 278     self.limit = limit.get_optional();
 279     self
 280   }
 281
 282   pub fn list(self) -> Result<Vec<CommentView>, Error> {
 283     use diesel::dsl::*;
 284
 285     // The left join below will return None in this case
 286     let person_id_join = self.my_person_id.unwrap_or(PersonId(-1));
 287
 288     let mut query = comment::table
 289       .inner_join(person::table)
 290       // recipient here
 291       .left_join(comment_alias_1::table.on(comment_alias_1::id.nullable().eq(comment::parent_id)))
 292       .left_join(person_alias_1::table.on(person_alias_1::id.eq(comment_alias_1::creator_id)))
 293       .inner_join(post::table)
 294       .inner_join(community::table.on(post::community_id.eq(community::id)))
 295       .inner_join(comment_aggregates::table)
 296       .left_join(
 297         community_person_ban::table.on(
 298           community::id
 299             .eq(community_person_ban::community_id)
 300             .and(community_person_ban::person_id.eq(comment::creator_id)),
 301         ),
 302       )
 303       .left_join(
 304         community_follower::table.on(
 305           post::community_id
 306             .eq(community_follower::community_id)
 307             .and(community_follower::person_id.eq(person_id_join)),
 308         ),
 309       )
 310       .left_join(
 311         comment_saved::table.on(
 312           comment::id
 313             .eq(comment_saved::comment_id)
 314             .and(comment_saved::person_id.eq(person_id_join)),
 315         ),
 316       )
 317       .left_join(
 318         comment_like::table.on(
 319           comment::id
 320             .eq(comment_like::comment_id)
 321             .and(comment_like::person_id.eq(person_id_join)),
 322         ),
 323       )
 324       .select((
 325         comment::all_columns,
 326         Person::safe_columns_tuple(),
 327         comment_alias_1::all_columns.nullable(),
 328         PersonAlias1::safe_columns_tuple().nullable(),
 329         post::all_columns,
 330         Community::safe_columns_tuple(),
 331         comment_aggregates::all_columns,
 332         community_person_ban::all_columns.nullable(),
 333         community_follower::all_columns.nullable(),
 334         comment_saved::all_columns.nullable(),
 335         comment_like::score.nullable(),
 336       ))
 337       .into_boxed();
 338
 339     // The replies
 340     if let Some(recipient_id) = self.recipient_id {
 341       query = query
 342         // TODO needs lots of testing
 343         .filter(person_alias_1::id.eq(recipient_id)) // Gets the comment replies
 344         .or_filter(
 345           comment::parent_id
 346             .is_null()
 347             .and(post::creator_id.eq(recipient_id)),
 348         ) // Gets the top level replies
 349         .filter(comment::deleted.eq(false))
 350         .filter(comment::removed.eq(false));
 351     }
 352
 353     if self.unread_only {
 354       query = query.filter(comment::read.eq(false));
 355     }
 356
 357     if let Some(creator_id) = self.creator_id {
 358       query = query.filter(comment::creator_id.eq(creator_id));
 359     };
 360
 361     if let Some(community_id) = self.community_id {
 362       query = query.filter(post::community_id.eq(community_id));
 363     }
 364
 365     if let Some(community_name) = self.community_name {
 366       query = query
 367         .filter(community::name.eq(community_name))
 368         .filter(comment::local.eq(true));
 369     }
 370
 371     if let Some(post_id) = self.post_id {
 372       query = query.filter(comment::post_id.eq(post_id));
 373     };
 374
 375     if let Some(search_term) = self.search_term {
 376       query = query.filter(comment::content.ilike(fuzzy_search(&search_term)));
 377     };
 378
 379     query = match self.listing_type {
 380       // ListingType::Subscribed => query.filter(community_follower::subscribed.eq(true)),
 381       ListingType::Subscribed => query.filter(community_follower::person_id.is_not_null()), // TODO could be this: and(community_follower::person_id.eq(person_id_join)),
 382       ListingType::Local => query.filter(community::local.eq(true)),
 383       _ => query,
 384     };
 385
 386     if self.saved_only {
 387       query = query.filter(comment_saved::id.is_not_null());
 388     }
 389
 390     if !self.show_bot_accounts {
 391       query = query.filter(person::bot_account.eq(false));
 392     };
 393
 394     query = match self.sort {
 395       SortType::Hot | SortType::Active => query
 396         .order_by(hot_rank(comment_aggregates::score, comment_aggregates::published).desc())
 397         .then_order_by(comment_aggregates::published.desc()),
 398       SortType::New | SortType::MostComments | SortType::NewComments => {
 399         query.order_by(comment::published.desc())
 400       }
 401       SortType::TopAll => query.order_by(comment_aggregates::score.desc()),
 402       SortType::TopYear => query
 403         .filter(comment::published.gt(now - 1.years()))
 404         .order_by(comment_aggregates::score.desc()),
 405       SortType::TopMonth => query
 406         .filter(comment::published.gt(now - 1.months()))
 407         .order_by(comment_aggregates::score.desc()),
 408       SortType::TopWeek => query
 409         .filter(comment::published.gt(now - 1.weeks()))
 410         .order_by(comment_aggregates::score.desc()),
 411       SortType::TopDay => query
 412         .filter(comment::published.gt(now - 1.days()))
 413         .order_by(comment_aggregates::score.desc()),
 414     };
 415
 416     let (limit, offset) = limit_and_offset(self.page, self.limit);
 417
 418     // Note: deleted and removed comments are done on the front side
 419     let res = query
 420       .limit(limit)
 421       .offset(offset)
 422       .load::<CommentViewTuple>(self.conn)?;
 423
 424     Ok(CommentView::from_tuple_to_vec(res))
 425   }
 426 }
 427
 428 impl ViewToVec for CommentView {
 429   type DbTuple = CommentViewTuple;
 430   fn from_tuple_to_vec(items: Vec<Self::DbTuple>) -> Vec<Self> {
 431     items
 432       .iter()
 433       .map(|a| Self {
 434         comment: a.0.to_owned(),
 435         creator: a.1.to_owned(),
 436         recipient: a.3.to_owned(),
 437         post: a.4.to_owned(),
 438         community: a.5.to_owned(),
 439         counts: a.6.to_owned(),
 440         creator_banned_from_community: a.7.is_some(),
 441         subscribed: a.8.is_some(),
 442         saved: a.9.is_some(),
 443         my_vote: a.10,
 444       })
 445       .collect::<Vec<Self>>()
 446   }
 447 }
 448
 449 #[cfg(test)]
 450 mod tests {
 451   use crate::comment_view::*;
 452   use lemmy_db_queries::{
 453     aggregates::comment_aggregates::CommentAggregates,
 454     establish_unpooled_connection,
 455     Crud,
 456     Likeable,
 457   };
 458   use lemmy_db_schema::source::{comment::*, community::*, person::*, post::*};
 459   use serial_test::serial;
 460
 461   #[test]
 462   #[serial]
 463   fn test_crud() {
 464     let conn = establish_unpooled_connection();
 465
 466     let new_person = PersonForm {
 467       name: "timmy".into(),
 468       ..PersonForm::default()
 469     };
 470
 471     let inserted_person = Person::create(&conn, &new_person).unwrap();
 472
 473     let new_community = CommunityForm {
 474       name: "test community 5".to_string(),
 475       title: "nada".to_owned(),
 476       ..CommunityForm::default()
 477     };
 478
 479     let inserted_community = Community::create(&conn, &new_community).unwrap();
 480
 481     let new_post = PostForm {
 482       name: "A test post 2".into(),
 483       creator_id: inserted_person.id,
 484       community_id: inserted_community.id,
 485       ..PostForm::default()
 486     };
 487
 488     let inserted_post = Post::create(&conn, &new_post).unwrap();
 489
 490     let comment_form = CommentForm {
 491       content: "A test comment 32".into(),
 492       creator_id: inserted_person.id,
 493       post_id: inserted_post.id,
 494       ..CommentForm::default()
 495     };
 496
 497     let inserted_comment = Comment::create(&conn, &comment_form).unwrap();
 498
 499     let comment_like_form = CommentLikeForm {
 500       comment_id: inserted_comment.id,
 501       post_id: inserted_post.id,
 502       person_id: inserted_person.id,
 503       score: 1,
 504     };
 505
 506     let _inserted_comment_like = CommentLike::like(&conn, &comment_like_form).unwrap();
 507
 508     let agg = CommentAggregates::read(&conn, inserted_comment.id).unwrap();
 509
 510     let expected_comment_view_no_person = CommentView {
 511       creator_banned_from_community: false,
 512       my_vote: None,
 513       subscribed: false,
 514       saved: false,
 515       comment: Comment {
 516         id: inserted_comment.id,
 517         content: "A test comment 32".into(),
 518         creator_id: inserted_person.id,
 519         post_id: inserted_post.id,
 520         parent_id: None,
 521         removed: false,
 522         deleted: false,
 523         read: false,
 524         published: inserted_comment.published,
 525         ap_id: inserted_comment.ap_id,
 526         updated: None,
 527         local: true,
 528       },
 529       creator: PersonSafe {
 530         id: inserted_person.id,
 531         name: "timmy".into(),
 532         display_name: None,
 533         published: inserted_person.published,
 534         avatar: None,
 535         actor_id: inserted_person.actor_id.to_owned(),
 536         local: true,
 537         banned: false,
 538         deleted: false,
 539         admin: false,
 540         bot_account: false,
 541         bio: None,
 542         banner: None,
 543         updated: None,
 544         inbox_url: inserted_person.inbox_url.to_owned(),
 545         shared_inbox_url: None,
 546         matrix_user_id: None,
 547       },
 548       recipient: None,
 549       post: Post {
 550         id: inserted_post.id,
 551         name: inserted_post.name.to_owned(),
 552         creator_id: inserted_person.id,
 553         url: None,
 554         body: None,
 555         published: inserted_post.published,
 556         updated: None,
 557         community_id: inserted_community.id,
 558         removed: false,
 559         deleted: false,
 560         locked: false,
 561         stickied: false,
 562         nsfw: false,
 563         embed_title: None,
 564         embed_description: None,
 565         embed_html: None,
 566         thumbnail_url: None,
 567         ap_id: inserted_post.ap_id.to_owned(),
 568         local: true,
 569       },
 570       community: CommunitySafe {
 571         id: inserted_community.id,
 572         name: "test community 5".to_string(),
 573         icon: None,
 574         removed: false,
 575         deleted: false,
 576         nsfw: false,
 577         actor_id: inserted_community.actor_id.to_owned(),
 578         local: true,
 579         title: "nada".to_owned(),
 580         description: None,
 581         updated: None,
 582         banner: None,
 583         published: inserted_community.published,
 584       },
 585       counts: CommentAggregates {
 586         id: agg.id,
 587         comment_id: inserted_comment.id,
 588         score: 1,
 589         upvotes: 1,
 590         downvotes: 0,
 591         published: agg.published,
 592       },
 593     };
 594
 595     let mut expected_comment_view_with_person = expected_comment_view_no_person.to_owned();
 596     expected_comment_view_with_person.my_vote = Some(1);
 597
 598     let read_comment_views_no_person = CommentQueryBuilder::create(&conn)
 599       .post_id(inserted_post.id)
 600       .list()
 601       .unwrap();
 602
 603     let read_comment_views_with_person = CommentQueryBuilder::create(&conn)
 604       .post_id(inserted_post.id)
 605       .my_person_id(inserted_person.id)
 606       .list()
 607       .unwrap();
 608
 609     let like_removed = CommentLike::remove(&conn, inserted_person.id, inserted_comment.id).unwrap();
 610     let num_deleted = Comment::delete(&conn, inserted_comment.id).unwrap();
 611     Post::delete(&conn, inserted_post.id).unwrap();
 612     Community::delete(&conn, inserted_community.id).unwrap();
 613     Person::delete(&conn, inserted_person.id).unwrap();
 614
 615     assert_eq!(
 616       expected_comment_view_no_person,
 617       read_comment_views_no_person[0]
 618     );
 619     assert_eq!(
 620       expected_comment_view_with_person,
 621       read_comment_views_with_person[0]
 622     );
 623     assert_eq!(1, num_deleted);
 624     assert_eq!(1, like_removed);
 625   }
 626 }