crates/apub/src/objects/person.rs

   1 use crate::{
   2   check_is_apub_id_valid,
   3   context::lemmy_context,
   4   generate_outbox_url,
   5   objects::{FromApub, ImageObject, Source, ToApub},
   6 };
   7 use activitystreams::{
   8   actor::Endpoints,
   9   base::AnyBase,
  10   chrono::{DateTime, FixedOffset},
  11   object::{kind::ImageType, Tombstone},
  12   primitives::OneOrMany,
  13   unparsed::Unparsed,
  14 };
  15 use lemmy_api_common::blocking;
  16 use lemmy_apub_lib::{
  17   signatures::PublicKey,
  18   traits::ActorType,
  19   values::{MediaTypeHtml, MediaTypeMarkdown},
  20   verify::verify_domains_match,
  21 };
  22 use lemmy_db_queries::{source::person::Person_, DbPool};
  23 use lemmy_db_schema::{
  24   naive_now,
  25   source::person::{Person as DbPerson, PersonForm},
  26 };
  27 use lemmy_utils::{
  28   utils::{check_slurs, check_slurs_opt, convert_datetime, markdown_to_html},
  29   LemmyError,
  30 };
  31 use lemmy_websocket::LemmyContext;
  32 use serde::{Deserialize, Serialize};
  33 use serde_with::skip_serializing_none;
  34 use url::Url;
  35
  36 #[derive(Clone, Copy, Debug, Deserialize, Serialize, PartialEq)]
  37 pub enum UserTypes {
  38   Person,
  39   Service,
  40 }
  41
  42 #[skip_serializing_none]
  43 #[derive(Clone, Debug, Deserialize, Serialize)]
  44 #[serde(rename_all = "camelCase")]
  45 pub struct Person {
  46   #[serde(rename = "@context")]
  47   context: OneOrMany<AnyBase>,
  48   #[serde(rename = "type")]
  49   kind: UserTypes,
  50   id: Url,
  51   /// username, set at account creation and can never be changed
  52   preferred_username: String,
  53   /// displayname (can be changed at any time)
  54   name: Option<String>,
  55   content: Option<String>,
  56   media_type: Option<MediaTypeHtml>,
  57   source: Option<Source>,
  58   /// user avatar
  59   icon: Option<ImageObject>,
  60   /// user banner
  61   image: Option<ImageObject>,
  62   matrix_user_id: Option<String>,
  63   inbox: Url,
  64   /// mandatory field in activitypub, currently empty in lemmy
  65   outbox: Url,
  66   endpoints: Endpoints<Url>,
  67   public_key: PublicKey,
  68   published: DateTime<FixedOffset>,
  69   updated: Option<DateTime<FixedOffset>>,
  70   #[serde(flatten)]
  71   unparsed: Unparsed,
  72 }
  73
  74 // TODO: can generate this with a derive macro
  75 impl Person {
  76   pub(crate) fn id(&self, expected_domain: &Url) -> Result<&Url, LemmyError> {
  77     verify_domains_match(&self.id, expected_domain)?;
  78     Ok(&self.id)
  79   }
  80 }
  81
  82 #[async_trait::async_trait(?Send)]
  83 impl ToApub for DbPerson {
  84   type ApubType = Person;
  85
  86   async fn to_apub(&self, _pool: &DbPool) -> Result<Person, LemmyError> {
  87     let kind = if self.bot_account {
  88       UserTypes::Service
  89     } else {
  90       UserTypes::Person
  91     };
  92     let source = self.bio.clone().map(|bio| Source {
  93       content: bio,
  94       media_type: MediaTypeMarkdown::Markdown,
  95     });
  96     let icon = self.avatar.clone().map(|url| ImageObject {
  97       kind: ImageType::Image,
  98       url: url.into(),
  99     });
 100     let image = self.banner.clone().map(|url| ImageObject {
 101       kind: ImageType::Image,
 102       url: url.into(),
 103     });
 104
 105     let person = Person {
 106       context: lemmy_context(),
 107       kind,
 108       id: self.actor_id.to_owned().into_inner(),
 109       preferred_username: self.name.clone(),
 110       name: self.display_name.clone(),
 111       content: self.bio.as_ref().map(|b| markdown_to_html(b)),
 112       media_type: self.bio.as_ref().map(|_| MediaTypeHtml::Html),
 113       source,
 114       icon,
 115       image,
 116       matrix_user_id: self.matrix_user_id.clone(),
 117       published: convert_datetime(self.published),
 118       outbox: generate_outbox_url(&self.actor_id)?.into(),
 119       endpoints: Endpoints {
 120         shared_inbox: self.shared_inbox_url.clone().map(|s| s.into()),
 121         ..Default::default()
 122       },
 123       public_key: self.get_public_key()?,
 124       updated: self.updated.map(convert_datetime),
 125       unparsed: Default::default(),
 126       inbox: self.inbox_url.clone().into(),
 127     };
 128     Ok(person)
 129   }
 130   fn to_tombstone(&self) -> Result<Tombstone, LemmyError> {
 131     unimplemented!()
 132   }
 133 }
 134
 135 #[async_trait::async_trait(?Send)]
 136 impl FromApub for DbPerson {
 137   type ApubType = Person;
 138
 139   async fn from_apub(
 140     person: &Person,
 141     context: &LemmyContext,
 142     expected_domain: &Url,
 143     _request_counter: &mut i32,
 144   ) -> Result<DbPerson, LemmyError> {
 145     let actor_id = Some(person.id(expected_domain)?.clone().into());
 146     let name = person.preferred_username.clone();
 147     let display_name: Option<String> = person.name.clone();
 148     let bio = person.source.clone().map(|s| s.content);
 149     let shared_inbox = person.endpoints.shared_inbox.clone().map(|s| s.into());
 150     let bot_account = match person.kind {
 151       UserTypes::Person => false,
 152       UserTypes::Service => true,
 153     };
 154
 155     let slur_regex = &context.settings().slur_regex();
 156     check_slurs(&name, slur_regex)?;
 157     check_slurs_opt(&display_name, slur_regex)?;
 158     check_slurs_opt(&bio, slur_regex)?;
 159
 160     check_is_apub_id_valid(&person.id, false, &context.settings())?;
 161
 162     let person_form = PersonForm {
 163       name,
 164       display_name: Some(display_name),
 165       banned: None,
 166       deleted: None,
 167       avatar: Some(person.icon.clone().map(|i| i.url.into())),
 168       banner: Some(person.image.clone().map(|i| i.url.into())),
 169       published: Some(person.published.naive_local()),
 170       updated: person.updated.map(|u| u.clone().naive_local()),
 171       actor_id,
 172       bio: Some(bio),
 173       local: Some(false),
 174       admin: Some(false),
 175       bot_account: Some(bot_account),
 176       private_key: None,
 177       public_key: Some(Some(person.public_key.public_key_pem.clone())),
 178       last_refreshed_at: Some(naive_now()),
 179       inbox_url: Some(person.inbox.to_owned().into()),
 180       shared_inbox_url: Some(shared_inbox),
 181       matrix_user_id: Some(person.matrix_user_id.clone()),
 182     };
 183     let person = blocking(context.pool(), move |conn| {
 184       DbPerson::upsert(conn, &person_form)
 185     })
 186     .await??;
 187     Ok(person)
 188   }
 189 }