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 pub type SiteExt = actor::ApActor<ApObject<actor::Service>>;
56 /// Activitystreams type for post
57 pub type PageExt = Ext1<ApObject<Page>, PageExtension>;
58 pub type NoteExt = ApObject<Note>;
60 #[derive(Clone, Copy, Debug, serde::Deserialize, serde::Serialize, PartialEq)]
66 pub static APUB_JSON_CONTENT_TYPE: &str = "application/activity+json";
68 /// Checks if the ID is allowed for sending or receiving.
70 /// In particular, it checks for:
71 /// - federation being enabled (if its disabled, only local URLs are allowed)
72 /// - the correct scheme (either http or https)
73 /// - URL being in the allowlist (if it is active)
74 /// - URL not being in the blocklist (if it is active)
76 pub fn check_is_apub_id_valid(apub_id: &Url, use_strict_allowlist: bool) -> Result<(), LemmyError> {
77 let settings = Settings::get();
78 let domain = apub_id.domain().context(location_info!())?.to_string();
79 let local_instance = settings.get_hostname_without_port()?;
81 if !settings.federation().enabled {
82 return if domain == local_instance {
87 "Trying to connect with {}, but federation is disabled",
95 let host = apub_id.host_str().context(location_info!())?;
96 let host_as_ip = host.parse::<IpAddr>();
97 if host == "localhost" || host_as_ip.is_ok() {
98 return Err(anyhow!("invalid hostname {}: {}", host, apub_id).into());
101 if apub_id.scheme() != Settings::get().get_protocol_string() {
102 return Err(anyhow!("invalid apub id scheme {}: {}", apub_id.scheme(), apub_id).into());
105 // TODO: might be good to put the part above in one method, and below in another
106 // (which only gets called in apub::objects)
107 // -> no that doesnt make sense, we still need the code below for blocklist and strict allowlist
108 if let Some(blocked) = Settings::get().get_blocked_instances() {
109 if blocked.contains(&domain) {
110 return Err(anyhow!("{} is in federation blocklist", domain).into());
114 if let Some(mut allowed) = Settings::get().get_allowed_instances() {
115 // Only check allowlist if this is a community, or strict allowlist is enabled.
116 let strict_allowlist = Settings::get()
120 if use_strict_allowlist || strict_allowlist {
121 // need to allow this explicitly because apub receive might contain objects from our local
123 allowed.push(local_instance);
125 if !allowed.contains(&domain) {
126 return Err(anyhow!("{} not in federation allowlist", domain).into());
134 /// Common functions for ActivityPub objects, which are implemented by most (but not all) objects
135 /// and actors in Lemmy.
136 #[async_trait::async_trait(?Send)]
137 pub trait ApubObjectType {
138 async fn send_create(&self, creator: &DbPerson, context: &LemmyContext)
139 -> Result<(), LemmyError>;
140 async fn send_update(&self, creator: &DbPerson, context: &LemmyContext)
141 -> Result<(), LemmyError>;
142 async fn send_delete(&self, creator: &DbPerson, context: &LemmyContext)
143 -> Result<(), LemmyError>;
144 async fn send_undo_delete(
147 context: &LemmyContext,
148 ) -> Result<(), LemmyError>;
149 async fn send_remove(&self, mod_: &DbPerson, context: &LemmyContext) -> Result<(), LemmyError>;
150 async fn send_undo_remove(
153 context: &LemmyContext,
154 ) -> Result<(), LemmyError>;
157 #[async_trait::async_trait(?Send)]
158 pub trait ApubLikeableType {
159 async fn send_like(&self, creator: &DbPerson, context: &LemmyContext) -> Result<(), LemmyError>;
160 async fn send_dislike(
163 context: &LemmyContext,
164 ) -> Result<(), LemmyError>;
165 async fn send_undo_like(
168 context: &LemmyContext,
169 ) -> Result<(), LemmyError>;
172 /// Common methods provided by ActivityPub actors (community and person). Not all methods are
173 /// implemented by all actors.
174 pub trait ActorType {
175 fn is_local(&self) -> bool;
176 fn actor_id(&self) -> Url;
177 fn name(&self) -> String;
179 // TODO: every actor should have a public key, so this shouldnt be an option (needs to be fixed in db)
180 fn public_key(&self) -> Option<String>;
181 fn private_key(&self) -> Option<String>;
183 fn get_shared_inbox_or_inbox_url(&self) -> Url;
185 /// Outbox URL is not generally used by Lemmy, so it can be generated on the fly (but only for
187 fn get_outbox_url(&self) -> Result<Url, LemmyError> {
189 if !self.is_local() {
190 return Err(anyhow!("get_outbox_url() called for remote actor").into());
193 Ok(Url::parse(&format!("{}/outbox", &self.actor_id()))?)
196 fn get_public_key_ext(&self) -> Result<PublicKeyExtension, LemmyError> {
199 id: format!("{}#main-key", self.actor_id()),
200 owner: self.actor_id(),
201 public_key_pem: self.public_key().context(location_info!())?,
208 #[async_trait::async_trait(?Send)]
209 pub trait CommunityType {
210 fn followers_url(&self) -> Url;
211 async fn get_follower_inboxes(&self, pool: &DbPool) -> Result<Vec<Url>, LemmyError>;
212 async fn send_accept_follow(
215 context: &LemmyContext,
216 ) -> Result<(), LemmyError>;
218 async fn send_update(&self, mod_: Person, context: &LemmyContext) -> Result<(), LemmyError>;
219 async fn send_delete(&self, mod_: Person, context: &LemmyContext) -> Result<(), LemmyError>;
220 async fn send_undo_delete(&self, mod_: Person, context: &LemmyContext) -> Result<(), LemmyError>;
222 async fn send_remove(&self, context: &LemmyContext) -> Result<(), LemmyError>;
223 async fn send_undo_remove(&self, context: &LemmyContext) -> Result<(), LemmyError>;
225 async fn send_announce(
229 context: &LemmyContext,
230 ) -> Result<(), LemmyError>;
232 async fn send_add_mod(
236 context: &LemmyContext,
237 ) -> Result<(), LemmyError>;
238 async fn send_remove_mod(
242 context: &LemmyContext,
243 ) -> Result<(), LemmyError>;
245 async fn send_block_user(
248 blocked_user: Person,
249 context: &LemmyContext,
250 ) -> Result<(), LemmyError>;
251 async fn send_undo_block_user(
254 blocked_user: Person,
255 context: &LemmyContext,
256 ) -> Result<(), LemmyError>;
259 #[async_trait::async_trait(?Send)]
261 async fn send_follow(
263 follow_actor_id: &Url,
264 context: &LemmyContext,
265 ) -> Result<(), LemmyError>;
266 async fn send_unfollow(
268 follow_actor_id: &Url,
269 context: &LemmyContext,
270 ) -> Result<(), LemmyError>;
273 pub enum EndpointType {
281 /// Generates the ActivityPub ID for a given object type and ID.
282 pub fn generate_apub_endpoint(
283 endpoint_type: EndpointType,
285 ) -> Result<DbUrl, ParseError> {
286 let point = match endpoint_type {
287 EndpointType::Community => "c",
288 EndpointType::Person => "u",
289 EndpointType::Post => "post",
290 EndpointType::Comment => "comment",
291 EndpointType::PrivateMessage => "private_message",
297 Settings::get().get_protocol_and_hostname(),
305 pub fn generate_followers_url(actor_id: &DbUrl) -> Result<DbUrl, ParseError> {
306 Ok(Url::parse(&format!("{}/followers", actor_id))?.into())
309 pub fn generate_inbox_url(actor_id: &DbUrl) -> Result<DbUrl, ParseError> {
310 Ok(Url::parse(&format!("{}/inbox", actor_id))?.into())
313 pub fn generate_shared_inbox_url(actor_id: &DbUrl) -> Result<DbUrl, LemmyError> {
314 let actor_id = actor_id.clone().into_inner();
318 &actor_id.host_str().context(location_info!())?,
319 if let Some(port) = actor_id.port() {
325 Ok(Url::parse(&url)?.into())
328 pub fn generate_moderators_url(community_id: &DbUrl) -> Result<DbUrl, LemmyError> {
329 Ok(Url::parse(&format!("{}/moderators", community_id))?.into())
332 /// Store a sent or received activity in the database, for logging purposes. These records are not
334 pub async fn insert_activity<T>(
340 ) -> Result<(), LemmyError>
342 T: Serialize + std::fmt::Debug + Send + 'static,
344 let ap_id = ap_id.to_owned().into();
345 blocking(pool, move |conn| {
346 Activity::insert(conn, ap_id, &activity, local, sensitive)
352 pub enum PostOrComment {
353 Comment(Box<Comment>),
357 /// Tries to find a post or comment in the local database, without any network requests.
358 /// This is used to handle deletions and removals, because in case we dont have the object, we can
359 /// simply ignore the activity.
360 pub async fn find_post_or_comment_by_id(
361 context: &LemmyContext,
363 ) -> Result<PostOrComment, LemmyError> {
364 let ap_id = apub_id.clone();
365 let post = blocking(context.pool(), move |conn| {
366 Post::read_from_apub_id(conn, &ap_id.into())
369 if let Ok(p) = post {
370 return Ok(PostOrComment::Post(Box::new(p)));
373 let ap_id = apub_id.clone();
374 let comment = blocking(context.pool(), move |conn| {
375 Comment::read_from_apub_id(conn, &ap_id.into())
378 if let Ok(c) = comment {
379 return Ok(PostOrComment::Comment(Box::new(c)));
387 Comment(Box<Comment>),
389 Community(Box<Community>),
390 Person(Box<DbPerson>),
391 PrivateMessage(Box<PrivateMessage>),
394 pub async fn find_object_by_id(context: &LemmyContext, apub_id: Url) -> Result<Object, LemmyError> {
395 let ap_id = apub_id.clone();
396 if let Ok(pc) = find_post_or_comment_by_id(context, ap_id.to_owned()).await {
398 PostOrComment::Post(p) => Object::Post(Box::new(*p)),
399 PostOrComment::Comment(c) => Object::Comment(Box::new(*c)),
403 let ap_id = apub_id.clone();
404 let person = blocking(context.pool(), move |conn| {
405 DbPerson::read_from_apub_id(conn, &ap_id.into())
408 if let Ok(u) = person {
409 return Ok(Object::Person(Box::new(u)));
412 let ap_id = apub_id.clone();
413 let community = blocking(context.pool(), move |conn| {
414 Community::read_from_apub_id(conn, &ap_id.into())
417 if let Ok(c) = community {
418 return Ok(Object::Community(Box::new(c)));
421 let private_message = blocking(context.pool(), move |conn| {
422 PrivateMessage::read_from_apub_id(conn, &apub_id.into())
425 if let Ok(pm) = private_message {
426 return Ok(Object::PrivateMessage(Box::new(pm)));
432 pub async fn check_community_or_site_ban(
434 community_id: CommunityId,
436 ) -> Result<(), LemmyError> {
438 return Err(anyhow!("Person is banned from site").into());
440 let person_id = person.id;
442 move |conn: &'_ _| CommunityPersonBanView::get(conn, person_id, community_id).is_ok();
443 if blocking(pool, is_banned).await? {
444 return Err(anyhow!("Person is banned from community").into());
450 pub fn get_activity_to_and_cc<T, Kind>(activity: &T) -> Vec<Url>
454 let mut to_and_cc = vec![];
455 if let Some(to) = activity.to() {
456 let to = to.to_owned().unwrap_to_vec();
459 .map(|t| t.as_xsd_any_uri())
461 .map(|t| t.to_owned())
463 to_and_cc.append(&mut to);
465 if let Some(cc) = activity.cc() {
466 let cc = cc.to_owned().unwrap_to_vec();
469 .map(|c| c.as_xsd_any_uri())
471 .map(|c| c.to_owned())
473 to_and_cc.append(&mut cc);
478 pub async fn get_community_from_to_or_cc<T, Kind>(
480 context: &LemmyContext,
481 request_counter: &mut i32,
482 ) -> Result<Community, LemmyError>
486 for cid in get_activity_to_and_cc(activity) {
487 let community = get_or_fetch_and_upsert_community(&cid, context, request_counter).await;
488 if community.is_ok() {