debugconsole-1.3.0/0000755000175000001440000000000010535007222013511 5ustar ademmerusersdebugconsole-1.3.0/debugConsole.config.php0000644000175000001440000000760010535007222020102 0ustar ademmerusers * @see * @version 1.2.1 * @package debugConsole_1.3.0 */ /** * config container for debugConsole * * @var array */ $_debugConsoleConfig = array(); /** * use debugConsole */ $_debugConsoleConfig['active'] = TRUE; /** * restrict access */ $_debugConsoleConfig['restrictions'] = array ( 'restrictAccess' => FALSE, 'allowedClientAdresses' => array('127.0.0.1') ); /** * set timezone, used for PHP >= 5.1.x */ putenv ('TZ=Europe/Berlin'); /** * focus debugConsole at end of debug-run */ $_debugConsoleConfig['focus'] = TRUE; /** * logfile configuration */ $_debugConsoleConfig['logfile'] = array ( 'enable' => FALSE, 'path' => './', 'filename' => 'log.txt', 'disablePopup' => FALSE ); /** * show or hide certain events */ $_debugConsoleConfig['filters'] = array ( 'debug' => TRUE, 'watches' => TRUE, 'checkpoints' => TRUE, 'timers' => TRUE, 'php_notices' => TRUE, 'php_warnings' => TRUE, 'php_errors' => TRUE, 'php_suggestions' => TRUE ); /** * popup dimensions in px */ $_debugConsoleConfig['dimensions'] = array ( 'width' => 300, 'height' => 525 ); /** * javascript snippets, do not touch! */ $_debugConsoleConfig['javascripts'] = array ( 'openTag' => '', 'openPopup' => 'debugConsole = window.open', 'closePopup' => 'debugConsole.close()', 'write' => 'debugConsole.document.write', 'scroll' => 'debugConsole.scrollBy', 'focus' => 'debugConsole.focus()' ); /** * html snippets, do not touch! */ $_debugConsoleConfig['html'] = array ( 'header' => ' debugConsole ', 'footer' => '' ); ?>debugconsole-1.3.0/debugConsole.functions.php0000644000175000001440000000463410535007222020651 0ustar ademmerusers * @see * @version 1.0.0 * @package debugConsole_1.3.0 */ /** * show debug info of a variable in debugConsole, * add own text for documentation or hints * * @param mixed $variable * @param string $text */ function dc_dump ($variable, $text) { $debugConsole = debugConsoleLoader(); if (is_object($debugConsole)) { $debugConsole->dump($variable, $text); } } /** * watch value changes of a variable in debugConsole * * @param string $variableName */ function dc_watch ($variableName) { $debugConsole = debugConsoleLoader(); if (is_object($debugConsole)) { $debugConsole->watchVariable($variableName); } } /** * show checkpoint info in debugConsole to make sure * that a certain program line has been passed * * @param string $message */ function dc_here ($message = NULL) { $debugConsole = debugConsoleLoader(); if (is_object($debugConsole)) { (bool)$message ? $debugConsole->passedCheckpoint($message) : $debugConsole->passedCheckpoint(); } } /** * starts a new timer clock and returns its handle * * @return mixed * @param string $comment */ function dc_start_timer ($comment) { $debugConsole = debugConsoleLoader(); if (is_object($debugConsole)) { return $debugConsole->startTimer($comment); } } /** * stops and shows a certain timer clock in debugConsole * * @return bool * @param string $timerHandle */ function dc_stop_timer ($timerHandle) { $debugConsole = debugConsoleLoader(); if (is_object($debugConsole)) { return $debugConsole->stopTimer($timerHandle); } } /** * singleton loader for debugConsole * DO NOT USE, private to debugConsole functions * * @return mixed */ function debugConsoleLoader () { static $debugConsole; static $access = 'unset'; $config = $GLOBALS['_debugConsoleConfig']; /* obey access restrictions */ if (gettype($access) != 'bool') { if ($config['active']) { if ($config['restrictions']['restrictAccess']) { if (in_array($_SERVER['REMOTE_ADDR'], $config['restrictions']['allowedClientAdresses'])) { $access = TRUE; } else { $access = FALSE; } } else { $access = TRUE; } } else { $access = FALSE; } } /* access granted */ if ($access) { if (!is_object($debugConsole)) { $debugConsole = new debugConsole(); } } else { $debugConsole = FALSE; } return $debugConsole; } ?>debugconsole-1.3.0/debugConsole.php0000644000175000001440000000075110535007222016636 0ustar ademmerusers * @see * @version 1.1.0 * @package debugConsole_1.3.0 */ /* PHP5 required */ if (version_compare(PHP_VERSION, '5.0.0') < 0) { die('The debugConsole requires PHP 5.x.x or greater.'); } $path = dirname(__FILE__) . '/'; require_once $path . 'debugConsole.config.php'; require_once $path . 'debugConsole.class.php'; require_once $path . 'debugConsole.functions.php'; ?>debugconsole-1.3.0/examples/0000755000175000001440000000000010535007222015327 5ustar ademmerusersdebugconsole-1.3.0/examples/.svn/0000755000175000001440000000000010535007222016213 5ustar ademmerusersdebugconsole-1.3.0/examples/.svn/tmp/0000755000175000001440000000000010535007222017013 5ustar ademmerusersdebugconsole-1.3.0/examples/.svn/tmp/props/0000755000175000001440000000000010535007222020156 5ustar ademmerusersdebugconsole-1.3.0/examples/.svn/tmp/text-base/0000755000175000001440000000000010535007222020707 5ustar ademmerusersdebugconsole-1.3.0/examples/.svn/tmp/prop-base/0000755000175000001440000000000010535007222020703 5ustar ademmerusersdebugconsole-1.3.0/examples/.svn/tmp/wcprops/0000755000175000001440000000000010535007222020510 5ustar ademmerusersdebugconsole-1.3.0/examples/.svn/props/0000755000175000001440000000000010535007222017356 5ustar ademmerusersdebugconsole-1.3.0/examples/.svn/empty-file0000644000175000001440000000000010535007222020177 0ustar ademmerusersdebugconsole-1.3.0/examples/.svn/entries0000444000175000001440000000277710535007222017622 0ustar ademmerusers debugconsole-1.3.0/examples/.svn/format0000644000175000001440000000000210535007222017416 0ustar ademmerusers4 debugconsole-1.3.0/examples/.svn/text-base/0000755000175000001440000000000010535007222020107 5ustar ademmerusersdebugconsole-1.3.0/examples/.svn/text-base/example4.php.svn-base0000644000175000001440000000107210535007222024054 0ustar ademmerusers * @see * @version 1.0.0 * @package debugConsole_1.3.0 */ echo '

