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