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
//! # Minimal logger with color support
//!
//! ```
//! # #[macro_use] extern crate log;
//! # extern crate mowl;
//! #
//! # fn main() {
//! mowl::init().unwrap();
//! warn!("Warning");
//! # }
//! ```
#![deny(missing_docs)]
extern crate failure;
extern crate log;
extern crate term;
extern crate time;

use failure::Error;
use log::{Level, LevelFilter, Log, Metadata, Record};
use std::io::prelude::*;
use term::{color::*, StderrTerminal};
use time::{Format, OffsetDateTime};

/// Initializes the global logger with a specific `max_log_level`.
///
/// ```
/// # #[macro_use] extern crate log;
/// # extern crate mowl;
/// #
/// # fn main() {
/// mowl::init_with_level(log::LevelFilter::Warn).unwrap();
///
/// warn!("A warning");
/// info!("A info message");
/// # }
///```
///
/// # Errors
///
/// An error is returned if a logger has already been set.
pub fn init_with_level(log_level: LevelFilter) -> Result<(), Error> {
    log::set_boxed_logger(Box::new(Logger {
        level: log_level,
        enable_colors: true,
    }))
    .map(|()| log::set_max_level(log_level))?;
    Ok(())
}

/// Initializes the global logger with a specific `max_log_level` and
/// without any coloring.
///
/// ```
/// # #[macro_use] extern crate log;
/// # extern crate mowl;
/// #
/// # fn main() {
/// mowl::init_with_level_and_without_colors(log::LevelFilter::Warn).unwrap();
///
/// warn!("A warning");
/// info!("A info message");
/// # }
/// ```
///
/// # Errors
///
/// An error is returned if a logger has already been set.
pub fn init_with_level_and_without_colors(log_level: LevelFilter) -> Result<(), Error> {
    log::set_boxed_logger(Box::new(Logger {
        level: log_level,
        enable_colors: false,
    }))
    .map(|()| log::set_max_level(log_level))?;
    Ok(())
}

/// Initializes the global logger with `max_log_level` set to
/// `LevelFilter::Trace`.
///
/// # Examples
/// ```
/// # #[macro_use] extern crate log;
/// # extern crate mowl;
/// #
/// # fn main() {
/// mowl::init().unwrap();
/// warn!("Warning");
/// # }
/// ```
///
/// # Errors
///
/// An error is returned if logger has already been initialized.
pub fn init() -> Result<(), Error> {
    init_with_level(LevelFilter::Trace)
}

/// The logging structure
pub struct Logger {
    level: LevelFilter,
    enable_colors: bool,
}

impl Log for Logger {
    fn enabled(&self, metadata: &Metadata) -> bool {
        metadata.level() <= self.level
    }

    fn log(&self, record: &Record) {
        if self.enabled(record.metadata()) {
            if let Err(e) = self.log_result(record) {
                println!("Logging failed: {}", e);
            }
        }
    }

    fn flush(&self) {}
}

impl Logger {
    fn log_result(&self, record: &Record) -> Result<(), Error> {
        // We have to create a new terminal on each log because Send is not fulfilled
        let mut t = LogSink::new();
        if self.enable_colors {
            t.fg(BRIGHT_BLACK)?;
        }
        write!(
            t,
            "[{}] ",
            OffsetDateTime::now_utc().lazy_format(Format::Rfc3339)
        )?;
        if self.enable_colors {
            t.fg(BRIGHT_BLUE)?;
        }
        write!(t, "[{}] ", record.module_path().unwrap_or("?"))?;
        if self.enable_colors {
            match record.level() {
                Level::Error => t.fg(BRIGHT_RED)?,
                Level::Warn => t.fg(BRIGHT_YELLOW)?,
                Level::Info => t.fg(BRIGHT_GREEN)?,
                Level::Debug => t.fg(BRIGHT_CYAN)?,
                Level::Trace => t.fg(BRIGHT_WHITE)?,
            };
        }
        write!(t, "[{}] ", record.level())?;
        if self.enable_colors {
            t.reset()?;
        }
        writeln!(t, "{}", record.args())?;
        Ok(())
    }

    /// Disable coloring output
    pub fn disable_colors(&mut self) {
        self.enable_colors = false;
    }
}

/// Different output implementations for the logger.
enum LogSink {
    /// Stderr Terminal as default
    Terminal(Box<StderrTerminal>),
    /// Stderr as fallback if a terminal cannot be instantiated
    Fallback(std::io::Stderr),
}

impl LogSink {
    fn new() -> Self {
        if let Some(term) = term::stderr() {
            Self::Terminal(term)
        } else {
            Self::Fallback(std::io::stderr())
        }
    }

    fn fg(&mut self, color: Color) -> Result<(), Error> {
        if let Self::Terminal(t) = self {
            t.fg(color)?;
        }
        Ok(())
    }

    fn reset(&mut self) -> Result<(), Error> {
        if let Self::Terminal(t) = self {
            t.reset()?;
        }
        Ok(())
    }
}

/// Implement Write for `LogSink` by forwarding to the underlying Writers
impl std::io::Write for LogSink {
    fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> {
        match self {
            Self::Terminal(t) => t.write(buf),
            Self::Fallback(e) => e.write(buf),
        }
    }

    fn write_vectored(&mut self, bufs: &[std::io::IoSlice<'_>]) -> std::io::Result<usize> {
        match self {
            Self::Terminal(t) => t.write_vectored(bufs),
            Self::Fallback(e) => e.write_vectored(bufs),
        }
    }

    fn flush(&mut self) -> std::io::Result<()> {
        match self {
            Self::Terminal(t) => t.flush(),
            Self::Fallback(e) => e.flush(),
        }
    }

    fn write_all(&mut self, buf: &[u8]) -> std::io::Result<()> {
        match self {
            Self::Terminal(t) => t.write_all(buf),
            Self::Fallback(e) => e.write_all(buf),
        }
    }

    fn write_fmt(&mut self, args: std::fmt::Arguments<'_>) -> std::io::Result<()> {
        match self {
            Self::Terminal(t) => t.write_fmt(args),
            Self::Fallback(e) => e.write_fmt(args),
        }
    }
}