debugConsole Demonstration

'; /* load debugConsole functionality */ require_once '../debugConsole.php'; /* test timer clocks */ $timer1 = dc_start_timer('first timer:'); $timer2 = dc_start_timer('second timer:'); sleep(1); dc_stop_timer($timer1); sleep(1); dc_stop_timer($timer2); echo '

Testdrive completed!

'; ?>debugconsole-1.3.0/examples/.svn/text-base/example3.php.svn-base0000644000175000001440000000115610535007222024056 0ustar ademmerusers * @see * @version 1.0.0 * @package debugConsole_1.3.0 */ echo '

debugConsole Demonstration

'; /* load debugConsole functionality */ require_once '../debugConsole.php'; /* debugConsole must be open to take over errorhandling */ dc_here('Now we catch some PHP error-events:'); /* test errorhandling notics */ echo $notSet; /* test errorhandling warnings */ fopen('not existing!', 'r'); echo '

Testdrive completed!

'; ?>debugconsole-1.3.0/examples/.svn/text-base/example2.php.svn-base0000644000175000001440000000105610535007222024054 0ustar ademmerusers * @see * @version 1.0.0 * @package debugConsole_1.3.0 */ echo '

debugConsole Demonstration

'; /* load debugConsole functionality */ require_once '../debugConsole.php'; /* test checkpoints */ dc_here('Now we check the daytime...'); if (date('H') >= 12) { dc_here('It is after noon!'); } else { dc_here('It is before noon!'); } echo '

Testdrive completed!

