1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
//! # Pipe Logger Lib
//! Stores, rotates, compresses process logs.
//!
//! ## Example
//!
//! ```
//! extern crate pipe_logger_lib;
//!
//! use pipe_logger_lib::*;
//!
//! use std::fs;
//! use std::path::Path;
//!
//! let test_folder = {
//!   let folder = Path::join(&Path::join(Path::new("tests"), Path::new("out")), "log-example");
//!
//!   fs::remove_dir_all(&folder);
//!
//!   fs::create_dir_all(&folder).unwrap();
//!
//!   folder
//! };
//!
//! let test_log_file = Path::join(&test_folder, Path::new("mylog.txt"));
//!
//! let mut builder = PipeLoggerBuilder::new(&test_log_file);
//!
//! builder
//!     .set_tee(Some(Tee::Stdout))
//!     .set_rotate(Some(RotateMethod::FileSize(30))) // bytes
//!     .set_count(Some(10))
//!     .set_compress(false);
//!
//! {
//!     let mut logger = builder.build().unwrap();
//!
//!     logger.write_line("Hello world!").unwrap();
//!
//!     let rotated_log_file_1 = logger.write_line("This is a convenient logger.").unwrap().unwrap();
//!
//!     logger.write_line("Other logs...").unwrap();
//!     logger.write_line("Other logs...").unwrap();
//!
//!     let rotated_log_file_2 = logger.write_line("Rotate again!").unwrap().unwrap();
//!
//!     logger.write_line("Ops!").unwrap();
//! }
//!
//! fs::remove_dir_all(test_folder).unwrap();
//! ```
//!
//! Now, the contents of `test_log_file` are,
//!
//! ```text
//! Ops!
//! ```
//!
//! The contents of `rotated_log_file_1` are,
//!
//! ```text
//! Hello world!
//! This is a convenient logger.
//! ```
//!
//! The contents of `rotated_log_file_2` are,
//!
//! ```text
//! Other logs...
//! Other logs...
//! Rotate again!
//! ```

extern crate chrono;
extern crate regex;
extern crate xz2;
extern crate path_absolutize;

use std::io::{self, Read, Write};
use std::path::{Path, PathBuf};
use std::fs::{self, File, OpenOptions};
use std::thread;

use path_absolutize::*;
use chrono::prelude::*;

use regex::Regex;

use xz2::write::XzEncoder;

const BUFFER_SIZE: usize = 4096 * 4;

#[derive(Debug)]
/// The way to rotate log files.
pub enum RotateMethod {
    /// Rotate log files by a file size threshold in bytes.
    FileSize(u64)
}

// TODO -----PipeLoggerBuilder START-----

#[derive(Debug)]
pub enum PipeLoggerBuilderError {
    /// A valid rotated file size needs bigger than 1.
    RotateFileSizeTooSmall,
    /// A valid count of log files needs bigger than 0.
    CountTooSmall,
    /// std::io::Error.
    IOError(io::Error),
    /// A log file cannot be a directory.
    FileIsDirectory,
}

#[derive(Debug, Clone)]
/// Read from standard input and write to standard output.
pub enum Tee {
    /// To stdout.
    Stdout,
    /// To stderr.
    Stderr,
}

#[derive(Debug)]
/// To build a PipeLogger instance.
pub struct PipeLoggerBuilder<P: AsRef<Path>> {
    rotate: Option<RotateMethod>,
    count: Option<usize>,
    log_path: P,
    compress: bool,
    tee: Option<Tee>,
}

impl<P: AsRef<Path>> PipeLoggerBuilder<P> {
    /// Create a new PipeLoggerBuilder.
    pub fn new(log_path: P) -> PipeLoggerBuilder<P> {
        PipeLoggerBuilder {
            rotate: None,
            count: None,
            log_path,
            compress: false,
            tee: None,
        }
    }

    pub fn rotate(&self) -> &Option<RotateMethod> {
        &self.rotate
    }

    pub fn count(&self) -> &Option<usize> {
        &self.count
    }

    pub fn log_path(&self) -> &P {
        &self.log_path
    }

    /// Whether to compress the rotated log files through xz.
    pub fn compress(&self) -> bool {
        self.compress
    }

    pub fn tee(&self) -> &Option<Tee> {
        &self.tee
    }

