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