'; ?>debugconsole-1.3.0/examples/.svn/text-base/example5.php.svn-base0000644000175000001440000000110010535007222024045 0ustar ademmerusers * @see * @version 1.0.0 * @package debugConsole_1.3.0 */ echo '

debugConsole Demonstration

'; /* load debugConsole functionality */ require_once '../debugConsole.php'; /* test watches */ dc_watch('foo'); dc_watch('bar'); declare (ticks = 1) { $foo = '1'; $foo++; $bar = $foo; $bar += 3; $foo --; } echo '

Testdrive completed!

'; ?>debugconsole-1.3.0/examples/.svn/text-base/example1.php.svn-base0000644000175000001440000000132310535007222024050 0ustar ademmerusers * @see * @version 1.0.0 * @package debugConsole_1.3.0 */ echo '

debugConsole Demonstration

'; /* load debugConsole functionality */ require_once '../debugConsole.php'; /* test variable debugging */ $foo = 'Hello World!'; dc_dump($foo, '$foo wants to say something:'); /* test variable debugging again */ $bar = 42.0; dc_dump($bar, '$bar tells us the meaning of life:'); /* test array debugging */ $foobar = array ( 'foo' => $foo, 'bar' => $bar ); dc_dump($foobar, '$foobar is a neat array!'); echo '

Testdrive completed!

'; ?>debugconsole-1.3.0/examples/.svn/README.txt0000644000175000001440000000016610535007222017714 0ustar ademmerusersThis is a Subversion working copy administrative directory. Visit http://subversion.tigris.org/ for more information. debugconsole-1.3.0/examples/.svn/prop-base/0000755000175000001440000000000010535007222020103 5ustar ademmerusersdebugconsole-1.3.0/examples/.svn/wcprops/0000755000175000001440000000000010535007222017710 5ustar ademmerusersdebugconsole-1.3.0/examples/.svn/wcprops/example4.php.svn-work0000444000175000001440000000016610535007222023726 0ustar ademmerusersK 25 svn:wc:ra_dav:version-url V 77 /svn/repositories/!svn/ver/74/public/debugconsole/trunk/examples/example4.php END debugconsole-1.3.0/examples/.svn/wcprops/example3.php.svn-work0000444000175000001440000000016610535007222023725 0ustar ademmerusersK 25 svn:wc:ra_dav:version-url V 77 /svn/repositories/!svn/ver/74/public/debugconsole/trunk/examples/example3.php END debugconsole-1.3.0/examples/.svn/wcprops/example2.php.svn-work0000444000175000001440000000016610535007222023724 0ustar ademmerusersK 25 svn:wc:ra_dav:version-url V 77 /svn/repositories/!svn/ver/74/public/debugconsole/trunk/examples/example2.php END debugconsole-1.3.0/examples/.svn/wcprops/example5.php.svn-work0000444000175000001440000000016610535007222023727 0ustar ademmerusersK 25 svn:wc:ra_dav:version-url V 77 /svn/repositories/!svn/ver/74/public/debugconsole/trunk/examples/example5.php END debugconsole-1.3.0/examples/.svn/wcprops/example1.php.svn-work0000444000175000001440000000016610535007222023723 0ustar ademmerusersK 25 svn:wc:ra_dav:version-url V 77 /svn/repositories/!svn/ver/74/public/debugconsole/trunk/examples/example1.php END debugconsole-1.3.0/examples/.svn/dir-wcprops0000444000175000001440000000015110535007222020402 0ustar ademmerusersK 25 svn:wc:ra_dav:version-url V 64 /svn/repositories/!svn/ver/74/public/debugconsole/trunk/examples END debugconsole-1.3.0/examples/example1.php0000644000175000001440000000132310535007222017553 0ustar ademmerusers * @see * @version 1.0.0 * @package debugConsole_1.3.0 */ echo '

debugConsole Demonstration

'; /* load debugConsole functionality */ require_once '../debugConsole.php'; /* test variable debugging */ $foo = 'Hello World!'; dc_dump($foo, '$foo wants to say something:'); /* test variable debugging again */ $bar = 42.0; dc_dump($bar, '$bar tells us the meaning of life:'); /* test array debugging */ $foobar = array ( 'foo' => $foo, 'bar' => $bar ); dc_dump($foobar, '$foobar is a neat array!'); echo '

