crates/apub/src/objects/person.rs

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