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::BlockPerson => {
  43       do_websocket_operation::<BlockPerson>(context, id, op, data).await
  44     }
  45     UserOperation::GetPersonMentions => {
  46       do_websocket_operation::<GetPersonMentions>(context, id, op, data).await
  47     }
  48     UserOperation::MarkPersonMentionAsRead => {
  49       do_websocket_operation::<MarkPersonMentionAsRead>(context, id, op, data).await
  50     }
  51     UserOperation::MarkAllAsRead => {
  52       do_websocket_operation::<MarkAllAsRead>(context, id, op, data).await
  53     }
  54     UserOperation::PasswordReset => {
  55       do_websocket_operation::<PasswordReset>(context, id, op, data).await
  56     }
  57     UserOperation::PasswordChange => {
  58       do_websocket_operation::<PasswordChange>(context, id, op, data).await
  59     }
  60     UserOperation::UserJoin => do_websocket_operation::<UserJoin>(context, id, op, data).await,
  61     UserOperation::PostJoin => do_websocket_operation::<PostJoin>(context, id, op, data).await,
  62     UserOperation::CommunityJoin => {
  63       do_websocket_operation::<CommunityJoin>(context, id, op, data).await
  64     }
  65     UserOperation::ModJoin => do_websocket_operation::<ModJoin>(context, id, op, data).await,
  66     UserOperation::SaveUserSettings => {
  67       do_websocket_operation::<SaveUserSettings>(context, id, op, data).await
  68     }
  69     UserOperation::ChangePassword => {
  70       do_websocket_operation::<ChangePassword>(context, id, op, data).await
  71     }
  72     UserOperation::GetReportCount => {
  73       do_websocket_operation::<GetReportCount>(context, id, op, data).await
  74     }
  75
  76     // Private Message ops
  77     UserOperation::MarkPrivateMessageAsRead => {
  78       do_websocket_operation::<MarkPrivateMessageAsRead>(context, id, op, data).await
  79     }
  80
  81     // Site ops
  82     UserOperation::GetModlog => do_websocket_operation::<GetModlog>(context, id, op, data).await,
  83     UserOperation::GetSiteConfig => {
  84       do_websocket_operation::<GetSiteConfig>(context, id, op, data).await
  85     }
  86     UserOperation::SaveSiteConfig => {
  87       do_websocket_operation::<SaveSiteConfig>(context, id, op, data).await
  88     }
  89     UserOperation::Search => do_websocket_operation::<Search>(context, id, op, data).await,
  90     UserOperation::ResolveObject => {
  91       do_websocket_operation::<ResolveObject>(context, id, op, data).await
  92     }
  93     UserOperation::TransferCommunity => {
  94       do_websocket_operation::<TransferCommunity>(context, id, op, data).await
  95     }
  96     UserOperation::TransferSite => {
  97       do_websocket_operation::<TransferSite>(context, id, op, data).await
  98     }
  99
 100     // Community ops
 101     UserOperation::FollowCommunity => {
 102       do_websocket_operation::<FollowCommunity>(context, id, op, data).await
 103     }
 104     UserOperation::BlockCommunity => {
 105       do_websocket_operation::<BlockCommunity>(context, id, op, data).await
 106     }
 107     UserOperation::BanFromCommunity => {
 108       do_websocket_operation::<BanFromCommunity>(context, id, op, data).await
 109     }
 110     UserOperation::AddModToCommunity => {
 111       do_websocket_operation::<AddModToCommunity>(context, id, op, data).await
 112     }
 113
 114     // Post ops
 115     UserOperation::LockPost => do_websocket_operation::<LockPost>(context, id, op, data).await,
 116     UserOperation::StickyPost => do_websocket_operation::<StickyPost>(context, id, op, data).await,
 117     UserOperation::CreatePostLike => {
 118       do_websocket_operation::<CreatePostLike>(context, id, op, data).await
 119     }
 120     UserOperation::SavePost => do_websocket_operation::<SavePost>(context, id, op, data).await,
 121     UserOperation::CreatePostReport => {
 122       do_websocket_operation::<CreatePostReport>(context, id, op, data).await
 123     }
 124     UserOperation::ListPostReports => {
 125       do_websocket_operation::<ListPostReports>(context, id, op, data).await
 126     }
 127     UserOperation::ResolvePostReport => {
 128       do_websocket_operation::<ResolvePostReport>(context, id, op, data).await
 129     }
 130     UserOperation::GetSiteMetadata => {
 131       do_websocket_operation::<GetSiteMetadata>(context, id, op, data).await
 132     }
 133
 134     // Comment ops
 135     UserOperation::MarkCommentAsRead => {
 136       do_websocket_operation::<MarkCommentAsRead>(context, id, op, data).await
 137     }
 138     UserOperation::SaveComment => {
 139       do_websocket_operation::<SaveComment>(context, id, op, data).await
 140     }
 141     UserOperation::CreateCommentLike => {
 142       do_websocket_operation::<CreateCommentLike>(context, id, op, data).await
 143     }
 144     UserOperation::CreateCommentReport => {
 145       do_websocket_operation::<CreateCommentReport>(context, id, op, data).await
 146     }
 147     UserOperation::ListCommentReports => {
 148       do_websocket_operation::<ListCommentReports>(context, id, op, data).await
 149     }
 150     UserOperation::ResolveCommentReport => {
 151       do_websocket_operation::<ResolveCommentReport>(context, id, op, data).await
 152     }
 153   }
 154 }
 155
 156 async fn do_websocket_operation<'a, 'b, Data>(
 157   context: LemmyContext,
 158   id: ConnectionId,
 159   op: UserOperation,
 160   data: &str,
 161 ) -> Result<String, LemmyError>
 162 where
 163   for<'de> Data: Deserialize<'de> + 'a,
 164   Data: Perform,
 165 {
 166   let parsed_data: Data = serde_json::from_str(data)?;
 167   let res = parsed_data
 168     .perform(&web::Data::new(context), Some(id))
 169     .await?;
 170   serialize_websocket_message(&op, &res)
 171 }
 172
 173 /// Converts the captcha to a base64 encoded wav audio file
 174 pub(crate) fn captcha_as_wav_base64(captcha: &Captcha) -> String {
 175   let letters = captcha.as_wav();
 176
 177   let mut concat_letters: Vec<u8> = Vec::new();
 178
 179   for letter in letters {
 180     let bytes = letter.unwrap_or_default();
 181     concat_letters.extend(bytes);
 182   }
 183
 184   // Convert to base64
 185   base64::encode(concat_letters)
 186 }
 187
 188 #[cfg(test)]
 189 mod tests {
 190   use lemmy_api_common::check_validator_time;
 191   use lemmy_db_queries::{
 192     establish_unpooled_connection,
 193     source::{local_user::LocalUser_, secret::Secret_},
 194     Crud,
 195   };
 196   use lemmy_db_schema::source::{
 197     local_user::{LocalUser, LocalUserForm},
 198     person::{Person, PersonForm},
 199     secret::Secret,
 200   };
 201   use lemmy_utils::{claims::Claims, settings::structs::Settings};
 202
 203   #[test]
 204   fn test_should_not_validate_user_token_after_password_change() {
 205     let conn = establish_unpooled_connection();
 206     let secret = Secret::init(&conn).unwrap();
 207     let settings = Settings::init().unwrap();
 208
 209     let new_person = PersonForm {
 210       name: "Gerry9812".into(),
 211       ..PersonForm::default()
 212     };
 213
 214     let inserted_person = Person::create(&conn, &new_person).unwrap();
 215
 216     let local_user_form = LocalUserForm {
 217       person_id: inserted_person.id,
 218       password_encrypted: "123456".to_string(),
 219       ..LocalUserForm::default()
 220     };
 221
 222     let inserted_local_user = LocalUser::create(&conn, &local_user_form).unwrap();
 223
 224     let jwt = Claims::jwt(
 225       inserted_local_user.id.0,
 226       &secret.jwt_secret,
 227       &settings.hostname,
 228     )
 229     .unwrap();
 230     let claims = Claims::decode(&jwt, &secret.jwt_secret).unwrap().claims;
 231     let check = check_validator_time(&inserted_local_user.validator_time, &claims);
 232     assert!(check.is_ok());
 233
 234     // The check should fail, since the validator time is now newer than the jwt issue time
 235     let updated_local_user =
 236       LocalUser::update_password(&conn, inserted_local_user.id, "password111").unwrap();
 237     let check_after = check_validator_time(&updated_local_user.validator_time, &claims);
 238     assert!(check_after.is_err());
 239
 240     let num_deleted = Person::delete(&conn, inserted_person.id).unwrap();
 241     assert_eq!(1, num_deleted);
 242   }
 243 }