crates/api_common/src/lib.rs

   1 pub mod comment;
   2 pub mod community;
   3 pub mod person;
   4 pub mod post;
   5 pub mod site;
   6 pub mod websocket;
   7
   8 use crate::site::FederatedInstances;
   9 use itertools::Itertools;
  10 use lemmy_db_schema::{
  11   newtypes::{CommunityId, LocalUserId, PersonId, PostId},
  12   source::{
  13     comment::Comment,
  14     community::Community,
  15     email_verification::{EmailVerification, EmailVerificationForm},
  16     password_reset_request::PasswordResetRequest,
  17     person_block::PersonBlock,
  18     post::{Post, PostRead, PostReadForm},
  19     registration_application::RegistrationApplication,
  20     secret::Secret,
  21     site::Site,
  22   },
  23   traits::{ApubActor, Crud, Readable},
  24   DbPool,
  25 };
  26 use lemmy_db_views::{
  27   comment_view::CommentQueryBuilder,
  28   local_user_view::{LocalUserSettingsView, LocalUserView},
  29 };
  30 use lemmy_db_views_actor::{
  31   community_moderator_view::CommunityModeratorView,
  32   community_person_ban_view::CommunityPersonBanView,
  33   community_view::CommunityView,
  34 };
  35 use lemmy_utils::{
  36   claims::Claims,
  37   email::send_email,
  38   settings::structs::{FederationConfig, Settings},
  39   utils::generate_random_string,
  40   LemmyError,
  41   Sensitive,
  42 };
  43 use url::Url;
  44
  45 pub async fn blocking<F, T>(pool: &DbPool, f: F) -> Result<T, LemmyError>
  46 where
  47   F: FnOnce(&diesel::PgConnection) -> T + Send + 'static,
  48   T: Send + 'static,
  49 {
  50   let pool = pool.clone();
  51   let blocking_span = tracing::info_span!("blocking operation");
  52   let res = actix_web::web::block(move || {
  53     let entered = blocking_span.enter();
  54     let conn = pool.get()?;
  55     let res = (f)(&conn);
  56     drop(entered);
  57     Ok(res) as Result<T, LemmyError>
  58   })
  59   .await?;
  60
  61   res
  62 }
  63
  64 #[tracing::instrument(skip_all)]
  65 pub async fn is_mod_or_admin(
  66   pool: &DbPool,
  67   person_id: PersonId,
  68   community_id: CommunityId,
  69 ) -> Result<(), LemmyError> {
  70   let is_mod_or_admin = blocking(pool, move |conn| {
  71     CommunityView::is_mod_or_admin(conn, person_id, community_id)
  72   })
  73   .await?;
  74   if !is_mod_or_admin {
  75     return Err(LemmyError::from_message("not_a_mod_or_admin"));
  76   }
  77   Ok(())
  78 }
  79
  80 pub fn is_admin(local_user_view: &LocalUserView) -> Result<(), LemmyError> {
  81   if !local_user_view.person.admin {
  82     return Err(LemmyError::from_message("not_an_admin"));
  83   }
  84   Ok(())
  85 }
  86
  87 #[tracing::instrument(skip_all)]
  88 pub async fn get_post(post_id: PostId, pool: &DbPool) -> Result<Post, LemmyError> {
  89   blocking(pool, move |conn| Post::read(conn, post_id))
  90     .await?
  91     .map_err(|e| LemmyError::from_error_message(e, "couldnt_find_post"))
  92 }
  93
  94 #[tracing::instrument(skip_all)]
  95 pub async fn mark_post_as_read(
  96   person_id: PersonId,
  97   post_id: PostId,
  98   pool: &DbPool,
  99 ) -> Result<PostRead, LemmyError> {
 100   let post_read_form = PostReadForm { post_id, person_id };
 101
 102   blocking(pool, move |conn| {
 103     PostRead::mark_as_read(conn, &post_read_form)
 104   })
 105   .await?
 106   .map_err(|e| LemmyError::from_error_message(e, "couldnt_mark_post_as_read"))
 107 }
 108
 109 #[tracing::instrument(skip_all)]
 110 pub async fn mark_post_as_unread(
 111   person_id: PersonId,
 112   post_id: PostId,
 113   pool: &DbPool,
 114 ) -> Result<usize, LemmyError> {
 115   let post_read_form = PostReadForm { post_id, person_id };
 116
 117   blocking(pool, move |conn| {
 118     PostRead::mark_as_unread(conn, &post_read_form)
 119   })
 120   .await?
 121   .map_err(|e| LemmyError::from_error_message(e, "couldnt_mark_post_as_read"))
 122 }
 123
 124 #[tracing::instrument(skip_all)]
 125 pub async fn get_local_user_view_from_jwt(
 126   jwt: &str,
 127   pool: &DbPool,
 128   secret: &Secret,
 129 ) -> Result<LocalUserView, LemmyError> {
 130   let claims = Claims::decode(jwt, &secret.jwt_secret)
 131     .map_err(|e| e.with_message("not_logged_in"))?
 132     .claims;
 133   let local_user_id = LocalUserId(claims.sub);
 134   let local_user_view =
 135     blocking(pool, move |conn| LocalUserView::read(conn, local_user_id)).await??;
 136   // Check for a site ban
 137   if local_user_view.person.is_banned() {
 138     return Err(LemmyError::from_message("site_ban"));
 139   }
 140
 141   // Check for user deletion
 142   if local_user_view.person.deleted {
 143     return Err(LemmyError::from_message("deleted"));
 144   }
 145
 146   check_validator_time(&local_user_view.local_user.validator_time, &claims)?;
 147
 148   Ok(local_user_view)
 149 }
 150
 151 /// Checks if user's token was issued before user's password reset.
 152 pub fn check_validator_time(
 153   validator_time: &chrono::NaiveDateTime,
 154   claims: &Claims,
 155 ) -> Result<(), LemmyError> {
 156   let user_validation_time = validator_time.timestamp();
 157   if user_validation_time > claims.iat {
 158     Err(LemmyError::from_message("not_logged_in"))
 159   } else {
 160     Ok(())
 161   }
 162 }
 163
 164 #[tracing::instrument(skip_all)]
 165 pub async fn get_local_user_view_from_jwt_opt(
 166   jwt: Option<&Sensitive<String>>,
 167   pool: &DbPool,
 168   secret: &Secret,
 169 ) -> Result<Option<LocalUserView>, LemmyError> {
 170   match jwt {
 171     Some(jwt) => Ok(Some(get_local_user_view_from_jwt(jwt, pool, secret).await?)),
 172     None => Ok(None),
 173   }
 174 }
 175
 176 #[tracing::instrument(skip_all)]
 177 pub async fn get_local_user_settings_view_from_jwt(
 178   jwt: &Sensitive<String>,
 179   pool: &DbPool,
 180   secret: &Secret,
 181 ) -> Result<LocalUserSettingsView, LemmyError> {
 182   let claims = Claims::decode(jwt.as_ref(), &secret.jwt_secret)
 183     .map_err(|e| e.with_message("not_logged_in"))?
 184     .claims;
 185   let local_user_id = LocalUserId(claims.sub);
 186   let local_user_view = blocking(pool, move |conn| {
 187     LocalUserSettingsView::read(conn, local_user_id)
 188   })
 189   .await??;
 190   // Check for a site ban
 191   if local_user_view.person.is_banned() {
 192     return Err(LemmyError::from_message("site_ban"));
 193   }
 194
 195   check_validator_time(&local_user_view.local_user.validator_time, &claims)?;
 196
 197   Ok(local_user_view)
 198 }
 199
 200 #[tracing::instrument(skip_all)]
 201 pub async fn get_local_user_settings_view_from_jwt_opt(
 202   jwt: Option<&Sensitive<String>>,
 203   pool: &DbPool,
 204   secret: &Secret,
 205 ) -> Result<Option<LocalUserSettingsView>, LemmyError> {
 206   match jwt {
 207     Some(jwt) => Ok(Some(
 208       get_local_user_settings_view_from_jwt(jwt, pool, secret).await?,
 209     )),
 210     None => Ok(None),
 211   }
 212 }
 213
 214 #[tracing::instrument(skip_all)]
 215 pub async fn check_community_ban(
 216   person_id: PersonId,
 217   community_id: CommunityId,
 218   pool: &DbPool,
 219 ) -> Result<(), LemmyError> {
 220   let is_banned =
 221     move |conn: &'_ _| CommunityPersonBanView::get(conn, person_id, community_id).is_ok();
 222   if blocking(pool, is_banned).await? {
 223     Err(LemmyError::from_message("community_ban"))
 224   } else {
 225     Ok(())
 226   }
 227 }
 228
 229 #[tracing::instrument(skip_all)]
 230 pub async fn check_community_deleted_or_removed(
 231   community_id: CommunityId,
 232   pool: &DbPool,
 233 ) -> Result<(), LemmyError> {
 234   let community = blocking(pool, move |conn| Community::read(conn, community_id))
 235     .await?
 236     .map_err(|e| LemmyError::from_error_message(e, "couldnt_find_community"))?;
 237   if community.deleted || community.removed {
 238     Err(LemmyError::from_message("deleted"))
 239   } else {
 240     Ok(())
 241   }
 242 }
 243
 244 pub fn check_post_deleted_or_removed(post: &Post) -> Result<(), LemmyError> {
 245   if post.deleted || post.removed {
 246     Err(LemmyError::from_message("deleted"))
 247   } else {
 248     Ok(())
 249   }
 250 }
 251
 252 #[tracing::instrument(skip_all)]
 253 pub async fn check_person_block(
 254   my_id: PersonId,
 255   potential_blocker_id: PersonId,
 256   pool: &DbPool,
 257 ) -> Result<(), LemmyError> {
 258   let is_blocked = move |conn: &'_ _| PersonBlock::read(conn, potential_blocker_id, my_id).is_ok();
 259   if blocking(pool, is_blocked).await? {
 260     Err(LemmyError::from_message("person_block"))
 261   } else {
 262     Ok(())
 263   }
 264 }
 265
 266 #[tracing::instrument(skip_all)]
 267 pub async fn check_downvotes_enabled(score: i16, pool: &DbPool) -> Result<(), LemmyError> {
 268   if score == -1 {
 269     let site = blocking(pool, Site::read_local_site).await??;
 270     if !site.enable_downvotes {
 271       return Err(LemmyError::from_message("downvotes_disabled"));
 272     }
 273   }
 274   Ok(())
 275 }
 276
 277 #[tracing::instrument(skip_all)]
 278 pub async fn check_private_instance(
 279   local_user_view: &Option<LocalUserView>,
 280   pool: &DbPool,
 281 ) -> Result<(), LemmyError> {
 282   if local_user_view.is_none() {
 283     let site = blocking(pool, Site::read_local_site).await?;
 284
 285     // The site might not be set up yet
 286     if let Ok(site) = site {
 287       if site.private_instance {
 288         return Err(LemmyError::from_message("instance_is_private"));
 289       }
 290     }
 291   }
 292   Ok(())
 293 }
 294
 295 #[tracing::instrument(skip_all)]
 296 pub async fn build_federated_instances(
 297   pool: &DbPool,
 298   federation_config: &FederationConfig,
 299   hostname: &str,
 300 ) -> Result<Option<FederatedInstances>, LemmyError> {
 301   let federation = federation_config.to_owned();
 302   if federation.enabled {
 303     let distinct_communities = blocking(pool, move |conn| {
 304       Community::distinct_federated_communities(conn)
 305     })
 306     .await??;
 307
 308     let allowed = federation.allowed_instances;
 309     let blocked = federation.blocked_instances;
 310
 311     let mut linked = distinct_communities
 312       .iter()
 313       .map(|actor_id| Ok(actor_id.host_str().unwrap_or("").to_string()))
 314       .collect::<Result<Vec<String>, LemmyError>>()?;
 315
 316     if let Some(allowed) = allowed.as_ref() {
 317       linked.extend_from_slice(allowed);
 318     }
 319
 320     if let Some(blocked) = blocked.as_ref() {
 321       linked.retain(|a| !blocked.contains(a) && !a.eq(hostname));
 322     }
 323
 324     // Sort and remove dupes
 325     linked.sort_unstable();
 326     linked.dedup();
 327
 328     Ok(Some(FederatedInstances {
 329       linked,
 330       allowed,
 331       blocked,
 332     }))
 333   } else {
 334     Ok(None)
 335   }
 336 }
 337
 338 /// Checks the password length
 339 pub fn password_length_check(pass: &str) -> Result<(), LemmyError> {
 340   if !(10..=60).contains(&pass.len()) {
 341     Err(LemmyError::from_message("invalid_password"))
 342   } else {
 343     Ok(())
 344   }
 345 }
 346
 347 /// Checks the site description length
 348 pub fn site_description_length_check(description: &str) -> Result<(), LemmyError> {
 349   if description.len() > 150 {
 350     Err(LemmyError::from_message("site_description_length_overflow"))
 351   } else {
 352     Ok(())
 353   }
 354 }
 355
 356 /// Checks for a honeypot. If this field is filled, fail the rest of the function
 357 pub fn honeypot_check(honeypot: &Option<String>) -> Result<(), LemmyError> {
 358   if honeypot.is_some() {
 359     Err(LemmyError::from_message("honeypot_fail"))
 360   } else {
 361     Ok(())
 362   }
 363 }
 364
 365 pub fn send_email_to_user(
 366   local_user_view: &LocalUserView,
 367   subject_text: &str,
 368   body_text: &str,
 369   comment_content: &str,
 370   settings: &Settings,
 371 ) {
 372   if local_user_view.person.banned || !local_user_view.local_user.send_notifications_to_email {
 373     return;
 374   }
 375
 376   if let Some(user_email) = &local_user_view.local_user.email {
 377     let subject = &format!(
 378       "{} - {} {}",
 379       subject_text, settings.hostname, local_user_view.person.name,
 380     );
 381     let html = &format!(
 382       "<h1>{}</h1><br><div>{} - {}</div><br><a href={}/inbox>inbox</a>",
 383       body_text,
 384       local_user_view.person.name,
 385       comment_content,
 386       settings.get_protocol_and_hostname()
 387     );
 388     match send_email(
 389       subject,
 390       user_email,
 391       &local_user_view.person.name,
 392       html,
 393       settings,
 394     ) {
 395       Ok(_o) => _o,
 396       Err(e) => tracing::error!("{}", e),
 397     };
 398   }
 399 }
 400
 401 pub async fn send_password_reset_email(
 402   local_user_view: &LocalUserView,
 403   pool: &DbPool,
 404   settings: &Settings,
 405 ) -> Result<(), LemmyError> {
 406   // Generate a random token
 407   let token = generate_random_string();
 408
 409   // Insert the row
 410   let token2 = token.clone();
 411   let local_user_id = local_user_view.local_user.id;
 412   blocking(pool, move |conn| {
 413     PasswordResetRequest::create_token(conn, local_user_id, &token2)
 414   })
 415   .await??;
 416
 417   let email = &local_user_view.local_user.email.to_owned().expect("email");
 418   let subject = &format!("Password reset for {}", local_user_view.person.name);
 419   let protocol_and_hostname = settings.get_protocol_and_hostname();
 420   let html = &format!("<h1>Password Reset Request for {}</h1><br><a href={}/password_change/{}>Click here to reset your password</a>", local_user_view.person.name, protocol_and_hostname, &token);
 421   send_email(subject, email, &local_user_view.person.name, html, settings)
 422 }
 423
 424 /// Send a verification email
 425 pub async fn send_verification_email(
 426   local_user_id: LocalUserId,
 427   new_email: &str,
 428   username: &str,
 429   pool: &DbPool,
 430   settings: &Settings,
 431 ) -> Result<(), LemmyError> {
 432   let form = EmailVerificationForm {
 433     local_user_id,
 434     email: new_email.to_string(),
 435     verification_token: generate_random_string(),
 436   };
 437   let verify_link = format!(
 438     "{}/verify_email/{}",
 439     settings.get_protocol_and_hostname(),
 440     &form.verification_token
 441   );
 442   blocking(pool, move |conn| EmailVerification::create(conn, &form)).await??;
 443
 444   let subject = format!("Verify your email address for {}", settings.hostname);
 445   let body = format!(
 446     concat!(
 447       "Please click the link below to verify your email address ",
 448       "for the account @{}@{}. Ignore this email if the account isn't yours.<br><br>",
 449       "<a href=\"{}\">Verify your email</a>"
 450     ),
 451     username, settings.hostname, verify_link
 452   );
 453   send_email(&subject, new_email, username, &body, settings)?;
 454
 455   Ok(())
 456 }
 457
 458 pub fn send_email_verification_success(
 459   local_user_view: &LocalUserView,
 460   settings: &Settings,
 461 ) -> Result<(), LemmyError> {
 462   let email = &local_user_view.local_user.email.to_owned().expect("email");
 463   let subject = &format!("Email verified for {}", local_user_view.person.actor_id);
 464   let html = "Your email has been verified.";
 465   send_email(subject, email, &local_user_view.person.name, html, settings)
 466 }
 467
 468 pub fn send_application_approved_email(
 469   local_user_view: &LocalUserView,
 470   settings: &Settings,
 471 ) -> Result<(), LemmyError> {
 472   let email = &local_user_view.local_user.email.to_owned().expect("email");
 473   let subject = &format!(
 474     "Registration approved for {}",
 475     local_user_view.person.actor_id
 476   );
 477   let html = &format!(
 478     "Your registration application has been approved. Welcome to {}!",
 479     settings.hostname
 480   );
 481   send_email(subject, email, &local_user_view.person.name, html, settings)
 482 }
 483
 484 pub async fn check_registration_application(
 485   site: &Site,
 486   local_user_view: &LocalUserView,
 487   pool: &DbPool,
 488 ) -> Result<(), LemmyError> {
 489   if site.require_application
 490     && !local_user_view.local_user.accepted_application
 491     && !local_user_view.person.admin
 492   {
 493     // Fetch the registration, see if its denied
 494     let local_user_id = local_user_view.local_user.id;
 495     let registration = blocking(pool, move |conn| {
 496       RegistrationApplication::find_by_local_user_id(conn, local_user_id)
 497     })
 498     .await??;
 499     if registration.deny_reason.is_some() {
 500       return Err(LemmyError::from_message("registration_denied"));
 501     } else {
 502       return Err(LemmyError::from_message("registration_application_pending"));
 503     }
 504   }
 505   Ok(())
 506 }
 507
 508 /// TODO this check should be removed after https://github.com/LemmyNet/lemmy/issues/868 is done.
 509 pub async fn check_private_instance_and_federation_enabled(
 510   pool: &DbPool,
 511   settings: &Settings,
 512 ) -> Result<(), LemmyError> {
 513   let site_opt = blocking(pool, Site::read_local_site).await?;
 514
 515   if let Ok(site) = site_opt {
 516     if site.private_instance && settings.federation.enabled {
 517       return Err(LemmyError::from_message(
 518         "Cannot have both private instance and federation enabled.",
 519       ));
 520     }
 521   }
 522   Ok(())
 523 }
 524
 525 /// Resolve actor identifier (eg `!news@example.com`) from local database to avoid network requests.
 526 /// This only works for local actors, and remote actors which were previously fetched (so it doesnt
 527 /// trigger any new fetch).
 528 #[tracing::instrument(skip_all)]
 529 pub async fn resolve_actor_identifier<Actor>(
 530   identifier: &str,
 531   pool: &DbPool,
 532 ) -> Result<Actor, LemmyError>
 533 where
 534   Actor: ApubActor + Send + 'static,
 535 {
 536   // remote actor
 537   if identifier.contains('@') {
 538     let (name, domain) = identifier
 539       .splitn(2, '@')
 540       .collect_tuple()
 541       .expect("invalid query");
 542     let name = name.to_string();
 543     let domain = format!("{}://{}", Settings::get().get_protocol_string(), domain);
 544     Ok(
 545       blocking(pool, move |conn| {
 546         Actor::read_from_name_and_domain(conn, &name, &domain)
 547       })
 548       .await??,
 549     )
 550   }
 551   // local actor
 552   else {
 553     let identifier = identifier.to_string();
 554     Ok(blocking(pool, move |conn| Actor::read_from_name(conn, &identifier)).await??)
 555   }
 556 }
 557
 558 pub async fn remove_user_data(banned_person_id: PersonId, pool: &DbPool) -> Result<(), LemmyError> {
 559   // Posts
 560   blocking(pool, move |conn: &'_ _| {
 561     Post::update_removed_for_creator(conn, banned_person_id, None, true)
 562   })
 563   .await??;
 564
 565   // Communities
 566   // Remove all communities where they're the top mod
 567   // for now, remove the communities manually
 568   let first_mod_communities = blocking(pool, move |conn: &'_ _| {
 569     CommunityModeratorView::get_community_first_mods(conn)
 570   })
 571   .await??;
 572
 573   // Filter to only this banned users top communities
 574   let banned_user_first_communities: Vec<CommunityModeratorView> = first_mod_communities
 575     .into_iter()
 576     .filter(|fmc| fmc.moderator.id == banned_person_id)
 577     .collect();
 578
 579   for first_mod_community in banned_user_first_communities {
 580     blocking(pool, move |conn: &'_ _| {
 581       Community::update_removed(conn, first_mod_community.community.id, true)
 582     })
 583     .await??;
 584   }
 585
 586   // Comments
 587   blocking(pool, move |conn: &'_ _| {
 588     Comment::update_removed_for_creator(conn, banned_person_id, true)
 589   })
 590   .await??;
 591
 592   Ok(())
 593 }
 594
 595 pub async fn remove_user_data_in_community(
 596   community_id: CommunityId,
 597   banned_person_id: PersonId,
 598   pool: &DbPool,
 599 ) -> Result<(), LemmyError> {
 600   // Posts
 601   blocking(pool, move |conn| {
 602     Post::update_removed_for_creator(conn, banned_person_id, Some(community_id), true)
 603   })
 604   .await??;
 605
 606   // Comments
 607   // TODO Diesel doesn't allow updates with joins, so this has to be a loop
 608   let comments = blocking(pool, move |conn| {
 609     CommentQueryBuilder::create(conn)
 610       .creator_id(banned_person_id)
 611       .community_id(community_id)
 612       .limit(std::i64::MAX)
 613       .list()
 614   })
 615   .await??;
 616
 617   for comment_view in &comments {
 618     let comment_id = comment_view.comment.id;
 619     blocking(pool, move |conn| {
 620       Comment::update_removed(conn, comment_id, true)
 621     })
 622     .await??;
 623   }
 624
 625   Ok(())
 626 }
 627
 628 pub fn check_image_has_local_domain(url: &Option<String>) -> Result<(), LemmyError> {
 629   if let Some(url) = url {
 630     let settings = Settings::get();
 631     let url = Url::parse(url)?;
 632     let domain = url.domain().expect("url has domain");
 633     if domain != settings.hostname {
 634       return Err(LemmyError::from_message("image_not_local"));
 635     }
 636   }
 637   Ok(())
 638 }