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

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