crates/apub/src/objects/community.rs

   1 use crate::{
   2   check_apub_id_valid,
   3   local_site_data_cached,
   4   objects::instance::fetch_instance_actor_for_object,
   5   protocol::{
   6     objects::{group::Group, Endpoints, LanguageTag},
   7     ImageObject,
   8     Source,
   9   },
  10 };
  11 use activitypub_federation::{
  12   config::Data,
  13   kinds::actor::GroupType,
  14   traits::{Actor, Object},
  15 };
  16 use chrono::NaiveDateTime;
  17 use itertools::Itertools;
  18 use lemmy_api_common::{
  19   context::LemmyContext,
  20   utils::{generate_featured_url, generate_moderators_url, generate_outbox_url},
  21 };
  22 use lemmy_db_schema::{
  23   source::{
  24     actor_language::CommunityLanguage,
  25     community::{Community, CommunityUpdateForm},
  26   },
  27   traits::{ApubActor, Crud},
  28 };
  29 use lemmy_db_views_actor::structs::CommunityFollowerView;
  30 use lemmy_utils::{
  31   error::LemmyError,
  32   utils::{markdown::markdown_to_html, time::convert_datetime},
  33 };
  34 use std::ops::Deref;
  35 use tracing::debug;
  36 use url::Url;
  37
  38 #[derive(Clone, Debug)]
  39 pub struct ApubCommunity(Community);
  40
  41 impl Deref for ApubCommunity {
  42   type Target = Community;
  43   fn deref(&self) -> &Self::Target {
  44     &self.0
  45   }
  46 }
  47
  48 impl From<Community> for ApubCommunity {
  49   fn from(c: Community) -> Self {
  50     ApubCommunity(c)
  51   }
  52 }
  53
  54 #[async_trait::async_trait]
  55 impl Object for ApubCommunity {
  56   type DataType = LemmyContext;
  57   type Kind = Group;
  58   type Error = LemmyError;
  59
  60   fn last_refreshed_at(&self) -> Option<NaiveDateTime> {
  61     Some(self.last_refreshed_at)
  62   }
  63
  64   #[tracing::instrument(skip_all)]
  65   async fn read_from_id(
  66     object_id: Url,
  67     context: &Data<Self::DataType>,
  68   ) -> Result<Option<Self>, LemmyError> {
  69     Ok(
  70       Community::read_from_apub_id(context.pool(), &object_id.into())
  71         .await?
  72         .map(Into::into),
  73     )
  74   }
  75
  76   #[tracing::instrument(skip_all)]
  77   async fn delete(self, context: &Data<Self::DataType>) -> Result<(), LemmyError> {
  78     let form = CommunityUpdateForm::builder().deleted(Some(true)).build();
  79     Community::update(context.pool(), self.id, &form).await?;
  80     Ok(())
  81   }
  82
  83   #[tracing::instrument(skip_all)]
  84   async fn into_json(self, data: &Data<Self::DataType>) -> Result<Group, LemmyError> {
  85     let community_id = self.id;
  86     let langs = CommunityLanguage::read(data.pool(), community_id).await?;
  87     let language = LanguageTag::new_multiple(langs, data.pool()).await?;
  88
  89     let group = Group {
  90       kind: GroupType::Group,
  91       id: self.id().into(),
  92       preferred_username: self.name.clone(),
  93       name: Some(self.title.clone()),
  94       summary: self.description.as_ref().map(|b| markdown_to_html(b)),
  95       source: self.description.clone().map(Source::new),
  96       icon: self.icon.clone().map(ImageObject::new),
  97       image: self.banner.clone().map(ImageObject::new),
  98       sensitive: Some(self.nsfw),
  99       featured: Some(generate_featured_url(&self.actor_id)?.into()),
 100       inbox: self.inbox_url.clone().into(),
 101       outbox: generate_outbox_url(&self.actor_id)?.into(),
 102       followers: self.followers_url.clone().into(),
 103       endpoints: self.shared_inbox_url.clone().map(|s| Endpoints {
 104         shared_inbox: s.into(),
 105       }),
 106       public_key: self.public_key(),
 107       language,
 108       published: Some(convert_datetime(self.published)),
 109       updated: self.updated.map(convert_datetime),
 110       posting_restricted_to_mods: Some(self.posting_restricted_to_mods),
 111       attributed_to: Some(generate_moderators_url(&self.actor_id)?.into()),
 112     };
 113     Ok(group)
 114   }
 115
 116   #[tracing::instrument(skip_all)]
 117   async fn verify(
 118     group: &Group,
 119     expected_domain: &Url,
 120     context: &Data<Self::DataType>,
 121   ) -> Result<(), LemmyError> {
 122     group.verify(expected_domain, context).await
 123   }
 124
 125   /// Converts a `Group` to `Community`, inserts it into the database and updates moderators.
 126   #[tracing::instrument(skip_all)]
 127   async fn from_json(
 128     group: Group,
 129     context: &Data<Self::DataType>,
 130   ) -> Result<ApubCommunity, LemmyError> {
 131     let instance_id = fetch_instance_actor_for_object(&group.id, context).await?;
 132
 133     let form = Group::into_insert_form(group.clone(), instance_id);
 134     let languages = LanguageTag::to_language_id_multiple(group.language, context.pool()).await?;
 135
 136     let community = Community::create(context.pool(), &form).await?;
 137     CommunityLanguage::update(context.pool(), languages, community.id).await?;
 138
 139     let community: ApubCommunity = community.into();
 140
 141     // Fetching mods and outbox is not necessary for Lemmy to work, so ignore errors. Besides,
 142     // we need to ignore these errors so that tests can work entirely offline.
 143     let fetch_outbox = group.outbox.dereference(&community, context);
 144
 145     if let Some(moderators) = group.attributed_to {
 146       let fetch_moderators = moderators.dereference(&community, context);
 147       // Fetch mods and outbox in parallel
 148       let res = tokio::join!(fetch_outbox, fetch_moderators);
 149       res.0.map_err(|e| debug!("{}", e)).ok();
 150       res.1.map_err(|e| debug!("{}", e)).ok();
 151     } else {
 152       fetch_outbox.await.map_err(|e| debug!("{}", e)).ok();
 153     }
 154
 155     Ok(community)
 156   }
 157 }
 158
 159 impl Actor for ApubCommunity {
 160   fn id(&self) -> Url {
 161     self.actor_id.inner().clone()
 162   }
 163
 164   fn public_key_pem(&self) -> &str {
 165     &self.public_key
 166   }
 167
 168   fn private_key_pem(&self) -> Option<String> {
 169     self.private_key.clone()
 170   }
 171
 172   fn inbox(&self) -> Url {
 173     self.inbox_url.clone().into()
 174   }
 175
 176   fn shared_inbox(&self) -> Option<Url> {
 177     self.shared_inbox_url.clone().map(Into::into)
 178   }
 179 }
 180
 181 impl ApubCommunity {
 182   /// For a given community, returns the inboxes of all followers.
 183   #[tracing::instrument(skip_all)]
 184   pub(crate) async fn get_follower_inboxes(
 185     &self,
 186     context: &LemmyContext,
 187   ) -> Result<Vec<Url>, LemmyError> {
 188     let id = self.id;
 189
 190     let local_site_data = local_site_data_cached(context.pool()).await?;
 191     let follows = CommunityFollowerView::for_community(context.pool(), id).await?;
 192     let inboxes: Vec<Url> = follows
 193       .into_iter()
 194       .filter(|f| !f.follower.local)
 195       .map(|f| {
 196         f.follower
 197           .shared_inbox_url
 198           .unwrap_or(f.follower.inbox_url)
 199           .into()
 200       })
 201       .unique()
 202       .filter(|inbox: &Url| inbox.host_str() != Some(&context.settings().hostname))
 203       // Don't send to blocked instances
 204       .filter(|inbox| check_apub_id_valid(inbox, &local_site_data).is_ok())
 205       .collect();
 206
 207     Ok(inboxes)
 208   }
 209 }
 210
 211 #[cfg(test)]
 212 pub(crate) mod tests {
 213   use super::*;
 214   use crate::{
 215     objects::{instance::tests::parse_lemmy_instance, tests::init_context},
 216     protocol::tests::file_to_json_object,
 217   };
 218   use activitypub_federation::fetch::collection_id::CollectionId;
 219   use lemmy_db_schema::{source::site::Site, traits::Crud};
 220   use serial_test::serial;
 221
 222   pub(crate) async fn parse_lemmy_community(context: &Data<LemmyContext>) -> ApubCommunity {
 223     // use separate counter so this doesnt affect tests
 224     let context2 = context.reset_request_count();
 225     let mut json: Group = file_to_json_object("assets/lemmy/objects/group.json").unwrap();
 226     // change these links so they dont fetch over the network
 227     json.attributed_to = None;
 228     json.outbox =
 229       CollectionId::parse("https://enterprise.lemmy.ml/c/tenforward/not_outbox").unwrap();
 230
 231     let url = Url::parse("https://enterprise.lemmy.ml/c/tenforward").unwrap();
 232     ApubCommunity::verify(&json, &url, &context2).await.unwrap();
 233     let community = ApubCommunity::from_json(json, &context2).await.unwrap();
 234     // this makes one requests to the (intentionally broken) outbox collection
 235     assert_eq!(context2.request_count(), 1);
 236     community
 237   }
 238
 239   #[tokio::test]
 240   #[serial]
 241   async fn test_parse_lemmy_community() {
 242     let context = init_context().await;
 243     let site = parse_lemmy_instance(&context).await;
 244     let community = parse_lemmy_community(&context).await;
 245
 246     assert_eq!(community.title, "Ten Forward");
 247     assert!(!community.local);
 248     assert_eq!(community.description.as_ref().unwrap().len(), 132);
 249
 250     Community::delete(context.pool(), community.id)
 251       .await
 252       .unwrap();
 253     Site::delete(context.pool(), site.id).await.unwrap();
 254   }
 255 }