2 check_is_apub_id_valid,
4 community_moderators::ApubCommunityModerators,
5 community_outbox::ApubCommunityOutbox,
8 context::lemmy_context,
9 fetcher::object_id::ObjectId,
10 generate_moderators_url,
12 objects::{get_summary_from_string_or_source, tombstone::Tombstone, ImageObject, Source},
14 use activitystreams::{
15 actor::{kind::GroupType, Endpoints},
17 chrono::NaiveDateTime,
18 object::kind::ImageType,
19 primitives::OneOrMany,
22 use chrono::{DateTime, FixedOffset};
23 use itertools::Itertools;
24 use lemmy_api_common::blocking;
26 signatures::PublicKey,
27 traits::{ActorType, ApubObject},
28 values::MediaTypeMarkdown,
29 verify::verify_domains_match,
31 use lemmy_db_schema::{
33 source::community::{Community, CommunityForm},
36 use lemmy_db_views_actor::community_follower_view::CommunityFollowerView;
38 settings::structs::Settings,
39 utils::{check_slurs, check_slurs_opt, convert_datetime, markdown_to_html},
42 use lemmy_websocket::LemmyContext;
44 use serde::{Deserialize, Serialize};
45 use serde_with::skip_serializing_none;
49 #[skip_serializing_none]
50 #[derive(Clone, Debug, Deserialize, Serialize)]
51 #[serde(rename_all = "camelCase")]
53 #[serde(rename = "@context")]
54 context: OneOrMany<AnyBase>,
55 #[serde(rename = "type")]
58 /// username, set at account creation and can never be changed
59 preferred_username: String,
60 /// title (can be changed at any time)
62 summary: Option<String>,
63 source: Option<Source>,
64 icon: Option<ImageObject>,
66 image: Option<ImageObject>,
68 sensitive: Option<bool>,
70 pub(crate) moderators: Option<ObjectId<ApubCommunityModerators>>,
72 pub(crate) outbox: ObjectId<ApubCommunityOutbox>,
74 endpoints: Endpoints<Url>,
75 public_key: PublicKey,
76 published: Option<DateTime<FixedOffset>>,
77 updated: Option<DateTime<FixedOffset>>,
83 pub(crate) async fn from_apub_to_form(
85 expected_domain: &Url,
87 ) -> Result<CommunityForm, LemmyError> {
88 verify_domains_match(expected_domain, &group.id)?;
89 let name = group.preferred_username.clone();
90 let title = group.name.clone();
91 let description = get_summary_from_string_or_source(&group.summary, &group.source);
92 let shared_inbox = group.endpoints.shared_inbox.clone().map(|s| s.into());
94 let slur_regex = &settings.slur_regex();
95 check_slurs(&name, slur_regex)?;
96 check_slurs(&title, slur_regex)?;
97 check_slurs_opt(&description, slur_regex)?;
104 published: group.published.map(|u| u.naive_local()),
105 updated: group.updated.map(|u| u.naive_local()),
107 nsfw: Some(group.sensitive.unwrap_or(false)),
108 actor_id: Some(group.id.clone().into()),
111 public_key: Some(group.public_key.public_key_pem.clone()),
112 last_refreshed_at: Some(naive_now()),
113 icon: Some(group.icon.clone().map(|i| i.url.into())),
114 banner: Some(group.image.clone().map(|i| i.url.into())),
115 followers_url: Some(group.followers.clone().into()),
116 inbox_url: Some(group.inbox.clone().into()),
117 shared_inbox_url: Some(shared_inbox),
122 #[derive(Clone, Debug)]
123 pub struct ApubCommunity(Community);
125 impl Deref for ApubCommunity {
126 type Target = Community;
127 fn deref(&self) -> &Self::Target {
132 impl From<Community> for ApubCommunity {
133 fn from(c: Community) -> Self {
134 ApubCommunity { 0: c }
138 #[async_trait::async_trait(?Send)]
139 impl ApubObject for ApubCommunity {
140 type DataType = LemmyContext;
141 type ApubType = Group;
142 type TombstoneType = Tombstone;
144 fn last_refreshed_at(&self) -> Option<NaiveDateTime> {
145 Some(self.last_refreshed_at)
148 async fn read_from_apub_id(
150 context: &LemmyContext,
151 ) -> Result<Option<Self>, LemmyError> {
153 blocking(context.pool(), move |conn| {
154 Community::read_from_apub_id(conn, object_id)
161 async fn delete(self, context: &LemmyContext) -> Result<(), LemmyError> {
162 blocking(context.pool(), move |conn| {
163 Community::update_deleted(conn, self.id, true)
169 async fn to_apub(&self, _context: &LemmyContext) -> Result<Group, LemmyError> {
170 let source = self.description.clone().map(|bio| Source {
172 media_type: MediaTypeMarkdown::Markdown,
174 let icon = self.icon.clone().map(|url| ImageObject {
175 kind: ImageType::Image,
178 let image = self.banner.clone().map(|url| ImageObject {
179 kind: ImageType::Image,
184 context: lemmy_context(),
185 kind: GroupType::Group,
187 preferred_username: self.name.clone(),
188 name: self.title.clone(),
189 summary: self.description.as_ref().map(|b| markdown_to_html(b)),
193 sensitive: Some(self.nsfw),
194 moderators: Some(ObjectId::<ApubCommunityModerators>::new(
195 generate_moderators_url(&self.actor_id)?.into_inner(),
197 inbox: self.inbox_url.clone().into(),
198 outbox: ObjectId::new(generate_outbox_url(&self.actor_id)?),
199 followers: self.followers_url.clone().into(),
200 endpoints: Endpoints {
201 shared_inbox: self.shared_inbox_url.clone().map(|s| s.into()),
204 public_key: self.get_public_key()?,
205 published: Some(convert_datetime(self.published)),
206 updated: self.updated.map(convert_datetime),
207 unparsed: Default::default(),
212 fn to_tombstone(&self) -> Result<Tombstone, LemmyError> {
215 self.updated.unwrap_or(self.published),
219 /// Converts a `Group` to `Community`, inserts it into the database and updates moderators.
222 context: &LemmyContext,
223 expected_domain: &Url,
224 request_counter: &mut i32,
225 ) -> Result<ApubCommunity, LemmyError> {
226 let form = Group::from_apub_to_form(group, expected_domain, &context.settings()).await?;
228 // Fetching mods and outbox is not necessary for Lemmy to work, so ignore errors. Besides,
229 // we need to ignore these errors so that tests can work entirely offline.
230 let community: ApubCommunity =
231 blocking(context.pool(), move |conn| Community::upsert(conn, &form))
234 let outbox_data = CommunityContext(community.clone(), context.clone());
238 .dereference(&outbox_data, request_counter)
240 .map_err(|e| debug!("{}", e))
243 if let Some(moderators) = &group.moderators {
245 .dereference(&outbox_data, request_counter)
247 .map_err(|e| debug!("{}", e))
255 impl ActorType for ApubCommunity {
256 fn is_local(&self) -> bool {
259 fn actor_id(&self) -> Url {
260 self.actor_id.to_owned().into()
262 fn name(&self) -> String {
265 fn public_key(&self) -> Option<String> {
266 self.public_key.to_owned()
268 fn private_key(&self) -> Option<String> {
269 self.private_key.to_owned()
272 fn inbox_url(&self) -> Url {
273 self.inbox_url.clone().into()
276 fn shared_inbox_url(&self) -> Option<Url> {
277 self.shared_inbox_url.clone().map(|s| s.into_inner())
282 /// For a given community, returns the inboxes of all followers.
283 pub(crate) async fn get_follower_inboxes(
287 ) -> Result<Vec<Url>, LemmyError> {
290 let follows = blocking(pool, move |conn| {
291 CommunityFollowerView::for_community(conn, id)
294 let inboxes = follows
296 .filter(|f| !f.follower.local)
297 .map(|f| f.follower.shared_inbox_url.unwrap_or(f.follower.inbox_url))
298 .map(|i| i.into_inner())
300 // Don't send to blocked instances
301 .filter(|inbox| check_is_apub_id_valid(inbox, false, settings).is_ok())
311 use crate::objects::tests::{file_to_json_object, init_context};
312 use assert_json_diff::assert_json_include;
313 use lemmy_db_schema::traits::Crud;
314 use serial_test::serial;
318 async fn test_parse_lemmy_community() {
319 let context = init_context();
320 let mut json: Group = file_to_json_object("assets/lemmy-community.json");
321 let json_orig = json.clone();
322 // change these links so they dont fetch over the network
323 json.moderators = Some(ObjectId::new(
324 Url::parse("https://enterprise.lemmy.ml/c/tenforward/not_moderators").unwrap(),
327 ObjectId::new(Url::parse("https://enterprise.lemmy.ml/c/tenforward/not_outbox").unwrap());
329 let url = Url::parse("https://enterprise.lemmy.ml/c/tenforward").unwrap();
330 let mut request_counter = 0;
331 let community = ApubCommunity::from_apub(&json, &context, &url, &mut request_counter)
335 assert_eq!(community.actor_id.clone().into_inner(), url);
336 assert_eq!(community.title, "Ten Forward");
337 assert!(community.public_key.is_some());
338 assert!(!community.local);
339 assert_eq!(community.description.as_ref().unwrap().len(), 132);
340 // this makes two requests to the (intentionally) broken outbox/moderators collections
341 assert_eq!(request_counter, 2);
343 let to_apub = community.to_apub(&context).await.unwrap();
344 assert_json_include!(actual: json_orig, expected: to_apub);
346 Community::delete(&*context.pool().get().unwrap(), community.id).unwrap();