X-Git-Url: http://these/git/?a=blobdiff_plain;f=crates%2Fapub%2Fsrc%2Fobjects%2Fcommunity.rs;h=75eb941b1b3af0589cf29782277e4ef6e388c4c9;hb=92568956353f21649ed9aff68b42699c9d036f30;hp=c8ddd29724dcca733c0b46602547104bb94be978;hpb=8708ad1b44e58dfbd8c555f9bc270daadbfa01af;p=lemmy.git diff --git a/crates/apub/src/objects/community.rs b/crates/apub/src/objects/community.rs index c8ddd297..75eb941b 100644 --- a/crates/apub/src/objects/community.rs +++ b/crates/apub/src/objects/community.rs @@ -1,191 +1,252 @@ use crate::{ - extensions::{context::lemmy_context, signatures::PublicKey}, - fetcher::community::{fetch_community_outbox, update_community_mods}, - generate_moderators_url, - objects::{create_tombstone, FromApub, ImageObject, Source, ToApub}, - ActorType, + check_apub_id_valid, + local_site_data_cached, + objects::instance::fetch_instance_actor_for_object, + protocol::{ + objects::{group::Group, Endpoints, LanguageTag}, + ImageObject, + Source, + }, }; -use activitystreams::{ - actor::{kind::GroupType, Endpoints}, - base::AnyBase, - object::{kind::ImageType, Tombstone}, - primitives::OneOrMany, - unparsed::Unparsed, +use activitypub_federation::{ + config::Data, + kinds::actor::GroupType, + traits::{Actor, Object}, }; -use chrono::{DateTime, FixedOffset}; -use lemmy_api_common::blocking; -use lemmy_apub_lib::{ - values::{MediaTypeHtml, MediaTypeMarkdown}, - verify_domains_match, +use chrono::NaiveDateTime; +use lemmy_api_common::{ + context::LemmyContext, + utils::{generate_featured_url, generate_moderators_url, generate_outbox_url}, }; -use lemmy_db_queries::{source::community::Community_, DbPool}; use lemmy_db_schema::{ - naive_now, - source::community::{Community, CommunityForm}, + source::{ + actor_language::CommunityLanguage, + community::{Community, CommunityUpdateForm}, + }, + traits::{ApubActor, Crud}, }; +use lemmy_db_views_actor::structs::CommunityFollowerView; use lemmy_utils::{ - settings::structs::Settings, - utils::{check_slurs, check_slurs_opt, convert_datetime, markdown_to_html}, - LemmyError, + error::LemmyError, + utils::{markdown::markdown_to_html, time::convert_datetime}, }; -use lemmy_websocket::LemmyContext; -use serde::{Deserialize, Serialize}; -use serde_with::skip_serializing_none; +use std::ops::Deref; +use tracing::debug; use url::Url; -#[skip_serializing_none] -#[derive(Clone, Debug, Deserialize, Serialize)] -#[serde(rename_all = "camelCase")] -pub struct Group { - #[serde(rename = "@context")] - context: OneOrMany, - #[serde(rename = "type")] - kind: GroupType, - id: Url, - /// username, set at account creation and can never be changed - preferred_username: String, - /// title (can be changed at any time) - name: String, - content: Option, - media_type: Option, - source: Option, - icon: Option, - /// banner - image: Option, - // lemmy extension - sensitive: Option, - // lemmy extension - pub(crate) moderators: Option, - inbox: Url, - pub(crate) outbox: Url, - followers: Url, - endpoints: Endpoints, - public_key: PublicKey, - published: DateTime, - updated: Option>, - #[serde(flatten)] - unparsed: Unparsed, -} +#[derive(Clone, Debug)] +pub struct ApubCommunity(Community); -impl Group { - pub(crate) fn id(&self, expected_domain: &Url) -> Result<&Url, LemmyError> { - verify_domains_match(&self.id, expected_domain)?; - Ok(&self.id) +impl Deref for ApubCommunity { + type Target = Community; + fn deref(&self) -> &Self::Target { + &self.0 } - pub(crate) async fn from_apub_to_form( - group: &Group, - expected_domain: &Url, - settings: &Settings, - ) -> Result { - let actor_id = Some(group.id(expected_domain)?.clone().into()); - let name = group.preferred_username.clone(); - let title = group.name.clone(); - let description = group.source.clone().map(|s| s.content); - let shared_inbox = group.endpoints.shared_inbox.clone().map(|s| s.into()); - - let slur_regex = &settings.slur_regex(); - check_slurs(&name, slur_regex)?; - check_slurs(&title, slur_regex)?; - check_slurs_opt(&description, slur_regex)?; - - Ok(CommunityForm { - name, - title, - description, - removed: None, - published: Some(group.published.naive_local()), - updated: group.updated.map(|u| u.naive_local()), - deleted: None, - nsfw: Some(group.sensitive.unwrap_or(false)), - actor_id, - local: Some(false), - private_key: None, - public_key: Some(group.public_key.public_key_pem.clone()), - last_refreshed_at: Some(naive_now()), - icon: Some(group.icon.clone().map(|i| i.url.into())), - banner: Some(group.image.clone().map(|i| i.url.into())), - followers_url: Some(group.followers.clone().into()), - inbox_url: Some(group.inbox.clone().into()), - shared_inbox_url: Some(shared_inbox), - }) +} + +impl From for ApubCommunity { + fn from(c: Community) -> Self { + ApubCommunity(c) } } -#[async_trait::async_trait(?Send)] -impl ToApub for Community { - type ApubType = Group; - - async fn to_apub(&self, _pool: &DbPool) -> Result { - let source = self.description.clone().map(|bio| Source { - content: bio, - media_type: MediaTypeMarkdown::Markdown, - }); - let icon = self.icon.clone().map(|url| ImageObject { - kind: ImageType::Image, - url: url.into(), - }); - let image = self.banner.clone().map(|url| ImageObject { - kind: ImageType::Image, - url: url.into(), - }); +#[async_trait::async_trait] +impl Object for ApubCommunity { + type DataType = LemmyContext; + type Kind = Group; + type Error = LemmyError; + + fn last_refreshed_at(&self) -> Option { + Some(self.last_refreshed_at) + } + + #[tracing::instrument(skip_all)] + async fn read_from_id( + object_id: Url, + context: &Data, + ) -> Result, LemmyError> { + Ok( + Community::read_from_apub_id(&mut context.pool(), &object_id.into()) + .await? + .map(Into::into), + ) + } + + #[tracing::instrument(skip_all)] + async fn delete(self, context: &Data) -> Result<(), LemmyError> { + let form = CommunityUpdateForm::builder().deleted(Some(true)).build(); + Community::update(&mut context.pool(), self.id, &form).await?; + Ok(()) + } + + #[tracing::instrument(skip_all)] + async fn into_json(self, data: &Data) -> Result { + let community_id = self.id; + let langs = CommunityLanguage::read(&mut data.pool(), community_id).await?; + let language = LanguageTag::new_multiple(langs, &mut data.pool()).await?; let group = Group { - context: lemmy_context(), kind: GroupType::Group, - id: self.actor_id(), + id: self.id().into(), preferred_username: self.name.clone(), - name: self.title.clone(), - content: self.description.as_ref().map(|b| markdown_to_html(b)), - media_type: self.description.as_ref().map(|_| MediaTypeHtml::Html), - source, - icon, - image, + name: Some(self.title.clone()), + summary: self.description.as_ref().map(|b| markdown_to_html(b)), + source: self.description.clone().map(Source::new), + icon: self.icon.clone().map(ImageObject::new), + image: self.banner.clone().map(ImageObject::new), sensitive: Some(self.nsfw), - moderators: Some(generate_moderators_url(&self.actor_id)?.into()), + featured: Some(generate_featured_url(&self.actor_id)?.into()), inbox: self.inbox_url.clone().into(), - outbox: self.get_outbox_url()?, + outbox: generate_outbox_url(&self.actor_id)?.into(), followers: self.followers_url.clone().into(), - endpoints: Endpoints { - shared_inbox: self.shared_inbox_url.clone().map(|s| s.into()), - ..Default::default() - }, - public_key: self.get_public_key()?, - published: convert_datetime(self.published), + endpoints: self.shared_inbox_url.clone().map(|s| Endpoints { + shared_inbox: s.into(), + }), + public_key: self.public_key(), + language, + published: Some(convert_datetime(self.published)), updated: self.updated.map(convert_datetime), - unparsed: Default::default(), + posting_restricted_to_mods: Some(self.posting_restricted_to_mods), + attributed_to: Some(generate_moderators_url(&self.actor_id)?.into()), }; Ok(group) } - fn to_tombstone(&self) -> Result { - create_tombstone( - self.deleted, - self.actor_id.to_owned().into(), - self.updated, - GroupType::Group, - ) + #[tracing::instrument(skip_all)] + async fn verify( + group: &Group, + expected_domain: &Url, + context: &Data, + ) -> Result<(), LemmyError> { + group.verify(expected_domain, context).await + } + + /// Converts a `Group` to `Community`, inserts it into the database and updates moderators. + #[tracing::instrument(skip_all)] + async fn from_json( + group: Group, + context: &Data, + ) -> Result { + let instance_id = fetch_instance_actor_for_object(&group.id, context).await?; + + let form = Group::into_insert_form(group.clone(), instance_id); + let languages = + LanguageTag::to_language_id_multiple(group.language, &mut context.pool()).await?; + + let community = Community::create(&mut context.pool(), &form).await?; + CommunityLanguage::update(&mut context.pool(), languages, community.id).await?; + + let community: ApubCommunity = community.into(); + + // Fetching mods and outbox is not necessary for Lemmy to work, so ignore errors. Besides, + // we need to ignore these errors so that tests can work entirely offline. + let fetch_outbox = group.outbox.dereference(&community, context); + + if let Some(moderators) = group.attributed_to { + let fetch_moderators = moderators.dereference(&community, context); + // Fetch mods and outbox in parallel + let res = tokio::join!(fetch_outbox, fetch_moderators); + res.0.map_err(|e| debug!("{}", e)).ok(); + res.1.map_err(|e| debug!("{}", e)).ok(); + } else { + fetch_outbox.await.map_err(|e| debug!("{}", e)).ok(); + } + + Ok(community) } } -#[async_trait::async_trait(?Send)] -impl FromApub for Community { - type ApubType = Group; +impl Actor for ApubCommunity { + fn id(&self) -> Url { + self.actor_id.inner().clone() + } - /// Converts a `Group` to `Community`, inserts it into the database and updates moderators. - async fn from_apub( - group: &Group, + fn public_key_pem(&self) -> &str { + &self.public_key + } + + fn private_key_pem(&self) -> Option { + self.private_key.clone() + } + + fn inbox(&self) -> Url { + self.inbox_url.clone().into() + } + + fn shared_inbox(&self) -> Option { + self.shared_inbox_url.clone().map(Into::into) + } +} + +impl ApubCommunity { + /// For a given community, returns the inboxes of all followers. + #[tracing::instrument(skip_all)] + pub(crate) async fn get_follower_inboxes( + &self, context: &LemmyContext, - expected_domain: &Url, - request_counter: &mut i32, - ) -> Result { - let form = Group::from_apub_to_form(group, expected_domain, &context.settings()).await?; + ) -> Result, LemmyError> { + let id = self.id; + + let local_site_data = local_site_data_cached(&mut context.pool()).await?; + let follows = + CommunityFollowerView::get_community_follower_inboxes(&mut context.pool(), id).await?; + let inboxes: Vec = follows + .into_iter() + .map(Into::into) + .filter(|inbox: &Url| inbox.host_str() != Some(&context.settings().hostname)) + // Don't send to blocked instances + .filter(|inbox| check_apub_id_valid(inbox, &local_site_data).is_ok()) + .collect(); - let community = blocking(context.pool(), move |conn| Community::upsert(conn, &form)).await??; - update_community_mods(group, &community, context, request_counter).await?; + Ok(inboxes) + } +} - // TODO: doing this unconditionally might cause infinite loop for some reason - fetch_community_outbox(context, &group.outbox, request_counter).await?; +#[cfg(test)] +pub(crate) mod tests { + #![allow(clippy::unwrap_used)] + #![allow(clippy::indexing_slicing)] - Ok(community) + use super::*; + use crate::{ + objects::{instance::tests::parse_lemmy_instance, tests::init_context}, + protocol::tests::file_to_json_object, + }; + use activitypub_federation::fetch::collection_id::CollectionId; + use lemmy_db_schema::{source::site::Site, traits::Crud}; + use serial_test::serial; + + pub(crate) async fn parse_lemmy_community(context: &Data) -> ApubCommunity { + // use separate counter so this doesnt affect tests + let context2 = context.reset_request_count(); + let mut json: Group = file_to_json_object("assets/lemmy/objects/group.json").unwrap(); + // change these links so they dont fetch over the network + json.attributed_to = None; + json.outbox = + CollectionId::parse("https://enterprise.lemmy.ml/c/tenforward/not_outbox").unwrap(); + + let url = Url::parse("https://enterprise.lemmy.ml/c/tenforward").unwrap(); + ApubCommunity::verify(&json, &url, &context2).await.unwrap(); + let community = ApubCommunity::from_json(json, &context2).await.unwrap(); + // this makes one requests to the (intentionally broken) outbox collection + assert_eq!(context2.request_count(), 1); + community + } + + #[tokio::test] + #[serial] + async fn test_parse_lemmy_community() { + let context = init_context().await; + let site = parse_lemmy_instance(&context).await; + let community = parse_lemmy_community(&context).await; + + assert_eq!(community.title, "Ten Forward"); + assert!(!community.local); + assert_eq!(community.description.as_ref().unwrap().len(), 132); + + Community::delete(&mut context.pool(), community.id) + .await + .unwrap(); + Site::delete(&mut context.pool(), site.id).await.unwrap(); } }