monologlogger.php

Go to the documentation of this file.

<?php
/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 This program 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.
*/

use Monolog\Logger as MLogger;
use Monolog\Formatter\LineFormatter;
//use Monolog\Handler\FirePHPHandler;
use Monolog\Handler\RotatingFileHandler;
use Monolog\Handler\StreamHandler;
use Monolog\Processor\WebProcessor;
use Psr\Log\LoggerInterface;
use Psr\Log\LogLevel;
use Xoops\Core\Logger;

class MonologLogger implements LoggerInterface
{
    private $monolog = false;

    private $activated = false;

    private $starttimes = array();

    private $configs = false;

    public function __construct()
    {
        Logger::getInstance()->addLogger($this);
    }

    public static function getInstance()
    {
        static $instance;
        if (!isset($instance)) {
            $class = __CLASS__;
            $instance = new $class();
        }

        return $instance;
    }

    public function disable()
    {
        //error_reporting(0);
        $this->activated = false;
    }

    public function enable()
    {
        error_reporting(E_ALL | E_STRICT);

        $this->activated = true;

        if (!$this->monolog) {
            // Create the logger
            $this->monolog = new \Monolog\Logger('app');
            $proc = new WebProcessor();
            $this->monolog->pushProcessor($proc);
            $this->monolog->pushProcessor(array($this,'xoopsDataProcessor'));

            $formatter = new LineFormatter();
            //$formatter = new LogstashFormatter;
            switch ($this->configs['logging_threshold']) {
                case 'error':
                    $threshold=MLogger::ERROR;
                    break;
                case 'warning':
                    $threshold=MLogger::WARNING;
                    break;
                case 'info':
                    $threshold=MLogger::INFO;
                    break;
                case 'debug':
                default:
                    $threshold=MLogger::DEBUG;
                    break;
            }
            if (intval($this->configs['max_versions']) == 0) {
                $stream = new StreamHandler($this->configs['log_file_path'], $threshold);
            } else {
                $stream = new RotatingFileHandler(
                    $this->configs['log_file_path'],
                    $this->configs['max_versions'],
                    $threshold
                );
            }
            $stream->setFormatter($formatter);
            $this->monolog->pushHandler($stream);
        }
        //if ($this->monolog && $this->configs['phpfire_enable']) {
        //    $firephp = new FirePHPHandler();
        //    $this->monolog->pushHandler($firephp);
        //}
    }

    public function xoopsDataProcessor($record)
    {
        $xoops = \Xoops::getInstance();
        $record['extra']['user'] = '?';
        @$record['extra']['user'] = $xoops->isUser() ? $xoops->user->getVar('uname') : 'n/a';
        return $record;
    }

    public function setConfigs($configs)
    {
        $this->configs=$configs;
    }

    public function isEnable()
    {
        return $this->activated;
    }

    public function quiet()
    {
        //$this->activated = false;
    }

    public function startTime($name = 'XOOPS')
    {
        $this->starttimes[$name] = microtime(true);
    }

    public function stopTime($name = 'XOOPS')
    {
        if ($this->activated) {
            if (array_key_exists($name, $this->starttimes)) {
                $elapsed = microtime(true) - $this->starttimes[$name];
                $msg = sprintf(_MD_MONOLOG_TIMETOLOAD, htmlspecialchars($name), $elapsed);
                $context = array(
                    'channel'=>'Timers',
                );
                $this->log(LogLevel::INFO, $msg, $context);
            }
        }
    }

    public function addQuery($sql, $error = null, $errno = null, $query_time = null)
    {
        if ($this->activated) {
            $level = LogLevel::INFO;
            if (!empty($error)) {
                $level = LogLevel::ERROR;
            }
            $context = array(
                'channel'=>'Queries',
                'error'=>$error,
                'errno'=>$errno,
                'query_time'=>$query_time
            );
            $this->log($level, $sql, $context);
        }
    }

    public function addBlock($name, $cached = false, $cachetime = 0)
    {
        if ($this->activated) {
            $context = array('channel'=>'Blocks', 'cached'=>$cached, 'cachetime'=>$cachetime);
            $this->log(LogLevel::INFO, $name, $context);
        }
    }

    public function addExtra($name, $msg)
    {
        if ($this->activated) {
            $context = array('channel'=>'Extra', 'name'=>$name);
            $this->log(LogLevel::INFO, $msg, $context);
        }
    }

    public function addDeprecated($msg)
    {
        if ($this->activated) {
            $this->log(LogLevel::WARNING, $msg, array('channel'=>'Deprecated'));
        }
    }

    public function addException($e)
    {
        if ($this->activated) {
            $this->error(
                sprintf(
                    $this->messageTag('_MD_MONOLOG_EXCEPTION', 'Exception* : %s : file %s line %s'),
                    $e->getMessage(),
                    $this->sanitizePath($e->getFile()),
                    $e->getLine()
                ),
                array('exception' => $e)
            );
        }
    }

