Debug

Complexity

Total Complexity

61

Size/Duplication

Total Lines	422
Duplicated Lines	0 %

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	db_query()	0	7	2
A	get_db()	0	6	2
A	add()	0	9	3
A	cache()	0	7	2
A	toggleViewQueries()	0	3	2
A	merge_db()	0	7	2
A	instance()	0	6	2
A	on()	0	3	1
C	display()	0	88	12
A	cache_count()	0	3	1
B	_prepare_last_bits()	0	38	7
A	rusage()	0	12	4
A	off()	0	3	1
A	viewQueries()	0	18	4
D	_show_queries()	0	37	16

<?php

/**
 * This file contains a (static) class that will track some debug information
 * if debug is on.
 *
 * @name      ElkArte Forum
 * @copyright ElkArte Forum contributors
 * @license   BSD http://opensource.org/licenses/BSD-3-Clause
 *
 * This file contains code covered by:
 * copyright:	2011 Simple Machines (http://www.simplemachines.org)
 * license:  	BSD, See included LICENSE.TXT for terms and conditions.
 *
 * @version 1.1
 *
 */

/**
 * Stored debugging information.
 */
class Debug
{
	/**
	 * This is used to remember if the debug is on or off
	 * @var bool
	 */
	private $_track = true;

	/**
	 * A list of known debug entities (here to preserve a kind of order)
	 * @var mixed[]
	 */
	private $_debugs = array(
		'templates' => array(),
		'sub_templates' => array(),
		'language_files' => array(),
		'sheets' => array(),
		'javascript' => array(),
		'hooks' => array(),
		'files_included' => array(),
		'tokens' => array(),
	);

	/**
	 * Holds the output ot the getrusage php function
	 * @var mixed[]
	 */
	private $_rusage = array();

	/**
	 * Holds All the cache hits for a page load
	 * @var string[]
	 */
	private $_cache_hits = array();

	/**
	 * Number of times the cache has been used
	 * @var int
	 */
	private $_cache_count = 0;

	/**
	 * All the queries executed
	 * @var mixed[]
	 */
	private $_db_cache = array();

	/**
	 * Number of queries
	 * @var int
	 */
	private $_db_count = 0;

	/**
	 * Some generic "system" debug info
	 * @var string[]
	 */
	private $_system = array();

	/**
	 * The instance of the class
	 * @var object
	 */
	private static $_instance = null;


	/**
	 * Adds a new generic debug entry
	 *
	 * @param string $type the kind of debug entry
	 * @param string|string[] string or array of the entry to show
	 */
	public function add($type, $value)
	{
		if (!$this->_track)
			return;

		if (is_array($value))
			$this->_debugs[$type] = array_merge($this->_debugs[$type], $value);
		else
			$this->_debugs[$type][] = $value;
	}

	/**
	 * Adds a new cache hits
	 *
	 * @param mixed[] $value contains the relevant cache info, in the form:
	 *         d => method: put or get
	 *         k => cache key
	 *         t => time taken to get/put the entry
	 *         s => length of the serialized value
	 */
	public function cache($value)
	{
		if (!$this->_track)
			return;

		$this->_cache_hits[] = $value;
		$this->_cache_count++;
	}

	/**
	 * Return the number of cache hits
	 *
	 * @return int
	 */
	public function cache_count()
	{
		return $this->_cache_count;
	}

	/**
	 * Adds a new database query
	 *
	 * @param mixed[] $value contains the relevant queries info, in the form:
	 *         q => the query string (only for the first 50 queries, after that only a "...")
	 *         f => the file in which the query has been executed
	 *         l => the line at which the query has been executed
	 *         s => seconds at which the query has been executed into the request
	 *         t => time taken by the query
	 */
	public function db_query($value)
	{
		if (!$this->_track)
			return;

		$this->_db_cache[] = $value;
		$this->_db_count++;
	}

	/**
	 * Merges the values passed with the current database entries
	 *
	 * @param mixed[] $value An array of queries info, see the db method for details
	 */
	public function merge_db($value)
	{
		if (!$this->_track)
			return;

		$this->_db_cache = array_merge($value, $this->_db_cache);
		$this->_db_count = count($this->_db_cache) + 1;
	}

	/**
	 * Return the current database entries
	 *
	 * @return array
	 */
	public function get_db()
	{
		if (!$this->_track)
			return array();

		return $this->_db_cache;
	}

