logger.php

<?php
 
 
class XoopsLogger
{
    public $queries = [];
    public $blocks = [];
    public $extra = [];
    public $logstart = [];
    public $logend = [];

    public function __construct()
    {
    }

    public static function &instance()
    {
        static $instance;
        if (!isset($instance)) {
            $instance = new XoopsLogger();
        }
        return $instance;
    }

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

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

    public function addQuery($sql, $error=null, $errno=null)
    {
        if (defined('XOOPS_LOGGER_ADDQUERY_DISABLED') && XOOPS_LOGGER_ADDQUERY_DISABLED) {
            return;
        }
        $this->queries[] = ['sql' => $sql, 'error' => $error, 'errno' => $errno];
        if ($error && defined('XOOPS_MYSQL_ERROR_LOG') && XOOPS_MYSQL_ERROR_LOG) {
            error_log('XOOPS_MYSQL_ERROR_LOG: ' . print_r(end($this->queries), true));
        }
    }

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

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

    public function dumpQueries()
    {
        $ret = '<table class="outer" width="100%" cellspacing="1"><tr><th>Queries</th></tr>';
        $class = 'even';
        foreach ($this->queries as $q) {
            if (isset($q['error'])) {
                $ret .= '<tr class="'.$class.'"><td><span style="color:#ff0000;">'.htmlentities($q['sql']).'<br><b>Error number:</b> '.$q['errno'].'<br><b>Error message:</b> '.$q['error'].'</span></td></tr>';
            } else {
                $ret .= '<tr class="'.$class.'"><td>'.htmlentities($q['sql']).'</td></tr>';
            }
            $class = ('odd' == $class) ? 'even' : 'odd';
        }
        $ret .= '<tr><td>Total: <span style="color:#ff0000;">'.count($this->queries).'</span> queries</td></tr></table><br>';
        return $ret;
    }

    public function dumpBlocks()
    {
        $ret = '<table class="outer" width="100%" cellspacing="1"><tr><th colspan="2">Blocks</th></tr>';
        $class = 'even';
        foreach ($this->blocks as $b) {
            if ($b['cached']) {
                $ret .= '<tr><td class="'.$class.'"><b>'.htmlspecialchars($b['name']).':</b> Cached (regenerates every ' . (int)$b['cachetime'] . ' seconds)</td></tr>';
            } else {
                $ret .= '<tr><td class="'.$class.'"><b>'.htmlspecialchars($b['name']).':</b> No Cache</td></tr>';
            }
            $class = ('odd' == $class) ? 'even' : 'odd';
        }
        $ret .= '<tr><td>Total: <span style="color:#ff0000;">'.count($this->blocks).'</span> blocks</td></tr></table><br>';
        return $ret;
    }

    public function dumpTime($name = 'XOOPS')
    {
        if (!isset($this->logstart[$name])) {
            return 0;
        }
        if (!isset($this->logend[$name])) {
            $stop_time = explode(' ', microtime());
        } else {
            $stop_time = $this->logend[$name];
        }
        return ((float)$stop_time[1] + (float)$stop_time[0]) - ((float)$this->logstart[$name][1] + (float)$this->logstart[$name][0]);
    }

    public function dumpExtra()
    {
        $ret = '<table class="outer" width="100%" cellspacing="1"><tr><th colspan="2">Extra</th></tr>';
        $class = 'even';
        foreach ($this->extra as $ex) {
            $ret .= '<tr><td class="'.$class.'"><b>'.htmlspecialchars($ex['name']).':</b> '.htmlspecialchars($ex['msg']).'</td></tr>';
            $class = ('odd' == $class) ? 'even' : 'odd';
        }
        $ret .= '</table><br>';
        return $ret;
    }

    public function dumpAll()
    {
        $ret = $this->dumpQueries();
        $ret .= $this->dumpBlocks();
        if (count($this->logstart) > 0) {
            $ret .= '<table class="outer" width="100%" cellspacing="1"><tr><th>Execution Time</th></tr>';
            $class = 'even';
            foreach ($this->logstart as $k => $v) {
                $ret .= '<tr><td class="'.$class.'"><b>'.htmlspecialchars($k).'</b> took <span style="color:#ff0000;">'.$this->dumpTime($k).'</span> seconds to load.</td></tr>';
                $class = ('odd' == $class) ? 'even' : 'odd';
            }
            $ret .= '</table><br>';
        }
        $ret .= $this->dumpExtra();
        return $ret;
    }
}