MWDebug::clearLog() - Code Metrics - Inspection of "Daily Inspection: debug: Don't separately calculat..." - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (78b167)

unknown

created 2016-08-21 17:31 UTC

MWDebug::clearLog() A

↳ Parent: MWDebug

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	3
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php
/**
 * Debug toolbar related code.
 *
 * 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.
 *
 * 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.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 */

/**
 * New debugger system that outputs a toolbar on page view.
 *
 * By default, most methods do nothing ( self::$enabled = false ). You have
 * to explicitly call MWDebug::init() to enabled them.
 *
 * @since 1.19
 */
class MWDebug {
	/**
	 * Log lines
	 *
	 * @var array $log
	 */
	protected static $log = [];

	/**
	 * Debug messages from wfDebug().
	 *
	 * @var array $debug
	 */
	protected static $debug = [];

	/**
	 * SQL statements of the database queries.
	 *
	 * @var array $query
	 */
	protected static $query = [];

	/**
	 * Is the debugger enabled?
	 *
	 * @var bool $enabled
	 */
	protected static $enabled = false;

	/**
	 * Array of functions that have already been warned, formatted
	 * function-caller to prevent a buttload of warnings
	 *
	 * @var array $deprecationWarnings
	 */
	protected static $deprecationWarnings = [];

	/**
	 * Enabled the debugger and load resource module.
	 * This is called by Setup.php when $wgDebugToolbar is true.
	 *
	 * @since 1.19
	 */
	public static function init() {
		self::$enabled = true;
	}

	/**
	 * Disable the debugger.
	 *
	 * @since 1.28
	 */
	public static function deinit() {
		self::$enabled = false;
	}

	/**
	 * Add ResourceLoader modules to the OutputPage object if debugging is
	 * enabled.
	 *
	 * @since 1.19
	 * @param OutputPage $out
	 */
	public static function addModules( OutputPage $out ) {
		if ( self::$enabled ) {
			$out->addModules( 'mediawiki.debug.init' );
		}
	}

	/**
	 * Adds a line to the log
	 *
	 * @since 1.19
	 * @param mixed $str
	 */
	public static function log( $str ) {
		if ( !self::$enabled ) {
			return;
		}
		if ( !is_string( $str ) ) {
			$str = print_r( $str, true );
		}
		self::$log[] = [
			'msg' => htmlspecialchars( $str ),
			'type' => 'log',
			'caller' => wfGetCaller(),
		];
	}

	/**
	 * Returns internal log array
	 * @since 1.19
	 * @return array
	 */
	public static function getLog() {
		return self::$log;
	}

	/**
	 * Clears internal log array and deprecation tracking
	 * @since 1.19
	 */
	public static function clearLog() {
		self::$log = [];
		self::$deprecationWarnings = [];
	}

	/**
	 * Adds a warning entry to the log
	 *
	 * @since 1.19
	 * @param string $msg
	 * @param int $callerOffset
	 * @param int $level A PHP error level. See sendMessage()
	 * @param string $log 'production' will always trigger a php error, 'auto'
	 *    will trigger an error if $wgDevelopmentWarnings is true, and 'debug'
	 *    will only write to the debug log(s).
	 *
	 * @return mixed
	 */
	public static function warning( $msg, $callerOffset = 1, $level = E_USER_NOTICE, $log = 'auto' ) {
		global $wgDevelopmentWarnings;

		if ( $log === 'auto' && !$wgDevelopmentWarnings ) {
			$log = 'debug';
		}

		if ( $log === 'debug' ) {
			$level = false;
		}

		$callerDescription = self::getCallerDescription( $callerOffset );

		self::sendMessage( $msg, $callerDescription, 'warning', $level );

		if ( self::$enabled ) {
			self::$log[] = [
				'msg' => htmlspecialchars( $msg ),
				'type' => 'warn',
				'caller' => $callerDescription['func'],
			];
		}
	}

