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

// Copyright (C) 2018 Mateusz Makowski

// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

//! A minimal logging library.
//!
//! This is a tiny library used to write stuff happening in your program to a file.
use std::fs::OpenOptions;
// use std::io;
use std::io::Write;

extern crate chrono;

// Tokens
const TIME: &str = "$time";
const TIMESHORT: &str = "$timeshort";
const DATE: &str = "$date";
const MESSAGE: &str = "$msg";

/// Main structure.
///
/// ````
/// pub struct Logger {
///     pub path: String,
///     pub format: String,
/// }
/// ````
/// * `path`: filepath to the log file you want to use, can be relative.
/// * `format`: output format to be used.
///
/// Available format tokens:
/// * `$time`: logs time in HH:MM.SS format.
/// * `$timeshort`: logs time in HH:MM format.
/// * `$date`: logs current date in DD-MM-YYYY Day format, where "Day" is a three letter abbreviation of week-day name.
/// * `$msg`: where the actual message will be output.
///
/// # Example
///
/// ```` ignore
/// extern crate rlog;
/// use rlog::Logger;
///
/// let log = Logger::new("my.log", "$date $time $msg");
/// assert!(log.log("Just testing"));
/// assert!(log.log("Another test"));
/// ````
///
/// Result is in file `my.log` in the root directory of your crate:
///
/// `10.08.2018 09:06.33 Just testing`
///
/// `10.08.2018 09:06.34 Another test`
///
pub struct Logger {
    pub path: String,
    pub format: String,
}

impl Logger {
    /// Create new instance.
    ///
    /// # Example
    ///
    /// ````
    /// extern crate rlog;
    /// use rlog::Logger;
    ///
    /// let log = Logger::new("test.log", "$msg"); // This format will just log messages without any timestamps.
    /// ````
    pub fn new(path: &str, format: &str) -> Logger {
        Logger {
            path: path.to_string(),
            format: format.to_string(),
        }
    }

    /// Log message `msg` to file.
    ///
    /// Returns `true` on succesful write, `false` otherwise and prints error message to stderr.
    ///
    /// # Example
    ///
    /// ```` ignore
    /// extern crate rlog;
    /// use rlog::Logger;
    ///
    /// let log = Logger::new("my.log", "$date $time $msg");
    /// assert!(log.log("Just testing"));
    /// ````
    pub fn log(&self, msg: &str) -> bool {
        match OpenOptions::new()
            .append(true)
            .create(true)
            .open(&self.path)
        {
            Ok(mut file) => {
                let final_msg = self.parse_format(msg);
                match file.write(final_msg.as_bytes()) {
                    Ok(_) => true,
                    Err(e) => {
                        eprintln!("{}", e);
                        false
                    }
                }
            }
            Err(e) => {
                eprintln!("{}", e);
                false
            }
        }
    }

    fn parse_format(&self, msg: &str) -> String {
        let now = chrono::Local::now();
        let date_str = now.format("%d-%m-%Y %a").to_string();
        let time_str = now.format("[%H:%M.%S]").to_string();
        let timeshort_str = now.format("[%H:%M]").to_string();
        self.format
            .replace(DATE, &date_str)
            .replace(TIME, &time_str)
            .replace(TIMESHORT, &timeshort_str)
            .replace(MESSAGE, msg) + "\n"
    }
}