crates/api/src/lib.rs

   1 use actix_web::{web, web::Data};
   2 use captcha::Captcha;
   3 use lemmy_api_common::{comment::*, community::*, person::*, post::*, site::*, websocket::*};
   4 use lemmy_utils::{ConnectionId, LemmyError};
   5 use lemmy_websocket::{serialize_websocket_message, LemmyContext, UserOperation};
   6 use serde::Deserialize;
   7
   8 mod comment;
   9 mod comment_report;
  10 mod community;
  11 mod local_user;
  12 mod post;
  13 mod post_report;
  14 mod private_message;
  15 mod site;
  16 mod websocket;
  17
  18 #[async_trait::async_trait(?Send)]
  19 pub trait Perform {
  20   type Response: serde::ser::Serialize + Send;
  21
  22   async fn perform(
  23     &self,
  24     context: &Data<LemmyContext>,
  25     websocket_id: Option<ConnectionId>,
  26   ) -> Result<Self::Response, LemmyError>;
  27 }
  28
  29 pub async fn match_websocket_operation(
  30   context: LemmyContext,
  31   id: ConnectionId,
  32   op: UserOperation,
  33   data: &str,
  34 ) -> Result<String, LemmyError> {
  35   match op {
  36     // User ops
  37     UserOperation::Login => do_websocket_operation::<Login>(context, id, op, data).await,
  38     UserOperation::GetCaptcha => do_websocket_operation::<GetCaptcha>(context, id, op, data).await,
  39     UserOperation::GetReplies => do_websocket_operation::<GetReplies>(context, id, op, data).await,
  40     UserOperation::AddAdmin => do_websocket_operation::<AddAdmin>(context, id, op, data).await,
  41     UserOperation::BanPerson => do_websocket_operation::<BanPerson>(context, id, op, data).await,
  42     UserOperation::GetPersonMentions => {
  43       do_websocket_operation::<GetPersonMentions>(context, id, op, data).await
  44     }
  45     UserOperation::MarkPersonMentionAsRead => {
  46       do_websocket_operation::<MarkPersonMentionAsRead>(context, id, op, data).await
  47     }
  48     UserOperation::MarkAllAsRead => {
  49       do_websocket_operation::<MarkAllAsRead>(context, id, op, data).await
  50     }
  51     UserOperation::PasswordReset => {
  52       do_websocket_operation::<PasswordReset>(context, id, op, data).await
  53     }
  54     UserOperation::PasswordChange => {
  55       do_websocket_operation::<PasswordChange>(context, id, op, data).await
  56     }
  57     UserOperation::UserJoin => do_websocket_operation::<UserJoin>(context, id, op, data).await,
  58     UserOperation::PostJoin => do_websocket_operation::<PostJoin>(context, id, op, data).await,
  59     UserOperation::CommunityJoin => {
  60       do_websocket_operation::<CommunityJoin>(context, id, op, data).await
  61     }
  62     UserOperation::ModJoin => do_websocket_operation::<ModJoin>(context, id, op, data).await,
  63     UserOperation::SaveUserSettings => {
  64       do_websocket_operation::<SaveUserSettings>(context, id, op, data).await
  65     }
  66     UserOperation::ChangePassword => {
  67       do_websocket_operation::<ChangePassword>(context, id, op, data).await
  68     }
  69     UserOperation::GetReportCount => {
  70       do_websocket_operation::<GetReportCount>(context, id, op, data).await
  71     }
  72
  73     // Private Message ops
  74     UserOperation::MarkPrivateMessageAsRead => {
  75       do_websocket_operation::<MarkPrivateMessageAsRead>(context, id, op, data).await
  76     }
  77
  78     // Site ops
  79     UserOperation::GetModlog => do_websocket_operation::<GetModlog>(context, id, op, data).await,
  80     UserOperation::GetSiteConfig => {
  81       do_websocket_operation::<GetSiteConfig>(context, id, op, data).await
  82     }
  83     UserOperation::SaveSiteConfig => {
  84       do_websocket_operation::<SaveSiteConfig>(context, id, op, data).await
  85     }
  86     UserOperation::Search => do_websocket_operation::<Search>(context, id, op, data).await,
  87     UserOperation::TransferCommunity => {
  88       do_websocket_operation::<TransferCommunity>(context, id, op, data).await
  89     }
  90     UserOperation::TransferSite => {
  91       do_websocket_operation::<TransferSite>(context, id, op, data).await
  92     }
  93
  94     // Community ops
  95     UserOperation::FollowCommunity => {
  96       do_websocket_operation::<FollowCommunity>(context, id, op, data).await
  97     }
  98     UserOperation::GetFollowedCommunities => {
  99       do_websocket_operation::<GetFollowedCommunities>(context, id, op, data).await
 100     }
 101     UserOperation::BanFromCommunity => {
 102       do_websocket_operation::<BanFromCommunity>(context, id, op, data).await
 103     }
 104     UserOperation::AddModToCommunity => {
 105       do_websocket_operation::<AddModToCommunity>(context, id, op, data).await
 106     }
 107
 108     // Post ops
 109     UserOperation::LockPost => do_websocket_operation::<LockPost>(context, id, op, data).await,
 110     UserOperation::StickyPost => do_websocket_operation::<StickyPost>(context, id, op, data).await,
 111     UserOperation::CreatePostLike => {
 112       do_websocket_operation::<CreatePostLike>(context, id, op, data).await
 113     }
 114     UserOperation::SavePost => do_websocket_operation::<SavePost>(context, id, op, data).await,
 115     UserOperation::CreatePostReport => {
 116       do_websocket_operation::<CreatePostReport>(context, id, op, data).await
 117     }
 118     UserOperation::ListPostReports => {
 119       do_websocket_operation::<ListPostReports>(context, id, op, data).await
 120     }
 121     UserOperation::ResolvePostReport => {
 122       do_websocket_operation::<ResolvePostReport>(context, id, op, data).await
 123     }
 124
 125     // Comment ops
 126     UserOperation::MarkCommentAsRead => {
 127       do_websocket_operation::<MarkCommentAsRead>(context, id, op, data).await
 128     }
 129     UserOperation::SaveComment => {
 130       do_websocket_operation::<SaveComment>(context, id, op, data).await
 131     }
 132     UserOperation::CreateCommentLike => {
 133       do_websocket_operation::<CreateCommentLike>(context, id, op, data).await
 134     }
 135     UserOperation::CreateCommentReport => {
 136       do_websocket_operation::<CreateCommentReport>(context, id, op, data).await
 137     }
 138     UserOperation::ListCommentReports => {
 139       do_websocket_operation::<ListCommentReports>(context, id, op, data).await
 140     }
 141     UserOperation::ResolveCommentReport => {
 142       do_websocket_operation::<ResolveCommentReport>(context, id, op, data).await
 143     }
 144   }
 145 }
 146
 147 async fn do_websocket_operation<'a, 'b, Data>(
 148   context: LemmyContext,
 149   id: ConnectionId,
 150   op: UserOperation,
 151   data: &str,
 152 ) -> Result<String, LemmyError>
 153 where
 154   for<'de> Data: Deserialize<'de> + 'a,
 155   Data: Perform,
 156 {
 157   let parsed_data: Data = serde_json::from_str(&data)?;
 158   let res = parsed_data
 159     .perform(&web::Data::new(context), Some(id))
 160     .await?;
 161   serialize_websocket_message(&op, &res)
 162 }
 163
 164 /// Converts the captcha to a base64 encoded wav audio file
 165 pub(crate) fn captcha_as_wav_base64(captcha: &Captcha) -> String {
 166   let letters = captcha.as_wav();
 167
 168   let mut concat_letters: Vec<u8> = Vec::new();
 169
 170   for letter in letters {
 171     let bytes = letter.unwrap_or_default();
 172     concat_letters.extend(bytes);
 173   }
 174
 175   // Convert to base64
 176   base64::encode(concat_letters)
 177 }
 178
 179 #[cfg(test)]
 180 mod tests {
 181   use lemmy_api_common::check_validator_time;
 182   use lemmy_db_queries::{establish_unpooled_connection, source::local_user::LocalUser_, Crud};
 183   use lemmy_db_schema::source::{
 184     local_user::{LocalUser, LocalUserForm},
 185     person::{Person, PersonForm},
 186   };
 187   use lemmy_utils::claims::Claims;
 188
 189   #[test]
 190   fn test_should_not_validate_user_token_after_password_change() {
 191     let conn = establish_unpooled_connection();
 192
 193     let new_person = PersonForm {
 194       name: "Gerry9812".into(),
 195       ..PersonForm::default()
 196     };
 197
 198     let inserted_person = Person::create(&conn, &new_person).unwrap();
 199
 200     let local_user_form = LocalUserForm {
 201       person_id: inserted_person.id,
 202       password_encrypted: "123456".to_string(),
 203       ..LocalUserForm::default()
 204     };
 205
 206     let inserted_local_user = LocalUser::create(&conn, &local_user_form).unwrap();
 207
 208     let jwt = Claims::jwt(inserted_local_user.id.0).unwrap();
 209     let claims = Claims::decode(&jwt).unwrap().claims;
 210     let check = check_validator_time(&inserted_local_user.validator_time, &claims);
 211     assert!(check.is_ok());
 212
 213     // The check should fail, since the validator time is now newer than the jwt issue time
 214     let updated_local_user =
 215       LocalUser::update_password(&conn, inserted_local_user.id, &"password111").unwrap();
 216     let check_after = check_validator_time(&updated_local_user.validator_time, &claims);
 217     assert!(check_after.is_err());
 218
 219     let num_deleted = Person::delete(&conn, inserted_person.id).unwrap();
 220     assert_eq!(1, num_deleted);
 221   }
 222 }