]> Untitled Git - lemmy.git/blob - crates/api_common/src/utils.rs
Use typed-builder crate for queries (#2379)
[lemmy.git] / crates / api_common / src / utils.rs
1 use crate::{request::purge_image_from_pictrs, sensitive::Sensitive, site::FederatedInstances};
2 use chrono::NaiveDateTime;
3 use lemmy_db_schema::{
4   impls::person::is_banned,
5   newtypes::{CommunityId, LocalUserId, PersonId, PostId},
6   source::{
7     comment::Comment,
8     community::Community,
9     email_verification::{EmailVerification, EmailVerificationForm},
10     password_reset_request::PasswordResetRequest,
11     person::Person,
12     person_block::PersonBlock,
13     post::{Post, PostRead, PostReadForm},
14     registration_application::RegistrationApplication,
15     secret::Secret,
16     site::Site,
17   },
18   traits::{Crud, Readable},
19   utils::DbPool,
20   ListingType,
21 };
22 use lemmy_db_views::{
23   comment_view::CommentQuery,
24   structs::{LocalUserSettingsView, LocalUserView},
25 };
26 use lemmy_db_views_actor::structs::{
27   CommunityModeratorView,
28   CommunityPersonBanView,
29   CommunityView,
30 };
31 use lemmy_utils::{
32   claims::Claims,
33   email::{send_email, translations::Lang},
34   error::LemmyError,
35   settings::structs::Settings,
36   utils::generate_random_string,
37 };
38 use reqwest_middleware::ClientWithMiddleware;
39 use rosetta_i18n::{Language, LanguageId};
40 use std::str::FromStr;
41 use tracing::warn;
42
43 pub async fn blocking<F, T>(pool: &DbPool, f: F) -> Result<T, LemmyError>
44 where
45   F: FnOnce(&diesel::PgConnection) -> T + Send + 'static,
46   T: Send + 'static,
47 {
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()?;
53     let res = (f)(&conn);
54     drop(entered);
55     Ok(res) as Result<T, LemmyError>
56   })
57   .await?;
58
59   res
60 }
61
62 #[tracing::instrument(skip_all)]
63 pub async fn is_mod_or_admin(
64   pool: &DbPool,
65   person_id: PersonId,
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)
70   })
71   .await?;
72   if !is_mod_or_admin {
73     return Err(LemmyError::from_message("not_a_mod_or_admin"));
74   }
75   Ok(())
76 }
77
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"));
81   }
82   Ok(())
83 }
84
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))
88     .await?
89     .map_err(|e| LemmyError::from_error_message(e, "couldnt_find_post"))
90 }
91
92 #[tracing::instrument(skip_all)]
93 pub async fn mark_post_as_read(
94   person_id: PersonId,
95   post_id: PostId,
96   pool: &DbPool,
97 ) -> Result<PostRead, LemmyError> {
98   let post_read_form = PostReadForm { post_id, person_id };
99
100   blocking(pool, move |conn| {
101     PostRead::mark_as_read(conn, &post_read_form)
102   })
103   .await?
104   .map_err(|e| LemmyError::from_error_message(e, "couldnt_mark_post_as_read"))
105 }
106
107 #[tracing::instrument(skip_all)]
108 pub async fn mark_post_as_unread(
109   person_id: PersonId,
110   post_id: PostId,
111   pool: &DbPool,
112 ) -> Result<usize, LemmyError> {
113   let post_read_form = PostReadForm { post_id, person_id };
114
115   blocking(pool, move |conn| {
116     PostRead::mark_as_unread(conn, &post_read_form)
117   })
118   .await?
119   .map_err(|e| LemmyError::from_error_message(e, "couldnt_mark_post_as_read"))
120 }
121
122 #[tracing::instrument(skip_all)]
123 pub async fn get_local_user_view_from_jwt(
124   jwt: &str,
125   pool: &DbPool,
126   secret: &Secret,
127 ) -> Result<LocalUserView, LemmyError> {
128   let claims = Claims::decode(jwt, &secret.jwt_secret)
129     .map_err(|e| e.with_message("not_logged_in"))?
130     .claims;
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??;
134   check_user_valid(
135     local_user_view.person.banned,
136     local_user_view.person.ban_expires,
137     local_user_view.person.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: &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_opt(
172   jwt: Option<&Sensitive<String>>,
173   pool: &DbPool,
174   secret: &Secret,
175 ) -> Result<Option<LocalUserSettingsView>, LemmyError> {
176   match jwt {
177     Some(jwt) => {
178       let claims = Claims::decode(jwt.as_ref(), &secret.jwt_secret)
179         .map_err(|e| e.with_message("not_logged_in"))?
180         .claims;
181       let local_user_id = LocalUserId(claims.sub);
182       let local_user_view = blocking(pool, move |conn| {
183         LocalUserSettingsView::read(conn, local_user_id)
184       })
185       .await??;
186       check_user_valid(
187         local_user_view.person.banned,
188         local_user_view.person.ban_expires,
189         local_user_view.person.deleted,
190       )?;
191
192       check_validator_time(&local_user_view.local_user.validator_time, &claims)?;
193
194       Ok(Some(local_user_view))
195     }
196     None => Ok(None),
197   }
198 }
199 pub fn check_user_valid(
200   banned: bool,
201   ban_expires: Option<NaiveDateTime>,
202   deleted: bool,
203 ) -> Result<(), LemmyError> {
204   // Check for a site ban
205   if is_banned(banned, ban_expires) {
206     return Err(LemmyError::from_message("site_ban"));
207   }
208
209   // check for account deletion
210   if deleted {
211     return Err(LemmyError::from_message("deleted"));
212   }
213
214   Ok(())
215 }
216
217 #[tracing::instrument(skip_all)]
218 pub async fn check_community_ban(
219   person_id: PersonId,
220   community_id: CommunityId,
221   pool: &DbPool,
222 ) -> Result<(), LemmyError> {
223   let is_banned =
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"))
227   } else {
228     Ok(())
229   }
230 }
231
232 #[tracing::instrument(skip_all)]
233 pub async fn check_community_deleted_or_removed(
234   community_id: CommunityId,
235   pool: &DbPool,
236 ) -> Result<(), LemmyError> {
237   let community = blocking(pool, move |conn| Community::read(conn, community_id))
238     .await?
239     .map_err(|e| LemmyError::from_error_message(e, "couldnt_find_community"))?;
240   if community.deleted || community.removed {
241     Err(LemmyError::from_message("deleted"))
242   } else {
243     Ok(())
244   }
245 }
246
247 pub fn check_post_deleted_or_removed(post: &Post) -> Result<(), LemmyError> {
248   if post.deleted || post.removed {
249     Err(LemmyError::from_message("deleted"))
250   } else {
251     Ok(())
252   }
253 }
254
255 #[tracing::instrument(skip_all)]
256 pub async fn check_person_block(
257   my_id: PersonId,
258   potential_blocker_id: PersonId,
259   pool: &DbPool,
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"))
264   } else {
265     Ok(())
266   }
267 }
268
269 #[tracing::instrument(skip_all)]
270 pub async fn check_downvotes_enabled(score: i16, pool: &DbPool) -> Result<(), LemmyError> {
271   if score == -1 {
272     let site = blocking(pool, Site::read_local_site).await??;
273     if !site.enable_downvotes {
274       return Err(LemmyError::from_message("downvotes_disabled"));
275     }
276   }
277   Ok(())
278 }
279
280 #[tracing::instrument(skip_all)]
281 pub async fn check_private_instance(
282   local_user_view: &Option<LocalUserView>,
283   pool: &DbPool,
284 ) -> Result<(), LemmyError> {
285   if local_user_view.is_none() {
286     let site = blocking(pool, Site::read_local_site).await?;
287
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"));
292       }
293     }
294   }
295   Ok(())
296 }
297
298 #[tracing::instrument(skip_all)]
299 pub async fn build_federated_instances(
300   pool: &DbPool,
301   settings: &Settings,
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)
309     })
310     .await??;
311
312     let allowed = federation.allowed_instances;
313     let blocked = federation.blocked_instances;
314
315     let mut linked = distinct_communities
316       .iter()
317       .map(|actor_id| Ok(actor_id.host_str().unwrap_or("").to_string()))
318       .collect::<Result<Vec<String>, LemmyError>>()?;
319
320     if let Some(allowed) = allowed.as_ref() {
321       linked.extend_from_slice(allowed);
322     }
323
324     if let Some(blocked) = blocked.as_ref() {
325       linked.retain(|a| !blocked.contains(a) && !a.eq(hostname));
326     }
327
328     // Sort and remove dupes
329     linked.sort_unstable();
330     linked.dedup();
331
332     Ok(Some(FederatedInstances {
333       linked,
334       allowed,
335       blocked,
336     }))
337   } else {
338     Ok(None)
339   }
340 }
341
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"))
346   } else {
347     Ok(())
348   }
349 }
350
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"))
355   } else {
356     Ok(())
357   }
358 }
359
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"))
364   } else {
365     Ok(())
366   }
367 }
368
369 pub fn send_email_to_user(
370   local_user_view: &LocalUserView,
371   subject: &str,
372   body: &str,
373   settings: &Settings,
374 ) {
375   if local_user_view.person.banned || !local_user_view.local_user.send_notifications_to_email {
376     return;
377   }
378
379   if let Some(user_email) = &local_user_view.local_user.email {
380     match send_email(
381       subject,
382       user_email,
383       &local_user_view.person.name,
384       body,
385       settings,
386     ) {
387       Ok(_o) => _o,
388       Err(e) => warn!("{}", e),
389     };
390   }
391 }
392
393 pub async fn send_password_reset_email(
394   user: &LocalUserView,
395   pool: &DbPool,
396   settings: &Settings,
397 ) -> Result<(), LemmyError> {
398   // Generate a random token
399   let token = generate_random_string();
400
401   // Insert the row
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)
406   })
407   .await??;
408
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)
416 }
417
418 /// Send a verification email
419 pub async fn send_verification_email(
420   user: &LocalUserView,
421   new_email: &str,
422   pool: &DbPool,
423   settings: &Settings,
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(),
429   };
430   let verify_link = format!(
431     "{}/verify_email/{}",
432     settings.get_protocol_and_hostname(),
433     &form.verification_token
434   );
435   blocking(pool, move |conn| EmailVerification::create(conn, &form)).await??;
436
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)?;
441
442   Ok(())
443 }
444
445 pub fn send_email_verification_success(
446   user: &LocalUserView,
447   settings: &Settings,
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)
454 }
455
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")
461   })
462 }
463
464 pub fn send_application_approved_email(
465   user: &LocalUserView,
466   settings: &Settings,
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)
473 }
474
475 pub async fn check_registration_application(
476   site: &Site,
477   local_user_view: &LocalUserView,
478   pool: &DbPool,
479 ) -> Result<(), LemmyError> {
480   if site.require_application
481     && !local_user_view.local_user.accepted_application
482     && !local_user_view.person.admin
483   {
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)
488     })
489     .await??;
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(&registration_denied_message));
494     } else {
495       return Err(LemmyError::from_message("registration_application_pending"));
496     }
497   }
498   Ok(())
499 }
500
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(
503   pool: &DbPool,
504   settings: &Settings,
505 ) -> Result<(), LemmyError> {
506   let site_opt = blocking(pool, Site::read_local_site).await?;
507
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.",
512       ));
513     }
514   }
515   Ok(())
516 }
517
518 pub async fn purge_image_posts_for_person(
519   banned_person_id: PersonId,
520   pool: &DbPool,
521   settings: &Settings,
522   client: &ClientWithMiddleware,
523 ) -> Result<(), LemmyError> {
524   let posts = blocking(pool, move |conn: &'_ _| {
525     Post::fetch_pictrs_posts_for_creator(conn, banned_person_id)
526   })
527   .await??;
528   for post in posts {
529     if let Some(url) = post.url {
530       purge_image_from_pictrs(client, settings, &url).await.ok();
531     }
532     if let Some(thumbnail_url) = post.thumbnail_url {
533       purge_image_from_pictrs(client, settings, &thumbnail_url)
534         .await
535         .ok();
536     }
537   }
538
539   blocking(pool, move |conn| {
540     Post::remove_pictrs_post_images_and_thumbnails_for_creator(conn, banned_person_id)
541   })
542   .await??;
543
544   Ok(())
545 }
546
547 pub async fn purge_image_posts_for_community(
548   banned_community_id: CommunityId,
549   pool: &DbPool,
550   settings: &Settings,
551   client: &ClientWithMiddleware,
552 ) -> Result<(), LemmyError> {
553   let posts = blocking(pool, move |conn: &'_ _| {
554     Post::fetch_pictrs_posts_for_community(conn, banned_community_id)
555   })
556   .await??;
557   for post in posts {
558     if let Some(url) = post.url {
559       purge_image_from_pictrs(client, settings, &url).await.ok();
560     }
561     if let Some(thumbnail_url) = post.thumbnail_url {
562       purge_image_from_pictrs(client, settings, &thumbnail_url)
563         .await
564         .ok();
565     }
566   }
567
568   blocking(pool, move |conn| {
569     Post::remove_pictrs_post_images_and_thumbnails_for_community(conn, banned_community_id)
570   })
571   .await??;
572
573   Ok(())
574 }
575
576 pub async fn remove_user_data(
577   banned_person_id: PersonId,
578   pool: &DbPool,
579   settings: &Settings,
580   client: &ClientWithMiddleware,
581 ) -> Result<(), LemmyError> {
582   // Purge user images
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)
586       .await
587       .ok();
588   }
589   if let Some(banner) = person.banner {
590     purge_image_from_pictrs(client, settings, &banner)
591       .await
592       .ok();
593   }
594
595   // Update the fields to None
596   blocking(pool, move |conn| {
597     Person::remove_avatar_and_banner(conn, banned_person_id)
598   })
599   .await??;
600
601   // Posts
602   blocking(pool, move |conn: &'_ _| {
603     Post::update_removed_for_creator(conn, banned_person_id, None, true)
604   })
605   .await??;
606
607   // Purge image posts
608   purge_image_posts_for_person(banned_person_id, pool, settings, client).await?;
609
610   // Communities
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)
615   })
616   .await??;
617
618   // Filter to only this banned users top communities
619   let banned_user_first_communities: Vec<CommunityModeratorView> = first_mod_communities
620     .into_iter()
621     .filter(|fmc| fmc.moderator.id == banned_person_id)
622     .collect();
623
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)
628     })
629     .await??;
630
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();
634     }
635     if let Some(banner) = first_mod_community.community.banner {
636       purge_image_from_pictrs(client, settings, &banner)
637         .await
638         .ok();
639     }
640     // Update the fields to None
641     blocking(pool, move |conn| {
642       Community::remove_avatar_and_banner(conn, community_id)
643     })
644     .await??;
645   }
646
647   // Comments
648   blocking(pool, move |conn: &'_ _| {
649     Comment::update_removed_for_creator(conn, banned_person_id, true)
650   })
651   .await??;
652
653   Ok(())
654 }
655
656 pub async fn remove_user_data_in_community(
657   community_id: CommunityId,
658   banned_person_id: PersonId,
659   pool: &DbPool,
660 ) -> Result<(), LemmyError> {
661   // Posts
662   blocking(pool, move |conn| {
663     Post::update_removed_for_creator(conn, banned_person_id, Some(community_id), true)
664   })
665   .await??;
666
667   // Comments
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()
671       .conn(conn)
672       .creator_id(Some(banned_person_id))
673       .community_id(Some(community_id))
674       .limit(Some(i64::MAX))
675       .build()
676       .list()
677   })
678   .await??;
679
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)
684     })
685     .await??;
686   }
687
688   Ok(())
689 }
690
691 pub async fn delete_user_account(
692   person_id: PersonId,
693   pool: &DbPool,
694   settings: &Settings,
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)
701       .await
702       .ok();
703   }
704   if let Some(banner) = person.banner {
705     purge_image_from_pictrs(client, settings, &banner)
706       .await
707       .ok();
708   }
709   // No need to update avatar and banner, those are handled in Person::delete_account
710
711   // Comments
712   let permadelete = move |conn: &'_ _| Comment::permadelete_for_creator(conn, person_id);
713   blocking(pool, permadelete)
714     .await?
715     .map_err(|e| LemmyError::from_error_message(e, "couldnt_update_comment"))?;
716
717   // Posts
718   let permadelete = move |conn: &'_ _| Post::permadelete_for_creator(conn, person_id);
719   blocking(pool, permadelete)
720     .await?
721     .map_err(|e| LemmyError::from_error_message(e, "couldnt_update_post"))?;
722
723   // Purge image posts
724   purge_image_posts_for_person(person_id, pool, settings, client).await?;
725
726   blocking(pool, move |conn| Person::delete_account(conn, person_id)).await??;
727
728   Ok(())
729 }
730
731 pub async fn listing_type_with_site_default(
732   listing_type: Option<ListingType>,
733   pool: &DbPool,
734 ) -> Result<ListingType, LemmyError> {
735   Ok(match listing_type {
736     Some(l) => l,
737     None => {
738       let site = blocking(pool, Site::read_local_site).await??;
739       ListingType::from_str(&site.default_post_listing_type)?
740     }
741   })
742 }