crates/apub/src/objects/comment.rs

   1 use crate::{
   2   activities::{verify_is_public, verify_person_in_community},
   3   check_apub_id_valid_with_strictness,
   4   fetch_local_site_data,
   5   local_instance,
   6   mentions::collect_non_local_mentions,
   7   objects::{read_from_string_or_source, verify_is_remote_object},
   8   protocol::{
   9     objects::{note::Note, LanguageTag},
  10     Source,
  11   },
  12   PostOrComment,
  13 };
  14 use activitypub_federation::{
  15   core::object_id::ObjectId,
  16   deser::values::MediaTypeMarkdownOrHtml,
  17   traits::ApubObject,
  18   utils::verify_domains_match,
  19 };
  20 use activitystreams_kinds::{object::NoteType, public};
  21 use chrono::NaiveDateTime;
  22 use lemmy_api_common::utils::local_site_opt_to_slur_regex;
  23 use lemmy_db_schema::{
  24   source::{
  25     comment::{Comment, CommentInsertForm, CommentUpdateForm},
  26     community::Community,
  27     local_site::LocalSite,
  28     person::Person,
  29     post::Post,
  30   },
  31   traits::Crud,
  32 };
  33 use lemmy_utils::{
  34   error::LemmyError,
  35   utils::{convert_datetime, markdown_to_html, remove_slurs},
  36 };
  37 use lemmy_websocket::LemmyContext;
  38 use std::ops::Deref;
  39 use url::Url;
  40
  41 #[derive(Clone, Debug)]
  42 pub struct ApubComment(Comment);
  43
  44 impl Deref for ApubComment {
  45   type Target = Comment;
  46   fn deref(&self) -> &Self::Target {
  47     &self.0
  48   }
  49 }
  50
  51 impl From<Comment> for ApubComment {
  52   fn from(c: Comment) -> Self {
  53     ApubComment(c)
  54   }
  55 }
  56
  57 #[async_trait::async_trait(?Send)]
  58 impl ApubObject for ApubComment {
  59   type DataType = LemmyContext;
  60   type ApubType = Note;
  61   type DbType = Comment;
  62   type Error = LemmyError;
  63
  64   fn last_refreshed_at(&self) -> Option<NaiveDateTime> {
  65     None
  66   }
  67
  68   #[tracing::instrument(skip_all)]
  69   async fn read_from_apub_id(
  70     object_id: Url,
  71     context: &LemmyContext,
  72   ) -> Result<Option<Self>, LemmyError> {
  73     Ok(
  74       Comment::read_from_apub_id(context.pool(), object_id)
  75         .await?
  76         .map(Into::into),
  77     )
  78   }
  79
  80   #[tracing::instrument(skip_all)]
  81   async fn delete(self, context: &LemmyContext) -> Result<(), LemmyError> {
  82     if !self.deleted {
  83       let form = CommentUpdateForm::builder().deleted(Some(true)).build();
  84       Comment::update(context.pool(), self.id, &form).await?;
  85     }
  86     Ok(())
  87   }
  88
  89   #[tracing::instrument(skip_all)]
  90   async fn into_apub(self, context: &LemmyContext) -> Result<Note, LemmyError> {
  91     let creator_id = self.creator_id;
  92     let creator = Person::read(context.pool(), creator_id).await?;
  93
  94     let post_id = self.post_id;
  95     let post = Post::read(context.pool(), post_id).await?;
  96     let community_id = post.community_id;
  97     let community = Community::read(context.pool(), community_id).await?;
  98
  99     let in_reply_to = if let Some(comment_id) = self.parent_comment_id() {
 100       let parent_comment = Comment::read(context.pool(), comment_id).await?;
 101       ObjectId::<PostOrComment>::new(parent_comment.ap_id)
 102     } else {
 103       ObjectId::<PostOrComment>::new(post.ap_id)
 104     };
 105     let language = LanguageTag::new_single(self.language_id, context.pool()).await?;
 106     let maa =
 107       collect_non_local_mentions(&self, ObjectId::new(community.actor_id), context, &mut 0).await?;
 108
 109     let note = Note {
 110       r#type: NoteType::Note,
 111       id: ObjectId::new(self.ap_id.clone()),
 112       attributed_to: ObjectId::new(creator.actor_id),
 113       to: vec![public()],
 114       cc: maa.ccs,
 115       content: markdown_to_html(&self.content),
 116       media_type: Some(MediaTypeMarkdownOrHtml::Html),
 117       source: Some(Source::new(self.content.clone())),
 118       in_reply_to,
 119       published: Some(convert_datetime(self.published)),
 120       updated: self.updated.map(convert_datetime),
 121       tag: maa.tags,
 122       distinguished: Some(self.distinguished),
 123       language,
 124     };
 125
 126     Ok(note)
 127   }
 128
 129   #[tracing::instrument(skip_all)]
 130   async fn verify(
 131     note: &Note,
 132     expected_domain: &Url,
 133     context: &LemmyContext,
 134     request_counter: &mut i32,
 135   ) -> Result<(), LemmyError> {
 136     verify_domains_match(note.id.inner(), expected_domain)?;
 137     verify_domains_match(note.attributed_to.inner(), note.id.inner())?;
 138     verify_is_public(&note.to, &note.cc)?;
 139     let (post, _) = note.get_parents(context, request_counter).await?;
 140     let community_id = post.community_id;
 141     let community = Community::read(context.pool(), community_id).await?;
 142     let local_site_data = fetch_local_site_data(context.pool()).await?;
 143
 144     check_apub_id_valid_with_strictness(
 145       note.id.inner(),
 146       community.local,
 147       &local_site_data,
 148       context.settings(),
 149     )?;
 150     verify_is_remote_object(note.id.inner(), context.settings())?;
 151     verify_person_in_community(
 152       &note.attributed_to,
 153       &community.into(),
 154       context,
 155       request_counter,
 156     )
 157     .await?;
 158     if post.locked {
 159       return Err(LemmyError::from_message("Post is locked"));
 160     }
 161     Ok(())
 162   }
 163
 164   /// Converts a `Note` to `Comment`.
 165   ///
 166   /// If the parent community, post and comment(s) are not known locally, these are also fetched.
 167   #[tracing::instrument(skip_all)]
 168   async fn from_apub(
 169     note: Note,
 170     context: &LemmyContext,
 171     request_counter: &mut i32,
 172   ) -> Result<ApubComment, LemmyError> {
 173     let creator = note
 174       .attributed_to
 175       .dereference(context, local_instance(context).await, request_counter)
 176       .await?;
 177     let (post, parent_comment) = note.get_parents(context, request_counter).await?;
 178
 179     let content = read_from_string_or_source(&note.content, &note.media_type, &note.source);
 180
 181     let local_site = LocalSite::read(context.pool()).await.ok();
 182     let slur_regex = &local_site_opt_to_slur_regex(&local_site);
 183     let content_slurs_removed = remove_slurs(&content, slur_regex);
 184     let language_id = LanguageTag::to_language_id_single(note.language, context.pool()).await?;
 185
 186     let form = CommentInsertForm {
 187       creator_id: creator.id,
 188       post_id: post.id,
 189       content: content_slurs_removed,
 190       removed: None,
 191       published: note.published.map(|u| u.naive_local()),
 192       updated: note.updated.map(|u| u.naive_local()),
 193       deleted: Some(false),
 194       ap_id: Some(note.id.into()),
 195       distinguished: note.distinguished,
 196       local: Some(false),
 197       language_id,
 198     };
 199     let parent_comment_path = parent_comment.map(|t| t.0.path);
 200     let comment = Comment::create(context.pool(), &form, parent_comment_path.as_ref()).await?;
 201     Ok(comment.into())
 202   }
 203 }
 204
 205 #[cfg(test)]
 206 pub(crate) mod tests {
 207   use super::*;
 208   use crate::{
 209     objects::{
 210       community::{tests::parse_lemmy_community, ApubCommunity},
 211       instance::ApubSite,
 212       person::{tests::parse_lemmy_person, ApubPerson},
 213       post::ApubPost,
 214       tests::init_context,
 215     },
 216     protocol::tests::file_to_json_object,
 217   };
 218   use assert_json_diff::assert_json_include;
 219   use html2md::parse_html;
 220   use lemmy_db_schema::source::site::Site;
 221   use serial_test::serial;
 222
 223   async fn prepare_comment_test(
 224     url: &Url,
 225     context: &LemmyContext,
 226   ) -> (ApubPerson, ApubCommunity, ApubPost, ApubSite) {
 227     let (person, site) = parse_lemmy_person(context).await;
 228     let community = parse_lemmy_community(context).await;
 229     let post_json = file_to_json_object("assets/lemmy/objects/page.json").unwrap();
 230     ApubPost::verify(&post_json, url, context, &mut 0)
 231       .await
 232       .unwrap();
 233     let post = ApubPost::from_apub(post_json, context, &mut 0)
 234       .await
 235       .unwrap();
 236     (person, community, post, site)
 237   }
 238
 239   async fn cleanup(data: (ApubPerson, ApubCommunity, ApubPost, ApubSite), context: &LemmyContext) {
 240     Post::delete(context.pool(), data.2.id).await.unwrap();
 241     Community::delete(context.pool(), data.1.id).await.unwrap();
 242     Person::delete(context.pool(), data.0.id).await.unwrap();
 243     Site::delete(context.pool(), data.3.id).await.unwrap();
 244     LocalSite::delete(context.pool()).await.unwrap();
 245   }
 246
 247   #[actix_rt::test]
 248   #[serial]
 249   pub(crate) async fn test_parse_lemmy_comment() {
 250     let context = init_context().await;
 251     let url = Url::parse("https://enterprise.lemmy.ml/comment/38741").unwrap();
 252     let data = prepare_comment_test(&url, &context).await;
 253
 254     let json: Note = file_to_json_object("assets/lemmy/objects/note.json").unwrap();
 255     let mut request_counter = 0;
 256     ApubComment::verify(&json, &url, &context, &mut request_counter)
 257       .await
 258       .unwrap();
 259     let comment = ApubComment::from_apub(json.clone(), &context, &mut request_counter)
 260       .await
 261       .unwrap();
 262
 263     assert_eq!(comment.ap_id, url.into());
 264     assert_eq!(comment.content.len(), 14);
 265     assert!(!comment.local);
 266     assert_eq!(request_counter, 0);
 267
 268     let comment_id = comment.id;
 269     let to_apub = comment.into_apub(&context).await.unwrap();
 270     assert_json_include!(actual: json, expected: to_apub);
 271
 272     Comment::delete(context.pool(), comment_id).await.unwrap();
 273     cleanup(data, &context).await;
 274   }
 275
 276   #[actix_rt::test]
 277   #[serial]
 278   async fn test_parse_pleroma_comment() {
 279     let context = init_context().await;
 280     let url = Url::parse("https://enterprise.lemmy.ml/comment/38741").unwrap();
 281     let data = prepare_comment_test(&url, &context).await;
 282
 283     let pleroma_url =
 284       Url::parse("https://queer.hacktivis.me/objects/8d4973f4-53de-49cd-8c27-df160e16a9c2")
 285         .unwrap();
 286     let person_json = file_to_json_object("assets/pleroma/objects/person.json").unwrap();
 287     ApubPerson::verify(&person_json, &pleroma_url, &context, &mut 0)
 288       .await
 289       .unwrap();
 290     ApubPerson::from_apub(person_json, &context, &mut 0)
 291       .await
 292       .unwrap();
 293     let json = file_to_json_object("assets/pleroma/objects/note.json").unwrap();
 294     let mut request_counter = 0;
 295     ApubComment::verify(&json, &pleroma_url, &context, &mut request_counter)
 296       .await
 297       .unwrap();
 298     let comment = ApubComment::from_apub(json, &context, &mut request_counter)
 299       .await
 300       .unwrap();
 301
 302     assert_eq!(comment.ap_id, pleroma_url.into());
 303     assert_eq!(comment.content.len(), 64);
 304     assert!(!comment.local);
 305     assert_eq!(request_counter, 0);
 306
 307     Comment::delete(context.pool(), comment.id).await.unwrap();
 308     cleanup(data, &context).await;
 309   }
 310
 311   #[actix_rt::test]
 312   #[serial]
 313   async fn test_html_to_markdown_sanitize() {
 314     let parsed = parse_html("<script></script><b>hello</b>");
 315     assert_eq!(parsed, "**hello**");
 316   }
 317 }