    public function sanitizePath($path)
    {
        $path = str_replace(
            array('\\', \XoopsBaseConfig::get('root-path'), str_replace('\\', '/', realpath(\XoopsBaseConfig::get('root-path')))),
            array('/', '', ''),
            $path
        );
        return $path;
    }

    public function emergency($message, array $context = array())
    {
        if ($this->activated) {
            $this->log(LogLevel::EMERGENCY, $message, $context);
        }
    }

    public function alert($message, array $context = array())
    {
        if ($this->activated) {
            $this->log(LogLevel::ALERT, $message, $context);
        }
    }

    public function critical($message, array $context = array())
    {
        if ($this->activated) {
            $this->log(LogLevel::CRITICAL, $message, $context);
        }
    }

    public function error($message, array $context = array())
    {
        if ($this->activated) {
            $this->log(LogLevel::ERROR, $message, $context);
        }
    }

    public function warning($message, array $context = array())
    {
        if ($this->activated) {
            $this->log(LogLevel::WARNING, $message, $context);
        }
    }

    public function notice($message, array $context = array())
    {
        if ($this->activated) {
            $this->log(LogLevel::NOTICE, $message, $context);
        }
    }

    public function info($message, array $context = array())
    {
        if ($this->activated) {
            $this->log(LogLevel::INFO, $message, $context);
        }
    }

    public function debug($message, array $context = array())
    {
        if ($this->activated) {
            $this->log(LogLevel::DEBUG, $message, $context);
        }
    }

    private function messageTag($tag, $default)
    {
        return  defined($tag) ? constant($tag) : $default;
    }

    public function log($level, $message, array $context = array())
    {
        if (!$this->activated) {
            return;
        }

        $channel = 'messages';
        $msg = $message;

        if (isset($context['channel'])) {
            $chan = strtolower($context['channel']);
            switch ($chan) {
                case 'blocks':
                    if (!$this->configs['include_blocks']) {
                        return;
                    }
                    //$channel = 'Blocks';
                    $msg = _MD_MONOLOG_BLOCKS . ' : ' . $message . ': ';
                    if ($context['cached']) {
                        $msg .= sprintf(_MD_MONOLOG_CACHED, intval($context['cachetime']));
                    } else {
                        $msg .= _MD_MONOLOG_NOT_CACHED;
                    }
                    break;
                case 'deprecated':
                    if (!$this->configs['include_deprecated']) {
                        return;
                    }
                    //$channel = 'Deprecated';
                    $msg = $this->messageTag('_MD_MONOLOG_DEPRECATED', 'Deprecated*') . ' : ' . $message;
                    //$msg = _MD_MONOLOG_DEPRECATED . ' : ' . $message;
                    break;
                case 'extra':
                    if (!$this->configs['include_extra']) {
                        return;
                    }
                    //$channel = 'Extra';
                    $msg = _MD_MONOLOG_EXTRA . ' : ' . $context['name'] . ': ' . $message;
                    break;
                case 'queries':
                    if (!$this->configs['include_queries']) {
                        return;
                    }
                    //$channel = 'Queries';
                    $msg = $message;
                    $qt = empty($context['query_time']) ?
                        '' : sprintf('%0.6f - ', $context['query_time']);
                    if ($level == LogLevel::ERROR) {
                        //if (!is_scalar($context['errno']) ||  !is_scalar($context['errno'])) {
                        //    \Xmf\Debug::dump($context);
                        //}
                        $msg .= ' -- Error number: '
                            . (is_scalar($context['errno']) ?  $context['errno'] : '?')
                            . ' Error message: '
                            . (is_scalar($context['error']) ?  $context['error'] : '?');
                    }
                    $msg = $this->messageTag('_MD_MONOLOG_QUERIES', 'Queries*') . ' : ' . $qt . $msg;
                    break;
                case 'timers':
                    if (!$this->configs['include_timers']) {
                        return;
                    }
                    $msg = $this->messageTag('_MD_MONOLOG_TIMERS', 'Timers*') . ' : ' . $message;
                    break;
                default:
                    $msg = $this->messageTag('_MD_MONOLOG_ERRORS', 'Errors*') . ' : ' . $message;
                    break;
            }
        } else {
            $msg = $this->messageTag('_MD_MONOLOG_MESSAGES', 'Message*') . ' : ' . $message;
        }
        switch ($level) {
            case LogLevel::EMERGENCY:
                $this->monolog->emergency($msg, $context);
                break;
            case LogLevel::ALERT:
                $this->monolog->alert($msg, $context);
                break;
            case LogLevel::CRITICAL:
                $this->monolog->critical($msg, $context);
                break;
            case LogLevel::ERROR:
                $this->monolog->error($msg, $context);
                break;
            case LogLevel::WARNING:
                $this->monolog->warning($msg, $context);
                break;
            case LogLevel::NOTICE:
                $this->monolog->notice($msg, $context);
                break;
            case LogLevel::INFO:
                $this->monolog->info($msg, $context);
                break;
            case LogLevel::DEBUG:
            default:
                $this->monolog->debug($msg, $context);
                break;
        }
    }
}