crates/apub/src/objects/person.rs

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