lemmy/crates/apub/src/http/community.rs

use actix_web::{body::Body, web, web::Payload, HttpRequest, HttpResponse};
use log::info;
use serde::{Deserialize, Serialize};

use lemmy_api_common::blocking;
use lemmy_apub_lib::{
  traits::{ActivityFields, ActivityHandler, ActorType, ApubObject},
  verify::verify_domains_match,
};
use lemmy_db_schema::source::community::Community;
use lemmy_utils::LemmyError;
use lemmy_websocket::LemmyContext;

use crate::{
  activities::{
    community::announce::{AnnouncableActivities, AnnounceActivity, GetCommunity},
    following::{follow::FollowCommunity, undo::UndoFollowCommunity},
    report::Report,
    verify_person_in_community,
  },
  collections::{
    community_moderators::ApubCommunityModerators,
    community_outbox::ApubCommunityOutbox,
    CommunityContext,
  },
  context::WithContext,
  fetcher::object_id::ObjectId,
  generate_outbox_url,
  http::{
    create_apub_response,
    create_apub_tombstone_response,
    payload_to_string,
    receive_activity,
  },
  objects::community::ApubCommunity,
  protocol::collections::group_followers::CommunityFollowers,
};

#[derive(Deserialize)]
pub(crate) struct CommunityQuery {
  community_name: String,
}

/// Return the ActivityPub json representation of a local community over HTTP.
pub(crate) async fn get_apub_community_http(
  info: web::Path<CommunityQuery>,
  context: web::Data<LemmyContext>,
) -> Result<HttpResponse<Body>, LemmyError> {
  let community: ApubCommunity = blocking(context.pool(), move |conn| {
    Community::read_from_name(conn, &info.community_name)
  })
  .await??
  .into();

  if !community.deleted {
    let apub = community.to_apub(&**context).await?;

    Ok(create_apub_response(&apub))
  } else {
    Ok(create_apub_tombstone_response(&community.to_tombstone()?))
  }
}

#[derive(Clone, Debug, Deserialize, Serialize, ActivityHandler, ActivityFields)]
#[serde(untagged)]
#[activity_handler(LemmyContext)]
pub enum GroupInboxActivities {
  FollowCommunity(FollowCommunity),
  UndoFollowCommunity(UndoFollowCommunity),
  AnnouncableActivities(AnnouncableActivities),
  Report(Report),
}

/// Handler for all incoming receive to community inboxes.
pub async fn community_inbox(
  request: HttpRequest,
  payload: Payload,
  _path: web::Path<String>,
  context: web::Data<LemmyContext>,
) -> Result<HttpResponse, LemmyError> {
  let unparsed = payload_to_string(payload).await?;
  info!("Received community inbox activity {}", unparsed);
  let activity = serde_json::from_str::<WithContext<GroupInboxActivities>>(&unparsed)?;

  receive_group_inbox(activity.inner(), request, &context).await?;

  Ok(HttpResponse::Ok().finish())
}

pub(in crate::http) async fn receive_group_inbox(
  activity: GroupInboxActivities,
  request: HttpRequest,
  context: &LemmyContext,
) -> Result<HttpResponse, LemmyError> {
  let res = receive_activity(request, activity.clone(), context).await;

  if let GroupInboxActivities::AnnouncableActivities(announcable) = activity {
    let community = announcable.get_community(context, &mut 0).await?;
    let actor_id = ObjectId::new(announcable.actor().clone());
    verify_domains_match(&community.actor_id(), announcable.id_unchecked())?;
    verify_person_in_community(&actor_id, &community, context, &mut 0).await?;
    if community.local {
      AnnounceActivity::send(announcable, &community, vec![], context).await?;
    }
  }

  res
}

/// Returns an empty followers collection, only populating the size (for privacy).
pub(crate) async fn get_apub_community_followers(
  info: web::Path<CommunityQuery>,
  context: web::Data<LemmyContext>,
) -> Result<HttpResponse<Body>, LemmyError> {
  let community = blocking(context.pool(), move |conn| {
    Community::read_from_name(conn, &info.community_name)
  })
  .await??;
  let followers = CommunityFollowers::new(community, &context).await?;
  Ok(create_apub_response(&followers))
}

