oreolek
/
debug-toolbar
mirror of https://github.com/Oreolek/debug-toolbar.git
1
0
Fork 0
Code Issues Releases Wiki Activity

code refactoring, Kohana styling and moving FirePHP to a submodule

This commit is contained in:
smgladkovskiy 2011-05-25 13:04:10 +04:00
parent 4542cfa117
commit d8e4b71b3f
7 changed files with 440 additions and 1786 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitmodules vendored Normal file
View File

@ -0,0 +1,3 @@
[submodule "vendor/firephp"]
path = vendor/firephp
url = git://github.com/cadorn/firephp-libs.git

418
classes/debugtoolbar.php
View File

@ -1,411 +1,11 @@
<?php defined('SYSPATH') or die('No direct script access.');
class DebugToolbar
{
protected static $_queries = FALSE;
protected static $_benchmarks = FALSE;
protected static $_custom_tabs = array();
public static $benchmark_name = 'debug_toolbar';
/**
* Renders the Debug Toolbar
*
* @param bool print rendered output
* @return string debug toolbar rendered output
*/
public static function render($print = false)
{
$token = Profiler::start('custom', self::$benchmark_name);
$template = new View('toolbar');
// Database panel
if (Kohana::config('debug_toolbar.panels.database') === TRUE)
{
$queries = self::get_queries();
$template
->set('queries', $queries['data'])
->set('query_count', $queries['count'])
->set('total_time', $queries['time'])
->set('total_memory', $queries['memory']);
}
// Files panel
if (Kohana::config('debug_toolbar.panels.files') === TRUE)
{
$template->set('files', self::get_files());
}
// Modules panel
if (Kohana::config('debug_toolbar.panels.modules') === TRUE)
{
$template->set('modules', self::get_modules());
}
// Routes panel
if (Kohana::config('debug_toolbar.panels.routes') === TRUE)
{
$template->set('routes', self::get_routes());
}
// Custom data
if (Kohana::config('debug_toolbar.panels.customs') === TRUE)
{
$template->set('customs', self::get_customs());
}
// FirePHP
if (Kohana::config('debug_toolbar.firephp_enabled') === TRUE)
{
self::firephp();
}
// Set alignment for toolbar
switch (Kohana::config('debug_toolbar.align'))
{
case 'right':
case 'center':
case 'left':
$template->set('align', Kohana::config('debug_toolbar.align'));
break;
default:
$template->set('align', 'left');
}
// Javascript for toolbar
$template->set('scripts', file_get_contents(Kohana::find_file('views', 'toolbar', 'js')));
// CSS for toolbar
$styles = file_get_contents(Kohana::find_file('views', 'toolbar', 'css'));
Profiler::stop($token);
// Benchmarks panel
if (Kohana::config('debug_toolbar.panels.benchmarks') === TRUE)
{
$template->set('benchmarks', self::get_benchmarks());
}
if ($output = Request::initial()->response()->body() and self::is_enabled())
{
// Try to add css just before the </head> tag
if (stripos($output, '</head>') !== FALSE)
{
$output = str_ireplace('</head>', $styles.'</head>', $output);
}
else
{
// No </head> tag found, append styles to output
$template->set('styles', $styles);
}
// Try to add js and HTML just before the </body> tag
if (stripos($output, '</body>') !== FALSE)
{
$output = str_ireplace('</body>', $template->render().'</body>', $output);
}
else
{
// Closing <body> tag not found, just append toolbar to output
$output .= $template->render();
}
Request::initial()->response()->body($output);
}
else
{
$template->set('styles', $styles);
return ($print ? $template->render() : $template);
}
}
/**
* Adds custom data to render in a separate tab
*
* @param string $tab_name
* @param mixed $data
* @return void
*/
public static function add_custom($tab_name, $data)
{
self::$_custom_tabs[$tab_name] = $data;
}
/**
* Get user vars
*
* @return array
*/
public static function get_customs()
{
$result = array();
foreach(self::$_custom_tabs as $tab => $data)
{
if (is_array($data) OR is_object($data))
{
$data = Debug::dump($data);
}
$result[$tab] = $data;
}
return $result;
}
/**
* Retrieves query benchmarks from Database
*
* @return array
*/
public static function get_queries()
{
if (self::$_queries !== FALSE)
{
return self::$_queries;
}
$result = array();
$count = $time = $memory = 0;
$groups = Profiler::groups();
foreach(Database::$instances as $name => $db)
{
$group_name = 'database (' . strtolower($name) . ')';
$group = arr::get($groups, $group_name, FALSE);
if ($group)
{
$sub_time = $sub_memory = $sub_count = 0;
foreach ($group as $query => $tokens)
{
$sub_count += count($tokens);
foreach ($tokens as $token)
{
$total = Profiler::total($token);
$sub_time += $total[0];
$sub_memory += $total[1];
$result[$name][] = array('name' => $query, 'time' => $total[0], 'memory' => $total[1]);
}
}
$count += $sub_count;
$time += $sub_time;
$memory += $sub_memory;
$result[$name]['total'] = array($sub_count, $sub_time, $sub_memory);
}
}
self::$_queries = array('count' => $count, 'time' => $time, 'memory' => $memory, 'data' => $result);
return self::$_queries;
}
/**
* Creates a formatted array of all Benchmarks
*
* @return array formatted benchmarks
*/
public static function get_benchmarks()
{
if (Kohana::$profiling == FALSE)
{
return array();
}
if (self::$_benchmarks !== FALSE)
{
return self::$_benchmarks;
}
$groups = Profiler::groups();
$result = array();
foreach(array_keys($groups) as $group)
{
if (strpos($group, 'database (') === FALSE)
{
foreach($groups[$group] as $name => $marks)
{
$stats = Profiler::stats($marks);
$result[$group][] = array
(
'name' => $name,
'count' => count($marks),
'total_time' => $stats['total']['time'],
'avg_time' => $stats['average']['time'],
'total_memory' => $stats['total']['memory'],
'avg_memory' => $stats['average']['memory'],
);
}
}
}
// add total stats
$total = Profiler::application();
$result['application'] = array
(
'count' => 1,
'total_time' => $total['current']['time'],
'avg_time' => $total['average']['time'],
'total_memory' => $total['current']['memory'],
'avg_memory' => $total['average']['memory'],
);
self::$_benchmarks = $result;
return $result;
}
/**
* Get list of included files
*
* @return array file currently included by php
*/
public static function get_files()
{
$files = (array)get_included_files();
sort($files);
return $files;
}
/**
* Get module list
*
* @return array module_name => module_path
*/
public static function get_modules()
{
return Kohana::modules();
}
/**
* Returns all application routes
*
* @return array
*/
public static function get_routes()
{
return Route::all();
}
/**
* Add toolbar data to FirePHP console
*
*/
private static function firephp()
{
$firephp = FirePHP::getInstance(TRUE);
$firephp->fb('KOHANA DEBUG TOOLBAR:');
// Globals
$globals = array(
'Post' => empty($_POST) ? array() : $_POST,
'Get' => empty($_GET) ? array() : $_GET,
'Cookie' => empty($_COOKIE) ? array() : $_COOKIE,
'Session' => empty($_SESSION) ? array() : $_SESSION
);
foreach ($globals as $name => $global)
{
$table = array();
$table[] = array($name,'Value');
foreach((array)$global as $key => $value)
{
if (is_object($value))
{
$value = get_class($value).' [object]';
}
$table[] = array($key, $value);
}
$message = "$name: ".count($global).' variables';
$firephp->fb(array($message, $table), FirePHP::TABLE);
}
// Database
$query_stats = self::get_queries();
//$total_time = $total_rows = 0;
$table = array();
$table[] = array('DB profile', 'SQL Statement','Time','Memory');
foreach ((array)$query_stats['data'] as $db => $queries)
{unset($queries['total']);
foreach ($queries as $query)
{
$table[] = array(
$db,
str_replace("\n",' ',$query['name']),
number_format($query['time']*1000, 3),
number_format($query['memory']/1024, 3),
);
}
}
$message = 'Queries: '.$query_stats['count'].' SQL queries took '.
number_format($query_stats['time'], 3).' seconds and '.$query_stats['memory'].' b';
$firephp->fb(array($message, $table), FirePHP::TABLE);
// Benchmarks
$groups = self::get_benchmarks();
// application benchmarks
$total = array_pop($groups);
$table = array();
$table[] = array('Group', 'Benchmark', 'Count', 'Time', 'Memory');
foreach ((array)$groups as $group => $benchmarks)
{
foreach ((array)$benchmarks as $name => $benchmark)
{
$table[] = array(
ucfirst($group),
ucwords($benchmark['name']),
number_format($benchmark['total_time'], 3). ' s',
text::bytes($benchmark['total_memory']),
);
}
}
$message = 'Application tooks '.number_format($total['total_time'], 3).' seconds and '.text::bytes($total['total_memory']).' memory';
$firephp->fb(array($message, $table), FirePHP::TABLE);
}
/**
* Determines if all the conditions are correct to display the toolbar
* (pretty kludgy, I know)
*
* @returns bool toolbar enabled
*/
public static function is_enabled()
{
// Don't auto render toolbar for ajax requests
if (Request::initial()->is_ajax())
return FALSE;
// Don't auto render toolbar if $_GET['debug'] = 'false'
if (isset($_GET['debug']) and strtolower($_GET['debug']) == 'false')
return FALSE;
// Don't auto render if auto_render config is FALSE
if (Kohana::config('debug_toolbar.auto_render') !== TRUE)
return FALSE;
// Auto render if secret key isset
$secret_key = Kohana::config('debug_toolbar.secret_key');
if ($secret_key !== FALSE and isset($_GET[$secret_key]))
return TRUE;
// Don't auto render when in PRODUCTION (this can obviously be
// overridden by the above secret key)
if (Kohana::$environment == Kohana::PRODUCTION)
return FALSE;
return TRUE;
}
}
/**
* Kohana v3 Debug Toolbar
*
* @package Debug Toolbar
* @author Aaron Forsander <http://grimhappy.com/>
* @author Brotkin Ivan (BIakaVeron) <BIakaVeron@gmail.com>
* @author Sergei Gladkovskiy <smgladkovskiy@gmail.com>
*/
abstract class DebugToolbar extends Kohana_DebugToolbar {}

