lemmy_api/src/lib.rs

   1 use crate::claims::Claims;
   2 use actix_web::{web, web::Data};
   3 use lemmy_db_queries::{
   4   source::{
   5     community::{CommunityModerator_, Community_},
   6     site::Site_,
   7     user::UserSafeSettings_,
   8   },
   9   Crud,
  10   DbPool,
  11 };
  12 use lemmy_db_schema::source::{
  13   community::{Community, CommunityModerator},
  14   post::Post,
  15   site::Site,
  16   user::{UserSafeSettings, User_},
  17 };
  18 use lemmy_db_views_actor::{
  19   community_user_ban_view::CommunityUserBanView,
  20   community_view::CommunityView,
  21 };
  22 use lemmy_structs::{blocking, comment::*, community::*, post::*, site::*, user::*, websocket::*};
  23 use lemmy_utils::{settings::Settings, APIError, ConnectionId, LemmyError};
  24 use lemmy_websocket::{serialize_websocket_message, LemmyContext, UserOperation};
  25 use serde::Deserialize;
  26 use std::process::Command;
  27 use url::Url;
  28
  29 pub mod claims;
  30 pub mod comment;
  31 pub mod community;
  32 pub mod post;
  33 pub mod site;
  34 pub mod user;
  35 pub mod version;
  36 pub mod websocket;
  37
  38 #[async_trait::async_trait(?Send)]
  39 pub trait Perform {
  40   type Response: serde::ser::Serialize + Send;
  41
  42   async fn perform(
  43     &self,
  44     context: &Data<LemmyContext>,
  45     websocket_id: Option<ConnectionId>,
  46   ) -> Result<Self::Response, LemmyError>;
  47 }
  48
  49 pub(crate) async fn is_mod_or_admin(
  50   pool: &DbPool,
  51   user_id: i32,
  52   community_id: i32,
  53 ) -> Result<(), LemmyError> {
  54   let is_mod_or_admin = blocking(pool, move |conn| {
  55     CommunityView::is_mod_or_admin(conn, user_id, community_id)
  56   })
  57   .await?;
  58   if !is_mod_or_admin {
  59     return Err(APIError::err("not_a_mod_or_admin").into());
  60   }
  61   Ok(())
  62 }
  63 pub async fn is_admin(pool: &DbPool, user_id: i32) -> Result<(), LemmyError> {
  64   let user = blocking(pool, move |conn| User_::read(conn, user_id)).await??;
  65   if !user.admin {
  66     return Err(APIError::err("not_an_admin").into());
  67   }
  68   Ok(())
  69 }
  70
  71 pub(crate) async fn get_post(post_id: i32, pool: &DbPool) -> Result<Post, LemmyError> {
  72   match blocking(pool, move |conn| Post::read(conn, post_id)).await? {
  73     Ok(post) => Ok(post),
  74     Err(_e) => Err(APIError::err("couldnt_find_post").into()),
  75   }
  76 }
  77
  78 pub(crate) async fn get_user_from_jwt(jwt: &str, pool: &DbPool) -> Result<User_, LemmyError> {
  79   let claims = match Claims::decode(&jwt) {
  80     Ok(claims) => claims.claims,
  81     Err(_e) => return Err(APIError::err("not_logged_in").into()),
  82   };
  83   let user_id = claims.id;
  84   let user = blocking(pool, move |conn| User_::read(conn, user_id)).await??;
  85   // Check for a site ban
  86   if user.banned {
  87     return Err(APIError::err("site_ban").into());
  88   }
  89   Ok(user)
  90 }
  91
  92 pub(crate) async fn get_user_from_jwt_opt(
  93   jwt: &Option<String>,
  94   pool: &DbPool,
  95 ) -> Result<Option<User_>, LemmyError> {
  96   match jwt {
  97     Some(jwt) => Ok(Some(get_user_from_jwt(jwt, pool).await?)),
  98     None => Ok(None),
  99   }
 100 }
 101
 102 pub(crate) async fn get_user_safe_settings_from_jwt(
 103   jwt: &str,
 104   pool: &DbPool,
 105 ) -> Result<UserSafeSettings, LemmyError> {
 106   let claims = match Claims::decode(&jwt) {
 107     Ok(claims) => claims.claims,
 108     Err(_e) => return Err(APIError::err("not_logged_in").into()),
 109   };
 110   let user_id = claims.id;
 111   let user = blocking(pool, move |conn| UserSafeSettings::read(conn, user_id)).await??;
 112   // Check for a site ban
 113   if user.banned {
 114     return Err(APIError::err("site_ban").into());
 115   }
 116   Ok(user)
 117 }
 118
 119 pub(crate) async fn get_user_safe_settings_from_jwt_opt(
 120   jwt: &Option<String>,
 121   pool: &DbPool,
 122 ) -> Result<Option<UserSafeSettings>, LemmyError> {
 123   match jwt {
 124     Some(jwt) => Ok(Some(get_user_safe_settings_from_jwt(jwt, pool).await?)),
 125     None => Ok(None),
 126   }
 127 }
 128
 129 pub(crate) async fn check_community_ban(
 130   user_id: i32,
 131   community_id: i32,
 132   pool: &DbPool,
 133 ) -> Result<(), LemmyError> {
 134   let is_banned = move |conn: &'_ _| CommunityUserBanView::get(conn, user_id, community_id).is_ok();
 135   if blocking(pool, is_banned).await? {
 136     Err(APIError::err("community_ban").into())
 137   } else {
 138     Ok(())
 139   }
 140 }
 141
 142 pub(crate) async fn check_downvotes_enabled(score: i16, pool: &DbPool) -> Result<(), LemmyError> {
 143   if score == -1 {
 144     let site = blocking(pool, move |conn| Site::read_simple(conn)).await??;
 145     if !site.enable_downvotes {
 146       return Err(APIError::err("downvotes_disabled").into());
 147     }
 148   }
 149   Ok(())
 150 }
 151
 152 /// Returns a list of communities that the user moderates
 153 /// or if a community_id is supplied validates the user is a moderator
 154 /// of that community and returns the community id in a vec
 155 ///
 156 /// * `user_id` - the user id of the moderator
 157 /// * `community_id` - optional community id to check for moderator privileges
 158 /// * `pool` - the diesel db pool
 159 pub(crate) async fn collect_moderated_communities(
 160   user_id: i32,
 161   community_id: Option<i32>,
 162   pool: &DbPool,
 163 ) -> Result<Vec<i32>, LemmyError> {
 164   if let Some(community_id) = community_id {
 165     // if the user provides a community_id, just check for mod/admin privileges
 166     is_mod_or_admin(pool, user_id, community_id).await?;
 167     Ok(vec![community_id])
 168   } else {
 169     let ids = blocking(pool, move |conn: &'_ _| {
 170       CommunityModerator::get_user_moderated_communities(conn, user_id)
 171     })
 172     .await??;
 173     Ok(ids)
 174   }
 175 }
 176
 177 pub(crate) fn check_optional_url(item: &Option<Option<String>>) -> Result<(), LemmyError> {
 178   if let Some(Some(item)) = &item {
 179     if Url::parse(item).is_err() {
 180       return Err(APIError::err("invalid_url").into());
 181     }
 182   }
 183   Ok(())
 184 }
 185
 186 pub(crate) async fn linked_instances(pool: &DbPool) -> Result<Vec<String>, LemmyError> {
 187   let mut instances: Vec<String> = Vec::new();
 188
 189   if Settings::get().federation.enabled {
 190     let distinct_communities = blocking(pool, move |conn| {
 191       Community::distinct_federated_communities(conn)
 192     })
 193     .await??;
 194
 195     instances = distinct_communities
 196       .iter()
 197       .map(|actor_id| Ok(Url::parse(actor_id)?.host_str().unwrap_or("").to_string()))
 198       .collect::<Result<Vec<String>, LemmyError>>()?;
 199
 200     instances.append(&mut Settings::get().get_allowed_instances());
 201     instances.retain(|a| {
 202       !Settings::get().get_blocked_instances().contains(a)
 203         && !a.eq("")
 204         && !a.eq(&Settings::get().hostname)
 205     });
 206
 207     // Sort and remove dupes
 208     instances.sort_unstable();
 209     instances.dedup();
 210   }
 211
 212   Ok(instances)
 213 }
 214
 215 pub async fn match_websocket_operation(
 216   context: LemmyContext,
 217   id: ConnectionId,
 218   op: UserOperation,
 219   data: &str,
 220 ) -> Result<String, LemmyError> {
 221   match op {
 222     // User ops
 223     UserOperation::Login => do_websocket_operation::<Login>(context, id, op, data).await,
 224     UserOperation::Register => do_websocket_operation::<Register>(context, id, op, data).await,
 225     UserOperation::GetCaptcha => do_websocket_operation::<GetCaptcha>(context, id, op, data).await,
 226     UserOperation::GetUserDetails => {
 227       do_websocket_operation::<GetUserDetails>(context, id, op, data).await
 228     }
 229     UserOperation::GetReplies => do_websocket_operation::<GetReplies>(context, id, op, data).await,
 230     UserOperation::AddAdmin => do_websocket_operation::<AddAdmin>(context, id, op, data).await,
 231     UserOperation::BanUser => do_websocket_operation::<BanUser>(context, id, op, data).await,
 232     UserOperation::GetUserMentions => {
 233       do_websocket_operation::<GetUserMentions>(context, id, op, data).await
 234     }
 235     UserOperation::MarkUserMentionAsRead => {
 236       do_websocket_operation::<MarkUserMentionAsRead>(context, id, op, data).await
 237     }
 238     UserOperation::MarkAllAsRead => {
 239       do_websocket_operation::<MarkAllAsRead>(context, id, op, data).await
 240     }
 241     UserOperation::DeleteAccount => {
 242       do_websocket_operation::<DeleteAccount>(context, id, op, data).await
 243     }
 244     UserOperation::PasswordReset => {
 245       do_websocket_operation::<PasswordReset>(context, id, op, data).await
 246     }
 247     UserOperation::PasswordChange => {
 248       do_websocket_operation::<PasswordChange>(context, id, op, data).await
 249     }
 250     UserOperation::UserJoin => do_websocket_operation::<UserJoin>(context, id, op, data).await,
 251     UserOperation::PostJoin => do_websocket_operation::<PostJoin>(context, id, op, data).await,
 252     UserOperation::CommunityJoin => {
 253       do_websocket_operation::<CommunityJoin>(context, id, op, data).await
 254     }
 255     UserOperation::ModJoin => do_websocket_operation::<ModJoin>(context, id, op, data).await,
 256     UserOperation::SaveUserSettings => {
 257       do_websocket_operation::<SaveUserSettings>(context, id, op, data).await
 258     }
 259     UserOperation::GetReportCount => {
 260       do_websocket_operation::<GetReportCount>(context, id, op, data).await
 261     }
 262
 263     // Private Message ops
 264     UserOperation::CreatePrivateMessage => {
 265       do_websocket_operation::<CreatePrivateMessage>(context, id, op, data).await
 266     }
 267     UserOperation::EditPrivateMessage => {
 268       do_websocket_operation::<EditPrivateMessage>(context, id, op, data).await
 269     }
 270     UserOperation::DeletePrivateMessage => {
 271       do_websocket_operation::<DeletePrivateMessage>(context, id, op, data).await
 272     }
 273     UserOperation::MarkPrivateMessageAsRead => {
 274       do_websocket_operation::<MarkPrivateMessageAsRead>(context, id, op, data).await
 275     }
 276     UserOperation::GetPrivateMessages => {
 277       do_websocket_operation::<GetPrivateMessages>(context, id, op, data).await
 278     }
 279
 280     // Site ops
 281     UserOperation::GetModlog => do_websocket_operation::<GetModlog>(context, id, op, data).await,
 282     UserOperation::CreateSite => do_websocket_operation::<CreateSite>(context, id, op, data).await,
 283     UserOperation::EditSite => do_websocket_operation::<EditSite>(context, id, op, data).await,
 284     UserOperation::GetSite => do_websocket_operation::<GetSite>(context, id, op, data).await,
 285     UserOperation::GetSiteConfig => {
 286       do_websocket_operation::<GetSiteConfig>(context, id, op, data).await
 287     }
 288     UserOperation::SaveSiteConfig => {
 289       do_websocket_operation::<SaveSiteConfig>(context, id, op, data).await
 290     }
 291     UserOperation::Search => do_websocket_operation::<Search>(context, id, op, data).await,
 292     UserOperation::TransferCommunity => {
 293       do_websocket_operation::<TransferCommunity>(context, id, op, data).await
 294     }
 295     UserOperation::TransferSite => {
 296       do_websocket_operation::<TransferSite>(context, id, op, data).await
 297     }
 298     UserOperation::ListCategories => {
 299       do_websocket_operation::<ListCategories>(context, id, op, data).await
 300     }
 301
 302     // Community ops
 303     UserOperation::GetCommunity => {
 304       do_websocket_operation::<GetCommunity>(context, id, op, data).await
 305     }
 306     UserOperation::ListCommunities => {
 307       do_websocket_operation::<ListCommunities>(context, id, op, data).await
 308     }
 309     UserOperation::CreateCommunity => {
 310       do_websocket_operation::<CreateCommunity>(context, id, op, data).await
 311     }
 312     UserOperation::EditCommunity => {
 313       do_websocket_operation::<EditCommunity>(context, id, op, data).await
 314     }
 315     UserOperation::DeleteCommunity => {
 316       do_websocket_operation::<DeleteCommunity>(context, id, op, data).await
 317     }
 318     UserOperation::RemoveCommunity => {
 319       do_websocket_operation::<RemoveCommunity>(context, id, op, data).await
 320     }
 321     UserOperation::FollowCommunity => {
 322       do_websocket_operation::<FollowCommunity>(context, id, op, data).await
 323     }
 324     UserOperation::GetFollowedCommunities => {
 325       do_websocket_operation::<GetFollowedCommunities>(context, id, op, data).await
 326     }
 327     UserOperation::BanFromCommunity => {
 328       do_websocket_operation::<BanFromCommunity>(context, id, op, data).await
 329     }
 330     UserOperation::AddModToCommunity => {
 331       do_websocket_operation::<AddModToCommunity>(context, id, op, data).await
 332     }
 333
 334     // Post ops
 335     UserOperation::CreatePost => do_websocket_operation::<CreatePost>(context, id, op, data).await,
 336     UserOperation::GetPost => do_websocket_operation::<GetPost>(context, id, op, data).await,
 337     UserOperation::GetPosts => do_websocket_operation::<GetPosts>(context, id, op, data).await,
 338     UserOperation::EditPost => do_websocket_operation::<EditPost>(context, id, op, data).await,
 339     UserOperation::DeletePost => do_websocket_operation::<DeletePost>(context, id, op, data).await,
 340     UserOperation::RemovePost => do_websocket_operation::<RemovePost>(context, id, op, data).await,
 341     UserOperation::LockPost => do_websocket_operation::<LockPost>(context, id, op, data).await,
 342     UserOperation::StickyPost => do_websocket_operation::<StickyPost>(context, id, op, data).await,
 343     UserOperation::CreatePostLike => {
 344       do_websocket_operation::<CreatePostLike>(context, id, op, data).await
 345     }
 346     UserOperation::SavePost => do_websocket_operation::<SavePost>(context, id, op, data).await,
 347     UserOperation::CreatePostReport => {
 348       do_websocket_operation::<CreatePostReport>(context, id, op, data).await
 349     }
 350     UserOperation::ListPostReports => {
 351       do_websocket_operation::<ListPostReports>(context, id, op, data).await
 352     }
 353     UserOperation::ResolvePostReport => {
 354       do_websocket_operation::<ResolvePostReport>(context, id, op, data).await
 355     }
 356
 357     // Comment ops
 358     UserOperation::CreateComment => {
 359       do_websocket_operation::<CreateComment>(context, id, op, data).await
 360     }
 361     UserOperation::EditComment => {
 362       do_websocket_operation::<EditComment>(context, id, op, data).await
 363     }
 364     UserOperation::DeleteComment => {
 365       do_websocket_operation::<DeleteComment>(context, id, op, data).await
 366     }
 367     UserOperation::RemoveComment => {
 368       do_websocket_operation::<RemoveComment>(context, id, op, data).await
 369     }
 370     UserOperation::MarkCommentAsRead => {
 371       do_websocket_operation::<MarkCommentAsRead>(context, id, op, data).await
 372     }
 373     UserOperation::SaveComment => {
 374       do_websocket_operation::<SaveComment>(context, id, op, data).await
 375     }
 376     UserOperation::GetComments => {
 377       do_websocket_operation::<GetComments>(context, id, op, data).await
 378     }
 379     UserOperation::CreateCommentLike => {
 380       do_websocket_operation::<CreateCommentLike>(context, id, op, data).await
 381     }
 382     UserOperation::CreateCommentReport => {
 383       do_websocket_operation::<CreateCommentReport>(context, id, op, data).await
 384     }
 385     UserOperation::ListCommentReports => {
 386       do_websocket_operation::<ListCommentReports>(context, id, op, data).await
 387     }
 388     UserOperation::ResolveCommentReport => {
 389       do_websocket_operation::<ResolveCommentReport>(context, id, op, data).await
 390     }
 391   }
 392 }
 393
 394 async fn do_websocket_operation<'a, 'b, Data>(
 395   context: LemmyContext,
 396   id: ConnectionId,
 397   op: UserOperation,
 398   data: &str,
 399 ) -> Result<String, LemmyError>
 400 where
 401   for<'de> Data: Deserialize<'de> + 'a,
 402   Data: Perform,
 403 {
 404   let parsed_data: Data = serde_json::from_str(&data)?;
 405   let res = parsed_data
 406     .perform(&web::Data::new(context), Some(id))
 407     .await?;
 408   serialize_websocket_message(&op, &res)
 409 }
 410
 411 pub(crate) fn captcha_espeak_wav_base64(captcha: &str) -> Result<String, LemmyError> {
 412   let mut built_text = String::new();
 413
 414   // Building proper speech text for espeak
 415   for mut c in captcha.chars() {
 416     let new_str = if c.is_alphabetic() {
 417       if c.is_lowercase() {
 418         c.make_ascii_uppercase();
 419         format!("lower case {} ... ", c)
 420       } else {
 421         c.make_ascii_uppercase();
 422         format!("capital {} ... ", c)
 423       }
 424     } else {
 425       format!("{} ...", c)
 426     };
 427
 428     built_text.push_str(&new_str);
 429   }
 430
 431   espeak_wav_base64(&built_text)
 432 }
 433
 434 pub(crate) fn espeak_wav_base64(text: &str) -> Result<String, LemmyError> {
 435   // Make a temp file path
 436   let uuid = uuid::Uuid::new_v4().to_string();
 437   let file_path = format!("/tmp/lemmy_espeak_{}.wav", &uuid);
 438
 439   // Write the wav file
 440   Command::new("espeak")
 441     .arg("-w")
 442     .arg(&file_path)
 443     .arg(text)
 444     .status()?;
 445
 446   // Read the wav file bytes
 447   let bytes = std::fs::read(&file_path)?;
 448
 449   // Delete the file
 450   std::fs::remove_file(file_path)?;
 451
 452   // Convert to base64
 453   let base64 = base64::encode(bytes);
 454
 455   Ok(base64)
 456 }
 457
 458 #[cfg(test)]
 459 mod tests {
 460   use crate::captcha_espeak_wav_base64;
 461
 462   #[test]
 463   fn test_espeak() {
 464     assert!(captcha_espeak_wav_base64("WxRt2l").is_ok())
 465   }
 466 }