crates/apub/src/objects/person.rs

   1 use crate::{
   2   check_is_apub_id_valid,
   3   generate_outbox_url,
   4   objects::get_summary_from_string_or_source,
   5   protocol::{
   6     objects::{
   7       person::{Person, UserTypes},
   8       Endpoints,
   9     },
  10     ImageObject,
  11     Source,
  12   },
  13 };
  14 use activitystreams::object::kind::ImageType;
  15 use chrono::NaiveDateTime;
  16 use lemmy_api_common::blocking;
  17 use lemmy_apub_lib::{
  18   object_id::ObjectId,
  19   traits::{ActorType, ApubObject},
  20   values::MediaTypeMarkdown,
  21   verify::verify_domains_match,
  22 };
  23 use lemmy_db_schema::{
  24   naive_now,
  25   source::person::{Person as DbPerson, PersonForm},
  26 };
  27 use lemmy_utils::{
  28   utils::{check_slurs, check_slurs_opt, convert_datetime, markdown_to_html},
  29   LemmyError,
  30 };
  31 use lemmy_websocket::LemmyContext;
  32 use std::ops::Deref;
  33 use url::Url;
  34
  35 #[derive(Clone, Debug, PartialEq)]
  36 pub struct ApubPerson(DbPerson);
  37
  38 impl Deref for ApubPerson {
  39   type Target = DbPerson;
  40   fn deref(&self) -> &Self::Target {
  41     &self.0
  42   }
  43 }
  44
  45 impl From<DbPerson> for ApubPerson {
  46   fn from(p: DbPerson) -> Self {
  47     ApubPerson { 0: p }
  48   }
  49 }
  50
  51 #[async_trait::async_trait(?Send)]
  52 impl ApubObject for ApubPerson {
  53   type DataType = LemmyContext;
  54   type ApubType = Person;
  55   type TombstoneType = ();
  56
  57   fn last_refreshed_at(&self) -> Option<NaiveDateTime> {
  58     Some(self.last_refreshed_at)
  59   }
  60
  61   async fn read_from_apub_id(
  62     object_id: Url,
  63     context: &LemmyContext,
  64   ) -> Result<Option<Self>, LemmyError> {
  65     Ok(
  66       blocking(context.pool(), move |conn| {
  67         DbPerson::read_from_apub_id(conn, object_id)
  68       })
  69       .await??
  70       .map(Into::into),
  71     )
  72   }
  73
  74   async fn delete(self, context: &LemmyContext) -> Result<(), LemmyError> {
  75     blocking(context.pool(), move |conn| {
  76       DbPerson::update_deleted(conn, self.id, true)
  77     })
  78     .await??;
  79     Ok(())
  80   }
  81
  82   async fn into_apub(self, _pool: &LemmyContext) -> Result<Person, LemmyError> {
  83     let kind = if self.bot_account {
  84       UserTypes::Service
  85     } else {
  86       UserTypes::Person
  87     };
  88     let source = self.bio.clone().map(|bio| Source {
  89       content: bio,
  90       media_type: MediaTypeMarkdown::Markdown,
  91     });
  92     let icon = self.avatar.clone().map(|url| ImageObject {
  93       kind: ImageType::Image,
  94       url: url.into(),
  95     });
  96     let image = self.banner.clone().map(|url| ImageObject {
  97       kind: ImageType::Image,
  98       url: url.into(),
  99     });
 100
 101     let person = Person {
 102       kind,
 103       id: ObjectId::new(self.actor_id.clone()),
 104       preferred_username: self.name.clone(),
 105       name: self.display_name.clone(),
 106       summary: self.bio.as_ref().map(|b| markdown_to_html(b)),
 107       source,
 108       icon,
 109       image,
 110       matrix_user_id: self.matrix_user_id.clone(),
 111       published: Some(convert_datetime(self.published)),
 112       outbox: generate_outbox_url(&self.actor_id)?.into(),
 113       endpoints: Endpoints {
 114         shared_inbox: self.shared_inbox_url.clone().map(|s| s.into()),
 115       },
 116       public_key: self.get_public_key()?,
 117       updated: self.updated.map(convert_datetime),
 118       unparsed: Default::default(),
 119       inbox: self.inbox_url.clone().into(),
 120     };
 121     Ok(person)
 122   }
 123
 124   fn to_tombstone(&self) -> Result<(), LemmyError> {
 125     unimplemented!()
 126   }
 127
 128   async fn verify(
 129     person: &Person,
 130     expected_domain: &Url,
 131     context: &LemmyContext,
 132     _request_counter: &mut i32,
 133   ) -> Result<(), LemmyError> {
 134     verify_domains_match(person.id.inner(), expected_domain)?;
 135     check_is_apub_id_valid(person.id.inner(), false, &context.settings())?;
 136
 137     let slur_regex = &context.settings().slur_regex();
 138     check_slurs(&person.preferred_username, slur_regex)?;
 139     check_slurs_opt(&person.name, slur_regex)?;
 140     let bio = get_summary_from_string_or_source(&person.summary, &person.source);
 141     check_slurs_opt(&bio, slur_regex)?;
 142     Ok(())
 143   }
 144
 145   async fn from_apub(
 146     person: Person,
 147     context: &LemmyContext,
 148     _request_counter: &mut i32,
 149   ) -> Result<ApubPerson, LemmyError> {
 150     let person_form = PersonForm {
 151       name: person.preferred_username,
 152       display_name: Some(person.name),
 153       banned: None,
 154       deleted: None,
 155       avatar: Some(person.icon.map(|i| i.url.into())),
 156       banner: Some(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: Some(get_summary_from_string_or_source(
 161         &person.summary,
 162         &person.source,
 163       )),
 164       local: Some(false),
 165       admin: Some(false),
 166       bot_account: Some(person.kind == UserTypes::Service),
 167       private_key: None,
 168       public_key: Some(Some(person.public_key.public_key_pem)),
 169       last_refreshed_at: Some(naive_now()),
 170       inbox_url: Some(person.inbox.into()),
 171       shared_inbox_url: Some(person.endpoints.shared_inbox.map(|s| s.into())),
 172       matrix_user_id: Some(person.matrix_user_id),
 173     };
 174     let person = blocking(context.pool(), move |conn| {
 175       DbPerson::upsert(conn, &person_form)
 176     })
 177     .await??;
 178     Ok(person.into())
 179   }
 180 }
 181
 182 impl ActorType for ApubPerson {
 183   fn actor_id(&self) -> Url {
 184     self.actor_id.to_owned().into()
 185   }
 186
 187   fn public_key(&self) -> Option<String> {
 188     self.public_key.to_owned()
 189   }
 190
 191   fn private_key(&self) -> Option<String> {
 192     self.private_key.to_owned()
 193   }
 194
 195   fn inbox_url(&self) -> Url {
 196     self.inbox_url.clone().into()
 197   }
 198
 199   fn shared_inbox_url(&self) -> Option<Url> {
 200     self.shared_inbox_url.clone().map(|s| s.into())
 201   }
 202 }
 203
 204 #[cfg(test)]
 205 pub(crate) mod tests {
 206   use super::*;
 207   use crate::objects::tests::{file_to_json_object, init_context};
 208   use lemmy_db_schema::traits::Crud;
 209   use serial_test::serial;
 210
 211   pub(crate) async fn parse_lemmy_person(context: &LemmyContext) -> ApubPerson {
 212     let json = file_to_json_object("assets/lemmy/objects/person.json");
 213     let url = Url::parse("https://enterprise.lemmy.ml/u/picard").unwrap();
 214     let mut request_counter = 0;
 215     ApubPerson::verify(&json, &url, context, &mut request_counter)
 216       .await
 217       .unwrap();
 218     let person = ApubPerson::from_apub(json, context, &mut request_counter)
 219       .await
 220       .unwrap();
 221     assert_eq!(request_counter, 0);
 222     person
 223   }
 224
 225   #[actix_rt::test]
 226   #[serial]
 227   async fn test_parse_lemmy_person() {
 228     let context = init_context();
 229     let person = parse_lemmy_person(&context).await;
 230
 231     assert_eq!(person.display_name, Some("Jean-Luc Picard".to_string()));
 232     assert!(person.public_key.is_some());
 233     assert!(!person.local);
 234     assert_eq!(person.bio.as_ref().unwrap().len(), 39);
 235
 236     DbPerson::delete(&*context.pool().get().unwrap(), person.id).unwrap();
 237   }
 238
 239   #[actix_rt::test]
 240   #[serial]
 241   async fn test_parse_pleroma_person() {
 242     let context = init_context();
 243     let json = file_to_json_object("assets/pleroma/objects/person.json");
 244     let url = Url::parse("https://queer.hacktivis.me/users/lanodan").unwrap();
 245     let mut request_counter = 0;
 246     ApubPerson::verify(&json, &url, &context, &mut request_counter)
 247       .await
 248       .unwrap();
 249     let person = ApubPerson::from_apub(json, &context, &mut request_counter)
 250       .await
 251       .unwrap();
 252
 253     assert_eq!(person.actor_id, url.into());
 254     assert_eq!(person.name, "lanodan");
 255     assert!(person.public_key.is_some());
 256     assert!(!person.local);
 257     assert_eq!(request_counter, 0);
 258     assert_eq!(person.bio.as_ref().unwrap().len(), 873);
 259
 260     DbPerson::delete(&*context.pool().get().unwrap(), person.id).unwrap();
 261   }
 262 }