crates/apub/src/objects/person.rs

   1 use crate::{
   2   check_is_apub_id_valid,
   3   generate_outbox_url,
   4   objects::{
   5     get_summary_from_string_or_source,
   6     instance::fetch_instance_actor_for_object,
   7     verify_image_domain_matches,
   8   },
   9   protocol::{
  10     objects::{
  11       person::{Person, UserTypes},
  12       Endpoints,
  13     },
  14     ImageObject,
  15     Source,
  16   },
  17 };
  18 use chrono::NaiveDateTime;
  19 use lemmy_api_common::blocking;
  20 use lemmy_apub_lib::{
  21   object_id::ObjectId,
  22   traits::{ActorType, ApubObject},
  23   verify::verify_domains_match,
  24 };
  25 use lemmy_db_schema::{
  26   naive_now,
  27   source::person::{Person as DbPerson, PersonForm},
  28   traits::ApubActor,
  29 };
  30 use lemmy_utils::{
  31   utils::{check_slurs, check_slurs_opt, convert_datetime, markdown_to_html},
  32   LemmyError,
  33 };
  34 use lemmy_websocket::LemmyContext;
  35 use std::ops::Deref;
  36 use url::Url;
  37
  38 #[derive(Clone, Debug, PartialEq)]
  39 pub struct ApubPerson(DbPerson);
  40
  41 impl Deref for ApubPerson {
  42   type Target = DbPerson;
  43   fn deref(&self) -> &Self::Target {
  44     &self.0
  45   }
  46 }
  47
  48 impl From<DbPerson> for ApubPerson {
  49   fn from(p: DbPerson) -> Self {
  50     ApubPerson { 0: p }
  51   }
  52 }
  53
  54 #[async_trait::async_trait(?Send)]
  55 impl ApubObject for ApubPerson {
  56   type DataType = LemmyContext;
  57   type ApubType = Person;
  58   type DbType = DbPerson;
  59   type TombstoneType = ();
  60
  61   fn last_refreshed_at(&self) -> Option<NaiveDateTime> {
  62     Some(self.last_refreshed_at)
  63   }
  64
  65   #[tracing::instrument(skip_all)]
  66   async fn read_from_apub_id(
  67     object_id: Url,
  68     context: &LemmyContext,
  69   ) -> Result<Option<Self>, LemmyError> {
  70     Ok(
  71       blocking(context.pool(), move |conn| {
  72         DbPerson::read_from_apub_id(conn, &object_id.into())
  73       })
  74       .await??
  75       .map(Into::into),
  76     )
  77   }
  78
  79   #[tracing::instrument(skip_all)]
  80   async fn delete(self, context: &LemmyContext) -> Result<(), LemmyError> {
  81     blocking(context.pool(), move |conn| {
  82       DbPerson::update_deleted(conn, self.id, true)
  83     })
  84     .await??;
  85     Ok(())
  86   }
  87
  88   #[tracing::instrument(skip_all)]
  89   async fn into_apub(self, _pool: &LemmyContext) -> Result<Person, LemmyError> {
  90     let kind = if self.bot_account {
  91       UserTypes::Service
  92     } else {
  93       UserTypes::Person
  94     };
  95
  96     let person = Person {
  97       kind,
  98       id: ObjectId::new(self.actor_id.clone()),
  99       preferred_username: self.name.clone(),
 100       name: self.display_name.clone(),
 101       summary: self.bio.as_ref().map(|b| markdown_to_html(b)),
 102       source: self.bio.clone().map(Source::new),
 103       icon: self.avatar.clone().map(ImageObject::new),
 104       image: self.banner.clone().map(ImageObject::new),
 105       matrix_user_id: self.matrix_user_id.clone(),
 106       published: Some(convert_datetime(self.published)),
 107       outbox: generate_outbox_url(&self.actor_id)?.into(),
 108       endpoints: self.shared_inbox_url.clone().map(|s| Endpoints {
 109         shared_inbox: s.into(),
 110       }),
 111       public_key: self.get_public_key()?,
 112       updated: self.updated.map(convert_datetime),
 113       inbox: self.inbox_url.clone().into(),
 114     };
 115     Ok(person)
 116   }
 117
 118   fn to_tombstone(&self) -> Result<(), LemmyError> {
 119     unimplemented!()
 120   }
 121
 122   #[tracing::instrument(skip_all)]
 123   async fn verify(
 124     person: &Person,
 125     expected_domain: &Url,
 126     context: &LemmyContext,
 127     _request_counter: &mut i32,
 128   ) -> Result<(), LemmyError> {
 129     verify_domains_match(person.id.inner(), expected_domain)?;
 130     check_is_apub_id_valid(person.id.inner(), false, &context.settings())?;
 131     verify_image_domain_matches(expected_domain, &person.icon)?;
 132     verify_image_domain_matches(expected_domain, &person.image)?;
 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
 178     let actor_id = person.actor_id.clone().into();
 179     fetch_instance_actor_for_object(actor_id, context, request_counter).await;
 180
 181     Ok(person.into())
 182   }
 183 }
 184
 185 impl ActorType for ApubPerson {
 186   fn actor_id(&self) -> Url {
 187     self.actor_id.to_owned().into()
 188   }
 189
 190   fn public_key(&self) -> String {
 191     self.public_key.to_owned()
 192   }
 193
 194   fn private_key(&self) -> Option<String> {
 195     self.private_key.to_owned()
 196   }
 197
 198   fn inbox_url(&self) -> Url {
 199     self.inbox_url.clone().into()
 200   }
 201
 202   fn shared_inbox_url(&self) -> Option<Url> {
 203     self.shared_inbox_url.clone().map(|s| s.into())
 204   }
 205 }
 206
 207 #[cfg(test)]
 208 pub(crate) mod tests {
 209   use super::*;
 210   use crate::{
 211     objects::{
 212       instance::{tests::parse_lemmy_instance, ApubSite},
 213       tests::init_context,
 214     },
 215     protocol::{objects::instance::Instance, tests::file_to_json_object},
 216   };
 217   use lemmy_db_schema::{source::site::Site, traits::Crud};
 218   use serial_test::serial;
 219
 220   pub(crate) async fn parse_lemmy_person(context: &LemmyContext) -> (ApubPerson, ApubSite) {
 221     let site = parse_lemmy_instance(context).await;
 222     let json = file_to_json_object("assets/lemmy/objects/person.json").unwrap();
 223     let url = Url::parse("https://enterprise.lemmy.ml/u/picard").unwrap();
 224     let mut request_counter = 0;
 225     ApubPerson::verify(&json, &url, context, &mut request_counter)
 226       .await
 227       .unwrap();
 228     let person = ApubPerson::from_apub(json, context, &mut request_counter)
 229       .await
 230       .unwrap();
 231     assert_eq!(request_counter, 0);
 232     (person, site)
 233   }
 234
 235   #[actix_rt::test]
 236   #[serial]
 237   async fn test_parse_lemmy_person() {
 238     let context = init_context();
 239     let (person, site) = parse_lemmy_person(&context).await;
 240
 241     assert_eq!(person.display_name, Some("Jean-Luc Picard".to_string()));
 242     assert!(!person.local);
 243     assert_eq!(person.bio.as_ref().unwrap().len(), 39);
 244
 245     DbPerson::delete(&*context.pool().get().unwrap(), person.id).unwrap();
 246     Site::delete(&*context.pool().get().unwrap(), site.id).unwrap();
 247   }
 248
 249   #[actix_rt::test]
 250   #[serial]
 251   async fn test_parse_pleroma_person() {
 252     let context = init_context();
 253
 254     // create and parse a fake pleroma instance actor, to avoid network request during test
 255     let mut json: Instance = file_to_json_object("assets/lemmy/objects/instance.json").unwrap();
 256     let id = Url::parse("https://queer.hacktivis.me/").unwrap();
 257     json.id = ObjectId::new(id);
 258     let mut request_counter = 0;
 259     let site = ApubSite::from_apub(json, &context, &mut request_counter)
 260       .await
 261       .unwrap();
 262
 263     let json = file_to_json_object("assets/pleroma/objects/person.json").unwrap();
 264     let url = Url::parse("https://queer.hacktivis.me/users/lanodan").unwrap();
 265     let mut request_counter = 0;
 266     ApubPerson::verify(&json, &url, &context, &mut request_counter)
 267       .await
 268       .unwrap();
 269     let person = ApubPerson::from_apub(json, &context, &mut request_counter)
 270       .await
 271       .unwrap();
 272
 273     assert_eq!(person.actor_id, url.into());
 274     assert_eq!(person.name, "lanodan");
 275     assert!(!person.local);
 276     assert_eq!(request_counter, 0);
 277     assert_eq!(person.bio.as_ref().unwrap().len(), 873);
 278
 279     DbPerson::delete(&*context.pool().get().unwrap(), person.id).unwrap();
 280     Site::delete(&*context.pool().get().unwrap(), site.id).unwrap();
 281   }
 282 }