]> Untitled Git - lemmy.git/blobdiff - crates/db_views_actor/src/community_view.rs
Reduce amount of columns selected (#3755)
[lemmy.git] / crates / db_views_actor / src / community_view.rs
index a7b711b43726c805e6d541200b86889f2b63bc25..28a492579899b5b0f77b3f74a41491dcab5da952 100644 (file)
@@ -1,48 +1,41 @@
-use crate::{community_moderator_view::CommunityModeratorView, person_view::PersonViewSafe};
-use diesel::{result::Error, *};
+use crate::structs::{CommunityModeratorView, CommunityView, PersonView};
+use diesel::{
+  pg::Pg,
+  result::Error,
+  BoolExpressionMethods,
+  ExpressionMethods,
+  JoinOnDsl,
+  NullableExpressionMethods,
+  PgTextExpressionMethods,
+  QueryDsl,
+};
+use diesel_async::RunQueryDsl;
 use lemmy_db_schema::{
-  aggregates::community_aggregates::CommunityAggregates,
-  functions::hot_rank,
-  fuzzy_search,
-  limit_and_offset,
+  aggregates::structs::CommunityAggregates,
   newtypes::{CommunityId, PersonId},
   schema::{community, community_aggregates, community_block, community_follower, local_user},
   source::{
-    community::{Community, CommunityFollower, CommunitySafe},
-    community_block::CommunityBlock,
+    community::{Community, CommunityFollower},
+    local_user::LocalUser,
   },
-  traits::{MaybeOptional, ToSafe, ViewToVec},
+  traits::JoinView,
+  utils::{fuzzy_search, limit_and_offset, DbConn, DbPool, ListFn, Queries, ReadFn},
   ListingType,
   SortType,
+  SubscribedType,
 };
-use serde::{Deserialize, Serialize};
-
-#[derive(Debug, Serialize, Deserialize, Clone)]
-pub struct CommunityView {
-  pub community: CommunitySafe,
-  pub subscribed: bool,
-  pub blocked: bool,
-  pub counts: CommunityAggregates,
-}
 
-type CommunityViewTuple = (
-  CommunitySafe,
-  CommunityAggregates,
-  Option<CommunityFollower>,
-  Option<CommunityBlock>,
-);
+type CommunityViewTuple = (Community, CommunityAggregates, SubscribedType, bool);
 
-impl CommunityView {
-  pub fn read(
-    conn: &PgConnection,
-    community_id: CommunityId,
-    my_person_id: Option<PersonId>,
-  ) -> Result<Self, Error> {
+fn queries<'a>() -> Queries<
+  impl ReadFn<'a, CommunityView, (CommunityId, Option<PersonId>, Option<bool>)>,
+  impl ListFn<'a, CommunityView, CommunityQuery<'a>>,
+> {
+  let all_joins = |query: community::BoxedQuery<'a, Pg>, my_person_id: Option<PersonId>| {
     // The left join below will return None in this case
     let person_id_join = my_person_id.unwrap_or(PersonId(-1));
 
-    let (community, counts, follower, blocked) = community::table
-      .find(community_id)
+    query
       .inner_join(community_aggregates::table)
       .left_join(
         community_follower::table.on(
@@ -58,223 +51,169 @@ impl CommunityView {
             .and(community_block::person_id.eq(person_id_join)),
         ),
       )
-      .select((
-        Community::safe_columns_tuple(),
-        community_aggregates::all_columns,
-        community_follower::all_columns.nullable(),
-        community_block::all_columns.nullable(),
-      ))
-      .first::<CommunityViewTuple>(conn)?;
-
-    Ok(CommunityView {
-      community,
-      subscribed: follower.is_some(),
-      blocked: blocked.is_some(),
-      counts,
-    })
-  }
-
-  // TODO: this function is only used by is_mod_or_admin() below, can probably be merged
-  fn community_mods_and_admins(
-    conn: &PgConnection,
-    community_id: CommunityId,
-  ) -> Result<Vec<PersonId>, Error> {
-    let mut mods_and_admins: Vec<PersonId> = Vec::new();
-    mods_and_admins.append(
-      &mut CommunityModeratorView::for_community(conn, community_id)
-        .map(|v| v.into_iter().map(|m| m.moderator.id).collect())?,
-    );
-    mods_and_admins.append(
-      &mut PersonViewSafe::admins(conn).map(|v| v.into_iter().map(|a| a.person.id).collect())?,
-    );
-    Ok(mods_and_admins)
-  }
-
-  pub fn is_mod_or_admin(
-    conn: &PgConnection,
-    person_id: PersonId,
-    community_id: CommunityId,
-  ) -> bool {
-    Self::community_mods_and_admins(conn, community_id)
-      .unwrap_or_default()
-      .contains(&person_id)
-  }
-}
-
-pub struct CommunityQueryBuilder<'a> {
-  conn: &'a PgConnection,
-  listing_type: Option<ListingType>,
-  sort: Option<SortType>,
-  my_person_id: Option<PersonId>,
-  show_nsfw: Option<bool>,
-  search_term: Option<String>,
-  page: Option<i64>,
-  limit: Option<i64>,
-}
-
-impl<'a> CommunityQueryBuilder<'a> {
-  pub fn create(conn: &'a PgConnection) -> Self {
-    CommunityQueryBuilder {
-      conn,
-      my_person_id: None,
-      listing_type: None,
-      sort: None,
-      show_nsfw: None,
-      search_term: None,
-      page: None,
-      limit: None,
+  };
+
+  let selection = (
+    community::all_columns,
+    community_aggregates::all_columns,
+    CommunityFollower::select_subscribed_type(),
+    community_block::id.nullable().is_not_null(),
+  );
+
+  let not_removed_or_deleted = community::removed
+    .eq(false)
+    .and(community::deleted.eq(false));
+
+  let read = move |mut conn: DbConn<'a>,
+                   (community_id, my_person_id, is_mod_or_admin): (
+    CommunityId,
+    Option<PersonId>,
+    Option<bool>,
+  )| async move {
+    let mut query = all_joins(
+      community::table.find(community_id).into_boxed(),
+      my_person_id,
+    )
+    .select(selection);
+
+    // Hide deleted and removed for non-admins or mods
+    if !is_mod_or_admin.unwrap_or(false) {
+      query = query.filter(not_removed_or_deleted);
     }
-  }
-
-  pub fn listing_type<T: MaybeOptional<ListingType>>(mut self, listing_type: T) -> Self {
-    self.listing_type = listing_type.get_optional();
-    self
-  }
-
-  pub fn sort<T: MaybeOptional<SortType>>(mut self, sort: T) -> Self {
-    self.sort = sort.get_optional();
-    self
-  }
-
-  pub fn show_nsfw<T: MaybeOptional<bool>>(mut self, show_nsfw: T) -> Self {
-    self.show_nsfw = show_nsfw.get_optional();
-    self
-  }
 
-  pub fn search_term<T: MaybeOptional<String>>(mut self, search_term: T) -> Self {
-    self.search_term = search_term.get_optional();
-    self
-  }
+    query.first::<CommunityViewTuple>(&mut conn).await
+  };
 
-  pub fn my_person_id<T: MaybeOptional<PersonId>>(mut self, my_person_id: T) -> Self {
-    self.my_person_id = my_person_id.get_optional();
-    self
-  }
+  let list = move |mut conn: DbConn<'a>, options: CommunityQuery<'a>| async move {
+    use SortType::*;
 
-  pub fn page<T: MaybeOptional<i64>>(mut self, page: T) -> Self {
-    self.page = page.get_optional();
-    self
-  }
-
-  pub fn limit<T: MaybeOptional<i64>>(mut self, limit: T) -> Self {
-    self.limit = limit.get_optional();
-    self
-  }
+    let my_person_id = options.local_user.map(|l| l.person_id);
 
-  pub fn list(self) -> Result<Vec<CommunityView>, Error> {
     // The left join below will return None in this case
-    let person_id_join = self.my_person_id.unwrap_or(PersonId(-1));
+    let person_id_join = my_person_id.unwrap_or(PersonId(-1));
 
-    let mut query = community::table
-      .inner_join(community_aggregates::table)
+    let mut query = all_joins(community::table.into_boxed(), my_person_id)
       .left_join(local_user::table.on(local_user::person_id.eq(person_id_join)))
-      .left_join(
-        community_follower::table.on(
-          community::id
-            .eq(community_follower::community_id)
-            .and(community_follower::person_id.eq(person_id_join)),
-        ),
-      )
-      .left_join(
-        community_block::table.on(
-          community::id
-            .eq(community_block::community_id)
-            .and(community_block::person_id.eq(person_id_join)),
-        ),
-      )
-      .select((
-        Community::safe_columns_tuple(),
-        community_aggregates::all_columns,
-        community_follower::all_columns.nullable(),
-        community_block::all_columns.nullable(),
-      ))
-      .into_boxed();
+      .select(selection);
 
-    if let Some(search_term) = self.search_term {
+    if let Some(search_term) = options.search_term {
       let searcher = fuzzy_search(&search_term);
       query = query
-        .filter(community::name.ilike(searcher.to_owned()))
-        .or_filter(community::title.ilike(searcher.to_owned()))
-        .or_filter(community::description.ilike(searcher));
-    };
+        .filter(community::name.ilike(searcher.clone()))
+        .or_filter(community::title.ilike(searcher))
+    }
 
-    match self.sort.unwrap_or(SortType::Hot) {
-      SortType::New => query = query.order_by(community::published.desc()),
-      SortType::TopAll => query = query.order_by(community_aggregates::subscribers.desc()),
-      SortType::TopMonth => query = query.order_by(community_aggregates::users_active_month.desc()),
-      SortType::Hot => {
-        query = query
-          .order_by(
-            hot_rank(
-              community_aggregates::subscribers,
-              community_aggregates::published,
-            )
-            .desc(),
-          )
-          .then_order_by(community_aggregates::published.desc());
-        // Don't show hidden communities in Hot (trending)
-        query = query.filter(
-          community::hidden
-            .eq(false)
-            .or(community_follower::person_id.eq(person_id_join)),
-        );
+    // Hide deleted and removed for non-admins or mods
+    if !options.is_mod_or_admin.unwrap_or(false) {
+      query = query.filter(not_removed_or_deleted).filter(
+        community::hidden
+          .eq(false)
+          .or(community_follower::person_id.eq(person_id_join)),
+      );
+    }
+
+    match options.sort.unwrap_or(Hot) {
+      Hot | Active => query = query.order_by(community_aggregates::hot_rank.desc()),
+      NewComments | TopDay | TopTwelveHour | TopSixHour | TopHour => {
+        query = query.order_by(community_aggregates::users_active_day.desc())
       }
-      // Covers all other sorts
-      _ => {
-        query = query
-          .order_by(
-            hot_rank(
-              community_aggregates::subscribers,
-              community_aggregates::published,
-            )
-            .desc(),
-          )
-          .then_order_by(community_aggregates::published.desc())
+      New => query = query.order_by(community::published.desc()),
+      Old => query = query.order_by(community::published.asc()),
+      // Controversial is temporary until a CommentSortType is created
+      MostComments | Controversial => query = query.order_by(community_aggregates::comments.desc()),
+      TopAll | TopYear | TopNineMonths => {
+        query = query.order_by(community_aggregates::subscribers.desc())
       }
+      TopSixMonths | TopThreeMonths => {
+        query = query.order_by(community_aggregates::users_active_half_year.desc())
+      }
+      TopMonth => query = query.order_by(community_aggregates::users_active_month.desc()),
+      TopWeek => query = query.order_by(community_aggregates::users_active_week.desc()),
     };
 
-    if let Some(listing_type) = self.listing_type {
+    if let Some(listing_type) = options.listing_type {
       query = match listing_type {
-        ListingType::Subscribed => query.filter(community_follower::person_id.is_not_null()), // TODO could be this: and(community_follower::person_id.eq(person_id_join)),
+        ListingType::Subscribed => query.filter(community_follower::pending.is_not_null()), // TODO could be this: and(community_follower::person_id.eq(person_id_join)),
         ListingType::Local => query.filter(community::local.eq(true)),
         _ => query,
       };
     }
 
     // Don't show blocked communities or nsfw communities if not enabled in profile
-    if self.my_person_id.is_some() {
+    if options.local_user.is_some() {
       query = query.filter(community_block::person_id.is_null());
       query = query.filter(community::nsfw.eq(false).or(local_user::show_nsfw.eq(true)));
     } else {
-      // No person in request, only show nsfw communities if show_nsfw passed into request
-      if !self.show_nsfw.unwrap_or(false) {
+      // No person in request, only show nsfw communities if show_nsfw is passed into request
+      if !options.show_nsfw.unwrap_or(false) {
         query = query.filter(community::nsfw.eq(false));
       }
     }
 
-    let (limit, offset) = limit_and_offset(self.page, self.limit);
-    let res = query
+    let (limit, offset) = limit_and_offset(options.page, options.limit)?;
+    query
       .limit(limit)
       .offset(offset)
-      .filter(community::removed.eq(false))
-      .filter(community::deleted.eq(false))
-      .load::<CommunityViewTuple>(self.conn)?;
+      .load::<CommunityViewTuple>(&mut conn)
+      .await
+  };
 
-    Ok(CommunityView::from_tuple_to_vec(res))
+  Queries::new(read, list)
+}
+
+impl CommunityView {
+  pub async fn read(
+    pool: &mut DbPool<'_>,
+    community_id: CommunityId,
+    my_person_id: Option<PersonId>,
+    is_mod_or_admin: Option<bool>,
+  ) -> Result<Self, Error> {
+    queries()
+      .read(pool, (community_id, my_person_id, is_mod_or_admin))
+      .await
   }
+
+  pub async fn is_mod_or_admin(
+    pool: &mut DbPool<'_>,
+    person_id: PersonId,
+    community_id: CommunityId,
+  ) -> Result<bool, Error> {
+    let is_mod =
+      CommunityModeratorView::is_community_moderator(pool, community_id, person_id).await?;
+    if is_mod {
+      return Ok(true);
+    }
+
+    PersonView::is_admin(pool, person_id).await
+  }
+}
+
+#[derive(Default)]
+pub struct CommunityQuery<'a> {
+  pub listing_type: Option<ListingType>,
+  pub sort: Option<SortType>,
+  pub local_user: Option<&'a LocalUser>,
+  pub search_term: Option<String>,
+  pub is_mod_or_admin: Option<bool>,
+  pub show_nsfw: Option<bool>,
+  pub page: Option<i64>,
+  pub limit: Option<i64>,
 }
 
-impl ViewToVec for CommunityView {
-  type DbTuple = CommunityViewTuple;
-  fn from_tuple_to_vec(items: Vec<Self::DbTuple>) -> Vec<Self> {
-    items
-      .iter()
-      .map(|a| Self {
-        community: a.0.to_owned(),
-        counts: a.1.to_owned(),
-        subscribed: a.2.is_some(),
-        blocked: a.3.is_some(),
-      })
-      .collect::<Vec<Self>>()
+impl<'a> CommunityQuery<'a> {
+  pub async fn list(self, pool: &mut DbPool<'_>) -> Result<Vec<CommunityView>, Error> {
+    queries().list(pool, self).await
+  }
+}
+
+impl JoinView for CommunityView {
+  type JoinTuple = CommunityViewTuple;
+  fn from_tuple(a: Self::JoinTuple) -> Self {
+    Self {
+      community: a.0,
+      counts: a.1,
+      subscribed: a.2,
+      blocked: a.3,
+    }
   }
 }