]> Untitled Git - lemmy.git/blob - crates/api/src/lib.rs
Merge remote-tracking branch 'yerba/split-api-crate' into test_merge_api_crates_reorg
[lemmy.git] / crates / api / src / lib.rs
1 use actix_web::{web, web::Data};
2 use lemmy_api_common::{comment::*, community::*, person::*, post::*, site::*, websocket::*};
3 use lemmy_utils::{ConnectionId, LemmyError};
4 use lemmy_websocket::{serialize_websocket_message, LemmyContext, UserOperation};
5 use serde::Deserialize;
6 use std::{env, process::Command};
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::GetReportCount => {
67       do_websocket_operation::<GetReportCount>(context, id, op, data).await
68     }
69
70     // Private Message ops
71     UserOperation::MarkPrivateMessageAsRead => {
72       do_websocket_operation::<MarkPrivateMessageAsRead>(context, id, op, data).await
73     }
74
75     // Site ops
76     UserOperation::GetModlog => do_websocket_operation::<GetModlog>(context, id, op, data).await,
77     UserOperation::GetSiteConfig => {
78       do_websocket_operation::<GetSiteConfig>(context, id, op, data).await
79     }
80     UserOperation::SaveSiteConfig => {
81       do_websocket_operation::<SaveSiteConfig>(context, id, op, data).await
82     }
83     UserOperation::Search => do_websocket_operation::<Search>(context, id, op, data).await,
84     UserOperation::TransferCommunity => {
85       do_websocket_operation::<TransferCommunity>(context, id, op, data).await
86     }
87     UserOperation::TransferSite => {
88       do_websocket_operation::<TransferSite>(context, id, op, data).await
89     }
90
91     // Community ops
92     UserOperation::FollowCommunity => {
93       do_websocket_operation::<FollowCommunity>(context, id, op, data).await
94     }
95     UserOperation::GetFollowedCommunities => {
96       do_websocket_operation::<GetFollowedCommunities>(context, id, op, data).await
97     }
98     UserOperation::BanFromCommunity => {
99       do_websocket_operation::<BanFromCommunity>(context, id, op, data).await
100     }
101     UserOperation::AddModToCommunity => {
102       do_websocket_operation::<AddModToCommunity>(context, id, op, data).await
103     }
104
105     // Post ops
106     UserOperation::LockPost => do_websocket_operation::<LockPost>(context, id, op, data).await,
107     UserOperation::StickyPost => do_websocket_operation::<StickyPost>(context, id, op, data).await,
108     UserOperation::CreatePostLike => {
109       do_websocket_operation::<CreatePostLike>(context, id, op, data).await
110     }
111     UserOperation::SavePost => do_websocket_operation::<SavePost>(context, id, op, data).await,
112     UserOperation::CreatePostReport => {
113       do_websocket_operation::<CreatePostReport>(context, id, op, data).await
114     }
115     UserOperation::ListPostReports => {
116       do_websocket_operation::<ListPostReports>(context, id, op, data).await
117     }
118     UserOperation::ResolvePostReport => {
119       do_websocket_operation::<ResolvePostReport>(context, id, op, data).await
120     }
121
122     // Comment ops
123     UserOperation::MarkCommentAsRead => {
124       do_websocket_operation::<MarkCommentAsRead>(context, id, op, data).await
125     }
126     UserOperation::SaveComment => {
127       do_websocket_operation::<SaveComment>(context, id, op, data).await
128     }
129     UserOperation::CreateCommentLike => {
130       do_websocket_operation::<CreateCommentLike>(context, id, op, data).await
131     }
132     UserOperation::CreateCommentReport => {
133       do_websocket_operation::<CreateCommentReport>(context, id, op, data).await
134     }
135     UserOperation::ListCommentReports => {
136       do_websocket_operation::<ListCommentReports>(context, id, op, data).await
137     }
138     UserOperation::ResolveCommentReport => {
139       do_websocket_operation::<ResolveCommentReport>(context, id, op, data).await
140     }
141   }
142 }
143
144 async fn do_websocket_operation<'a, 'b, Data>(
145   context: LemmyContext,
146   id: ConnectionId,
147   op: UserOperation,
148   data: &str,
149 ) -> Result<String, LemmyError>
150 where
151   for<'de> Data: Deserialize<'de> + 'a,
152   Data: Perform,
153 {
154   let parsed_data: Data = serde_json::from_str(&data)?;
155   let res = parsed_data
156     .perform(&web::Data::new(context), Some(id))
157     .await?;
158   serialize_websocket_message(&op, &res)
159 }
160
161 pub(crate) fn captcha_espeak_wav_base64(captcha: &str) -> Result<String, LemmyError> {
162   let mut built_text = String::new();
163
164   // Building proper speech text for espeak
165   for mut c in captcha.chars() {
166     let new_str = if c.is_alphabetic() {
167       if c.is_lowercase() {
168         c.make_ascii_uppercase();
169         format!("lower case {} ... ", c)
170       } else {
171         c.make_ascii_uppercase();
172         format!("capital {} ... ", c)
173       }
174     } else {
175       format!("{} ...", c)
176     };
177
178     built_text.push_str(&new_str);
179   }
180
181   espeak_wav_base64(&built_text)
182 }
183
184 pub(crate) fn espeak_wav_base64(text: &str) -> Result<String, LemmyError> {
185   // Make a temp file path
186   let uuid = uuid::Uuid::new_v4().to_string();
187   let file_path = format!(
188     "{}/lemmy_espeak_{}.wav",
189     env::temp_dir().to_string_lossy(),
190     &uuid
191   );
192
193   // Write the wav file
194   Command::new("espeak")
195     .arg("-w")
196     .arg(&file_path)
197     .arg(text)
198     .status()?;
199
200   // Read the wav file bytes
201   let bytes = std::fs::read(&file_path)?;
202
203   // Delete the file
204   std::fs::remove_file(file_path)?;
205
206   // Convert to base64
207   let base64 = base64::encode(bytes);
208
209   Ok(base64)
210 }
211
212 #[cfg(test)]
213 mod tests {
214   use crate::captcha_espeak_wav_base64;
215   use lemmy_api_common::check_validator_time;
216   use lemmy_db_queries::{establish_unpooled_connection, source::local_user::LocalUser_, Crud};
217   use lemmy_db_schema::source::{
218     local_user::{LocalUser, LocalUserForm},
219     person::{Person, PersonForm},
220   };
221   use lemmy_utils::claims::Claims;
222
223   #[test]
224   fn test_should_not_validate_user_token_after_password_change() {
225     let conn = establish_unpooled_connection();
226
227     let new_person = PersonForm {
228       name: "Gerry9812".into(),
229       ..PersonForm::default()
230     };
231
232     let inserted_person = Person::create(&conn, &new_person).unwrap();
233
234     let local_user_form = LocalUserForm {
235       person_id: inserted_person.id,
236       password_encrypted: "123456".to_string(),
237       ..LocalUserForm::default()
238     };
239
240     let inserted_local_user = LocalUser::create(&conn, &local_user_form).unwrap();
241
242     let jwt = Claims::jwt(inserted_local_user.id.0).unwrap();
243     let claims = Claims::decode(&jwt).unwrap().claims;
244     let check = check_validator_time(&inserted_local_user.validator_time, &claims);
245     assert!(check.is_ok());
246
247     // The check should fail, since the validator time is now newer than the jwt issue time
248     let updated_local_user =
249       LocalUser::update_password(&conn, inserted_local_user.id, &"password111").unwrap();
250     let check_after = check_validator_time(&updated_local_user.validator_time, &claims);
251     assert!(check_after.is_err());
252
253     let num_deleted = Person::delete(&conn, inserted_person.id).unwrap();
254     assert_eq!(1, num_deleted);
255   }
256
257   #[test]
258   fn test_espeak() {
259     assert!(captcha_espeak_wav_base64("WxRt2l").is_ok())
260   }
261 }