mbilogTextBackendBase.cpp

Go to the documentation of this file.

/*===================================================================

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center,
Division of Medical and Biological Informatics.
All rights reserved.

This software is distributed WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.

See LICENSE.txt or http://www.mitk.org for details.

===================================================================*/

#include "mbilogTextBackendBase.h"
#include "mbilogLoggingTypes.h"
#include <ctime>
#include <iomanip>
#include <iostream>
#include <vector>

#ifdef _WIN32
#define USE_WIN32COLOREDCONSOLE
#include <windows.h>
#include "mbilogTextDictionary.h"
#endif

static bool g_init = false;

mbilog::TextBackendBase::~TextBackendBase()
{
}

#ifdef USE_WIN32COLOREDCONSOLE

static HANDLE g_hConsole;

class AutoCategorize
{
protected:
  std::vector<std::string> path;

  std::string current, category;

  int pos;

  void flush()
  {
    if (current.size() > 0)
    {
      if (current.compare("..") == 0)
      {
        if (path.size() > 0)
          path.pop_back();
      }
      else
      {
        path.push_back(current);
      }
      current = "";
    }
  }

  std::string simplify(std::string x)
  {
    bool redo;

    std::string lft(""), rgt("");

    do
    {
      redo = false;

      for (int r = 0; r < sizeof(mbilog::replace) / sizeof(char *); r += 2)
      {
        int s = static_cast<int>(strlen(mbilog::replace[r]));
        int xs = static_cast<int>(x.size());

        if (xs == s)
        {
          if (mbilog::replace[r + 1][0] || !lft.empty() || !rgt.empty())
            if (x.compare(mbilog::replace[r]) == 0)
              x = mbilog::replace[r + 1];
        }
        else if (xs > s)
        {
          if (strncmp(mbilog::replace[r], &x.c_str()[xs - s], s) == 0)
          {
            std::string rp = mbilog::replace[r + 1];
            if (!rp.empty())
              rp[0] = toupper(rp[0]);
            x = x.substr(0, xs - s);
            rgt = rp + rgt;
            redo = true;
          }
          else if (strncmp(mbilog::replace[r], x.c_str(), s) == 0)
          {
            std::string rp = mbilog::replace[r + 1];
            if (!rp.empty())
              rp[0] = toupper(rp[0]);
            x = x.substr(s, xs - s);
            lft = lft + rp;
            redo = true;
          }
        }
      }
    } while (redo);

    x[0] = toupper(x[0]);

    x = lft + x + rgt;

    x[0] = tolower(x[0]);

    return x;
  }

  std::string concat(std::string a, std::string b, bool opt)
  {
    int as = static_cast<int>(a.size());
    int bs = static_cast<int>(b.size());
    if (opt && as <= bs)
    {
      if (as == bs && a.compare(b) == 0)
        return a;

      if (strncmp(a.c_str(), b.c_str(), as) == 0)
      {
        b = b.substr(as, bs - as);
        b[0] = tolower(b[0]);
      }
    }

    return a + "." + b;
  }

  bool search2p2(char *a, char *b, bool optimize = true)
  {
    int size = static_cast<int>(path.size()) - 3;
    for (int r = 0; r < size; r++)
      if (path[r].compare(a) == 0 && path[r + 1].compare(b) == 0)
      {
        pos = r + 2;
        category = concat(simplify(path[pos]), simplify(path[path.size() - 1]), optimize);
        return true;
      }
    return false;
  }

  bool search2p1(char *a, char *b)
  {
    int size = static_cast<int>(path.size()) - 2;
    for (int r = 0; r < size; r++)
      if (path[r].compare(a) == 0 && path[r + 1].compare(b) == 0)
      {
        pos = r + 2;
        category = simplify(path[path.size() - 1]);
        return true;
      }
    return false;
  }

  bool search1p2(char *a, bool optimize = true)
  {
    int size = static_cast<int>(path.size()) - 2;
    for (int r = 0; r < size; r++)
      if (path[r].compare(a) == 0)
      {
        pos = r + 1;
        category = concat(simplify(path[pos]), simplify(path[path.size() - 1]), optimize);
        return true;
      }
    return false;
  }

public:
  AutoCategorize(const mbilog::LogMessage &l)
  {
    int size = static_cast<int>(strlen(l.filePath));

    current = "";

    for (int r = 0; r < size; r++)
    {
      char c = l.filePath[r];
      if (c == '\\' || c == '/')
        flush();
      else
        current += tolower(c);
    }

    flush();
  }