	/**
	 * Show a warning that $function is deprecated.
	 * This will send it to the following locations:
	 * - Debug toolbar, with one item per function and caller, if $wgDebugToolbar
	 *   is set to true.
	 * - PHP's error log, with level E_USER_DEPRECATED, if $wgDevelopmentWarnings
	 *   is set to true.
	 * - MediaWiki's debug log, if $wgDevelopmentWarnings is set to false.
	 *
	 * @since 1.19
	 * @param string $function Function that is deprecated.
	 * @param string|bool $version Version in which the function was deprecated.
	 * @param string|bool $component Component to which the function belongs.
	 *    If false, it is assumbed the function is in MediaWiki core.
	 * @param int $callerOffset How far up the callstack is the original
	 *    caller. 2 = function that called the function that called
	 *    MWDebug::deprecated() (Added in 1.20).
	 */
	public static function deprecated( $function, $version = false,
		$component = false, $callerOffset = 2
	) {
		$callerDescription = self::getCallerDescription( $callerOffset );
		$callerFunc = $callerDescription['func'];

		$sendToLog = true;

		// Check to see if there already was a warning about this function
		if ( isset( self::$deprecationWarnings[$function][$callerFunc] ) ) {
			return;
		} elseif ( isset( self::$deprecationWarnings[$function] ) ) {
			if ( self::$enabled ) {
				$sendToLog = false;
			} else {
				return;
			}
		}

		self::$deprecationWarnings[$function][$callerFunc] = true;

		if ( $version ) {
			global $wgDeprecationReleaseLimit;
			if ( $wgDeprecationReleaseLimit && $component === false ) {
				# Strip -* off the end of $version so that branches can use the
				# format #.##-branchname to avoid issues if the branch is merged into
				# a version of MediaWiki later than what it was branched from
				$comparableVersion = preg_replace( '/-.*$/', '', $version );

				# If the comparableVersion is larger than our release limit then
				# skip the warning message for the deprecation
				if ( version_compare( $wgDeprecationReleaseLimit, $comparableVersion, '<' ) ) {
					$sendToLog = false;
				}
			}

			$component = $component === false ? 'MediaWiki' : $component;
			$msg = "Use of $function was deprecated in $component $version.";
		} else {
			$msg = "Use of $function is deprecated.";
		}

		if ( $sendToLog ) {
			global $wgDevelopmentWarnings; // we could have a more specific $wgDeprecationWarnings setting.
			self::sendMessage(
				$msg,
				$callerDescription,
				'deprecated',
				$wgDevelopmentWarnings ? E_USER_DEPRECATED : false
			);
		}

		if ( self::$enabled ) {
			$logMsg = htmlspecialchars( $msg ) .
				Html::rawElement( 'div', [ 'class' => 'mw-debug-backtrace' ],
					Html::element( 'span', [], 'Backtrace:' ) . wfBacktrace()
				);

			self::$log[] = [
				'msg' => $logMsg,
				'type' => 'deprecated',
				'caller' => $callerFunc,
			];
		}
	}

	/**
	 * Get an array describing the calling function at a specified offset.
	 *
	 * @param int $callerOffset How far up the callstack is the original
	 *    caller. 0 = function that called getCallerDescription()
	 * @return array Array with two keys: 'file' and 'func'
	 */
	private static function getCallerDescription( $callerOffset ) {
		$callers = wfDebugBacktrace();

		if ( isset( $callers[$callerOffset] ) ) {
			$callerfile = $callers[$callerOffset];
			if ( isset( $callerfile['file'] ) && isset( $callerfile['line'] ) ) {
				$file = $callerfile['file'] . ' at line ' . $callerfile['line'];
			} else {
				$file = '(internal function)';
			}
		} else {
			$file = '(unknown location)';
		}

		if ( isset( $callers[$callerOffset + 1] ) ) {
			$callerfunc = $callers[$callerOffset + 1];
			$func = '';
			if ( isset( $callerfunc['class'] ) ) {
				$func .= $callerfunc['class'] . '::';
			}
			if ( isset( $callerfunc['function'] ) ) {
				$func .= $callerfunc['function'];
			}
		} else {
			$func = 'unknown';
		}

		return [ 'file' => $file, 'func' => $func ];
	}

	/**
	 * Send a message to the debug log and optionally also trigger a PHP
	 * error, depending on the $level argument.
	 *
	 * @param string $msg Message to send
	 * @param array $caller Caller description get from getCallerDescription()
	 * @param string $group Log group on which to send the message
	 * @param int|bool $level Error level to use; set to false to not trigger an error
	 */
	private static function sendMessage( $msg, $caller, $group, $level ) {
		$msg .= ' [Called from ' . $caller['func'] . ' in ' . $caller['file'] . ']';

		if ( $level !== false ) {
			trigger_error( $msg, $level );
		}

		wfDebugLog( $group, $msg, 'private' );
	}

