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