  std::string GetPrefix()
  {
    category = "";
    if (search2p2("mbi-sb", "core", false))
      return "sb.";
    if (search2p1("mbi-sb", "q4mitk"))
      return "sb.ui.";
    if (search2p2("mbi", "applications"))
      return "sb.app.";
    if (search2p2("mbi-sb", "q4applications"))
      return "sb.app.";
    if (search2p2("mbi-sb", "utilities"))
      return "sb.util.";
    if (search2p2("mbi-sb", "bundles"))
      return "sb.bun.";
    if (search2p2("mbi-sb", "bundlesqt"))
      return "sb.bun.";
    if (search2p2("mbi", "modules"))
      return "sb.mod.";

    if (search2p2("mbi-qm", "core", false))
      return "qm.";
    if (search2p2("mbi-qm", "utilities"))
      return "qm.util.";

    if (search2p2("modules", "mitkext", false))
      return "ext.";
    if (search2p1("modules", "qmitkext"))
      return "ext.ui.";
    if (search2p2("modules", "bundles"))
      return "ext.bun.";

    if (search2p2("blueberry", "bundles"))
      return "blueberry.";

    if (search2p2("core", "code", false))
      return "core.";
    if (search2p1("coreui", "qmitk"))
      return "core.ui.";
    if (search2p2("coreui", "bundles"))
      return "core.bun.";

    // following must come last:
    if (search1p2("modules"))
      return "core.mod.";
    if (search1p2("utilities"))
      return "core.util.";
    if (search1p2("applications"))
      return "core.app.";

    return "";
  }

  std::string GetCategory() { return category; }
};

#endif

void mbilog::TextBackendBase::FormatSmart(std::ostream &out, const LogMessage &l, int /*threadID*/)
{
  char c_open = '[';
  char c_close = ']';

  switch (l.level)
  {
    case mbilog::Info:
      break;

    case mbilog::Warn:
      c_open = '!';
      c_close = '!';
      break;

    case mbilog::Error:
      c_open = '#';
      c_close = '#';
      break;

    case mbilog::Fatal:
      c_open = '*';
      c_close = '*';
      break;

    case mbilog::Debug:
      c_open = '{';
      c_close = '}';
      break;
  }

  out << c_open;

  if (!g_init)
  {
    g_init = true;
    AppendTimeStamp(out);
    out << std::endl;
  }

  std::locale C("C");
  std::locale originalLocale = out.getloc();
  out.imbue(C);

  out << std::fixed << std::setprecision(3) << ((double)std::clock()) / CLOCKS_PER_SEC;

  out.imbue(originalLocale);

  out << c_close << " ";

  if (!l.category.empty())
  {
    out << "[" << l.category << "] ";
  }

  switch (l.level)
  {
    case mbilog::Info:
      break;

    case mbilog::Warn:
      out << "WARNING: ";
      break;

    case mbilog::Error:
      out << "ERROR: ";
      break;

    case mbilog::Fatal:
      out << "FATAL: ";
      break;

    case mbilog::Debug:
      out << "DEBUG: ";
      break;
  }

  out << l.message << std::endl;
}

void mbilog::TextBackendBase::FormatFull(std::ostream &out, const LogMessage &l, int threadID)
{
  switch (l.level)
  {
    case mbilog::Info:
      out << "INFO";
      break;

    case mbilog::Warn:
      out << "WARN";
      break;

    case mbilog::Error:
      out << "ERROR";
      break;

    case mbilog::Fatal:
      out << "FATAL";
      break;

    case mbilog::Debug:
      out << "DEBUG";
      break;
  }

  out << "|";

  AppendTimeStamp(out);

  out << "|";

  out << "|" << std::string(l.filePath) << "(" << l.lineNumber << ")";

  out << "|" << std::string(l.functionName);

  // if(threadID)
  {
    out << "|" << std::hex << threadID;
  }

  // if(NA_STRING != l.moduleName)
  {
    out << "|" << std::string(l.moduleName);
  }

  // if(!l.category.empty())
  {
    out << "|" << l.category;
  }

  out << l.message << std::endl;
}

void mbilog::TextBackendBase::FormatSmart(const LogMessage &l, int threadID)
{
#ifdef USE_WIN32COLOREDCONSOLE
  FormatSmartWindows(l, threadID);
#else
  FormatSmart(std::cout, l, threadID);
#endif
}

void mbilog::TextBackendBase::FormatFull(const LogMessage &l, int threadID)
{
  FormatFull(std::cout, l, threadID);
}

void mbilog::TextBackendBase::AppendTimeStamp(std::ostream &out)
{
  time_t rawtime = time(nullptr);
  std::string timestring(ctime(&rawtime));
  timestring.replace(timestring.length() - 1,
                     1,
                     " "); // replace \n by " " (separates date/time from following output of relative time since start)

  std::locale C("C");
  std::locale originalLocale = out.getloc();
  out.imbue(C);

  out << timestring;

  out.imbue(originalLocale);
}

#ifdef USE_WIN32COLOREDCONSOLE

