Issues in MWException.php (master) - Issues in master - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

Issues (4122)

Security Analysis not enabled

Cross-Site Scripting

Cross-Site Scripting enables an attacker to inject code into the response of a web-request that is viewed by other users. It can for example be used to bypass access controls, or even to take over other users' accounts.

File Exposure

File Exposure allows an attacker to gain access to local files that he should not be able to access. These files can for example include database credentials, or other configuration files.

File Manipulation

File Manipulation enables an attacker to write custom data to files. This potentially leads to injection of arbitrary code on the server.

Object Injection

Object Injection enables an attacker to inject an object into PHP code, and can lead to arbitrary code execution, file exposure, or file manipulation attacks.

Code Injection

Code Injection enables an attacker to execute arbitrary code on the server.

Response Splitting

Response Splitting can be used to send arbitrary responses.

File Inclusion

File Inclusion enables an attacker to inject custom files into PHP's file loading mechanism, either explicitly passed to include, or for example via PHP's auto-loading mechanism.

Command Injection

Command Injection enables an attacker to inject a shell command that is execute with the privileges of the web-server. This can be used to expose sensitive data, or gain access of your server.

SQL Injection

SQL Injection enables an attacker to execute arbitrary SQL code on your database server gaining access to user data, or manipulating user data.

XPath Injection

XPath Injection enables an attacker to modify the parts of XML document that are read. If that XML document is for example used for authentication, this can lead to further vulnerabilities similar to SQL Injection.

LDAP Injection

LDAP Injection enables an attacker to inject LDAP statements potentially granting permission to run unauthorized queries, or modify content inside the LDAP tree.

Header Injection

Other Vulnerability

This category comprises other attack vectors such as manipulating the PHP runtime, loading custom extensions, freezing the runtime, or similar.

Regex Injection

Regex Injection enables an attacker to execute arbitrary code in your PHP process.

XML Injection

XML Injection enables an attacker to read files on your local filesystem including configuration files, or can be abused to freeze your web-server process.

Variable Injection

Variable Injection enables an attacker to overwrite program variables with custom data, and can lead to further vulnerabilities.

Unfortunately, the security analysis is currently not available for your project. If you are a non-commercial open-source project, please contact support to gain access.

includes/exception/MWException.php (5 issues)

Labels

Severity

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php
/**
 * 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
 */

/**
 * MediaWiki exception
 *
 * @ingroup Exception
 */
class MWException extends Exception {
	/**
	 * Should the exception use $wgOut to output the error?
	 *
	 * @return bool
	 */
	public function useOutputPage() {
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
		return $this->useMessageCache() &&
		!empty( $GLOBALS['wgFullyInitialised'] ) &&
		!empty( $GLOBALS['wgOut'] ) &&
		!defined( 'MEDIAWIKI_INSTALL' );
	}

	/**
	 * Whether to log this exception in the exception debug log.
	 *
	 * @since 1.23
	 * @return bool
	 */
	public function isLoggable() {
		return true;
	}

	/**
	 * Can the extension use the Message class/wfMessage to get i18n-ed messages?
	 *
	 * @return bool
	 */
	public function useMessageCache() {
		global $wgLang;

		foreach ( $this->getTrace() as $frame ) {
			if ( isset( $frame['class'] ) && $frame['class'] === 'LocalisationCache' ) {
				return false;
			}
		}

		return $wgLang instanceof Language;
	}

	/**
	 * Run hook to allow extensions to modify the text of the exception
	 *
	 * @param string $name Class name of the exception
	 * @param array $args Arguments to pass to the callback functions
	 * @return string|null String to output or null if any hook has been called
	 */
	public function runHooks( $name, $args = [] ) {
		return MWExceptionRenderer::runHooks( $this, $name, $args );
	}

	/**
	 * Get a message from i18n
	 *
	 * @param string $key Message name
	 * @param string $fallback Default message if the message cache can't be
	 *                  called by the exception
	 * The function also has other parameters that are arguments for the message
	 * @return string Message with arguments replaced
	 */
	public function msg( $key, $fallback /*[, params...] */ ) {
		$args = array_slice( func_get_args(), 2 );

		if ( $this->useMessageCache() ) {
			try {
				return wfMessage( $key, $args )->text();
			} catch ( Exception $e ) {

			}
		}
		return wfMsgReplaceArgs( $fallback, $args );
	}

