legacylogger.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 Psr\Log\LoggerInterface;
use Psr\Log\LogLevel;
use Xoops\Core\Logger;

class LegacyLogger implements LoggerInterface
{
    protected $queries = array();

    protected $blocks = array();

    protected $extra = array();

    protected $logstart = array();

    protected $logend = array();

    protected $errors = array();

    protected $deprecated = array();

    protected $renderingEnabled = false;

    protected $activated = false;

    protected $configs = false;

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

    protected $usePopup = false;


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

        return $instance;
    }

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

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

    public function enable()
    {
        error_reporting(E_ALL | E_STRICT);
        $xoops = Xoops::getInstance();
        if ($this->configs && array_key_exists('logger_enable', $this->configs)) {
            if ($this->configs['logger_popup']) {
                $this->usePopup = true;
            }
        }
        $this->activated = true;
        $this->enableRendering();
    }

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

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

    private function addToTheme()
    {
        static $addedResource = false;

        if ($this->activated && !$addedResource) {
            if (isset($GLOBALS['xoTheme'])) {
                /*
                $xoops = Xoops::getInstance();
                $head = '</style>' . $this->renderer->renderHead()
                    . '<style>.icon-tags:before { content: ""; width: 16px; background-position: -25px -48px;}';
                $xoops->theme()->addStylesheet(null, null, $head);
                */
                $addedResource = true;
            }
        }
    }

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

    public function stopTime($name = 'XOOPS')
    {
        if ($this->activated) {
            $this->logend[$name] = microtime(true);
        }
    }

    public function addQuery($sql, $error = null, $errno = null, $query_time = null)
    {
        if ($this->activated) {
            $this->queries[] = array(
                'sql' => $sql, 'error' => $error, 'errno' => $errno, 'query_time' => $query_time
            );
        }
    }

    public function addBlock($name, $cached = false, $cachetime = 0)
    {
        if ($this->activated) {
            $this->blocks[] = array('name' => $name, 'cached' => $cached, 'cachetime' => $cachetime);
        }
    }

    public function addExtra($name, $msg)
    {
        if ($this->activated) {
            $this->extra[] = array('name' => $name, 'msg' => $msg);
        }
    }

    public function addDeprecated($msg)
    {
        if ($this->activated) {
            $this->deprecated[] = $msg;
        }
    }

    public function addException($e)
    {
        if ($this->activated) {
            $this->log(
                LogLevel::ERROR,
                'Exception: ' . $e->getMessage() . ' - ' .
                $this->sanitizePath($e->getFile()) . ' ' . $e->getLine()
            );
        }
    }

    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 enableRendering()
    {
        if (!$this->renderingEnabled) {
            ob_start(array(&$this, 'render'));
            $this->renderingEnabled = true;
        }
    }

    public function render($output)
    {
        if (!$this->activated) {
            return $output;
        }

        $log = $this->dump($this->usePopup ? 'popup' : '');
        $this->renderingEnabled = $this->activated = false;

        $pattern = '<!--{xo-logger-output}-->';
        $pos = strpos($output, $pattern);
        if ($pos !== false) {
            return substr($output, 0, $pos) . $log . substr($output, $pos + strlen($pattern));
        } else {
            return $output . $log;
        }
    }

    public function dump($mode = '')
    {
        $ret = '';
// -------------------------------------------------------------
        $xoops = Xoops::getInstance();
        /* @var $this LoggerLegacy */
        $ret = '';
        if ($mode == 'popup') {
            $dump = $this->dump('');
            $content = '
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<head>
    <meta http-equiv="content-language" content="' . XoopsLocale::getLangCode() . '" />
    <meta http-equiv="content-type" content="text/html; charset=' . XoopsLocale::getCharset() . '" />
    <title>' . $xoops->getConfig('sitename') . ' - ' . _MD_LOGGER_DEBUG . ' </title>
    <meta name="generator" content="XOOPS" />
    <link rel="stylesheet" type="text/css" media="all" href="' . $xoops->getCss($xoops->getConfig('theme_set')) . '" />
</head>
<body>' . $dump . '
    <div style="text-align:center;">
        <input class="formButton" value="' . XoopsLocale::A_CLOSE . '" type="button" onclick="javascript:window.close();" />
    </div>
';
            $ret .= '
<script type="text/javascript">
    debug_window = openWithSelfMain("about:blank", "popup", 680, 450, true);
    debug_window.document.clear();
';
            $lines = preg_split("/(\r\n|\r|\n)( *)/", $content);
            foreach ($lines as $line) {
                $ret .= "\n" . 'debug_window.document.writeln("'
                    . str_replace(array('"', '</'), array('\"', '<\/'), $line) . '");';
            }
            $ret .= '
    debug_window.focus();
    debug_window.document.close();
</script>
';
        }

        $this->addExtra(
            _MD_LOGGER_INCLUDED_FILES,
            sprintf(_MD_LOGGER_FILES, count(get_included_files()))
        );

        /*
        $included_files = get_included_files();
        foreach ($included_files as $filename) {
            $this->addExtra('files',$filename);
        }
        
        if (function_exists('memory_get_peak_usage')) {
            $this->addExtra('Peak memory',memory_get_peak_usage());
        }
        */

        $memory = 0;
        
        if (function_exists('memory_get_usage')) {
            $memory = memory_get_usage() . ' bytes';
        } else {
            if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
                $out = array();
                exec('tasklist /FI "PID eq ' . getmypid() . '" /FO LIST', $out);
                if (isset($out[5])) {
                    $memory = sprintf(_MD_LOGGER_MEM_ESTIMATED, substr($out[5], strpos($out[5], ':') + 1));
                }
            }
        }
        if ($memory) {
            $this->addExtra(_MD_LOGGER_MEM_USAGE, $memory);
        }

        if (empty($mode)) {
            $views = array('errors', 'deprecated', 'queries', 'blocks', 'extra');
            $ret .= "\n<div id=\"xo-logger-output\">\n<div id='xo-logger-tabs'>\n";
            $ret .= "<a href='javascript:xoSetLoggerView(\"none\")'>" . _MD_LOGGER_NONE . "</a>\n";
            $ret .= "<a href='javascript:xoSetLoggerView(\"\")'>" . _MD_LOGGER_ALL . "</a>\n";
            foreach ($views as $view) {
                $count = count($this->$view);
                $ret .= "<a href='javascript:xoSetLoggerView(\"$view\")'>" . constant('_MD_LOGGER_' . strtoupper($view)) . " ($count)</a>\n";
            }
            $count = count($this->logstart);
            $ret .= "<a href='javascript:xoSetLoggerView(\"timers\")'>" . _MD_LOGGER_TIMERS . "($count)</a>\n";
            $ret .= "</div>\n";
        }
        
        if (empty($mode) || $mode == 'errors') {
            $class = 'even';
            $ret .= '<table id="xo-logger-errors" class="outer"><thead><tr><th>' . _MD_LOGGER_ERRORS . '</th></tr></thead><tbody>';
            foreach ($this->errors as $error) {
                $ret .= "\n<tr><td class='$class'>";
                $ret .= $error;
                $ret .= "<br />\n</td></tr>";
                $class = ($class == 'odd') ? 'even' : 'odd';
            }
            $ret .= "\n</tbody></table>\n";
        }

        if (empty($mode) || $mode == 'deprecated') {
            $class = 'even';
            $ret .= '<table id="xo-logger-deprecated" class="outer"><thead><tr><th>' . _MD_LOGGER_DEPRECATED . '</th></tr></thead><tbody>';
            foreach ($this->deprecated as $message) {
                $ret .= "\n<tr><td class='$class'>";
                $ret .= $message;
                $ret .= "<br />\n</td></tr>";
                $class = ($class == 'odd') ? 'even' : 'odd';
            }
            $ret .= "\n</tbody></table>\n";
        }

        if (empty($mode) || $mode == 'queries') {
            $class = 'even';
            $ret .= '<table id="xo-logger-queries" class="outer"><thead><tr><th>' . _MD_LOGGER_QUERIES . '</th></tr></thead><tbody>';
            $pattern = '/\b' . preg_quote(\XoopsBaseConfig::get('db-prefix')) . '\_/i';
        
            foreach ($this->queries as $q) {
                $sql = preg_replace($pattern, '', $q['sql']);
                $query_time = isset($q['query_time']) ? sprintf('%0.6f - ', $q['query_time']) : '';
        
                if (isset($q['error'])) {
                    $ret .= '<tr class="' . $class . '"><td><span style="color:#ff0000;">' . $query_time . htmlentities($sql) . '<br /><strong>Error number:</strong> ' . $q['errno'] . '<br /><strong>Error message:</strong> ' . $q['error'] . '</span></td></tr>';
                } else {
                    $ret .= '<tr class="' . $class . '"><td>' . $query_time . htmlentities($sql) . '</td></tr>';
                }
        
                $class = ($class == 'odd') ? 'even' : 'odd';
            }
            $ret .= '</tbody><tfoot><tr class="foot"><td>' . _MD_LOGGER_TOTAL . ': <span style="color:#ff0000;">' . count($this->queries) . '</span></td></tr></tfoot></table>';
        }
        if (empty($mode) || $mode == 'blocks') {
            $class = 'even';
            $ret .= '<table id="xo-logger-blocks" class="outer"><thead><tr><th>' . _MD_LOGGER_BLOCKS . '</th></tr></thead><tbody>';
            foreach ($this->blocks as $b) {
                if ($b['cached']) {
                    $ret .= '<tr><td class="' . $class . '"><strong>' . $b['name'] . ':</strong> ' . sprintf(_MD_LOGGER_CACHED, intval($b['cachetime'])) . '</td></tr>';
                } else {
                    $ret .= '<tr><td class="' . $class . '"><strong>' . $b['name'] . ':</strong> ' . _MD_LOGGER_NOT_CACHED . '</td></tr>';
                }
                $class = ($class == 'odd') ? 'even' : 'odd';
            }
            $ret .= '</tbody><tfoot><tr class="foot"><td>' . _MD_LOGGER_TOTAL . ': <span style="color:#ff0000;">' . count($this->blocks) . '</span></td></tr></tfoot></table>';
        }
        if (empty($mode) || $mode == 'extra') {
            $class = 'even';
            $ret .= '<table id="xo-logger-extra" class="outer"><thead><tr><th>' . _MD_LOGGER_EXTRA . '</th></tr></thead><tbody>';
            foreach ($this->extra as $ex) {
                $ret .= '<tr><td class="' . $class . '"><strong>';
                $ret .= htmlspecialchars($ex['name']) . ':</strong> ' . htmlspecialchars($ex['msg']);
                $ret .= '</td></tr>';
                $class = ($class == 'odd') ? 'even' : 'odd';
            }
            $ret .= '</tbody></table>';
        }
        if (empty($mode) || $mode == 'timers') {
            $class = 'even';
            $ret .= '<table id="xo-logger-timers" class="outer"><thead><tr><th>' . _MD_LOGGER_TIMERS . '</th></tr></thead><tbody>';
            foreach ($this->logstart as $k => $v) {
                $ret .= '<tr><td class="' . $class . '"><strong>';
                $ret .= sprintf(_MD_LOGGER_TIMETOLOAD, htmlspecialchars($k) . '</strong>', '<span style="color:#ff0000;">' . sprintf("%.03f", $this->dumpTime($k)) . '</span>');
                $ret .= '</td></tr>';
                $class = ($class == 'odd') ? 'even' : 'odd';
            }
            $ret .= '</tbody></table>';
        }
        
        if (empty($mode)) {
            $ret .= <<<EOT
</div>
<script type="text/javascript">
    function xoLogCreateCookie(name,value,days) {
        if (days) {
            var date = new Date();
            date.setTime(date.getTime()+(days*24*60*60*1000));
            var expires = "; expires="+date.toGMTString();
        }
        else var expires = "";
        document.cookie = name+"="+value+expires+"; path=/";
    }
    function xoLogReadCookie(name) {
        var nameEQ = name + "=";
        var ca = document.cookie.split(';');
        for(var i=0;i < ca.length;i++) {
            var c = ca[i];
            while (c.charAt(0)==' ') c = c.substring(1,c.length);
            if (c.indexOf(nameEQ) == 0) return c.substring(nameEQ.length,c.length);
        }
        return null;
    }
    function xoLogEraseCookie(name) {
        createCookie(name,"",-1);
    }
    function xoSetLoggerView( name ) {
        var log = document.getElementById( "xo-logger-output" );
        if ( !log ) return;
        var i, elt;
        for ( i=0; i!=log.childNodes.length; i++ ) {
            elt = log.childNodes[i];
            if ( elt.tagName && elt.tagName.toLowerCase() != 'script' && elt.id != "xo-logger-tabs" ) {
                elt.style.display = ( !name || elt.id == "xo-logger-" + name ) ? "block" : "none";
            }
        }
        xoLogCreateCookie( 'XOLOGGERVIEW', name, 1 );
    }
    xoSetLoggerView( xoLogReadCookie( 'XOLOGGERVIEW' ) );
</script>

EOT;
        }
// -------------------------------------------------------------
        return $ret;
    }

    public function dumpTime($name = 'XOOPS', $unset = false)
    {
        if (!$this->activated) {
            return null;
        }

        if (!isset($this->logstart[$name])) {
            return 0;
        }
        $stop = isset($this->logend[$name]) ? $this->logend[$name] : microtime(true);
        $start = $this->logstart[$name];

        if ($unset) {
            unset($this->logstart[$name]);
            unset($this->logend[$name]);
        }

        return $stop - $start;
    }


    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);
        }
    }

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

        $this->errors[] = $message;
    }
}