Testdrive completed!

'; ?>debugconsole-1.3.0/examples/example2.php0000644000175000001440000000105610535007222017557 0ustar ademmerusers * @see * @version 1.0.0 * @package debugConsole_1.3.0 */ echo '

debugConsole Demonstration

'; /* load debugConsole functionality */ require_once '../debugConsole.php'; /* test checkpoints */ dc_here('Now we check the daytime...'); if (date('H') >= 12) { dc_here('It is after noon!'); } else { dc_here('It is before noon!'); } echo '

Testdrive completed!

'; ?>debugconsole-1.3.0/examples/example3.php0000644000175000001440000000115610535007222017561 0ustar ademmerusers * @see * @version 1.0.0 * @package debugConsole_1.3.0 */ echo '

debugConsole Demonstration

'; /* load debugConsole functionality */ require_once '../debugConsole.php'; /* debugConsole must be open to take over errorhandling */ dc_here('Now we catch some PHP error-events:'); /* test errorhandling notics */ echo $notSet; /* test errorhandling warnings */ fopen('not existing!', 'r'); echo '

Testdrive completed!

'; ?>debugconsole-1.3.0/examples/example4.php0000644000175000001440000000107210535007222017557 0ustar ademmerusers * @see * @version 1.0.0 * @package debugConsole_1.3.0 */ echo '

debugConsole Demonstration

'; /* load debugConsole functionality */ require_once '../debugConsole.php'; /* test timer clocks */ $timer1 = dc_start_timer('first timer:'); $timer2 = dc_start_timer('second timer:'); sleep(1); dc_stop_timer($timer1); sleep(1); dc_stop_timer($timer2); echo '

Testdrive completed!

'; ?>debugconsole-1.3.0/examples/example5.php0000644000175000001440000000110010535007222017550 0ustar ademmerusers * @see * @version 1.0.0 * @package debugConsole_1.3.0 */ echo '

debugConsole Demonstration

'; /* load debugConsole functionality */ require_once '../debugConsole.php'; /* test watches */ dc_watch('foo'); dc_watch('bar'); declare (ticks = 1) { $foo = '1'; $foo++; $bar = $foo; $bar += 3; $foo --; } echo '

Testdrive completed!

