2 extern crate lazy_static;
5 pub mod activity_queue;
13 use crate::extensions::{
14 group_extensions::GroupExtension,
15 page_extension::PageExtension,
16 signatures::{PublicKey, PublicKeyExtension},
18 use activitystreams::{
22 object::{ApObject, Note, Page},
24 use activitystreams_ext::{Ext1, Ext2};
25 use anyhow::{anyhow, Context};
27 use lemmy_api_structs::blocking;
28 use lemmy_db_queries::{source::activity::Activity_, ApubObject, DbPool};
29 use lemmy_db_schema::{
34 person::{Person as DbPerson, Person},
36 private_message::PrivateMessage,
40 use lemmy_utils::{location_info, settings::structs::Settings, LemmyError};
41 use lemmy_websocket::LemmyContext;
44 use url::{ParseError, Url};
46 /// Activitystreams type for community
47 type GroupExt = Ext2<actor::ApActor<ApObject<actor::Group>>, GroupExtension, PublicKeyExtension>;
48 /// Activitystreams type for person
49 type PersonExt = Ext1<actor::ApActor<ApObject<actor::Person>>, PublicKeyExtension>;
50 /// Activitystreams type for post
51 type PageExt = Ext1<ApObject<Page>, PageExtension>;
52 type NoteExt = ApObject<Note>;
54 pub static APUB_JSON_CONTENT_TYPE: &str = "application/activity+json";
56 /// Checks if the ID is allowed for sending or receiving.
58 /// In particular, it checks for:
59 /// - federation being enabled (if its disabled, only local URLs are allowed)
60 /// - the correct scheme (either http or https)
61 /// - URL being in the allowlist (if it is active)
62 /// - URL not being in the blocklist (if it is active)
64 /// Note that only one of allowlist and blacklist can be enabled, not both.
65 fn check_is_apub_id_valid(apub_id: &Url) -> Result<(), LemmyError> {
66 let settings = Settings::get();
67 let domain = apub_id.domain().context(location_info!())?.to_string();
68 let local_instance = settings.get_hostname_without_port()?;
70 if !settings.federation().enabled {
71 return if domain == local_instance {
76 "Trying to connect with {}, but federation is disabled",
84 let host = apub_id.host_str().context(location_info!())?;
85 let host_as_ip = host.parse::<IpAddr>();
86 if host == "localhost" || host_as_ip.is_ok() {
87 return Err(anyhow!("invalid hostname {}: {}", host, apub_id).into());
90 if apub_id.scheme() != Settings::get().get_protocol_string() {
91 return Err(anyhow!("invalid apub id scheme {}: {}", apub_id.scheme(), apub_id).into());
94 let allowed_instances = Settings::get().get_allowed_instances();
95 let blocked_instances = Settings::get().get_blocked_instances();
97 if allowed_instances.is_none() && blocked_instances.is_none() {
99 } else if let Some(mut allowed) = allowed_instances {
100 // need to allow this explicitly because apub receive might contain objects from our local
101 // instance. split is needed to remove the port in our federation test setup.
102 allowed.push(local_instance);
104 if allowed.contains(&domain) {
107 Err(anyhow!("{} not in federation allowlist", domain).into())
109 } else if let Some(blocked) = blocked_instances {
110 if blocked.contains(&domain) {
111 Err(anyhow!("{} is in federation blocklist", domain).into())
116 panic!("Invalid config, both allowed_instances and blocked_instances are specified");
120 /// Common functions for ActivityPub objects, which are implemented by most (but not all) objects
121 /// and actors in Lemmy.
122 #[async_trait::async_trait(?Send)]
123 pub trait ApubObjectType {
124 async fn send_create(&self, creator: &DbPerson, context: &LemmyContext)
125 -> Result<(), LemmyError>;
126 async fn send_update(&self, creator: &DbPerson, context: &LemmyContext)
127 -> Result<(), LemmyError>;
128 async fn send_delete(&self, creator: &DbPerson, context: &LemmyContext)
129 -> Result<(), LemmyError>;
130 async fn send_undo_delete(
133 context: &LemmyContext,
134 ) -> Result<(), LemmyError>;
135 async fn send_remove(&self, mod_: &DbPerson, context: &LemmyContext) -> Result<(), LemmyError>;
136 async fn send_undo_remove(
139 context: &LemmyContext,
140 ) -> Result<(), LemmyError>;
143 #[async_trait::async_trait(?Send)]
144 pub trait ApubLikeableType {
145 async fn send_like(&self, creator: &DbPerson, context: &LemmyContext) -> Result<(), LemmyError>;
146 async fn send_dislike(
149 context: &LemmyContext,
150 ) -> Result<(), LemmyError>;
151 async fn send_undo_like(
154 context: &LemmyContext,
155 ) -> Result<(), LemmyError>;
158 /// Common methods provided by ActivityPub actors (community and person). Not all methods are
159 /// implemented by all actors.
160 #[async_trait::async_trait(?Send)]
161 pub trait ActorType {
162 fn is_local(&self) -> bool;
163 fn actor_id(&self) -> Url;
165 // TODO: every actor should have a public key, so this shouldnt be an option (needs to be fixed in db)
166 fn public_key(&self) -> Option<String>;
167 fn private_key(&self) -> Option<String>;
169 fn get_shared_inbox_or_inbox_url(&self) -> Url;
171 /// Outbox URL is not generally used by Lemmy, so it can be generated on the fly (but only for
173 fn get_outbox_url(&self) -> Result<Url, LemmyError> {
174 if !self.is_local() {
175 return Err(anyhow!("get_outbox_url() called for remote actor").into());
177 Ok(Url::parse(&format!("{}/outbox", &self.actor_id()))?)
180 fn get_public_key_ext(&self) -> Result<PublicKeyExtension, LemmyError> {
183 id: format!("{}#main-key", self.actor_id()),
184 owner: self.actor_id(),
185 public_key_pem: self.public_key().context(location_info!())?,
192 #[async_trait::async_trait(?Send)]
193 pub trait CommunityType {
194 async fn get_follower_inboxes(&self, pool: &DbPool) -> Result<Vec<Url>, LemmyError>;
195 async fn send_accept_follow(
198 context: &LemmyContext,
199 ) -> Result<(), LemmyError>;
201 async fn send_delete(&self, context: &LemmyContext) -> Result<(), LemmyError>;
202 async fn send_undo_delete(&self, context: &LemmyContext) -> Result<(), LemmyError>;
204 async fn send_remove(&self, context: &LemmyContext) -> Result<(), LemmyError>;
205 async fn send_undo_remove(&self, context: &LemmyContext) -> Result<(), LemmyError>;
207 async fn send_announce(
210 context: &LemmyContext,
211 ) -> Result<(), LemmyError>;
213 async fn send_add_mod(
217 context: &LemmyContext,
218 ) -> Result<(), LemmyError>;
219 async fn send_remove_mod(
223 context: &LemmyContext,
224 ) -> Result<(), LemmyError>;
227 #[async_trait::async_trait(?Send)]
229 async fn send_follow(
231 follow_actor_id: &Url,
232 context: &LemmyContext,
233 ) -> Result<(), LemmyError>;
234 async fn send_unfollow(
236 follow_actor_id: &Url,
237 context: &LemmyContext,
238 ) -> Result<(), LemmyError>;
241 pub enum EndpointType {
249 /// Generates the ActivityPub ID for a given object type and ID.
250 pub fn generate_apub_endpoint(
251 endpoint_type: EndpointType,
253 ) -> Result<DbUrl, ParseError> {
254 let point = match endpoint_type {
255 EndpointType::Community => "c",
256 EndpointType::Person => "u",
257 EndpointType::Post => "post",
258 EndpointType::Comment => "comment",
259 EndpointType::PrivateMessage => "private_message",
265 Settings::get().get_protocol_and_hostname(),
273 pub fn generate_followers_url(actor_id: &DbUrl) -> Result<DbUrl, ParseError> {
274 Ok(Url::parse(&format!("{}/followers", actor_id))?.into())
277 pub fn generate_inbox_url(actor_id: &DbUrl) -> Result<DbUrl, ParseError> {
278 Ok(Url::parse(&format!("{}/inbox", actor_id))?.into())
281 pub fn generate_shared_inbox_url(actor_id: &DbUrl) -> Result<DbUrl, LemmyError> {
282 let actor_id = actor_id.clone().into_inner();
286 &actor_id.host_str().context(location_info!())?,
287 if let Some(port) = actor_id.port() {
293 Ok(Url::parse(&url)?.into())
296 pub(crate) fn generate_moderators_url(community_id: &DbUrl) -> Result<DbUrl, LemmyError> {
297 Ok(Url::parse(&format!("{}/moderators", community_id))?.into())
300 /// Store a sent or received activity in the database, for logging purposes. These records are not
302 pub(crate) async fn insert_activity<T>(
308 ) -> Result<(), LemmyError>
310 T: Serialize + std::fmt::Debug + Send + 'static,
312 let ap_id = ap_id.to_owned().into();
313 blocking(pool, move |conn| {
314 Activity::insert(conn, ap_id, &activity, local, sensitive)
320 pub(crate) enum PostOrComment {
321 Comment(Box<Comment>),
325 /// Tries to find a post or comment in the local database, without any network requests.
326 /// This is used to handle deletions and removals, because in case we dont have the object, we can
327 /// simply ignore the activity.
328 pub(crate) async fn find_post_or_comment_by_id(
329 context: &LemmyContext,
331 ) -> Result<PostOrComment, LemmyError> {
332 let ap_id = apub_id.clone();
333 let post = blocking(context.pool(), move |conn| {
334 Post::read_from_apub_id(conn, &ap_id.into())
337 if let Ok(p) = post {
338 return Ok(PostOrComment::Post(Box::new(p)));
341 let ap_id = apub_id.clone();
342 let comment = blocking(context.pool(), move |conn| {
343 Comment::read_from_apub_id(conn, &ap_id.into())
346 if let Ok(c) = comment {
347 return Ok(PostOrComment::Comment(Box::new(c)));
354 pub(crate) enum Object {
355 Comment(Box<Comment>),
357 Community(Box<Community>),
358 Person(Box<DbPerson>),
359 PrivateMessage(Box<PrivateMessage>),
362 pub(crate) async fn find_object_by_id(
363 context: &LemmyContext,
365 ) -> Result<Object, LemmyError> {
366 let ap_id = apub_id.clone();
367 if let Ok(pc) = find_post_or_comment_by_id(context, ap_id.to_owned()).await {
369 PostOrComment::Post(p) => Object::Post(Box::new(*p)),
370 PostOrComment::Comment(c) => Object::Comment(Box::new(*c)),
374 let ap_id = apub_id.clone();
375 let person = blocking(context.pool(), move |conn| {
376 DbPerson::read_from_apub_id(conn, &ap_id.into())
379 if let Ok(u) = person {
380 return Ok(Object::Person(Box::new(u)));
383 let ap_id = apub_id.clone();
384 let community = blocking(context.pool(), move |conn| {
385 Community::read_from_apub_id(conn, &ap_id.into())
388 if let Ok(c) = community {
389 return Ok(Object::Community(Box::new(c)));
392 let private_message = blocking(context.pool(), move |conn| {
393 PrivateMessage::read_from_apub_id(conn, &apub_id.into())
396 if let Ok(pm) = private_message {
397 return Ok(Object::PrivateMessage(Box::new(pm)));