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