]> Untitled Git - lemmy.git/blobdiff - crates/apub/src/objects/post.rs
Implement instance actor (#1798)
[lemmy.git] / crates / apub / src / objects / post.rs
index 341b428b6def03e257da0d34e880a6917d912896..b15c9374b55d5bc38279c887de17734f67c9ad11 100644 (file)
@@ -1,27 +1,24 @@
 use crate::{
-  activities::{extract_community, verify_person_in_community},
-  extensions::context::lemmy_context,
-  fetcher::object_id::ObjectId,
-  objects::{create_tombstone, FromApub, ImageObject, Source, ToApub},
-  ActorType,
-};
-use activitystreams::{
-  base::AnyBase,
-  object::{
-    kind::{ImageType, PageType},
-    Tombstone,
+  activities::{verify_is_public, verify_person_in_community},
+  check_is_apub_id_valid,
+  protocol::{
+    objects::{
+      page::{Page, PageType},
+      tombstone::Tombstone,
+    },
+    ImageObject,
+    Source,
   },
-  primitives::OneOrMany,
-  public,
-  unparsed::Unparsed,
 };
-use chrono::{DateTime, FixedOffset};
+use activitystreams_kinds::public;
+use chrono::NaiveDateTime;
 use lemmy_api_common::blocking;
 use lemmy_apub_lib::{
+  object_id::ObjectId,
+  traits::ApubObject,
   values::{MediaTypeHtml, MediaTypeMarkdown},
-  verify_domains_match,
+  verify::verify_domains_match,
 };
-use lemmy_db_queries::{source::post::Post_, ApubObject, Crud, DbPool};
 use lemmy_db_schema::{
   self,
   source::{
@@ -29,6 +26,7 @@ use lemmy_db_schema::{
     person::Person,
     post::{Post, PostForm},
   },
+  traits::Crud,
 };
 use lemmy_utils::{
   request::fetch_site_data,
@@ -36,119 +34,93 @@ use lemmy_utils::{
   LemmyError,
 };
 use lemmy_websocket::LemmyContext;
-use serde::{Deserialize, Serialize};
-use serde_with::skip_serializing_none;
+use std::ops::Deref;
 use url::Url;
 
-#[skip_serializing_none]
-#[derive(Clone, Debug, Deserialize, Serialize)]
-#[serde(rename_all = "camelCase")]
-pub struct Page {
-  #[serde(rename = "@context")]
-  context: OneOrMany<AnyBase>,
-  r#type: PageType,
-  id: Url,
-  pub(crate) attributed_to: ObjectId<Person>,
-  to: [Url; 2],
-  name: String,
-  content: Option<String>,
-  media_type: MediaTypeHtml,
-  source: Option<Source>,
-  url: Option<Url>,
-  image: Option<ImageObject>,
-  pub(crate) comments_enabled: Option<bool>,
-  sensitive: Option<bool>,
-  pub(crate) stickied: Option<bool>,
-  published: DateTime<FixedOffset>,
-  updated: Option<DateTime<FixedOffset>>,
-  #[serde(flatten)]
-  unparsed: Unparsed,
-}
+#[derive(Clone, Debug)]
+pub struct ApubPost(Post);
 
-impl Page {
-  pub(crate) fn id_unchecked(&self) -> &Url {
-    &self.id
+impl Deref for ApubPost {
+  type Target = Post;
+  fn deref(&self) -> &Self::Target {
+    &self.0
   }
-  pub(crate) fn id(&self, expected_domain: &Url) -> Result<&Url, LemmyError> {
-    verify_domains_match(&self.id, expected_domain)?;
-    Ok(&self.id)
+}
+
+impl From<Post> for ApubPost {
+  fn from(p: Post) -> Self {
+    ApubPost { 0: p }
   }
+}
 
-  /// Only mods can change the post's stickied/locked status. So if either of these is changed from
-  /// the current value, it is a mod action and needs to be verified as such.
-  ///
-  /// Both stickied and locked need to be false on a newly created post (verified in [[CreatePost]].
-  pub(crate) async fn is_mod_action(&self, pool: &DbPool) -> Result<bool, LemmyError> {
-    let post_id = self.id.clone();
-    let old_post = blocking(pool, move |conn| {
-      Post::read_from_apub_id(conn, &post_id.into())
-    })
-    .await?;
+#[async_trait::async_trait(?Send)]
+impl ApubObject for ApubPost {
+  type DataType = LemmyContext;
+  type ApubType = Page;
+  type TombstoneType = Tombstone;
 
-    let is_mod_action = if let Ok(old_post) = old_post {
-      self.stickied != Some(old_post.stickied) || self.comments_enabled != Some(!old_post.locked)
-    } else {
-      false
-    };
-    Ok(is_mod_action)
+  fn last_refreshed_at(&self) -> Option<NaiveDateTime> {
+    None
   }
 
-  pub(crate) async fn verify(
-    &self,
+  #[tracing::instrument(skip_all)]
+  async fn read_from_apub_id(
+    object_id: Url,
     context: &LemmyContext,
-    request_counter: &mut i32,
-  ) -> Result<(), LemmyError> {
-    let community = extract_community(&self.to, context, request_counter).await?;
-
-    check_slurs(&self.name)?;
-    verify_domains_match(self.attributed_to.inner(), &self.id)?;
-    verify_person_in_community(
-      &self.attributed_to,
-      &ObjectId::new(community.actor_id()),
-      context,
-      request_counter,
+  ) -> Result<Option<Self>, LemmyError> {
+    Ok(
+      blocking(context.pool(), move |conn| {
+        Post::read_from_apub_id(conn, object_id)
+      })
+      .await??
+      .map(Into::into),
     )
-    .await?;
-    Ok(())
   }
-}
 
-#[async_trait::async_trait(?Send)]
-impl ToApub for Post {
-  type ApubType = Page;
+  #[tracing::instrument(skip_all)]
+  async fn delete(self, context: &LemmyContext) -> Result<(), LemmyError> {
+    if !self.deleted {
+      blocking(context.pool(), move |conn| {
+        Post::update_deleted(conn, self.id, true)
+      })
+      .await??;
+    }
+    Ok(())
+  }
 
   // Turn a Lemmy post into an ActivityPub page that can be sent out over the network.
-  async fn to_apub(&self, pool: &DbPool) -> Result<Page, LemmyError> {
+  #[tracing::instrument(skip_all)]
+  async fn into_apub(self, context: &LemmyContext) -> Result<Page, LemmyError> {
     let creator_id = self.creator_id;
-    let creator = blocking(pool, move |conn| Person::read(conn, creator_id)).await??;
+    let creator = blocking(context.pool(), move |conn| Person::read(conn, creator_id)).await??;
     let community_id = self.community_id;
-    let community = blocking(pool, move |conn| Community::read(conn, community_id)).await??;
+    let community = blocking(context.pool(), move |conn| {
+      Community::read(conn, community_id)
+    })
+    .await??;
 
     let source = self.body.clone().map(|body| Source {
       content: body,
       media_type: MediaTypeMarkdown::Markdown,
     });
-    let image = self.thumbnail_url.clone().map(|thumb| ImageObject {
-      kind: ImageType::Image,
-      url: thumb.into(),
-    });
+    let image = self.thumbnail_url.clone().map(ImageObject::new);
 
     let page = Page {
-      context: lemmy_context(),
       r#type: PageType::Page,
-      id: self.ap_id.clone().into(),
+      id: ObjectId::new(self.ap_id.clone()),
       attributed_to: ObjectId::new(creator.actor_id),
-      to: [community.actor_id.into(), public()],
+      to: vec![community.actor_id.into(), public()],
+      cc: vec![],
       name: self.name.clone(),
       content: self.body.as_ref().map(|b| markdown_to_html(b)),
-      media_type: MediaTypeHtml::Html,
+      media_type: Some(MediaTypeHtml::Html),
       source,
       url: self.url.clone().map(|u| u.into()),
       image,
       comments_enabled: Some(!self.locked),
       sensitive: Some(self.nsfw),
       stickied: Some(self.stickied),
-      published: convert_datetime(self.published),
+      published: Some(convert_datetime(self.published)),
       updated: self.updated.map(convert_datetime),
       unparsed: Default::default(),
     };
@@ -156,42 +128,46 @@ impl ToApub for Post {
   }
 
   fn to_tombstone(&self) -> Result<Tombstone, LemmyError> {
-    create_tombstone(
-      self.deleted,
-      self.ap_id.to_owned().into(),
-      self.updated,
-      PageType::Page,
-    )
+    Ok(Tombstone::new(self.ap_id.clone().into()))
   }
-}
 
-#[async_trait::async_trait(?Send)]
-impl FromApub for Post {
-  type ApubType = Page;
-
-  async fn from_apub(
+  #[tracing::instrument(skip_all)]
+  async fn verify(
     page: &Page,
-    context: &LemmyContext,
     expected_domain: &Url,
+    context: &LemmyContext,
     request_counter: &mut i32,
-  ) -> Result<Post, LemmyError> {
+  ) -> Result<(), LemmyError> {
     // We can't verify the domain in case of mod action, because the mod may be on a different
     // instance from the post author.
-    let ap_id = if page.is_mod_action(context.pool()).await? {
-      page.id_unchecked()
-    } else {
-      page.id(expected_domain)?
+    if !page.is_mod_action(context).await? {
+      verify_domains_match(page.id.inner(), expected_domain)?;
     };
-    let ap_id = Some(ap_id.clone().into());
+
+    let community = page.extract_community(context, request_counter).await?;
+    check_is_apub_id_valid(page.id.inner(), community.local, &context.settings())?;
+    verify_person_in_community(&page.attributed_to, &community, context, request_counter).await?;
+    check_slurs(&page.name, &context.settings().slur_regex())?;
+    verify_domains_match(page.attributed_to.inner(), page.id.inner())?;
+    verify_is_public(&page.to, &page.cc)?;
+    Ok(())
+  }
+
+  #[tracing::instrument(skip_all)]
+  async fn from_apub(
+    page: Page,
+    context: &LemmyContext,
+    request_counter: &mut i32,
+  ) -> Result<ApubPost, LemmyError> {
     let creator = page
       .attributed_to
-      .dereference(context, request_counter)
+      .dereference(context, context.client(), request_counter)
       .await?;
-    let community = extract_community(&page.to, context, request_counter).await?;
+    let community = page.extract_community(context, request_counter).await?;
 
-    let thumbnail_url: Option<Url> = page.image.clone().map(|i| i.url);
+    let thumbnail_url: Option<Url> = page.image.map(|i| i.url);
     let (metadata_res, pictrs_thumbnail) = if let Some(url) = &page.url {
-      fetch_site_data(context.client(), Some(url)).await
+      fetch_site_data(context.client(), &context.settings(), Some(url)).await
     } else {
       (None, thumbnail_url)
     };
@@ -199,16 +175,19 @@ impl FromApub for Post {
       .map(|u| (u.title, u.description, u.html))
       .unwrap_or((None, None, None));
 
-    let body_slurs_removed = page.source.as_ref().map(|s| remove_slurs(&s.content));
+    let body_slurs_removed = page
+      .source
+      .as_ref()
+      .map(|s| remove_slurs(&s.content, &context.settings().slur_regex()));
     let form = PostForm {
-      name: page.name.clone(),
-      url: page.url.clone().map(|u| u.into()),
+      name: page.name,
+      url: page.url.map(|u| u.into()),
       body: body_slurs_removed,
       creator_id: creator.id,
       community_id: community.id,
       removed: None,
       locked: page.comments_enabled.map(|e| !e),
-      published: Some(page.published.naive_local()),
+      published: page.published.map(|u| u.naive_local()),
       updated: page.updated.map(|u| u.naive_local()),
       deleted: None,
       nsfw: page.sensitive,
@@ -217,9 +196,57 @@ impl FromApub for Post {
       embed_description,
       embed_html,
       thumbnail_url: pictrs_thumbnail.map(|u| u.into()),
-      ap_id,
+      ap_id: Some(page.id.into()),
       local: Some(false),
     };
-    Ok(blocking(context.pool(), move |conn| Post::upsert(conn, &form)).await??)
+    let post = blocking(context.pool(), move |conn| Post::upsert(conn, &form)).await??;
+    Ok(post.into())
+  }
+}
+
+#[cfg(test)]
+mod tests {
+  use super::*;
+  use crate::objects::{
+    community::tests::parse_lemmy_community,
+    person::tests::parse_lemmy_person,
+    post::ApubPost,
+    tests::{file_to_json_object, init_context},
+  };
+  use lemmy_apub_lib::activity_queue::create_activity_queue;
+  use lemmy_db_schema::source::site::Site;
+  use serial_test::serial;
+
+  #[actix_rt::test]
+  #[serial]
+  async fn test_parse_lemmy_post() {
+    let client = reqwest::Client::new().into();
+    let manager = create_activity_queue(client);
+    let context = init_context(manager.queue_handle().clone());
+    let (person, site) = parse_lemmy_person(&context).await;
+    let community = parse_lemmy_community(&context).await;
+
+    let json = file_to_json_object("assets/lemmy/objects/page.json").unwrap();
+    let url = Url::parse("https://enterprise.lemmy.ml/post/55143").unwrap();
+    let mut request_counter = 0;
+    ApubPost::verify(&json, &url, &context, &mut request_counter)
+      .await
+      .unwrap();
+    let post = ApubPost::from_apub(json, &context, &mut request_counter)
+      .await
+      .unwrap();
+
+    assert_eq!(post.ap_id, url.into());
+    assert_eq!(post.name, "Post title");
+    assert!(post.body.is_some());
+    assert_eq!(post.body.as_ref().unwrap().len(), 45);
+    assert!(!post.locked);
+    assert!(post.stickied);
+    assert_eq!(request_counter, 0);
+
+    Post::delete(&*context.pool().get().unwrap(), post.id).unwrap();
+    Person::delete(&*context.pool().get().unwrap(), person.id).unwrap();
+    Community::delete(&*context.pool().get().unwrap(), community.id).unwrap();
+    Site::delete(&*context.pool().get().unwrap(), site.id).unwrap();
   }
 }