2 check_apub_id_valid_with_strictness,
4 objects::{instance::fetch_instance_actor_for_object, read_from_string_or_source_opt},
7 person::{Person, UserTypes},
15 use activitypub_federation::{
16 core::object_id::ObjectId,
17 traits::{Actor, ApubObject},
18 utils::verify_domains_match,
20 use chrono::NaiveDateTime;
21 use lemmy_api_common::{
22 context::LemmyContext,
23 utils::{generate_outbox_url, local_site_opt_to_slur_regex},
25 use lemmy_db_schema::{
28 person::{Person as DbPerson, PersonInsertForm, PersonUpdateForm},
30 traits::{ApubActor, Crud},
35 utils::{check_slurs, check_slurs_opt, convert_datetime, markdown_to_html},
40 #[derive(Clone, Debug, PartialEq, Eq)]
41 pub struct ApubPerson(pub(crate) DbPerson);
43 impl Deref for ApubPerson {
44 type Target = DbPerson;
45 fn deref(&self) -> &Self::Target {
50 impl From<DbPerson> for ApubPerson {
51 fn from(p: DbPerson) -> Self {
56 #[async_trait::async_trait(?Send)]
57 impl ApubObject for ApubPerson {
58 type DataType = LemmyContext;
59 type ApubType = Person;
60 type DbType = DbPerson;
61 type Error = LemmyError;
63 fn last_refreshed_at(&self) -> Option<NaiveDateTime> {
64 Some(self.last_refreshed_at)
67 #[tracing::instrument(skip_all)]
68 async fn read_from_apub_id(
70 context: &LemmyContext,
71 ) -> Result<Option<Self>, LemmyError> {
73 DbPerson::read_from_apub_id(context.pool(), &object_id.into())
79 #[tracing::instrument(skip_all)]
80 async fn delete(self, context: &LemmyContext) -> Result<(), LemmyError> {
81 let form = PersonUpdateForm::builder().deleted(Some(true)).build();
82 DbPerson::update(context.pool(), self.id, &form).await?;
86 #[tracing::instrument(skip_all)]
87 async fn into_apub(self, _pool: &LemmyContext) -> Result<Person, LemmyError> {
88 let kind = if self.bot_account {
96 id: ObjectId::new(self.actor_id.clone()),
97 preferred_username: self.name.clone(),
98 name: self.display_name.clone(),
99 summary: self.bio.as_ref().map(|b| markdown_to_html(b)),
100 source: self.bio.clone().map(Source::new),
101 icon: self.avatar.clone().map(ImageObject::new),
102 image: self.banner.clone().map(ImageObject::new),
103 matrix_user_id: self.matrix_user_id.clone(),
104 published: Some(convert_datetime(self.published)),
105 outbox: generate_outbox_url(&self.actor_id)?.into(),
106 endpoints: self.shared_inbox_url.clone().map(|s| Endpoints {
107 shared_inbox: s.into(),
109 public_key: self.get_public_key(),
110 updated: self.updated.map(convert_datetime),
111 inbox: self.inbox_url.clone().into(),
116 #[tracing::instrument(skip_all)]
119 expected_domain: &Url,
120 context: &LemmyContext,
121 _request_counter: &mut i32,
122 ) -> Result<(), LemmyError> {
123 let local_site_data = fetch_local_site_data(context.pool()).await?;
124 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)?;
129 verify_domains_match(person.id.inner(), expected_domain)?;
130 check_apub_id_valid_with_strictness(
137 let bio = read_from_string_or_source_opt(&person.summary, &None, &person.source);
138 check_slurs_opt(&bio, slur_regex)?;
142 #[tracing::instrument(skip_all)]
145 context: &LemmyContext,
146 request_counter: &mut i32,
147 ) -> Result<ApubPerson, LemmyError> {
148 let apub_id = person.id.inner().clone();
149 let instance = Instance::create_from_actor_id(context.pool(), &apub_id).await?;
151 let person_form = PersonInsertForm {
152 name: person.preferred_username,
153 display_name: person.name,
156 deleted: Some(false),
157 avatar: person.icon.map(|i| i.url.into()),
158 banner: person.image.map(|i| i.url.into()),
159 published: person.published.map(|u| u.naive_local()),
160 updated: person.updated.map(|u| u.naive_local()),
161 actor_id: Some(person.id.into()),
162 bio: read_from_string_or_source_opt(&person.summary, &None, &person.source),
165 bot_account: Some(person.kind == UserTypes::Service),
167 public_key: person.public_key.public_key_pem,
168 last_refreshed_at: Some(naive_now()),
169 inbox_url: Some(person.inbox.into()),
170 shared_inbox_url: person.endpoints.map(|e| e.shared_inbox.into()),
171 matrix_user_id: person.matrix_user_id,
172 instance_id: instance.id,
174 let person = DbPerson::create(context.pool(), &person_form).await?;
176 let actor_id = person.actor_id.clone().into();
177 fetch_instance_actor_for_object(actor_id, context, request_counter).await;
183 impl ActorType for ApubPerson {
184 fn actor_id(&self) -> Url {
185 self.actor_id.clone().into()
188 fn private_key(&self) -> Option<String> {
189 self.private_key.clone()
193 impl Actor for ApubPerson {
194 fn public_key(&self) -> &str {
198 fn inbox(&self) -> Url {
199 self.inbox_url.clone().into()
202 fn shared_inbox(&self) -> Option<Url> {
203 self.shared_inbox_url.clone().map(Into::into)
208 pub(crate) mod tests {
212 instance::{tests::parse_lemmy_instance, ApubSite},
215 protocol::{objects::instance::Instance, tests::file_to_json_object},
217 use lemmy_db_schema::{source::site::Site, traits::Crud};
218 use serial_test::serial;
220 pub(crate) async fn parse_lemmy_person(context: &LemmyContext) -> (ApubPerson, ApubSite) {
221 let site = parse_lemmy_instance(context).await;
222 let json = file_to_json_object("assets/lemmy/objects/person.json").unwrap();
223 let url = Url::parse("https://enterprise.lemmy.ml/u/picard").unwrap();
224 let mut request_counter = 0;
225 ApubPerson::verify(&json, &url, context, &mut request_counter)
228 let person = ApubPerson::from_apub(json, context, &mut request_counter)
231 assert_eq!(request_counter, 0);
237 async fn test_parse_lemmy_person() {
238 let context = init_context().await;
239 let (person, site) = parse_lemmy_person(&context).await;
241 assert_eq!(person.display_name, Some("Jean-Luc Picard".to_string()));
242 assert!(!person.local);
243 assert_eq!(person.bio.as_ref().unwrap().len(), 39);
245 cleanup((person, site), &context).await;
250 async fn test_parse_pleroma_person() {
251 let context = init_context().await;
253 // create and parse a fake pleroma instance actor, to avoid network request during test
254 let mut json: Instance = file_to_json_object("assets/lemmy/objects/instance.json").unwrap();
255 let id = Url::parse("https://queer.hacktivis.me/").unwrap();
256 json.id = ObjectId::new(id);
257 let mut request_counter = 0;
258 let site = ApubSite::from_apub(json, &context, &mut request_counter)
262 let json = file_to_json_object("assets/pleroma/objects/person.json").unwrap();
263 let url = Url::parse("https://queer.hacktivis.me/users/lanodan").unwrap();
264 let mut request_counter = 0;
265 ApubPerson::verify(&json, &url, &context, &mut request_counter)
268 let person = ApubPerson::from_apub(json, &context, &mut request_counter)
272 assert_eq!(person.actor_id, url.into());
273 assert_eq!(person.name, "lanodan");
274 assert!(!person.local);
275 assert_eq!(request_counter, 0);
276 assert_eq!(person.bio.as_ref().unwrap().len(), 873);
278 cleanup((person, site), &context).await;
281 async fn cleanup(data: (ApubPerson, ApubSite), context: &LemmyContext) {
282 DbPerson::delete(context.pool(), data.0.id).await.unwrap();
283 Site::delete(context.pool(), data.1.id).await.unwrap();