lemmy/crates/db_views/src/registration_application_view.rs

use diesel::{dsl::count, result::Error, *};
use lemmy_db_schema::{
  limit_and_offset,
  schema::{local_user, person, person_alias_1, registration_application},
  source::{
    local_user::{LocalUser, LocalUserSettings},
    person::{Person, PersonAlias1, PersonSafe, PersonSafeAlias1},
    registration_application::RegistrationApplication,
  },
  traits::{MaybeOptional, ToSafe, ToSafeSettings, ViewToVec},
};
use serde::{Deserialize, Serialize};

#[derive(Debug, PartialEq, Serialize, Deserialize, Clone)]
pub struct RegistrationApplicationView {
  pub registration_application: RegistrationApplication,
  pub creator_local_user: LocalUserSettings,
  pub creator: PersonSafe,
  pub admin: Option<PersonSafeAlias1>,
}

type RegistrationApplicationViewTuple = (
  RegistrationApplication,
  LocalUserSettings,
  PersonSafe,
  Option<PersonSafeAlias1>,
);

impl RegistrationApplicationView {
  pub fn read(conn: &PgConnection, registration_application_id: i32) -> Result<Self, Error> {
    let (registration_application, creator_local_user, creator, admin) =
      registration_application::table
        .find(registration_application_id)
        .inner_join(
          local_user::table.on(registration_application::local_user_id.eq(local_user::id)),
        )
        .inner_join(person::table.on(local_user::person_id.eq(person::id)))
        .left_join(
          person_alias_1::table
            .on(registration_application::admin_id.eq(person_alias_1::id.nullable())),
        )
        .order_by(registration_application::published.desc())
        .select((
          registration_application::all_columns,
          LocalUser::safe_settings_columns_tuple(),
          Person::safe_columns_tuple(),
          PersonAlias1::safe_columns_tuple().nullable(),
        ))
        .first::<RegistrationApplicationViewTuple>(conn)?;

    Ok(RegistrationApplicationView {
      registration_application,
      creator_local_user,
      creator,
      admin,
    })
  }

  /// Returns the current unread registration_application count
  pub fn get_unread_count(conn: &PgConnection, verified_email_only: bool) -> Result<i64, Error> {
    let mut query = registration_application::table
      .inner_join(local_user::table.on(registration_application::local_user_id.eq(local_user::id)))
      .inner_join(person::table.on(local_user::person_id.eq(person::id)))
      .left_join(
        person_alias_1::table
          .on(registration_application::admin_id.eq(person_alias_1::id.nullable())),
      )
      .filter(registration_application::admin_id.is_null())
      .into_boxed();

    if verified_email_only {
      query = query.filter(local_user::email_verified.eq(true))
    }

    query
      .select(count(registration_application::id))
      .first::<i64>(conn)
  }
}

pub struct RegistrationApplicationQueryBuilder<'a> {
  conn: &'a PgConnection,
  unread_only: Option<bool>,
  verified_email_only: Option<bool>,
  page: Option<i64>,
  limit: Option<i64>,
}

impl<'a> RegistrationApplicationQueryBuilder<'a> {
  pub fn create(conn: &'a PgConnection) -> Self {
    RegistrationApplicationQueryBuilder {
      conn,
      unread_only: None,
      verified_email_only: None,
      page: None,
      limit: None,
    }
  }

  pub fn unread_only<T: MaybeOptional<bool>>(mut self, unread_only: T) -> Self {
    self.unread_only = unread_only.get_optional();
    self
  }

  pub fn verified_email_only<T: MaybeOptional<bool>>(mut self, verified_email_only: T) -> Self {
    self.verified_email_only = verified_email_only.get_optional();
    self
  }

  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
  }

  pub fn list(self) -> Result<Vec<RegistrationApplicationView>, Error> {
    let mut query = registration_application::table
      .inner_join(local_user::table.on(registration_application::local_user_id.eq(local_user::id)))
      .inner_join(person::table.on(local_user::person_id.eq(person::id)))
      .left_join(
        person_alias_1::table
          .on(registration_application::admin_id.eq(person_alias_1::id.nullable())),
      )
      .order_by(registration_application::published.desc())
      .select((
        registration_application::all_columns,
        LocalUser::safe_settings_columns_tuple(),
        Person::safe_columns_tuple(),
        PersonAlias1::safe_columns_tuple().nullable(),
      ))
      .into_boxed();

    if self.unread_only.unwrap_or(false) {
      query = query.filter(registration_application::admin_id.is_null())
    }

    if self.verified_email_only.unwrap_or(false) {
      query = query.filter(local_user::email_verified.eq(true))
    }

    let (limit, offset) = limit_and_offset(self.page, self.limit);

    query = query
      .limit(limit)
      .offset(offset)
      .order_by(registration_application::published.desc());

    let res = query.load::<RegistrationApplicationViewTuple>(self.conn)?;

    Ok(RegistrationApplicationView::from_tuple_to_vec(res))
  }
}