	/**
	 * This is a method to pass messages from wfDebug to the pretty debugger.
	 * Do NOT use this method, use MWDebug::log or wfDebug()
	 *
	 * @since 1.19
	 * @param string $str
	 * @param array $context
	 */
	public static function debugMsg( $str, $context = [] ) {
		global $wgDebugComments, $wgShowDebug;

		if ( self::$enabled || $wgDebugComments || $wgShowDebug ) {
			if ( $context ) {
				$prefix = '';
				if ( isset( $context['prefix'] ) ) {
					$prefix = $context['prefix'];
				} elseif ( isset( $context['channel'] ) && $context['channel'] !== 'wfDebug' ) {
					$prefix = "[{$context['channel']}] ";
				}
				if ( isset( $context['seconds_elapsed'] ) && isset( $context['memory_used'] ) ) {
					$prefix .= "{$context['seconds_elapsed']} {$context['memory_used']}  ";
				}
				$str = $prefix . $str;
			}
			self::$debug[] = rtrim( UtfNormal\Validator::cleanUp( $str ) );
		}
	}

	/**
	 * Begins profiling on a database query
	 *
	 * @since 1.19
	 * @param string $sql
	 * @param string $function
	 * @param bool $isMaster
	 * @param float $runTime Query run time
	 * @return int ID number of the query to pass to queryTime or -1 if the
	 *  debugger is disabled
	 */
	public static function query( $sql, $function, $isMaster, $runTime ) {
		if ( !self::$enabled ) {
			return -1;
		}

		// Replace invalid UTF-8 chars with a square UTF-8 character
		// This prevents json_encode from erroring out due to binary SQL data
		$sql = preg_replace(
			'/(
				[\xC0-\xC1] # Invalid UTF-8 Bytes
				| [\xF5-\xFF] # Invalid UTF-8 Bytes
				| \xE0[\x80-\x9F] # Overlong encoding of prior code point
				| \xF0[\x80-\x8F] # Overlong encoding of prior code point
				| [\xC2-\xDF](?![\x80-\xBF]) # Invalid UTF-8 Sequence Start
				| [\xE0-\xEF](?![\x80-\xBF]{2}) # Invalid UTF-8 Sequence Start
				| [\xF0-\xF4](?![\x80-\xBF]{3}) # Invalid UTF-8 Sequence Start
				| (?<=[\x0-\x7F\xF5-\xFF])[\x80-\xBF] # Invalid UTF-8 Sequence Middle
				| (?<![\xC2-\xDF]|[\xE0-\xEF]|[\xE0-\xEF][\x80-\xBF]|[\xF0-\xF4]
				   |[\xF0-\xF4][\x80-\xBF]|[\xF0-\xF4][\x80-\xBF]{2})[\x80-\xBF] # Overlong Sequence
				| (?<=[\xE0-\xEF])[\x80-\xBF](?![\x80-\xBF]) # Short 3 byte sequence
				| (?<=[\xF0-\xF4])[\x80-\xBF](?![\x80-\xBF]{2}) # Short 4 byte sequence
				| (?<=[\xF0-\xF4][\x80-\xBF])[\x80-\xBF](?![\x80-\xBF]) # Short 4 byte sequence (2)
			)/x',
			'■',
			$sql
		);

		// last check for invalid utf8
		$sql = UtfNormal\Validator::cleanUp( $sql );

		self::$query[] = [
			'sql' => $sql,
			'function' => $function,
			'master' => (bool)$isMaster,
			'time' => $runTime,
		];

