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