	/**
	 * If $wgShowExceptionDetails is true, return a HTML message with a
	 * backtrace to the error, otherwise show a message to ask to set it to true
	 * to show that information.
	 *
	 * @return string Html to output
	 */
	public function getHTML() {
		global $wgShowExceptionDetails;

		if ( $wgShowExceptionDetails ) {
			return '<p>' . nl2br( htmlspecialchars( MWExceptionHandler::getLogMessage( $this ) ) ) .
			'</p><p>Backtrace:</p><p>' .
			nl2br( htmlspecialchars( MWExceptionHandler::getRedactedTraceAsString( $this ) ) ) .
			"</p>\n";
		} else {
			$logId = WebRequest::getRequestId();
			$type = get_class( $this );
			return "<div class=\"errorbox\">" .
			'[' . $logId . '] ' .
			gmdate( 'Y-m-d H:i:s' ) . ": " .
			$this->msg( "internalerror-fatal-exception",
				"Fatal exception of type $1",
				$type,
				$logId,
				MWExceptionHandler::getURL( $this )
			) . "</div>\n" .
			"<!-- Set \$wgShowExceptionDetails = true; " .
			"at the bottom of LocalSettings.php to show detailed " .
			"debugging information. -->";
		}
	}

	/**
	 * Get the text to display when reporting the error on the command line.
	 * If $wgShowExceptionDetails is true, return a text message with a
	 * backtrace to the error.
	 *
	 * @return string
	 */
	public function getText() {
		global $wgShowExceptionDetails;

		if ( $wgShowExceptionDetails ) {
			return MWExceptionHandler::getLogMessage( $this ) .
			"\nBacktrace:\n" . MWExceptionHandler::getRedactedTraceAsString( $this ) . "\n";
		} else {
			return "Set \$wgShowExceptionDetails = true; " .
			"in LocalSettings.php to show detailed debugging information.\n";
		}
	}

	/**
	 * Return the title of the page when reporting this error in a HTTP response.
	 *
	 * @return string
	 */
	public function getPageTitle() {
		return $this->msg( 'internalerror', 'Internal error' );
	}

	/**
	 * Output the exception report using HTML.
	 */
	public function reportHTML() {
		global $wgOut, $wgSitename;
		if ( $this->useOutputPage() ) {
			$wgOut->prepareErrorPage( $this->getPageTitle() );

			$hookResult = $this->runHooks( get_class( $this ) );
			if ( $hookResult ) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
				$wgOut->addHTML( $hookResult );
			} else {
				$wgOut->addHTML( $this->getHTML() );
			}

			$wgOut->output();
		} else {
			self::header( 'Content-Type: text/html; charset=utf-8' );
			echo "<!DOCTYPE html>\n" .
				'<html><head>' .
				// Mimick OutputPage::setPageTitle behaviour
				'<title>' .
				htmlspecialchars( $this->msg( 'pagetitle', "$1 - $wgSitename", $this->getPageTitle() ) ) .
				'</title>' .
				'<style>body { font-family: sans-serif; margin: 0; padding: 0.5em 2em; }</style>' .
				"</head><body>\n";

			$hookResult = $this->runHooks( get_class( $this ) . 'Raw' );
			if ( $hookResult ) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
				echo $hookResult;
			} else {
				echo $this->getHTML();
			}

			echo "</body></html>\n";
		}
	}

	/**
	 * Output a report about the exception and takes care of formatting.
	 * It will be either HTML or plain text based on isCommandLine().
	 */
	public function report() {
		global $wgMimeType;

		if ( defined( 'MW_API' ) ) {
			// Unhandled API exception, we can't be sure that format printer is alive
			self::header( 'MediaWiki-API-Error: internal_api_error_' . get_class( $this ) );
			wfHttpError( 500, 'Internal Server Error', $this->getText() );
		} elseif ( self::isCommandLine() ) {
			$message = $this->getText();
			// T17602: STDERR may not be available
			if ( defined( 'STDERR' ) ) {
				fwrite( STDERR, $message );
			} else {
				echo $message;
			}
		} else {
			self::statusHeader( 500 );
			self::header( "Content-Type: $wgMimeType; charset=utf-8" );

			$this->reportHTML();
		}
	}

	/**
	 * Check whether we are in command line mode or not to report the exception
	 * in the correct format.
	 *
	 * @return bool
	 */
	public static function isCommandLine() {
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
		return !empty( $GLOBALS['wgCommandLineMode'] );
	}

	/**
	 * Send a header, if we haven't already sent them. We shouldn't,
	 * but sometimes we might in a weird case like Export
	 * @param string $header
	 */
	private static function header( $header ) {
		if ( !headers_sent() ) {
			header( $header );
		}
	}
	private static function statusHeader( $code ) {
		if ( !headers_sent() ) {
			HttpStatus::header( $code );
		}
	}
}


