crates/apub/src/objects/person.rs

   1 use crate::{
   2   check_is_apub_id_valid,
   3   generate_outbox_url,
   4   objects::{instance::fetch_instance_actor_for_object, read_from_string_or_source_opt},
   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::utils::blocking;
  16 use lemmy_apub_lib::{
  17   object_id::ObjectId,
  18   traits::{ActorType, ApubObject},
  19   verify::verify_domains_match,
  20 };
  21 use lemmy_db_schema::{
  22   source::person::{Person as DbPerson, PersonForm},
  23   traits::ApubActor,
  24   utils::naive_now,
  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(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 DbType = DbPerson;
  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.into())
  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
  92     let person = Person {
  93       kind,
  94       id: ObjectId::new(self.actor_id.clone()),
  95       preferred_username: self.name.clone(),
  96       name: self.display_name.clone(),
  97       summary: self.bio.as_ref().map(|b| markdown_to_html(b)),
  98       source: self.bio.clone().map(Source::new),
  99       icon: self.avatar.clone().map(ImageObject::new),
 100       image: self.banner.clone().map(ImageObject::new),
 101       matrix_user_id: self.matrix_user_id.clone(),
 102       published: Some(convert_datetime(self.published)),
 103       outbox: generate_outbox_url(&self.actor_id)?.into(),
 104       endpoints: self.shared_inbox_url.clone().map(|s| Endpoints {
 105         shared_inbox: s.into(),
 106       }),
 107       public_key: self.get_public_key()?,
 108       updated: self.updated.map(convert_datetime),
 109       inbox: self.inbox_url.clone().into(),
 110     };
 111     Ok(person)
 112   }
 113
 114   fn to_tombstone(&self) -> Result<(), LemmyError> {
 115     unimplemented!()
 116   }
 117
 118   #[tracing::instrument(skip_all)]
 119   async fn verify(
 120     person: &Person,
 121     expected_domain: &Url,
 122     context: &LemmyContext,
 123     _request_counter: &mut i32,
 124   ) -> Result<(), LemmyError> {
 125     verify_domains_match(person.id.inner(), expected_domain)?;
 126     check_is_apub_id_valid(person.id.inner(), false, &context.settings())?;
 127
 128     let slur_regex = &context.settings().slur_regex();
 129     check_slurs(&person.preferred_username, slur_regex)?;
 130     check_slurs_opt(&person.name, slur_regex)?;
 131     let bio = read_from_string_or_source_opt(&person.summary, &None, &person.source);
 132     check_slurs_opt(&bio, slur_regex)?;
 133     Ok(())
 134   }
 135
 136   #[tracing::instrument(skip_all)]
 137   async fn from_apub(
 138     person: Person,
 139     context: &LemmyContext,
 140     request_counter: &mut i32,
 141   ) -> Result<ApubPerson, LemmyError> {
 142     let person_form = PersonForm {
 143       name: person.preferred_username,
 144       display_name: Some(person.name),
 145       banned: None,
 146       ban_expires: 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(read_from_string_or_source_opt(
 154         &person.summary,
 155         &None,
 156         &person.source,
 157       )),
 158       local: Some(false),
 159       admin: Some(false),
 160       bot_account: Some(person.kind == UserTypes::Service),
 161       private_key: None,
 162       public_key: person.public_key.public_key_pem,
 163       last_refreshed_at: Some(naive_now()),
 164       inbox_url: Some(person.inbox.into()),
 165       shared_inbox_url: Some(person.endpoints.map(|e| e.shared_inbox.into())),
 166       matrix_user_id: Some(person.matrix_user_id),
 167     };
 168     let person = blocking(context.pool(), move |conn| {
 169       DbPerson::upsert(conn, &person_form)
 170     })
 171     .await??;
 172
 173     let actor_id = person.actor_id.clone().into();
 174     fetch_instance_actor_for_object(actor_id, context, request_counter).await;
 175
 176     Ok(person.into())
 177   }
 178 }
 179
 180 impl ActorType for ApubPerson {
 181   fn actor_id(&self) -> Url {
 182     self.actor_id.to_owned().into()
 183   }
 184
 185   fn public_key(&self) -> String {
 186     self.public_key.to_owned()
 187   }
 188
 189   fn private_key(&self) -> Option<String> {
 190     self.private_key.to_owned()
 191   }
 192
 193   fn inbox_url(&self) -> Url {
 194     self.inbox_url.clone().into()
 195   }
 196
 197   fn shared_inbox_url(&self) -> Option<Url> {
 198     self.shared_inbox_url.clone().map(|s| s.into())
 199   }
 200 }
 201
 202 #[cfg(test)]
 203 pub(crate) mod tests {
 204   use super::*;
 205   use crate::{
 206     objects::{
 207       instance::{tests::parse_lemmy_instance, ApubSite},
 208       tests::init_context,
 209     },
 210     protocol::{objects::instance::Instance, tests::file_to_json_object},
 211   };
 212   use lemmy_db_schema::{source::site::Site, traits::Crud};
 213   use serial_test::serial;
 214
 215   pub(crate) async fn parse_lemmy_person(context: &LemmyContext) -> (ApubPerson, ApubSite) {
 216     let site = parse_lemmy_instance(context).await;
 217     let json = file_to_json_object("assets/lemmy/objects/person.json").unwrap();
 218     let url = Url::parse("https://enterprise.lemmy.ml/u/picard").unwrap();
 219     let mut request_counter = 0;
 220     ApubPerson::verify(&json, &url, context, &mut request_counter)
 221       .await
 222       .unwrap();
 223     let person = ApubPerson::from_apub(json, context, &mut request_counter)
 224       .await
 225       .unwrap();
 226     assert_eq!(request_counter, 0);
 227     (person, site)
 228   }
 229
 230   #[actix_rt::test]
 231   #[serial]
 232   async fn test_parse_lemmy_person() {
 233     let context = init_context();
 234     let (person, site) = parse_lemmy_person(&context).await;
 235
 236     assert_eq!(person.display_name, Some("Jean-Luc Picard".to_string()));
 237     assert!(!person.local);
 238     assert_eq!(person.bio.as_ref().unwrap().len(), 39);
 239
 240     DbPerson::delete(&*context.pool().get().unwrap(), person.id).unwrap();
 241     Site::delete(&*context.pool().get().unwrap(), site.id).unwrap();
 242   }
 243
 244   #[actix_rt::test]
 245   #[serial]
 246   async fn test_parse_pleroma_person() {
 247     let context = init_context();
 248
 249     // create and parse a fake pleroma instance actor, to avoid network request during test
 250     let mut json: Instance = file_to_json_object("assets/lemmy/objects/instance.json").unwrap();
 251     let id = Url::parse("https://queer.hacktivis.me/").unwrap();
 252     json.id = ObjectId::new(id);
 253     let mut request_counter = 0;
 254     let site = ApubSite::from_apub(json, &context, &mut request_counter)
 255       .await
 256       .unwrap();
 257
 258     let json = file_to_json_object("assets/pleroma/objects/person.json").unwrap();
 259     let url = Url::parse("https://queer.hacktivis.me/users/lanodan").unwrap();
 260     let mut request_counter = 0;
 261     ApubPerson::verify(&json, &url, &context, &mut request_counter)
 262       .await
 263       .unwrap();
 264     let person = ApubPerson::from_apub(json, &context, &mut request_counter)
 265       .await
 266       .unwrap();
 267
 268     assert_eq!(person.actor_id, url.into());
 269     assert_eq!(person.name, "lanodan");
 270     assert!(!person.local);
 271     assert_eq!(request_counter, 0);
 272     assert_eq!(person.bio.as_ref().unwrap().len(), 873);
 273
 274     DbPerson::delete(&*context.pool().get().unwrap(), person.id).unwrap();
 275     Site::delete(&*context.pool().get().unwrap(), site.id).unwrap();
 276   }
 277 }