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, LemmyContext};
  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 std::ops::Deref;
  36 use url::Url;
  37
  38 #[derive(Clone, Debug, PartialEq, Eq)]
  39 pub struct ApubPerson(pub(crate) 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(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 Error = LemmyError;
  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       DbPerson::read_from_apub_id(context.pool(), &object_id.into())
  72         .await?
  73         .map(Into::into),
  74     )
  75   }
  76
  77   #[tracing::instrument(skip_all)]
  78   async fn delete(self, context: &LemmyContext) -> Result<(), LemmyError> {
  79     let form = PersonUpdateForm::builder().deleted(Some(true)).build();
  80     DbPerson::update(context.pool(), self.id, &form).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   #[tracing::instrument(skip_all)]
 115   async fn verify(
 116     person: &Person,
 117     expected_domain: &Url,
 118     context: &LemmyContext,
 119     _request_counter: &mut i32,
 120   ) -> Result<(), LemmyError> {
 121     let local_site_data = fetch_local_site_data(context.pool()).await?;
 122     let slur_regex = &local_site_opt_to_slur_regex(&local_site_data.local_site);
 123
 124     check_slurs(&person.preferred_username, slur_regex)?;
 125     check_slurs_opt(&person.name, slur_regex)?;
 126
 127     verify_domains_match(person.id.inner(), expected_domain)?;
 128     check_apub_id_valid_with_strictness(
 129       person.id.inner(),
 130       false,
 131       &local_site_data,
 132       context.settings(),
 133     )?;
 134
 135     let bio = read_from_string_or_source_opt(&person.summary, &None, &person.source);
 136     check_slurs_opt(&bio, slur_regex)?;
 137     Ok(())
 138   }
 139
 140   #[tracing::instrument(skip_all)]
 141   async fn from_apub(
 142     person: Person,
 143     context: &LemmyContext,
 144     request_counter: &mut i32,
 145   ) -> Result<ApubPerson, LemmyError> {
 146     let apub_id = person.id.inner().clone();
 147     let instance = Instance::create_from_actor_id(context.pool(), &apub_id).await?;
 148
 149     let person_form = PersonInsertForm {
 150       name: person.preferred_username,
 151       display_name: person.name,
 152       banned: None,
 153       ban_expires: None,
 154       deleted: Some(false),
 155       avatar: person.icon.map(|i| i.url.into()),
 156       banner: person.image.map(|i| i.url.into()),
 157       published: person.published.map(|u| u.naive_local()),
 158       updated: person.updated.map(|u| u.naive_local()),
 159       actor_id: Some(person.id.into()),
 160       bio: read_from_string_or_source_opt(&person.summary, &None, &person.source),
 161       local: Some(false),
 162       admin: Some(false),
 163       bot_account: Some(person.kind == UserTypes::Service),
 164       private_key: None,
 165       public_key: person.public_key.public_key_pem,
 166       last_refreshed_at: Some(naive_now()),
 167       inbox_url: Some(person.inbox.into()),
 168       shared_inbox_url: person.endpoints.map(|e| e.shared_inbox.into()),
 169       matrix_user_id: person.matrix_user_id,
 170       instance_id: instance.id,
 171     };
 172     let person = DbPerson::create(context.pool(), &person_form).await?;
 173
 174     let actor_id = person.actor_id.clone().into();
 175     fetch_instance_actor_for_object(actor_id, context, request_counter).await;
 176
 177     Ok(person.into())
 178   }
 179 }
 180
 181 impl ActorType for ApubPerson {
 182   fn actor_id(&self) -> Url {
 183     self.actor_id.clone().into()
 184   }
 185
 186   fn private_key(&self) -> Option<String> {
 187     self.private_key.clone()
 188   }
 189 }
 190
 191 impl Actor for ApubPerson {
 192   fn public_key(&self) -> &str {
 193     &self.public_key
 194   }
 195
 196   fn inbox(&self) -> Url {
 197     self.inbox_url.clone().into()
 198   }
 199
 200   fn shared_inbox(&self) -> Option<Url> {
 201     self.shared_inbox_url.clone().map(Into::into)
 202   }
 203 }
 204
 205 #[cfg(test)]
 206 pub(crate) mod tests {
 207   use super::*;
 208   use crate::{
 209     objects::{
 210       instance::{tests::parse_lemmy_instance, ApubSite},
 211       tests::init_context,
 212     },
 213     protocol::{objects::instance::Instance, tests::file_to_json_object},
 214   };
 215   use lemmy_db_schema::{source::site::Site, traits::Crud};
 216   use serial_test::serial;
 217
 218   pub(crate) async fn parse_lemmy_person(context: &LemmyContext) -> (ApubPerson, ApubSite) {
 219     let site = parse_lemmy_instance(context).await;
 220     let json = file_to_json_object("assets/lemmy/objects/person.json").unwrap();
 221     let url = Url::parse("https://enterprise.lemmy.ml/u/picard").unwrap();
 222     let mut request_counter = 0;
 223     ApubPerson::verify(&json, &url, context, &mut request_counter)
 224       .await
 225       .unwrap();
 226     let person = ApubPerson::from_apub(json, context, &mut request_counter)
 227       .await
 228       .unwrap();
 229     assert_eq!(request_counter, 0);
 230     (person, site)
 231   }
 232
 233   #[actix_rt::test]
 234   #[serial]
 235   async fn test_parse_lemmy_person() {
 236     let context = init_context().await;
 237     let (person, site) = parse_lemmy_person(&context).await;
 238
 239     assert_eq!(person.display_name, Some("Jean-Luc Picard".to_string()));
 240     assert!(!person.local);
 241     assert_eq!(person.bio.as_ref().unwrap().len(), 39);
 242
 243     cleanup((person, site), &context).await;
 244   }
 245
 246   #[actix_rt::test]
 247   #[serial]
 248   async fn test_parse_pleroma_person() {
 249     let context = init_context().await;
 250
 251     // create and parse a fake pleroma instance actor, to avoid network request during test
 252     let mut json: Instance = file_to_json_object("assets/lemmy/objects/instance.json").unwrap();
 253     let id = Url::parse("https://queer.hacktivis.me/").unwrap();
 254     json.id = ObjectId::new(id);
 255     let mut request_counter = 0;
 256     let site = ApubSite::from_apub(json, &context, &mut request_counter)
 257       .await
 258       .unwrap();
 259
 260     let json = file_to_json_object("assets/pleroma/objects/person.json").unwrap();
 261     let url = Url::parse("https://queer.hacktivis.me/users/lanodan").unwrap();
 262     let mut request_counter = 0;
 263     ApubPerson::verify(&json, &url, &context, &mut request_counter)
 264       .await
 265       .unwrap();
 266     let person = ApubPerson::from_apub(json, &context, &mut request_counter)
 267       .await
 268       .unwrap();
 269
 270     assert_eq!(person.actor_id, url.into());
 271     assert_eq!(person.name, "lanodan");
 272     assert!(!person.local);
 273     assert_eq!(request_counter, 0);
 274     assert_eq!(person.bio.as_ref().unwrap().len(), 873);
 275
 276     cleanup((person, site), &context).await;
 277   }
 278
 279   async fn cleanup(data: (ApubPerson, ApubSite), context: &LemmyContext) {
 280     DbPerson::delete(context.pool(), data.0.id).await.unwrap();
 281     Site::delete(context.pool(), data.1.id).await.unwrap();
 282   }
 283 }