// Copyright 2015, 2016 Ethcore (UK) Ltd. // This file is part of Parity. // Parity 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. // Parity 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 Parity. If not, see . //! Common log helper functions use std::env; use std::borrow::Cow; use rlog::{LogLevelFilter}; use env_logger::LogBuilder; use std::sync::{RwLock, RwLockReadGuard}; use std::sync::atomic::{Ordering, AtomicBool}; use arrayvec::ArrayVec; use misc::RwLockable; pub use ansi_term::{Colour, Style}; lazy_static! { static ref USE_COLOR: AtomicBool = AtomicBool::new(false); } /// Something which can be apply()ed. pub trait Applyable: AsRef { /// Apply the style `c` to ourself, returning us styled in that manner. fn apply(&self, c: Style) -> Cow; } impl> Applyable for T { fn apply(&self, c: Style) -> Cow { let s = self.as_ref(); match USE_COLOR.load(Ordering::Relaxed) { true => Cow::Owned(format!("{}", c.paint(s))), false => Cow::Borrowed(s), } } } lazy_static! { static ref LOG_DUMMY: bool = { let mut builder = LogBuilder::new(); builder.filter(None, LogLevelFilter::Info); if let Ok(log) = env::var("RUST_LOG") { builder.parse(&log); } if builder.init().is_ok() { println!("logger initialized"); } true }; } /// Intialize log with default settings pub fn init_log() { let _ = *LOG_DUMMY; } const LOG_SIZE : usize = 128; /// Logger implementation that keeps up to `LOG_SIZE` log elements. pub struct RotatingLogger { /// Defined logger levels levels: String, /// Logs array. Latest log is always at index 0 logs: RwLock>, } impl RotatingLogger { /// Creates new `RotatingLogger` with given levels. /// It does not enforce levels - it's just read only. pub fn new(levels: String, enable_color: bool) -> Self { USE_COLOR.store(enable_color, Ordering::Relaxed); RotatingLogger { levels: levels, logs: RwLock::new(ArrayVec::<[_; LOG_SIZE]>::new()), } } /// Append new log entry pub fn append(&self, log: String) { self.logs.unwrapped_write().insert(0, log); } /// Return levels pub fn levels(&self) -> &str { &self.levels } /// Return logs pub fn logs(&self) -> RwLockReadGuard> { self.logs.unwrapped_read() } } #[cfg(test)] mod test { use super::RotatingLogger; fn logger() -> RotatingLogger { RotatingLogger::new("test".to_owned(), false) } #[test] fn should_return_log_levels() { // given let logger = logger(); // when let levels = logger.levels(); // then assert_eq!(levels, "test"); } #[test] fn should_return_latest_logs() { // given let logger = logger(); // when logger.append("a".to_owned()); logger.append("b".to_owned()); // then let logs = logger.logs(); assert_eq!(logs[0], "b".to_owned()); assert_eq!(logs[1], "a".to_owned()); assert_eq!(logs.len(), 2); } }