1 use crate::{request::purge_image_from_pictrs, sensitive::Sensitive, site::FederatedInstances};
2 use chrono::NaiveDateTime;
4 impls::person::is_banned,
5 newtypes::{CommunityId, LocalUserId, PersonId, PostId},
9 email_verification::{EmailVerification, EmailVerificationForm},
10 password_reset_request::PasswordResetRequest,
12 person_block::PersonBlock,
13 post::{Post, PostRead, PostReadForm},
14 registration_application::RegistrationApplication,
18 traits::{Crud, Readable},
23 comment_view::CommentQuery,
24 structs::{LocalUserSettingsView, LocalUserView},
26 use lemmy_db_views_actor::structs::{
27 CommunityModeratorView,
28 CommunityPersonBanView,
33 email::{send_email, translations::Lang},
35 settings::structs::Settings,
36 utils::generate_random_string,
38 use reqwest_middleware::ClientWithMiddleware;
39 use rosetta_i18n::{Language, LanguageId};
40 use std::str::FromStr;
43 pub async fn blocking<F, T>(pool: &DbPool, f: F) -> Result<T, LemmyError>
45 F: FnOnce(&diesel::PgConnection) -> T + Send + 'static,
48 let pool = pool.clone();
49 let blocking_span = tracing::info_span!("blocking operation");
50 let res = actix_web::web::block(move || {
51 let entered = blocking_span.enter();
52 let conn = pool.get()?;
55 Ok(res) as Result<T, LemmyError>
62 #[tracing::instrument(skip_all)]
63 pub async fn is_mod_or_admin(
66 community_id: CommunityId,
67 ) -> Result<(), LemmyError> {
68 let is_mod_or_admin = blocking(pool, move |conn| {
69 CommunityView::is_mod_or_admin(conn, person_id, community_id)
73 return Err(LemmyError::from_message("not_a_mod_or_admin"));
78 pub fn is_admin(local_user_view: &LocalUserView) -> Result<(), LemmyError> {
79 if !local_user_view.person.admin {
80 return Err(LemmyError::from_message("not_an_admin"));
85 #[tracing::instrument(skip_all)]
86 pub async fn get_post(post_id: PostId, pool: &DbPool) -> Result<Post, LemmyError> {
87 blocking(pool, move |conn| Post::read(conn, post_id))
89 .map_err(|e| LemmyError::from_error_message(e, "couldnt_find_post"))
92 #[tracing::instrument(skip_all)]
93 pub async fn mark_post_as_read(
97 ) -> Result<PostRead, LemmyError> {
98 let post_read_form = PostReadForm { post_id, person_id };
100 blocking(pool, move |conn| {
101 PostRead::mark_as_read(conn, &post_read_form)
104 .map_err(|e| LemmyError::from_error_message(e, "couldnt_mark_post_as_read"))
107 #[tracing::instrument(skip_all)]
108 pub async fn mark_post_as_unread(
112 ) -> Result<usize, LemmyError> {
113 let post_read_form = PostReadForm { post_id, person_id };
115 blocking(pool, move |conn| {
116 PostRead::mark_as_unread(conn, &post_read_form)
119 .map_err(|e| LemmyError::from_error_message(e, "couldnt_mark_post_as_read"))
122 #[tracing::instrument(skip_all)]
123 pub async fn get_local_user_view_from_jwt(
127 ) -> Result<LocalUserView, LemmyError> {
128 let claims = Claims::decode(jwt, &secret.jwt_secret)
129 .map_err(|e| e.with_message("not_logged_in"))?
131 let local_user_id = LocalUserId(claims.sub);
132 let local_user_view =
133 blocking(pool, move |conn| LocalUserView::read(conn, local_user_id)).await??;
135 local_user_view.person.banned,
136 local_user_view.person.ban_expires,
137 local_user_view.person.deleted,
140 check_validator_time(&local_user_view.local_user.validator_time, &claims)?;
145 /// Checks if user's token was issued before user's password reset.
146 pub fn check_validator_time(
147 validator_time: &NaiveDateTime,
149 ) -> Result<(), LemmyError> {
150 let user_validation_time = validator_time.timestamp();
151 if user_validation_time > claims.iat {
152 Err(LemmyError::from_message("not_logged_in"))
158 #[tracing::instrument(skip_all)]
159 pub async fn get_local_user_view_from_jwt_opt(
160 jwt: Option<&Sensitive<String>>,
163 ) -> Result<Option<LocalUserView>, LemmyError> {
165 Some(jwt) => Ok(Some(get_local_user_view_from_jwt(jwt, pool, secret).await?)),
170 #[tracing::instrument(skip_all)]
171 pub async fn get_local_user_settings_view_from_jwt_opt(
172 jwt: Option<&Sensitive<String>>,
175 ) -> Result<Option<LocalUserSettingsView>, LemmyError> {
178 let claims = Claims::decode(jwt.as_ref(), &secret.jwt_secret)
179 .map_err(|e| e.with_message("not_logged_in"))?
181 let local_user_id = LocalUserId(claims.sub);
182 let local_user_view = blocking(pool, move |conn| {
183 LocalUserSettingsView::read(conn, local_user_id)
187 local_user_view.person.banned,
188 local_user_view.person.ban_expires,
189 local_user_view.person.deleted,
192 check_validator_time(&local_user_view.local_user.validator_time, &claims)?;
194 Ok(Some(local_user_view))
199 pub fn check_user_valid(
201 ban_expires: Option<NaiveDateTime>,
203 ) -> Result<(), LemmyError> {
204 // Check for a site ban
205 if is_banned(banned, ban_expires) {
206 return Err(LemmyError::from_message("site_ban"));
209 // check for account deletion
211 return Err(LemmyError::from_message("deleted"));
217 #[tracing::instrument(skip_all)]
218 pub async fn check_community_ban(
220 community_id: CommunityId,
222 ) -> Result<(), LemmyError> {
224 move |conn: &'_ _| CommunityPersonBanView::get(conn, person_id, community_id).is_ok();
225 if blocking(pool, is_banned).await? {
226 Err(LemmyError::from_message("community_ban"))
232 #[tracing::instrument(skip_all)]
233 pub async fn check_community_deleted_or_removed(
234 community_id: CommunityId,
236 ) -> Result<(), LemmyError> {
237 let community = blocking(pool, move |conn| Community::read(conn, community_id))
239 .map_err(|e| LemmyError::from_error_message(e, "couldnt_find_community"))?;
240 if community.deleted || community.removed {
241 Err(LemmyError::from_message("deleted"))
247 pub fn check_post_deleted_or_removed(post: &Post) -> Result<(), LemmyError> {
248 if post.deleted || post.removed {
249 Err(LemmyError::from_message("deleted"))
255 #[tracing::instrument(skip_all)]
256 pub async fn check_person_block(
258 potential_blocker_id: PersonId,
260 ) -> Result<(), LemmyError> {
261 let is_blocked = move |conn: &'_ _| PersonBlock::read(conn, potential_blocker_id, my_id).is_ok();
262 if blocking(pool, is_blocked).await? {
263 Err(LemmyError::from_message("person_block"))
269 #[tracing::instrument(skip_all)]
270 pub async fn check_downvotes_enabled(score: i16, pool: &DbPool) -> Result<(), LemmyError> {
272 let site = blocking(pool, Site::read_local_site).await??;
273 if !site.enable_downvotes {
274 return Err(LemmyError::from_message("downvotes_disabled"));
280 #[tracing::instrument(skip_all)]
281 pub async fn check_private_instance(
282 local_user_view: &Option<LocalUserView>,
284 ) -> Result<(), LemmyError> {
285 if local_user_view.is_none() {
286 let site = blocking(pool, Site::read_local_site).await?;
288 // The site might not be set up yet
289 if let Ok(site) = site {
290 if site.private_instance {
291 return Err(LemmyError::from_message("instance_is_private"));
298 #[tracing::instrument(skip_all)]
299 pub async fn build_federated_instances(
302 ) -> Result<Option<FederatedInstances>, LemmyError> {
303 let federation_config = &settings.federation;
304 let hostname = &settings.hostname;
305 let federation = federation_config.to_owned();
306 if federation.enabled {
307 let distinct_communities = blocking(pool, move |conn| {
308 Community::distinct_federated_communities(conn)
312 let allowed = federation.allowed_instances;
313 let blocked = federation.blocked_instances;
315 let mut linked = distinct_communities
317 .map(|actor_id| Ok(actor_id.host_str().unwrap_or("").to_string()))
318 .collect::<Result<Vec<String>, LemmyError>>()?;
320 if let Some(allowed) = allowed.as_ref() {
321 linked.extend_from_slice(allowed);
324 if let Some(blocked) = blocked.as_ref() {
325 linked.retain(|a| !blocked.contains(a) && !a.eq(hostname));
328 // Sort and remove dupes
329 linked.sort_unstable();
332 Ok(Some(FederatedInstances {
342 /// Checks the password length
343 pub fn password_length_check(pass: &str) -> Result<(), LemmyError> {
344 if !(10..=60).contains(&pass.len()) {
345 Err(LemmyError::from_message("invalid_password"))
351 /// Checks the site description length
352 pub fn site_description_length_check(description: &str) -> Result<(), LemmyError> {
353 if description.len() > 150 {
354 Err(LemmyError::from_message("site_description_length_overflow"))
360 /// Checks for a honeypot. If this field is filled, fail the rest of the function
361 pub fn honeypot_check(honeypot: &Option<String>) -> Result<(), LemmyError> {
362 if honeypot.is_some() {
363 Err(LemmyError::from_message("honeypot_fail"))
369 pub fn send_email_to_user(
370 local_user_view: &LocalUserView,
375 if local_user_view.person.banned || !local_user_view.local_user.send_notifications_to_email {
379 if let Some(user_email) = &local_user_view.local_user.email {
383 &local_user_view.person.name,
388 Err(e) => warn!("{}", e),
393 pub async fn send_password_reset_email(
394 user: &LocalUserView,
397 ) -> Result<(), LemmyError> {
398 // Generate a random token
399 let token = generate_random_string();
402 let token2 = token.clone();
403 let local_user_id = user.local_user.id;
404 blocking(pool, move |conn| {
405 PasswordResetRequest::create_token(conn, local_user_id, &token2)
409 let email = &user.local_user.email.to_owned().expect("email");
410 let lang = get_user_lang(user);
411 let subject = &lang.password_reset_subject(&user.person.name);
412 let protocol_and_hostname = settings.get_protocol_and_hostname();
413 let reset_link = format!("{}/password_change/{}", protocol_and_hostname, &token);
414 let body = &lang.password_reset_body(reset_link, &user.person.name);
415 send_email(subject, email, &user.person.name, body, settings)
418 /// Send a verification email
419 pub async fn send_verification_email(
420 user: &LocalUserView,
424 ) -> Result<(), LemmyError> {
425 let form = EmailVerificationForm {
426 local_user_id: user.local_user.id,
427 email: new_email.to_string(),
428 verification_token: generate_random_string(),
430 let verify_link = format!(
431 "{}/verify_email/{}",
432 settings.get_protocol_and_hostname(),
433 &form.verification_token
435 blocking(pool, move |conn| EmailVerification::create(conn, &form)).await??;
437 let lang = get_user_lang(user);
438 let subject = lang.verify_email_subject(&settings.hostname);
439 let body = lang.verify_email_body(&settings.hostname, &user.person.name, verify_link);
440 send_email(&subject, new_email, &user.person.name, &body, settings)?;
445 pub fn send_email_verification_success(
446 user: &LocalUserView,
448 ) -> Result<(), LemmyError> {
449 let email = &user.local_user.email.to_owned().expect("email");
450 let lang = get_user_lang(user);
451 let subject = &lang.email_verified_subject(&user.person.actor_id);
452 let body = &lang.email_verified_body();
453 send_email(subject, email, &user.person.name, body, settings)
456 pub fn get_user_lang(user: &LocalUserView) -> Lang {
457 let user_lang = LanguageId::new(user.local_user.lang.clone());
458 Lang::from_language_id(&user_lang).unwrap_or_else(|| {
459 let en = LanguageId::new("en");
460 Lang::from_language_id(&en).expect("default language")
464 pub fn send_application_approved_email(
465 user: &LocalUserView,
467 ) -> Result<(), LemmyError> {
468 let email = &user.local_user.email.to_owned().expect("email");
469 let lang = get_user_lang(user);
470 let subject = lang.registration_approved_subject(&user.person.actor_id);
471 let body = lang.registration_approved_body(&settings.hostname);
472 send_email(&subject, email, &user.person.name, &body, settings)
475 pub async fn check_registration_application(
477 local_user_view: &LocalUserView,
479 ) -> Result<(), LemmyError> {
480 if site.require_application
481 && !local_user_view.local_user.accepted_application
482 && !local_user_view.person.admin
484 // Fetch the registration, see if its denied
485 let local_user_id = local_user_view.local_user.id;
486 let registration = blocking(pool, move |conn| {
487 RegistrationApplication::find_by_local_user_id(conn, local_user_id)
490 if let Some(deny_reason) = registration.deny_reason {
491 let lang = get_user_lang(local_user_view);
492 let registration_denied_message = format!("{}: {}", lang.registration_denied(), &deny_reason);
493 return Err(LemmyError::from_message(®istration_denied_message));
495 return Err(LemmyError::from_message("registration_application_pending"));
501 /// TODO this check should be removed after https://github.com/LemmyNet/lemmy/issues/868 is done.
502 pub async fn check_private_instance_and_federation_enabled(
505 ) -> Result<(), LemmyError> {
506 let site_opt = blocking(pool, Site::read_local_site).await?;
508 if let Ok(site) = site_opt {
509 if site.private_instance && settings.federation.enabled {
510 return Err(LemmyError::from_message(
511 "Cannot have both private instance and federation enabled.",
518 pub async fn purge_image_posts_for_person(
519 banned_person_id: PersonId,
522 client: &ClientWithMiddleware,
523 ) -> Result<(), LemmyError> {
524 let posts = blocking(pool, move |conn: &'_ _| {
525 Post::fetch_pictrs_posts_for_creator(conn, banned_person_id)
529 if let Some(url) = post.url {
530 purge_image_from_pictrs(client, settings, &url).await.ok();
532 if let Some(thumbnail_url) = post.thumbnail_url {
533 purge_image_from_pictrs(client, settings, &thumbnail_url)
539 blocking(pool, move |conn| {
540 Post::remove_pictrs_post_images_and_thumbnails_for_creator(conn, banned_person_id)
547 pub async fn purge_image_posts_for_community(
548 banned_community_id: CommunityId,
551 client: &ClientWithMiddleware,
552 ) -> Result<(), LemmyError> {
553 let posts = blocking(pool, move |conn: &'_ _| {
554 Post::fetch_pictrs_posts_for_community(conn, banned_community_id)
558 if let Some(url) = post.url {
559 purge_image_from_pictrs(client, settings, &url).await.ok();
561 if let Some(thumbnail_url) = post.thumbnail_url {
562 purge_image_from_pictrs(client, settings, &thumbnail_url)
568 blocking(pool, move |conn| {
569 Post::remove_pictrs_post_images_and_thumbnails_for_community(conn, banned_community_id)
576 pub async fn remove_user_data(
577 banned_person_id: PersonId,
580 client: &ClientWithMiddleware,
581 ) -> Result<(), LemmyError> {
583 let person = blocking(pool, move |conn| Person::read(conn, banned_person_id)).await??;
584 if let Some(avatar) = person.avatar {
585 purge_image_from_pictrs(client, settings, &avatar)
589 if let Some(banner) = person.banner {
590 purge_image_from_pictrs(client, settings, &banner)
595 // Update the fields to None
596 blocking(pool, move |conn| {
597 Person::remove_avatar_and_banner(conn, banned_person_id)
602 blocking(pool, move |conn: &'_ _| {
603 Post::update_removed_for_creator(conn, banned_person_id, None, true)
608 purge_image_posts_for_person(banned_person_id, pool, settings, client).await?;
611 // Remove all communities where they're the top mod
612 // for now, remove the communities manually
613 let first_mod_communities = blocking(pool, move |conn: &'_ _| {
614 CommunityModeratorView::get_community_first_mods(conn)
618 // Filter to only this banned users top communities
619 let banned_user_first_communities: Vec<CommunityModeratorView> = first_mod_communities
621 .filter(|fmc| fmc.moderator.id == banned_person_id)
624 for first_mod_community in banned_user_first_communities {
625 let community_id = first_mod_community.community.id;
626 blocking(pool, move |conn: &'_ _| {
627 Community::update_removed(conn, community_id, true)
631 // Delete the community images
632 if let Some(icon) = first_mod_community.community.icon {
633 purge_image_from_pictrs(client, settings, &icon).await.ok();
635 if let Some(banner) = first_mod_community.community.banner {
636 purge_image_from_pictrs(client, settings, &banner)
640 // Update the fields to None
641 blocking(pool, move |conn| {
642 Community::remove_avatar_and_banner(conn, community_id)
648 blocking(pool, move |conn: &'_ _| {
649 Comment::update_removed_for_creator(conn, banned_person_id, true)
656 pub async fn remove_user_data_in_community(
657 community_id: CommunityId,
658 banned_person_id: PersonId,
660 ) -> Result<(), LemmyError> {
662 blocking(pool, move |conn| {
663 Post::update_removed_for_creator(conn, banned_person_id, Some(community_id), true)
668 // TODO Diesel doesn't allow updates with joins, so this has to be a loop
669 let comments = blocking(pool, move |conn| {
670 CommentQuery::builder()
672 .creator_id(Some(banned_person_id))
673 .community_id(Some(community_id))
674 .limit(Some(i64::MAX))
680 for comment_view in &comments {
681 let comment_id = comment_view.comment.id;
682 blocking(pool, move |conn| {
683 Comment::update_removed(conn, comment_id, true)
691 pub async fn delete_user_account(
695 client: &ClientWithMiddleware,
696 ) -> Result<(), LemmyError> {
697 // Delete their images
698 let person = blocking(pool, move |conn| Person::read(conn, person_id)).await??;
699 if let Some(avatar) = person.avatar {
700 purge_image_from_pictrs(client, settings, &avatar)
704 if let Some(banner) = person.banner {
705 purge_image_from_pictrs(client, settings, &banner)
709 // No need to update avatar and banner, those are handled in Person::delete_account
712 let permadelete = move |conn: &'_ _| Comment::permadelete_for_creator(conn, person_id);
713 blocking(pool, permadelete)
715 .map_err(|e| LemmyError::from_error_message(e, "couldnt_update_comment"))?;
718 let permadelete = move |conn: &'_ _| Post::permadelete_for_creator(conn, person_id);
719 blocking(pool, permadelete)
721 .map_err(|e| LemmyError::from_error_message(e, "couldnt_update_post"))?;
724 purge_image_posts_for_person(person_id, pool, settings, client).await?;
726 blocking(pool, move |conn| Person::delete_account(conn, person_id)).await??;
731 pub async fn listing_type_with_site_default(
732 listing_type: Option<ListingType>,
734 ) -> Result<ListingType, LemmyError> {
735 Ok(match listing_type {
738 let site = blocking(pool, Site::read_local_site).await??;
739 ListingType::from_str(&site.default_post_listing_type)?