crates/apub/src/objects/comment.rs

   1 use crate::{
   2   activities::{verify_is_public, verify_person_in_community},
   3   check_is_apub_id_valid,
   4   protocol::{
   5     objects::{
   6       note::{Note, SourceCompat},
   7       tombstone::Tombstone,
   8     },
   9     Source,
  10   },
  11   PostOrComment,
  12 };
  13 use activitystreams::{object::kind::NoteType, public};
  14 use anyhow::anyhow;
  15 use chrono::NaiveDateTime;
  16 use html2md::parse_html;
  17 use lemmy_api_common::blocking;
  18 use lemmy_apub_lib::{
  19   object_id::ObjectId,
  20   traits::ApubObject,
  21   values::{MediaTypeHtml, MediaTypeMarkdown},
  22   verify::verify_domains_match,
  23 };
  24 use lemmy_db_schema::{
  25   source::{
  26     comment::{Comment, CommentForm},
  27     community::Community,
  28     person::Person,
  29     post::Post,
  30   },
  31   traits::Crud,
  32 };
  33 use lemmy_utils::{
  34   utils::{convert_datetime, markdown_to_html, remove_slurs},
  35   LemmyError,
  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 { 0: 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 TombstoneType = Tombstone;
  62
  63   fn last_refreshed_at(&self) -> Option<NaiveDateTime> {
  64     None
  65   }
  66
  67   async fn read_from_apub_id(
  68     object_id: Url,
  69     context: &LemmyContext,
  70   ) -> Result<Option<Self>, LemmyError> {
  71     Ok(
  72       blocking(context.pool(), move |conn| {
  73         Comment::read_from_apub_id(conn, object_id)
  74       })
  75       .await??
  76       .map(Into::into),
  77     )
  78   }
  79
  80   async fn delete(self, context: &LemmyContext) -> Result<(), LemmyError> {
  81     if !self.deleted {
  82       blocking(context.pool(), move |conn| {
  83         Comment::update_deleted(conn, self.id, true)
  84       })
  85       .await??;
  86     }
  87     Ok(())
  88   }
  89
  90   async fn into_apub(self, context: &LemmyContext) -> Result<Note, LemmyError> {
  91     let creator_id = self.creator_id;
  92     let creator = blocking(context.pool(), move |conn| Person::read(conn, creator_id)).await??;
  93
  94     let post_id = self.post_id;
  95     let post = blocking(context.pool(), move |conn| Post::read(conn, post_id)).await??;
  96
  97     let in_reply_to = if let Some(comment_id) = self.parent_id {
  98       let parent_comment =
  99         blocking(context.pool(), move |conn| Comment::read(conn, comment_id)).await??;
 100       ObjectId::<PostOrComment>::new(parent_comment.ap_id)
 101     } else {
 102       ObjectId::<PostOrComment>::new(post.ap_id)
 103     };
 104
 105     let note = Note {
 106       r#type: NoteType::Note,
 107       id: ObjectId::new(self.ap_id.clone()),
 108       attributed_to: ObjectId::new(creator.actor_id),
 109       to: vec![public()],
 110       cc: vec![],
 111       content: markdown_to_html(&self.content),
 112       media_type: Some(MediaTypeHtml::Html),
 113       source: SourceCompat::Lemmy(Source {
 114         content: self.content.clone(),
 115         media_type: MediaTypeMarkdown::Markdown,
 116       }),
 117       in_reply_to,
 118       published: Some(convert_datetime(self.published)),
 119       updated: self.updated.map(convert_datetime),
 120       unparsed: Default::default(),
 121     };
 122
 123     Ok(note)
 124   }
 125
 126   fn to_tombstone(&self) -> Result<Tombstone, LemmyError> {
 127     Ok(Tombstone::new(
 128       NoteType::Note,
 129       self.updated.unwrap_or(self.published),
 130     ))
 131   }
 132
 133   async fn verify(
 134     note: &Note,
 135     expected_domain: &Url,
 136     context: &LemmyContext,
 137     request_counter: &mut i32,
 138   ) -> Result<(), LemmyError> {
 139     verify_domains_match(note.id.inner(), expected_domain)?;
 140     verify_domains_match(note.attributed_to.inner(), note.id.inner())?;
 141     verify_is_public(&note.to, &note.cc)?;
 142     let (post, _) = note.get_parents(context, request_counter).await?;
 143     let community_id = post.community_id;
 144     let community = blocking(context.pool(), move |conn| {
 145       Community::read(conn, community_id)
 146     })
 147     .await??;
 148     check_is_apub_id_valid(note.id.inner(), community.local, &context.settings())?;
 149     verify_person_in_community(
 150       &note.attributed_to,
 151       &community.into(),
 152       context,
 153       request_counter,
 154     )
 155     .await?;
 156     if post.locked {
 157       return Err(anyhow!("Post is locked").into());
 158     }
 159     Ok(())
 160   }
 161
 162   /// Converts a `Note` to `Comment`.
 163   ///
 164   /// If the parent community, post and comment(s) are not known locally, these are also fetched.
 165   async fn from_apub(
 166     note: Note,
 167     context: &LemmyContext,
 168     request_counter: &mut i32,
 169   ) -> Result<ApubComment, LemmyError> {
 170     let creator = note
 171       .attributed_to
 172       .dereference(context, request_counter)
 173       .await?;
 174     let (post, parent_comment_id) = note.get_parents(context, request_counter).await?;
 175
 176     let content = if let SourceCompat::Lemmy(source) = &note.source {
 177       source.content.clone()
 178     } else {
 179       parse_html(&note.content)
 180     };
 181     let content_slurs_removed = remove_slurs(&content, &context.settings().slur_regex());
 182
 183     let form = CommentForm {
 184       creator_id: creator.id,
 185       post_id: post.id,
 186       parent_id: parent_comment_id,
 187       content: content_slurs_removed,
 188       removed: None,
 189       read: None,
 190       published: note.published.map(|u| u.naive_local()),
 191       updated: note.updated.map(|u| u.naive_local()),
 192       deleted: None,
 193       ap_id: Some(note.id.into()),
 194       local: Some(false),
 195     };
 196     let comment = blocking(context.pool(), move |conn| Comment::upsert(conn, &form)).await??;
 197     Ok(comment.into())
 198   }
 199 }
 200
 201 #[cfg(test)]
 202 pub(crate) mod tests {
 203   use super::*;
 204   use crate::objects::{
 205     community::{tests::parse_lemmy_community, ApubCommunity},
 206     person::{tests::parse_lemmy_person, ApubPerson},
 207     post::ApubPost,
 208     tests::{file_to_json_object, init_context},
 209   };
 210   use assert_json_diff::assert_json_include;
 211   use serial_test::serial;
 212
 213   async fn prepare_comment_test(
 214     url: &Url,
 215     context: &LemmyContext,
 216   ) -> (ApubPerson, ApubCommunity, ApubPost) {
 217     let person = parse_lemmy_person(context).await;
 218     let community = parse_lemmy_community(context).await;
 219     let post_json = file_to_json_object("assets/lemmy/objects/page.json");
 220     ApubPost::verify(&post_json, url, context, &mut 0)
 221       .await
 222       .unwrap();
 223     let post = ApubPost::from_apub(post_json, context, &mut 0)
 224       .await
 225       .unwrap();
 226     (person, community, post)
 227   }
 228
 229   fn cleanup(data: (ApubPerson, ApubCommunity, ApubPost), context: &LemmyContext) {
 230     Post::delete(&*context.pool().get().unwrap(), data.2.id).unwrap();
 231     Community::delete(&*context.pool().get().unwrap(), data.1.id).unwrap();
 232     Person::delete(&*context.pool().get().unwrap(), data.0.id).unwrap();
 233   }
 234
 235   #[actix_rt::test]
 236   #[serial]
 237   pub(crate) async fn test_parse_lemmy_comment() {
 238     let context = init_context();
 239     let url = Url::parse("https://enterprise.lemmy.ml/comment/38741").unwrap();
 240     let data = prepare_comment_test(&url, &context).await;
 241
 242     let json: Note = file_to_json_object("assets/lemmy/objects/note.json");
 243     let mut request_counter = 0;
 244     ApubComment::verify(&json, &url, &context, &mut request_counter)
 245       .await
 246       .unwrap();
 247     let comment = ApubComment::from_apub(json.clone(), &context, &mut request_counter)
 248       .await
 249       .unwrap();
 250
 251     assert_eq!(comment.ap_id, url.into());
 252     assert_eq!(comment.content.len(), 14);
 253     assert!(!comment.local);
 254     assert_eq!(request_counter, 0);
 255
 256     let comment_id = comment.id;
 257     let to_apub = comment.into_apub(&context).await.unwrap();
 258     assert_json_include!(actual: json, expected: to_apub);
 259
 260     Comment::delete(&*context.pool().get().unwrap(), comment_id).unwrap();
 261     cleanup(data, &context);
 262   }
 263
 264   #[actix_rt::test]
 265   #[serial]
 266   async fn test_parse_pleroma_comment() {
 267     let context = init_context();
 268     let url = Url::parse("https://enterprise.lemmy.ml/comment/38741").unwrap();
 269     let data = prepare_comment_test(&url, &context).await;
 270
 271     let pleroma_url =
 272       Url::parse("https://queer.hacktivis.me/objects/8d4973f4-53de-49cd-8c27-df160e16a9c2")
 273         .unwrap();
 274     let person_json = file_to_json_object("assets/pleroma/objects/person.json");
 275     ApubPerson::verify(&person_json, &pleroma_url, &context, &mut 0)
 276       .await
 277       .unwrap();
 278     ApubPerson::from_apub(person_json, &context, &mut 0)
 279       .await
 280       .unwrap();
 281     let json = file_to_json_object("assets/pleroma/objects/note.json");
 282     let mut request_counter = 0;
 283     ApubComment::verify(&json, &pleroma_url, &context, &mut request_counter)
 284       .await
 285       .unwrap();
 286     let comment = ApubComment::from_apub(json, &context, &mut request_counter)
 287       .await
 288       .unwrap();
 289
 290     assert_eq!(comment.ap_id, pleroma_url.into());
 291     assert_eq!(comment.content.len(), 64);
 292     assert!(!comment.local);
 293     assert_eq!(request_counter, 0);
 294
 295     Comment::delete(&*context.pool().get().unwrap(), comment.id).unwrap();
 296     cleanup(data, &context);
 297   }
 298
 299   #[actix_rt::test]
 300   #[serial]
 301   async fn test_html_to_markdown_sanitize() {
 302     let parsed = parse_html("<script></script><b>hello</b>");
 303     assert_eq!(parsed, "**hello**");
 304   }
 305 }