debugtoolbar.php | searchcode

/modules/debug_toolbar/classes/debugtoolbar.php

https://bitbucket.org/seyar/ari100krat.local
PHP | 362 lines | 249 code | 55 blank | 58 comment | 23 complexity | d5b238207fefbb8bbd71435f49eb20ec MD5 | raw file
Possible License(s): BSD-3-Clause, LGPL-2.1

<?php defined('SYSPATH') or die('No direct script access.');

class DebugToolbar
{
	protected static $_queries = FALSE;
	protected static $_benchmarks = FALSE;

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

		// 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::instance()->response 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::instance()->response = $output;
		}
		else
		{
			$template->set('styles', $styles);

			return ($print ? $template->render() : $template);
		}
	}

	/**
	 * Retrieves query benchmarks from Database
	 */
	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;
	}

	/**
	 *
	 * @return array  module_name => module_path
	 */
	public static function get_modules()
	{
		return Kohana::modules();
	}

	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::$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 (IN_PRODUCTION)
			return FALSE;

		return TRUE;
	}
}