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(&mut diesel::PgConnection) -> T + Send + 'static,
48 let pool = pool.clone();
49 let blocking_span = tracing::info_span!("blocking operation");
50 actix_web::web::block(move || {
51 let entered = blocking_span.enter();
52 let mut conn = pool.get()?;
53 let res = (f)(&mut conn);
55 Ok(res) as Result<T, LemmyError>
60 #[tracing::instrument(skip_all)]
61 pub async fn is_mod_or_admin(
64 community_id: CommunityId,
65 ) -> Result<(), LemmyError> {
66 let is_mod_or_admin = blocking(pool, move |conn| {
67 CommunityView::is_mod_or_admin(conn, person_id, community_id)
71 return Err(LemmyError::from_message("not_a_mod_or_admin"));
76 pub fn is_admin(local_user_view: &LocalUserView) -> Result<(), LemmyError> {
77 if !local_user_view.person.admin {
78 return Err(LemmyError::from_message("not_an_admin"));
83 #[tracing::instrument(skip_all)]
84 pub async fn get_post(post_id: PostId, pool: &DbPool) -> Result<Post, LemmyError> {
85 blocking(pool, move |conn| Post::read(conn, post_id))
87 .map_err(|e| LemmyError::from_error_message(e, "couldnt_find_post"))
90 #[tracing::instrument(skip_all)]
91 pub async fn mark_post_as_read(
95 ) -> Result<PostRead, LemmyError> {
96 let post_read_form = PostReadForm { post_id, person_id };
98 blocking(pool, move |conn| {
99 PostRead::mark_as_read(conn, &post_read_form)
102 .map_err(|e| LemmyError::from_error_message(e, "couldnt_mark_post_as_read"))
105 #[tracing::instrument(skip_all)]
106 pub async fn mark_post_as_unread(
110 ) -> Result<usize, LemmyError> {
111 let post_read_form = PostReadForm { post_id, person_id };
113 blocking(pool, move |conn| {
114 PostRead::mark_as_unread(conn, &post_read_form)
117 .map_err(|e| LemmyError::from_error_message(e, "couldnt_mark_post_as_read"))
120 #[tracing::instrument(skip_all)]
121 pub async fn get_local_user_view_from_jwt(
125 ) -> Result<LocalUserView, LemmyError> {
126 let claims = Claims::decode(jwt, &secret.jwt_secret)
127 .map_err(|e| e.with_message("not_logged_in"))?
129 let local_user_id = LocalUserId(claims.sub);
130 let local_user_view =
131 blocking(pool, move |conn| LocalUserView::read(conn, local_user_id)).await??;
133 local_user_view.person.banned,
134 local_user_view.person.ban_expires,
135 local_user_view.person.deleted,
138 check_validator_time(&local_user_view.local_user.validator_time, &claims)?;
143 /// Checks if user's token was issued before user's password reset.
144 pub fn check_validator_time(
145 validator_time: &NaiveDateTime,
147 ) -> Result<(), LemmyError> {
148 let user_validation_time = validator_time.timestamp();
149 if user_validation_time > claims.iat {
150 Err(LemmyError::from_message("not_logged_in"))
156 #[tracing::instrument(skip_all)]
157 pub async fn get_local_user_view_from_jwt_opt(
158 jwt: Option<&Sensitive<String>>,
161 ) -> Result<Option<LocalUserView>, LemmyError> {
163 Some(jwt) => Ok(Some(get_local_user_view_from_jwt(jwt, pool, secret).await?)),
168 #[tracing::instrument(skip_all)]
169 pub async fn get_local_user_settings_view_from_jwt_opt(
170 jwt: Option<&Sensitive<String>>,
173 ) -> Result<Option<LocalUserSettingsView>, LemmyError> {
176 let claims = Claims::decode(jwt.as_ref(), &secret.jwt_secret)
177 .map_err(|e| e.with_message("not_logged_in"))?
179 let local_user_id = LocalUserId(claims.sub);
180 let local_user_view = blocking(pool, move |conn| {
181 LocalUserSettingsView::read(conn, local_user_id)
185 local_user_view.person.banned,
186 local_user_view.person.ban_expires,
187 local_user_view.person.deleted,
190 check_validator_time(&local_user_view.local_user.validator_time, &claims)?;
192 Ok(Some(local_user_view))
197 pub fn check_user_valid(
199 ban_expires: Option<NaiveDateTime>,
201 ) -> Result<(), LemmyError> {
202 // Check for a site ban
203 if is_banned(banned, ban_expires) {
204 return Err(LemmyError::from_message("site_ban"));
207 // check for account deletion
209 return Err(LemmyError::from_message("deleted"));
215 #[tracing::instrument(skip_all)]
216 pub async fn check_community_ban(
218 community_id: CommunityId,
220 ) -> Result<(), LemmyError> {
222 move |conn: &mut _| CommunityPersonBanView::get(conn, person_id, community_id).is_ok();
223 if blocking(pool, is_banned).await? {
224 Err(LemmyError::from_message("community_ban"))
230 #[tracing::instrument(skip_all)]
231 pub async fn check_community_deleted_or_removed(
232 community_id: CommunityId,
234 ) -> Result<(), LemmyError> {
235 let community = blocking(pool, move |conn| Community::read(conn, community_id))
237 .map_err(|e| LemmyError::from_error_message(e, "couldnt_find_community"))?;
238 if community.deleted || community.removed {
239 Err(LemmyError::from_message("deleted"))
245 pub fn check_post_deleted_or_removed(post: &Post) -> Result<(), LemmyError> {
246 if post.deleted || post.removed {
247 Err(LemmyError::from_message("deleted"))
253 #[tracing::instrument(skip_all)]
254 pub async fn check_person_block(
256 potential_blocker_id: PersonId,
258 ) -> Result<(), LemmyError> {
259 let is_blocked = move |conn: &mut _| PersonBlock::read(conn, potential_blocker_id, my_id).is_ok();
260 if blocking(pool, is_blocked).await? {
261 Err(LemmyError::from_message("person_block"))
267 #[tracing::instrument(skip_all)]
268 pub async fn check_downvotes_enabled(score: i16, pool: &DbPool) -> Result<(), LemmyError> {
270 let site = blocking(pool, Site::read_local_site).await??;
271 if !site.enable_downvotes {
272 return Err(LemmyError::from_message("downvotes_disabled"));
278 #[tracing::instrument(skip_all)]
279 pub async fn check_private_instance(
280 local_user_view: &Option<LocalUserView>,
282 ) -> Result<(), LemmyError> {
283 if local_user_view.is_none() {
284 let site = blocking(pool, Site::read_local_site).await?;
286 // The site might not be set up yet
287 if let Ok(site) = site {
288 if site.private_instance {
289 return Err(LemmyError::from_message("instance_is_private"));
296 #[tracing::instrument(skip_all)]
297 pub async fn build_federated_instances(
300 ) -> Result<Option<FederatedInstances>, LemmyError> {
301 let federation_config = &settings.federation;
302 let hostname = &settings.hostname;
303 let federation = federation_config.to_owned();
304 if federation.enabled {
305 let distinct_communities = blocking(pool, move |conn| {
306 Community::distinct_federated_communities(conn)
310 let allowed = federation.allowed_instances;
311 let blocked = federation.blocked_instances;
313 let mut linked = distinct_communities
315 .map(|actor_id| Ok(actor_id.host_str().unwrap_or("").to_string()))
316 .collect::<Result<Vec<String>, LemmyError>>()?;
318 if let Some(allowed) = allowed.as_ref() {
319 linked.extend_from_slice(allowed);
322 if let Some(blocked) = blocked.as_ref() {
323 linked.retain(|a| !blocked.contains(a) && !a.eq(hostname));
326 // Sort and remove dupes
327 linked.sort_unstable();
330 Ok(Some(FederatedInstances {
340 /// Checks the password length
341 pub fn password_length_check(pass: &str) -> Result<(), LemmyError> {
342 if !(10..=60).contains(&pass.len()) {
343 Err(LemmyError::from_message("invalid_password"))
349 /// Checks the site description length
350 pub fn site_description_length_check(description: &str) -> Result<(), LemmyError> {
351 if description.len() > 150 {
352 Err(LemmyError::from_message("site_description_length_overflow"))
358 /// Checks for a honeypot. If this field is filled, fail the rest of the function
359 pub fn honeypot_check(honeypot: &Option<String>) -> Result<(), LemmyError> {
360 if honeypot.is_some() {
361 Err(LemmyError::from_message("honeypot_fail"))
367 pub fn send_email_to_user(
368 local_user_view: &LocalUserView,
373 if local_user_view.person.banned || !local_user_view.local_user.send_notifications_to_email {
377 if let Some(user_email) = &local_user_view.local_user.email {
381 &local_user_view.person.name,
386 Err(e) => warn!("{}", e),
391 pub async fn send_password_reset_email(
392 user: &LocalUserView,
395 ) -> Result<(), LemmyError> {
396 // Generate a random token
397 let token = generate_random_string();
400 let token2 = token.clone();
401 let local_user_id = user.local_user.id;
402 blocking(pool, move |conn| {
403 PasswordResetRequest::create_token(conn, local_user_id, &token2)
407 let email = &user.local_user.email.to_owned().expect("email");
408 let lang = get_interface_language(user);
409 let subject = &lang.password_reset_subject(&user.person.name);
410 let protocol_and_hostname = settings.get_protocol_and_hostname();
411 let reset_link = format!("{}/password_change/{}", protocol_and_hostname, &token);
412 let body = &lang.password_reset_body(reset_link, &user.person.name);
413 send_email(subject, email, &user.person.name, body, settings)
416 /// Send a verification email
417 pub async fn send_verification_email(
418 user: &LocalUserView,
422 ) -> Result<(), LemmyError> {
423 let form = EmailVerificationForm {
424 local_user_id: user.local_user.id,
425 email: new_email.to_string(),
426 verification_token: generate_random_string(),
428 let verify_link = format!(
429 "{}/verify_email/{}",
430 settings.get_protocol_and_hostname(),
431 &form.verification_token
433 blocking(pool, move |conn| EmailVerification::create(conn, &form)).await??;
435 let lang = get_interface_language(user);
436 let subject = lang.verify_email_subject(&settings.hostname);
437 let body = lang.verify_email_body(&settings.hostname, &user.person.name, verify_link);
438 send_email(&subject, new_email, &user.person.name, &body, settings)?;
443 pub fn send_email_verification_success(
444 user: &LocalUserView,
446 ) -> Result<(), LemmyError> {
447 let email = &user.local_user.email.to_owned().expect("email");
448 let lang = get_interface_language(user);
449 let subject = &lang.email_verified_subject(&user.person.actor_id);
450 let body = &lang.email_verified_body();
451 send_email(subject, email, &user.person.name, body, settings)
454 pub fn get_interface_language(user: &LocalUserView) -> Lang {
455 lang_str_to_lang(&user.local_user.interface_language)
458 pub fn get_interface_language_from_settings(user: &LocalUserSettingsView) -> Lang {
459 lang_str_to_lang(&user.local_user.interface_language)
462 fn lang_str_to_lang(lang: &str) -> Lang {
463 let lang_id = LanguageId::new(lang);
464 Lang::from_language_id(&lang_id).unwrap_or_else(|| {
465 let en = LanguageId::new("en");
466 Lang::from_language_id(&en).expect("default language")
470 pub fn send_application_approved_email(
471 user: &LocalUserView,
473 ) -> Result<(), LemmyError> {
474 let email = &user.local_user.email.to_owned().expect("email");
475 let lang = get_interface_language(user);
476 let subject = lang.registration_approved_subject(&user.person.actor_id);
477 let body = lang.registration_approved_body(&settings.hostname);
478 send_email(&subject, email, &user.person.name, &body, settings)
481 /// Send a new applicant email notification to all admins
482 pub async fn send_new_applicant_email_to_admins(
483 applicant_username: &str,
486 ) -> Result<(), LemmyError> {
487 // Collect the admins with emails
488 let admins = blocking(pool, move |conn| {
489 LocalUserSettingsView::list_admins_with_emails(conn)
493 let applications_link = &format!(
494 "{}/registration_applications",
495 settings.get_protocol_and_hostname(),
498 for admin in &admins {
499 let email = &admin.local_user.email.to_owned().expect("email");
500 let lang = get_interface_language_from_settings(admin);
501 let subject = lang.new_application_subject(applicant_username, &settings.hostname);
502 let body = lang.new_application_body(applications_link);
503 send_email(&subject, email, &admin.person.name, &body, settings)?;
508 pub async fn check_registration_application(
510 local_user_view: &LocalUserView,
512 ) -> Result<(), LemmyError> {
513 if site.require_application
514 && !local_user_view.local_user.accepted_application
515 && !local_user_view.person.admin
517 // Fetch the registration, see if its denied
518 let local_user_id = local_user_view.local_user.id;
519 let registration = blocking(pool, move |conn| {
520 RegistrationApplication::find_by_local_user_id(conn, local_user_id)
523 if let Some(deny_reason) = registration.deny_reason {
524 let lang = get_interface_language(local_user_view);
525 let registration_denied_message = format!("{}: {}", lang.registration_denied(), &deny_reason);
526 return Err(LemmyError::from_message(®istration_denied_message));
528 return Err(LemmyError::from_message("registration_application_pending"));
534 /// TODO this check should be removed after https://github.com/LemmyNet/lemmy/issues/868 is done.
535 pub async fn check_private_instance_and_federation_enabled(
538 ) -> Result<(), LemmyError> {
539 let site_opt = blocking(pool, Site::read_local_site).await?;
541 if let Ok(site) = site_opt {
542 if site.private_instance && settings.federation.enabled {
543 return Err(LemmyError::from_message(
544 "Cannot have both private instance and federation enabled.",
551 pub async fn purge_image_posts_for_person(
552 banned_person_id: PersonId,
555 client: &ClientWithMiddleware,
556 ) -> Result<(), LemmyError> {
557 let posts = blocking(pool, move |conn: &mut _| {
558 Post::fetch_pictrs_posts_for_creator(conn, banned_person_id)
562 if let Some(url) = post.url {
563 purge_image_from_pictrs(client, settings, &url).await.ok();
565 if let Some(thumbnail_url) = post.thumbnail_url {
566 purge_image_from_pictrs(client, settings, &thumbnail_url)
572 blocking(pool, move |conn| {
573 Post::remove_pictrs_post_images_and_thumbnails_for_creator(conn, banned_person_id)
580 pub async fn purge_image_posts_for_community(
581 banned_community_id: CommunityId,
584 client: &ClientWithMiddleware,
585 ) -> Result<(), LemmyError> {
586 let posts = blocking(pool, move |conn: &mut _| {
587 Post::fetch_pictrs_posts_for_community(conn, banned_community_id)
591 if let Some(url) = post.url {
592 purge_image_from_pictrs(client, settings, &url).await.ok();
594 if let Some(thumbnail_url) = post.thumbnail_url {
595 purge_image_from_pictrs(client, settings, &thumbnail_url)
601 blocking(pool, move |conn| {
602 Post::remove_pictrs_post_images_and_thumbnails_for_community(conn, banned_community_id)
609 pub async fn remove_user_data(
610 banned_person_id: PersonId,
613 client: &ClientWithMiddleware,
614 ) -> Result<(), LemmyError> {
616 let person = blocking(pool, move |conn| Person::read(conn, banned_person_id)).await??;
617 if let Some(avatar) = person.avatar {
618 purge_image_from_pictrs(client, settings, &avatar)
622 if let Some(banner) = person.banner {
623 purge_image_from_pictrs(client, settings, &banner)
628 // Update the fields to None
629 blocking(pool, move |conn| {
630 Person::remove_avatar_and_banner(conn, banned_person_id)
635 blocking(pool, move |conn: &mut _| {
636 Post::update_removed_for_creator(conn, banned_person_id, None, true)
641 purge_image_posts_for_person(banned_person_id, pool, settings, client).await?;
644 // Remove all communities where they're the top mod
645 // for now, remove the communities manually
646 let first_mod_communities = blocking(pool, move |conn: &mut _| {
647 CommunityModeratorView::get_community_first_mods(conn)
651 // Filter to only this banned users top communities
652 let banned_user_first_communities: Vec<CommunityModeratorView> = first_mod_communities
654 .filter(|fmc| fmc.moderator.id == banned_person_id)
657 for first_mod_community in banned_user_first_communities {
658 let community_id = first_mod_community.community.id;
659 blocking(pool, move |conn: &mut _| {
660 Community::update_removed(conn, community_id, true)
664 // Delete the community images
665 if let Some(icon) = first_mod_community.community.icon {
666 purge_image_from_pictrs(client, settings, &icon).await.ok();
668 if let Some(banner) = first_mod_community.community.banner {
669 purge_image_from_pictrs(client, settings, &banner)
673 // Update the fields to None
674 blocking(pool, move |conn| {
675 Community::remove_avatar_and_banner(conn, community_id)
681 blocking(pool, move |conn: &mut _| {
682 Comment::update_removed_for_creator(conn, banned_person_id, true)
689 pub async fn remove_user_data_in_community(
690 community_id: CommunityId,
691 banned_person_id: PersonId,
693 ) -> Result<(), LemmyError> {
695 blocking(pool, move |conn| {
696 Post::update_removed_for_creator(conn, banned_person_id, Some(community_id), true)
701 // TODO Diesel doesn't allow updates with joins, so this has to be a loop
702 let comments = blocking(pool, move |conn| {
703 CommentQuery::builder()
705 .creator_id(Some(banned_person_id))
706 .community_id(Some(community_id))
707 .limit(Some(i64::MAX))
713 for comment_view in &comments {
714 let comment_id = comment_view.comment.id;
715 blocking(pool, move |conn| {
716 Comment::update_removed(conn, comment_id, true)
724 pub async fn delete_user_account(
728 client: &ClientWithMiddleware,
729 ) -> Result<(), LemmyError> {
730 // Delete their images
731 let person = blocking(pool, move |conn| Person::read(conn, person_id)).await??;
732 if let Some(avatar) = person.avatar {
733 purge_image_from_pictrs(client, settings, &avatar)
737 if let Some(banner) = person.banner {
738 purge_image_from_pictrs(client, settings, &banner)
742 // No need to update avatar and banner, those are handled in Person::delete_account
745 let permadelete = move |conn: &mut _| Comment::permadelete_for_creator(conn, person_id);
746 blocking(pool, permadelete)
748 .map_err(|e| LemmyError::from_error_message(e, "couldnt_update_comment"))?;
751 let permadelete = move |conn: &mut _| Post::permadelete_for_creator(conn, person_id);
752 blocking(pool, permadelete)
754 .map_err(|e| LemmyError::from_error_message(e, "couldnt_update_post"))?;
757 purge_image_posts_for_person(person_id, pool, settings, client).await?;
759 blocking(pool, move |conn| Person::delete_account(conn, person_id)).await??;
764 pub async fn listing_type_with_site_default(
765 listing_type: Option<ListingType>,
767 ) -> Result<ListingType, LemmyError> {
768 Ok(match listing_type {
771 let site = blocking(pool, Site::read_local_site).await??;
772 ListingType::from_str(&site.default_post_listing_type)?