crates/apub/src/objects/person.rs

   1 use crate::{
   2   check_is_apub_id_valid,
   3   generate_outbox_url,
   4   objects::get_summary_from_string_or_source,
   5   protocol::{
   6     objects::person::{Person, UserTypes},
   7     ImageObject,
   8     Source,
   9   },
  10 };
  11 use activitystreams::{actor::Endpoints, object::kind::ImageType};
  12 use chrono::NaiveDateTime;
  13 use lemmy_api_common::blocking;
  14 use lemmy_apub_lib::{
  15   traits::{ActorType, ApubObject},
  16   values::MediaTypeMarkdown,
  17   verify::verify_domains_match,
  18 };
  19 use lemmy_db_schema::{
  20   naive_now,
  21   source::person::{Person as DbPerson, PersonForm},
  22 };
  23 use lemmy_utils::{
  24   utils::{check_slurs, check_slurs_opt, convert_datetime, markdown_to_html},
  25   LemmyError,
  26 };
  27 use lemmy_websocket::LemmyContext;
  28 use std::ops::Deref;
  29 use url::Url;
  30
  31 #[derive(Clone, Debug, PartialEq)]
  32 pub struct ApubPerson(DbPerson);
  33
  34 impl Deref for ApubPerson {
  35   type Target = DbPerson;
  36   fn deref(&self) -> &Self::Target {
  37     &self.0
  38   }
  39 }
  40
  41 impl From<DbPerson> for ApubPerson {
  42   fn from(p: DbPerson) -> Self {
  43     ApubPerson { 0: p }
  44   }
  45 }
  46
  47 #[async_trait::async_trait(?Send)]
  48 impl ApubObject for ApubPerson {
  49   type DataType = LemmyContext;
  50   type ApubType = Person;
  51   type TombstoneType = ();
  52
  53   fn last_refreshed_at(&self) -> Option<NaiveDateTime> {
  54     Some(self.last_refreshed_at)
  55   }
  56
  57   async fn read_from_apub_id(
  58     object_id: Url,
  59     context: &LemmyContext,
  60   ) -> Result<Option<Self>, LemmyError> {
  61     Ok(
  62       blocking(context.pool(), move |conn| {
  63         DbPerson::read_from_apub_id(conn, object_id)
  64       })
  65       .await??
  66       .map(Into::into),
  67     )
  68   }
  69
  70   async fn delete(self, context: &LemmyContext) -> Result<(), LemmyError> {
  71     blocking(context.pool(), move |conn| {
  72       DbPerson::update_deleted(conn, self.id, true)
  73     })
  74     .await??;
  75     Ok(())
  76   }
  77
  78   async fn to_apub(&self, _pool: &LemmyContext) -> Result<Person, LemmyError> {
  79     let kind = if self.bot_account {
  80       UserTypes::Service
  81     } else {
  82       UserTypes::Person
  83     };
  84     let source = self.bio.clone().map(|bio| Source {
  85       content: bio,
  86       media_type: MediaTypeMarkdown::Markdown,
  87     });
  88     let icon = self.avatar.clone().map(|url| ImageObject {
  89       kind: ImageType::Image,
  90       url: url.into(),
  91     });
  92     let image = self.banner.clone().map(|url| ImageObject {
  93       kind: ImageType::Image,
  94       url: url.into(),
  95     });
  96
  97     let person = Person {
  98       kind,
  99       id: self.actor_id.to_owned().into_inner(),
 100       preferred_username: self.name.clone(),
 101       name: self.display_name.clone(),
 102       summary: self.bio.as_ref().map(|b| markdown_to_html(b)),
 103       source,
 104       icon,
 105       image,
 106       matrix_user_id: self.matrix_user_id.clone(),
 107       published: Some(convert_datetime(self.published)),
 108       outbox: generate_outbox_url(&self.actor_id)?.into(),
 109       endpoints: Endpoints {
 110         shared_inbox: self.shared_inbox_url.clone().map(|s| s.into()),
 111         ..Default::default()
 112       },
 113       public_key: self.get_public_key()?,
 114       updated: self.updated.map(convert_datetime),
 115       unparsed: Default::default(),
 116       inbox: self.inbox_url.clone().into(),
 117     };
 118     Ok(person)
 119   }
 120
 121   fn to_tombstone(&self) -> Result<(), LemmyError> {
 122     unimplemented!()
 123   }
 124
 125   async fn from_apub(
 126     person: &Person,
 127     context: &LemmyContext,
 128     expected_domain: &Url,
 129     _request_counter: &mut i32,
 130   ) -> Result<ApubPerson, LemmyError> {
 131     verify_domains_match(&person.id, expected_domain)?;
 132     let actor_id = Some(person.id.clone().into());
 133     let name = person.preferred_username.clone();
 134     let display_name: Option<String> = person.name.clone();
 135     let bio = get_summary_from_string_or_source(&person.summary, &person.source);
 136     let shared_inbox = person.endpoints.shared_inbox.clone().map(|s| s.into());
 137     let bot_account = match person.kind {
 138       UserTypes::Person => false,
 139       UserTypes::Service => true,
 140     };
 141
 142     let slur_regex = &context.settings().slur_regex();
 143     check_slurs(&name, slur_regex)?;
 144     check_slurs_opt(&display_name, slur_regex)?;
 145     check_slurs_opt(&bio, slur_regex)?;
 146
 147     check_is_apub_id_valid(&person.id, false, &context.settings())?;
 148
 149     let person_form = PersonForm {
 150       name,
 151       display_name: Some(display_name),
 152       banned: None,
 153       deleted: None,
 154       avatar: Some(person.icon.clone().map(|i| i.url.into())),
 155       banner: Some(person.image.clone().map(|i| i.url.into())),
 156       published: person.published.map(|u| u.clone().naive_local()),
 157       updated: person.updated.map(|u| u.clone().naive_local()),
 158       actor_id,
 159       bio: Some(bio),
 160       local: Some(false),
 161       admin: Some(false),
 162       bot_account: Some(bot_account),
 163       private_key: None,
 164       public_key: Some(Some(person.public_key.public_key_pem.clone())),
 165       last_refreshed_at: Some(naive_now()),
 166       inbox_url: Some(person.inbox.to_owned().into()),
 167       shared_inbox_url: Some(shared_inbox),
 168       matrix_user_id: Some(person.matrix_user_id.clone()),
 169     };
 170     let person = blocking(context.pool(), move |conn| {
 171       DbPerson::upsert(conn, &person_form)
 172     })
 173     .await??;
 174     Ok(person.into())
 175   }
 176 }
 177
 178 impl ActorType for ApubPerson {
 179   fn is_local(&self) -> bool {
 180     self.local
 181   }
 182   fn actor_id(&self) -> Url {
 183     self.actor_id.to_owned().into_inner()
 184   }
 185   fn name(&self) -> String {
 186     self.name.clone()
 187   }
 188
 189   fn public_key(&self) -> Option<String> {
 190     self.public_key.to_owned()
 191   }
 192
 193   fn private_key(&self) -> Option<String> {
 194     self.private_key.to_owned()
 195   }
 196
 197   fn inbox_url(&self) -> Url {
 198     self.inbox_url.clone().into()
 199   }
 200
 201   fn shared_inbox_url(&self) -> Option<Url> {
 202     self.shared_inbox_url.clone().map(|s| s.into_inner())
 203   }
 204 }
 205
 206 #[cfg(test)]
 207 pub(crate) mod tests {
 208   use super::*;
 209   use crate::objects::tests::{file_to_json_object, init_context};
 210   use lemmy_db_schema::traits::Crud;
 211   use serial_test::serial;
 212
 213   pub(crate) async fn parse_lemmy_person(context: &LemmyContext) -> ApubPerson {
 214     let json = file_to_json_object("assets/lemmy/objects/person.json");
 215     let url = Url::parse("https://enterprise.lemmy.ml/u/picard").unwrap();
 216     let mut request_counter = 0;
 217     let person = ApubPerson::from_apub(&json, context, &url, &mut request_counter)
 218       .await
 219       .unwrap();
 220     assert_eq!(request_counter, 0);
 221     person
 222   }
 223
 224   #[actix_rt::test]
 225   #[serial]
 226   async fn test_parse_lemmy_person() {
 227     let context = init_context();
 228     let person = parse_lemmy_person(&context).await;
 229
 230     assert_eq!(person.display_name, Some("Jean-Luc Picard".to_string()));
 231     assert!(person.public_key.is_some());
 232     assert!(!person.local);
 233     assert_eq!(person.bio.as_ref().unwrap().len(), 39);
 234
 235     DbPerson::delete(&*context.pool().get().unwrap(), person.id).unwrap();
 236   }
 237
 238   #[actix_rt::test]
 239   #[serial]
 240   async fn test_parse_pleroma_person() {
 241     let context = init_context();
 242     let json = file_to_json_object("assets/pleroma/objects/person.json");
 243     let url = Url::parse("https://queer.hacktivis.me/users/lanodan").unwrap();
 244     let mut request_counter = 0;
 245     let person = ApubPerson::from_apub(&json, &context, &url, &mut request_counter)
 246       .await
 247       .unwrap();
 248
 249     assert_eq!(person.actor_id.clone().into_inner(), url);
 250     assert_eq!(person.name, "lanodan");
 251     assert!(person.public_key.is_some());
 252     assert!(!person.local);
 253     assert_eq!(request_counter, 0);
 254     assert_eq!(person.bio.as_ref().unwrap().len(), 873);
 255
 256     DbPerson::delete(&*context.pool().get().unwrap(), person.id).unwrap();
 257   }
 258 }