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
//! A collection of [`log4rs`] appenders and configuration for logging in the
//! same style as the Python package [`mlzlog`].
//!
//! [`log4rs`]: https://github.com/sfackler/log4rs
//! [`mlzlog`]: http://pypi.python.org/pypi/mlzlog

pub use log4rs;

use std::env;
use std::fmt;
use std::error::Error;
use std::fs::{DirBuilder, File, OpenOptions, remove_file};
use std::io::{self, Stdout, Write, BufWriter};
use std::path::{Path, PathBuf};
use hashbrown::HashSet;
use parking_lot::Mutex;
#[cfg(target_family = "unix")]
use std::os::unix::fs::symlink;
#[cfg(target_family = "windows")]
use std::os::windows::fs::symlink_file as symlink;

use time::{Timespec, Tm, Duration, get_time, now, strftime};
use log::{Level, Record, LevelFilter};
use log4rs::append::Append;
use log4rs::filter::{Filter, Response as FilterResponse};
use log4rs::encode::Encode;
use log4rs::encode::pattern::PatternEncoder;
use log4rs::encode::writer::simple::SimpleWriter;
use log4rs::config::{Config, Root, Appender};
use ansi_term::Colour::{Red, White, Purple};


fn ensure_dir<P: AsRef<Path>>(path: P) -> io::Result<()> {
    if path.as_ref().is_dir() {
        return Ok(());
    }
    DirBuilder::new().recursive(true).create(path)
}


/// A log4rs appender that writes ANSI colored log messages to stdout.
pub struct ConsoleAppender {
    prefix: String,
    stdout: Stdout,
}

impl fmt::Debug for ConsoleAppender {
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        fmt.write_str("<console>")
    }
}

impl ConsoleAppender {
    pub fn new(prefix: &str) -> ConsoleAppender {
        ConsoleAppender { prefix: prefix.into(),
                          stdout: io::stdout(), }
    }
}

impl Default for ConsoleAppender {
    fn default() -> Self {
        Self::new("")
    }
}

impl Append for ConsoleAppender {
    fn append(&self, record: &Record) -> Result<(), Box<dyn Error + Send + Sync>> {
        let mut stdout = self.stdout.lock();
        let time_str = strftime("[%H:%M:%S]", &now()).unwrap();
        let msg = log_mdc::get("thread", |thread_str| {
            let thread_str = thread_str.unwrap_or("");
            match record.level() {
                Level::Error => Red.bold().paint(
                    format!("{}{}ERROR: {}", self.prefix, thread_str, record.args())),
                Level::Warn  => Purple.paint(
                    format!("{}{}WARNING: {}", self.prefix, thread_str, record.args())),
                Level::Debug => White.paint(
                    format!("{}{}{}", self.prefix, thread_str, record.args())),
                _ => From::from(
                    format!("{}{}{}", self.prefix, thread_str, record.args())),
            }
        });
        writeln!(stdout, "{} {}", White.paint(time_str), msg)?;
        stdout.flush()?;
        Ok(())
    }

    fn flush(&self) {
        // nothing here, like in upstream appender impl
    }
}


/// A log4rs appender that writes uncolored log messages to stdout.
pub struct PlainConsoleAppender {
    prefix: String,
    stdout: Stdout,
}

impl fmt::Debug for PlainConsoleAppender {
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        fmt.write_str("<console>")
    }
}

impl PlainConsoleAppender {
    pub fn new(prefix: &str) -> Self {
        Self { prefix: prefix.into(),
               stdout: io::stdout(), }
    }
}

impl Default for PlainConsoleAppender {
    fn default() -> Self {
        Self::new("")
    }
}

impl Append for PlainConsoleAppender {
    fn append(&self, record: &Record) -> Result<(), Box<dyn Error + Send + Sync>> {
        let mut stdout = self.stdout.lock();
        let time_str = strftime("[%H:%M:%S]", &now()).unwrap();
        log_mdc::get("thread", |thread_str| {
            let thread_str = thread_str.unwrap_or("");
            match record.level() {
                Level::Error => writeln!(stdout, "{} {}{}ERROR: {}",
                                         time_str, self.prefix, thread_str, record.args()),
                Level::Warn  => writeln!(stdout, "{} {}{}WARNING: {}",
                                         time_str, self.prefix, thread_str, record.args()),
                Level::Debug => writeln!(stdout, "{} {}{}DEBUG: {}",
                                         time_str, self.prefix, thread_str, record.args()),
                _ =>            writeln!(stdout, "{} {}{}{}",
                                         time_str, self.prefix, thread_str, record.args()),
            }
        })?;
        stdout.flush()?;
        Ok(())
    }