		return count( self::$query ) - 1;
	}

	/**
	 * Returns a list of files included, along with their size
	 *
	 * @param IContextSource $context
	 * @return array
	 */
	protected static function getFilesIncluded( IContextSource $context ) {
		$files = get_included_files();
		$fileList = [];
		foreach ( $files as $file ) {
			$size = filesize( $file );
			$fileList[] = [
				'name' => $file,
				'size' => $context->getLanguage()->formatSize( $size ),
			];
		}

		return $fileList;
	}

	/**
	 * Returns the HTML to add to the page for the toolbar
	 *
	 * @since 1.19
	 * @param IContextSource $context
	 * @return string
	 */
	public static function getDebugHTML( IContextSource $context ) {
		global $wgDebugComments;

		$html = '';

		if ( self::$enabled ) {
			MWDebug::log( 'MWDebug output complete' );
			$debugInfo = self::getDebugInfo( $context );

			// Cannot use OutputPage::addJsConfigVars because those are already outputted
			// by the time this method is called.
			$html = ResourceLoader::makeInlineScript(
				ResourceLoader::makeConfigSetScript( [ 'debugInfo' => $debugInfo ] )

			);
		}

		if ( $wgDebugComments ) {
			$html .= "<!-- Debug output:\n" .
				htmlspecialchars( implode( "\n", self::$debug ) ) .
				"\n\n-->";
		}

		return $html;
	}

	/**
	 * Generate debug log in HTML for displaying at the bottom of the main
	 * content area.
	 * If $wgShowDebug is false, an empty string is always returned.
	 *
	 * @since 1.20
	 * @return string HTML fragment
	 */
	public static function getHTMLDebugLog() {
		global $wgShowDebug;

		if ( !$wgShowDebug ) {
			return '';
		}

		$ret = "\n<hr />\n<strong>Debug data:</strong><ul id=\"mw-debug-html\">\n";

		foreach ( self::$debug as $line ) {
			$display = nl2br( htmlspecialchars( trim( $line ) ) );

			$ret .= "<li><code>$display</code></li>\n";
		}

		$ret .= '</ul>' . "\n";

		return $ret;
	}

	/**
	 * Append the debug info to given ApiResult
	 *
	 * @param IContextSource $context
	 * @param ApiResult $result
	 */
	public static function appendDebugInfoToApiResult( IContextSource $context, ApiResult $result ) {
		if ( !self::$enabled ) {
			return;
		}

		// output errors as debug info, when display_errors is on
		// this is necessary for all non html output of the api, because that clears all errors first
		$obContents = ob_get_contents();
		if ( $obContents ) {
			$obContentArray = explode( '<br />', $obContents );
			foreach ( $obContentArray as $obContent ) {
				if ( trim( $obContent ) ) {
					self::debugMsg( Sanitizer::stripAllTags( $obContent ) );
				}
			}
		}

		MWDebug::log( 'MWDebug output complete' );
		$debugInfo = self::getDebugInfo( $context );

		ApiResult::setIndexedTagName( $debugInfo, 'debuginfo' );
		ApiResult::setIndexedTagName( $debugInfo['log'], 'line' );
		ApiResult::setIndexedTagName( $debugInfo['debugLog'], 'msg' );
		ApiResult::setIndexedTagName( $debugInfo['queries'], 'query' );
		ApiResult::setIndexedTagName( $debugInfo['includes'], 'queries' );
		$result->addValue( null, 'debuginfo', $debugInfo );
	}

	/**
	 * Returns the HTML to add to the page for the toolbar
	 *
	 * @param IContextSource $context
	 * @return array
	 */
	public static function getDebugInfo( IContextSource $context ) {
		if ( !self::$enabled ) {
			return [];
		}

		global $wgVersion, $wgRequestTime;
		$request = $context->getRequest();

		// HHVM's reported memory usage from memory_get_peak_usage()
		// is not useful when passing false, but we continue passing
		// false for consistency of historical data in zend.
		// see: https://github.com/facebook/hhvm/issues/2257#issuecomment-39362246
		$realMemoryUsage = wfIsHHVM();

		return [
			'mwVersion' => $wgVersion,
			'phpEngine' => wfIsHHVM() ? 'HHVM' : 'PHP',
			'phpVersion' => wfIsHHVM() ? HHVM_VERSION : PHP_VERSION,
			'gitRevision' => GitInfo::headSHA1(),
			'gitBranch' => GitInfo::currentBranch(),
			'gitViewUrl' => GitInfo::headViewUrl(),
			'time' => microtime( true ) - $wgRequestTime,
			'log' => self::$log,
			'debugLog' => self::$debug,
			'queries' => self::$query,
			'request' => [
				'method' => $request->getMethod(),
				'url' => $request->getRequestURL(),
				'headers' => $request->getAllHeaders(),
				'params' => $request->getValues(),
			],
			'memory' => $context->getLanguage()->formatSize( memory_get_usage( $realMemoryUsage ) ),
			'memoryPeak' => $context->getLanguage()->formatSize( memory_get_peak_usage( $realMemoryUsage ) ),
			'includes' => self::getFilesIncluded( $context ),
		];
	}
}


