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