-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #136 from TicClick/logging
- Loading branch information
Showing
8 changed files
with
440 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,224 @@ | ||
| use std::collections::{hash_map::Entry, HashMap}; | ||
| use std::fmt::Write as FmtWrite; | ||
| use std::fs::File; | ||
| use std::io::Write as IOWrite; | ||
| use std::path::{Path, PathBuf}; | ||
|
|
||
| use steel_core::chat::Message; | ||
| use tokio::sync::mpsc::{unbounded_channel, UnboundedReceiver, UnboundedSender}; | ||
|
|
||
| use crate::actor::ActorHandle; | ||
|
|
||
| pub enum LoggingRequest { | ||
| LogMessage { chat_name: String, message: Message }, | ||
| CloseLog { chat_name: String }, | ||
| ChangeLogFormat { log_line_format: String }, | ||
| ChangeLoggingDirectory { logging_directory: String }, | ||
| ShutdownLogger, | ||
| } | ||
|
|
||
| pub struct ChatLoggerHandle { | ||
| channel: UnboundedSender<LoggingRequest>, | ||
| } | ||
|
|
||
| impl ActorHandle for ChatLoggerHandle {} | ||
|
|
||
| impl ChatLoggerHandle { | ||
| pub fn new(log_directory: &str, log_line_format: &str) -> Self { | ||
| let (tx, rx) = unbounded_channel(); | ||
| let mut actor = ChatLoggerBackend::new(log_directory, log_line_format, rx); | ||
| std::thread::spawn(move || { | ||
| actor.run(); | ||
| }); | ||
| Self { channel: tx } | ||
| } | ||
|
|
||
| pub fn log(&self, chat_name: String, message: Message) { | ||
| let _ = self | ||
| .channel | ||
| .send(LoggingRequest::LogMessage { chat_name, message }); | ||
| } | ||
|
|
||
| pub fn close_log(&self, chat_name: String) { | ||
| let _ = self.channel.send(LoggingRequest::CloseLog { chat_name }); | ||
| } | ||
|
|
||
| pub fn change_log_format(&self, log_line_format: String) { | ||
| let _ = self | ||
| .channel | ||
| .send(LoggingRequest::ChangeLogFormat { log_line_format }); | ||
| } | ||
|
|
||
| pub fn change_logging_directory(&self, logging_directory: String) { | ||
| let _ = self | ||
| .channel | ||
| .send(LoggingRequest::ChangeLoggingDirectory { logging_directory }); | ||
| } | ||
|
|
||
| pub fn shutdown(&self) { | ||
| let _ = self.channel.send(LoggingRequest::ShutdownLogger); | ||
| } | ||
| } | ||
|
|
||
| struct ChatLoggerBackend { | ||
| log_directory: PathBuf, | ||
| log_line_format: String, | ||
| channel: UnboundedReceiver<LoggingRequest>, | ||
| files: HashMap<PathBuf, File>, | ||
| } | ||
|
|
||
| impl ChatLoggerBackend { | ||
| fn new( | ||
| log_directory: &str, | ||
| log_line_format: &str, | ||
| channel: UnboundedReceiver<LoggingRequest>, | ||
| ) -> Self { | ||
| Self { | ||
| log_directory: Path::new(&log_directory).to_path_buf(), | ||
| log_line_format: log_line_format.to_owned(), | ||
| channel, | ||
| files: HashMap::new(), | ||
| } | ||
| } | ||
|
|
||
| fn run(&mut self) { | ||
| while let Some(evt) = self.channel.blocking_recv() { | ||
| match evt { | ||
| LoggingRequest::LogMessage { chat_name, message } => { | ||
| if self.log(chat_name, message).is_err() { | ||
| return; | ||
| } | ||
| } | ||
| LoggingRequest::ChangeLogFormat { log_line_format } => { | ||
| self.log_line_format = log_line_format; | ||
| } | ||
| LoggingRequest::ChangeLoggingDirectory { logging_directory } => { | ||
| log::info!( | ||
| "Chat logging directory has been changed: {:?} -> {}", | ||
| self.log_directory, | ||
| logging_directory | ||
| ); | ||
| self.log_directory = Path::new(&logging_directory).to_path_buf(); | ||
| self.files.clear(); | ||
| } | ||
| LoggingRequest::CloseLog { chat_name } => self.close(chat_name), | ||
| LoggingRequest::ShutdownLogger => return, | ||
| } | ||
| } | ||
| } | ||
|
|
||
| fn chat_path(&self, chat_name: &str) -> PathBuf { | ||
| self.log_directory | ||
| .join(chat_name.to_lowercase()) | ||
| .with_extension("log") | ||
| } | ||
|
|
||
| fn log(&mut self, chat_name: String, message: Message) -> std::io::Result<()> { | ||
| if self.files.is_empty() { | ||
| if let Err(e) = std::fs::create_dir_all(&self.log_directory) { | ||
| log::error!( | ||
| "Failed to create the directory for storing chat logs: {}", | ||
| e | ||
| ); | ||
| return Err(e); | ||
| } | ||
| } | ||
|
|
||
| let target_path = self.chat_path(&chat_name); | ||
| let (is_new_file, mut f) = match self.files.entry(target_path.clone()) { | ||
| Entry::Occupied(e) => (false, e.into_mut()), | ||
| Entry::Vacant(e) => { | ||
| match std::fs::OpenOptions::new() | ||
| .read(true) | ||
| .create(true) | ||
| .append(true) | ||
| .open(target_path) | ||
| { | ||
| Ok(handle) => (true, e.insert(handle)), | ||
| Err(e) => { | ||
| log::error!( | ||
| "Failed to open or create the chat log for {}: {}", | ||
| chat_name, | ||
| e | ||
| ); | ||
| return Err(e); | ||
| } | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| if is_new_file { | ||
| if let Err(e) = writeln!(&mut f, "\n") { | ||
| log::error!( | ||
| "Failed to start a new logging session for {}: {}", | ||
| chat_name, | ||
| e | ||
| ); | ||
| return Err(e); | ||
| } | ||
| } | ||
|
|
||
| let formatted_message = format_message_for_logging(&self.log_line_format, &message); | ||
| if let Err(e) = writeln!(&mut f, "{}", formatted_message) { | ||
| log::error!("Failed to append a chat log line for {}: {}", chat_name, e); | ||
| return Err(e); | ||
| } | ||
|
|
||
| Ok(()) | ||
| } | ||
|
|
||
| fn close(&mut self, chat_name: String) { | ||
| let target_path = self.chat_path(&chat_name); | ||
| if let Entry::Occupied(e) = self.files.entry(target_path) { | ||
| e.remove_entry(); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| pub fn format_message_for_logging(log_line_format: &str, message: &Message) -> String { | ||
| let mut result = String::new(); | ||
| let mut placeholder = String::new(); | ||
| let mut in_placeholder = false; | ||
|
|
||
| for c in log_line_format.chars() { | ||
| match c { | ||
| '{' => { | ||
| in_placeholder = true; | ||
| placeholder.clear(); | ||
| } | ||
| '}' => { | ||
| if in_placeholder { | ||
| result.push_str(&resolve_placeholder(&placeholder, message)); | ||
| in_placeholder = false; | ||
| } else { | ||
| result.push(c); | ||
| } | ||
| } | ||
| _ => { | ||
| if in_placeholder { | ||
| placeholder.push(c); | ||
| } else { | ||
| result.push(c); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| result | ||
| } | ||
|
|
||
| fn resolve_placeholder(placeholder: &str, message: &Message) -> String { | ||
| if let Some(date_format) = placeholder.strip_prefix("date:") { | ||
| let mut buf = String::new(); | ||
| match write!(&mut buf, "{}", message.time.format(date_format)) { | ||
| Ok(_) => buf, | ||
| Err(_) => format!("{{date:{}}}", date_format), | ||
| } | ||
| } else { | ||
| match placeholder { | ||
| "username" => message.username.clone(), | ||
| "text" => message.text.clone(), | ||
| _ => String::from("{unknown}"), | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,5 @@ | ||
| pub mod irc; | ||
| pub mod logging; | ||
| pub mod os; | ||
| pub mod sound; | ||
| pub mod updater; | ||
|
|
||
Oops, something went wrong.