logging.i

<?php
// vim: tabstop=2 expandtab syn=php

/*
 * Provide some global logging routines for Odyssey.
 */


abstract class Logger {

  /**
   * devMode -- Is the environment currently set to be in dev mode?
   *            {true, false (default)}
   */
  private $devMode = false;

  function __construct($name="root", $pDevMode=false) {

    $this->name = $name;
    $this->devMode = $pDevMode;
  }

  abstract protected function log($level, $log);

  protected function log_format($level, ...$args) {
    /**
      *  args can be a variable number of messages.
      *  ONLY 1
      *    then this is the only message and there is no extra formatting
      *
      *  > 1
      *    This option will format the string, based on the printf format, which should be the first argument in that array
      *        ** NOTE using [] is short notation for declaring an array
      *    For example  $logger->info("%s %s", "Print this String", "Then this string");
      *
      */
    if (count($args) == 1) {
      $logMsg = array_shift($args);
    } else {
        // ** First argument is the format
        // ** Remaining arguments will be used in the vsprintf function
        // ** However, if there aren't enough items in the array to match the printf formatting %
          // ** then an error is thrown.  Trying to catch that here.  And then just print out the array elements as a string
        // *** NOTE:  When using this method a warning will be raised if you have less arguments than formats % for vsprintf
      $fmt = array_shift($args);
      $logMsg = vsprintf($fmt, $args);
    }
    // pass string to log function and return response
    return $this->log($level, $logMsg);
  }

  function debug(...$msg) {
    /**
     * (3/6/18) - Debug prints should not make it to production.
     * The intent of debug is purely for debugging development code.
     * If you would like to dump extra information to the log to better track down
     * error in production then use either
     * info or
     * error
     */
    if ($this->devMode) {
      return $this->log_format('DEBUG', ...$msg);
    }
  }

  function info(...$msg) {
    return $this->log_format('INFO', ...$msg);
  }

  function warning(...$msg) {
    // return $this->log_format('WARNING', ...$msg);
    return $this->notice(...$msg);
  }

  function notice(...$msg) {
    return $this->log_format('NOTICE', ...$msg);
  }
  function error(...$msg) {
    return $this->log_format('ERROR', ...$msg);
  }
}


class StandardLogger extends Logger {

  protected function log($level, $msg) {
    $log = sprintf("[%s] [%s]: %s\n", $level, $this->name, $msg);
    return fwrite($this->fd, $log);
  }

  function __construct(...$args) {
    $this->fd = fopen('php://stdout', 'w');
    parent::__construct(...$args);
  }
}


class ColorStandardLogger extends StandardLogger {

  protected $level_to_color = [
    'DEBUG' => 'yellow',
    'INFO' => 'blue',
    'NOTICE' => 'green',
    'ERROR' => 'red'
  ];

  protected $color_to_vt100 = [
    'normal' => "",
    'yellow' => "\033[30;43m",
    'blue' => "\033[34;47m",
    'green' => "\33[32m",
    'purple' => "\033[35m",
    'red' => "\033[37;41m"
  ];

  protected function log($level, $msg) {

    $color = $this->level_to_color[$level];
    $vt100 = $this->color_to_vt100[$color];
    $level = $vt100 . $level . "\033[0m";
    return parent::log($level, $msg);
  }
}


/* Guess which logger type is best based on the output device. */
/**
 * @param boolean pDevMode - {true, false(default)}Set the dev mode option of the logger
 */
function getLogger($name, $pDevMode=false) {
  $testfd = fopen('php://stdout', 'w');
  try {
      if (posix_isatty($testfd)) {
        return new ColorStandardLogger($name, $pDevMode);
      } else {
        return new StandardLogger($name, $pDevMode);
      }
  } finally {
    fclose($testfd);
  }
}

?>