X-Git-Url: http://git.cyclocoop.org/?a=blobdiff_plain;f=includes%2FException.php;h=ddcd739152c381127b78bd5765fdd36005bbc39f;hb=e46c9a91fd9ab6f9e1e41ffbfb31551a92b95307;hp=81cf12f6d9d1d88c8f911b727d6a98400fb00d35;hpb=f9619da3f02b4759ae92250c483d4bf14dfd9ee8;p=lhc%2Fweb%2Fwiklou.git

diff --git a/includes/Exception.php b/includes/Exception.php
index 81cf12f6d9..ddcd739152 100644
--- a/includes/Exception.php
+++ b/includes/Exception.php
@@ -1,20 +1,74 @@
 <?php
+/**
+ * @defgroup Exception Exception
+ */
 
 /**
- * @addtogroup Exception
+ * MediaWiki exception
+ * @ingroup Exception
  */
-class MWException extends Exception
-{
+class MWException extends Exception {
+	/**
+	 * Should the exception use $wgOut to output the error ?
+	 * @return bool
+	 */
 	function useOutputPage() {
-		return !empty( $GLOBALS['wgFullyInitialised'] ) && 
-			!empty( $GLOBALS['wgArticle'] ) && !empty( $GLOBALS['wgTitle'] );
+		return $this->useMessageCache() &&
+			!empty( $GLOBALS['wgFullyInitialised'] ) &&
+			( !empty( $GLOBALS['wgArticle'] ) || ( !empty( $GLOBALS['wgOut'] ) && !$GLOBALS['wgOut']->isArticle() ) ) &&
+			!empty( $GLOBALS['wgTitle'] );
 	}
 
+	/**
+	 * Can the extension use wfMsg() to get i18n messages ?
+	 * @return bool
+	 */
 	function useMessageCache() {
 		global $wgLang;
+		foreach ( $this->getTrace() as $frame ) {
+			if ( isset( $frame['class'] ) && $frame['class'] === 'LocalisationCache' ) {
+				return false;
+			}
+		}
 		return is_object( $wgLang );
 	}
 
+	/**
+	 * Run hook to allow extensions to modify the text of the exception
+	 *
+	 * @param $name String: class name of the exception
+	 * @param $args Array: arguments to pass to the callback functions
+	 * @return Mixed: string to output or null if any hook has been called
+	 */
+	function runHooks( $name, $args = array() ) {
+		global $wgExceptionHooks;
+		if( !isset( $wgExceptionHooks ) || !is_array( $wgExceptionHooks ) )
+			return;	// Just silently ignore
+		if( !array_key_exists( $name, $wgExceptionHooks ) || !is_array( $wgExceptionHooks[ $name ] ) )
+			return;
+		$hooks = $wgExceptionHooks[ $name ];
+		$callargs = array_merge( array( $this ), $args );
+
+		foreach( $hooks as $hook ) {
+			if( is_string( $hook ) || ( is_array( $hook ) && count( $hook ) >= 2 && is_string( $hook[0] ) ) ) {	//'function' or array( 'class', hook' )
+				$result = call_user_func_array( $hook, $callargs );
+			} else {
+				$result = null;
+			}
+			if( is_string( $result ) )
+				return $result;
+		}
+	}
+
+	/**
+	 * Get a message from i18n
+	 *
+	 * @param $key String: message name
+	 * @param $fallback String: 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
+	 */
 	function msg( $key, $fallback /*[, params...] */ ) {
 		$args = array_slice( func_get_args(), 2 );
 		if ( $this->useMessageCache() ) {
@@ -24,29 +78,42 @@ class MWException extends Exception
 		}
 	}
 
+	/**
+	 * 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
+	 */
 	function getHTML() {
 		global $wgShowExceptionDetails;
 		if( $wgShowExceptionDetails ) {
-			return '<p>' . htmlspecialchars( $this->getMessage() ) . 
+			return '<p>' . nl2br( htmlspecialchars( $this->getMessage() ) ) .
 				'</p><p>Backtrace:</p><p>' . nl2br( htmlspecialchars( $this->getTraceAsString() ) ) .
 				"</p>\n";
 		} else {
 			return "<p>Set <b><tt>\$wgShowExceptionDetails = true;</tt></b> " .
-				"in LocalSettings.php to show detailed debugging information.</p>";
+				"at the bottom of LocalSettings.php to show detailed " .
+				"debugging information.</p>";
 		}
 	}
 
+	/**
+	 * If $wgShowExceptionDetails is true, return a text message with a
+	 * backtrace to the error.
+	 */
 	function getText() {
 		global $wgShowExceptionDetails;
 		if( $wgShowExceptionDetails ) {
 			return $this->getMessage() .
 				"\nBacktrace:\n" . $this->getTraceAsString() . "\n";
 		} else {
-			return "<p>Set <tt>\$wgShowExceptionDetails = true;</tt> " .
-				"in LocalSettings.php to show detailed debugging information.</p>";
+			return "Set \$wgShowExceptionDetails = true; " .
+				"in LocalSettings.php to show detailed debugging information.\n";
 		}
 	}
-	
+
+	/* Return titles of this error page */
 	function getPageTitle() {
 		if ( $this->useMessageCache() ) {
 			return wfMsg( 'internalerror' );
@@ -55,50 +122,80 @@ class MWException extends Exception
 			return "$wgSitename error";
 		}
 	}
-	
+
+	/**
+	 * Return the requested URL and point to file and line number from which the
+	 * exception occured
+	 *
+	 * @return String
+	 */
 	function getLogMessage() {
 		global $wgRequest;
 		$file = $this->getFile();
 		$line = $this->getLine();
 		$message = $this->getMessage();
-		return $wgRequest->getRequestURL() . " Exception from line $line of $file: $message";
+		if ( isset( $wgRequest ) ) {
+			$url = $wgRequest->getRequestURL();
+			if ( !$url ) {
+				$url = '[no URL]';
+			}
+		} else {
+			$url = '[no req]';
+		}
+
+		return "$url   Exception from line $line of $file: $message";
 	}
-	
+
+	/** Output the exception report using HTML */
 	function reportHTML() {
 		global $wgOut;
 		if ( $this->useOutputPage() ) {
 			$wgOut->setPageTitle( $this->getPageTitle() );
-			$wgOut->setRobotpolicy( "noindex,nofollow" );
+			$wgOut->setRobotPolicy( "noindex,nofollow" );
 			$wgOut->setArticleRelated( false );
 			$wgOut->enableClientCache( false );
 			$wgOut->redirect( '' );
 			$wgOut->clearHTML();
-			$wgOut->addHTML( $this->getHTML() );
+			if( $hookResult = $this->runHooks( get_class( $this ) ) ) {
+				$wgOut->addHTML( $hookResult );
+			} else {
+				$wgOut->addHTML( $this->getHTML() );
+			}
 			$wgOut->output();
 		} else {
-			echo $this->htmlHeader();
-			echo $this->getHTML();
-			echo $this->htmlFooter();
+			if( $hookResult = $this->runHooks( get_class( $this ) . "Raw" ) ) {
+				die( $hookResult );
+			}
+			if ( defined( 'MEDIAWIKI_INSTALL' ) || $this->htmlBodyOnly() ) {
+				echo $this->getHTML();
+			} else {
+				echo $this->htmlHeader();
+				echo $this->getHTML();
+				echo $this->htmlFooter();
+			}
 		}
 	}
-	
-	function reportText() {
-		echo $this->getText();
-	}
 
+	/**
+	 * Output a report about the exception and takes care of formatting.
+	 * It will be either HTML or plain text based on isCommandLine().
+	 */
 	function report() {
-		global $wgCommandLineMode;
-		if ( $wgCommandLineMode ) {
-			$this->reportText();
+		$log = $this->getLogMessage();
+		if ( $log ) {
+			wfDebugLog( 'exception', $log );
+		}
+		if ( self::isCommandLine() ) {
+			wfPrintError( $this->getText() );
 		} else {
-			$log = $this->getLogMessage();
-			if ( $log ) {
-				wfDebugLog( 'exception', $log );
-			}
 			$this->reportHTML();
 		}
 	}
 
+	/**
+	 * Send headers and output the beginning of the html page if not using
+	 * $wgOut to output the exception.
+	 */
 	function htmlHeader() {
 		global $wgLogo, $wgSitename, $wgOutputEncoding;
 
@@ -110,25 +207,38 @@ class MWException extends Exception
 			header( 'Pragma: nocache' );
 		}
 		$title = $this->getPageTitle();
-		echo "<html>
+		return "<html>
 		<head>
 		<title>$title</title>
 		</head>
 		<body>
-		<h1><img src='$wgLogo' style='float:left;margin-right:1em' alt=''>$title</h1>
+		<h1><img src='$wgLogo' style='float:left;margin-right:1em' alt=''/>$title</h1>
 		";
 	}
 
+	/**
+	 * print the end of the html page if not using $wgOut.
+	 */
 	function htmlFooter() {
-		echo "</body></html>";
+		return "</body></html>";
+	}
+	
+	/**
+	 * headers handled by subclass?
+	 */
+	function htmlBodyOnly() {
+		return false;
 	}
 
+	static function isCommandLine() {
+		return !empty( $GLOBALS['wgCommandLineMode'] ) && !defined( 'MEDIAWIKI_INSTALL' );
+	}
 }
 
 /**
  * Exception class which takes an HTML error message, and does not
  * produce a backtrace. Replacement for OutputPage::fatalError().
- * @addtogroup Exception
+ * @ingroup Exception
  */
 class FatalError extends MWException {
 	function getHTML() {
@@ -141,11 +251,11 @@ class FatalError extends MWException {
 }
 
 /**
- * @addtogroup Exception
+ * @ingroup Exception
  */
 class ErrorPageError extends MWException {
 	public $title, $msg;
-	
+
 	/**
 	 * Note: these arguments are keys into wfMsg(), not text!
 	 */
@@ -173,27 +283,53 @@ function wfInstallExceptionHandler() {
  * Report an exception to the user
  */
 function wfReportException( Exception $e ) {
-	 if ( $e instanceof MWException ) {
-		 try {
-			 $e->report();
-		 } catch ( Exception $e2 ) {
-			 // Exception occurred from within exception handler
-			 // Show a simpler error message for the original exception,
-			 // don't try to invoke report()
-			 $message = "MediaWiki internal error.\n\n" .
-			 "Original exception: " . $e->__toString() .
-			 "\n\nException caught inside exception handler: " .
-			 $e2->__toString() . "\n";
-
-			 if ( !empty( $GLOBALS['wgCommandLineMode'] ) ) {
-				 echo $message;
-			 } else {
-				 echo nl2br( htmlspecialchars( $message ) ). "\n";
-			 }
-		 }
-	 } else {
-		 echo $e->__toString();
-	 }
+	$cmdLine = MWException::isCommandLine();
+	if ( $e instanceof MWException ) {
+		try {
+			$e->report();
+		} catch ( Exception $e2 ) {
+			// Exception occurred from within exception handler
+			// Show a simpler error message for the original exception,
+			// don't try to invoke report()
+			$message = "MediaWiki internal error.\n\n";
+			if ( $GLOBALS['wgShowExceptionDetails'] )
+				$message .= "Original exception: " . $e->__toString();
+			$message .= "\n\nException caught inside exception handler";
+			if ( $GLOBALS['wgShowExceptionDetails'] )
+				$message .= ": " . $e2->__toString();
+			$message .= "\n";
+			if ( $cmdLine ) {
+				wfPrintError( $message );
+			} else {
+				echo nl2br( htmlspecialchars( $message ) ). "\n";
+			}
+		}
+	} else {
+		$message = "Unexpected non-MediaWiki exception encountered, of type \"" . get_class( $e ) . "\"\n" .
+			$e->__toString() . "\n";
+		if ( $GLOBALS['wgShowExceptionDetails'] ) {
+			$message .= "\n" . $e->getTraceAsString() ."\n";
+		}
+		if ( $cmdLine ) {
+			wfPrintError( $message );
+		} else {
+			echo nl2br( htmlspecialchars( $message ) ). "\n";
+		}
+	}
+}
+
+/**
+ * Print a message, if possible to STDERR.
+ * Use this in command line mode only (see isCommandLine)
+ */
+function wfPrintError( $message ) {
+	#NOTE: STDERR may not be available, especially if php-cgi is used from the command line (bug #15602).
+	#      Try to produce meaningful output anyway. Using echo may corrupt output to STDOUT though.
+	if ( defined( 'STDERR' ) ) {
+		fwrite( STDERR, $message );
+	} else {
+		echo( $message );
+	}
 }
 
 /**
@@ -210,7 +346,7 @@ function wfReportException( Exception $e ) {
 function wfExceptionHandler( $e ) {
 	global $wgFullyInitialised;
 	wfReportException( $e );
-	
+
 	// Final cleanup, similar to wfErrorExit()
 	if ( $wgFullyInitialised ) {
 		try {
@@ -221,5 +357,3 @@ function wfExceptionHandler( $e ) {
 	// Exit value should be nonzero for the benefit of shell jobs
 	exit( 1 );
 }
-
-?>