2 check_is_apub_id_valid,
3 collections::{community_moderators::ApubCommunityModerators, CommunityContext},
4 generate_moderators_url,
6 objects::instance::fetch_instance_actor_for_object,
8 objects::{group::Group, tombstone::Tombstone, Endpoints},
13 use activitystreams_kinds::actor::GroupType;
14 use chrono::NaiveDateTime;
15 use itertools::Itertools;
16 use lemmy_api_common::blocking;
19 traits::{ActorType, ApubObject},
21 use lemmy_db_schema::{source::community::Community, traits::ApubActor};
22 use lemmy_db_views_actor::community_follower_view::CommunityFollowerView;
24 utils::{convert_datetime, markdown_to_html},
27 use lemmy_websocket::LemmyContext;
32 #[derive(Clone, Debug)]
33 pub struct ApubCommunity(Community);
35 impl Deref for ApubCommunity {
36 type Target = Community;
37 fn deref(&self) -> &Self::Target {
42 impl From<Community> for ApubCommunity {
43 fn from(c: Community) -> Self {
44 ApubCommunity { 0: c }
48 #[async_trait::async_trait(?Send)]
49 impl ApubObject for ApubCommunity {
50 type DataType = LemmyContext;
51 type ApubType = Group;
52 type TombstoneType = Tombstone;
54 fn last_refreshed_at(&self) -> Option<NaiveDateTime> {
55 Some(self.last_refreshed_at)
58 #[tracing::instrument(skip_all)]
59 async fn read_from_apub_id(
61 context: &LemmyContext,
62 ) -> Result<Option<Self>, LemmyError> {
64 blocking(context.pool(), move |conn| {
65 Community::read_from_apub_id(conn, object_id)
72 #[tracing::instrument(skip_all)]
73 async fn delete(self, context: &LemmyContext) -> Result<(), LemmyError> {
74 blocking(context.pool(), move |conn| {
75 Community::update_deleted(conn, self.id, true)
81 #[tracing::instrument(skip_all)]
82 async fn into_apub(self, _context: &LemmyContext) -> Result<Group, LemmyError> {
84 kind: GroupType::Group,
85 id: ObjectId::new(self.actor_id()),
86 preferred_username: self.name.clone(),
87 name: self.title.clone(),
88 summary: self.description.as_ref().map(|b| markdown_to_html(b)),
89 source: self.description.clone().map(Source::new),
90 icon: self.icon.clone().map(ImageObject::new),
91 image: self.banner.clone().map(ImageObject::new),
92 sensitive: Some(self.nsfw),
93 moderators: Some(ObjectId::<ApubCommunityModerators>::new(
94 generate_moderators_url(&self.actor_id)?,
96 inbox: self.inbox_url.clone().into(),
97 outbox: ObjectId::new(generate_outbox_url(&self.actor_id)?),
98 followers: self.followers_url.clone().into(),
99 endpoints: self.shared_inbox_url.clone().map(|s| Endpoints {
100 shared_inbox: s.into(),
102 public_key: self.get_public_key()?,
103 published: Some(convert_datetime(self.published)),
104 updated: self.updated.map(convert_datetime),
109 fn to_tombstone(&self) -> Result<Tombstone, LemmyError> {
110 Ok(Tombstone::new(self.actor_id()))
113 #[tracing::instrument(skip_all)]
116 expected_domain: &Url,
117 context: &LemmyContext,
118 _request_counter: &mut i32,
119 ) -> Result<(), LemmyError> {
120 group.verify(expected_domain, context).await
123 /// Converts a `Group` to `Community`, inserts it into the database and updates moderators.
124 #[tracing::instrument(skip_all)]
127 context: &LemmyContext,
128 request_counter: &mut i32,
129 ) -> Result<ApubCommunity, LemmyError> {
130 let form = Group::into_form(group.clone());
132 // Fetching mods and outbox is not necessary for Lemmy to work, so ignore errors. Besides,
133 // we need to ignore these errors so that tests can work entirely offline.
134 let community: ApubCommunity =
135 blocking(context.pool(), move |conn| Community::upsert(conn, &form))
138 let outbox_data = CommunityContext(community.clone(), context.clone());
142 .dereference(&outbox_data, context.client(), request_counter)
144 .map_err(|e| debug!("{}", e))
147 if let Some(moderators) = &group.moderators {
149 .dereference(&outbox_data, context.client(), request_counter)
151 .map_err(|e| debug!("{}", e))
155 fetch_instance_actor_for_object(community.actor_id(), context, request_counter).await;
161 impl ActorType for ApubCommunity {
162 fn actor_id(&self) -> Url {
163 self.actor_id.to_owned().into()
165 fn public_key(&self) -> String {
166 self.public_key.to_owned()
168 fn private_key(&self) -> Option<String> {
169 self.private_key.to_owned()
172 fn inbox_url(&self) -> Url {
173 self.inbox_url.clone().into()
176 fn shared_inbox_url(&self) -> Option<Url> {
177 self.shared_inbox_url.clone().map(|s| s.into())
182 /// For a given community, returns the inboxes of all followers.
183 #[tracing::instrument(skip_all)]
184 pub(crate) async fn get_follower_inboxes(
186 context: &LemmyContext,
187 ) -> Result<Vec<Url>, LemmyError> {
190 let follows = blocking(context.pool(), move |conn| {
191 CommunityFollowerView::for_community(conn, id)
194 let inboxes: Vec<Url> = follows
196 .filter(|f| !f.follower.local)
200 .unwrap_or(f.follower.inbox_url)
204 .filter(|inbox: &Url| inbox.host_str() != Some(&context.settings().hostname))
205 // Don't send to blocked instances
206 .filter(|inbox| check_is_apub_id_valid(inbox, false, &context.settings()).is_ok())
214 pub(crate) mod tests {
217 objects::{instance::tests::parse_lemmy_instance, tests::init_context},
218 protocol::tests::file_to_json_object,
220 use lemmy_apub_lib::activity_queue::create_activity_queue;
221 use lemmy_db_schema::{source::site::Site, traits::Crud};
222 use serial_test::serial;
224 pub(crate) async fn parse_lemmy_community(context: &LemmyContext) -> ApubCommunity {
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.moderators = None;
229 ObjectId::new(Url::parse("https://enterprise.lemmy.ml/c/tenforward/not_outbox").unwrap());
231 let url = Url::parse("https://enterprise.lemmy.ml/c/tenforward").unwrap();
232 let mut request_counter = 0;
233 ApubCommunity::verify(&json, &url, context, &mut request_counter)
236 let community = ApubCommunity::from_apub(json, context, &mut request_counter)
239 // this makes one requests to the (intentionally broken) outbox collection
240 assert_eq!(request_counter, 1);
246 async fn test_parse_lemmy_community() {
247 let client = reqwest::Client::new().into();
248 let manager = create_activity_queue(client);
249 let context = init_context(manager.queue_handle().clone());
250 let site = parse_lemmy_instance(&context).await;
251 let community = parse_lemmy_community(&context).await;
253 assert_eq!(community.title, "Ten Forward");
254 assert!(!community.local);
255 assert_eq!(community.description.as_ref().unwrap().len(), 132);
257 Community::delete(&*context.pool().get().unwrap(), community.id).unwrap();
258 Site::delete(&*context.pool().get().unwrap(), site.id).unwrap();