'; ?>debugconsole-1.3.0/debugConsole.class.php0000644000175000001440000002731610535007222017750 0ustar ademmerusers * @see * @version 1.2.1 * @package debugConsole_1.3.0 */ class debugConsole { /** * events which are shown in debug console * * @var array */ protected $filters; /** * all watched variables with their current content * * @var array */ protected $watches; /** * debugConsole configuration values * * @var array */ protected $config; /** * URL where template can be found * * @var string */ protected $template; /** * javascripts to control popup * * @var array */ protected $javascripts; /** * html for popup * * @var array */ protected $html; /** * time of debugrun start in milliseconds * * @var string */ protected $starttime; /** * time of timer start in milliseconds * * @var array */ protected $timers; /** * constructor, opens popup window */ public function __construct () { /* initialize class vars */ $this->starttime = $this->getMicrotime(); $this->watches = array (); $this->config = $GLOBALS['_debugConsoleConfig']; $this->html = $this->config['html']; $this->html['header'] = str_replace("\n\r", NULL, $this->html['header']); $this->html['header'] = str_replace("\n", NULL, $this->html['header']); $this->javascripts = $this->config['javascripts']; /* replace PHP's errorhandler */ $errorhandler = array ( $this, 'errorHandlerCallback' ); set_error_handler($errorhandler); /* open popup */ $popupOptions = "', 'debugConsole', 'width=" . $this->config['dimensions']['width'] . ",height=" . $this->config['dimensions']['height'] . ',scrollbars=yes'; $this->sendCommand('openPopup', $popupOptions); $this->sendCommand('write', $this->html['header']); $this->startDebugRun(); } /** * destructor, shows runtime and finishes html document in popup window */ public function __destruct () { $runtime = $this->getMicrotime() - $this->starttime; $runtime = number_format((float)$runtime, 4, '.', NULL); $info = '

This debug-run took ' . $runtime . ' seconds to complete.

'; $this->sendCommand('write', $info); $this->sendCommand('write', ''); $this->sendCommand('scroll', "0','100000"); $this->sendCommand('write', $this->html['footer']); if ($this->config['focus']) { $this->sendCommand('focus'); } } /** * show new debug run header in console */ protected function startDebugRun () { $info = '

new debug-run (' . date('H:i') . ' hours)

'; $this->sendCommand('write', '
'); $this->sendCommand('write', $info); } /** * adds a variable to the watchlist * * Watched variables must be in a declare(ticks=n) * block so that every n ticks the watched variables * are checked for changes. If any changes were made, * the new value of the variable is shown in the * debugConsole with additional information where the * changes happened. * * @param string $variableName */ public function watchVariable ($variableName) { if (count($this->watches) === 0) { $watchMethod = array ( $this, 'watchesCallback' ); register_tick_function($watchMethod); } if (isset($GLOBALS[$variableName])) { $this->watches[$variableName] = $GLOBALS[$variableName]; } else { $this->watches[$variableName] = NULL; } } /** * tick callback: process watches and show changes */ public function watchesCallback () { if ($this->config['filters']['watches']) { foreach ($this->watches as $variableName => $variableValue) { if (isset($GLOBALS[$variableName]) && ($GLOBALS[$variableName] !== $this->watches[$variableName])) { $info = '

$' . $variableName; $info .= ' changed from "'; $info .= $this->watches[$variableName]; $info .= '" (' . gettype($this->watches[$variableName]) . ')'; $info .= ' to "' . $GLOBALS[$variableName] . '" ('; $info .= gettype($GLOBALS[$variableName]) . ')'; $info .= $this->getTraceback() . '

'; $this->watches[$variableName] = $GLOBALS[$variableName]; $this->sendCommand('write', $info); } } } } /** * sends a javascript command to browser * * @param string $command * @param string $value */ protected function sendCommand ($command, $value = FALSE) { $value = str_replace('\\', '\\\\', $value); $value = nl2br($value); if ((bool)$value) { /* write optionally logfile */ $this->writeLogfileEntry($command, $value); $command = $this->javascripts[$command] . "('" . $value . "');"; } else { $command = $this->javascripts[$command] . ';'; } $command = str_replace("\n\r", NULL, $command); $command = str_replace("\n", NULL, $command); if (!$this->config['logfile']['disablePopup']) { echo $this->javascripts['openTag'], "\n"; echo $command, "\n"; echo $this->javascripts['closeTag'], "\n"; } flush(); } /** * writes html output as text entry into logfile * * @param string $command * @param string $value */ protected function writeLogfileEntry ($command, $value) { if ($this->config['logfile']['enable']) { $logfile = $this->config['logfile']['path'] . $this->config['logfile']['filename']; /* log only useful entries, no html header and footer */ if ( $command === 'write' && !strpos($value, '') && !strpos($value, '') ) { /* convert html to text */ $value = html_entity_decode($value); $value = str_replace('>', '> ', $value); $value = strip_tags($value); $fp = fopen($logfile, 'a+'); fputs($fp, $value . "\n\n"); fclose($fp); } elseif (strpos($value, '')) { $fp = fopen($logfile, 'a+'); fputs($fp, "-----------\n"); fclose($fp); } } } /** * shows in console that a checkpoint has been passed, * additional info is the file and line which triggered * the output * * @param string $message */ public function passedCheckpoint ($message = NULL) { if ($this->config['filters']['checkpoints']) { $message = (bool)$message ? $message : 'Checkpoint passed!'; $info = '

' . $message . ''; $info .= $this->getTraceback() . '

'; $this->sendCommand('write', $info); } } /** * returns microtime as float value * * @return float */ protected function getMicrotime () { list($usec, $sec) = explode(' ', microtime()); return ((float)$usec + (float)$sec); } /** * returns all possible filter events for debugConsole::setFilter() method * * @return array */ public function getFilters () { $filters = array_keys($this->config['filters']); ksort($filters); reset($filters); return $filters; } /** * shows or hides an event-type in debugConsole, * returns previous setting of the given event-type * * @param string $event * @param bool $isShown * @return bool */ public function setFilter ($event, $isShown) { if (array_key_exists($event, $this->config['filters'])) { $oldValue = $this->config['filters'][$event]; $this->config['filters'][$event] = $isShown; } else { throw new Exception ('debugConsole: unknown event "' . $event . '" in debugConsole::filter()'); } return $oldValue; } /** * show debug info for variable in debugConsole, * added by custom text for documentation and hints * * @param mixed $variable * @param string $text */ public function dump ($variable, $text) { if ($this->config['filters']['debug']) { @ob_start(); /* grab current ob content */ $obContents = ob_get_contents(); ob_clean(); /* grap var dump from ob */ var_dump($variable); $variableDebug = ob_get_contents(); ob_end_clean(); /* restore previous ob content */ if ((bool)$obContents) echo $obContents; /* render debug */ $variableDebug = htmlspecialchars($variableDebug); $infos = '

' . $text . '
'; if (is_array($variable)) { $variableDebug = str_replace(' ', ' ', $variableDebug); $infos .= '' . $variableDebug . ''; } else { $infos .= '' . $variableDebug . ''; } $infos .= $this->getTraceback() . '

'; $this->sendCommand('write', $infos); } } /** * callback method for PHP errorhandling * * @TODO implement more errorlevels */ public function errorHandlerCallback () { $details = func_get_args(); $details[1] = str_replace("'", '"', $details[1]); $details[1] = str_replace('href="function.', 'target="_blank" href="http://www.php.net/', $details[1]); /* determine error level */ switch ($details[0]) { case 2: if (!$this->config['filters']['php_warnings']) return; $errorlevel = 'warning'; break; case 8: if (!$this->config['filters']['php_notices']) return; $errorlevel = 'notice'; break; case 2048: if (!$this->config['filters']['php_suggestions']) return; $errorlevel = 'suggestion'; break; } $fullTraceback = $details[2] . ' on line ' . $details[3]; $file = $this->cropScriptPath($details[2]); $infos = '

'; $infos .= 'PHP ' . strtoupper($errorlevel) . ''; $infos .= $details[1] . '
'; $infos .= $file . ' on line '; $infos .= $details[3] . '

'; $this->sendCommand('write', $infos); } /** * start timer clock, returns timer handle * * @return mixed * @param string $comment */ public function startTimer ($comment) { if ($this->config['filters']['timers']) { $timerHandle = md5(microtime()); $this->timers[$timerHandle] = array ( 'starttime' => $this->getMicrotime(), 'comment' => $comment ); } else { $timerHandle = FALSE; } return $timerHandle; } /** * stop timer clock * * @return bool * @param string $timerHandle */ public function stopTimer ($timerHandle) { if ($this->config['filters']['timers']) { if (array_key_exists($timerHandle, $this->timers)) { $timerExists = TRUE; $timespan = $this->getMicrotime() - $this->timers[$timerHandle]['starttime']; $info = '

' . $this->timers[$timerHandle]['comment']; $info .= '
The timer ran '; $info .= '' . number_format ($timespan, 4, '.', NULL) . ''; $info .= ' seconds.' . $this->getTraceback() . '

'; $this->sendCommand('write', $info); } else { $timerExists = FALSE; } } else { $timerExists = FALSE; } return $timerExists; } /** * returns a formatted traceback string * * @return string */ public function getTraceback () { $callStack = debug_backtrace(); $debugConsoleFiles = array( 'debugConsole.class.php', 'debugConsole.functions.php' ); $call = array ( 'file' => 'debugConsole.class.php' ); while(in_array(basename($call['file']), $debugConsoleFiles)) { $call = array_shift($callStack); } $fullTraceback = $call['file'] . ' on line ' . $call['line']; $call['file'] = $this->cropScriptPath($call['file']); $traceback = ''; $traceback .= $call['file'] . ' on line '; $traceback .= $call['line'] . ''; return '
' . $traceback; } /** * crops long script path, shows only the last $maxLength chars * * @param string $path * @param int $maxLength * @return string */ protected function cropScriptPath ($path, $maxLength = 30) { if (strlen($path) > $maxLength) { $startPos = strlen($path) - $maxLength - 2; if ($startPos > 0) { $path = '...' . substr($path, $startPos); } } return $path; } } ?>