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   fetch_local_site_data,
   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   // deprecated, use attributed_to instead
  65   pub(crate) moderators: Option<CollectionId<ApubCommunityModerators>>,
  66   #[serde(deserialize_with = "deserialize_skip_error", default)]
  67   pub(crate) attributed_to: Option<CollectionId<ApubCommunityModerators>>,
  68   // lemmy extension
  69   pub(crate) posting_restricted_to_mods: Option<bool>,
  70   pub(crate) outbox: CollectionId<ApubCommunityOutbox>,
  71   pub(crate) endpoints: Option<Endpoints>,
  72   pub(crate) featured: Option<CollectionId<ApubCommunityFeatured>>,
  73   #[serde(default)]
  74   pub(crate) language: Vec<LanguageTag>,
  75   pub(crate) published: Option<DateTime<FixedOffset>>,
  76   pub(crate) updated: Option<DateTime<FixedOffset>>,
  77 }
  78
  79 impl Group {
  80   pub(crate) async fn verify(
  81     &self,
  82     expected_domain: &Url,
  83     context: &LemmyContext,
  84   ) -> Result<(), LemmyError> {
  85     let local_site_data = fetch_local_site_data(context.pool()).await?;
  86
  87     check_apub_id_valid_with_strictness(
  88       self.id.inner(),
  89       true,
  90       &local_site_data,
  91       context.settings(),
  92     )?;
  93     verify_domains_match(expected_domain, self.id.inner())?;
  94
  95     let slur_regex = &local_site_opt_to_slur_regex(&local_site_data.local_site);
  96
  97     check_slurs(&self.preferred_username, slur_regex)?;
  98     check_slurs_opt(&self.name, slur_regex)?;
  99     let description = read_from_string_or_source_opt(&self.summary, &None, &self.source);
 100     check_slurs_opt(&description, slur_regex)?;
 101     Ok(())
 102   }
 103
 104   pub(crate) fn into_insert_form(self, instance_id: InstanceId) -> CommunityInsertForm {
 105     CommunityInsertForm {
 106       name: self.preferred_username.clone(),
 107       title: self.name.unwrap_or(self.preferred_username),
 108       description: read_from_string_or_source_opt(&self.summary, &None, &self.source),
 109       removed: None,
 110       published: self.published.map(|u| u.naive_local()),
 111       updated: self.updated.map(|u| u.naive_local()),
 112       deleted: Some(false),
 113       nsfw: Some(self.sensitive.unwrap_or(false)),
 114       actor_id: Some(self.id.into()),
 115       local: Some(false),
 116       private_key: None,
 117       hidden: Some(false),
 118       public_key: self.public_key.public_key_pem,
 119       last_refreshed_at: Some(naive_now()),
 120       icon: self.icon.map(|i| i.url.into()),
 121       banner: self.image.map(|i| i.url.into()),
 122       followers_url: Some(self.followers.into()),
 123       inbox_url: Some(self.inbox.into()),
 124       shared_inbox_url: self.endpoints.map(|e| e.shared_inbox.into()),
 125       moderators_url: self.moderators.map(Into::into),
 126       posting_restricted_to_mods: self.posting_restricted_to_mods,
 127       instance_id,
 128       featured_url: self.featured.map(Into::into),
 129     }
 130   }
 131
 132   pub(crate) fn into_update_form(self) -> CommunityUpdateForm {
 133     CommunityUpdateForm {
 134       title: Some(self.name.unwrap_or(self.preferred_username)),
 135       description: Some(read_from_string_or_source_opt(
 136         &self.summary,
 137         &None,
 138         &self.source,
 139       )),
 140       removed: None,
 141       published: self.published.map(|u| u.naive_local()),
 142       updated: Some(self.updated.map(|u| u.naive_local())),
 143       deleted: None,
 144       nsfw: Some(self.sensitive.unwrap_or(false)),
 145       actor_id: Some(self.id.into()),
 146       local: Some(false),
 147       private_key: None,
 148       hidden: Some(false),
 149       public_key: Some(self.public_key.public_key_pem),
 150       last_refreshed_at: Some(naive_now()),
 151       icon: Some(self.icon.map(|i| i.url.into())),
 152       banner: Some(self.image.map(|i| i.url.into())),
 153       followers_url: Some(self.followers.into()),
 154       inbox_url: Some(self.inbox.into()),
 155       shared_inbox_url: Some(self.endpoints.map(|e| e.shared_inbox.into())),
 156       moderators_url: self.moderators.map(Into::into),
 157       posting_restricted_to_mods: self.posting_restricted_to_mods,
 158       featured_url: self.featured.map(Into::into),
 159     }
 160   }
 161 }