    pub fn set_rotate(&mut self, rotate: Option<RotateMethod>) -> &mut Self {
        self.rotate = rotate;
        self
    }

    pub fn set_count(&mut self, count: Option<usize>) -> &mut Self {
        self.count = count;
        self
    }

    /// Whether to compress the rotated log files through xz.
    pub fn set_compress(&mut self, compress: bool) -> &mut Self {
        self.compress = compress;
        self
    }

    pub fn set_tee(&mut self, tee: Option<Tee>) -> &mut Self {
        self.tee = tee;
        self
    }

    /// Build a new PipeLogger.
    pub fn build(self) -> Result<PipeLogger, PipeLoggerBuilderError> {
        if let Some(rotate) = &self.rotate {
            match rotate {
                RotateMethod::FileSize(file_size) => {
                    if *file_size < 2 {
                        return Err(PipeLoggerBuilderError::RotateFileSizeTooSmall);
                    }
                }
            }

            if let Some(count) = &self.count {
                if *count < 1 {
                    return Err(PipeLoggerBuilderError::CountTooSmall);
                }
            }
        }

        let file_path = self.log_path.as_ref().absolutize().map_err(|err| PipeLoggerBuilderError::IOError(err))?;

        let file_size;

        let folder_path = if file_path.exists() {
            if file_path.is_dir() {
                return Err(PipeLoggerBuilderError::FileIsDirectory);
            }
            match fs::metadata(&file_path) {
                Ok(m) => {
                    let p = m.permissions();
                    if p.readonly() {
                        return Err(PipeLoggerBuilderError::IOError(io::Error::new(io::ErrorKind::PermissionDenied, format!("`{}` is readonly.", file_path.to_str().unwrap()))));
                    }
                    file_size = m.len();
                }
                Err(err) => {
                    return Err(PipeLoggerBuilderError::IOError(err));
                }
            }
            match file_path.parent() {
                Some(parent) => {
                    if self.rotate.is_some() {
                        match fs::metadata(&parent) {
                            Ok(m) => {
                                let p = m.permissions();
                                if p.readonly() {
                                    return Err(PipeLoggerBuilderError::IOError(io::Error::new(io::ErrorKind::PermissionDenied, format!("`{}` is readonly.", parent.to_str().unwrap()))));
                                }
                            }
                            Err(err) => {
                                return Err(PipeLoggerBuilderError::IOError(err));
                            }
                        }
                    }
                    parent
                }
                None => {
                    panic!("impossible");
                }
            }
        } else {
            file_size = 0;
            match file_path.parent() {
                Some(parent) => {
                    match fs::metadata(&parent) {
                        Ok(m) => {
                            let p = m.permissions();
                            if p.readonly() {
                                return Err(PipeLoggerBuilderError::IOError(io::Error::new(io::ErrorKind::PermissionDenied, format!("`{}` is readonly.", parent.to_str().unwrap()))));
                            }
                            parent
                        }
                        Err(err) => {
                            return Err(PipeLoggerBuilderError::IOError(err));
                        }
                    }
                }
                None => {
                    return Err(PipeLoggerBuilderError::IOError(io::Error::new(io::ErrorKind::NotFound, format!("`{}`'s parent does not exist.", file_path.to_str().unwrap()))));
                }
            }
        }.to_path_buf();

        let file_name = Path::new(&file_path).file_name().unwrap().to_str().unwrap().to_string();

        let file_name_point_index = match file_name.rfind(".") {
            Some(index) => {
                index
            }
            None => {
                file_name.len()
            }
        };

        let rotated_log_file_names = {
            let mut rotated_log_file_names = Vec::new();

            let re = Regex::new("^-[1-2][0-9]{3}(-[0-5][0-9]){5}-[0-9]{3}$").unwrap(); // -%Y-%m-%d-%H-%M-%S + $.3f

            let file_name_without_extension = &file_name[..file_name_point_index];

            for entry in folder_path.read_dir().unwrap().filter_map(|entry| entry.ok()) {
                let rotated_log_file_path = entry.path();

                if !rotated_log_file_path.is_file() {
                    continue;
                }

                let rotated_log_file_name = Path::new(&rotated_log_file_path).file_name().unwrap().to_str().unwrap();

                if !rotated_log_file_name.starts_with(file_name_without_extension) {
                    continue;
                }

                let rotated_log_file_name_point_index = match rotated_log_file_name.rfind(".") {
                    Some(index) => {
                        index
                    }
                    None => {
                        rotated_log_file_name.len()
                    }
                };

                if rotated_log_file_name_point_index < file_name_point_index + 24 { // -%Y-%m-%d-%H-%M-%S + $.3f
                    continue;
                }

                let file_name_without_extension_len = file_name_without_extension.len();

                if !re.is_match(&rotated_log_file_name[file_name_without_extension_len..file_name_without_extension_len + 24]) {  // -%Y-%m-%d-%H-%M-%S + $.3f
                    continue;
                }

                let ext = &rotated_log_file_name[rotated_log_file_name_point_index..];

                if ext.eq(&file_name[file_name_point_index..]) {
                    rotated_log_file_names.push(rotated_log_file_name.to_string());
                } else if ext.eq(".xz") && rotated_log_file_name[..rotated_log_file_name_point_index].ends_with(&file_name[file_name_point_index..]) {
                    rotated_log_file_names.push(rotated_log_file_name[..rotated_log_file_name_point_index].to_string());
                }
            }

            rotated_log_file_names.sort();

            rotated_log_file_names
        };

        let file = OpenOptions::new()
            .create(true)
            .write(true)
            .append(true)
            .open(&file_path).map_err(|err| PipeLoggerBuilderError::IOError(err))?;

        Ok(PipeLogger {
            rotate: self.rotate,
            count: self.count,
            file: Some(file),
            file_name,
            file_name_point_index,
            file_path,
            file_size,
            folder_path,
            rotated_log_file_names,
            compress: self.compress,
            tee: self.tee,
        })
    }
}

