crates/apub/src/objects/person.rs

   1 use crate::{
   2   check_apub_id_valid_with_strictness,
   3   fetch_local_site_data,
   4   generate_outbox_url,
   5   objects::{instance::fetch_instance_actor_for_object, read_from_string_or_source_opt},
   6   protocol::{
   7     objects::{
   8       person::{Person, UserTypes},
   9       Endpoints,
  10     },
  11     ImageObject,
  12     Source,
  13   },
  14   ActorType,
  15 };
  16 use activitypub_federation::{
  17   core::object_id::ObjectId,
  18   traits::{Actor, ApubObject},
  19   utils::verify_domains_match,
  20 };
  21 use chrono::NaiveDateTime;
  22 use lemmy_api_common::utils::local_site_opt_to_slur_regex;
  23 use lemmy_db_schema::{
  24   source::{
  25     instance::Instance,
  26     person::{Person as DbPerson, PersonInsertForm, PersonUpdateForm},
  27   },
  28   traits::{ApubActor, Crud},
  29   utils::naive_now,
  30 };
  31 use lemmy_utils::{
  32   error::LemmyError,
  33   utils::{check_slurs, check_slurs_opt, convert_datetime, markdown_to_html},
  34 };
  35 use lemmy_websocket::LemmyContext;
  36 use std::ops::Deref;
  37 use url::Url;
  38
  39 #[derive(Clone, Debug, PartialEq, Eq)]
  40 pub struct ApubPerson(pub(crate) DbPerson);
  41
  42 impl Deref for ApubPerson {
  43   type Target = DbPerson;
  44   fn deref(&self) -> &Self::Target {
  45     &self.0
  46   }
  47 }
  48
  49 impl From<DbPerson> for ApubPerson {
  50   fn from(p: DbPerson) -> Self {
  51     ApubPerson(p)
  52   }
  53 }
  54
  55 #[async_trait::async_trait(?Send)]
  56 impl ApubObject for ApubPerson {
  57   type DataType = LemmyContext;
  58   type ApubType = Person;
  59   type DbType = DbPerson;
  60   type Error = LemmyError;
  61
  62   fn last_refreshed_at(&self) -> Option<NaiveDateTime> {
  63     Some(self.last_refreshed_at)
  64   }
  65
  66   #[tracing::instrument(skip_all)]
  67   async fn read_from_apub_id(
  68     object_id: Url,
  69     context: &LemmyContext,
  70   ) -> Result<Option<Self>, LemmyError> {
  71     Ok(
  72       DbPerson::read_from_apub_id(context.pool(), &object_id.into())
  73         .await?
  74         .map(Into::into),
  75     )
  76   }
  77
  78   #[tracing::instrument(skip_all)]
  79   async fn delete(self, context: &LemmyContext) -> Result<(), LemmyError> {
  80     let form = PersonUpdateForm::builder().deleted(Some(true)).build();
  81     DbPerson::update(context.pool(), self.id, &form).await?;
  82     Ok(())
  83   }
  84
  85   #[tracing::instrument(skip_all)]
  86   async fn into_apub(self, _pool: &LemmyContext) -> Result<Person, LemmyError> {
  87     let kind = if self.bot_account {
  88       UserTypes::Service
  89     } else {
  90       UserTypes::Person
  91     };
  92
  93     let person = Person {
  94       kind,
  95       id: ObjectId::new(self.actor_id.clone()),
  96       preferred_username: self.name.clone(),
  97       name: self.display_name.clone(),
  98       summary: self.bio.as_ref().map(|b| markdown_to_html(b)),
  99       source: self.bio.clone().map(Source::new),
 100       icon: self.avatar.clone().map(ImageObject::new),
 101       image: self.banner.clone().map(ImageObject::new),
 102       matrix_user_id: self.matrix_user_id.clone(),
 103       published: Some(convert_datetime(self.published)),
 104       outbox: generate_outbox_url(&self.actor_id)?.into(),
 105       endpoints: self.shared_inbox_url.clone().map(|s| Endpoints {
 106         shared_inbox: s.into(),
 107       }),
 108       public_key: self.get_public_key(),
 109       updated: self.updated.map(convert_datetime),
 110       inbox: self.inbox_url.clone().into(),
 111     };
 112     Ok(person)
 113   }
 114
 115   #[tracing::instrument(skip_all)]
 116   async fn verify(
 117     person: &Person,
 118     expected_domain: &Url,
 119     context: &LemmyContext,
 120     _request_counter: &mut i32,
 121   ) -> Result<(), LemmyError> {
 122     let local_site_data = fetch_local_site_data(context.pool()).await?;
 123     let slur_regex = &local_site_opt_to_slur_regex(&local_site_data.local_site);
 124
 125     check_slurs(&person.preferred_username, slur_regex)?;
 126     check_slurs_opt(&person.name, slur_regex)?;
 127
 128     verify_domains_match(person.id.inner(), expected_domain)?;
 129     check_apub_id_valid_with_strictness(
 130       person.id.inner(),
 131       false,
 132       &local_site_data,
 133       context.settings(),
 134     )?;
 135
 136     let bio = read_from_string_or_source_opt(&person.summary, &None, &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 apub_id = person.id.inner().clone();
 148     let instance = Instance::create_from_actor_id(context.pool(), &apub_id).await?;
 149
 150     let person_form = PersonInsertForm {
 151       name: person.preferred_username,
 152       display_name: person.name,
 153       banned: None,
 154       ban_expires: None,
 155       deleted: Some(false),
 156       avatar: person.icon.map(|i| i.url.into()),
 157       banner: person.image.map(|i| i.url.into()),
 158       published: person.published.map(|u| u.naive_local()),
 159       updated: person.updated.map(|u| u.naive_local()),
 160       actor_id: Some(person.id.into()),
 161       bio: read_from_string_or_source_opt(&person.summary, &None, &person.source),
 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: person.endpoints.map(|e| e.shared_inbox.into()),
 170       matrix_user_id: person.matrix_user_id,
 171       instance_id: instance.id,
 172     };
 173     let person = DbPerson::create(context.pool(), &person_form).await?;
 174
 175     let actor_id = person.actor_id.clone().into();
 176     fetch_instance_actor_for_object(actor_id, context, request_counter).await;
 177
 178     Ok(person.into())
 179   }
 180 }
 181
 182 impl ActorType for ApubPerson {
 183   fn actor_id(&self) -> Url {
 184     self.actor_id.clone().into()
 185   }
 186
 187   fn private_key(&self) -> Option<String> {
 188     self.private_key.clone()
 189   }
 190 }
 191
 192 impl Actor for ApubPerson {
 193   fn public_key(&self) -> &str {
 194     &self.public_key
 195   }
 196
 197   fn inbox(&self) -> Url {
 198     self.inbox_url.clone().into()
 199   }
 200
 201   fn shared_inbox(&self) -> Option<Url> {
 202     self.shared_inbox_url.clone().map(Into::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().await;
 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     cleanup((person, site), &context).await;
 245   }
 246
 247   #[actix_rt::test]
 248   #[serial]
 249   async fn test_parse_pleroma_person() {
 250     let context = init_context().await;
 251
 252     // create and parse a fake pleroma instance actor, to avoid network request during test
 253     let mut json: Instance = file_to_json_object("assets/lemmy/objects/instance.json").unwrap();
 254     let id = Url::parse("https://queer.hacktivis.me/").unwrap();
 255     json.id = ObjectId::new(id);
 256     let mut request_counter = 0;
 257     let site = ApubSite::from_apub(json, &context, &mut request_counter)
 258       .await
 259       .unwrap();
 260
 261     let json = file_to_json_object("assets/pleroma/objects/person.json").unwrap();
 262     let url = Url::parse("https://queer.hacktivis.me/users/lanodan").unwrap();
 263     let mut request_counter = 0;
 264     ApubPerson::verify(&json, &url, &context, &mut request_counter)
 265       .await
 266       .unwrap();
 267     let person = ApubPerson::from_apub(json, &context, &mut request_counter)
 268       .await
 269       .unwrap();
 270
 271     assert_eq!(person.actor_id, url.into());
 272     assert_eq!(person.name, "lanodan");
 273     assert!(!person.local);
 274     assert_eq!(request_counter, 0);
 275     assert_eq!(person.bio.as_ref().unwrap().len(), 873);
 276
 277     cleanup((person, site), &context).await;
 278   }
 279
 280   async fn cleanup(data: (ApubPerson, ApubSite), context: &LemmyContext) {
 281     DbPerson::delete(context.pool(), data.0.id).await.unwrap();
 282     Site::delete(context.pool(), data.1.id).await.unwrap();
 283   }
 284 }