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::builder().deleted(Some(true)).build();
  81     DbPerson::update(&mut context.pool(), self.id, &form).await?;
  82     Ok(())
  83   }
  84
  85   #[tracing::instrument(skip_all)]
  86   async fn into_json(self, _context: &Data<Self::DataType>) -> 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: self.actor_id.clone().into(),
  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.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: &Data<Self::DataType>,
 120   ) -> Result<(), LemmyError> {
 121     let local_site_data = local_site_data_cached(&mut context.pool()).await?;
 122     let slur_regex = &local_site_opt_to_slur_regex(&local_site_data.local_site);
 123     check_slurs(&person.preferred_username, slur_regex)?;
 124     check_slurs_opt(&person.name, slur_regex)?;
 125
 126     verify_domains_match(person.id.inner(), expected_domain)?;
 127     check_apub_id_valid_with_strictness(person.id.inner(), false, context).await?;
 128
 129     let bio = read_from_string_or_source_opt(&person.summary, &None, &person.source);
 130     check_slurs_opt(&bio, slur_regex)?;
 131     Ok(())
 132   }
 133
 134   #[tracing::instrument(skip_all)]
 135   async fn from_json(
 136     person: Person,
 137     context: &Data<Self::DataType>,
 138   ) -> Result<ApubPerson, LemmyError> {
 139     let instance_id = fetch_instance_actor_for_object(&person.id, context).await?;
 140
 141     let name = sanitize_html(&person.preferred_username);
 142     let display_name = sanitize_html_opt(&person.name);
 143     let bio = read_from_string_or_source_opt(&person.summary, &None, &person.source);
 144     let bio = sanitize_html_opt(&bio);
 145
 146     // Some Mastodon users have `name: ""` (empty string), need to convert that to `None`
 147     // https://github.com/mastodon/mastodon/issues/25233
 148     let display_name = display_name.filter(|n| !n.is_empty());
 149
 150     let person_form = PersonInsertForm {
 151       name,
 152       display_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,
 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,
 172     };
 173     let person = DbPerson::upsert(&mut context.pool(), &person_form).await?;
 174
 175     Ok(person.into())
 176   }
 177 }
 178
 179 impl Actor for ApubPerson {
 180   fn id(&self) -> Url {
 181     self.actor_id.inner().clone()
 182   }
 183
 184   fn public_key_pem(&self) -> &str {
 185     &self.public_key
 186   }
 187
 188   fn private_key_pem(&self) -> Option<String> {
 189     self.private_key.clone()
 190   }
 191
 192   fn inbox(&self) -> Url {
 193     self.inbox_url.clone().into()
 194   }
 195
 196   fn shared_inbox(&self) -> Option<Url> {
 197     self.shared_inbox_url.clone().map(Into::into)
 198   }
 199 }
 200
 201 #[cfg(test)]
 202 pub(crate) mod tests {
 203   #![allow(clippy::unwrap_used)]
 204   #![allow(clippy::indexing_slicing)]
 205
 206   use super::*;
 207   use crate::{
 208     objects::{
 209       instance::{tests::parse_lemmy_instance, ApubSite},
 210       tests::init_context,
 211     },
 212     protocol::{objects::instance::Instance, tests::file_to_json_object},
 213   };
 214   use activitypub_federation::fetch::object_id::ObjectId;
 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: &Data<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     ApubPerson::verify(&json, &url, context).await.unwrap();
 223     let person = ApubPerson::from_json(json, context).await.unwrap();
 224     assert_eq!(context.request_count(), 0);
 225     (person, site)
 226   }
 227
 228   #[tokio::test]
 229   #[serial]
 230   async fn test_parse_lemmy_person() {
 231     let context = init_context().await;
 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     cleanup((person, site), &context).await;
 239   }
 240
 241   #[tokio::test]
 242   #[serial]
 243   async fn test_parse_pleroma_person() {
 244     let context = init_context().await;
 245
 246     // create and parse a fake pleroma instance actor, to avoid network request during test
 247     let mut json: Instance = file_to_json_object("assets/lemmy/objects/instance.json").unwrap();
 248     json.id = ObjectId::parse("https://queer.hacktivis.me/").unwrap();
 249     let url = Url::parse("https://queer.hacktivis.me/users/lanodan").unwrap();
 250     ApubSite::verify(&json, &url, &context).await.unwrap();
 251     let site = ApubSite::from_json(json, &context).await.unwrap();
 252
 253     let json = file_to_json_object("assets/pleroma/objects/person.json").unwrap();
 254     ApubPerson::verify(&json, &url, &context).await.unwrap();
 255     let person = ApubPerson::from_json(json, &context).await.unwrap();
 256
 257     assert_eq!(person.actor_id, url.into());
 258     assert_eq!(person.name, "lanodan");
 259     assert!(!person.local);
 260     assert_eq!(context.request_count(), 0);
 261     assert_eq!(person.bio.as_ref().unwrap().len(), 873);
 262
 263     cleanup((person, site), &context).await;
 264   }
 265
 266   async fn cleanup(data: (ApubPerson, ApubSite), context: &LemmyContext) {
 267     DbPerson::delete(&mut context.pool(), data.0.id)
 268       .await
 269       .unwrap();
 270     Site::delete(&mut context.pool(), data.1.id).await.unwrap();
 271   }
 272 }