server/src/websocket/server.rs

   1 //! `ChatServer` is an actor. It maintains list of connection client session.
   2 //! And manages available rooms. Peers send messages to other peers in same
   3 //! room through `ChatServer`.
   4
   5 use actix::prelude::*;
   6 use diesel::r2d2::{ConnectionManager, Pool};
   7 use diesel::PgConnection;
   8 use failure::Error;
   9 use rand::{rngs::ThreadRng, Rng};
  10 use serde::{Deserialize, Serialize};
  11 use serde_json::Value;
  12 use std::collections::{HashMap, HashSet};
  13 use std::str::FromStr;
  14 use std::time::SystemTime;
  15
  16 use crate::api::comment::*;
  17 use crate::api::community::*;
  18 use crate::api::post::*;
  19 use crate::api::site::*;
  20 use crate::api::user::*;
  21 use crate::api::*;
  22 use crate::websocket::UserOperation;
  23 use crate::Settings;
  24
  25 /// Chat server sends this messages to session
  26 #[derive(Message)]
  27 #[rtype(result = "()")]
  28 pub struct WSMessage(pub String);
  29
  30 /// Message for chat server communications
  31
  32 /// New chat session is created
  33 #[derive(Message)]
  34 #[rtype(usize)]
  35 pub struct Connect {
  36   pub addr: Recipient<WSMessage>,
  37   pub ip: String,
  38 }
  39
  40 /// Session is disconnected
  41 #[derive(Message)]
  42 #[rtype(result = "()")]
  43 pub struct Disconnect {
  44   pub id: usize,
  45   pub ip: String,
  46 }
  47
  48 // TODO this is unused rn
  49 /// Send message to specific room
  50 #[derive(Message)]
  51 #[rtype(result = "()")]
  52 pub struct ClientMessage {
  53   /// Id of the client session
  54   pub id: usize,
  55   /// Peer message
  56   pub msg: String,
  57   /// Room name
  58   pub room: String,
  59 }
  60
  61 #[derive(Serialize, Deserialize, Message)]
  62 #[rtype(String)]
  63 pub struct StandardMessage {
  64   /// Id of the client session
  65   pub id: usize,
  66   /// Peer message
  67   pub msg: String,
  68 }
  69
  70 #[derive(Debug)]
  71 pub struct RateLimitBucket {
  72   last_checked: SystemTime,
  73   allowance: f64,
  74 }
  75
  76 pub struct SessionInfo {
  77   pub addr: Recipient<WSMessage>,
  78   pub ip: String,
  79 }
  80
  81 /// `ChatServer` manages chat rooms and responsible for coordinating chat
  82 /// session. implementation is super primitive
  83 pub struct ChatServer {
  84   sessions: HashMap<usize, SessionInfo>, // A map from generated random ID to session addr
  85   rate_limits: HashMap<String, RateLimitBucket>,
  86   rooms: HashMap<i32, HashSet<usize>>, // A map from room / post name to set of connectionIDs
  87   rng: ThreadRng,
  88   db: Pool<ConnectionManager<PgConnection>>,
  89 }
  90
  91 impl ChatServer {
  92   pub fn startup(db: Pool<ConnectionManager<PgConnection>>) -> ChatServer {
  93     // default room
  94     let rooms = HashMap::new();
  95
  96     ChatServer {
  97       sessions: HashMap::new(),
  98       rate_limits: HashMap::new(),
  99       rooms,
 100       rng: rand::thread_rng(),
 101       db,
 102     }
 103   }
 104
 105   /// Send message to all users in the room
 106   fn send_room_message(&self, room: i32, message: &str, skip_id: usize) {
 107     if let Some(sessions) = self.rooms.get(&room) {
 108       for id in sessions {
 109         if *id != skip_id {
 110           if let Some(info) = self.sessions.get(id) {
 111             let _ = info.addr.do_send(WSMessage(message.to_owned()));
 112           }
 113         }
 114       }
 115     }
 116   }
 117
 118   fn join_room(&mut self, room_id: i32, id: usize) {
 119     // remove session from all rooms
 120     for sessions in self.rooms.values_mut() {
 121       sessions.remove(&id);
 122     }
 123
 124     // If the room doesn't exist yet
 125     if self.rooms.get_mut(&room_id).is_none() {
 126       self.rooms.insert(room_id, HashSet::new());
 127     }
 128
 129     self.rooms.get_mut(&room_id).unwrap().insert(id);
 130   }
 131
 132   fn send_community_message(
 133     &self,
 134     community_id: i32,
 135     message: &str,
 136     skip_id: usize,
 137   ) -> Result<(), Error> {
 138     use crate::db::post_view::*;
 139     use crate::db::*;
 140
 141     let conn = self.db.get()?;
 142
 143     let posts = PostQueryBuilder::create(&conn)
 144       .listing_type(ListingType::Community)
 145       .sort(&SortType::New)
 146       .for_community_id(community_id)
 147       .limit(9999)
 148       .list()?;
 149
 150     for post in posts {
 151       self.send_room_message(post.id, message, skip_id);
 152     }
 153
 154     Ok(())
 155   }
 156
 157   fn check_rate_limit_register(&mut self, id: usize) -> Result<(), Error> {
 158     self.check_rate_limit_full(
 159       id,
 160       Settings::get().rate_limit.register,
 161       Settings::get().rate_limit.register_per_second,
 162     )
 163   }
 164
 165   fn check_rate_limit_post(&mut self, id: usize) -> Result<(), Error> {
 166     self.check_rate_limit_full(
 167       id,
 168       Settings::get().rate_limit.post,
 169       Settings::get().rate_limit.post_per_second,
 170     )
 171   }
 172
 173   fn check_rate_limit_message(&mut self, id: usize) -> Result<(), Error> {
 174     self.check_rate_limit_full(
 175       id,
 176       Settings::get().rate_limit.message,
 177       Settings::get().rate_limit.message_per_second,
 178     )
 179   }
 180
 181   #[allow(clippy::float_cmp)]
 182   fn check_rate_limit_full(&mut self, id: usize, rate: i32, per: i32) -> Result<(), Error> {
 183     if let Some(info) = self.sessions.get(&id) {
 184       if let Some(rate_limit) = self.rate_limits.get_mut(&info.ip) {
 185         // The initial value
 186         if rate_limit.allowance == -2f64 {
 187           rate_limit.allowance = rate as f64;
 188         };
 189
 190         let current = SystemTime::now();
 191         let time_passed = current.duration_since(rate_limit.last_checked)?.as_secs() as f64;
 192         rate_limit.last_checked = current;
 193         rate_limit.allowance += time_passed * (rate as f64 / per as f64);
 194         if rate_limit.allowance > rate as f64 {
 195           rate_limit.allowance = rate as f64;
 196         }
 197
 198         if rate_limit.allowance < 1.0 {
 199           println!(
 200             "Rate limited IP: {}, time_passed: {}, allowance: {}",
 201             &info.ip, time_passed, rate_limit.allowance
 202           );
 203           Err(
 204             APIError {
 205               message: format!("Too many requests. {} per {} seconds", rate, per),
 206             }
 207             .into(),
 208           )
 209         } else {
 210           rate_limit.allowance -= 1.0;
 211           Ok(())
 212         }
 213       } else {
 214         Ok(())
 215       }
 216     } else {
 217       Ok(())
 218     }
 219   }
 220 }
 221
 222 /// Make actor from `ChatServer`
 223 impl Actor for ChatServer {
 224   /// We are going to use simple Context, we just need ability to communicate
 225   /// with other actors.
 226   type Context = Context<Self>;
 227 }
 228
 229 /// Handler for Connect message.
 230 ///
 231 /// Register new session and assign unique id to this session
 232 impl Handler<Connect> for ChatServer {
 233   type Result = usize;
 234
 235   fn handle(&mut self, msg: Connect, _ctx: &mut Context<Self>) -> Self::Result {
 236     // notify all users in same room
 237     // self.send_room_message(&"Main".to_owned(), "Someone joined", 0);
 238
 239     // register session with random id
 240     let id = self.rng.gen::<usize>();
 241     println!("{} joined", &msg.ip);
 242
 243     self.sessions.insert(
 244       id,
 245       SessionInfo {
 246         addr: msg.addr,
 247         ip: msg.ip.to_owned(),
 248       },
 249     );
 250
 251     if self.rate_limits.get(&msg.ip).is_none() {
 252       self.rate_limits.insert(
 253         msg.ip,
 254         RateLimitBucket {
 255           last_checked: SystemTime::now(),
 256           allowance: -2f64,
 257         },
 258       );
 259     }
 260
 261     id
 262   }
 263 }
 264
 265 /// Handler for Disconnect message.
 266 impl Handler<Disconnect> for ChatServer {
 267   type Result = ();
 268
 269   fn handle(&mut self, msg: Disconnect, _: &mut Context<Self>) {
 270     // let mut rooms: Vec<i32> = Vec::new();
 271
 272     // remove address
 273     if self.sessions.remove(&msg.id).is_some() {
 274       // remove session from all rooms
 275       for sessions in self.rooms.values_mut() {
 276         if sessions.remove(&msg.id) {
 277           // rooms.push(*id);
 278         }
 279       }
 280     }
 281   }
 282 }
 283
 284 /// Handler for Message message.
 285 impl Handler<StandardMessage> for ChatServer {
 286   type Result = MessageResult<StandardMessage>;
 287
 288   fn handle(&mut self, msg: StandardMessage, _: &mut Context<Self>) -> Self::Result {
 289     let msg_out = match parse_json_message(self, msg) {
 290       Ok(m) => m,
 291       Err(e) => e.to_string(),
 292     };
 293
 294     MessageResult(msg_out)
 295   }
 296 }
 297
 298 #[derive(Serialize)]
 299 struct WebsocketResponse<T> {
 300   op: String,
 301   data: T,
 302 }
 303
 304 fn to_json_string<T>(op: &UserOperation, data: T) -> Result<String, Error>
 305 where
 306   T: Serialize,
 307 {
 308   let response = WebsocketResponse {
 309     op: op.to_string(),
 310     data,
 311   };
 312   Ok(serde_json::to_string(&response)?)
 313 }
 314
 315 fn parse_json_message(chat: &mut ChatServer, msg: StandardMessage) -> Result<String, Error> {
 316   let json: Value = serde_json::from_str(&msg.msg)?;
 317   let data = &json["data"].to_string();
 318   let op = &json["op"].as_str().ok_or(APIError {
 319     message: "Unknown op type".to_string(),
 320   })?;
 321
 322   let conn = chat.db.get()?;
 323
 324   let user_operation: UserOperation = UserOperation::from_str(&op)?;
 325
 326   match user_operation {
 327     UserOperation::Login => {
 328       let login: Login = serde_json::from_str(data)?;
 329       let res = Oper::new(login).perform(&conn)?;
 330       to_json_string(&user_operation, &res)
 331     }
 332     UserOperation::Register => {
 333       let register: Register = serde_json::from_str(data)?;
 334       let res = Oper::new(register).perform(&conn);
 335       if res.is_ok() {
 336         chat.check_rate_limit_register(msg.id)?;
 337       }
 338       to_json_string(&user_operation, &res?)
 339     }
 340     UserOperation::GetUserDetails => {
 341       let get_user_details: GetUserDetails = serde_json::from_str(data)?;
 342       let res = Oper::new(get_user_details).perform(&conn)?;
 343       to_json_string(&user_operation, &res)
 344     }
 345     UserOperation::SaveUserSettings => {
 346       let save_user_settings: SaveUserSettings = serde_json::from_str(data)?;
 347       let res = Oper::new(save_user_settings).perform(&conn)?;
 348       to_json_string(&user_operation, &res)
 349     }
 350     UserOperation::AddAdmin => {
 351       let add_admin: AddAdmin = serde_json::from_str(data)?;
 352       let res = Oper::new(add_admin).perform(&conn)?;
 353       to_json_string(&user_operation, &res)
 354     }
 355     UserOperation::BanUser => {
 356       let ban_user: BanUser = serde_json::from_str(data)?;
 357       let res = Oper::new(ban_user).perform(&conn)?;
 358       to_json_string(&user_operation, &res)
 359     }
 360     UserOperation::GetReplies => {
 361       let get_replies: GetReplies = serde_json::from_str(data)?;
 362       let res = Oper::new(get_replies).perform(&conn)?;
 363       to_json_string(&user_operation, &res)
 364     }
 365     UserOperation::GetUserMentions => {
 366       let get_user_mentions: GetUserMentions = serde_json::from_str(data)?;
 367       let res = Oper::new(get_user_mentions).perform(&conn)?;
 368       to_json_string(&user_operation, &res)
 369     }
 370     UserOperation::EditUserMention => {
 371       let edit_user_mention: EditUserMention = serde_json::from_str(data)?;
 372       let res = Oper::new(edit_user_mention).perform(&conn)?;
 373       to_json_string(&user_operation, &res)
 374     }
 375     UserOperation::MarkAllAsRead => {
 376       let mark_all_as_read: MarkAllAsRead = serde_json::from_str(data)?;
 377       let res = Oper::new(mark_all_as_read).perform(&conn)?;
 378       to_json_string(&user_operation, &res)
 379     }
 380     UserOperation::GetCommunity => {
 381       let get_community: GetCommunity = serde_json::from_str(data)?;
 382       let res = Oper::new(get_community).perform(&conn)?;
 383       to_json_string(&user_operation, &res)
 384     }
 385     UserOperation::ListCommunities => {
 386       let list_communities: ListCommunities = serde_json::from_str(data)?;
 387       let res = Oper::new(list_communities).perform(&conn)?;
 388       to_json_string(&user_operation, &res)
 389     }
 390     UserOperation::CreateCommunity => {
 391       chat.check_rate_limit_register(msg.id)?;
 392       let create_community: CreateCommunity = serde_json::from_str(data)?;
 393       let res = Oper::new(create_community).perform(&conn)?;
 394       to_json_string(&user_operation, &res)
 395     }
 396     UserOperation::EditCommunity => {
 397       let edit_community: EditCommunity = serde_json::from_str(data)?;
 398       let res = Oper::new(edit_community).perform(&conn)?;
 399       let mut community_sent: CommunityResponse = res.clone();
 400       community_sent.community.user_id = None;
 401       community_sent.community.subscribed = None;
 402       let community_sent_str = to_json_string(&user_operation, &community_sent)?;
 403       chat.send_community_message(community_sent.community.id, &community_sent_str, msg.id)?;
 404       to_json_string(&user_operation, &res)
 405     }
 406     UserOperation::FollowCommunity => {
 407       let follow_community: FollowCommunity = serde_json::from_str(data)?;
 408       let res = Oper::new(follow_community).perform(&conn)?;
 409       to_json_string(&user_operation, &res)
 410     }
 411     UserOperation::GetFollowedCommunities => {
 412       let followed_communities: GetFollowedCommunities = serde_json::from_str(data)?;
 413       let res = Oper::new(followed_communities).perform(&conn)?;
 414       to_json_string(&user_operation, &res)
 415     }
 416     UserOperation::BanFromCommunity => {
 417       let ban_from_community: BanFromCommunity = serde_json::from_str(data)?;
 418       let community_id = ban_from_community.community_id;
 419       let res = Oper::new(ban_from_community).perform(&conn)?;
 420       let res_str = to_json_string(&user_operation, &res)?;
 421       chat.send_community_message(community_id, &res_str, msg.id)?;
 422       Ok(res_str)
 423     }
 424     UserOperation::AddModToCommunity => {
 425       let mod_add_to_community: AddModToCommunity = serde_json::from_str(data)?;
 426       let community_id = mod_add_to_community.community_id;
 427       let res = Oper::new(mod_add_to_community).perform(&conn)?;
 428       let res_str = to_json_string(&user_operation, &res)?;
 429       chat.send_community_message(community_id, &res_str, msg.id)?;
 430       Ok(res_str)
 431     }
 432     UserOperation::ListCategories => {
 433       let list_categories: ListCategories = ListCategories;
 434       let res = Oper::new(list_categories).perform(&conn)?;
 435       to_json_string(&user_operation, &res)
 436     }
 437     UserOperation::CreatePost => {
 438       chat.check_rate_limit_post(msg.id)?;
 439       let create_post: CreatePost = serde_json::from_str(data)?;
 440       let res = Oper::new(create_post).perform(&conn)?;
 441       to_json_string(&user_operation, &res)
 442     }
 443     UserOperation::GetPost => {
 444       let get_post: GetPost = serde_json::from_str(data)?;
 445       chat.join_room(get_post.id, msg.id);
 446       let res = Oper::new(get_post).perform(&conn)?;
 447       to_json_string(&user_operation, &res)
 448     }
 449     UserOperation::GetPosts => {
 450       let get_posts: GetPosts = serde_json::from_str(data)?;
 451       let res = Oper::new(get_posts).perform(&conn)?;
 452       to_json_string(&user_operation, &res)
 453     }
 454     UserOperation::CreatePostLike => {
 455       chat.check_rate_limit_message(msg.id)?;
 456       let create_post_like: CreatePostLike = serde_json::from_str(data)?;
 457       let res = Oper::new(create_post_like).perform(&conn)?;
 458       to_json_string(&user_operation, &res)
 459     }
 460     UserOperation::EditPost => {
 461       let edit_post: EditPost = serde_json::from_str(data)?;
 462       let res = Oper::new(edit_post).perform(&conn)?;
 463       let mut post_sent = res.clone();
 464       post_sent.post.my_vote = None;
 465       let post_sent_str = to_json_string(&user_operation, &post_sent)?;
 466       chat.send_room_message(post_sent.post.id, &post_sent_str, msg.id);
 467       to_json_string(&user_operation, &res)
 468     }
 469     UserOperation::SavePost => {
 470       let save_post: SavePost = serde_json::from_str(data)?;
 471       let res = Oper::new(save_post).perform(&conn)?;
 472       to_json_string(&user_operation, &res)
 473     }
 474     UserOperation::CreateComment => {
 475       chat.check_rate_limit_message(msg.id)?;
 476       let create_comment: CreateComment = serde_json::from_str(data)?;
 477       let post_id = create_comment.post_id;
 478       let res = Oper::new(create_comment).perform(&conn)?;
 479       let mut comment_sent = res.clone();
 480       comment_sent.comment.my_vote = None;
 481       comment_sent.comment.user_id = None;
 482       let comment_sent_str = to_json_string(&user_operation, &comment_sent)?;
 483       chat.send_room_message(post_id, &comment_sent_str, msg.id);
 484       to_json_string(&user_operation, &res)
 485     }
 486     UserOperation::EditComment => {
 487       let edit_comment: EditComment = serde_json::from_str(data)?;
 488       let post_id = edit_comment.post_id;
 489       let res = Oper::new(edit_comment).perform(&conn)?;
 490       let mut comment_sent = res.clone();
 491       comment_sent.comment.my_vote = None;
 492       comment_sent.comment.user_id = None;
 493       let comment_sent_str = to_json_string(&user_operation, &comment_sent)?;
 494       chat.send_room_message(post_id, &comment_sent_str, msg.id);
 495       to_json_string(&user_operation, &res)
 496     }
 497     UserOperation::SaveComment => {
 498       let save_comment: SaveComment = serde_json::from_str(data)?;
 499       let res = Oper::new(save_comment).perform(&conn)?;
 500       to_json_string(&user_operation, &res)
 501     }
 502     UserOperation::CreateCommentLike => {
 503       chat.check_rate_limit_message(msg.id)?;
 504       let create_comment_like: CreateCommentLike = serde_json::from_str(data)?;
 505       let post_id = create_comment_like.post_id;
 506       let res = Oper::new(create_comment_like).perform(&conn)?;
 507       let mut comment_sent = res.clone();
 508       comment_sent.comment.my_vote = None;
 509       comment_sent.comment.user_id = None;
 510       let comment_sent_str = to_json_string(&user_operation, &comment_sent)?;
 511       chat.send_room_message(post_id, &comment_sent_str, msg.id);
 512       to_json_string(&user_operation, &res)
 513     }
 514     UserOperation::GetModlog => {
 515       let get_modlog: GetModlog = serde_json::from_str(data)?;
 516       let res = Oper::new(get_modlog).perform(&conn)?;
 517       to_json_string(&user_operation, &res)
 518     }
 519     UserOperation::CreateSite => {
 520       let create_site: CreateSite = serde_json::from_str(data)?;
 521       let res = Oper::new(create_site).perform(&conn)?;
 522       to_json_string(&user_operation, &res)
 523     }
 524     UserOperation::EditSite => {
 525       let edit_site: EditSite = serde_json::from_str(data)?;
 526       let res = Oper::new(edit_site).perform(&conn)?;
 527       to_json_string(&user_operation, &res)
 528     }
 529     UserOperation::GetSite => {
 530       let online: usize = chat.sessions.len();
 531       let get_site: GetSite = serde_json::from_str(data)?;
 532       let mut res = Oper::new(get_site).perform(&conn)?;
 533       res.online = online;
 534       to_json_string(&user_operation, &res)
 535     }
 536     UserOperation::Search => {
 537       let search: Search = serde_json::from_str(data)?;
 538       let res = Oper::new(search).perform(&conn)?;
 539       to_json_string(&user_operation, &res)
 540     }
 541     UserOperation::TransferCommunity => {
 542       let transfer_community: TransferCommunity = serde_json::from_str(data)?;
 543       let res = Oper::new(transfer_community).perform(&conn)?;
 544       to_json_string(&user_operation, &res)
 545     }
 546     UserOperation::TransferSite => {
 547       let transfer_site: TransferSite = serde_json::from_str(data)?;
 548       let res = Oper::new(transfer_site).perform(&conn)?;
 549       to_json_string(&user_operation, &res)
 550     }
 551     UserOperation::DeleteAccount => {
 552       let delete_account: DeleteAccount = serde_json::from_str(data)?;
 553       let res = Oper::new(delete_account).perform(&conn)?;
 554       to_json_string(&user_operation, &res)
 555     }
 556     UserOperation::PasswordReset => {
 557       let password_reset: PasswordReset = serde_json::from_str(data)?;
 558       let res = Oper::new(password_reset).perform(&conn)?;
 559       to_json_string(&user_operation, &res)
 560     }
 561     UserOperation::PasswordChange => {
 562       let password_change: PasswordChange = serde_json::from_str(data)?;
 563       let res = Oper::new(password_change).perform(&conn)?;
 564       to_json_string(&user_operation, &res)
 565     }
 566   }
 567 }