Merge remote-tracking branch 'origin/master'

# Conflicts:
#	src/daemon_util.rs
#	src/libc_util.rs

Author: chenjunliang

Cargo.toml

@@ -1,11 +1,11 @@
 [package]
 name = "mysql-audit-extend"
-version = "0.2.4"
+version = "0.2.5"
 edition = "2021"
 authors = ["seeker"]
 description = "An extension tool of mysql-audit, which provides functions such as log rotation and log cleaning."
 license = "MIT"
-documentation = "https://docs.rs/crate/mysql-audit-extend/0.2.4"
+documentation = "https://docs.rs/crate/mysql-audit-extend/0.2.5"
 repository = "https://gitee.com/seeker_rs/mysql-audit-extend"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

README.md

@@ -11,7 +11,7 @@ cargo install mysql-audit-extend
 ```
 or
 ```shell
-wget https://gitee.com/seeker_rs/mysql-audit-extend/releases/download/release-0.2.4/mysql-audit-extend
+wget https://gitee.com/seeker_rs/mysql-audit-extend/releases/download/release-0.2.5/mysql-audit-extend
 chmod 775 mysql-audit-extend
 ```
 

src/daemon_util.rs

@@ -7,6 +7,7 @@ use std::fs;
 #[cfg(target_family = "unix")]
 use std::fs::File;
 
+/// Linux background running
 #[cfg(target_family = "unix")]
 pub fn daemonize(
     username: &str,

src/libc_util.rs

@@ -1,6 +1,7 @@
 #[cfg(target_family = "unix")]
 use users::{get_current_uid, get_user_by_uid};
 
+/// Get current operating system user
 #[cfg(target_family = "unix")]
 pub fn get_current_user() -> String {
     let user = get_user_by_uid(get_current_uid()).unwrap();

src/main.rs

@@ -26,16 +26,18 @@ struct Options {
     max_file: u32,
 }
 
-/// 文件路径检查
+/// File path check
 fn parse_path(s: &str) -> Result<String> {
     fs::File::open(s)?;
     Ok(s.into())
 }
 
+/// Initialize the log component
 fn init_log() {
     simple_logger::init_with_level(log::Level::Info).unwrap();
 }
 
+/// main function
 fn main() -> Result<()> {
     let options = Options::parse();
     log::info!("App environments:{:?}", options);

src/tasks.rs

@@ -7,16 +7,16 @@ use std::path::Path;
 use std::thread::sleep;
 use std::time::{Duration};
 
-fn mysql_audit_log_rotate(sched: &mut JobScheduler, path: String, max_size: u32, max_file: u32) {
-    // utc time
+/// Handling mysql audit logs
+fn mysql_audit_log_handle(sched: &mut JobScheduler, path: String, max_size: u32, max_file: u32) {
     sched.add(Job::new("1/10 * * * * *".parse().unwrap(), move || {
         let r = fs::File::options().write(true).open(path.as_str());
         match r {
             Ok(file) => {
                 let metadata = file.metadata().unwrap();
                 let file_len = Decimal::from(metadata.len());
                 let cf = Decimal::from(1024);
-                let file_size = (file_len / cf / cf).round_dp(0);
+                let file_size = (file_len / cf / cf).round_dp(2);
                 let file_max_size = Decimal::from(max_size);
                 if file_size >= file_max_size {
                     log::info!("The file size reaches the split standard:{:?}M", file_size);
@@ -65,10 +65,11 @@ fn mysql_audit_log_rotate(sched: &mut JobScheduler, path: String, max_size: u32,
     }));
 }
 
+/// Scheduled task control
 pub fn start_backstage_task(path: String, max_size: u32, max_file: u32) {
     let mut sched = JobScheduler::new();
 
-    mysql_audit_log_rotate(sched.borrow_mut(), path, max_size, max_file);
+    mysql_audit_log_handle(sched.borrow_mut(), path, max_size, max_file);
 
     loop {
         sched.tick();