2 pub(crate) mod collections;
10 extern crate lazy_static;
12 use crate::fetcher::post_or_comment::PostOrComment;
13 use anyhow::{anyhow, Context};
14 use lemmy_api_common::blocking;
15 use lemmy_apub_lib::webfinger::{webfinger_resolve_actor, WebfingerType};
16 use lemmy_db_schema::{newtypes::DbUrl, source::activity::Activity, DbPool};
17 use lemmy_utils::{location_info, settings::structs::Settings, LemmyError};
18 use lemmy_websocket::LemmyContext;
21 use url::{ParseError, Url};
23 /// Checks if the ID is allowed for sending or receiving.
25 /// In particular, it checks for:
26 /// - federation being enabled (if its disabled, only local URLs are allowed)
27 /// - the correct scheme (either http or https)
28 /// - URL being in the allowlist (if it is active)
29 /// - URL not being in the blocklist (if it is active)
31 pub(crate) fn check_is_apub_id_valid(
33 use_strict_allowlist: bool,
35 ) -> Result<(), LemmyError> {
36 let domain = apub_id.domain().context(location_info!())?.to_string();
37 let local_instance = settings.get_hostname_without_port()?;
39 if !settings.federation.enabled {
40 return if domain == local_instance {
45 "Trying to connect with {}, but federation is disabled",
53 let host = apub_id.host_str().context(location_info!())?;
54 let host_as_ip = host.parse::<IpAddr>();
55 if host == "localhost" || host_as_ip.is_ok() {
56 return Err(anyhow!("invalid hostname {}: {}", host, apub_id).into());
59 if apub_id.scheme() != settings.get_protocol_string() {
60 return Err(anyhow!("invalid apub id scheme {}: {}", apub_id.scheme(), apub_id).into());
63 // TODO: might be good to put the part above in one method, and below in another
64 // (which only gets called in apub::objects)
65 // -> no that doesnt make sense, we still need the code below for blocklist and strict allowlist
66 if let Some(blocked) = settings.to_owned().federation.blocked_instances {
67 if blocked.contains(&domain) {
68 return Err(anyhow!("{} is in federation blocklist", domain).into());
72 if let Some(mut allowed) = settings.to_owned().federation.allowed_instances {
73 // Only check allowlist if this is a community, or strict allowlist is enabled.
74 let strict_allowlist = settings.to_owned().federation.strict_allowlist;
75 if use_strict_allowlist || strict_allowlist {
76 // need to allow this explicitly because apub receive might contain objects from our local
78 allowed.push(local_instance);
80 if !allowed.contains(&domain) {
81 return Err(anyhow!("{} not in federation allowlist", domain).into());
89 pub enum EndpointType {
97 /// Generates an apub endpoint for a given domain, IE xyz.tld
98 pub fn generate_local_apub_endpoint(
99 endpoint_type: EndpointType,
102 ) -> Result<DbUrl, ParseError> {
103 let point = match endpoint_type {
104 EndpointType::Community => "c",
105 EndpointType::Person => "u",
106 EndpointType::Post => "post",
107 EndpointType::Comment => "comment",
108 EndpointType::PrivateMessage => "private_message",
111 Ok(Url::parse(&format!("{}/{}/{}", domain, point, name))?.into())
114 pub fn generate_followers_url(actor_id: &DbUrl) -> Result<DbUrl, ParseError> {
115 Ok(Url::parse(&format!("{}/followers", actor_id))?.into())
118 pub fn generate_inbox_url(actor_id: &DbUrl) -> Result<DbUrl, ParseError> {
119 Ok(Url::parse(&format!("{}/inbox", actor_id))?.into())
122 pub fn generate_shared_inbox_url(actor_id: &DbUrl) -> Result<DbUrl, LemmyError> {
123 let actor_id: Url = actor_id.clone().into();
127 &actor_id.host_str().context(location_info!())?,
128 if let Some(port) = actor_id.port() {
134 Ok(Url::parse(&url)?.into())
137 pub fn generate_outbox_url(actor_id: &DbUrl) -> Result<DbUrl, ParseError> {
138 Ok(Url::parse(&format!("{}/outbox", actor_id))?.into())
141 fn generate_moderators_url(community_id: &DbUrl) -> Result<DbUrl, LemmyError> {
142 Ok(Url::parse(&format!("{}/moderators", community_id))?.into())
145 /// Takes in a shortname of the type dessalines@xyz.tld or dessalines (assumed to be local), and outputs the actor id.
146 /// Used in the API for communities and users.
147 pub async fn get_actor_id_from_name(
148 webfinger_type: WebfingerType,
150 context: &LemmyContext,
151 ) -> Result<DbUrl, LemmyError> {
152 let split = short_name.split('@').collect::<Vec<&str>>();
156 // If there's no @, its local
157 if split.len() == 1 {
158 let domain = context.settings().get_protocol_and_hostname();
159 let endpoint_type = match webfinger_type {
160 WebfingerType::Person => EndpointType::Person,
161 WebfingerType::Group => EndpointType::Community,
163 Ok(generate_local_apub_endpoint(endpoint_type, name, &domain)?)
165 let protocol = context.settings().get_protocol_string();
167 webfinger_resolve_actor(name, split[1], webfinger_type, context.client(), protocol)
174 /// Store a sent or received activity in the database, for logging purposes. These records are not
176 async fn insert_activity<T>(
182 ) -> Result<(), LemmyError>
184 T: Serialize + std::fmt::Debug + Send + 'static,
186 let ap_id = ap_id.to_owned().into();
187 blocking(pool, move |conn| {
188 Activity::insert(conn, ap_id, &activity, local, sensitive)