// // ------------------------------------------------------------------------ // // This program is free software; you can redistribute it and/or modify // // it under the terms of the GNU General Public License as published by // // the Free Software Foundation; either version 2 of the License, or // // (at your option) any later version. // // // // 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. See the // // GNU General Public License for more details. // // // // You should have received a copy of the GNU General Public License // // along with this program; if not, write to the Free Software // // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA // // ------------------------------------------------------------------------ // // Author: Kazumi Ono (AKA onokazu) // // URL: http://www.myweb.ne.jp/, http://www.xoops.org/, http://jp.xoops.org/ // // Project: The XOOPS Project // // ------------------------------------------------------------------------- // /** * Collects information for a page request * * Singelton: There can be only one instance of this class and it must * be accessed through the {@link instance()} method! * * records information about database queries, blocks, and execution time * and can display it as HTML * * @author Kazumi Ono * @copyright copyright (c) 2000-2003 XOOPS.org * * @package kernel */ class XoopsLogger { /**#@+ * @var array */ var $queries = array(); var $blocks = array(); var $extra = array(); var $logstart = array(); var $logend = array(); /**#@-*/ /** * constructor * * @access private */ function XoopsLogger() { } /** * get a reference to the only instance of this class * * @return object XoopsLogger reference to the only instance */ function &instance() { static $instance; if (!isset($instance)) { $instance = new XoopsLogger(); } return $instance; } /** * start a timer * * @param string $name name of the timer * */ function startTime($name = 'XOOPS') { $this->logstart[$name] = explode(' ', microtime()); } /** * stop a timer * * @param string $name name of the timer */ function stopTime($name = 'XOOPS') { $this->logend[$name] = explode(' ', microtime()); } /** * log a database query * * @param string $sql SQL string * @param string $error error message (if any) * @param int $errno error number (if any) */ function addQuery($sql, $error=null, $errno=null) { $this->queries[] = array('sql' => $sql, 'error' => $error, 'errno' => $errno); } /** * log display of a block * * @param string $name name of the block * @param bool $cached was the block cached? * @param int $cachetime cachetime of the block */ function addBlock($name, $cached = false, $cachetime = 0) { $this->blocks[] = array('name' => $name, 'cached' => $cached, 'cachetime' => $cachetime); } /** * log extra information * * @param string $name name for the entry * @param int $msg text message for the entry */ function addExtra($name, $msg) { $this->extra[] = array('name' => $name, 'msg' => $msg); } /** * get the logged queries in a HTML table * * @return string HTML table with queries */ function dumpQueries() { $ret = ''; $class = 'even'; foreach ($this->queries as $q) { if (isset($q['error'])) { $ret .= ''; } else { $ret .= ''; } $class = ($class == 'odd') ? 'even' : 'odd'; } $ret .= '

Queries
'.htmlentities($q['sql']).' Error number: '.$q['errno'].' Error message: '.$q['error'].'
'.htmlentities($q['sql']).'
Total: '.count($this->queries).' queries

'; return $ret; } /** * get the logged blocks in a HTML table * * @return string HTML table with blocks */ function dumpBlocks() { $ret = ''; $class = 'even'; foreach ($this->blocks as $b) { if ($b['cached']) { $ret .= ''; } else { $ret .= ''; } $class = ($class == 'odd') ? 'even' : 'odd'; } $ret .= '

Blocks
'.htmlspecialchars($b['name']).': Cached (regenerates every '.intval($b['cachetime']).' seconds)
'.htmlspecialchars($b['name']).': No Cache
Total: '.count($this->blocks).' blocks

'; return $ret; } /** * get the current execution time of a timer * * @param string $name name of the counter * @return float current execution time of the counter */ 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]); } /** * get extra information in a HTML table * * @return string HTML table with extra information */ function dumpExtra() { $ret = ''; $class = 'even'; foreach ($this->extra as $ex) { $ret .= ''; $class = ($class == 'odd') ? 'even' : 'odd'; } $ret .= '

Extra
'.htmlspecialchars($ex['name']).': '.htmlspecialchars($ex['msg']).'

'; return $ret; } /** * get all logged information formatted in HTML tables * * @return string HTML output */ function dumpAll() { $ret = $this->dumpQueries(); $ret .= $this->dumpBlocks(); if (count($this->logstart) > 0) { $ret .= ''; $class = 'even'; foreach ($this->logstart as $k => $v) { $ret .= ''; $class = ($class == 'odd') ? 'even' : 'odd'; } $ret .= '

Execution Time
'.htmlspecialchars($k).' took '.$this->dumpTime($k).' seconds to load.

'; } $ret .= $this->dumpExtra(); return $ret; } } ?>