crates/apub/src/objects/person.rs

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