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