impl ViewToVec for RegistrationApplicationView {
  type DbTuple = RegistrationApplicationViewTuple;
  fn from_tuple_to_vec(items: Vec<Self::DbTuple>) -> Vec<Self> {
    items
      .iter()
      .map(|a| Self {
        registration_application: a.0.to_owned(),
        creator_local_user: a.1.to_owned(),
        creator: a.2.to_owned(),
        admin: a.3.to_owned(),
      })
      .collect::<Vec<Self>>()
  }
}

#[cfg(test)]
mod tests {
  use crate::registration_application_view::{
    RegistrationApplicationQueryBuilder,
    RegistrationApplicationView,
  };
  use lemmy_db_schema::{
    establish_unpooled_connection,
    source::{
      local_user::{LocalUser, LocalUserForm, LocalUserSettings},
      person::*,
      registration_application::{RegistrationApplication, RegistrationApplicationForm},
    },
    traits::Crud,
  };
  use serial_test::serial;

  #[test]
  #[serial]
  fn test_crud() {
    let conn = establish_unpooled_connection();

    let timmy_person_form = PersonForm {
      name: "timmy_rav".into(),
      admin: Some(true),
      ..PersonForm::default()
    };

    let inserted_timmy_person = Person::create(&conn, &timmy_person_form).unwrap();

    let timmy_local_user_form = LocalUserForm {
      person_id: Some(inserted_timmy_person.id),
      password_encrypted: Some("nada".to_string()),
      ..LocalUserForm::default()
    };

    let _inserted_timmy_local_user = LocalUser::create(&conn, &timmy_local_user_form).unwrap();

    let sara_person_form = PersonForm {
      name: "sara_rav".into(),
      ..PersonForm::default()
    };

    let inserted_sara_person = Person::create(&conn, &sara_person_form).unwrap();

    let sara_local_user_form = LocalUserForm {
      person_id: Some(inserted_sara_person.id),
      password_encrypted: Some("nada".to_string()),
      ..LocalUserForm::default()
    };

    let inserted_sara_local_user = LocalUser::create(&conn, &sara_local_user_form).unwrap();

    // Sara creates an application
    let sara_app_form = RegistrationApplicationForm {
      local_user_id: Some(inserted_sara_local_user.id),
      answer: Some("LET ME IIIIINN".to_string()),
      ..RegistrationApplicationForm::default()
    };

    let sara_app = RegistrationApplication::create(&conn, &sara_app_form).unwrap();

    let read_sara_app_view = RegistrationApplicationView::read(&conn, sara_app.id).unwrap();

    let jess_person_form = PersonForm {
      name: "jess_rav".into(),
      ..PersonForm::default()
    };

    let inserted_jess_person = Person::create(&conn, &jess_person_form).unwrap();

    let jess_local_user_form = LocalUserForm {
      person_id: Some(inserted_jess_person.id),
      password_encrypted: Some("nada".to_string()),
      ..LocalUserForm::default()
    };

    let inserted_jess_local_user = LocalUser::create(&conn, &jess_local_user_form).unwrap();

    // Sara creates an application
    let jess_app_form = RegistrationApplicationForm {
      local_user_id: Some(inserted_jess_local_user.id),
      answer: Some("LET ME IIIIINN".to_string()),
      ..RegistrationApplicationForm::default()
    };

    let jess_app = RegistrationApplication::create(&conn, &jess_app_form).unwrap();

    let read_jess_app_view = RegistrationApplicationView::read(&conn, jess_app.id).unwrap();

    let mut expected_sara_app_view = RegistrationApplicationView {
      registration_application: sara_app.to_owned(),
      creator_local_user: LocalUserSettings {
        id: inserted_sara_local_user.id,
        person_id: inserted_sara_local_user.person_id,
        email: inserted_sara_local_user.email,
        show_nsfw: inserted_sara_local_user.show_nsfw,
        theme: inserted_sara_local_user.theme,
        default_sort_type: inserted_sara_local_user.default_sort_type,
        default_listing_type: inserted_sara_local_user.default_listing_type,
        lang: inserted_sara_local_user.lang,
        show_avatars: inserted_sara_local_user.show_avatars,
        send_notifications_to_email: inserted_sara_local_user.send_notifications_to_email,
        validator_time: inserted_sara_local_user.validator_time,
        show_bot_accounts: inserted_sara_local_user.show_bot_accounts,
        show_scores: inserted_sara_local_user.show_scores,
        show_read_posts: inserted_sara_local_user.show_read_posts,
        show_new_post_notifs: inserted_sara_local_user.show_new_post_notifs,
        email_verified: inserted_sara_local_user.email_verified,
        accepted_application: inserted_sara_local_user.accepted_application,
      },
      creator: PersonSafe {
        id: inserted_sara_person.id,
        name: inserted_sara_person.name.to_owned(),
        display_name: None,
        published: inserted_sara_person.published,
        avatar: None,
        actor_id: inserted_sara_person.actor_id.to_owned(),
        local: true,
        banned: false,
        deleted: false,
        admin: false,
        bot_account: false,
        bio: None,
        banner: None,
        updated: None,
        inbox_url: inserted_sara_person.inbox_url.to_owned(),
        shared_inbox_url: None,
        matrix_user_id: None,
      },
      admin: None,
    };

    assert_eq!(read_sara_app_view, expected_sara_app_view);

    // Do a batch read of the applications
    let apps = RegistrationApplicationQueryBuilder::create(&conn)
      .unread_only(true)
      .list()
      .unwrap();

    assert_eq!(
      apps,
      [
        read_jess_app_view.to_owned(),
        expected_sara_app_view.to_owned()
      ]
    );

    // Make sure the counts are correct
    let unread_count = RegistrationApplicationView::get_unread_count(&conn, false).unwrap();
    assert_eq!(unread_count, 2);

    // Approve the application
    let approve_form = RegistrationApplicationForm {
      admin_id: Some(inserted_timmy_person.id),
      deny_reason: None,
      ..RegistrationApplicationForm::default()
    };

    RegistrationApplication::update(&conn, sara_app.id, &approve_form).unwrap();

    // Update the local_user row
    let approve_local_user_form = LocalUserForm {
      accepted_application: Some(true),
      ..LocalUserForm::default()
    };

    LocalUser::update(&conn, inserted_sara_local_user.id, &approve_local_user_form).unwrap();

    let read_sara_app_view_after_approve =
      RegistrationApplicationView::read(&conn, sara_app.id).unwrap();

    // Make sure the columns changed
    expected_sara_app_view
      .creator_local_user
      .accepted_application = true;
    expected_sara_app_view.registration_application.admin_id = Some(inserted_timmy_person.id);

    expected_sara_app_view.admin = Some(PersonSafeAlias1 {
      id: inserted_timmy_person.id,
      name: inserted_timmy_person.name.to_owned(),
      display_name: None,
      published: inserted_timmy_person.published,
      avatar: None,
      actor_id: inserted_timmy_person.actor_id.to_owned(),
      local: true,
      banned: false,
      deleted: false,
      admin: true,
      bot_account: false,
      bio: None,
      banner: None,
      updated: None,
      inbox_url: inserted_timmy_person.inbox_url.to_owned(),
      shared_inbox_url: None,
      matrix_user_id: None,
    });
    assert_eq!(read_sara_app_view_after_approve, expected_sara_app_view);

    // Do a batch read of apps again
    // It should show only jessicas which is unresolved
    let apps_after_resolve = RegistrationApplicationQueryBuilder::create(&conn)
      .unread_only(true)
      .list()
      .unwrap();
    assert_eq!(apps_after_resolve, vec![read_jess_app_view]);

    // Make sure the counts are correct
    let unread_count_after_approve =
      RegistrationApplicationView::get_unread_count(&conn, false).unwrap();
    assert_eq!(unread_count_after_approve, 1);

    // Make sure the not undenied_only has all the apps
    let all_apps = RegistrationApplicationQueryBuilder::create(&conn)
      .list()
      .unwrap();
    assert_eq!(all_apps.len(), 2);

    Person::delete(&conn, inserted_timmy_person.id).unwrap();
    Person::delete(&conn, inserted_sara_person.id).unwrap();
    Person::delete(&conn, inserted_jess_person.id).unwrap();
  }
}