]> Untitled Git - lemmy.git/blobdiff - crates/apub/src/objects/community.rs
Implement instance actor (#1798)
[lemmy.git] / crates / apub / src / objects / community.rs
index 566e4714af28879ba085c09a58100274ae50f191..4a618bf8867a0b02a524df7e063066d6fd486f7f 100644 (file)
 use crate::{
-  extensions::{context::lemmy_context, group_extensions::GroupExtension},
-  fetcher::user::get_or_fetch_and_upsert_user,
-  objects::{
-    check_object_domain,
-    create_tombstone,
-    get_object_from_apub,
-    get_source_markdown_value,
-    set_content_and_source,
-    FromApub,
-    FromApubToForm,
-    ToApub,
+  check_is_apub_id_valid,
+  collections::{community_moderators::ApubCommunityModerators, CommunityContext},
+  generate_moderators_url,
+  generate_outbox_url,
+  objects::instance::fetch_instance_actor_for_object,
+  protocol::{
+    objects::{group::Group, tombstone::Tombstone, Endpoints},
+    ImageObject,
+    Source,
   },
-  ActorType,
-  GroupExt,
 };
-use activitystreams::{
-  actor::{kind::GroupType, ApActor, Endpoints, Group},
-  base::BaseExt,
-  object::{ApObject, Image, Tombstone},
-  prelude::*,
+use activitystreams_kinds::actor::GroupType;
+use chrono::NaiveDateTime;
+use itertools::Itertools;
+use lemmy_api_common::blocking;
+use lemmy_apub_lib::{
+  object_id::ObjectId,
+  traits::{ActorType, ApubObject},
 };
-use activitystreams_ext::Ext2;
-use anyhow::Context;
-use lemmy_db_queries::DbPool;
-use lemmy_db_schema::{
-  naive_now,
-  source::community::{Community, CommunityForm},
-};
-use lemmy_db_views_actor::community_moderator_view::CommunityModeratorView;
-use lemmy_structs::blocking;
+use lemmy_db_schema::{source::community::Community, traits::ApubActor};
+use lemmy_db_views_actor::community_follower_view::CommunityFollowerView;
 use lemmy_utils::{
-  location_info,
-  utils::{check_slurs, check_slurs_opt, convert_datetime},
+  utils::{convert_datetime, markdown_to_html},
   LemmyError,
 };
 use lemmy_websocket::LemmyContext;
+use std::ops::Deref;
+use tracing::debug;
 use url::Url;
 
-#[async_trait::async_trait(?Send)]
-impl ToApub for Community {
-  type ApubType = GroupExt;
-
-  async fn to_apub(&self, pool: &DbPool) -> Result<GroupExt, LemmyError> {
-    // The attributed to, is an ordered vector with the creator actor_ids first,
-    // then the rest of the moderators
-    // TODO Technically the instance admins can mod the community, but lets
-    // ignore that for now
-    let id = self.id;
-    let moderators = blocking(pool, move |conn| {
-      CommunityModeratorView::for_community(&conn, id)
-    })
-    .await??;
-    let moderators: Vec<Url> = moderators
-      .into_iter()
-      .map(|m| m.moderator.actor_id.into_inner())
-      .collect();
+#[derive(Clone, Debug)]
+pub struct ApubCommunity(Community);
 
-    let mut group = ApObject::new(Group::new());
-    group
-      .set_many_contexts(lemmy_context()?)
-      .set_id(self.actor_id.to_owned().into())
-      .set_name(self.title.to_owned())
-      .set_published(convert_datetime(self.published))
-      .set_many_attributed_tos(moderators);
-
-    if let Some(u) = self.updated.to_owned() {
-      group.set_updated(convert_datetime(u));
-    }
-    if let Some(d) = self.description.to_owned() {
-      set_content_and_source(&mut group, &d)?;
-    }
+impl Deref for ApubCommunity {
+  type Target = Community;
+  fn deref(&self) -> &Self::Target {
+    &self.0
+  }
+}
 
-    if let Some(icon_url) = &self.icon {
-      let mut image = Image::new();
-      image.set_url(Url::parse(icon_url)?);
-      group.set_icon(image.into_any_base()?);
-    }
+impl From<Community> for ApubCommunity {
+  fn from(c: Community) -> Self {
+    ApubCommunity { 0: c }
+  }
+}
 
-    if let Some(banner_url) = &self.banner {
-      let mut image = Image::new();
-      image.set_url(Url::parse(banner_url)?);
-      group.set_image(image.into_any_base()?);
-    }
+#[async_trait::async_trait(?Send)]
+impl ApubObject for ApubCommunity {
+  type DataType = LemmyContext;
+  type ApubType = Group;
+  type TombstoneType = Tombstone;
 
-    let mut ap_actor = ApActor::new(self.get_inbox_url()?, group);
-    ap_actor
-      .set_preferred_username(self.name.to_owned())
-      .set_outbox(self.get_outbox_url()?)
-      .set_followers(self.get_followers_url()?)
-      .set_endpoints(Endpoints {
-        shared_inbox: Some(self.get_shared_inbox_url()?),
-        ..Default::default()
-      });
-
-    let nsfw = self.nsfw;
-    let category_id = self.category_id;
-    let group_extension = blocking(pool, move |conn| {
-      GroupExtension::new(conn, category_id, nsfw)
+  fn last_refreshed_at(&self) -> Option<NaiveDateTime> {
+    Some(self.last_refreshed_at)
+  }
+
+  #[tracing::instrument(skip_all)]
+  async fn read_from_apub_id(
+    object_id: Url,
+    context: &LemmyContext,
+  ) -> Result<Option<Self>, LemmyError> {
+    Ok(
+      blocking(context.pool(), move |conn| {
+        Community::read_from_apub_id(conn, object_id)
+      })
+      .await??
+      .map(Into::into),
+    )
+  }
+
+  #[tracing::instrument(skip_all)]
+  async fn delete(self, context: &LemmyContext) -> Result<(), LemmyError> {
+    blocking(context.pool(), move |conn| {
+      Community::update_deleted(conn, self.id, true)
     })
     .await??;
+    Ok(())
+  }
 
-    Ok(Ext2::new(
-      ap_actor,
-      group_extension,
-      self.get_public_key_ext()?,
-    ))
+  #[tracing::instrument(skip_all)]
+  async fn into_apub(self, _context: &LemmyContext) -> Result<Group, LemmyError> {
+    let group = Group {
+      kind: GroupType::Group,
+      id: ObjectId::new(self.actor_id()),
+      preferred_username: self.name.clone(),
+      name: 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(ObjectId::<ApubCommunityModerators>::new(
+        generate_moderators_url(&self.actor_id)?,
+      )),
+      inbox: self.inbox_url.clone().into(),
+      outbox: ObjectId::new(generate_outbox_url(&self.actor_id)?),
+      followers: self.followers_url.clone().into(),
+      endpoints: self.shared_inbox_url.clone().map(|s| Endpoints {
+        shared_inbox: s.into(),
+      }),
+      public_key: self.get_public_key()?,
+      published: Some(convert_datetime(self.published)),
+      updated: self.updated.map(convert_datetime),
+      unparsed: Default::default(),
+    };
+    Ok(group)
   }
 
   fn to_tombstone(&self) -> Result<Tombstone, LemmyError> {
-    create_tombstone(
-      self.deleted,
-      self.actor_id.to_owned().into(),
-      self.updated,
-      GroupType::Group,
-    )
+    Ok(Tombstone::new(self.actor_id()))
   }
-}
 
-#[async_trait::async_trait(?Send)]
-impl FromApub for Community {
-  type ApubType = GroupExt;
+  #[tracing::instrument(skip_all)]
+  async fn verify(
+    group: &Group,
+    expected_domain: &Url,
+    context: &LemmyContext,
+    _request_counter: &mut i32,
+  ) -> Result<(), LemmyError> {
+    group.verify(expected_domain, context).await
+  }
 
-  /// Converts a `Group` to `Community`.
+  /// Converts a `Group` to `Community`, inserts it into the database and updates moderators.
+  #[tracing::instrument(skip_all)]
   async fn from_apub(
-    group: &GroupExt,
+    group: Group,
     context: &LemmyContext,
-    expected_domain: Url,
     request_counter: &mut i32,
-  ) -> Result<Community, LemmyError> {
-    get_object_from_apub(group, context, expected_domain, request_counter).await
+  ) -> Result<ApubCommunity, LemmyError> {
+    let form = Group::into_form(group.clone());
+
+    // 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: ApubCommunity =
+      blocking(context.pool(), move |conn| Community::upsert(conn, &form))
+        .await??
+        .into();
+    let outbox_data = CommunityContext(community.clone(), context.clone());
+
+    group
+      .outbox
+      .dereference(&outbox_data, context.client(), request_counter)
+      .await
+      .map_err(|e| debug!("{}", e))
+      .ok();
+
+    if let Some(moderators) = &group.moderators {
+      moderators
+        .dereference(&outbox_data, context.client(), request_counter)
+        .await
+        .map_err(|e| debug!("{}", e))
+        .ok();
+    }
+
+    fetch_instance_actor_for_object(community.actor_id(), context, request_counter).await;
+
+    Ok(community)
   }
 }
 
-#[async_trait::async_trait(?Send)]
-impl FromApubToForm<GroupExt> for CommunityForm {
-  async fn from_apub(
-    group: &GroupExt,
-    context: &LemmyContext,
-    expected_domain: Url,
-    request_counter: &mut i32,
-  ) -> Result<Self, LemmyError> {
-    let creator_and_moderator_uris = group.inner.attributed_to().context(location_info!())?;
-    let creator_uri = creator_and_moderator_uris
-      .as_many()
-      .context(location_info!())?
-      .iter()
-      .next()
-      .context(location_info!())?
-      .as_xsd_any_uri()
-      .context(location_info!())?;
-
-    let creator = get_or_fetch_and_upsert_user(creator_uri, context, request_counter).await?;
-    let name = group
-      .inner
-      .preferred_username()
-      .context(location_info!())?
-      .to_string();
-    let title = group
-      .inner
-      .name()
-      .context(location_info!())?
-      .as_one()
-      .context(location_info!())?
-      .as_xsd_string()
-      .context(location_info!())?
-      .to_string();
-
-    let description = get_source_markdown_value(group)?;
-
-    check_slurs(&name)?;
-    check_slurs(&title)?;
-    check_slurs_opt(&description)?;
-
-    let icon = match group.icon() {
-      Some(any_image) => Some(
-        Image::from_any_base(any_image.as_one().context(location_info!())?.clone())
-          .context(location_info!())?
-          .context(location_info!())?
-          .url()
-          .context(location_info!())?
-          .as_single_xsd_any_uri()
-          .map(|u| u.to_string()),
-      ),
-      None => None,
-    };
+impl ActorType for ApubCommunity {
+  fn actor_id(&self) -> Url {
+    self.actor_id.to_owned().into()
+  }
+  fn public_key(&self) -> String {
+    self.public_key.to_owned()
+  }
+  fn private_key(&self) -> Option<String> {
+    self.private_key.to_owned()
+  }
 
-    let banner = match group.image() {
-      Some(any_image) => Some(
-        Image::from_any_base(any_image.as_one().context(location_info!())?.clone())
-          .context(location_info!())?
-          .context(location_info!())?
-          .url()
-          .context(location_info!())?
-          .as_single_xsd_any_uri()
-          .map(|u| u.to_string()),
-      ),
-      None => None,
-    };
+  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())
+  }
+}
 
-    Ok(CommunityForm {
-      name,
-      title,
-      description,
-      category_id: group.ext_one.category.identifier.parse::<i32>()?,
-      creator_id: creator.id,
-      removed: None,
-      published: group.inner.published().map(|u| u.to_owned().naive_local()),
-      updated: group.inner.updated().map(|u| u.to_owned().naive_local()),
-      deleted: None,
-      nsfw: group.ext_one.sensitive,
-      actor_id: Some(check_object_domain(group, expected_domain)?),
-      local: false,
-      private_key: None,
-      public_key: Some(group.ext_two.to_owned().public_key.public_key_pem),
-      last_refreshed_at: Some(naive_now()),
-      icon,
-      banner,
+impl ApubCommunity {
+  /// For a given community, returns the inboxes of all followers.
+  #[tracing::instrument(skip_all)]
+  pub(crate) async fn get_follower_inboxes(
+    &self,
+    context: &LemmyContext,
+  ) -> Result<Vec<Url>, LemmyError> {
+    let id = self.id;
+
+    let follows = blocking(context.pool(), move |conn| {
+      CommunityFollowerView::for_community(conn, 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)
+          .into()
+      })
+      .unique()
+      .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, &context.settings()).is_ok())
+      .collect();
+
+    Ok(inboxes)
+  }
+}
+
+#[cfg(test)]
+pub(crate) mod tests {
+  use super::*;
+  use crate::objects::{
+    instance::tests::parse_lemmy_instance,
+    tests::{file_to_json_object, init_context},
+  };
+  use lemmy_apub_lib::activity_queue::create_activity_queue;
+  use lemmy_db_schema::{source::site::Site, traits::Crud};
+  use serial_test::serial;
+
+  pub(crate) async fn parse_lemmy_community(context: &LemmyContext) -> ApubCommunity {
+    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 = None;
+    json.outbox =
+      ObjectId::new(Url::parse("https://enterprise.lemmy.ml/c/tenforward/not_outbox").unwrap());
+
+    let url = Url::parse("https://enterprise.lemmy.ml/c/tenforward").unwrap();
+    let mut request_counter = 0;
+    ApubCommunity::verify(&json, &url, context, &mut request_counter)
+      .await
+      .unwrap();
+    let community = ApubCommunity::from_apub(json, context, &mut request_counter)
+      .await
+      .unwrap();
+    // this makes one requests to the (intentionally broken) outbox collection
+    assert_eq!(request_counter, 1);
+    community
+  }
+
+  #[actix_rt::test]
+  #[serial]
+  async fn test_parse_lemmy_community() {
+    let client = reqwest::Client::new().into();
+    let manager = create_activity_queue(client);
+    let context = init_context(manager.queue_handle().clone());
+    let site = parse_lemmy_instance(&context).await;
+    let community = parse_lemmy_community(&context).await;
+
+    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();
+    Site::delete(&*context.pool().get().unwrap(), site.id).unwrap();
   }
 }