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::{
26 source::person::{Person as DbPerson, PersonInsertForm, PersonUpdateForm},
27 traits::{ApubActor, Crud},
33 markdown::markdown_to_html,
34 slurs::{check_slurs, check_slurs_opt},
35 time::convert_datetime,
41 #[derive(Clone, Debug, PartialEq, Eq)]
42 pub struct ApubPerson(pub(crate) DbPerson);
44 impl Deref for ApubPerson {
45 type Target = DbPerson;
46 fn deref(&self) -> &Self::Target {
51 impl From<DbPerson> for ApubPerson {
52 fn from(p: DbPerson) -> Self {
57 #[async_trait::async_trait(?Send)]
58 impl ApubObject for ApubPerson {
59 type DataType = LemmyContext;
60 type ApubType = Person;
61 type DbType = DbPerson;
62 type Error = LemmyError;
64 fn last_refreshed_at(&self) -> Option<NaiveDateTime> {
65 Some(self.last_refreshed_at)
68 #[tracing::instrument(skip_all)]
69 async fn read_from_apub_id(
71 context: &LemmyContext,
72 ) -> Result<Option<Self>, LemmyError> {
74 DbPerson::read_from_apub_id(context.pool(), &object_id.into())
80 #[tracing::instrument(skip_all)]
81 async fn delete(self, context: &LemmyContext) -> Result<(), LemmyError> {
82 let form = PersonUpdateForm::builder().deleted(Some(true)).build();
83 DbPerson::update(context.pool(), self.id, &form).await?;
87 #[tracing::instrument(skip_all)]
88 async fn into_apub(self, _pool: &LemmyContext) -> Result<Person, LemmyError> {
89 let kind = if self.bot_account {
97 id: ObjectId::new(self.actor_id.clone()),
98 preferred_username: self.name.clone(),
99 name: self.display_name.clone(),
100 summary: self.bio.as_ref().map(|b| markdown_to_html(b)),
101 source: self.bio.clone().map(Source::new),
102 icon: self.avatar.clone().map(ImageObject::new),
103 image: self.banner.clone().map(ImageObject::new),
104 matrix_user_id: self.matrix_user_id.clone(),
105 published: Some(convert_datetime(self.published)),
106 outbox: generate_outbox_url(&self.actor_id)?.into(),
107 endpoints: self.shared_inbox_url.clone().map(|s| Endpoints {
108 shared_inbox: s.into(),
110 public_key: self.get_public_key(),
111 updated: self.updated.map(convert_datetime),
112 inbox: self.inbox_url.clone().into(),
117 #[tracing::instrument(skip_all)]
120 expected_domain: &Url,
121 context: &LemmyContext,
122 _request_counter: &mut i32,
123 ) -> Result<(), LemmyError> {
124 let local_site_data = fetch_local_site_data(context.pool()).await?;
125 let slur_regex = &local_site_opt_to_slur_regex(&local_site_data.local_site);
127 check_slurs(&person.preferred_username, slur_regex)?;
128 check_slurs_opt(&person.name, slur_regex)?;
130 verify_domains_match(person.id.inner(), expected_domain)?;
131 check_apub_id_valid_with_strictness(
138 let bio = read_from_string_or_source_opt(&person.summary, &None, &person.source);
139 check_slurs_opt(&bio, slur_regex)?;
143 #[tracing::instrument(skip_all)]
146 context: &LemmyContext,
147 request_counter: &mut i32,
148 ) -> Result<ApubPerson, LemmyError> {
149 let instance_id = fetch_instance_actor_for_object(&person.id, context, request_counter).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,
174 let person = DbPerson::create(context.pool(), &person_form).await?;
180 impl ActorType for ApubPerson {
181 fn actor_id(&self) -> Url {
182 self.actor_id.clone().into()
185 fn private_key(&self) -> Option<String> {
186 self.private_key.clone()
190 impl Actor for ApubPerson {
191 fn public_key(&self) -> &str {
195 fn inbox(&self) -> Url {
196 self.inbox_url.clone().into()
199 fn shared_inbox(&self) -> Option<Url> {
200 self.shared_inbox_url.clone().map(Into::into)
205 pub(crate) mod tests {
209 instance::{tests::parse_lemmy_instance, ApubSite},
212 protocol::{objects::instance::Instance, tests::file_to_json_object},
214 use lemmy_db_schema::{source::site::Site, traits::Crud};
215 use serial_test::serial;
217 pub(crate) async fn parse_lemmy_person(context: &LemmyContext) -> (ApubPerson, ApubSite) {
218 let site = parse_lemmy_instance(context).await;
219 let json = file_to_json_object("assets/lemmy/objects/person.json").unwrap();
220 let url = Url::parse("https://enterprise.lemmy.ml/u/picard").unwrap();
221 let mut request_counter = 0;
222 ApubPerson::verify(&json, &url, context, &mut request_counter)
225 let person = ApubPerson::from_apub(json, context, &mut request_counter)
228 assert_eq!(request_counter, 0);
234 async fn test_parse_lemmy_person() {
235 let context = init_context().await;
236 let (person, site) = parse_lemmy_person(&context).await;
238 assert_eq!(person.display_name, Some("Jean-Luc Picard".to_string()));
239 assert!(!person.local);
240 assert_eq!(person.bio.as_ref().unwrap().len(), 39);
242 cleanup((person, site), &context).await;
247 async fn test_parse_pleroma_person() {
248 let context = init_context().await;
250 // create and parse a fake pleroma instance actor, to avoid network request during test
251 let mut json: Instance = file_to_json_object("assets/lemmy/objects/instance.json").unwrap();
252 let id = Url::parse("https://queer.hacktivis.me/").unwrap();
253 json.id = ObjectId::new(id);
254 let mut request_counter = 0;
255 let site = ApubSite::from_apub(json, &context, &mut request_counter)
259 let json = file_to_json_object("assets/pleroma/objects/person.json").unwrap();
260 let url = Url::parse("https://queer.hacktivis.me/users/lanodan").unwrap();
261 let mut request_counter = 0;
262 ApubPerson::verify(&json, &url, &context, &mut request_counter)
265 let person = ApubPerson::from_apub(json, &context, &mut request_counter)
269 assert_eq!(person.actor_id, url.into());
270 assert_eq!(person.name, "lanodan");
271 assert!(!person.local);
272 assert_eq!(request_counter, 0);
273 assert_eq!(person.bio.as_ref().unwrap().len(), 873);
275 cleanup((person, site), &context).await;
278 async fn cleanup(data: (ApubPerson, ApubSite), context: &LemmyContext) {
279 DbPerson::delete(context.pool(), data.0.id).await.unwrap();
280 Site::delete(context.pool(), data.1.id).await.unwrap();