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   #[tracing::instrument(skip_all)]
  61   async fn read_from_apub_id(
  62     object_id: Url,
  63     context: &LemmyContext,
  64   ) -> Result<Option<Self>, LemmyError> {
  65     Ok(
  66       blocking(context.pool(), move |conn| {
  67         DbPerson::read_from_apub_id(conn, object_id)
  68       })
  69       .await??
  70       .map(Into::into),
  71     )
  72   }
  73
  74   #[tracing::instrument(skip_all)]
  75   async fn delete(self, context: &LemmyContext) -> Result<(), LemmyError> {
  76     blocking(context.pool(), move |conn| {
  77       DbPerson::update_deleted(conn, self.id, true)
  78     })
  79     .await??;
  80     Ok(())
  81   }
  82
  83   #[tracing::instrument(skip_all)]
  84   async fn into_apub(self, _pool: &LemmyContext) -> Result<Person, LemmyError> {
  85     let kind = if self.bot_account {
  86       UserTypes::Service
  87     } else {
  88       UserTypes::Person
  89     };
  90     let source = self.bio.clone().map(|bio| Source {
  91       content: bio,
  92       media_type: MediaTypeMarkdown::Markdown,
  93     });
  94     let icon = self.avatar.clone().map(ImageObject::new);
  95     let image = self.banner.clone().map(ImageObject::new);
  96
  97     let person = Person {
  98       kind,
  99       id: ObjectId::new(self.actor_id.clone()),
 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: self.shared_inbox_url.clone().map(|s| Endpoints {
 110         shared_inbox: s.into(),
 111       }),
 112       public_key: self.get_public_key()?,
 113       updated: self.updated.map(convert_datetime),
 114       unparsed: Default::default(),
 115       inbox: self.inbox_url.clone().into(),
 116     };
 117     Ok(person)
 118   }
 119
 120   fn to_tombstone(&self) -> Result<(), LemmyError> {
 121     unimplemented!()
 122   }
 123
 124   #[tracing::instrument(skip_all)]
 125   async fn verify(
 126     person: &Person,
 127     expected_domain: &Url,
 128     context: &LemmyContext,
 129     _request_counter: &mut i32,
 130   ) -> Result<(), LemmyError> {
 131     verify_domains_match(person.id.inner(), expected_domain)?;
 132     check_is_apub_id_valid(person.id.inner(), false, &context.settings())?;
 133
 134     let slur_regex = &context.settings().slur_regex();
 135     check_slurs(&person.preferred_username, slur_regex)?;
 136     check_slurs_opt(&person.name, slur_regex)?;
 137     let bio = get_summary_from_string_or_source(&person.summary, &person.source);
 138     check_slurs_opt(&bio, slur_regex)?;
 139     Ok(())
 140   }
 141
 142   #[tracing::instrument(skip_all)]
 143   async fn from_apub(
 144     person: Person,
 145     context: &LemmyContext,
 146     _request_counter: &mut i32,
 147   ) -> Result<ApubPerson, LemmyError> {
 148     let person_form = PersonForm {
 149       name: person.preferred_username,
 150       display_name: Some(person.name),
 151       banned: None,
 152       ban_expires: None,
 153       deleted: None,
 154       avatar: Some(person.icon.map(|i| i.url.into())),
 155       banner: Some(person.image.map(|i| i.url.into())),
 156       published: person.published.map(|u| u.naive_local()),
 157       updated: person.updated.map(|u| u.naive_local()),
 158       actor_id: Some(person.id.into()),
 159       bio: Some(get_summary_from_string_or_source(
 160         &person.summary,
 161         &person.source,
 162       )),
 163       local: Some(false),
 164       admin: Some(false),
 165       bot_account: Some(person.kind == UserTypes::Service),
 166       private_key: None,
 167       public_key: person.public_key.public_key_pem,
 168       last_refreshed_at: Some(naive_now()),
 169       inbox_url: Some(person.inbox.into()),
 170       shared_inbox_url: Some(person.endpoints.map(|e| e.shared_inbox.into())),
 171       matrix_user_id: Some(person.matrix_user_id),
 172     };
 173     let person = blocking(context.pool(), move |conn| {
 174       DbPerson::upsert(conn, &person_form)
 175     })
 176     .await??;
 177     Ok(person.into())
 178   }
 179 }
 180
 181 impl ActorType for ApubPerson {
 182   fn actor_id(&self) -> Url {
 183     self.actor_id.to_owned().into()
 184   }
 185
 186   fn public_key(&self) -> String {
 187     self.public_key.to_owned()
 188   }
 189
 190   fn private_key(&self) -> Option<String> {
 191     self.private_key.to_owned()
 192   }
 193
 194   fn inbox_url(&self) -> Url {
 195     self.inbox_url.clone().into()
 196   }
 197
 198   fn shared_inbox_url(&self) -> Option<Url> {
 199     self.shared_inbox_url.clone().map(|s| s.into())
 200   }
 201 }
 202
 203 #[cfg(test)]
 204 pub(crate) mod tests {
 205   use super::*;
 206   use crate::objects::tests::{file_to_json_object, init_context};
 207   use lemmy_apub_lib::activity_queue::create_activity_queue;
 208   use lemmy_db_schema::traits::Crud;
 209   use serial_test::serial;
 210
 211   pub(crate) async fn parse_lemmy_person(context: &LemmyContext) -> ApubPerson {
 212     let json = file_to_json_object("assets/lemmy/objects/person.json").unwrap();
 213     let url = Url::parse("https://enterprise.lemmy.ml/u/picard").unwrap();
 214     let mut request_counter = 0;
 215     ApubPerson::verify(&json, &url, context, &mut request_counter)
 216       .await
 217       .unwrap();
 218     let person = ApubPerson::from_apub(json, context, &mut request_counter)
 219       .await
 220       .unwrap();
 221     assert_eq!(request_counter, 0);
 222     person
 223   }
 224
 225   #[actix_rt::test]
 226   #[serial]
 227   async fn test_parse_lemmy_person() {
 228     let client = reqwest::Client::new().into();
 229     let manager = create_activity_queue(client);
 230     let context = init_context(manager.queue_handle().clone());
 231     let person = parse_lemmy_person(&context).await;
 232
 233     assert_eq!(person.display_name, Some("Jean-Luc Picard".to_string()));
 234     assert!(!person.local);
 235     assert_eq!(person.bio.as_ref().unwrap().len(), 39);
 236
 237     DbPerson::delete(&*context.pool().get().unwrap(), person.id).unwrap();
 238   }
 239
 240   #[actix_rt::test]
 241   #[serial]
 242   async fn test_parse_pleroma_person() {
 243     let client = reqwest::Client::new().into();
 244     let manager = create_activity_queue(client);
 245     let context = init_context(manager.queue_handle().clone());
 246     let json = file_to_json_object("assets/pleroma/objects/person.json").unwrap();
 247     let url = Url::parse("https://queer.hacktivis.me/users/lanodan").unwrap();
 248     let mut request_counter = 0;
 249     ApubPerson::verify(&json, &url, &context, &mut request_counter)
 250       .await
 251       .unwrap();
 252     let person = ApubPerson::from_apub(json, &context, &mut request_counter)
 253       .await
 254       .unwrap();
 255
 256     assert_eq!(person.actor_id, url.into());
 257     assert_eq!(person.name, "lanodan");
 258     assert!(!person.local);
 259     assert_eq!(request_counter, 0);
 260     assert_eq!(person.bio.as_ref().unwrap().len(), 873);
 261
 262     DbPerson::delete(&*context.pool().get().unwrap(), person.id).unwrap();
 263   }
 264 }