lemmy/crates/db_schema/src/traits.rs

use crate::{
  newtypes::{CommunityId, DbUrl, PersonId},
  utils::{get_conn, DbPool},
};
use diesel::{
  associations::HasTable,
  dsl,
  expression::{AsExpression, TypedExpressionType},
  expression_methods::ExpressionMethods,
  query_dsl::methods::{FindDsl, LimitDsl},
  result::Error,
  sql_types::SqlType,
  AsChangeset,
  Expression,
  Insertable,
  Table,
};
use diesel_async::{methods::LoadQuery, AsyncPgConnection, RunQueryDsl};
use std::hash::Hash;

/*Self: Send + 'static + Sized + HasTable,
Self::Table:
FindDsl<Self::IdType> + Send + Sized + 'static,
<Self::Table as FindDsl<Self::IdType>>::Output:
LimitDsl + Send + Sized + 'static,
<<Self::Table as Table>::PrimaryKey as Expression>::SqlType: SqlType,
<Self::Table as Table>::PrimaryKey: ExpressionMethods + Send + Sized + 'static,*/
#[async_trait]
pub trait Crud
where
  Self: HasTable + Sized,
  Self::Table: FindDsl<Self::IdType> + 'static,
  dsl::Find<Self::Table, Self::IdType>: LimitDsl + Send,
  for<'a> dsl::Limit<dsl::Find<Self::Table, Self::IdType>>:
    Send + LoadQuery<'a, AsyncPgConnection, Self> + 'a,
  <<Self as HasTable>::Table as Table>::PrimaryKey: ExpressionMethods + Send,
  <<<Self as HasTable>::Table as Table>::PrimaryKey as Expression>::SqlType:
    SqlType + TypedExpressionType,
{
  /*for<'a> &'a Self::InsertForm: Insertable<Self::Table>,
  for<'a> InsertStatement<Self::Table, <&'a Self::InsertForm as Insertable<Self::Table>>::Values>:
    LoadQuery<'a, AsyncPgConnection, Self> + 'a,
  for<'a> <&'a Self::InsertForm as Insertable<Self::Table>>::Values: 'a,*/
  type InsertForm;
  type UpdateForm;
  type IdType: Hash
    + Eq
    + Sized
    + Send
    + AsExpression<<<Self::Table as Table>::PrimaryKey as Expression>::SqlType>;
  async fn create(pool: &mut DbPool<'_>, form: &Self::InsertForm) -> Result<Self, Error>;
  /*{
    let query = insert_into(Self::table()).values(form);
    let conn = &mut *get_conn(pool).await?;
    query.get_result::<Self>(conn).await
  }*/
  async fn read(pool: &mut DbPool<'_>, id: Self::IdType) -> Result<Self, Error> {
    let query = Self::table().find(id);
    let conn = &mut *get_conn(pool).await?;
    query.first::<Self>(conn).await
  }
  /// when you want to null out a column, you have to send Some(None)), since sending None means you just don't want to update that column.
  async fn update(
    pool: &mut DbPool<'_>,
    id: Self::IdType,
    form: &Self::UpdateForm,
  ) -> Result<Self, Error>;
  /*{
    let conn = &mut get_conn(pool).await?;
    diesel::update(Self::table().find(id))
      .set(form)
      .get_result::<Self>(conn)
      .await
  }*/
  async fn delete(_pool: &mut DbPool<'_>, _id: Self::IdType) -> Result<usize, Error> {
    Err(Error::NotFound)
    /*let conn = &mut get_conn(pool).await?;
    diesel::delete(Self::table().find(id)).execute(conn).await*/
  }
}

#[async_trait]
pub trait Followable
where
  Self: HasTable,
  for<'a> &'a Self::Form: AsChangeset<Target = Self::Table> + Insertable<Self::Table>,
{
  //type FollowerColumn: Column + Default + Send;
  //type TargetColumn: Column + Default + Send;
  type Form;
  async fn follow(pool: &mut DbPool<'_>, form: &Self::Form) -> Result<Self, Error>
  where
    Self: Sized;
  /*{
    let conn = &mut get_conn(pool).await?;
    insert_into(Self::table())
      .values(form)
      .on_conflict((
        Self::TargetColumn::default(),
        Self::FollowerColumn::default(),
      ))
      .do_update()
      .set(form)
      .get_result::<Self>(conn)
      .await
  }*/
  async fn follow_accepted(
    pool: &mut DbPool<'_>,
    community_id: CommunityId,
    person_id: PersonId,
  ) -> Result<Self, Error>
  where
    Self: Sized;
  async fn unfollow(pool: &mut DbPool<'_>, form: &Self::Form) -> Result<usize, Error>
  where
    Self: Sized;
}

#[async_trait]
pub trait Joinable {
  type Form;
  async fn join(pool: &mut DbPool<'_>, form: &Self::Form) -> Result<Self, Error>
  where
    Self: Sized;
  async fn leave(pool: &mut DbPool<'_>, form: &Self::Form) -> Result<usize, Error>
  where
    Self: Sized;
}

#[async_trait]
pub trait Likeable {
  type Form;
  type IdType;
  async fn like(pool: &mut DbPool<'_>, form: &Self::Form) -> Result<Self, Error>
  where
    Self: Sized;
  async fn remove(
    pool: &mut DbPool<'_>,
    person_id: PersonId,
    item_id: Self::IdType,
  ) -> Result<usize, Error>
  where
    Self: Sized;
}

#[async_trait]
pub trait Bannable {
  type Form;
  async fn ban(pool: &mut DbPool<'_>, form: &Self::Form) -> Result<Self, Error>
  where
    Self: Sized;
  async fn unban(pool: &mut DbPool<'_>, form: &Self::Form) -> Result<usize, Error>
  where
    Self: Sized;
}

#[async_trait]
pub trait Saveable {
  type Form;
  async fn save(pool: &mut DbPool<'_>, form: &Self::Form) -> Result<Self, Error>
  where
    Self: Sized;
  async fn unsave(pool: &mut DbPool<'_>, form: &Self::Form) -> Result<usize, Error>
  where
    Self: Sized;
}

#[async_trait]
pub trait Blockable {
  type Form;
  async fn block(pool: &mut DbPool<'_>, form: &Self::Form) -> Result<Self, Error>
  where
    Self: Sized;
  async fn unblock(pool: &mut DbPool<'_>, form: &Self::Form) -> Result<usize, Error>
  where
    Self: Sized;
}

#[async_trait]
pub trait Readable {
  type Form;
  async fn mark_as_read(pool: &mut DbPool<'_>, form: &Self::Form) -> Result<Self, Error>
  where
    Self: Sized;
  async fn mark_as_unread(pool: &mut DbPool<'_>, form: &Self::Form) -> Result<usize, Error>
  where
    Self: Sized;
}

#[async_trait]
pub trait Reportable {
  type Form;
  type IdType;
  async fn report(pool: &mut DbPool<'_>, form: &Self::Form) -> Result<Self, Error>
  where
    Self: Sized;
  async fn resolve(
    pool: &mut DbPool<'_>,
    report_id: Self::IdType,
    resolver_id: PersonId,
  ) -> Result<usize, Error>
  where
    Self: Sized;
  async fn unresolve(
    pool: &mut DbPool<'_>,
    report_id: Self::IdType,
    resolver_id: PersonId,
  ) -> Result<usize, Error>
  where
    Self: Sized;
}

pub trait JoinView {
  type JoinTuple;
  fn from_tuple(tuple: Self::JoinTuple) -> Self
  where
    Self: Sized;
}

#[async_trait]
pub trait ApubActor {
  async fn read_from_apub_id(
    pool: &mut DbPool<'_>,
    object_id: &DbUrl,
  ) -> Result<Option<Self>, Error>
  where
    Self: Sized;
  /// - actor_name is the name of the community or user to read.
  /// - include_deleted, if true, will return communities or users that were deleted/removed
  async fn read_from_name(
    pool: &mut DbPool<'_>,
    actor_name: &str,
    include_deleted: bool,
  ) -> Result<Self, Error>
  where
    Self: Sized;
  async fn read_from_name_and_domain(
    pool: &mut DbPool<'_>,
    actor_name: &str,
    protocol_domain: &str,
  ) -> Result<Self, Error>
  where
    Self: Sized;
}