void mbilog::TextBackendBase::FormatSmartWindows(const mbilog::LogMessage &l, int /*threadID*/)
{
  int colorNormal = FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE;

  int lastColor = colorNormal;
#define ChangeColor(_col)                                                                                              \
  {                                                                                                                    \
    int col = (_col);                                                                                                  \
    if (lastColor != (col))                                                                                            \
    {                                                                                                                  \
      SetConsoleTextAttribute(g_hConsole, (col));                                                                      \
      lastColor = (col);                                                                                               \
    }                                                                                                                  \
  }

  int colorTime = FOREGROUND_GREEN;
  int colorText = FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE;
  int colorCat = FOREGROUND_BLUE | FOREGROUND_RED;
  bool showColon = true;
  bool forceCat = false;

  if (!g_init)
  {
    g_hConsole = GetStdHandle(STD_OUTPUT_HANDLE);
    g_init = true;

    std::string title = "mbilog";

    SetConsoleTitle(title.c_str());

    /* Title rendering
    ChangeColor( FOREGROUND_GREEN|FOREGROUND_BLUE|BACKGROUND_BLUE );
    std::cout << " <<< " << std::flush;
    ChangeColor( FOREGROUND_RED|FOREGROUND_GREEN|FOREGROUND_BLUE|FOREGROUND_INTENSITY|BACKGROUND_BLUE );
    std::cout << title << std::flush;
    ChangeColor( FOREGROUND_GREEN|FOREGROUND_BLUE|BACKGROUND_BLUE );
    std::cout << " >>> " << std::flush;
    ChangeColor( colorNormal );
    std::cout << std::endl;
    */

    // Give out start time
    ChangeColor(colorTime);
    AppendTimeStamp(std::cout);
    std::cout << std::endl;
  }

  switch (l.level)
  {
    case mbilog::Info:
      break;

    case mbilog::Warn:
      colorTime = FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_INTENSITY;
      // colorText = FOREGROUND_RED|FOREGROUND_GREEN;
      colorCat = FOREGROUND_BLUE | FOREGROUND_RED | FOREGROUND_INTENSITY;
      showColon = false;
      forceCat = true;
      break;

    case mbilog::Error:
      colorTime = FOREGROUND_RED | FOREGROUND_INTENSITY;
      // colorText = FOREGROUND_RED;
      colorCat = FOREGROUND_BLUE | FOREGROUND_RED | FOREGROUND_INTENSITY;
      showColon = false;
      forceCat = true;
      break;

    case mbilog::Fatal:
      colorTime = FOREGROUND_RED | FOREGROUND_BLUE | FOREGROUND_INTENSITY;
      // colorText = FOREGROUND_RED|FOREGROUND_BLUE|FOREGROUND_INTENSITY;
      colorCat = FOREGROUND_BLUE | FOREGROUND_RED | FOREGROUND_INTENSITY;
      showColon = false;
      forceCat = true;
      break;

    case mbilog::Debug:
      colorTime = FOREGROUND_BLUE | FOREGROUND_INTENSITY;
      // colorText |= FOREGROUND_INTENSITY;
      showColon = false;
      break;
  }

  ChangeColor(colorTime);

  std::locale C("C");
  std::locale originalLocale = std::cout.getloc();
  std::cout.imbue(C);

  std::cout << std::fixed << std::setprecision(2) << ((double)std::clock()) / CLOCKS_PER_SEC << " ";

  std::cout.imbue(originalLocale);

  // category
  {
    AutoCategorize ac(l);
    std::string pre = ac.GetPrefix();
    std::string cat = ac.GetCategory();

    cat = pre + cat;

    if (cat.empty())
      cat = l.category;

    if (!cat.empty())
    {
      ChangeColor(colorCat);
      // static std::string lastCat;
      // if(forceCat||lastCat.compare(cat))
      {
        std::cout << cat << std::flush;
        // lastCat = cat;
      }
      // else
      // std::cout << "..." << std::flush;

      if (showColon)
      {
        ChangeColor(FOREGROUND_BLUE | FOREGROUND_INTENSITY);
        std::cout << ": " << std::flush;
      }
      else
        std::cout << " ";
    }
  }

  switch (l.level)
  {
    case mbilog::Info:
      break;

    case mbilog::Warn:
      ChangeColor(colorTime);
      std::cout << "WARNING" << std::flush;
      ChangeColor(FOREGROUND_BLUE | FOREGROUND_INTENSITY);
      std::cout << ": " << std::flush;
      break;

    case mbilog::Error:
      ChangeColor(colorTime);
      std::cout << "ERROR" << std::flush;
      ChangeColor(FOREGROUND_BLUE | FOREGROUND_INTENSITY);
      std::cout << ": " << std::flush;
      break;

    case mbilog::Fatal:
      ChangeColor(colorTime);
      std::cout << "FATAL" << std::flush;
      ChangeColor(FOREGROUND_BLUE | FOREGROUND_INTENSITY);
      std::cout << ": " << std::flush;
      break;

    case mbilog::Debug:
      ChangeColor(colorTime);
      std::cout << "DBG" << std::flush;
      ChangeColor(FOREGROUND_BLUE | FOREGROUND_INTENSITY);
      std::cout << ": " << std::flush;
      break;
  }

  ChangeColor(colorText);
  std::cout << l.message << std::endl;

  ChangeColor(colorNormal);
}

#endif