2 extern crate lazy_static;
5 pub mod activity_queue;
12 group_extension::GroupExtension,
13 page_extension::PageExtension,
14 person_extension::PersonExtension,
15 signatures::{PublicKey, PublicKeyExtension},
17 fetcher::community::get_or_fetch_and_upsert_community,
19 use activitystreams::{
23 object::{ApObject, AsObject, Note, ObjectExt, Page},
25 use activitystreams_ext::{Ext1, Ext2};
26 use anyhow::{anyhow, Context};
28 use lemmy_api_common::blocking;
29 use lemmy_db_queries::{source::activity::Activity_, ApubObject, DbPool};
30 use lemmy_db_schema::{
35 person::{Person as DbPerson, Person},
37 private_message::PrivateMessage,
42 use lemmy_db_views_actor::community_person_ban_view::CommunityPersonBanView;
43 use lemmy_utils::{location_info, settings::structs::Settings, LemmyError};
44 use lemmy_websocket::LemmyContext;
47 use url::{ParseError, Url};
49 /// Activitystreams type for community
51 Ext2<actor::ApActor<ApObject<actor::Group>>, GroupExtension, PublicKeyExtension>;
52 /// Activitystreams type for person
54 Ext2<actor::ApActor<ApObject<actor::Actor<UserTypes>>>, PersonExtension, PublicKeyExtension>;
55 /// Activitystreams type for post
56 pub type PageExt = Ext1<ApObject<Page>, PageExtension>;
57 pub type NoteExt = ApObject<Note>;
59 #[derive(Clone, Copy, Debug, serde::Deserialize, serde::Serialize, PartialEq)]
65 pub static APUB_JSON_CONTENT_TYPE: &str = "application/activity+json";
67 /// Checks if the ID is allowed for sending or receiving.
69 /// In particular, it checks for:
70 /// - federation being enabled (if its disabled, only local URLs are allowed)
71 /// - the correct scheme (either http or https)
72 /// - URL being in the allowlist (if it is active)
73 /// - URL not being in the blocklist (if it is active)
75 pub fn check_is_apub_id_valid(apub_id: &Url, use_strict_allowlist: bool) -> Result<(), LemmyError> {
76 let settings = Settings::get();
77 let domain = apub_id.domain().context(location_info!())?.to_string();
78 let local_instance = settings.get_hostname_without_port()?;
80 if !settings.federation().enabled {
81 return if domain == local_instance {
86 "Trying to connect with {}, but federation is disabled",
94 let host = apub_id.host_str().context(location_info!())?;
95 let host_as_ip = host.parse::<IpAddr>();
96 if host == "localhost" || host_as_ip.is_ok() {
97 return Err(anyhow!("invalid hostname {}: {}", host, apub_id).into());
100 if apub_id.scheme() != Settings::get().get_protocol_string() {
101 return Err(anyhow!("invalid apub id scheme {}: {}", apub_id.scheme(), apub_id).into());
104 // TODO: might be good to put the part above in one method, and below in another
105 // (which only gets called in apub::objects)
106 // -> no that doesnt make sense, we still need the code below for blocklist and strict allowlist
107 if let Some(blocked) = Settings::get().get_blocked_instances() {
108 if blocked.contains(&domain) {
109 return Err(anyhow!("{} is in federation blocklist", domain).into());
113 if let Some(mut allowed) = Settings::get().get_allowed_instances() {
114 // Only check allowlist if this is a community, or strict allowlist is enabled.
115 let strict_allowlist = Settings::get()
119 if use_strict_allowlist || strict_allowlist {
120 // need to allow this explicitly because apub receive might contain objects from our local
122 allowed.push(local_instance);
124 if !allowed.contains(&domain) {
125 return Err(anyhow!("{} not in federation allowlist", domain).into());
133 /// Common functions for ActivityPub objects, which are implemented by most (but not all) objects
134 /// and actors in Lemmy.
135 #[async_trait::async_trait(?Send)]
136 pub trait ApubObjectType {
137 async fn send_create(&self, creator: &DbPerson, context: &LemmyContext)
138 -> Result<(), LemmyError>;
139 async fn send_update(&self, creator: &DbPerson, context: &LemmyContext)
140 -> Result<(), LemmyError>;
141 async fn send_delete(&self, creator: &DbPerson, context: &LemmyContext)
142 -> Result<(), LemmyError>;
143 async fn send_undo_delete(
146 context: &LemmyContext,
147 ) -> Result<(), LemmyError>;
148 async fn send_remove(&self, mod_: &DbPerson, context: &LemmyContext) -> Result<(), LemmyError>;
149 async fn send_undo_remove(
152 context: &LemmyContext,
153 ) -> Result<(), LemmyError>;
156 #[async_trait::async_trait(?Send)]
157 pub trait ApubLikeableType {
158 async fn send_like(&self, creator: &DbPerson, context: &LemmyContext) -> Result<(), LemmyError>;
159 async fn send_dislike(
162 context: &LemmyContext,
163 ) -> Result<(), LemmyError>;
164 async fn send_undo_like(
167 context: &LemmyContext,
168 ) -> Result<(), LemmyError>;
171 /// Common methods provided by ActivityPub actors (community and person). Not all methods are
172 /// implemented by all actors.
173 #[async_trait::async_trait(?Send)]
174 pub trait ActorType {
175 fn is_local(&self) -> bool;
176 fn actor_id(&self) -> Url;
178 // TODO: every actor should have a public key, so this shouldnt be an option (needs to be fixed in db)
179 fn public_key(&self) -> Option<String>;
180 fn private_key(&self) -> Option<String>;
182 fn get_shared_inbox_or_inbox_url(&self) -> Url;
184 /// Outbox URL is not generally used by Lemmy, so it can be generated on the fly (but only for
186 fn get_outbox_url(&self) -> Result<Url, LemmyError> {
188 if !self.is_local() {
189 return Err(anyhow!("get_outbox_url() called for remote actor").into());
192 Ok(Url::parse(&format!("{}/outbox", &self.actor_id()))?)
195 fn get_public_key_ext(&self) -> Result<PublicKeyExtension, LemmyError> {
198 id: format!("{}#main-key", self.actor_id()),
199 owner: self.actor_id(),
200 public_key_pem: self.public_key().context(location_info!())?,
207 #[async_trait::async_trait(?Send)]
208 pub trait CommunityType {
209 fn followers_url(&self) -> Url;
210 async fn get_follower_inboxes(&self, pool: &DbPool) -> Result<Vec<Url>, LemmyError>;
211 async fn send_accept_follow(
214 context: &LemmyContext,
215 ) -> Result<(), LemmyError>;
217 async fn send_update(&self, mod_: Person, context: &LemmyContext) -> Result<(), LemmyError>;
218 async fn send_delete(&self, mod_: Person, context: &LemmyContext) -> Result<(), LemmyError>;
219 async fn send_undo_delete(&self, mod_: Person, context: &LemmyContext) -> Result<(), LemmyError>;
221 async fn send_remove(&self, context: &LemmyContext) -> Result<(), LemmyError>;
222 async fn send_undo_remove(&self, context: &LemmyContext) -> Result<(), LemmyError>;
224 async fn send_announce(
228 context: &LemmyContext,
229 ) -> Result<(), LemmyError>;
231 async fn send_add_mod(
235 context: &LemmyContext,
236 ) -> Result<(), LemmyError>;
237 async fn send_remove_mod(
241 context: &LemmyContext,
242 ) -> Result<(), LemmyError>;
244 async fn send_block_user(
247 blocked_user: Person,
248 context: &LemmyContext,
249 ) -> Result<(), LemmyError>;
250 async fn send_undo_block_user(
253 blocked_user: Person,
254 context: &LemmyContext,
255 ) -> Result<(), LemmyError>;
258 #[async_trait::async_trait(?Send)]
260 async fn send_follow(
262 follow_actor_id: &Url,
263 context: &LemmyContext,
264 ) -> Result<(), LemmyError>;
265 async fn send_unfollow(
267 follow_actor_id: &Url,
268 context: &LemmyContext,
269 ) -> Result<(), LemmyError>;
272 pub enum EndpointType {
280 /// Generates the ActivityPub ID for a given object type and ID.
281 pub fn generate_apub_endpoint(
282 endpoint_type: EndpointType,
284 ) -> Result<DbUrl, ParseError> {
285 let point = match endpoint_type {
286 EndpointType::Community => "c",
287 EndpointType::Person => "u",
288 EndpointType::Post => "post",
289 EndpointType::Comment => "comment",
290 EndpointType::PrivateMessage => "private_message",
296 Settings::get().get_protocol_and_hostname(),
304 pub fn generate_followers_url(actor_id: &DbUrl) -> Result<DbUrl, ParseError> {
305 Ok(Url::parse(&format!("{}/followers", actor_id))?.into())
308 pub fn generate_inbox_url(actor_id: &DbUrl) -> Result<DbUrl, ParseError> {
309 Ok(Url::parse(&format!("{}/inbox", actor_id))?.into())
312 pub fn generate_shared_inbox_url(actor_id: &DbUrl) -> Result<DbUrl, LemmyError> {
313 let actor_id = actor_id.clone().into_inner();
317 &actor_id.host_str().context(location_info!())?,
318 if let Some(port) = actor_id.port() {
324 Ok(Url::parse(&url)?.into())
327 pub fn generate_moderators_url(community_id: &DbUrl) -> Result<DbUrl, LemmyError> {
328 Ok(Url::parse(&format!("{}/moderators", community_id))?.into())
331 /// Store a sent or received activity in the database, for logging purposes. These records are not
333 pub async fn insert_activity<T>(
339 ) -> Result<(), LemmyError>
341 T: Serialize + std::fmt::Debug + Send + 'static,
343 let ap_id = ap_id.to_owned().into();
344 blocking(pool, move |conn| {
345 Activity::insert(conn, ap_id, &activity, local, sensitive)
351 pub enum PostOrComment {
352 Comment(Box<Comment>),
356 /// Tries to find a post or comment in the local database, without any network requests.
357 /// This is used to handle deletions and removals, because in case we dont have the object, we can
358 /// simply ignore the activity.
359 pub async fn find_post_or_comment_by_id(
360 context: &LemmyContext,
362 ) -> Result<PostOrComment, LemmyError> {
363 let ap_id = apub_id.clone();
364 let post = blocking(context.pool(), move |conn| {
365 Post::read_from_apub_id(conn, &ap_id.into())
368 if let Ok(p) = post {
369 return Ok(PostOrComment::Post(Box::new(p)));
372 let ap_id = apub_id.clone();
373 let comment = blocking(context.pool(), move |conn| {
374 Comment::read_from_apub_id(conn, &ap_id.into())
377 if let Ok(c) = comment {
378 return Ok(PostOrComment::Comment(Box::new(c)));
386 Comment(Box<Comment>),
388 Community(Box<Community>),
389 Person(Box<DbPerson>),
390 PrivateMessage(Box<PrivateMessage>),
393 pub async fn find_object_by_id(context: &LemmyContext, apub_id: Url) -> Result<Object, LemmyError> {
394 let ap_id = apub_id.clone();
395 if let Ok(pc) = find_post_or_comment_by_id(context, ap_id.to_owned()).await {
397 PostOrComment::Post(p) => Object::Post(Box::new(*p)),
398 PostOrComment::Comment(c) => Object::Comment(Box::new(*c)),
402 let ap_id = apub_id.clone();
403 let person = blocking(context.pool(), move |conn| {
404 DbPerson::read_from_apub_id(conn, &ap_id.into())
407 if let Ok(u) = person {
408 return Ok(Object::Person(Box::new(u)));
411 let ap_id = apub_id.clone();
412 let community = blocking(context.pool(), move |conn| {
413 Community::read_from_apub_id(conn, &ap_id.into())
416 if let Ok(c) = community {
417 return Ok(Object::Community(Box::new(c)));
420 let private_message = blocking(context.pool(), move |conn| {
421 PrivateMessage::read_from_apub_id(conn, &apub_id.into())
424 if let Ok(pm) = private_message {
425 return Ok(Object::PrivateMessage(Box::new(pm)));
431 pub async fn check_community_or_site_ban(
433 community_id: CommunityId,
435 ) -> Result<(), LemmyError> {
437 return Err(anyhow!("Person is banned from site").into());
439 let person_id = person.id;
441 move |conn: &'_ _| CommunityPersonBanView::get(conn, person_id, community_id).is_ok();
442 if blocking(pool, is_banned).await? {
443 return Err(anyhow!("Person is banned from community").into());
449 pub fn get_activity_to_and_cc<T, Kind>(activity: &T) -> Vec<Url>
453 let mut to_and_cc = vec![];
454 if let Some(to) = activity.to() {
455 let to = to.to_owned().unwrap_to_vec();
458 .map(|t| t.as_xsd_any_uri())
460 .map(|t| t.to_owned())
462 to_and_cc.append(&mut to);
464 if let Some(cc) = activity.cc() {
465 let cc = cc.to_owned().unwrap_to_vec();
468 .map(|c| c.as_xsd_any_uri())
470 .map(|c| c.to_owned())
472 to_and_cc.append(&mut cc);
477 pub async fn get_community_from_to_or_cc<T, Kind>(
479 context: &LemmyContext,
480 request_counter: &mut i32,
481 ) -> Result<Community, LemmyError>
485 for cid in get_activity_to_and_cc(activity) {
486 let community = get_or_fetch_and_upsert_community(&cid, context, request_counter).await;
487 if community.is_ok() {