1376
classes/firephp.php
View File

File diff suppressed because it is too large Load Diff

418
classes/kohana/debugtoolbar.php Normal file
View File

@ -0,0 +1,418 @@
<?php defined('SYSPATH') or die('No direct script access.');
/**
* Kohana v3 Debug Toolbar
*
* @package Debug Toolbar
* @author Aaron Forsander <http://grimhappy.com/>
* @author Brotkin Ivan (BIakaVeron) <BIakaVeron@gmail.com>
* @author Sergei Gladkovskiy <smgladkovskiy@gmail.com>
*/
class Kohana_DebugToolbar {
/**
* Queries container
*
* @var bool|array
*/
protected static $_queries = FALSE;
/**
* Benchmarks container
*
* @var bool|array
*/
protected static $_benchmarks = FALSE;
/**
* Custom tabs container
*
* @var array
*/
protected static $_custom_tabs = array();
/**
* Benchmark name
*
* @var string
*/
public static $benchmark_name = 'debug_toolbar';
/**
* Renders the Debug Toolbar
*
* @static
* @return bool|string
*/
public static function render()
{
if( ! self::is_enabled())
return FALSE;
$token = Profiler::start('custom', self::$benchmark_name);
$template = new View('toolbar');
$config = Kohana::config('debug_toolbar');
// Database panel
if ($config->panels['database'] === TRUE)
{
$queries = self::get_queries();
$template
->set('queries', $queries['data'])
->set('query_count', $queries['count'])
->set('total_time', $queries['time'])
->set('total_memory', $queries['memory']);
}
// Files panel
if ($config->panels['files'] === TRUE)
{
$template->set('files', self::get_files());
}
// Modules panel
if ($config->panels['modules'] === TRUE)
{
$template->set('modules', self::get_modules());
}
// Routes panel
if ($config->panels['routes'] === TRUE)
{
$template->set('routes', self::get_routes());
}
// Custom data
if ($config->panels['customs'] === TRUE)
{
$template->set('customs', self::get_customs());
}
// FirePHP
if ($config->firephp_enabled === TRUE)
{
self::firephp();
}
// Set alignment for toolbar
switch ($config->align)
{
case 'right':
case 'center':
case 'left':
$template->set('align', $config->align);
break;
default:
$template->set('align', 'left');
}
// Javascript for toolbar
$template->set('scripts', file_get_contents(Kohana::find_file('views', 'toolbar', 'js')));
// CSS for toolbar
$styles = file_get_contents(Kohana::find_file('views', 'toolbar', 'css'));
Profiler::stop($token);
// Benchmarks panel
if ($config->panels['benchmarks'] === TRUE)
{
$template->set('benchmarks', self::get_benchmarks());
}
$template->set('styles', $styles);
echo $template->render();
}
/**
* Adds custom data to render in a separate tab
*
* @param string $tab_name
* @param mixed $data
* @return void
*/
public static function add_custom($tab_name, $data)
{
self::$_custom_tabs[$tab_name] = $data;
}
/**
* Get user vars
*
* @return array
*/
public static function get_customs()
{
$result = array();
foreach(self::$_custom_tabs as $tab => $data)
{
if (is_array($data) OR is_object($data))
{
$data = Debug::dump($data);
}
$result[$tab] = $data;
}
return $result;
}
/**
* Retrieves query benchmarks from Database
*
* @return array
*/
public static function get_queries()
{
if (self::$_queries !== FALSE)
{
return self::$_queries;
}
$result = array();
$count = $time = $memory = 0;
$groups = Profiler::groups();
foreach(Database::$instances as $name => $db)
{
$group_name = 'database (' . strtolower($name) . ')';
$group = arr::get($groups, $group_name, FALSE);
if ($group)
{
$sub_time = $sub_memory = $sub_count = 0;
foreach ($group as $query => $tokens)
{
$sub_count += count($tokens);
foreach ($tokens as $token)
{
$total = Profiler::total($token);
$sub_time += $total[0];
$sub_memory += $total[1];
$result[$name][] = array('name' => $query, 'time' => $total[0], 'memory' => $total[1]);
}
}
$count += $sub_count;
$time += $sub_time;
$memory += $sub_memory;
$result[$name]['total'] = array($sub_count, $sub_time, $sub_memory);
}
}
self::$_queries = array('count' => $count, 'time' => $time, 'memory' => $memory, 'data' => $result);
return self::$_queries;
}
/**
* Creates a formatted array of all Benchmarks
*
* @return array formatted benchmarks
*/
public static function get_benchmarks()
{
if (Kohana::$profiling == FALSE)
{
return array();
}
if (self::$_benchmarks !== FALSE)
{
return self::$_benchmarks;
}
$groups = Profiler::groups();
$result = array();
foreach(array_keys($groups) as $group)
{
if (strpos($group, 'database (') === FALSE)
{
foreach($groups[$group] as $name => $marks)
{
$stats = Profiler::stats($marks);
$result[$group][] = array
(
'name' => $name,
'count' => count($marks),
'total_time' => $stats['total']['time'],
'avg_time' => $stats['average']['time'],
'total_memory' => $stats['total']['memory'],
'avg_memory' => $stats['average']['memory'],
);
}
}
}
// add total stats
$total = Profiler::application();
$result['application'] = array
(
'count' => 1,
'total_time' => $total['current']['time'],
'avg_time' => $total['average']['time'],
'total_memory' => $total['current']['memory'],
'avg_memory' => $total['average']['memory'],
);
self::$_benchmarks = $result;
return $result;
}
/**
* Get list of included files
*
* @return array file currently included by php
*/
public static function get_files()
{
$files = (array)get_included_files();
sort($files);
return $files;
}
/**
* Get module list
*
* @return array module_name => module_path
*/
public static function get_modules()
{
return Kohana::modules();
}
/**
* Returns all application routes
*
* @return array
*/
public static function get_routes()
{
return Route::all();
}
/**
* Add toolbar data to FirePHP console
*
*/
private static function firephp()
{
$firephp = FirePHP::getInstance(TRUE);
$firephp->fb('KOHANA DEBUG TOOLBAR:');
// Globals
$globals = array(
'Post' => empty($_POST) ? array() : $_POST,
'Get' => empty($_GET) ? array() : $_GET,
'Cookie' => empty($_COOKIE) ? array() : $_COOKIE,
'Session' => empty($_SESSION) ? array() : $_SESSION
);
foreach ($globals as $name => $global)
{
$table = array();
$table[] = array($name,'Value');
foreach((array)$global as $key => $value)
{
if (is_object($value))
{
$value = get_class($value).' [object]';
}
$table[] = array($key, $value);
}
$message = "$name: ".count($global).' variables';
$firephp->fb(array($message, $table), FirePHP::TABLE);
}
// Database
$query_stats = self::get_queries();
//$total_time = $total_rows = 0;
$table = array();
$table[] = array('DB profile', 'SQL Statement','Time','Memory');
foreach ((array)$query_stats['data'] as $db => $queries)
{unset($queries['total']);
foreach ($queries as $query)
{
$table[] = array(
$db,
str_replace("\n",' ',$query['name']),
number_format($query['time']*1000, 3),
number_format($query['memory']/1024, 3),
);
}
}
$message = 'Queries: '.$query_stats['count'].' SQL queries took '.
number_format($query_stats['time'], 3).' seconds and '.$query_stats['memory'].' b';
$firephp->fb(array($message, $table), FirePHP::TABLE);
// Benchmarks
$groups = self::get_benchmarks();
// application benchmarks
$total = array_pop($groups);
$table = array();
$table[] = array('Group', 'Benchmark', 'Count', 'Time', 'Memory');
foreach ((array)$groups as $group => $benchmarks)
{
foreach ((array)$benchmarks as $name => $benchmark)
{
$table[] = array(
ucfirst($group),
ucwords($benchmark['name']),
number_format($benchmark['total_time'], 3). ' s',
text::bytes($benchmark['total_memory']),
);
}
}
$message = 'Application tooks '.number_format($total['total_time'], 3).' seconds and '.text::bytes($total['total_memory']).' memory';
$firephp->fb(array($message, $table), FirePHP::TABLE);
}
/**
* Determines if all the conditions are correct to display the toolbar
* (pretty kludgy, I know)
*
* @static
* @return bool
*/
public static function is_enabled()
{
$config = Kohana::config('debug_toolbar');
// Don't auto render toolbar for ajax requests
if (Request::initial()->is_ajax())
return FALSE;
// Don't auto render toolbar if $_GET['debug'] = 'false'
if (isset($_GET['debug']) and strtolower($_GET['debug']) == 'false')
return FALSE;
// Don't auto render if auto_render config is FALSE
if ($config->auto_render !== TRUE)
return FALSE;
// Auto render if secret key isset
if ($config->secret_key !== FALSE and isset($_GET[$config->secret_key]))
return TRUE;
// Don't auto render when in PRODUCTION (this can obviously be
// overridden by the above secret key)
if (Kohana::$environment == Kohana::PRODUCTION)
return FALSE;
return TRUE;
}
}

2
config/debug_toolbar.php
View File

@ -5,7 +5,7 @@
* NOTE: if IN_PRODUCTION is set to TRUE, the toolbar will
* not automatically render, even if auto_render is TRUE
*/
$config['auto_render'] = FALSE;
$config['auto_render'] = Kohana::$environment > Kohana::PRODUCTION;
/*
* If true, the toolbar will default to the minimized position

8
init.php Normal file
View File

@ -0,0 +1,8 @@
<?php defined('SYSPATH') or die('No direct script access.');
// Load FirePHP if it enabled in config
if(Kohana::config('debug_toolbar.firephp_enabled') === TRUE)
require_once Kohana::find_file('vendor', 'firephp/packages/core/lib/FirePHPCore/FirePHP.class');
// Render Debug Toolbar on the end of application execution
register_shutdown_function('debugtoolbar::render');

1
vendor/firephp vendored Submodule

@ -0,0 +1 @@
Subproject commit aff25803a3ff460b2797d3450b4c8acdcd3137eb