Change logging to easylogging++

This replaces the epee and data_loggers logging systems with
a single one, and also adds filename:line and explicit severity
levels. Categories may be defined, and logging severity set
by category (or set of categories). epee style 0-4 log level
maps to a sensible severity configuration. Log files now also
rotate when reaching 100 MB.

To select which logs to output, use the MONERO_LOGS environment
variable, with a comma separated list of categories (globs are
supported), with their requested severity level after a colon.
If a log matches more than one such setting, the last one in
the configuration string applies. A few examples:

This one is (mostly) silent, only outputting fatal errors:

MONERO_LOGS=*:FATAL

This one is very verbose:

MONERO_LOGS=*:TRACE

This one is totally silent (logwise):

MONERO_LOGS=""

This one outputs all errors and warnings, except for the
"verify" category, which prints just fatal errors (the verify
category is used for logs about incoming transactions and
blocks, and it is expected that some/many will fail to verify,
hence we don't want the spam):

MONERO_LOGS=*:WARNING,verify:FATAL

Log levels are, in decreasing order of priority:
FATAL, ERROR, WARNING, INFO, DEBUG, TRACE

Subcategories may be added using prefixes and globs. This
example will output net.p2p logs at the TRACE level, but all
other net* logs only at INFO:

MONERO_LOGS=*:ERROR,net*:INFO,net.p2p:TRACE

Logs which are intended for the user (which Monero was using
a lot through epee, but really isn't a nice way to go things)
should use the "global" category. There are a few helper macros
for using this category, eg: MGINFO("this shows up by default")
or MGINFO_RED("this is red"), to try to keep a similar look
and feel for now.

Existing epee log macros still exist, and map to the new log
levels, but since they're used as a "user facing" UI element
as much as a logging system, they often don't map well to log
severities (ie, a log level 0 log may be an error, or may be
something we want the user to see, such as an important info).
In those cases, I tried to use the new macros. In other cases,
I left the existing macros in. When modifying logs, it is
probably best to switch to the new macros with explicit levels.

The --log-level options and set_log commands now also accept
category settings, in addition to the epee style log levels.

1 files changed, 319 insertions, 0 deletions

diff --git a/contrib/epee/src/mlog.cpp b/contrib/epee/src/mlog.cpp
new file mode 100644
index 000000000..37a15bbd5
--- /dev/null
+++ b/contrib/epee/src/mlog.cpp
@@ -0,0 +1,319 @@
+// Copyright (c) 2006-2013, Andrey N. Sabelnikov, www.sabelnikov.net
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are met:
+// * Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+// * Redistributions in binary form must reproduce the above copyright
+// notice, this list of conditions and the following disclaimer in the
+// documentation and/or other materials provided with the distribution.
+// * Neither the name of the Andrey N. Sabelnikov nor the
+// names of its contributors may be used to endorse or promote products
+// derived from this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER  BE LIABLE FOR ANY
+// DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+//
+
+
+#ifndef _MLOG_H_
+#define _MLOG_H_
+
+#include <atomic>
+#include "misc_log_ex.h"
+
+INITIALIZE_EASYLOGGINGPP
+
+//#define MLOG_BASE_FORMAT "%datetime{%Y-%M-%d %H:%m:%s.%g}\t%thread\t%level\t%logger\t%fbase:%line\t%msg"
+#define MLOG_BASE_FORMAT "%datetime{%Y-%M-%d %H:%m:%s.%g}\t%thread\t%level\t%logger\t%loc\t%msg"
+
+using namespace epee;
+
+static std::string generate_log_filename(const char *base)
+{
+  std::string filename(base);
+  char tmp[200];
+  struct tm tm;
+  time_t now = time(NULL);
+  if (!gmtime_r(&now, &tm))
+    strcpy(tmp, "unknown");
+  else
+    strftime(tmp, sizeof(tmp), "%Y-%m-%d-%H-%M-%S", &tm);
+  filename += "-";
+  filename += tmp;
+  return filename;
+}
+
+std::string mlog_get_default_log_path(const char *default_filename)
+{
+  std::string process_name = epee::string_tools::get_current_module_name();
+  std::string default_log_folder = epee::string_tools::get_current_module_folder();
+  std::string default_log_file = process_name;
+  std::string::size_type a = default_log_file.rfind('.');
+  if ( a != std::string::npos )
+    default_log_file.erase( a, default_log_file.size());
+  if ( ! default_log_file.empty() )
+    default_log_file += ".log";
+  else
+    default_log_file = default_filename;
+
+  return (boost::filesystem::path(default_log_folder) / boost::filesystem::path(default_log_file)).string();
+}
+
+static void mlog_set_common_prefix()
+{
+  static const char * const expected_filename = "contrib/epee/src/mlog.cpp";
+  const char *path = __FILE__, *expected_ptr = strstr(path, expected_filename);
+  if (!expected_ptr)
+    return;
+  el::Loggers::setFilenameCommonPrefix(std::string(path, expected_ptr - path));
+}
+
+void mlog_configure(const std::string &filename_base, bool console)
+{
+  el::Configurations c;
+  c.setGlobally(el::ConfigurationType::Filename, filename_base);
+  c.setGlobally(el::ConfigurationType::ToFile, "true");
+  c.setGlobally(el::ConfigurationType::Format, MLOG_BASE_FORMAT);
+  c.setGlobally(el::ConfigurationType::ToStandardOutput, console ? "true" : "false");
+  c.setGlobally(el::ConfigurationType::MaxLogFileSize, "104850000"); // 100 MB - 7600 bytes
+  el::Loggers::setDefaultConfigurations(c, true);
+
+  el::Loggers::addFlag(el::LoggingFlag::HierarchicalLogging);
+  el::Loggers::addFlag(el::LoggingFlag::CreateLoggerAutomatically);
+  el::Loggers::addFlag(el::LoggingFlag::DisableApplicationAbortOnFatalLog);
+  el::Loggers::addFlag(el::LoggingFlag::ColoredTerminalOutput);
+  el::Loggers::addFlag(el::LoggingFlag::StrictLogFileSizeCheck);
+  el::Helpers::installPreRollOutCallback([&filename_base](const char *name, size_t){
+    std::string rname = generate_log_filename(filename_base.c_str());
+    rename(name, rname.c_str());
+  });
+  mlog_set_common_prefix();
+  const char *monero_log = getenv("MONERO_LOGS");
+  if (!monero_log)
+  {
+    monero_log = "*:WARNING,net*:FATAL,global:INFO,verify:FATAL";
+  }
+  mlog_set_categories(monero_log);
+}
+
+void mlog_set_categories(const char *categories)
+{
+  el::Loggers::setCategories(categories);
+  MINFO("Mew log categories: " << categories);
+}
+
+// maps epee style log level to new logging system
+void mlog_set_log_level(int level)
+{
+    const char *settings = NULL;
+    switch (level)
+    {
+      case 0:
+        settings = "*:FATAL,net*:FATAL,global:INFO,verify:FATAL";
+        break;
+      case 1:
+        settings = "*:WARNING,global:INFO";
+        break;
+      case 2:
+        settings = "*:INFO";
+        break;
+      case 3:
+        settings = "*:DEBUG";
+        break;
+      case 4:
+        settings = "*:TRACE";
+        break;
+      default:
+        return;
+    }
+
+    el::Loggers::setCategories(settings);
+    MINFO("Mew log categories: " << settings);
+}
+
+void mlog_set_log(const char *log)
+{
+  long level;
+  char *ptr = NULL;
+
+  level = strtoll(log, &ptr, 10);
+  if (ptr && *ptr)
+  {
+    mlog_set_categories(log);
+  }
+  else if (level >= 0 && level <= 4)
+  {
+    mlog_set_log_level(level);
+  }
+  else
+  {
+    MERROR("Invalid numerical log level: " << log);
+  }
+}
+
+namespace epee
+{
+
+bool is_stdout_a_tty()
+{
+  static std::atomic<bool> initialized(false);
+  static std::atomic<bool> is_a_tty(false);
+
+  if (!initialized.load(std::memory_order_acquire))
+  {
+#if defined(WIN32)
+    is_a_tty.store(0 != _isatty(_fileno(stdout)), std::memory_order_relaxed);
+#else
+    is_a_tty.store(0 != isatty(fileno(stdout)), std::memory_order_relaxed);
+#endif
+    initialized.store(true, std::memory_order_release);
+  }
+
+  return is_a_tty.load(std::memory_order_relaxed);
+}
+
+void set_console_color(int color, bool bright)
+{
+  if (!is_stdout_a_tty())
+    return;
+
+  switch(color)
+  {
+  case console_color_default:
+    {
+#ifdef WIN32
+      HANDLE h_stdout = GetStdHandle(STD_OUTPUT_HANDLE);
+      SetConsoleTextAttribute(h_stdout, FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE| (bright ? FOREGROUND_INTENSITY:0));
+#else
+      if(bright)
+        std::cout << "\033[1;37m";
+      else
+        std::cout << "\033[0m";
+#endif
+    }
+    break;
+  case console_color_white:
+    {
+#ifdef WIN32
+      HANDLE h_stdout = GetStdHandle(STD_OUTPUT_HANDLE);
+      SetConsoleTextAttribute(h_stdout, FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE | (bright ? FOREGROUND_INTENSITY:0));
+#else
+      if(bright)
+        std::cout << "\033[1;37m";
+      else
+        std::cout << "\033[0;37m";
+#endif
+    }
+    break;
+  case console_color_red:
+    {
+#ifdef WIN32
+      HANDLE h_stdout = GetStdHandle(STD_OUTPUT_HANDLE);
+      SetConsoleTextAttribute(h_stdout, FOREGROUND_RED | (bright ? FOREGROUND_INTENSITY:0));
+#else
+      if(bright)
+        std::cout << "\033[1;31m";
+      else
+        std::cout << "\033[0;31m";
+#endif
+    }
+    break;
+  case console_color_green:
+    {
+#ifdef WIN32
+      HANDLE h_stdout = GetStdHandle(STD_OUTPUT_HANDLE);
+      SetConsoleTextAttribute(h_stdout, FOREGROUND_GREEN | (bright ? FOREGROUND_INTENSITY:0));
+#else
+      if(bright)
+        std::cout << "\033[1;32m";
+      else
+        std::cout << "\033[0;32m";
+#endif
+    }
+    break;
+
+  case console_color_blue:
+    {
+#ifdef WIN32
+      HANDLE h_stdout = GetStdHandle(STD_OUTPUT_HANDLE);
+      SetConsoleTextAttribute(h_stdout, FOREGROUND_BLUE | FOREGROUND_INTENSITY);//(bright ? FOREGROUND_INTENSITY:0));
+#else
+      if(bright)
+        std::cout << "\033[1;34m";
+      else
+        std::cout << "\033[0;34m";
+#endif
+    }
+    break;
+
+  case console_color_cyan:
+    {
+#ifdef WIN32
+      HANDLE h_stdout = GetStdHandle(STD_OUTPUT_HANDLE);
+      SetConsoleTextAttribute(h_stdout, FOREGROUND_GREEN | FOREGROUND_BLUE | (bright ? FOREGROUND_INTENSITY:0));
+#else
+      if(bright)
+        std::cout << "\033[1;36m";
+      else
+        std::cout << "\033[0;36m";
+#endif
+    }
+    break;
+
+  case console_color_magenta:
+    {
+#ifdef WIN32
+      HANDLE h_stdout = GetStdHandle(STD_OUTPUT_HANDLE);
+      SetConsoleTextAttribute(h_stdout, FOREGROUND_BLUE | FOREGROUND_RED | (bright ? FOREGROUND_INTENSITY:0));
+#else
+      if(bright)
+        std::cout << "\033[1;35m";
+      else
+        std::cout << "\033[0;35m";
+#endif
+    }
+    break;
+
+  case console_color_yellow:
+    {
+#ifdef WIN32
+      HANDLE h_stdout = GetStdHandle(STD_OUTPUT_HANDLE);
+      SetConsoleTextAttribute(h_stdout, FOREGROUND_RED | FOREGROUND_GREEN | (bright ? FOREGROUND_INTENSITY:0));
+#else
+      if(bright)
+        std::cout << "\033[1;33m";
+      else
+        std::cout << "\033[0;33m";
+#endif
+    }
+    break;
+
+  }
+}
+
+void reset_console_color() {
+  if (!is_stdout_a_tty())
+    return;
+
+#ifdef WIN32
+  HANDLE h_stdout = GetStdHandle(STD_OUTPUT_HANDLE);
+  SetConsoleTextAttribute(h_stdout, FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE);
+#else
+  std::cout << "\033[0m";
+  std::cout.flush();
+#endif
+}
+
+}
+
+#endif //_MLOG_H_