	/**
	 * Adds a new getrusage value (by default two are added: one at the beginning
	 * of the script execution and one at the end)
	 *
	 * @param string $point can be end or start depending on when the function
	 *               is called
	 * @param string[]|null $rusage value of getrusage or null to let the method call it
	 */
	public function rusage($point, $rusage = null)
	{
		// getrusage is missing in php < 7 on Windows
		if ($this->_track === false || function_exists('getrusage') === false)
		{
			return;
		}

		if ($rusage === null)
			$this->_rusage[$point] = getrusage();
		else
			$this->_rusage[$point] = $rusage;
	}

	/**
	 * Enables tracking of debug entries
	 */
	public function on()
	{
		$this->_track = true;
	}

	/**
	 * Disables tracking of debug entries
	 */
	public function off()
	{
		$this->_track = false;
	}

	/**
	 * Toggles the visibility of the queries
	 */
	public function toggleViewQueries()
	{
		$_SESSION['view_queries'] = $_SESSION['view_queries'] == 1 ? 0 : 1;
	}

	/**
	 * Collects some other generic system information necessary for the
	 * debug screen
	 */
	private function _prepare_last_bits()
	{
		global $context;

		if (empty($_SESSION['view_queries']))
			$_SESSION['view_queries'] = 0;

		$files = get_included_files();
		$total_size = 0;
		for ($i = 0, $n = count($files); $i < $n; $i++)
		{
			if (file_exists($files[$i]))
				$total_size += filesize($files[$i]);
			$this->add('files_included', strtr($files[$i], array(BOARDDIR => '.')));
		}

		if (!empty($this->_db_cache))
			$_SESSION['debug'] = $this->_db_cache;

		// Compute some system info, if we can
		$this->_system['system_type'] = php_uname();
		require_once(SUBSDIR . '/Server.subs.php');
		$this->_system['server_load'] = detectServerLoad();
		$this->_system['script_mem_load'] = byte_format(memory_get_peak_usage());

		// getrusage() information is CPU time, not wall clock time like microtime, *nix only
		$this->rusage('end');

		if (!empty($this->_rusage))
		{
			$this->_system['script_cpu_load'] = ($this->_rusage['end']['ru_utime.tv_sec'] - $this->_rusage['start']['ru_utime.tv_sec'] + ($this->_rusage['end']['ru_utime.tv_usec'] / 1000000)) . ' / ' . ($this->_rusage['end']['ru_stime.tv_sec'] - $this->_rusage['start']['ru_stime.tv_sec'] + ($this->_rusage['end']['ru_stime.tv_usec'] / 1000000));
		}

		$this->_system['browser'] = $context['browser_body_id'] . ' <em>(' . implode('</em>, <em>', array_reverse(array_keys($context['browser'], true))) . ')</em>';

		// What tokens are active?
		if (isset($_SESSION['token']))
			$this->add('tokens', array_keys($_SESSION['token']));
	}

	/**
	 * This function shows the debug information tracked
	 */
	public function display()
	{
		global $scripturl, $txt;

		$this->_prepare_last_bits();
		$expand_id = array();

		// Gotta have valid HTML ;).
		$temp = ob_get_contents();
		ob_clean();

		echo preg_replace('~</body>\s*</html>~', '', $temp), '
		<div id="debug_logging_wrapper">
			<div id="debug_logging" class="smalltext">';

		foreach ($this->_system as $key => $value)
			if (!empty($value))
				echo '
				', $txt['debug_' . $key], $value, '<br />';

		$expandable = array('hooks', 'files_included');

		foreach ($this->_debugs as $key => $value)
		{
			$value = array_map('htmlentities', $value);
			if (in_array($key, $expandable))
			{
				$key = htmlentities($key, ENT_QUOTES);
				$expand_id[] = 'debug_' . $key;
				$pre = ' (<a id="debug_' . $key . '" href="#">' . $txt['debug_show'] . '</a><span class="hide">';
				$post = '</span>)';
			}
			else
			{
				$pre = '';
				$post = '';
			}

			echo '
				', $txt['debug_' . $key], count($value), ' - ' . $pre . '<em>', implode('</em>, <em>', $value), '</em>.' . $post . '<br />';
		}

		// If the cache is on, how successful was it?
		if (Cache::instance()->isEnabled() && !empty($this->_cache_hits))
		{
			$entries = array();
			$total_t = 0;
			$total_s = 0;
			foreach ($this->_cache_hits as $cache_hit)
			{
				$entries[] = $cache_hit['d'] . ' ' . $cache_hit['k'] . ': ' . sprintf($txt['debug_cache_seconds_bytes'], comma_format($cache_hit['t'], 5), $cache_hit['s']);
				$total_t += $cache_hit['t'];
				$total_s += $cache_hit['s'];
			}
			$expand_id[] = 'debug_cache_info';

			echo '
				', $txt['debug_cache_hits'], $this->cache_count(), ': ', sprintf($txt['debug_cache_seconds_bytes_total'], comma_format($total_t, 5), comma_format($total_s)), ' (<a id="debug_cache_info" href="#">', $txt['debug_show'], '</a><span class="hide"><em>', implode('</em>, <em>', $entries), '</em></span>)<br />';
		}

		// Want to see the querys in a new windows?
		echo '
				<a href="', $scripturl, '?action=viewquery" target="_blank" class="new_win">', sprintf($txt['debug_queries_used'], $this->_db_count), '</a><br />';

		if ($_SESSION['view_queries'] == 1 && !empty($this->_db_cache))
			$this->_show_queries();

		// Or show/hide the querys in line with all of this data
		echo '
				<a href="' . $scripturl . '?action=viewquery;sa=hide">', $txt['debug_' . (empty($_SESSION['view_queries']) ? 'show' : 'hide') . '_queries'], '</a>
			</div>
		</div>';

		if (!empty($expand_id))
		{
			echo '
			<script>
				$(function() {
					$(\'#', implode(', #', $expand_id), '\').click(function(ev) {
						ev.preventDefault();
						$(this).next().toggle();
						$(this).remove();
					});
				});
			</script>';
		}

