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