pub mod websocket;
use crate::site::FederatedInstances;
-use diesel::PgConnection;
-use lemmy_db_queries::{
- source::{
- community::{CommunityModerator_, Community_},
- site::Site_,
- },
- Crud,
- DbPool,
-};
use lemmy_db_schema::{
+ newtypes::{CommunityId, LocalUserId, PersonId, PostId},
source::{
- comment::Comment,
- community::{Community, CommunityModerator},
- person::Person,
- person_mention::{PersonMention, PersonMentionForm},
- post::Post,
+ community::Community,
+ email_verification::{EmailVerification, EmailVerificationForm},
+ password_reset_request::PasswordResetRequest,
+ person_block::PersonBlock,
+ post::{Post, PostRead, PostReadForm},
+ registration_application::RegistrationApplication,
+ secret::Secret,
site::Site,
},
- CommunityId,
- LocalUserId,
- PersonId,
- PostId,
+ traits::{Crud, Readable},
+ DbPool,
};
use lemmy_db_views::local_user_view::{LocalUserSettingsView, LocalUserView};
use lemmy_db_views_actor::{
use lemmy_utils::{
claims::Claims,
email::send_email,
- settings::structs::Settings,
- utils::MentionData,
- ApiError,
+ settings::structs::{FederationConfig, Settings},
+ utils::generate_random_string,
LemmyError,
+ Sensitive,
};
-use log::error;
-use serde::{Deserialize, Serialize};
use url::Url;
-#[derive(Serialize, Deserialize, Debug)]
-pub struct WebFingerLink {
- pub rel: Option<String>,
- #[serde(rename(serialize = "type", deserialize = "type"))]
- pub type_: Option<String>,
- pub href: Option<Url>,
- #[serde(skip_serializing_if = "Option::is_none")]
- pub template: Option<String>,
-}
-
-#[derive(Serialize, Deserialize, Debug)]
-pub struct WebFingerResponse {
- pub subject: String,
- pub aliases: Vec<Url>,
- pub links: Vec<WebFingerLink>,
-}
-
pub async fn blocking<F, T>(pool: &DbPool, f: F) -> Result<T, LemmyError>
where
F: FnOnce(&diesel::PgConnection) -> T + Send + 'static,
T: Send + 'static,
{
let pool = pool.clone();
+ let blocking_span = tracing::info_span!("blocking operation");
let res = actix_web::web::block(move || {
+ let entered = blocking_span.enter();
let conn = pool.get()?;
let res = (f)(&conn);
- Ok(res) as Result<_, LemmyError>
+ drop(entered);
+ Ok(res) as Result<T, LemmyError>
})
.await?;
- Ok(res)
-}
-
-pub async fn send_local_notifs(
- mentions: Vec<MentionData>,
- comment: Comment,
- person: Person,
- post: Post,
- pool: &DbPool,
- do_send_email: bool,
-) -> Result<Vec<LocalUserId>, LemmyError> {
- let ids = blocking(pool, move |conn| {
- do_send_local_notifs(conn, &mentions, &comment, &person, &post, do_send_email)
- })
- .await?;
-
- Ok(ids)
-}
-
-fn do_send_local_notifs(
- conn: &PgConnection,
- mentions: &[MentionData],
- comment: &Comment,
- person: &Person,
- post: &Post,
- do_send_email: bool,
-) -> Vec<LocalUserId> {
- let mut recipient_ids = Vec::new();
-
- // Send the local mentions
- for mention in mentions
- .iter()
- .filter(|m| m.is_local() && m.name.ne(&person.name))
- .collect::<Vec<&MentionData>>()
- {
- if let Ok(mention_user_view) = LocalUserView::read_from_name(&conn, &mention.name) {
- // TODO
- // At some point, make it so you can't tag the parent creator either
- // This can cause two notifications, one for reply and the other for mention
- recipient_ids.push(mention_user_view.local_user.id);
-
- let user_mention_form = PersonMentionForm {
- recipient_id: mention_user_view.person.id,
- comment_id: comment.id,
- read: None,
- };
-
- // Allow this to fail softly, since comment edits might re-update or replace it
- // Let the uniqueness handle this fail
- PersonMention::create(&conn, &user_mention_form).ok();
-
- // Send an email to those local users that have notifications on
- if do_send_email {
- send_email_to_user(
- &mention_user_view,
- "Mentioned by",
- "Person Mention",
- &comment.content,
- )
- }
- }
- }
-
- // Send notifs to the parent commenter / poster
- match comment.parent_id {
- Some(parent_id) => {
- if let Ok(parent_comment) = Comment::read(&conn, parent_id) {
- // Don't send a notif to yourself
- if parent_comment.creator_id != person.id {
- // Get the parent commenter local_user
- if let Ok(parent_user_view) = LocalUserView::read_person(&conn, parent_comment.creator_id)
- {
- recipient_ids.push(parent_user_view.local_user.id);
-
- if do_send_email {
- send_email_to_user(
- &parent_user_view,
- "Reply from",
- "Comment Reply",
- &comment.content,
- )
- }
- }
- }
- }
- }
- // Its a post
- None => {
- if post.creator_id != person.id {
- if let Ok(parent_user_view) = LocalUserView::read_person(&conn, post.creator_id) {
- recipient_ids.push(parent_user_view.local_user.id);
-
- if do_send_email {
- send_email_to_user(
- &parent_user_view,
- "Reply from",
- "Post Reply",
- &comment.content,
- )
- }
- }
- }
- }
- };
- recipient_ids
-}
-
-pub fn send_email_to_user(
- local_user_view: &LocalUserView,
- subject_text: &str,
- body_text: &str,
- comment_content: &str,
-) {
- if local_user_view.person.banned || !local_user_view.local_user.send_notifications_to_email {
- return;
- }
-
- if let Some(user_email) = &local_user_view.local_user.email {
- let subject = &format!(
- "{} - {} {}",
- subject_text,
- Settings::get().hostname(),
- local_user_view.person.name,
- );
- let html = &format!(
- "<h1>{}</h1><br><div>{} - {}</div><br><a href={}/inbox>inbox</a>",
- body_text,
- local_user_view.person.name,
- comment_content,
- Settings::get().get_protocol_and_hostname()
- );
- match send_email(subject, &user_email, &local_user_view.person.name, html) {
- Ok(_o) => _o,
- Err(e) => error!("{}", e),
- };
- }
+ res
}
+#[tracing::instrument(skip_all)]
pub async fn is_mod_or_admin(
pool: &DbPool,
person_id: PersonId,
})
.await?;
if !is_mod_or_admin {
- return Err(ApiError::err("not_a_mod_or_admin").into());
+ return Err(LemmyError::from_message("not_a_mod_or_admin"));
}
Ok(())
}
pub fn is_admin(local_user_view: &LocalUserView) -> Result<(), LemmyError> {
if !local_user_view.person.admin {
- return Err(ApiError::err("not_an_admin").into());
+ return Err(LemmyError::from_message("not_an_admin"));
}
Ok(())
}
+#[tracing::instrument(skip_all)]
pub async fn get_post(post_id: PostId, pool: &DbPool) -> Result<Post, LemmyError> {
- match blocking(pool, move |conn| Post::read(conn, post_id)).await? {
- Ok(post) => Ok(post),
- Err(_e) => Err(ApiError::err("couldnt_find_post").into()),
- }
+ blocking(pool, move |conn| Post::read(conn, post_id))
+ .await?
+ .map_err(LemmyError::from)
+ .map_err(|e| e.with_message("couldnt_find_post"))
+}
+
+#[tracing::instrument(skip_all)]
+pub async fn mark_post_as_read(
+ person_id: PersonId,
+ post_id: PostId,
+ pool: &DbPool,
+) -> Result<PostRead, LemmyError> {
+ let post_read_form = PostReadForm { post_id, person_id };
+
+ blocking(pool, move |conn| {
+ PostRead::mark_as_read(conn, &post_read_form)
+ })
+ .await?
+ .map_err(LemmyError::from)
+ .map_err(|e| e.with_message("couldnt_mark_post_as_read"))
+}
+
+#[tracing::instrument(skip_all)]
+pub async fn mark_post_as_unread(
+ person_id: PersonId,
+ post_id: PostId,
+ pool: &DbPool,
+) -> Result<usize, LemmyError> {
+ let post_read_form = PostReadForm { post_id, person_id };
+
+ blocking(pool, move |conn| {
+ PostRead::mark_as_unread(conn, &post_read_form)
+ })
+ .await?
+ .map_err(LemmyError::from)
+ .map_err(|e| e.with_message("couldnt_mark_post_as_read"))
}
+#[tracing::instrument(skip_all)]
pub async fn get_local_user_view_from_jwt(
jwt: &str,
pool: &DbPool,
+ secret: &Secret,
) -> Result<LocalUserView, LemmyError> {
- let claims = match Claims::decode(&jwt) {
- Ok(claims) => claims.claims,
- Err(_e) => return Err(ApiError::err("not_logged_in").into()),
- };
+ let claims = Claims::decode(jwt, &secret.jwt_secret)
+ .map_err(LemmyError::from)
+ .map_err(|e| e.with_message("not_logged_in"))?
+ .claims;
let local_user_id = LocalUserId(claims.sub);
let local_user_view =
blocking(pool, move |conn| LocalUserView::read(conn, local_user_id)).await??;
// Check for a site ban
- if local_user_view.person.banned {
- return Err(ApiError::err("site_ban").into());
+ if local_user_view.person.is_banned() {
+ return Err(LemmyError::from_message("site_ban"));
+ }
+
+ // Check for user deletion
+ if local_user_view.person.deleted {
+ return Err(LemmyError::from_message("deleted"));
}
check_validator_time(&local_user_view.local_user.validator_time, &claims)?;
) -> Result<(), LemmyError> {
let user_validation_time = validator_time.timestamp();
if user_validation_time > claims.iat {
- Err(ApiError::err("not_logged_in").into())
+ Err(LemmyError::from_message("not_logged_in"))
} else {
Ok(())
}
}
+#[tracing::instrument(skip_all)]
pub async fn get_local_user_view_from_jwt_opt(
- jwt: &Option<String>,
+ jwt: Option<&Sensitive<String>>,
pool: &DbPool,
+ secret: &Secret,
) -> Result<Option<LocalUserView>, LemmyError> {
match jwt {
- Some(jwt) => Ok(Some(get_local_user_view_from_jwt(jwt, pool).await?)),
+ Some(jwt) => Ok(Some(get_local_user_view_from_jwt(jwt, pool, secret).await?)),
None => Ok(None),
}
}
+#[tracing::instrument(skip_all)]
pub async fn get_local_user_settings_view_from_jwt(
- jwt: &str,
+ jwt: &Sensitive<String>,
pool: &DbPool,
+ secret: &Secret,
) -> Result<LocalUserSettingsView, LemmyError> {
- let claims = match Claims::decode(&jwt) {
- Ok(claims) => claims.claims,
- Err(_e) => return Err(ApiError::err("not_logged_in").into()),
- };
+ let claims = Claims::decode(jwt.as_ref(), &secret.jwt_secret)
+ .map_err(LemmyError::from)
+ .map_err(|e| e.with_message("not_logged_in"))?
+ .claims;
let local_user_id = LocalUserId(claims.sub);
let local_user_view = blocking(pool, move |conn| {
LocalUserSettingsView::read(conn, local_user_id)
})
.await??;
// Check for a site ban
- if local_user_view.person.banned {
- return Err(ApiError::err("site_ban").into());
+ if local_user_view.person.is_banned() {
+ return Err(LemmyError::from_message("site_ban"));
}
check_validator_time(&local_user_view.local_user.validator_time, &claims)?;
Ok(local_user_view)
}
+#[tracing::instrument(skip_all)]
pub async fn get_local_user_settings_view_from_jwt_opt(
- jwt: &Option<String>,
+ jwt: Option<&Sensitive<String>>,
pool: &DbPool,
+ secret: &Secret,
) -> Result<Option<LocalUserSettingsView>, LemmyError> {
match jwt {
Some(jwt) => Ok(Some(
- get_local_user_settings_view_from_jwt(jwt, pool).await?,
+ get_local_user_settings_view_from_jwt(jwt, pool, secret).await?,
)),
None => Ok(None),
}
}
+#[tracing::instrument(skip_all)]
pub async fn check_community_ban(
person_id: PersonId,
community_id: CommunityId,
let is_banned =
move |conn: &'_ _| CommunityPersonBanView::get(conn, person_id, community_id).is_ok();
if blocking(pool, is_banned).await? {
- Err(ApiError::err("community_ban").into())
+ Err(LemmyError::from_message("community_ban"))
} else {
Ok(())
}
}
+#[tracing::instrument(skip_all)]
+pub async fn check_community_deleted_or_removed(
+ community_id: CommunityId,
+ pool: &DbPool,
+) -> Result<(), LemmyError> {
+ let community = blocking(pool, move |conn| Community::read(conn, community_id))
+ .await?
+ .map_err(LemmyError::from)
+ .map_err(|e| e.with_message("couldnt_find_community"))?;
+ if community.deleted || community.removed {
+ Err(LemmyError::from_message("deleted"))
+ } else {
+ Ok(())
+ }
+}
+
+pub fn check_post_deleted_or_removed(post: &Post) -> Result<(), LemmyError> {
+ if post.deleted || post.removed {
+ Err(LemmyError::from_message("deleted"))
+ } else {
+ Ok(())
+ }
+}
+
+#[tracing::instrument(skip_all)]
+pub async fn check_person_block(
+ my_id: PersonId,
+ potential_blocker_id: PersonId,
+ pool: &DbPool,
+) -> Result<(), LemmyError> {
+ let is_blocked = move |conn: &'_ _| PersonBlock::read(conn, potential_blocker_id, my_id).is_ok();
+ if blocking(pool, is_blocked).await? {
+ Err(LemmyError::from_message("person_block"))
+ } else {
+ Ok(())
+ }
+}
+
+#[tracing::instrument(skip_all)]
pub async fn check_downvotes_enabled(score: i16, pool: &DbPool) -> Result<(), LemmyError> {
if score == -1 {
- let site = blocking(pool, move |conn| Site::read_simple(conn)).await??;
+ let site = blocking(pool, Site::read_simple).await??;
if !site.enable_downvotes {
- return Err(ApiError::err("downvotes_disabled").into());
+ return Err(LemmyError::from_message("downvotes_disabled"));
}
}
Ok(())
}
-/// Returns a list of communities that the user moderates
-/// or if a community_id is supplied validates the user is a moderator
-/// of that community and returns the community id in a vec
-///
-/// * `person_id` - the person id of the moderator
-/// * `community_id` - optional community id to check for moderator privileges
-/// * `pool` - the diesel db pool
-pub async fn collect_moderated_communities(
- person_id: PersonId,
- community_id: Option<CommunityId>,
+#[tracing::instrument(skip_all)]
+pub async fn check_private_instance(
+ local_user_view: &Option<LocalUserView>,
pool: &DbPool,
-) -> Result<Vec<CommunityId>, LemmyError> {
- if let Some(community_id) = community_id {
- // if the user provides a community_id, just check for mod/admin privileges
- is_mod_or_admin(pool, person_id, community_id).await?;
- Ok(vec![community_id])
- } else {
- let ids = blocking(pool, move |conn: &'_ _| {
- CommunityModerator::get_person_moderated_communities(conn, person_id)
- })
- .await??;
- Ok(ids)
+) -> Result<(), LemmyError> {
+ if local_user_view.is_none() {
+ let site = blocking(pool, Site::read_simple).await??;
+ if site.private_instance {
+ return Err(LemmyError::from_message("instance_is_private"));
+ }
}
+ Ok(())
}
+#[tracing::instrument(skip_all)]
pub async fn build_federated_instances(
pool: &DbPool,
+ federation_config: &FederationConfig,
+ hostname: &str,
) -> Result<Option<FederatedInstances>, LemmyError> {
- if Settings::get().federation().enabled {
+ let federation = federation_config.to_owned();
+ if federation.enabled {
let distinct_communities = blocking(pool, move |conn| {
Community::distinct_federated_communities(conn)
})
.await??;
- let allowed = Settings::get().get_allowed_instances();
- let blocked = Settings::get().get_blocked_instances();
+ let allowed = federation.allowed_instances;
+ let blocked = federation.blocked_instances;
let mut linked = distinct_communities
.iter()
}
if let Some(blocked) = blocked.as_ref() {
- linked.retain(|a| !blocked.contains(a) && !a.eq(&Settings::get().hostname()));
+ linked.retain(|a| !blocked.contains(a) && !a.eq(hostname));
}
// Sort and remove dupes
/// Checks the password length
pub fn password_length_check(pass: &str) -> Result<(), LemmyError> {
- if pass.len() > 60 {
- Err(ApiError::err("invalid_password").into())
+ if !(10..=60).contains(&pass.len()) {
+ Err(LemmyError::from_message("invalid_password"))
} else {
Ok(())
}
/// Checks the site description length
pub fn site_description_length_check(description: &str) -> Result<(), LemmyError> {
if description.len() > 150 {
- Err(ApiError::err("site_description_length_overflow").into())
+ Err(LemmyError::from_message("site_description_length_overflow"))
} else {
Ok(())
}
}
+
+/// Checks for a honeypot. If this field is filled, fail the rest of the function
+pub fn honeypot_check(honeypot: &Option<String>) -> Result<(), LemmyError> {
+ if honeypot.is_some() {
+ Err(LemmyError::from_message("honeypot_fail"))
+ } else {
+ Ok(())
+ }
+}
+
+pub fn send_email_to_user(
+ local_user_view: &LocalUserView,
+ subject_text: &str,
+ body_text: &str,
+ comment_content: &str,
+ settings: &Settings,
+) {
+ if local_user_view.person.banned || !local_user_view.local_user.send_notifications_to_email {
+ return;
+ }
+
+ if let Some(user_email) = &local_user_view.local_user.email {
+ let subject = &format!(
+ "{} - {} {}",
+ subject_text, settings.hostname, local_user_view.person.name,
+ );
+ let html = &format!(
+ "<h1>{}</h1><br><div>{} - {}</div><br><a href={}/inbox>inbox</a>",
+ body_text,
+ local_user_view.person.name,
+ comment_content,
+ settings.get_protocol_and_hostname()
+ );
+ match send_email(
+ subject,
+ user_email,
+ &local_user_view.person.name,
+ html,
+ settings,
+ ) {
+ Ok(_o) => _o,
+ Err(e) => tracing::error!("{}", e),
+ };
+ }
+}
+
+pub async fn send_password_reset_email(
+ local_user_view: &LocalUserView,
+ pool: &DbPool,
+ settings: &Settings,
+) -> Result<(), LemmyError> {
+ // Generate a random token
+ let token = generate_random_string();
+
+ // Insert the row
+ let token2 = token.clone();
+ let local_user_id = local_user_view.local_user.id;
+ blocking(pool, move |conn| {
+ PasswordResetRequest::create_token(conn, local_user_id, &token2)
+ })
+ .await??;
+
+ let email = &local_user_view.local_user.email.to_owned().expect("email");
+ let subject = &format!("Password reset for {}", local_user_view.person.name);
+ let protocol_and_hostname = settings.get_protocol_and_hostname();
+ let html = &format!("<h1>Password Reset Request for {}</h1><br><a href={}/password_change/{}>Click here to reset your password</a>", local_user_view.person.name, protocol_and_hostname, &token);
+ send_email(subject, email, &local_user_view.person.name, html, settings)
+}
+
+/// Send a verification email
+pub async fn send_verification_email(
+ local_user_id: LocalUserId,
+ new_email: &str,
+ username: &str,
+ pool: &DbPool,
+ settings: &Settings,
+) -> Result<(), LemmyError> {
+ let form = EmailVerificationForm {
+ local_user_id,
+ email: new_email.to_string(),
+ verification_token: generate_random_string(),
+ };
+ let verify_link = format!(
+ "{}/verify_email/{}",
+ settings.get_protocol_and_hostname(),
+ &form.verification_token
+ );
+ blocking(pool, move |conn| EmailVerification::create(conn, &form)).await??;
+
+ let subject = format!("Verify your email address for {}", settings.hostname);
+ let body = format!(
+ concat!(
+ "Please click the link below to verify your email address ",
+ "for the account @{}@{}. Ignore this email if the account isn't yours.<br><br>",
+ "<a href=\"{}\">Verify your email</a>"
+ ),
+ username, settings.hostname, verify_link
+ );
+ send_email(&subject, new_email, username, &body, settings)?;
+
+ Ok(())
+}
+
+pub fn send_email_verification_success(
+ local_user_view: &LocalUserView,
+ settings: &Settings,
+) -> Result<(), LemmyError> {
+ let email = &local_user_view.local_user.email.to_owned().expect("email");
+ let subject = &format!("Email verified for {}", local_user_view.person.actor_id);
+ let html = "Your email has been verified.";
+ send_email(subject, email, &local_user_view.person.name, html, settings)
+}
+
+pub fn send_application_approved_email(
+ local_user_view: &LocalUserView,
+ settings: &Settings,
+) -> Result<(), LemmyError> {
+ let email = &local_user_view.local_user.email.to_owned().expect("email");
+ let subject = &format!(
+ "Registration approved for {}",
+ local_user_view.person.actor_id
+ );
+ let html = &format!(
+ "Your registration application has been approved. Welcome to {}!",
+ settings.hostname
+ );
+ send_email(subject, email, &local_user_view.person.name, html, settings)
+}
+
+pub async fn check_registration_application(
+ site: &Site,
+ local_user_view: &LocalUserView,
+ pool: &DbPool,
+) -> Result<(), LemmyError> {
+ if site.require_application
+ && !local_user_view.local_user.accepted_application
+ && !local_user_view.person.admin
+ {
+ // Fetch the registration, see if its denied
+ let local_user_id = local_user_view.local_user.id;
+ let registration = blocking(pool, move |conn| {
+ RegistrationApplication::find_by_local_user_id(conn, local_user_id)
+ })
+ .await??;
+ if registration.deny_reason.is_some() {
+ return Err(LemmyError::from_message("registration_denied"));
+ } else {
+ return Err(LemmyError::from_message("registration_application_pending"));
+ }
+ }
+ Ok(())
+}
+
+/// TODO this check should be removed after https://github.com/LemmyNet/lemmy/issues/868 is done.
+pub async fn check_private_instance_and_federation_enabled(
+ pool: &DbPool,
+ settings: &Settings,
+) -> Result<(), LemmyError> {
+ let site_opt = blocking(pool, Site::read_simple).await?;
+
+ if let Ok(site) = site_opt {
+ if site.private_instance && settings.federation.enabled {
+ return Err(LemmyError::from_message(
+ "Cannot have both private instance and federation enabled.",
+ ));
+ }
+ }
+ Ok(())
+}