/// Returns the community outbox, which is populated by a maximum of 20 posts (but no other
/// activites like votes or comments).
pub(crate) async fn get_apub_community_outbox(
  info: web::Path<CommunityQuery>,
  context: web::Data<LemmyContext>,
) -> Result<HttpResponse<Body>, LemmyError> {
  let community = blocking(context.pool(), move |conn| {
    Community::read_from_name(conn, &info.community_name)
  })
  .await??;
  let id = ObjectId::new(generate_outbox_url(&community.actor_id)?.into_inner());
  let outbox_data = CommunityContext(community.into(), context.get_ref().clone());
  let outbox: ApubCommunityOutbox = id.dereference(&outbox_data, &mut 0).await?;
  Ok(create_apub_response(&outbox.to_apub(&outbox_data).await?))
}

pub(crate) async fn get_apub_community_moderators(
  info: web::Path<CommunityQuery>,
  context: web::Data<LemmyContext>,
) -> Result<HttpResponse<Body>, LemmyError> {
  let community: ApubCommunity = blocking(context.pool(), move |conn| {
    Community::read_from_name(conn, &info.community_name)
  })
  .await??
  .into();
  let id = ObjectId::new(generate_outbox_url(&community.actor_id)?.into_inner());
  let outbox_data = CommunityContext(community, context.get_ref().clone());
  let moderators: ApubCommunityModerators = id.dereference(&outbox_data, &mut 0).await?;
  Ok(create_apub_response(
    &moderators.to_apub(&outbox_data).await?,
  ))
}
Move object and collection structs to protocol folder 3 years ago			`use actix_web::{body::Body, web, web::Payload, HttpRequest, HttpResponse};`
			`use log::info;`
			`use serde::{Deserialize, Serialize};`

			`use lemmy_api_common::blocking;`
			`use lemmy_apub_lib::{`
			`traits::{ActivityFields, ActivityHandler, ActorType, ApubObject},`
			`verify::verify_domains_match,`
			`};`
			`use lemmy_db_schema::source::community::Community;`
			`use lemmy_utils::LemmyError;`
			`use lemmy_websocket::LemmyContext;`

