]> Untitled Git - lemmy.git/blob - crates/api_common/src/utils.rs
Adding admin purging of DB items and pictures. #904 #1331 (#1809)
[lemmy.git] / crates / api_common / src / utils.rs
1 use crate::{request::purge_image_from_pictrs, sensitive::Sensitive, site::FederatedInstances};
2 use lemmy_db_schema::{
3   newtypes::{CommunityId, LocalUserId, PersonId, PostId},
4   source::{
5     comment::Comment,
6     community::Community,
7     email_verification::{EmailVerification, EmailVerificationForm},
8     password_reset_request::PasswordResetRequest,
9     person::Person,
10     person_block::PersonBlock,
11     post::{Post, PostRead, PostReadForm},
12     registration_application::RegistrationApplication,
13     secret::Secret,
14     site::Site,
15   },
16   traits::{Crud, Readable},
17   utils::DbPool,
18 };
19 use lemmy_db_views::{
20   comment_view::CommentQueryBuilder,
21   structs::{LocalUserSettingsView, LocalUserView},
22 };
23 use lemmy_db_views_actor::structs::{
24   CommunityModeratorView,
25   CommunityPersonBanView,
26   CommunityView,
27 };
28 use lemmy_utils::{
29   claims::Claims,
30   email::{send_email, translations::Lang},
31   error::LemmyError,
32   settings::structs::Settings,
33   utils::generate_random_string,
34 };
35 use reqwest_middleware::ClientWithMiddleware;
36 use rosetta_i18n::{Language, LanguageId};
37 use tracing::warn;
38
39 pub async fn blocking<F, T>(pool: &DbPool, f: F) -> Result<T, LemmyError>
40 where
41   F: FnOnce(&diesel::PgConnection) -> T + Send + 'static,
42   T: Send + 'static,
43 {
44   let pool = pool.clone();
45   let blocking_span = tracing::info_span!("blocking operation");
46   let res = actix_web::web::block(move || {
47     let entered = blocking_span.enter();
48     let conn = pool.get()?;
49     let res = (f)(&conn);
50     drop(entered);
51     Ok(res) as Result<T, LemmyError>
52   })
53   .await?;
54
55   res
56 }
57
58 #[tracing::instrument(skip_all)]
59 pub async fn is_mod_or_admin(
60   pool: &DbPool,
61   person_id: PersonId,
62   community_id: CommunityId,
63 ) -> Result<(), LemmyError> {
64   let is_mod_or_admin = blocking(pool, move |conn| {
65     CommunityView::is_mod_or_admin(conn, person_id, community_id)
66   })
67   .await?;
68   if !is_mod_or_admin {
69     return Err(LemmyError::from_message("not_a_mod_or_admin"));
70   }
71   Ok(())
72 }
73
74 pub fn is_admin(local_user_view: &LocalUserView) -> Result<(), LemmyError> {
75   if !local_user_view.person.admin {
76     return Err(LemmyError::from_message("not_an_admin"));
77   }
78   Ok(())
79 }
80
81 #[tracing::instrument(skip_all)]
82 pub async fn get_post(post_id: PostId, pool: &DbPool) -> Result<Post, LemmyError> {
83   blocking(pool, move |conn| Post::read(conn, post_id))
84     .await?
85     .map_err(|e| LemmyError::from_error_message(e, "couldnt_find_post"))
86 }
87
88 #[tracing::instrument(skip_all)]
89 pub async fn mark_post_as_read(
90   person_id: PersonId,
91   post_id: PostId,
92   pool: &DbPool,
93 ) -> Result<PostRead, LemmyError> {
94   let post_read_form = PostReadForm { post_id, person_id };
95
96   blocking(pool, move |conn| {
97     PostRead::mark_as_read(conn, &post_read_form)
98   })
99   .await?
100   .map_err(|e| LemmyError::from_error_message(e, "couldnt_mark_post_as_read"))
101 }
102
103 #[tracing::instrument(skip_all)]
104 pub async fn mark_post_as_unread(
105   person_id: PersonId,
106   post_id: PostId,
107   pool: &DbPool,
108 ) -> Result<usize, LemmyError> {
109   let post_read_form = PostReadForm { post_id, person_id };
110
111   blocking(pool, move |conn| {
112     PostRead::mark_as_unread(conn, &post_read_form)
113   })
114   .await?
115   .map_err(|e| LemmyError::from_error_message(e, "couldnt_mark_post_as_read"))
116 }
117
118 #[tracing::instrument(skip_all)]
119 pub async fn get_local_user_view_from_jwt(
120   jwt: &str,
121   pool: &DbPool,
122   secret: &Secret,
123 ) -> Result<LocalUserView, LemmyError> {
124   let claims = Claims::decode(jwt, &secret.jwt_secret)
125     .map_err(|e| e.with_message("not_logged_in"))?
126     .claims;
127   let local_user_id = LocalUserId(claims.sub);
128   let local_user_view =
129     blocking(pool, move |conn| LocalUserView::read(conn, local_user_id)).await??;
130   // Check for a site ban
131   if local_user_view.person.is_banned() {
132     return Err(LemmyError::from_message("site_ban"));
133   }
134
135   // Check for user deletion
136   if local_user_view.person.deleted {
137     return Err(LemmyError::from_message("deleted"));
138   }
139
140   check_validator_time(&local_user_view.local_user.validator_time, &claims)?;
141
142   Ok(local_user_view)
143 }
144
145 /// Checks if user's token was issued before user's password reset.
146 pub fn check_validator_time(
147   validator_time: &chrono::NaiveDateTime,
148   claims: &Claims,
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"))
153   } else {
154     Ok(())
155   }
156 }
157
158 #[tracing::instrument(skip_all)]
159 pub async fn get_local_user_view_from_jwt_opt(
160   jwt: Option<&Sensitive<String>>,
161   pool: &DbPool,
162   secret: &Secret,
163 ) -> Result<Option<LocalUserView>, LemmyError> {
164   match jwt {
165     Some(jwt) => Ok(Some(get_local_user_view_from_jwt(jwt, pool, secret).await?)),
166     None => Ok(None),
167   }
168 }
169
170 #[tracing::instrument(skip_all)]
171 pub async fn get_local_user_settings_view_from_jwt(
172   jwt: &Sensitive<String>,
173   pool: &DbPool,
174   secret: &Secret,
175 ) -> Result<LocalUserSettingsView, LemmyError> {
176   let claims = Claims::decode(jwt.as_ref(), &secret.jwt_secret)
177     .map_err(|e| e.with_message("not_logged_in"))?
178     .claims;
179   let local_user_id = LocalUserId(claims.sub);
180   let local_user_view = blocking(pool, move |conn| {
181     LocalUserSettingsView::read(conn, local_user_id)
182   })
183   .await??;
184   // Check for a site ban
185   if local_user_view.person.is_banned() {
186     return Err(LemmyError::from_message("site_ban"));
187   }
188
189   check_validator_time(&local_user_view.local_user.validator_time, &claims)?;
190
191   Ok(local_user_view)
192 }
193
194 #[tracing::instrument(skip_all)]
195 pub async fn get_local_user_settings_view_from_jwt_opt(
196   jwt: Option<&Sensitive<String>>,
197   pool: &DbPool,
198   secret: &Secret,
199 ) -> Result<Option<LocalUserSettingsView>, LemmyError> {
200   match jwt {
201     Some(jwt) => Ok(Some(
202       get_local_user_settings_view_from_jwt(jwt, pool, secret).await?,
203     )),
204     None => Ok(None),
205   }
206 }
207
208 #[tracing::instrument(skip_all)]
209 pub async fn check_community_ban(
210   person_id: PersonId,
211   community_id: CommunityId,
212   pool: &DbPool,
213 ) -> Result<(), LemmyError> {
214   let is_banned =
215     move |conn: &'_ _| CommunityPersonBanView::get(conn, person_id, community_id).is_ok();
216   if blocking(pool, is_banned).await? {
217     Err(LemmyError::from_message("community_ban"))
218   } else {
219     Ok(())
220   }
221 }
222
223 #[tracing::instrument(skip_all)]
224 pub async fn check_community_deleted_or_removed(
225   community_id: CommunityId,
226   pool: &DbPool,
227 ) -> Result<(), LemmyError> {
228   let community = blocking(pool, move |conn| Community::read(conn, community_id))
229     .await?
230     .map_err(|e| LemmyError::from_error_message(e, "couldnt_find_community"))?;
231   if community.deleted || community.removed {
232     Err(LemmyError::from_message("deleted"))
233   } else {
234     Ok(())
235   }
236 }
237
238 pub fn check_post_deleted_or_removed(post: &Post) -> Result<(), LemmyError> {
239   if post.deleted || post.removed {
240     Err(LemmyError::from_message("deleted"))
241   } else {
242     Ok(())
243   }
244 }
245
246 #[tracing::instrument(skip_all)]
247 pub async fn check_person_block(
248   my_id: PersonId,
249   potential_blocker_id: PersonId,
250   pool: &DbPool,
251 ) -> Result<(), LemmyError> {
252   let is_blocked = move |conn: &'_ _| PersonBlock::read(conn, potential_blocker_id, my_id).is_ok();
253   if blocking(pool, is_blocked).await? {
254     Err(LemmyError::from_message("person_block"))
255   } else {
256     Ok(())
257   }
258 }
259
260 #[tracing::instrument(skip_all)]
261 pub async fn check_downvotes_enabled(score: i16, pool: &DbPool) -> Result<(), LemmyError> {
262   if score == -1 {
263     let site = blocking(pool, Site::read_local_site).await??;
264     if !site.enable_downvotes {
265       return Err(LemmyError::from_message("downvotes_disabled"));
266     }
267   }
268   Ok(())
269 }
270
271 #[tracing::instrument(skip_all)]
272 pub async fn check_private_instance(
273   local_user_view: &Option<LocalUserView>,
274   pool: &DbPool,
275 ) -> Result<(), LemmyError> {
276   if local_user_view.is_none() {
277     let site = blocking(pool, Site::read_local_site).await?;
278
279     // The site might not be set up yet
280     if let Ok(site) = site {
281       if site.private_instance {
282         return Err(LemmyError::from_message("instance_is_private"));
283       }
284     }
285   }
286   Ok(())
287 }
288
289 #[tracing::instrument(skip_all)]
290 pub async fn build_federated_instances(
291   pool: &DbPool,
292   settings: &Settings,
293 ) -> Result<Option<FederatedInstances>, LemmyError> {
294   let federation_config = &settings.federation;
295   let hostname = &settings.hostname;
296   let federation = federation_config.to_owned();
297   if federation.enabled {
298     let distinct_communities = blocking(pool, move |conn| {
299       Community::distinct_federated_communities(conn)
300     })
301     .await??;
302
303     let allowed = federation.allowed_instances;
304     let blocked = federation.blocked_instances;
305
306     let mut linked = distinct_communities
307       .iter()
308       .map(|actor_id| Ok(actor_id.host_str().unwrap_or("").to_string()))
309       .collect::<Result<Vec<String>, LemmyError>>()?;
310
311     if let Some(allowed) = allowed.as_ref() {
312       linked.extend_from_slice(allowed);
313     }
314
315     if let Some(blocked) = blocked.as_ref() {
316       linked.retain(|a| !blocked.contains(a) && !a.eq(hostname));
317     }
318
319     // Sort and remove dupes
320     linked.sort_unstable();
321     linked.dedup();
322
323     Ok(Some(FederatedInstances {
324       linked,
325       allowed,
326       blocked,
327     }))
328   } else {
329     Ok(None)
330   }
331 }
332
333 /// Checks the password length
334 pub fn password_length_check(pass: &str) -> Result<(), LemmyError> {
335   if !(10..=60).contains(&pass.len()) {
336     Err(LemmyError::from_message("invalid_password"))
337   } else {
338     Ok(())
339   }
340 }
341
342 /// Checks the site description length
343 pub fn site_description_length_check(description: &str) -> Result<(), LemmyError> {
344   if description.len() > 150 {
345     Err(LemmyError::from_message("site_description_length_overflow"))
346   } else {
347     Ok(())
348   }
349 }
350
351 /// Checks for a honeypot. If this field is filled, fail the rest of the function
352 pub fn honeypot_check(honeypot: &Option<String>) -> Result<(), LemmyError> {
353   if honeypot.is_some() {
354     Err(LemmyError::from_message("honeypot_fail"))
355   } else {
356     Ok(())
357   }
358 }
359
360 pub fn send_email_to_user(
361   local_user_view: &LocalUserView,
362   subject: &str,
363   body: &str,
364   settings: &Settings,
365 ) {
366   if local_user_view.person.banned || !local_user_view.local_user.send_notifications_to_email {
367     return;
368   }
369
370   if let Some(user_email) = &local_user_view.local_user.email {
371     match send_email(
372       subject,
373       user_email,
374       &local_user_view.person.name,
375       body,
376       settings,
377     ) {
378       Ok(_o) => _o,
379       Err(e) => warn!("{}", e),
380     };
381   }
382 }
383
384 pub async fn send_password_reset_email(
385   user: &LocalUserView,
386   pool: &DbPool,
387   settings: &Settings,
388 ) -> Result<(), LemmyError> {
389   // Generate a random token
390   let token = generate_random_string();
391
392   // Insert the row
393   let token2 = token.clone();
394   let local_user_id = user.local_user.id;
395   blocking(pool, move |conn| {
396     PasswordResetRequest::create_token(conn, local_user_id, &token2)
397   })
398   .await??;
399
400   let email = &user.local_user.email.to_owned().expect("email");
401   let lang = get_user_lang(user);
402   let subject = &lang.password_reset_subject(&user.person.name);
403   let protocol_and_hostname = settings.get_protocol_and_hostname();
404   let reset_link = format!("{}/password_change/{}", protocol_and_hostname, &token);
405   let body = &lang.password_reset_body(reset_link, &user.person.name);
406   send_email(subject, email, &user.person.name, body, settings)
407 }
408
409 /// Send a verification email
410 pub async fn send_verification_email(
411   user: &LocalUserView,
412   new_email: &str,
413   pool: &DbPool,
414   settings: &Settings,
415 ) -> Result<(), LemmyError> {
416   let form = EmailVerificationForm {
417     local_user_id: user.local_user.id,
418     email: new_email.to_string(),
419     verification_token: generate_random_string(),
420   };
421   let verify_link = format!(
422     "{}/verify_email/{}",
423     settings.get_protocol_and_hostname(),
424     &form.verification_token
425   );
426   blocking(pool, move |conn| EmailVerification::create(conn, &form)).await??;
427
428   let lang = get_user_lang(user);
429   let subject = lang.verify_email_subject(&settings.hostname);
430   let body = lang.verify_email_body(&settings.hostname, &user.person.name, verify_link);
431   send_email(&subject, new_email, &user.person.name, &body, settings)?;
432
433   Ok(())
434 }
435
436 pub fn send_email_verification_success(
437   user: &LocalUserView,
438   settings: &Settings,
439 ) -> Result<(), LemmyError> {
440   let email = &user.local_user.email.to_owned().expect("email");
441   let lang = get_user_lang(user);
442   let subject = &lang.email_verified_subject(&user.person.actor_id);
443   let body = &lang.email_verified_body();
444   send_email(subject, email, &user.person.name, body, settings)
445 }
446
447 pub fn get_user_lang(user: &LocalUserView) -> Lang {
448   let user_lang = LanguageId::new(user.local_user.lang.clone());
449   Lang::from_language_id(&user_lang).unwrap_or_else(|| {
450     let en = LanguageId::new("en");
451     Lang::from_language_id(&en).expect("default language")
452   })
453 }
454
455 pub fn send_application_approved_email(
456   user: &LocalUserView,
457   settings: &Settings,
458 ) -> Result<(), LemmyError> {
459   let email = &user.local_user.email.to_owned().expect("email");
460   let lang = get_user_lang(user);
461   let subject = lang.registration_approved_subject(&user.person.actor_id);
462   let body = lang.registration_approved_body(&settings.hostname);
463   send_email(&subject, email, &user.person.name, &body, settings)
464 }
465
466 pub async fn check_registration_application(
467   site: &Site,
468   local_user_view: &LocalUserView,
469   pool: &DbPool,
470 ) -> Result<(), LemmyError> {
471   if site.require_application
472     && !local_user_view.local_user.accepted_application
473     && !local_user_view.person.admin
474   {
475     // Fetch the registration, see if its denied
476     let local_user_id = local_user_view.local_user.id;
477     let registration = blocking(pool, move |conn| {
478       RegistrationApplication::find_by_local_user_id(conn, local_user_id)
479     })
480     .await??;
481     if let Some(deny_reason) = registration.deny_reason {
482       let lang = get_user_lang(local_user_view);
483       let registration_denied_message = format!("{}: {}", lang.registration_denied(), &deny_reason);
484       return Err(LemmyError::from_message(&registration_denied_message));
485     } else {
486       return Err(LemmyError::from_message("registration_application_pending"));
487     }
488   }
489   Ok(())
490 }
491
492 /// TODO this check should be removed after https://github.com/LemmyNet/lemmy/issues/868 is done.
493 pub async fn check_private_instance_and_federation_enabled(
494   pool: &DbPool,
495   settings: &Settings,
496 ) -> Result<(), LemmyError> {
497   let site_opt = blocking(pool, Site::read_local_site).await?;
498
499   if let Ok(site) = site_opt {
500     if site.private_instance && settings.federation.enabled {
501       return Err(LemmyError::from_message(
502         "Cannot have both private instance and federation enabled.",
503       ));
504     }
505   }
506   Ok(())
507 }
508
509 pub async fn purge_image_posts_for_person(
510   banned_person_id: PersonId,
511   pool: &DbPool,
512   settings: &Settings,
513   client: &ClientWithMiddleware,
514 ) -> Result<(), LemmyError> {
515   let posts = blocking(pool, move |conn: &'_ _| {
516     Post::fetch_pictrs_posts_for_creator(conn, banned_person_id)
517   })
518   .await??;
519   for post in posts {
520     if let Some(url) = post.url {
521       purge_image_from_pictrs(client, settings, &url).await.ok();
522     }
523     if let Some(thumbnail_url) = post.thumbnail_url {
524       purge_image_from_pictrs(client, settings, &thumbnail_url)
525         .await
526         .ok();
527     }
528   }
529
530   blocking(pool, move |conn| {
531     Post::remove_pictrs_post_images_and_thumbnails_for_creator(conn, banned_person_id)
532   })
533   .await??;
534
535   Ok(())
536 }
537
538 pub async fn purge_image_posts_for_community(
539   banned_community_id: CommunityId,
540   pool: &DbPool,
541   settings: &Settings,
542   client: &ClientWithMiddleware,
543 ) -> Result<(), LemmyError> {
544   let posts = blocking(pool, move |conn: &'_ _| {
545     Post::fetch_pictrs_posts_for_community(conn, banned_community_id)
546   })
547   .await??;
548   for post in posts {
549     if let Some(url) = post.url {
550       purge_image_from_pictrs(client, settings, &url).await.ok();
551     }
552     if let Some(thumbnail_url) = post.thumbnail_url {
553       purge_image_from_pictrs(client, settings, &thumbnail_url)
554         .await
555         .ok();
556     }
557   }
558
559   blocking(pool, move |conn| {
560     Post::remove_pictrs_post_images_and_thumbnails_for_community(conn, banned_community_id)
561   })
562   .await??;
563
564   Ok(())
565 }
566
567 pub async fn remove_user_data(
568   banned_person_id: PersonId,
569   pool: &DbPool,
570   settings: &Settings,
571   client: &ClientWithMiddleware,
572 ) -> Result<(), LemmyError> {
573   // Purge user images
574   let person = blocking(pool, move |conn| Person::read(conn, banned_person_id)).await??;
575   if let Some(avatar) = person.avatar {
576     purge_image_from_pictrs(client, settings, &avatar)
577       .await
578       .ok();
579   }
580   if let Some(banner) = person.banner {
581     purge_image_from_pictrs(client, settings, &banner)
582       .await
583       .ok();
584   }
585
586   // Update the fields to None
587   blocking(pool, move |conn| {
588     Person::remove_avatar_and_banner(conn, banned_person_id)
589   })
590   .await??;
591
592   // Posts
593   blocking(pool, move |conn: &'_ _| {
594     Post::update_removed_for_creator(conn, banned_person_id, None, true)
595   })
596   .await??;
597
598   // Purge image posts
599   purge_image_posts_for_person(banned_person_id, pool, settings, client).await?;
600
601   // Communities
602   // Remove all communities where they're the top mod
603   // for now, remove the communities manually
604   let first_mod_communities = blocking(pool, move |conn: &'_ _| {
605     CommunityModeratorView::get_community_first_mods(conn)
606   })
607   .await??;
608
609   // Filter to only this banned users top communities
610   let banned_user_first_communities: Vec<CommunityModeratorView> = first_mod_communities
611     .into_iter()
612     .filter(|fmc| fmc.moderator.id == banned_person_id)
613     .collect();
614
615   for first_mod_community in banned_user_first_communities {
616     let community_id = first_mod_community.community.id;
617     blocking(pool, move |conn: &'_ _| {
618       Community::update_removed(conn, community_id, true)
619     })
620     .await??;
621
622     // Delete the community images
623     if let Some(icon) = first_mod_community.community.icon {
624       purge_image_from_pictrs(client, settings, &icon).await.ok();
625     }
626     if let Some(banner) = first_mod_community.community.banner {
627       purge_image_from_pictrs(client, settings, &banner)
628         .await
629         .ok();
630     }
631     // Update the fields to None
632     blocking(pool, move |conn| {
633       Community::remove_avatar_and_banner(conn, community_id)
634     })
635     .await??;
636   }
637
638   // Comments
639   blocking(pool, move |conn: &'_ _| {
640     Comment::update_removed_for_creator(conn, banned_person_id, true)
641   })
642   .await??;
643
644   Ok(())
645 }
646
647 pub async fn remove_user_data_in_community(
648   community_id: CommunityId,
649   banned_person_id: PersonId,
650   pool: &DbPool,
651 ) -> Result<(), LemmyError> {
652   // Posts
653   blocking(pool, move |conn| {
654     Post::update_removed_for_creator(conn, banned_person_id, Some(community_id), true)
655   })
656   .await??;
657
658   // Comments
659   // TODO Diesel doesn't allow updates with joins, so this has to be a loop
660   let comments = blocking(pool, move |conn| {
661     CommentQueryBuilder::create(conn)
662       .creator_id(banned_person_id)
663       .community_id(community_id)
664       .limit(std::i64::MAX)
665       .list()
666   })
667   .await??;
668
669   for comment_view in &comments {
670     let comment_id = comment_view.comment.id;
671     blocking(pool, move |conn| {
672       Comment::update_removed(conn, comment_id, true)
673     })
674     .await??;
675   }
676
677   Ok(())
678 }
679
680 pub async fn delete_user_account(
681   person_id: PersonId,
682   pool: &DbPool,
683   settings: &Settings,
684   client: &ClientWithMiddleware,
685 ) -> Result<(), LemmyError> {
686   // Delete their images
687   let person = blocking(pool, move |conn| Person::read(conn, person_id)).await??;
688   if let Some(avatar) = person.avatar {
689     purge_image_from_pictrs(client, settings, &avatar)
690       .await
691       .ok();
692   }
693   if let Some(banner) = person.banner {
694     purge_image_from_pictrs(client, settings, &banner)
695       .await
696       .ok();
697   }
698   // No need to update avatar and banner, those are handled in Person::delete_account
699
700   // Comments
701   let permadelete = move |conn: &'_ _| Comment::permadelete_for_creator(conn, person_id);
702   blocking(pool, permadelete)
703     .await?
704     .map_err(|e| LemmyError::from_error_message(e, "couldnt_update_comment"))?;
705
706   // Posts
707   let permadelete = move |conn: &'_ _| Post::permadelete_for_creator(conn, person_id);
708   blocking(pool, permadelete)
709     .await?
710     .map_err(|e| LemmyError::from_error_message(e, "couldnt_update_post"))?;
711
712   // Purge image posts
713   purge_image_posts_for_person(person_id, pool, settings, client).await?;
714
715   blocking(pool, move |conn| Person::delete_account(conn, person_id)).await??;
716
717   Ok(())
718 }