// TODO -----PipeLoggerBuilder END-----

// TODO -----PipeLogger START-----

/// PipeLogger can help you stores, rotates and compresses logs.
pub struct PipeLogger {
    rotate: Option<RotateMethod>,
    count: Option<usize>,
    file: Option<File>,
    file_name: String,
    file_name_point_index: usize,
    file_path: PathBuf,
    file_size: u64,
    folder_path: PathBuf,
    rotated_log_file_names: Vec<String>,
    compress: bool,
    tee: Option<Tee>,
}

impl Write for PipeLogger {
    /// Write UTF-8 data.
    fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
        PipeLogger::write(self, String::from_utf8_lossy(buf))?;

        Ok(buf.len())
    }

    fn flush(&mut self) -> io::Result<()> {
        match self.file {
            Some(ref mut file) => {
                file.flush()
            }
            None => {
                panic!("impossible")
            }
        }
    }
}

impl PipeLogger {
    /// Create a new PipeLoggerBuilder.
    pub fn builder<P: AsRef<Path>>(log_path: P) -> PipeLoggerBuilder<P> {
        PipeLoggerBuilder::new(log_path)
    }

    /// Write a string. If the log is rotated, this method returns the renamed path.
    pub fn write<S: AsRef<str>>(&mut self, text: S) -> io::Result<Option<PathBuf>> {
        let s = text.as_ref();

        let buf = s.as_bytes();

        let len = buf.len();

        if len == 0 {
            return Ok(None);
        }

        self.print(s);

        let mut file = self.file.take().unwrap();

        let n = file.write(buf)?;

        self.file_size += n as u64;

        let mut new_file = None;

        if let Some(rotate) = &self.rotate {
            match rotate {
                RotateMethod::FileSize(size) => {
                    if self.file_size >= *size {
                        let utc: DateTime<Utc> = Utc::now();
                        let timestamp = utc.format("%Y-%m-%d-%H-%M-%S").to_string();
                        let millisecond = utc.format("%.3f").to_string();

                        file.flush()?;

                        file.sync_all()?;

                        drop(file);

                        let rotated_log_file_name = format!("{}-{}-{}{}", &self.file_name[..self.file_name_point_index], timestamp, &millisecond[1..], &self.file_name[self.file_name_point_index..]);

                        let rotated_log_file = Path::join(&self.folder_path, Path::new(&rotated_log_file_name));

                        fs::copy(&self.file_path, &rotated_log_file)?;

                        if self.compress {
                            let rotated_log_file_name_compressed = format!("{}.xz", rotated_log_file_name);
                            let rotated_log_file_compressed = Path::join(&self.folder_path, Path::new(&rotated_log_file_name_compressed));
                            let rotated_log_file = rotated_log_file.clone();

                            let tee = self.tee.clone();

                            let print_err = move |s| {
                                match tee {
                                    Some(tee) => {
                                        match tee {
                                            Tee::Stdout => {
                                                eprintln!("{}", s);
                                            }
                                            Tee::Stderr => {
                                                println!("{}", s);
                                            }
                                        }
                                    }
                                    None => {
                                        eprintln!("{}", s);
                                    }
                                }
                            };

                            thread::spawn(move || {
                                match File::create(&rotated_log_file_compressed) {
                                    Ok(file_w) => {
                                        match File::open(&rotated_log_file) {
                                            Ok(mut file_r) => {
                                                let mut compressor = XzEncoder::new(file_w, 9);
                                                let mut buffer = [0u8; BUFFER_SIZE];
                                                loop {
                                                    match file_r.read(&mut buffer) {
                                                        Ok(c) => {
                                                            if c == 0 {
                                                                if let Err(_) = fs::remove_file(&rotated_log_file) {}
                                                                break;
                                                            }
                                                            match compressor.write(&buffer[..c]) {
                                                                Ok(cc) => {
                                                                    if c != cc {
                                                                        print_err("The space is not enough.".to_string());
                                                                        break;
                                                                    }
                                                                }
                                                                Err(err) => {
                                                                    print_err(err.to_string());
                                                                    break;
                                                                }
                                                            }
                                                        }
                                                        Err(err) => {
                                                            print_err(err.to_string());
                                                            break;
                                                        }
                                                    }
                                                }
                                            }
                                            Err(err) => {
                                                print_err(err.to_string());
                                            }
                                        }
                                    }
                                    Err(err) => {
                                        print_err(err.to_string());
                                    }
                                };
                            });
                        }

                        self.rotated_log_file_names.push(rotated_log_file_name);

                        if let Some(count) = self.count {
                            while self.rotated_log_file_names.len() >= count {
                                let mut rotated_log_file_name = self.rotated_log_file_names.remove(0);
                                if let Err(_) = fs::remove_file(Path::join(&self.folder_path, Path::new(&rotated_log_file_name))) {}

                                let p_compressed_name = {
                                    rotated_log_file_name.push_str(".xz");

                                    rotated_log_file_name
                                };

                                let p_compressed = Path::join(&self.folder_path, Path::new(&p_compressed_name));
                                if let Err(_) = fs::remove_file(&p_compressed) {}
                            }
                        }

                        file = OpenOptions::new()
                            .write(true)
                            .truncate(true)
                            .open(&self.file_path)?;

                        self.file_size = 0;

                        new_file = if self.compress {
                            let mut s = rotated_log_file.into_os_string();
                            s.push(".xz");
                            Some(PathBuf::from(s))
                        } else {
                            Some(rotated_log_file)
                        };
                    }
                }
            }
        }

        if n != len {
            return Err(io::Error::new(io::ErrorKind::BrokenPipe, "The space is not enough."));
        }

        self.file = Some(file);

        Ok(new_file)
    }

    /// Write a string with a new line. If the log is rotated, this method returns the renamed path.
    pub fn write_line<S: AsRef<str>>(&mut self, text: S) -> io::Result<Option<PathBuf>> {
        let new_file = self.write(text)?;

        if new_file.is_none() {
            match self.file {
                Some(ref mut file) => {
                    let n = file.write(b"\n")?;

                    if n != 1 {
                        return Err(io::Error::new(io::ErrorKind::BrokenPipe, "The space is not enough."));
                    }

                    self.file_size += 1u64;
                }
                None => {
                    panic!("impossible");
                }
            }
            self.print("\n");
        }

        Ok(new_file)
    }

    fn print<S: AsRef<str>>(&self, text: S) {
        let s = text.as_ref();

        match &self.tee {
            Some(tee) => {
                match tee {
                    Tee::Stdout => {
                        print!("{}", s);
                    }
                    Tee::Stderr => {
                        eprint!("{}", s);
                    }
                }
            }
            None => ()
        }
    }
}

// TODO -----PipeLogger END-----