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

   1 use crate::{
   2   fetcher::user_or_community::{PersonOrGroupType, UserOrCommunity},
   3   local_instance,
   4   objects::{community::ApubCommunity, person::ApubPerson, post::ApubPost},
   5   protocol::{ImageObject, Source},
   6 };
   7 use activitypub_federation::{
   8   core::object_id::ObjectId,
   9   data::Data,
  10   deser::{
  11     helpers::{deserialize_one_or_many, deserialize_skip_error},
  12     values::MediaTypeMarkdownOrHtml,
  13   },
  14   traits::{ActivityHandler, ApubObject},
  15 };
  16 use activitystreams_kinds::link::LinkType;
  17 use chrono::{DateTime, FixedOffset};
  18 use itertools::Itertools;
  19 use lemmy_db_schema::newtypes::DbUrl;
  20 use lemmy_utils::error::LemmyError;
  21 use lemmy_websocket::LemmyContext;
  22 use serde::{Deserialize, Serialize};
  23 use serde_with::skip_serializing_none;
  24 use url::Url;
  25
  26 #[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
  27 pub enum PageType {
  28   Page,
  29   Article,
  30   Note,
  31   Video,
  32 }
  33
  34 #[skip_serializing_none]
  35 #[derive(Clone, Debug, Deserialize, Serialize)]
  36 #[serde(rename_all = "camelCase")]
  37 pub struct Page {
  38   #[serde(rename = "type")]
  39   pub(crate) kind: PageType,
  40   pub(crate) id: ObjectId<ApubPost>,
  41   pub(crate) attributed_to: AttributedTo,
  42   #[serde(deserialize_with = "deserialize_one_or_many")]
  43   pub(crate) to: Vec<Url>,
  44   pub(crate) name: String,
  45
  46   #[serde(deserialize_with = "deserialize_one_or_many", default)]
  47   pub(crate) cc: Vec<Url>,
  48   pub(crate) content: Option<String>,
  49   pub(crate) media_type: Option<MediaTypeMarkdownOrHtml>,
  50   #[serde(deserialize_with = "deserialize_skip_error", default)]
  51   pub(crate) source: Option<Source>,
  52   /// deprecated, use attachment field
  53   #[serde(deserialize_with = "deserialize_skip_error", default)]
  54   pub(crate) url: Option<Url>,
  55   /// most software uses array type for attachment field, so we do the same. nevertheless, we only
  56   /// use the first item
  57   #[serde(default)]
  58   pub(crate) attachment: Vec<Attachment>,
  59   pub(crate) image: Option<ImageObject>,
  60   pub(crate) comments_enabled: Option<bool>,
  61   pub(crate) sensitive: Option<bool>,
  62   pub(crate) stickied: Option<bool>,
  63   pub(crate) published: Option<DateTime<FixedOffset>>,
  64   pub(crate) updated: Option<DateTime<FixedOffset>>,
  65 }
  66
  67 #[derive(Clone, Debug, Deserialize, Serialize)]
  68 #[serde(rename_all = "camelCase")]
  69 pub(crate) struct Attachment {
  70   pub(crate) href: Url,
  71   pub(crate) r#type: LinkType,
  72 }
  73
  74 #[derive(Clone, Debug, Deserialize, Serialize)]
  75 #[serde(untagged)]
  76 pub(crate) enum AttributedTo {
  77   Lemmy(ObjectId<ApubPerson>),
  78   Peertube([AttributedToPeertube; 2]),
  79 }
  80
  81 #[derive(Clone, Debug, Deserialize, Serialize)]
  82 #[serde(rename_all = "camelCase")]
  83 pub(crate) struct AttributedToPeertube {
  84   #[serde(rename = "type")]
  85   pub kind: PersonOrGroupType,
  86   pub id: ObjectId<UserOrCommunity>,
  87 }
  88
  89 impl Page {
  90   /// Only mods can change the post's stickied/locked status. So if either of these is changed from
  91   /// the current value, it is a mod action and needs to be verified as such.
  92   ///
  93   /// Both stickied and locked need to be false on a newly created post (verified in [[CreatePost]].
  94   pub(crate) async fn is_mod_action(&self, context: &LemmyContext) -> Result<bool, LemmyError> {
  95     let old_post = ObjectId::<ApubPost>::new(self.id.clone())
  96       .dereference_local(context)
  97       .await;
  98
  99     let stickied_changed = Page::is_stickied_changed(&old_post, &self.stickied);
 100     let locked_changed = Page::is_locked_changed(&old_post, &self.comments_enabled);
 101     Ok(stickied_changed || locked_changed)
 102   }
 103
 104   pub(crate) fn is_stickied_changed<E>(
 105     old_post: &Result<ApubPost, E>,
 106     new_stickied: &Option<bool>,
 107   ) -> bool {
 108     if let Some(new_stickied) = new_stickied {
 109       if let Ok(old_post) = old_post {
 110         return new_stickied != &old_post.stickied;
 111       }
 112     }
 113
 114     false
 115   }
 116
 117   pub(crate) fn is_locked_changed<E>(
 118     old_post: &Result<ApubPost, E>,
 119     new_comments_enabled: &Option<bool>,
 120   ) -> bool {
 121     if let Some(new_comments_enabled) = new_comments_enabled {
 122       if let Ok(old_post) = old_post {
 123         return new_comments_enabled != &!old_post.locked;
 124       }
 125     }
 126
 127     false
 128   }
 129
 130   pub(crate) async fn extract_community(
 131     &self,
 132     context: &LemmyContext,
 133     request_counter: &mut i32,
 134   ) -> Result<ApubCommunity, LemmyError> {
 135     match &self.attributed_to {
 136       AttributedTo::Lemmy(_) => {
 137         let mut iter = self.to.iter().merge(self.cc.iter());
 138         loop {
 139           if let Some(cid) = iter.next() {
 140             let cid = ObjectId::new(cid.clone());
 141             if let Ok(c) = cid
 142               .dereference(context, local_instance(context), request_counter)
 143               .await
 144             {
 145               break Ok(c);
 146             }
 147           } else {
 148             return Err(LemmyError::from_message("No community found in cc"));
 149           }
 150         }
 151       }
 152       AttributedTo::Peertube(p) => {
 153         p.iter()
 154           .find(|a| a.kind == PersonOrGroupType::Group)
 155           .map(|a| ObjectId::<ApubCommunity>::new(a.id.clone().into_inner()))
 156           .ok_or_else(|| LemmyError::from_message("page does not specify group"))?
 157           .dereference(context, local_instance(context), request_counter)
 158           .await
 159       }
 160     }
 161   }
 162
 163   pub(crate) fn creator(&self) -> Result<ObjectId<ApubPerson>, LemmyError> {
 164     match &self.attributed_to {
 165       AttributedTo::Lemmy(l) => Ok(l.clone()),
 166       AttributedTo::Peertube(p) => p
 167         .iter()
 168         .find(|a| a.kind == PersonOrGroupType::Person)
 169         .map(|a| ObjectId::<ApubPerson>::new(a.id.clone().into_inner()))
 170         .ok_or_else(|| LemmyError::from_message("page does not specify creator person")),
 171     }
 172   }
 173 }
 174
 175 impl Attachment {
 176   pub(crate) fn new(url: DbUrl) -> Attachment {
 177     Attachment {
 178       href: url.into(),
 179       r#type: Default::default(),
 180     }
 181   }
 182 }
 183
 184 // Used for community outbox, so that it can be compatible with Pleroma/Mastodon.
 185 #[async_trait::async_trait(?Send)]
 186 impl ActivityHandler for Page {
 187   type DataType = LemmyContext;
 188   type Error = LemmyError;
 189   fn id(&self) -> &Url {
 190     unimplemented!()
 191   }
 192   fn actor(&self) -> &Url {
 193     unimplemented!()
 194   }
 195   async fn verify(
 196     &self,
 197     data: &Data<Self::DataType>,
 198     request_counter: &mut i32,
 199   ) -> Result<(), LemmyError> {
 200     ApubPost::verify(self, self.id.inner(), data, request_counter).await
 201   }
 202   async fn receive(
 203     self,
 204     data: &Data<Self::DataType>,
 205     request_counter: &mut i32,
 206   ) -> Result<(), LemmyError> {
 207     ApubPost::from_apub(self, data, request_counter).await?;
 208     Ok(())
 209   }
 210 }