    fn flush(&self) {
        // nothing here, like in upstream appender impl
    }
}


type Writer = SimpleWriter<BufWriter<File>>;

/// A log4rs appender that writes to daily rolling logfiles with the date
/// used as a suffix in the filename.
#[derive(Debug)]
pub struct RollingFileAppender {
    dir:     PathBuf,
    prefix:  String,
    link_fn: PathBuf,
    file:    Mutex<(Option<Writer>, Timespec)>,
    pattern: PatternEncoder,
}

impl RollingFileAppender {
    pub fn new(dir: &Path, prefix: &str) -> RollingFileAppender {
        let thisday = Tm { tm_hour: 0, tm_min: 0, tm_sec: 0, tm_nsec: 0, ..now() };
        let roll_at = (thisday + Duration::days(1)).to_timespec();
        let pattern = PatternEncoder::new("{d(%H:%M:%S,%f)(local)} : {l:<5} : {X(thread)}{m}{n}");
        let link_fn = dir.join("current");
        let prefix = prefix.replace("/", "-");
        RollingFileAppender { dir: dir.to_path_buf(),
                              prefix,
                              link_fn,
                              file: Mutex::new((None, roll_at)),
                              pattern, }
    }

    fn rollover(&self, file_opt: &mut Option<Writer>, roll_at: &mut Timespec) -> io::Result<()> {
        file_opt.take(); // will drop the file if open
        let time = strftime("%Y-%m-%d", &now()).unwrap();
        let full = format!("{}-{}.log", self.prefix, time);
        let new_fn = self.dir.join(full);
        let fp = OpenOptions::new()
            .create(true).write(true).append(true)
            .open(&new_fn)?;
        *file_opt = Some(SimpleWriter(BufWriter::new(fp)));
        let _ = remove_file(&self.link_fn);
        let _ = symlink(&new_fn.file_name().unwrap(), &self.link_fn);
        *roll_at = *roll_at + Duration::days(1);
        Ok(())
    }
}

impl Append for RollingFileAppender {
    fn append(&self, record: &Record) -> Result<(), Box<dyn Error + Send + Sync>> {
        let (ref mut file_opt, ref mut roll_at) = *self.file.lock();
        if file_opt.is_none() || get_time() >= *roll_at {
            self.rollover(file_opt, roll_at)?;
        }
        let fp = file_opt.as_mut().unwrap();
        self.pattern.encode(fp, record)?;
        fp.flush()?;
        Ok(())
    }

    fn flush(&self) {
        // nothing here, like in upstream appender impl
    }
}

#[cfg(feature="systemd")]
use systemd::journal;

/// An appender which logs to the systemd journal.
#[derive(Debug)]
#[cfg(feature="systemd")]
pub struct JournalAppender;

#[cfg(feature="systemd")]
impl Append for JournalAppender {
    fn append(&self, record: &Record) -> Result<(), Box<dyn Error + Send + Sync>> {
        journal::log_record(record);
        Ok(())
    }

    fn flush(&self) { }
}

/// A log4rs filter for filtering by target.
#[derive(Debug, Clone)]
pub struct TargetFilter {
    black: HashSet<String>,
    white: HashSet<String>,
}

impl Filter for TargetFilter {
    fn filter(&self, record: &Record) -> FilterResponse {
        self.filter_inner(record.target())
    }
}

impl TargetFilter {
    fn new(black: HashSet<String>, white: HashSet<String>) -> Self {
        Self { black, white }
    }

    fn filter_inner(&self, target: &str) -> FilterResponse {
        use self::FilterResponse::*;
        if self.black.contains(target) {
            Reject
        } else if self.white.contains(target) {
            Neutral
        } else {
            // no specific entry for this module, try the parent
            target.rsplitn(2, "::").nth(1).map_or_else(
                || if self.white.is_empty() { Neutral } else { Reject },
                |parent| self.filter_inner(parent))
        }
    }
}

fn parse_filter_config(cfg: String) -> TargetFilter {
    let mut black = HashSet::default();
    let mut white = HashSet::default();

    for entry in cfg.split(',') {
        if entry.starts_with('-') {
            black.insert(entry[1..].into());
        } else if entry.starts_with('+') {
            white.insert(entry[1..].into());
        } else {
            white.insert(entry.into());
        }
    }

    TargetFilter::new(black, white)
}