1			<?php
2			/**
3			* Debug toolbar related code.
4			*
5			* This program is free software; you can redistribute it and/or modify
6			* it under the terms of the GNU General Public License as published by
7			* the Free Software Foundation; either version 2 of the License, or
8			* (at your option) any later version.
9			*
10			* This program is distributed in the hope that it will be useful,
11			* but WITHOUT ANY WARRANTY; without even the implied warranty of
12			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13			* GNU General Public License for more details.
14			*
15			* You should have received a copy of the GNU General Public License along
16			* with this program; if not, write to the Free Software Foundation, Inc.,
17			* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18			* http://www.gnu.org/copyleft/gpl.html
19			*
20			* @file
21			*/
22
23			/**
24			* New debugger system that outputs a toolbar on page view.
25			*
26			* By default, most methods do nothing ( self::$enabled = false ). You have
27			* to explicitly call MWDebug::init() to enabled them.
28			*
29			* @since 1.19
30			*/
31			class MWDebug {
32			/**
33			* Log lines
34			*
35			* @var array $log
36			*/
37			protected static $log = [];
38
39			/**
40			* Debug messages from wfDebug().
41			*
42			* @var array $debug
43			*/
44			protected static $debug = [];
45
46			/**
47			* SQL statements of the database queries.
48			*
49			* @var array $query
50			*/
51			protected static $query = [];
52
53			/**
54			* Is the debugger enabled?
55			*
56			* @var bool $enabled
57			*/
58			protected static $enabled = false;
59
60			/**
61			* Array of functions that have already been warned, formatted
62			* function-caller to prevent a buttload of warnings
63			*
64			* @var array $deprecationWarnings
65			*/
66			protected static $deprecationWarnings = [];
67
68			/**
69			* Enabled the debugger and load resource module.
70			* This is called by Setup.php when $wgDebugToolbar is true.
71			*
72			* @since 1.19
73			*/
74			public static function init() {
75			self::$enabled = true;
76			}
77
78			/**
79			* Disable the debugger.
80			*
81			* @since 1.28
82			*/
83			public static function deinit() {
84			self::$enabled = false;
85			}
86
87			/**
88			* Add ResourceLoader modules to the OutputPage object if debugging is
89			* enabled.
90			*
91			* @since 1.19
92			* @param OutputPage $out
93			*/
94			public static function addModules( OutputPage $out ) {
95			if ( self::$enabled ) {
96			$out->addModules( 'mediawiki.debug.init' );
97			}
98			}
99
100			/**
101			* Adds a line to the log
102			*
103			* @since 1.19
104			* @param mixed $str
105			*/
106			public static function log( $str ) {
107			if ( !self::$enabled ) {
108			return;
109			}
110			if ( !is_string( $str ) ) {
111			$str = print_r( $str, true );
112			}
113			self::$log[] = [
114			'msg' => htmlspecialchars( $str ),
115			'type' => 'log',
116			'caller' => wfGetCaller(),
117			];
118			}
119
120			/**
121			* Returns internal log array
122			* @since 1.19
123			* @return array
124			*/
125			public static function getLog() {
126			return self::$log;
127			}
128
129			/**
130			* Clears internal log array and deprecation tracking
131			* @since 1.19
132			*/
133			public static function clearLog() {
134			self::$log = [];
135			self::$deprecationWarnings = [];
136			}
137
138			/**
139			* Adds a warning entry to the log
140			*
141			* @since 1.19
142			* @param string $msg
143			* @param int $callerOffset
144			* @param int $level A PHP error level. See sendMessage()
145			* @param string $log 'production' will always trigger a php error, 'auto'
146			* will trigger an error if $wgDevelopmentWarnings is true, and 'debug'
147			* will only write to the debug log(s).
148			*
149			* @return mixed
150			*/
151			public static function warning( $msg, $callerOffset = 1, $level = E_USER_NOTICE, $log = 'auto' ) {
152			global $wgDevelopmentWarnings;
153
154			if ( $log === 'auto' && !$wgDevelopmentWarnings ) {
155			$log = 'debug';
156			}
157
158			if ( $log === 'debug' ) {
159			$level = false;
160			}
161
162			$callerDescription = self::getCallerDescription( $callerOffset );
163
164			self::sendMessage( $msg, $callerDescription, 'warning', $level );
165
166			if ( self::$enabled ) {
167			self::$log[] = [
168			'msg' => htmlspecialchars( $msg ),
169			'type' => 'warn',
170			'caller' => $callerDescription['func'],
171			];
172			}
173			}
174
175			/**
176			* Show a warning that $function is deprecated.
177			* This will send it to the following locations:
178			* - Debug toolbar, with one item per function and caller, if $wgDebugToolbar
179			* is set to true.
180			* - PHP's error log, with level E_USER_DEPRECATED, if $wgDevelopmentWarnings
181			* is set to true.
182			* - MediaWiki's debug log, if $wgDevelopmentWarnings is set to false.
183			*
184			* @since 1.19
185			* @param string $function Function that is deprecated.
186			* @param string\|bool $version Version in which the function was deprecated.
187			* @param string\|bool $component Component to which the function belongs.
188			* If false, it is assumbed the function is in MediaWiki core.
189			* @param int $callerOffset How far up the callstack is the original
190			* caller. 2 = function that called the function that called
191			* MWDebug::deprecated() (Added in 1.20).
192			*/
193			public static function deprecated( $function, $version = false,
194			$component = false, $callerOffset = 2
195			) {
196			$callerDescription = self::getCallerDescription( $callerOffset );
197			$callerFunc = $callerDescription['func'];
198
199			$sendToLog = true;
200
201			// Check to see if there already was a warning about this function
202			if ( isset( self::$deprecationWarnings[$function][$callerFunc] ) ) {
203			return;
204			} elseif ( isset( self::$deprecationWarnings[$function] ) ) {
205			if ( self::$enabled ) {
206			$sendToLog = false;
207			} else {
208			return;
209			}
210			}
211
212			self::$deprecationWarnings[$function][$callerFunc] = true;
213
214			if ( $version ) {
215			global $wgDeprecationReleaseLimit;
216			if ( $wgDeprecationReleaseLimit && $component === false ) {
217			# Strip -* off the end of $version so that branches can use the
218			# format #.##-branchname to avoid issues if the branch is merged into
219			# a version of MediaWiki later than what it was branched from
220			$comparableVersion = preg_replace( '/-.*$/', '', $version );
221
222			# If the comparableVersion is larger than our release limit then
223			# skip the warning message for the deprecation
224			if ( version_compare( $wgDeprecationReleaseLimit, $comparableVersion, '<' ) ) {
225			$sendToLog = false;
226			}
227			}
228
229			$component = $component === false ? 'MediaWiki' : $component;
230			$msg = "Use of $function was deprecated in $component $version.";
231			} else {
232			$msg = "Use of $function is deprecated.";
233			}
234
235			if ( $sendToLog ) {
236			global $wgDevelopmentWarnings; // we could have a more specific $wgDeprecationWarnings setting.
237			self::sendMessage(
238			$msg,
239			$callerDescription,
240			'deprecated',
241			$wgDevelopmentWarnings ? E_USER_DEPRECATED : false
242			);
243			}
244
245			if ( self::$enabled ) {
246			$logMsg = htmlspecialchars( $msg ) .
247			Html::rawElement( 'div', [ 'class' => 'mw-debug-backtrace' ],
248			Html::element( 'span', [], 'Backtrace:' ) . wfBacktrace()
249			);
250
251			self::$log[] = [
252			'msg' => $logMsg,
253			'type' => 'deprecated',
254			'caller' => $callerFunc,
255			];
256			}
257			}
258
259			/**
260			* Get an array describing the calling function at a specified offset.
261			*
262			* @param int $callerOffset How far up the callstack is the original
263			* caller. 0 = function that called getCallerDescription()
264			* @return array Array with two keys: 'file' and 'func'
265			*/
266			private static function getCallerDescription( $callerOffset ) {
267			$callers = wfDebugBacktrace();
268
269			if ( isset( $callers[$callerOffset] ) ) {
270			$callerfile = $callers[$callerOffset];
271			if ( isset( $callerfile['file'] ) && isset( $callerfile['line'] ) ) {
272			$file = $callerfile['file'] . ' at line ' . $callerfile['line'];
273			} else {
274			$file = '(internal function)';
275			}
276			} else {
277			$file = '(unknown location)';
278			}
279
280			if ( isset( $callers[$callerOffset + 1] ) ) {
281			$callerfunc = $callers[$callerOffset + 1];
282			$func = '';
283			if ( isset( $callerfunc['class'] ) ) {
284			$func .= $callerfunc['class'] . '::';
285			}
286			if ( isset( $callerfunc['function'] ) ) {
287			$func .= $callerfunc['function'];
288			}
289			} else {
290			$func = 'unknown';
291			}
292
293			return [ 'file' => $file, 'func' => $func ];
294			}
295
296			/**
297			* Send a message to the debug log and optionally also trigger a PHP
298			* error, depending on the $level argument.
299			*
300			* @param string $msg Message to send
301			* @param array $caller Caller description get from getCallerDescription()
302			* @param string $group Log group on which to send the message
303			* @param int\|bool $level Error level to use; set to false to not trigger an error
304			*/
305			private static function sendMessage( $msg, $caller, $group, $level ) {
306			$msg .= ' [Called from ' . $caller['func'] . ' in ' . $caller['file'] . ']';
307
308			if ( $level !== false ) {
309			trigger_error( $msg, $level );
310			}
311
312			wfDebugLog( $group, $msg, 'private' );
313			}
314
315			/**
316			* This is a method to pass messages from wfDebug to the pretty debugger.
317			* Do NOT use this method, use MWDebug::log or wfDebug()
318			*
319			* @since 1.19
320			* @param string $str
321			* @param array $context
322			*/
323			public static function debugMsg( $str, $context = [] ) {
324			global $wgDebugComments, $wgShowDebug;
325
326			if ( self::$enabled \|\| $wgDebugComments \|\| $wgShowDebug ) {
327			if ( $context ) {
328			$prefix = '';
329			if ( isset( $context['prefix'] ) ) {
330			$prefix = $context['prefix'];
331			} elseif ( isset( $context['channel'] ) && $context['channel'] !== 'wfDebug' ) {
332			$prefix = "[{$context['channel']}] ";
333			}
334			if ( isset( $context['seconds_elapsed'] ) && isset( $context['memory_used'] ) ) {
335			$prefix .= "{$context['seconds_elapsed']} {$context['memory_used']} ";
336			}
337			$str = $prefix . $str;
338			}
339			self::$debug[] = rtrim( UtfNormal\Validator::cleanUp( $str ) );
340			}
341			}
342
343			/**
344			* Begins profiling on a database query
345			*
346			* @since 1.19
347			* @param string $sql
348			* @param string $function
349			* @param bool $isMaster
350			* @param float $runTime Query run time
351			* @return int ID number of the query to pass to queryTime or -1 if the
352			* debugger is disabled
353			*/
354			public static function query( $sql, $function, $isMaster, $runTime ) {
355			if ( !self::$enabled ) {
356			return -1;
357			}
358
359			// Replace invalid UTF-8 chars with a square UTF-8 character
360			// This prevents json_encode from erroring out due to binary SQL data
361			$sql = preg_replace(
362			'/(
363			[\xC0-\xC1] # Invalid UTF-8 Bytes
364			\| [\xF5-\xFF] # Invalid UTF-8 Bytes
365			\| \xE0[\x80-\x9F] # Overlong encoding of prior code point
366			\| \xF0[\x80-\x8F] # Overlong encoding of prior code point
367			\| [\xC2-\xDF](?![\x80-\xBF]) # Invalid UTF-8 Sequence Start
368			\| [\xE0-\xEF](?![\x80-\xBF]{2}) # Invalid UTF-8 Sequence Start
369			\| [\xF0-\xF4](?![\x80-\xBF]{3}) # Invalid UTF-8 Sequence Start
370			\| (?<=[\x0-\x7F\xF5-\xFF])[\x80-\xBF] # Invalid UTF-8 Sequence Middle
371			\| (?<![\xC2-\xDF]\|[\xE0-\xEF]\|[\xE0-\xEF][\x80-\xBF]\|[\xF0-\xF4]
372			\|[\xF0-\xF4][\x80-\xBF]\|[\xF0-\xF4][\x80-\xBF]{2})[\x80-\xBF] # Overlong Sequence
373			\| (?<=[\xE0-\xEF])[\x80-\xBF](?![\x80-\xBF]) # Short 3 byte sequence
374			\| (?<=[\xF0-\xF4])[\x80-\xBF](?![\x80-\xBF]{2}) # Short 4 byte sequence
375			\| (?<=[\xF0-\xF4][\x80-\xBF])[\x80-\xBF](?![\x80-\xBF]) # Short 4 byte sequence (2)
376			)/x',
377			'■',
378			$sql
379			);
380
381			// last check for invalid utf8
382			$sql = UtfNormal\Validator::cleanUp( $sql );
383
384			self::$query[] = [
385			'sql' => $sql,
386			'function' => $function,
387			'master' => (bool)$isMaster,
388			'time' => $runTime,
389			];
390
391			return count( self::$query ) - 1;
392			}
393
394			/**
395			* Returns a list of files included, along with their size
396			*
397			* @param IContextSource $context
398			* @return array
399			*/
400			protected static function getFilesIncluded( IContextSource $context ) {
401			$files = get_included_files();
402			$fileList = [];
403			foreach ( $files as $file ) {
404			$size = filesize( $file );
405			$fileList[] = [
406			'name' => $file,
407			'size' => $context->getLanguage()->formatSize( $size ),
408			];
409			}
410
411			return $fileList;
412			}
413
414			/**
415			* Returns the HTML to add to the page for the toolbar
416			*
417			* @since 1.19
418			* @param IContextSource $context
419			* @return string
420			*/
421			public static function getDebugHTML( IContextSource $context ) {
422			global $wgDebugComments;
423
424			$html = '';
425
426			if ( self::$enabled ) {
427			MWDebug::log( 'MWDebug output complete' );
428			$debugInfo = self::getDebugInfo( $context );
429
430			// Cannot use OutputPage::addJsConfigVars because those are already outputted
431			// by the time this method is called.
432			$html = ResourceLoader::makeInlineScript(
433			ResourceLoader::makeConfigSetScript( [ 'debugInfo' => $debugInfo ] )
			0 ignored issues – show Security Bug introduced 2016-03-24 17:27 UTC by Report Bug Copy Issue Report It seems like `\ResourceLoader::makeCon...ugInfo' => $debugInfo))` targeting `ResourceLoader::makeConfigSetScript()` can also be of type `false`; however, `ResourceLoader::makeInlineScript()` does only seem to accept `string`, did you maybe forget to handle an error condition? Loading history...
434			);
435			}
436
437			if ( $wgDebugComments ) {
438			$html .= "<!-- Debug output:\n" .
439			htmlspecialchars( implode( "\n", self::$debug ) ) .
440			"\n\n-->";
441			}
442
443			return $html;
444			}
445
446			/**
447			* Generate debug log in HTML for displaying at the bottom of the main
448			* content area.
449			* If $wgShowDebug is false, an empty string is always returned.
450			*
451			* @since 1.20
452			* @return string HTML fragment
453			*/
454			public static function getHTMLDebugLog() {
455			global $wgShowDebug;
456
457			if ( !$wgShowDebug ) {
458			return '';
459			}
460
461			$ret = "\n<hr />\n<strong>Debug data:</strong><ul id=\"mw-debug-html\">\n";
462
463			foreach ( self::$debug as $line ) {
464			$display = nl2br( htmlspecialchars( trim( $line ) ) );
465
466			$ret .= "<li><code>$display</code></li>\n";
467			}
468
469			$ret .= '</ul>' . "\n";
470
471			return $ret;
472			}
473
474			/**
475			* Append the debug info to given ApiResult
476			*
477			* @param IContextSource $context
478			* @param ApiResult $result
479			*/
480			public static function appendDebugInfoToApiResult( IContextSource $context, ApiResult $result ) {
481			if ( !self::$enabled ) {
482			return;
483			}
484
485			// output errors as debug info, when display_errors is on
486			// this is necessary for all non html output of the api, because that clears all errors first
487			$obContents = ob_get_contents();
488			if ( $obContents ) {
489			$obContentArray = explode( '<br />', $obContents );
490			foreach ( $obContentArray as $obContent ) {
491			if ( trim( $obContent ) ) {
492			self::debugMsg( Sanitizer::stripAllTags( $obContent ) );
493			}
494			}
495			}
496
497			MWDebug::log( 'MWDebug output complete' );
498			$debugInfo = self::getDebugInfo( $context );
499
500			ApiResult::setIndexedTagName( $debugInfo, 'debuginfo' );
501			ApiResult::setIndexedTagName( $debugInfo['log'], 'line' );
502			ApiResult::setIndexedTagName( $debugInfo['debugLog'], 'msg' );
503			ApiResult::setIndexedTagName( $debugInfo['queries'], 'query' );
504			ApiResult::setIndexedTagName( $debugInfo['includes'], 'queries' );
505			$result->addValue( null, 'debuginfo', $debugInfo );
506			}
507
508			/**
509			* Returns the HTML to add to the page for the toolbar
510			*
511			* @param IContextSource $context
512			* @return array
513			*/
514			public static function getDebugInfo( IContextSource $context ) {
515			if ( !self::$enabled ) {
516			return [];
517			}
518
519			global $wgVersion, $wgRequestTime;
520			$request = $context->getRequest();
521
522			// HHVM's reported memory usage from memory_get_peak_usage()
523			// is not useful when passing false, but we continue passing
524			// false for consistency of historical data in zend.
525			// see: https://github.com/facebook/hhvm/issues/2257#issuecomment-39362246
526			$realMemoryUsage = wfIsHHVM();
527
528			return [
529			'mwVersion' => $wgVersion,
530			'phpEngine' => wfIsHHVM() ? 'HHVM' : 'PHP',
531			'phpVersion' => wfIsHHVM() ? HHVM_VERSION : PHP_VERSION,
532			'gitRevision' => GitInfo::headSHA1(),
533			'gitBranch' => GitInfo::currentBranch(),
534			'gitViewUrl' => GitInfo::headViewUrl(),
535			'time' => microtime( true ) - $wgRequestTime,
536			'log' => self::$log,
537			'debugLog' => self::$debug,
538			'queries' => self::$query,
539			'request' => [
540			'method' => $request->getMethod(),
541			'url' => $request->getRequestURL(),
542			'headers' => $request->getAllHeaders(),
543			'params' => $request->getValues(),
544			],
545			'memory' => $context->getLanguage()->formatSize( memory_get_usage( $realMemoryUsage ) ),
546			'memoryPeak' => $context->getLanguage()->formatSize( memory_get_peak_usage( $realMemoryUsage ) ),
547			'includes' => self::getFilesIncluded( $context ),
548			];
549			}
550			}
551

wikimedia / mediawiki

Branch — master (78b167)

MWDebug::clearLog() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like