Merge apub, apub_receive crates (fixes #1621) 3 years ago			`use crate::{`
Rewrite remaining activities (#1712) * Limit type/method visibility in apub code * Simplify db_queries traits by removing generics * Simplify delete activity implementation * Rewrite delete activities * Implement helper functions for websocket message sending * When receiving delete reason as empty string, change to none * Rewrite remaining activities * Simplify inbox * Remove struct ActivityCommonFields, derive ActivityFields trait instead * Community should announce received activities to followers 3 years ago			`activities::{`
When receiving activity, dont read community from cc (for pleroma compat and better verification) 3 years ago			`community::announce::{AnnouncableActivities, AnnounceActivity, GetCommunity},`
Rewrite remaining activities (#1712) * Limit type/method visibility in apub code * Simplify db_queries traits by removing generics * Simplify delete activity implementation * Rewrite delete activities * Implement helper functions for websocket message sending * When receiving delete reason as empty string, change to none * Rewrite remaining activities * Simplify inbox * Remove struct ActivityCommonFields, derive ActivityFields trait instead * Community should announce received activities to followers 3 years ago			`following::{follow::FollowCommunity, undo::UndoFollowCommunity},`
Federate reports (#1830) * Federate reports * add federation test cases for reports 3 years ago			`report::Report,`
When receiving activity, dont read community from cc (for pleroma compat and better verification) 3 years ago			`verify_person_in_community,`
Rewrite remaining activities (#1712) * Limit type/method visibility in apub code * Simplify db_queries traits by removing generics * Simplify delete activity implementation * Rewrite delete activities * Implement helper functions for websocket message sending * When receiving delete reason as empty string, change to none * Rewrite remaining activities * Simplify inbox * Remove struct ActivityCommonFields, derive ActivityFields trait instead * Community should announce received activities to followers 3 years ago			`},`
Rewrite collections to use new fetcher (#1861) * Merge traits ToApub and FromApub into ApubObject * Rewrite community outbox to use new fetcher * Rewrite community moderators collection * Rewrite tombstone 3 years ago			`collections::{`
Rewrite community outbox to use new fetcher 3 years ago			`community_moderators::ApubCommunityModerators,`
			`community_outbox::ApubCommunityOutbox,`
Rewrite collections to use new fetcher (#1861) * Merge traits ToApub and FromApub into ApubObject * Rewrite community outbox to use new fetcher * Rewrite community moderators collection * Rewrite tombstone 3 years ago			`CommunityContext,`
			`},`
Move @context out of object/activity definitions 3 years ago			`context::WithContext,`
Rewrite collections to use new fetcher (#1861) * Merge traits ToApub and FromApub into ApubObject * Rewrite community outbox to use new fetcher * Rewrite community moderators collection * Rewrite tombstone 3 years ago			`fetcher::object_id::ObjectId,`
Move code to apub library (#1795) * Remove dependency of apub_lib on LemmyContext * Move ApubObject trait to library * Reorganize files in apub lib * Move ActorType, signatures, activity_queue to apub library 3 years ago			`generate_outbox_url,`
Merge apub, apub_receive crates (fixes #1621) 3 years ago			`http::{`
Rewrite community outbox to use new fetcher 3 years ago			`create_apub_response,`
			`create_apub_tombstone_response,`
			`payload_to_string,`
			`receive_activity,`
Merge apub, apub_receive crates (fixes #1621) 3 years ago			`},`
Major refactor, adding newtypes for apub crate - this allows moving FromApub/ToApub traits into apub lib 3 years ago			`objects::community::ApubCommunity,`
Move object and collection structs to protocol folder 3 years ago			`protocol::collections::group_followers::CommunityFollowers,`
Apub inbox rewrite (#1652) * start to implement apub inbox routing lib * got something that almost works * it compiles! * implemented some more * move library code to separate crate (most of it) * convert private message handlers * convert all comment receivers (except undo comment) * convert post receiver * add verify trait * convert community receivers * add cc field for all activities which i forgot before * convert inbox functions, add missing checks * convert undo like/dislike receivers * convert undo_delete and undo_remove receivers * move block/unblock activities * convert remaining activity receivers * reimplement http signature verification and other checks * also use actor type for routing, VerifyActivity and SendActivity traits * cleanup and restructure apub_receive code * wip: try to fix activity routing * implement a (very bad) derive macro for activityhandler * working activity routing! * rework pm verify(), fix tests and confirm manually also remove inbox username check which was broken * rework following verify(), fix tests and test manually * fix post/comment create/update, rework voting * Rewrite remove/delete post/comment, fix tests, test manually * Rework and fix (un)block user, announce, update post * some code cleanup * rework delete/remove activity receivers (still quite messy) * rewrite, test and fix add/remove mod, update community handlers * add docs for ActivityHandler derive macro * dont try to compile macro comments 3 years ago			`};`
Refactor apub code, split up large files 4 years ago
			`#[derive(Deserialize)]`
Move moderators collection to separate HTTP endpoint 3 years ago			`pub(crate) struct CommunityQuery {`
Refactor apub code, split up large files 4 years ago			`community_name: String,`
			`}`

Create rustdoc for activitypub code 4 years ago			`/// Return the ActivityPub json representation of a local community over HTTP.`
Move moderators collection to separate HTTP endpoint 3 years ago			`pub(crate) async fn get_apub_community_http(`
Refactor apub code, split up large files 4 years ago			`info: web::Path<CommunityQuery>,`
			`context: web::Data<LemmyContext>,`
			`) -> Result<HttpResponse<Body>, LemmyError> {`
Major refactor, adding newtypes for apub crate - this allows moving FromApub/ToApub traits into apub lib 3 years ago			`let community: ApubCommunity = blocking(context.pool(), move \|conn\| {`
Refactor apub code, split up large files 4 years ago			`Community::read_from_name(conn, &info.community_name)`
			`})`
Major refactor, adding newtypes for apub crate - this allows moving FromApub/ToApub traits into apub lib 3 years ago			`.await??`
			`.into();`
Refactor apub code, split up large files 4 years ago
			`if !community.deleted {`
Rewrite collections to use new fetcher (#1861) * Merge traits ToApub and FromApub into ApubObject * Rewrite community outbox to use new fetcher * Rewrite community moderators collection * Rewrite tombstone 3 years ago			`let apub = community.to_apub(&**context).await?;`
Refactor apub code, split up large files 4 years ago
			`Ok(create_apub_response(&apub))`
			`} else {`
			`Ok(create_apub_tombstone_response(&community.to_tombstone()?))`
			`}`
			`}`

Rewrite remaining activities (#1712) * Limit type/method visibility in apub code * Simplify db_queries traits by removing generics * Simplify delete activity implementation * Rewrite delete activities * Implement helper functions for websocket message sending * When receiving delete reason as empty string, change to none * Rewrite remaining activities * Simplify inbox * Remove struct ActivityCommonFields, derive ActivityFields trait instead * Community should announce received activities to followers 3 years ago			`#[derive(Clone, Debug, Deserialize, Serialize, ActivityHandler, ActivityFields)]`
			`#[serde(untagged)]`
Move code to apub library (#1795) * Remove dependency of apub_lib on LemmyContext * Move ApubObject trait to library * Reorganize files in apub lib * Move ActorType, signatures, activity_queue to apub library 3 years ago			`#[activity_handler(LemmyContext)]`
Rewrite remaining activities (#1712) * Limit type/method visibility in apub code * Simplify db_queries traits by removing generics * Simplify delete activity implementation * Rewrite delete activities * Implement helper functions for websocket message sending * When receiving delete reason as empty string, change to none * Rewrite remaining activities * Simplify inbox * Remove struct ActivityCommonFields, derive ActivityFields trait instead * Community should announce received activities to followers 3 years ago			`pub enum GroupInboxActivities {`
			`FollowCommunity(FollowCommunity),`
			`UndoFollowCommunity(UndoFollowCommunity),`
			`AnnouncableActivities(AnnouncableActivities),`
Federate reports (#1830) * Federate reports * add federation test cases for reports 3 years ago			`Report(Report),`
Rewrite remaining activities (#1712) * Limit type/method visibility in apub code * Simplify db_queries traits by removing generics * Simplify delete activity implementation * Rewrite delete activities * Implement helper functions for websocket message sending * When receiving delete reason as empty string, change to none * Rewrite remaining activities * Simplify inbox * Remove struct ActivityCommonFields, derive ActivityFields trait instead * Community should announce received activities to followers 3 years ago			`}`

Apub inbox rewrite (#1652) * start to implement apub inbox routing lib * got something that almost works * it compiles! * implemented some more * move library code to separate crate (most of it) * convert private message handlers * convert all comment receivers (except undo comment) * convert post receiver * add verify trait * convert community receivers * add cc field for all activities which i forgot before * convert inbox functions, add missing checks * convert undo like/dislike receivers * convert undo_delete and undo_remove receivers * move block/unblock activities * convert remaining activity receivers * reimplement http signature verification and other checks * also use actor type for routing, VerifyActivity and SendActivity traits * cleanup and restructure apub_receive code * wip: try to fix activity routing * implement a (very bad) derive macro for activityhandler * working activity routing! * rework pm verify(), fix tests and confirm manually also remove inbox username check which was broken * rework following verify(), fix tests and test manually * fix post/comment create/update, rework voting * Rewrite remove/delete post/comment, fix tests, test manually * Rework and fix (un)block user, announce, update post * some code cleanup * rework delete/remove activity receivers (still quite messy) * rewrite, test and fix add/remove mod, update community handlers * add docs for ActivityHandler derive macro * dont try to compile macro comments 3 years ago			`/// Handler for all incoming receive to community inboxes.`
			`pub async fn community_inbox(`
			`request: HttpRequest,`
			`payload: Payload,`
			`_path: web::Path<String>,`
			`context: web::Data<LemmyContext>,`
			`) -> Result<HttpResponse, LemmyError> {`
			`let unparsed = payload_to_string(payload).await?;`
Activity.to should always be a vec (and unspecified size for public activities) 3 years ago			`info!("Received community inbox activity {}", unparsed);`
Move @context out of object/activity definitions 3 years ago			`let activity = serde_json::from_str::<WithContext<GroupInboxActivities>>(&unparsed)?;`
Rewrite remaining activities (#1712) * Limit type/method visibility in apub code * Simplify db_queries traits by removing generics * Simplify delete activity implementation * Rewrite delete activities * Implement helper functions for websocket message sending * When receiving delete reason as empty string, change to none * Rewrite remaining activities * Simplify inbox * Remove struct ActivityCommonFields, derive ActivityFields trait instead * Community should announce received activities to followers 3 years ago
Move @context out of object/activity definitions 3 years ago			`receive_group_inbox(activity.inner(), request, &context).await?;`
Rewrite remaining activities (#1712) * Limit type/method visibility in apub code * Simplify db_queries traits by removing generics * Simplify delete activity implementation * Rewrite delete activities * Implement helper functions for websocket message sending * When receiving delete reason as empty string, change to none * Rewrite remaining activities * Simplify inbox * Remove struct ActivityCommonFields, derive ActivityFields trait instead * Community should announce received activities to followers 3 years ago
			`Ok(HttpResponse::Ok().finish())`
			`}`

			`pub(in crate::http) async fn receive_group_inbox(`
			`activity: GroupInboxActivities,`
			`request: HttpRequest,`
			`context: &LemmyContext,`
			`) -> Result<HttpResponse, LemmyError> {`
Three instance inbox bug (#1866) * 3 instance shared inbox bug test * Fixing shared inbox bug. Fixes #1865 * A few fixes. 3 years ago			`let res = receive_activity(request, activity.clone(), context).await;`
When receiving activity, dont read community from cc (for pleroma compat and better verification) 3 years ago
			`if let GroupInboxActivities::AnnouncableActivities(announcable) = activity {`
			`let community = announcable.get_community(context, &mut 0).await?;`
			`let actor_id = ObjectId::new(announcable.actor().clone());`
			`verify_domains_match(&community.actor_id(), announcable.id_unchecked())?;`
			`verify_person_in_community(&actor_id, &community, context, &mut 0).await?;`
Three instance inbox bug (#1866) * 3 instance shared inbox bug test * Fixing shared inbox bug. Fixes #1865 * A few fixes. 3 years ago			`if community.local {`
			`AnnounceActivity::send(announcable, &community, vec![], context).await?;`
			`}`
			`}`
When receiving activity, dont read community from cc (for pleroma compat and better verification) 3 years ago
Three instance inbox bug (#1866) * 3 instance shared inbox bug test * Fixing shared inbox bug. Fixes #1865 * A few fixes. 3 years ago			`res`
Apub inbox rewrite (#1652) * start to implement apub inbox routing lib * got something that almost works * it compiles! * implemented some more * move library code to separate crate (most of it) * convert private message handlers * convert all comment receivers (except undo comment) * convert post receiver * add verify trait * convert community receivers * add cc field for all activities which i forgot before * convert inbox functions, add missing checks * convert undo like/dislike receivers * convert undo_delete and undo_remove receivers * move block/unblock activities * convert remaining activity receivers * reimplement http signature verification and other checks * also use actor type for routing, VerifyActivity and SendActivity traits * cleanup and restructure apub_receive code * wip: try to fix activity routing * implement a (very bad) derive macro for activityhandler * working activity routing! * rework pm verify(), fix tests and confirm manually also remove inbox username check which was broken * rework following verify(), fix tests and test manually * fix post/comment create/update, rework voting * Rewrite remove/delete post/comment, fix tests, test manually * Rework and fix (un)block user, announce, update post * some code cleanup * rework delete/remove activity receivers (still quite messy) * rewrite, test and fix add/remove mod, update community handlers * add docs for ActivityHandler derive macro * dont try to compile macro comments 3 years ago			`}`

Refactor apub code, split up large files 4 years ago			`/// Returns an empty followers collection, only populating the size (for privacy).`
Move moderators collection to separate HTTP endpoint 3 years ago			`pub(crate) async fn get_apub_community_followers(`
Refactor apub code, split up large files 4 years ago			`info: web::Path<CommunityQuery>,`
			`context: web::Data<LemmyContext>,`
			`) -> Result<HttpResponse<Body>, LemmyError> {`
			`let community = blocking(context.pool(), move \|conn\| {`
Running clippy --fix (#1647) 3 years ago			`Community::read_from_name(conn, &info.community_name)`
Refactor apub code, split up large files 4 years ago			`})`
			`.await??;`
Rewrite community followers and user outbox to use our own structs 3 years ago			`let followers = CommunityFollowers::new(community, &context).await?;`
			`Ok(create_apub_response(&followers))`
Refactor apub code, split up large files 4 years ago			`}`

Create rustdoc for activitypub code 4 years ago			`/// Returns the community outbox, which is populated by a maximum of 20 posts (but no other`
			`/// activites like votes or comments).`
Move moderators collection to separate HTTP endpoint 3 years ago			`pub(crate) async fn get_apub_community_outbox(`
Refactor apub code, split up large files 4 years ago			`info: web::Path<CommunityQuery>,`
			`context: web::Data<LemmyContext>,`
			`) -> Result<HttpResponse<Body>, LemmyError> {`
			`let community = blocking(context.pool(), move \|conn\| {`
Running clippy --fix (#1647) 3 years ago			`Community::read_from_name(conn, &info.community_name)`
Refactor apub code, split up large files 4 years ago			`})`
			`.await??;`
Rewrite collections to use new fetcher (#1861) * Merge traits ToApub and FromApub into ApubObject * Rewrite community outbox to use new fetcher * Rewrite community moderators collection * Rewrite tombstone 3 years ago			`let id = ObjectId::new(generate_outbox_url(&community.actor_id)?.into_inner());`
			`let outbox_data = CommunityContext(community.into(), context.get_ref().clone());`
			`let outbox: ApubCommunityOutbox = id.dereference(&outbox_data, &mut 0).await?;`
			`Ok(create_apub_response(&outbox.to_apub(&outbox_data).await?))`
Move moderators collection to separate HTTP endpoint 3 years ago			`}`

			`pub(crate) async fn get_apub_community_moderators(`
Create empty inbox collections for actors (ref #1322) 4 years ago			`info: web::Path<CommunityQuery>,`
			`context: web::Data<LemmyContext>,`
			`) -> Result<HttpResponse<Body>, LemmyError> {`
Major refactor, adding newtypes for apub crate - this allows moving FromApub/ToApub traits into apub lib 3 years ago			`let community: ApubCommunity = blocking(context.pool(), move \|conn\| {`
Running clippy --fix (#1647) 3 years ago			`Community::read_from_name(conn, &info.community_name)`
Create empty inbox collections for actors (ref #1322) 4 years ago			`})`
Major refactor, adding newtypes for apub crate - this allows moving FromApub/ToApub traits into apub lib 3 years ago			`.await??`
			`.into();`
Rewrite collections to use new fetcher (#1861) * Merge traits ToApub and FromApub into ApubObject * Rewrite community outbox to use new fetcher * Rewrite community moderators collection * Rewrite tombstone 3 years ago			`let id = ObjectId::new(generate_outbox_url(&community.actor_id)?.into_inner());`
			`let outbox_data = CommunityContext(community, context.get_ref().clone());`
			`let moderators: ApubCommunityModerators = id.dereference(&outbox_data, &mut 0).await?;`
			`Ok(create_apub_response(`
			`&moderators.to_apub(&outbox_data).await?,`
			`))`
Create empty inbox collections for actors (ref #1322) 4 years ago			`}`