/// Settings struct for mlzlog::init().
///
/// It is recommended to use this as
///
/// ```
/// # use mlzlog::Settings;
/// let settings = Settings { show_appname: false, .. Settings::default() };
/// ```
///
/// to avoid code breaking when new options are added.
///
/// If `show_appname` is true, the appname is prepended to console messages.
/// If `debug` is true, debug messages are output.  If `use_stdout` is true, a
/// `ConsoleAppender` is created to log to stdout.  If `use_journal` is true,
/// messages will be written to journald.
#[derive(Debug, Clone)]
pub struct Settings {
    pub show_appname: bool,
    pub debug: bool,
    pub use_stdout: bool,
    pub stdout_color: bool,
    pub use_journal: bool,
}

impl Default for Settings {
    fn default() -> Self {
        Self {
            show_appname: true,
            debug: false,
            use_stdout: true,
            stdout_color: true,
            use_journal: false,
        }
    }
}


/// Initialize default mlzlog settings.
///
/// `log_path` is the base path for logfiles.  The `appname` is used as the base
/// name for the logfiles, with the current day appended.  The logfile is rolled
/// over on midnight.  A symbolic link named `current` always links to the
/// latest file.
///
/// If `log_path` is `None`, no logfiles are written to disk.
///
/// The hardcoded setting of `log_path` can be overridden by an environment
/// variabled named `MLZ_LOG_PATH`.  If it is empty, no logfiles are written,
/// else it specifies the new base path.
///
/// Logger target filtering can be configured using the `MLZ_LOG_FILTER`
/// environment variable.  Its syntax is "[+-]?target1,[+-]?target2,..."  where
/// `+` or no prefix enters the target into a whitelist, while `-` enters it
/// into a blacklist.  If there are no whitelist entries, anything not in the
/// blacklist will be let through.
///
/// The black- and whitelists are checked for the record's target and then for
/// its parents (as given by `rust::module::paths`).  The first match wins.
pub fn init<P: AsRef<Path>>(log_path: Option<P>, appname: &str, settings: Settings) -> io::Result<()> {
    let mut config = Config::builder();
    let mut root_cfg = Root::builder();
    let mut log_path = log_path.map(|p| p.as_ref().to_path_buf());

    // override
    if let Some(path) = env::var_os("MLZ_LOG_PATH") {
        if path.is_empty() {
            log_path = None;
        } else {
            log_path = Some(Path::new(&path).to_path_buf());
        }
    }

    let filter = env::var("MLZ_LOG_FILTER").ok().map(parse_filter_config);

    if let Some(p) = log_path {
        ensure_dir(&p)?;
        let file_appender = RollingFileAppender::new(&p, appname);
        root_cfg = root_cfg.appender("file");
        let mut app_builder = Appender::builder();
        if let Some(ref f) = filter {
            app_builder = app_builder.filter(Box::new(f.clone()));
        }
        config = config.appender(app_builder.build("file", Box::new(file_appender)));
    }
    if settings.use_stdout {
        let appname_prefix = format!("[{}] ", appname);
        let prefix = if settings.show_appname { &appname_prefix } else { "" };
        root_cfg = root_cfg.appender("con");
        let mut app_builder = Appender::builder();
        if let Some(ref f) = filter {
            app_builder = app_builder.filter(Box::new(f.clone()));
        }
        if settings.stdout_color {
            let con_appender = ConsoleAppender::new(prefix);
            config = config.appender(app_builder.build("con", Box::new(con_appender)));
        } else {
            let con_appender = PlainConsoleAppender::new(prefix);
            config = config.appender(app_builder.build("con", Box::new(con_appender)));
        }
    }
    #[cfg(feature="systemd")]
    {
        if use_journal {
            let mut app_builder = Appender::builder();
            if let Some(ref f) = filter {
                app_builder = app_builder.filter(Box::new(f.clone()));
            }
            config = config.appender(app_builder.build("journal", Box::new(JournalAppender)));
        }
    }
    #[cfg(not(feature="systemd"))]
    {
        if settings.use_journal {
            return Err(io::Error::new(
                io::ErrorKind::Other,
                "journal integration requested, but not built into crate".to_string()));
        }
    }
    let config = config.build(root_cfg.build(if settings.debug { LevelFilter::Debug }
                                             else { LevelFilter::Info }))
                       .expect("error building logging config");

    let _ = log4rs::init_config(config);
    Ok(())
}


/// Set logging prefix for the current thread.
///
/// This prefix is prepended to every log message from that thread.
pub fn set_thread_prefix(prefix: impl Into<String>) {
    log_mdc::insert("thread", prefix.into());
}