		echo '
	</body></html>';
	}

	/**
	 * Displays a page with all the queries executed during the "current"
	 * page load and allows to EXPLAIN them
	 *
	 * @param integer $query_id the id of the query to EXPLAIN, if -1 no queries are explained
	 */
	public function viewQueries($query_id)
	{
		$queries_data = array();

		$query_analysis = new Query_Analysis();

		foreach ($_SESSION['debug'] as $q => $query_data)
		{
			$queries_data[$q] = $query_analysis->extractInfo($query_data);

			// Explain the query.
			if ($query_id == $q && $queries_data[$q]['is_select'])
			{
				$queries_data[$q]['explain'] = $query_analysis->doExplain();
			}
		}

		return $queries_data;
	}

	/**
	 * Displays a list of queries executed during the current
	 * page load
	 */
	private function _show_queries()
	{
		global $scripturl, $txt;

		foreach ($this->_db_cache as $q => $qq)
		{
			$is_select = strpos(trim($qq['q']), 'SELECT') === 0 || preg_match('~^INSERT(?: IGNORE)? INTO \w+(?:\s+\([^)]+\))?\s+SELECT .+$~s', trim($qq['q'])) != 0 || strpos(trim($qq['q']), 'WITH') === 0;

			// Temporary tables created in earlier queries are not explainable.
			if ($is_select)
			{
				foreach (array('log_topics_unread', 'topics_posted_in', 'tmp_log_search_topics', 'tmp_log_search_messages') as $tmp)
					if (strpos(trim($qq['q']), $tmp) !== false)
					{
						$is_select = false;
						break;
					}
			}
			// But actual creation of the temporary tables are.
			elseif (preg_match('~^CREATE TEMPORARY TABLE .+?SELECT .+$~s', trim($qq['q'])) != 0)
				$is_select = true;

			// Make the filenames look a bit better.
			if (isset($qq['f']))
				$qq['f'] = preg_replace('~^' . preg_quote(BOARDDIR, '~') . '~', '...', $qq['f']);

			echo '
		<strong>', $is_select ? '<a href="' . $scripturl . '?action=viewquery;qq=' . ($q + 1) . '#qq' . $q . '" target="_blank" class="new_win">' : '', nl2br(str_replace("\t", '&nbsp;&nbsp;&nbsp;', htmlspecialchars(ltrim($qq['q'], "\n\r"), ENT_COMPAT, 'UTF-8'))) . ($is_select ? '</a></strong>' : '</strong>') . '<br />
		&nbsp;&nbsp;&nbsp;';
			if (!empty($qq['f']) && !empty($qq['l']))
				echo sprintf($txt['debug_query_in_line'], $qq['f'], $qq['l']);

			if (isset($qq['s'], $qq['t']) && isset($txt['debug_query_which_took_at']))
				echo sprintf($txt['debug_query_which_took_at'], round($qq['t'], 8), round($qq['s'], 8)) . '<br />';
			elseif (isset($qq['t']))
				echo sprintf($txt['debug_query_which_took'], round($qq['t'], 8)) . '<br />';
			echo '
		<br />';
		}
	}

	/**
	 * Return the single instance of this class
	 * @return Debug
	 */
	public static function instance()
	{
		if (self::$_instance === null)
			self::$_instance = new Debug();

		return self::$_instance;
	}
}