crates/apub/src/protocol/objects/group.rs

   1 use crate::{
   2   check_apub_id_valid_with_strictness,
   3   collections::{
   4     community_featured::ApubCommunityFeatured,
   5     community_moderators::ApubCommunityModerators,
   6     community_outbox::ApubCommunityOutbox,
   7   },
   8   local_site_data_cached,
   9   objects::{community::ApubCommunity, read_from_string_or_source_opt},
  10   protocol::{
  11     objects::{Endpoints, LanguageTag},
  12     ImageObject,
  13     Source,
  14   },
  15 };
  16 use activitypub_federation::{
  17   fetch::{collection_id::CollectionId, object_id::ObjectId},
  18   kinds::actor::GroupType,
  19   protocol::{
  20     helpers::deserialize_skip_error,
  21     public_key::PublicKey,
  22     verification::verify_domains_match,
  23   },
  24 };
  25 use chrono::{DateTime, FixedOffset};
  26 use lemmy_api_common::{context::LemmyContext, utils::local_site_opt_to_slur_regex};
  27 use lemmy_db_schema::{
  28   newtypes::InstanceId,
  29   source::community::{CommunityInsertForm, CommunityUpdateForm},
  30   utils::naive_now,
  31 };
  32 use lemmy_utils::{
  33   error::LemmyError,
  34   utils::slurs::{check_slurs, check_slurs_opt},
  35 };
  36 use serde::{Deserialize, Serialize};
  37 use serde_with::skip_serializing_none;
  38 use std::fmt::Debug;
  39 use url::Url;
  40
  41 #[skip_serializing_none]
  42 #[derive(Clone, Debug, Deserialize, Serialize)]
  43 #[serde(rename_all = "camelCase")]
  44 pub struct Group {
  45   #[serde(rename = "type")]
  46   pub(crate) kind: GroupType,
  47   pub(crate) id: ObjectId<ApubCommunity>,
  48   /// username, set at account creation and usually fixed after that
  49   pub(crate) preferred_username: String,
  50   pub(crate) inbox: Url,
  51   pub(crate) followers: Url,
  52   pub(crate) public_key: PublicKey,
  53
  54   /// title
  55   pub(crate) name: Option<String>,
  56   pub(crate) summary: Option<String>,
  57   #[serde(deserialize_with = "deserialize_skip_error", default)]
  58   pub(crate) source: Option<Source>,
  59   pub(crate) icon: Option<ImageObject>,
  60   /// banner
  61   pub(crate) image: Option<ImageObject>,
  62   // lemmy extension
  63   pub(crate) sensitive: Option<bool>,
  64   #[serde(deserialize_with = "deserialize_skip_error", default)]
  65   pub(crate) attributed_to: Option<CollectionId<ApubCommunityModerators>>,
  66   // lemmy extension
  67   pub(crate) posting_restricted_to_mods: Option<bool>,
  68   pub(crate) outbox: CollectionId<ApubCommunityOutbox>,
  69   pub(crate) endpoints: Option<Endpoints>,
  70   pub(crate) featured: Option<CollectionId<ApubCommunityFeatured>>,
  71   #[serde(default)]
  72   pub(crate) language: Vec<LanguageTag>,
  73   pub(crate) published: Option<DateTime<FixedOffset>>,
  74   pub(crate) updated: Option<DateTime<FixedOffset>>,
  75 }
  76
  77 impl Group {
  78   pub(crate) async fn verify(
  79     &self,
  80     expected_domain: &Url,
  81     context: &LemmyContext,
  82   ) -> Result<(), LemmyError> {
  83     check_apub_id_valid_with_strictness(self.id.inner(), true, context).await?;
  84     verify_domains_match(expected_domain, self.id.inner())?;
  85
  86     let local_site_data = local_site_data_cached(&mut context.pool()).await?;
  87     let slur_regex = &local_site_opt_to_slur_regex(&local_site_data.local_site);
  88
  89     check_slurs(&self.preferred_username, slur_regex)?;
  90     check_slurs_opt(&self.name, slur_regex)?;
  91     let description = read_from_string_or_source_opt(&self.summary, &None, &self.source);
  92     check_slurs_opt(&description, slur_regex)?;
  93     Ok(())
  94   }
  95
  96   pub(crate) fn into_insert_form(self, instance_id: InstanceId) -> CommunityInsertForm {
  97     CommunityInsertForm {
  98       name: self.preferred_username.clone(),
  99       title: self.name.unwrap_or(self.preferred_username),
 100       description: read_from_string_or_source_opt(&self.summary, &None, &self.source),
 101       removed: None,
 102       published: self.published.map(|u| u.naive_local()),
 103       updated: self.updated.map(|u| u.naive_local()),
 104       deleted: Some(false),
 105       nsfw: Some(self.sensitive.unwrap_or(false)),
 106       actor_id: Some(self.id.into()),
 107       local: Some(false),
 108       private_key: None,
 109       hidden: None,
 110       public_key: self.public_key.public_key_pem,
 111       last_refreshed_at: Some(naive_now()),
 112       icon: self.icon.map(|i| i.url.into()),
 113       banner: self.image.map(|i| i.url.into()),
 114       followers_url: Some(self.followers.into()),
 115       inbox_url: Some(self.inbox.into()),
 116       shared_inbox_url: self.endpoints.map(|e| e.shared_inbox.into()),
 117       moderators_url: self.attributed_to.map(Into::into),
 118       posting_restricted_to_mods: self.posting_restricted_to_mods,
 119       instance_id,
 120       featured_url: self.featured.map(Into::into),
 121     }
 122   }
 123
 124   pub(crate) fn into_update_form(self) -> CommunityUpdateForm {
 125     CommunityUpdateForm {
 126       title: Some(self.name.unwrap_or(self.preferred_username)),
 127       description: Some(read_from_string_or_source_opt(
 128         &self.summary,
 129         &None,
 130         &self.source,
 131       )),
 132       removed: None,
 133       published: self.published.map(|u| u.naive_local()),
 134       updated: Some(self.updated.map(|u| u.naive_local())),
 135       deleted: None,
 136       nsfw: Some(self.sensitive.unwrap_or(false)),
 137       actor_id: Some(self.id.into()),
 138       local: None,
 139       private_key: None,
 140       hidden: None,
 141       public_key: Some(self.public_key.public_key_pem),
 142       last_refreshed_at: Some(naive_now()),
 143       icon: Some(self.icon.map(|i| i.url.into())),
 144       banner: Some(self.image.map(|i| i.url.into())),
 145       followers_url: Some(self.followers.into()),
 146       inbox_url: Some(self.inbox.into()),
 147       shared_inbox_url: Some(self.endpoints.map(|e| e.shared_inbox.into())),
 148       moderators_url: self.attributed_to.map(Into::into),
 149       posting_restricted_to_mods: self.posting_restricted_to_mods,
 150       featured_url: self.featured.map(Into::into),
 151     }
 152   }
 153 }