]> Untitled Git - lemmy.git/blobdiff - crates/apub/src/objects/community.rs
Cache & Optimize Woodpecker CI (#3450)
[lemmy.git] / crates / apub / src / objects / community.rs
index 525ae854d5e3b874146a73765a81501c4276e21a..75eb941b1b3af0589cf29782277e4ef6e388c4c9 100644 (file)
 use crate::{
-  check_is_apub_id_valid,
-  context::lemmy_context,
-  fetcher::community::{fetch_community_outbox, update_community_mods},
-  generate_moderators_url,
-  generate_outbox_url,
-  objects::{create_tombstone, ImageObject, Source},
-  CommunityType,
+  check_apub_id_valid,
+  local_site_data_cached,
+  objects::instance::fetch_instance_actor_for_object,
+  protocol::{
+    objects::{group::Group, Endpoints, LanguageTag},
+    ImageObject,
+    Source,
+  },
 };
-use activitystreams::{
-  actor::{kind::GroupType, Endpoints},
-  base::AnyBase,
-  chrono::NaiveDateTime,
-  object::{kind::ImageType, Tombstone},
-  primitives::OneOrMany,
-  unparsed::Unparsed,
+use activitypub_federation::{
+  config::Data,
+  kinds::actor::GroupType,
+  traits::{Actor, Object},
 };
-use chrono::{DateTime, FixedOffset};
-use itertools::Itertools;
-use lemmy_api_common::blocking;
-use lemmy_apub_lib::{
-  signatures::PublicKey,
-  traits::{ActorType, ApubObject, FromApub, ToApub},
-  values::{MediaTypeHtml, MediaTypeMarkdown},
-  verify::verify_domains_match,
+use chrono::NaiveDateTime;
+use lemmy_api_common::{
+  context::LemmyContext,
+  utils::{generate_featured_url, generate_moderators_url, generate_outbox_url},
 };
 use lemmy_db_schema::{
-  naive_now,
-  source::community::{Community, CommunityForm},
-  DbPool,
+  source::{
+    actor_language::CommunityLanguage,
+    community::{Community, CommunityUpdateForm},
+  },
+  traits::{ApubActor, Crud},
 };
-use lemmy_db_views_actor::community_follower_view::CommunityFollowerView;
+use lemmy_db_views_actor::structs::CommunityFollowerView;
 use lemmy_utils::{
-  settings::structs::Settings,
-  utils::{check_slurs, check_slurs_opt, convert_datetime, markdown_to_html},
-  LemmyError,
+  error::LemmyError,
+  utils::{markdown::markdown_to_html, time::convert_datetime},
 };
-use lemmy_websocket::LemmyContext;
-use log::debug;
-use serde::{Deserialize, Serialize};
-use serde_with::skip_serializing_none;
 use std::ops::Deref;
+use tracing::debug;
 use url::Url;
 
-#[skip_serializing_none]
-#[derive(Clone, Debug, Deserialize, Serialize)]
-#[serde(rename_all = "camelCase")]
-pub struct Group {
-  #[serde(rename = "@context")]
-  context: OneOrMany<AnyBase>,
-  #[serde(rename = "type")]
-  kind: GroupType,
-  id: Url,
-  /// username, set at account creation and can never be changed
-  preferred_username: String,
-  /// title (can be changed at any time)
-  name: String,
-  content: Option<String>,
-  media_type: Option<MediaTypeHtml>,
-  source: Option<Source>,
-  icon: Option<ImageObject>,
-  /// banner
-  image: Option<ImageObject>,
-  // lemmy extension
-  sensitive: Option<bool>,
-  // lemmy extension
-  pub(crate) moderators: Option<Url>,
-  inbox: Url,
-  pub(crate) outbox: Url,
-  followers: Url,
-  endpoints: Endpoints<Url>,
-  public_key: PublicKey,
-  published: Option<DateTime<FixedOffset>>,
-  updated: Option<DateTime<FixedOffset>>,
-  #[serde(flatten)]
-  unparsed: Unparsed,
-}
-
-impl Group {
-  pub(crate) fn id(&self, expected_domain: &Url) -> Result<&Url, LemmyError> {
-    verify_domains_match(&self.id, expected_domain)?;
-    Ok(&self.id)
-  }
-  pub(crate) async fn from_apub_to_form(
-    group: &Group,
-    expected_domain: &Url,
-    settings: &Settings,
-  ) -> Result<CommunityForm, LemmyError> {
-    let actor_id = Some(group.id(expected_domain)?.clone().into());
-    let name = group.preferred_username.clone();
-    let title = group.name.clone();
-    let description = group.source.clone().map(|s| s.content);
-    let shared_inbox = group.endpoints.shared_inbox.clone().map(|s| s.into());
-
-    let slur_regex = &settings.slur_regex();
-    check_slurs(&name, slur_regex)?;
-    check_slurs(&title, slur_regex)?;
-    check_slurs_opt(&description, slur_regex)?;
-
-    Ok(CommunityForm {
-      name,
-      title,
-      description,
-      removed: None,
-      published: group.published.map(|u| u.naive_local()),
-      updated: group.updated.map(|u| u.naive_local()),
-      deleted: None,
-      nsfw: Some(group.sensitive.unwrap_or(false)),
-      actor_id,
-      local: Some(false),
-      private_key: None,
-      public_key: Some(group.public_key.public_key_pem.clone()),
-      last_refreshed_at: Some(naive_now()),
-      icon: Some(group.icon.clone().map(|i| i.url.into())),
-      banner: Some(group.image.clone().map(|i| i.url.into())),
-      followers_url: Some(group.followers.clone().into()),
-      inbox_url: Some(group.inbox.clone().into()),
-      shared_inbox_url: Some(shared_inbox),
-    })
-  }
-}
-
 #[derive(Clone, Debug)]
 pub struct ApubCommunity(Community);
 
@@ -132,182 +46,156 @@ impl Deref for ApubCommunity {
 
 impl From<Community> for ApubCommunity {
   fn from(c: Community) -> Self {
-    ApubCommunity { 0: c }
+    ApubCommunity(c)
   }
 }
 
-#[async_trait::async_trait(?Send)]
-impl ApubObject for ApubCommunity {
+#[async_trait::async_trait]
+impl Object for ApubCommunity {
   type DataType = LemmyContext;
+  type Kind = Group;
+  type Error = LemmyError;
 
   fn last_refreshed_at(&self) -> Option<NaiveDateTime> {
     Some(self.last_refreshed_at)
   }
 
-  async fn read_from_apub_id(
+  #[tracing::instrument(skip_all)]
+  async fn read_from_id(
     object_id: Url,
-    context: &LemmyContext,
+    context: &Data<Self::DataType>,
   ) -> Result<Option<Self>, LemmyError> {
     Ok(
-      blocking(context.pool(), move |conn| {
-        Community::read_from_apub_id(conn, object_id)
-      })
-      .await??
-      .map(Into::into),
+      Community::read_from_apub_id(&mut context.pool(), &object_id.into())
+        .await?
+        .map(Into::into),
     )
   }
 
-  async fn delete(self, context: &LemmyContext) -> Result<(), LemmyError> {
-    blocking(context.pool(), move |conn| {
-      Community::update_deleted(conn, self.id, true)
-    })
-    .await??;
+  #[tracing::instrument(skip_all)]
+  async fn delete(self, context: &Data<Self::DataType>) -> Result<(), LemmyError> {
+    let form = CommunityUpdateForm::builder().deleted(Some(true)).build();
+    Community::update(&mut context.pool(), self.id, &form).await?;
     Ok(())
   }
-}
 
-impl ActorType for ApubCommunity {
-  fn is_local(&self) -> bool {
-    self.local
-  }
-  fn actor_id(&self) -> Url {
-    self.actor_id.to_owned().into()
-  }
-  fn name(&self) -> String {
-    self.name.clone()
-  }
-  fn public_key(&self) -> Option<String> {
-    self.public_key.to_owned()
-  }
-  fn private_key(&self) -> Option<String> {
-    self.private_key.to_owned()
-  }
-
-  fn inbox_url(&self) -> Url {
-    self.inbox_url.clone().into()
-  }
-
-  fn shared_inbox_url(&self) -> Option<Url> {
-    self.shared_inbox_url.clone().map(|s| s.into_inner())
-  }
-}
-
-#[async_trait::async_trait(?Send)]
-impl ToApub for ApubCommunity {
-  type ApubType = Group;
-  type TombstoneType = Tombstone;
-  type DataType = DbPool;
-
-  async fn to_apub(&self, _pool: &DbPool) -> Result<Group, LemmyError> {
-    let source = self.description.clone().map(|bio| Source {
-      content: bio,
-      media_type: MediaTypeMarkdown::Markdown,
-    });
-    let icon = self.icon.clone().map(|url| ImageObject {
-      kind: ImageType::Image,
-      url: url.into(),
-    });
-    let image = self.banner.clone().map(|url| ImageObject {
-      kind: ImageType::Image,
-      url: url.into(),
-    });
+  #[tracing::instrument(skip_all)]
+  async fn into_json(self, data: &Data<Self::DataType>) -> Result<Group, LemmyError> {
+    let community_id = self.id;
+    let langs = CommunityLanguage::read(&mut data.pool(), community_id).await?;
+    let language = LanguageTag::new_multiple(langs, &mut data.pool()).await?;
 
     let group = Group {
-      context: lemmy_context(),
       kind: GroupType::Group,
-      id: self.actor_id(),
+      id: self.id().into(),
       preferred_username: self.name.clone(),
-      name: self.title.clone(),
-      content: self.description.as_ref().map(|b| markdown_to_html(b)),
-      media_type: self.description.as_ref().map(|_| MediaTypeHtml::Html),
-      source,
-      icon,
-      image,
+      name: Some(self.title.clone()),
+      summary: self.description.as_ref().map(|b| markdown_to_html(b)),
+      source: self.description.clone().map(Source::new),
+      icon: self.icon.clone().map(ImageObject::new),
+      image: self.banner.clone().map(ImageObject::new),
       sensitive: Some(self.nsfw),
-      moderators: Some(generate_moderators_url(&self.actor_id)?.into()),
+      featured: Some(generate_featured_url(&self.actor_id)?.into()),
       inbox: self.inbox_url.clone().into(),
       outbox: generate_outbox_url(&self.actor_id)?.into(),
       followers: self.followers_url.clone().into(),
-      endpoints: Endpoints {
-        shared_inbox: self.shared_inbox_url.clone().map(|s| s.into()),
-        ..Default::default()
-      },
-      public_key: self.get_public_key()?,
+      endpoints: self.shared_inbox_url.clone().map(|s| Endpoints {
+        shared_inbox: s.into(),
+      }),
+      public_key: self.public_key(),
+      language,
       published: Some(convert_datetime(self.published)),
       updated: self.updated.map(convert_datetime),
-      unparsed: Default::default(),
+      posting_restricted_to_mods: Some(self.posting_restricted_to_mods),
+      attributed_to: Some(generate_moderators_url(&self.actor_id)?.into()),
     };
     Ok(group)
   }
 
-  fn to_tombstone(&self) -> Result<Tombstone, LemmyError> {
-    create_tombstone(
-      self.deleted,
-      self.actor_id.to_owned().into(),
-      self.updated,
-      GroupType::Group,
-    )
+  #[tracing::instrument(skip_all)]
+  async fn verify(
+    group: &Group,
+    expected_domain: &Url,
+    context: &Data<Self::DataType>,
+  ) -> Result<(), LemmyError> {
+    group.verify(expected_domain, context).await
   }
-}
-
-#[async_trait::async_trait(?Send)]
-impl FromApub for ApubCommunity {
-  type ApubType = Group;
-  type DataType = LemmyContext;
 
   /// Converts a `Group` to `Community`, inserts it into the database and updates moderators.
-  async fn from_apub(
-    group: &Group,
-    context: &LemmyContext,
-    expected_domain: &Url,
-    request_counter: &mut i32,
+  #[tracing::instrument(skip_all)]
+  async fn from_json(
+    group: Group,
+    context: &Data<Self::DataType>,
   ) -> Result<ApubCommunity, LemmyError> {
-    let form = Group::from_apub_to_form(group, expected_domain, &context.settings()).await?;
+    let instance_id = fetch_instance_actor_for_object(&group.id, context).await?;
+
+    let form = Group::into_insert_form(group.clone(), instance_id);
+    let languages =
+      LanguageTag::to_language_id_multiple(group.language, &mut context.pool()).await?;
+
+    let community = Community::create(&mut context.pool(), &form).await?;
+    CommunityLanguage::update(&mut context.pool(), languages, community.id).await?;
+
+    let community: ApubCommunity = community.into();
 
     // Fetching mods and outbox is not necessary for Lemmy to work, so ignore errors. Besides,
     // we need to ignore these errors so that tests can work entirely offline.
-    let community = blocking(context.pool(), move |conn| Community::upsert(conn, &form)).await??;
-    update_community_mods(group, &community, context, request_counter)
-      .await
-      .map_err(|e| debug!("{}", e))
-      .ok();
+    let fetch_outbox = group.outbox.dereference(&community, context);
 
-    // TODO: doing this unconditionally might cause infinite loop for some reason
-    fetch_community_outbox(context, &group.outbox, request_counter)
-      .await
-      .map_err(|e| debug!("{}", e))
-      .ok();
+    if let Some(moderators) = group.attributed_to {
+      let fetch_moderators = moderators.dereference(&community, context);
+      // Fetch mods and outbox in parallel
+      let res = tokio::join!(fetch_outbox, fetch_moderators);
+      res.0.map_err(|e| debug!("{}", e)).ok();
+      res.1.map_err(|e| debug!("{}", e)).ok();
+    } else {
+      fetch_outbox.await.map_err(|e| debug!("{}", e)).ok();
+    }
 
-    Ok(community.into())
+    Ok(community)
   }
 }
 
-#[async_trait::async_trait(?Send)]
-impl CommunityType for Community {
-  fn followers_url(&self) -> Url {
-    self.followers_url.clone().into()
+impl Actor for ApubCommunity {
+  fn id(&self) -> Url {
+    self.actor_id.inner().clone()
+  }
+
+  fn public_key_pem(&self) -> &str {
+    &self.public_key
+  }
+
+  fn private_key_pem(&self) -> Option<String> {
+    self.private_key.clone()
+  }
+
+  fn inbox(&self) -> Url {
+    self.inbox_url.clone().into()
+  }
+
+  fn shared_inbox(&self) -> Option<Url> {
+    self.shared_inbox_url.clone().map(Into::into)
   }
+}
 
+impl ApubCommunity {
   /// For a given community, returns the inboxes of all followers.
-  async fn get_follower_inboxes(
+  #[tracing::instrument(skip_all)]
+  pub(crate) async fn get_follower_inboxes(
     &self,
-    pool: &DbPool,
-    settings: &Settings,
+    context: &LemmyContext,
   ) -> Result<Vec<Url>, LemmyError> {
     let id = self.id;
 
-    let follows = blocking(pool, move |conn| {
-      CommunityFollowerView::for_community(conn, id)
-    })
-    .await??;
-    let inboxes = follows
+    let local_site_data = local_site_data_cached(&mut context.pool()).await?;
+    let follows =
+      CommunityFollowerView::get_community_follower_inboxes(&mut context.pool(), id).await?;
+    let inboxes: Vec<Url> = follows
       .into_iter()
-      .filter(|f| !f.follower.local)
-      .map(|f| f.follower.shared_inbox_url.unwrap_or(f.follower.inbox_url))
-      .map(|i| i.into_inner())
-      .unique()
+      .map(Into::into)
+      .filter(|inbox: &Url| inbox.host_str() != Some(&context.settings().hostname))
       // Don't send to blocked instances
-      .filter(|inbox| check_is_apub_id_valid(inbox, false, settings).is_ok())
+      .filter(|inbox| check_apub_id_valid(inbox, &local_site_data).is_ok())
       .collect();
 
     Ok(inboxes)
@@ -315,40 +203,50 @@ impl CommunityType for Community {
 }
 
 #[cfg(test)]
-mod tests {
+pub(crate) mod tests {
+  #![allow(clippy::unwrap_used)]
+  #![allow(clippy::indexing_slicing)]
+
   use super::*;
-  use crate::objects::tests::{file_to_json_object, init_context};
-  use assert_json_diff::assert_json_include;
-  use lemmy_db_schema::traits::Crud;
+  use crate::{
+    objects::{instance::tests::parse_lemmy_instance, tests::init_context},
+    protocol::tests::file_to_json_object,
+  };
+  use activitypub_federation::fetch::collection_id::CollectionId;
+  use lemmy_db_schema::{source::site::Site, traits::Crud};
   use serial_test::serial;
 
-  #[actix_rt::test]
-  #[serial]
-  async fn test_fetch_lemmy_community() {
-    let context = init_context();
-    let mut json: Group = file_to_json_object("assets/lemmy-community.json");
-    let json_orig = json.clone();
+  pub(crate) async fn parse_lemmy_community(context: &Data<LemmyContext>) -> ApubCommunity {
+    // use separate counter so this doesnt affect tests
+    let context2 = context.reset_request_count();
+    let mut json: Group = file_to_json_object("assets/lemmy/objects/group.json").unwrap();
     // change these links so they dont fetch over the network
-    json.moderators = Some(Url::parse("https://lemmy.ml/c/announcements/not_moderators").unwrap());
-    json.outbox = Url::parse("https://lemmy.ml/c/announcements/not_outbox").unwrap();
+    json.attributed_to = None;
+    json.outbox =
+      CollectionId::parse("https://enterprise.lemmy.ml/c/tenforward/not_outbox").unwrap();
 
-    let url = Url::parse("https://lemmy.ml/c/announcements").unwrap();
-    let mut request_counter = 0;
-    let community = ApubCommunity::from_apub(&json, &context, &url, &mut request_counter)
-      .await
-      .unwrap();
+    let url = Url::parse("https://enterprise.lemmy.ml/c/tenforward").unwrap();
+    ApubCommunity::verify(&json, &url, &context2).await.unwrap();
+    let community = ApubCommunity::from_json(json, &context2).await.unwrap();
+    // this makes one requests to the (intentionally broken) outbox collection
+    assert_eq!(context2.request_count(), 1);
+    community
+  }
 
-    assert_eq!(community.actor_id.clone().into_inner(), url);
-    assert_eq!(community.title, "Announcements");
-    assert!(community.public_key.is_some());
-    assert!(!community.local);
-    assert_eq!(community.description.as_ref().unwrap().len(), 126);
-    // this makes two requests to the (intentionally) broken outbox/moderators collections
-    assert_eq!(request_counter, 2);
+  #[tokio::test]
+  #[serial]
+  async fn test_parse_lemmy_community() {
+    let context = init_context().await;
+    let site = parse_lemmy_instance(&context).await;
+    let community = parse_lemmy_community(&context).await;
 
-    let to_apub = community.to_apub(context.pool()).await.unwrap();
-    assert_json_include!(actual: json_orig, expected: to_apub);
+    assert_eq!(community.title, "Ten Forward");
+    assert!(!community.local);
+    assert_eq!(community.description.as_ref().unwrap().len(), 132);
 
-    Community::delete(&*context.pool().get().unwrap(), community.id).unwrap();
+    Community::delete(&mut context.pool(), community.id)
+      .await
+      .unwrap();
+    Site::delete(&mut context.pool(), site.id).await.unwrap();
   }
 }