1		<?php
2		/**
3		* This program is free software; you can redistribute it and/or modify
4		* it under the terms of the GNU General Public License as published by
5		* the Free Software Foundation; either version 2 of the License, or
6		* (at your option) any later version.
7		*
8		* This program is distributed in the hope that it will be useful,
9		* but WITHOUT ANY WARRANTY; without even the implied warranty of
10		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11		* GNU General Public License for more details.
12		*
13		* You should have received a copy of the GNU General Public License along
14		* with this program; if not, write to the Free Software Foundation, Inc.,
15		* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16		* http://www.gnu.org/copyleft/gpl.html
17		*
18		* @file
19		*/
20
21		/**
22		* MediaWiki exception
23		*
24		* @ingroup Exception
25		*/
26		class MWException extends Exception {
27		/**
28		* Should the exception use $wgOut to output the error?
29		*
30		* @return bool
31		*/
32		public function useOutputPage() {
		0 ignored issues – show Coding Style introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report Show Similar Issues like this `useOutputPage` uses the super-global variable `$GLOBALS` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
33		return $this->useMessageCache() &&
34		!empty( $GLOBALS['wgFullyInitialised'] ) &&
35		!empty( $GLOBALS['wgOut'] ) &&
36		!defined( 'MEDIAWIKI_INSTALL' );
37		}
38
39		/**
40		* Whether to log this exception in the exception debug log.
41		*
42		* @since 1.23
43		* @return bool
44		*/
45		public function isLoggable() {
46		return true;
47		}
48
49		/**
50		* Can the extension use the Message class/wfMessage to get i18n-ed messages?
51		*
52		* @return bool
53		*/
54		public function useMessageCache() {
55		global $wgLang;
56
57	View Code Duplication	foreach ( $this->getTrace() as $frame ) {
58		if ( isset( $frame['class'] ) && $frame['class'] === 'LocalisationCache' ) {
59		return false;
60		}
61		}
62
63		return $wgLang instanceof Language;
64		}
65
66		/**
67		* Run hook to allow extensions to modify the text of the exception
68		*
69		* @param string $name Class name of the exception
70		* @param array $args Arguments to pass to the callback functions
71		* @return string\|null String to output or null if any hook has been called
72		*/
73		public function runHooks( $name, $args = [] ) {
74		return MWExceptionRenderer::runHooks( $this, $name, $args );
75		}
76
77		/**
78		* Get a message from i18n
79		*
80		* @param string $key Message name
81		* @param string $fallback Default message if the message cache can't be
82		* called by the exception
83		* The function also has other parameters that are arguments for the message
84		* @return string Message with arguments replaced
85		*/
86	View Code Duplication	public function msg( $key, $fallback /[, params...] / ) {
87		$args = array_slice( func_get_args(), 2 );
88
89		if ( $this->useMessageCache() ) {
90		try {
91		return wfMessage( $key, $args )->text();
92		} catch ( Exception $e ) {
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report Show Similar Issues like this Consider adding a comment why this CATCH block is empty. Loading history...
93		}
94		}
95		return wfMsgReplaceArgs( $fallback, $args );
96		}
97
98		/**
99		* If $wgShowExceptionDetails is true, return a HTML message with a
100		* backtrace to the error, otherwise show a message to ask to set it to true
101		* to show that information.
102		*
103		* @return string Html to output
104		*/
105		public function getHTML() {
106		global $wgShowExceptionDetails;
107
108		if ( $wgShowExceptionDetails ) {
109		return '<p>' . nl2br( htmlspecialchars( MWExceptionHandler::getLogMessage( $this ) ) ) .
110		'</p><p>Backtrace:</p><p>' .
111		nl2br( htmlspecialchars( MWExceptionHandler::getRedactedTraceAsString( $this ) ) ) .
112		"</p>\n";
113		} else {
114		$logId = WebRequest::getRequestId();
115		$type = get_class( $this );
116		return "<div class=\"errorbox\">" .
117		'[' . $logId . '] ' .
118		gmdate( 'Y-m-d H:i:s' ) . ": " .
119		$this->msg( "internalerror-fatal-exception",
120		"Fatal exception of type $1",
121		$type,
122		$logId,
123		MWExceptionHandler::getURL( $this )
124		) . "</div>\n" .
125		"<!-- Set \$wgShowExceptionDetails = true; " .
126		"at the bottom of LocalSettings.php to show detailed " .
127		"debugging information. -->";
128		}
129		}
130
131		/**
132		* Get the text to display when reporting the error on the command line.
133		* If $wgShowExceptionDetails is true, return a text message with a
134		* backtrace to the error.
135		*
136		* @return string
137		*/
138	View Code Duplication	public function getText() {
139		global $wgShowExceptionDetails;
140
141		if ( $wgShowExceptionDetails ) {
142		return MWExceptionHandler::getLogMessage( $this ) .
143		"\nBacktrace:\n" . MWExceptionHandler::getRedactedTraceAsString( $this ) . "\n";
144		} else {
145		return "Set \$wgShowExceptionDetails = true; " .
146		"in LocalSettings.php to show detailed debugging information.\n";
147		}
148		}
149
150		/**
151		* Return the title of the page when reporting this error in a HTTP response.
152		*
153		* @return string
154		*/
155		public function getPageTitle() {
156		return $this->msg( 'internalerror', 'Internal error' );
157		}
158
159		/**
160		* Output the exception report using HTML.
161		*/
162		public function reportHTML() {
163		global $wgOut, $wgSitename;
164		if ( $this->useOutputPage() ) {
165		$wgOut->prepareErrorPage( $this->getPageTitle() );
166
167		$hookResult = $this->runHooks( get_class( $this ) );
168		if ( $hookResult ) {
		0 ignored issues – show Bug Best Practice introduced 2016-09-15 18:30 UTC by Report Bug Copy Issue Report Show Similar Issues like this The expression `$hookResult` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
169		$wgOut->addHTML( $hookResult );
170		} else {
171		$wgOut->addHTML( $this->getHTML() );
172		}
173
174		$wgOut->output();
175		} else {
176		self::header( 'Content-Type: text/html; charset=utf-8' );
177		echo "<!DOCTYPE html>\n" .
178		'<html><head>' .
179		// Mimick OutputPage::setPageTitle behaviour
180		'<title>' .
181		htmlspecialchars( $this->msg( 'pagetitle', "$1 - $wgSitename", $this->getPageTitle() ) ) .
182		'</title>' .
183		'<style>body { font-family: sans-serif; margin: 0; padding: 0.5em 2em; }</style>' .
184		"</head><body>\n";
185
186		$hookResult = $this->runHooks( get_class( $this ) . 'Raw' );
187		if ( $hookResult ) {
		0 ignored issues – show Bug Best Practice introduced 2016-09-15 18:30 UTC by Report Bug Copy Issue Report Show Similar Issues like this The expression `$hookResult` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
188		echo $hookResult;
189		} else {
190		echo $this->getHTML();
191		}
192
193		echo "</body></html>\n";
194		}
195		}
196
197		/**
198		* Output a report about the exception and takes care of formatting.
199		* It will be either HTML or plain text based on isCommandLine().
200		*/
201		public function report() {
202		global $wgMimeType;
203
204		if ( defined( 'MW_API' ) ) {
205		// Unhandled API exception, we can't be sure that format printer is alive
206		self::header( 'MediaWiki-API-Error: internal_api_error_' . get_class( $this ) );
207		wfHttpError( 500, 'Internal Server Error', $this->getText() );
208		} elseif ( self::isCommandLine() ) {
209		$message = $this->getText();
210		// T17602: STDERR may not be available
211		if ( defined( 'STDERR' ) ) {
212		fwrite( STDERR, $message );
213		} else {
214		echo $message;
215		}
216		} else {
217		self::statusHeader( 500 );
218		self::header( "Content-Type: $wgMimeType; charset=utf-8" );
219
220		$this->reportHTML();
221		}
222		}
223
224		/**
225		* Check whether we are in command line mode or not to report the exception
226		* in the correct format.
227		*
228		* @return bool
229		*/
230		public static function isCommandLine() {
		0 ignored issues – show Coding Style introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report Show Similar Issues like this `isCommandLine` uses the super-global variable `$GLOBALS` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
231		return !empty( $GLOBALS['wgCommandLineMode'] );
232		}
233
234		/**
235		* Send a header, if we haven't already sent them. We shouldn't,
236		* but sometimes we might in a weird case like Export
237		* @param string $header
238		*/
239		private static function header( $header ) {
240		if ( !headers_sent() ) {
241		header( $header );
242		}
243		}
244		private static function statusHeader( $code ) {
245		if ( !headers_sent() ) {
246		HttpStatus::header( $code );
247		}
248		}
249		}
250

wikimedia / mediawiki

Issues (4122)

Security Analysis not enabled

includes/exception/MWException.php (5 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like