wiki.techinc.nl/includes/exception/ErrorPageError.php
Timo Tijhof 11e3172c03 exception: Let MediaWiki.php control final output for ErrorPageError
The same way it does already for non-error output. This makes
it so that doPreOutputCommit() consistently happens between
the staging of output and the actual sending of output.

It is still allowed for code to bypass this, such as for fatal
errors and for handlers that disable OutputPage (like Special:Export).

But for cases where we do want to perform doPreOutputCommit(), it
should be run consistently between staging and sending so that it
can make appropiate decisions based on the current state of
OutputPage.

Previously, the state of OutputPage seen by doPreOutputCommit()
would be the broken/incomplete output of a seemingly succesful
(possibly cacheable) user action, which would then, after
doPreOutputCommit() runs, be completely replaced by $e->report()/
$out->showErrorPage().

This is a prerequisite for being able to reliably send cookie-block
cookies on error pages (next patch).

Bug: T233594
Change-Id: Iaeaf5e55a5868e6be534ddda73f3b56b9d6ef8f0
2019-09-26 07:56:14 +00:00

80 lines
2.7 KiB
PHP

<?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
*/
/**
* An error page which can definitely be safely rendered using the OutputPage.
*
* @since 1.7
* @ingroup Exception
*/
class ErrorPageError extends MWException implements ILocalizedException {
const SEND_OUTPUT = 0;
const STAGE_OUTPUT = 1;
public $title, $msg, $params;
/**
* Note: these arguments are keys into wfMessage(), not text!
*
* @param string|Message $title Message key (string) for page title, or a Message object
* @param string|Message $msg Message key (string) for error text, or a Message object
* @param array $params Array with parameters to wfMessage()
*/
public function __construct( $title, $msg, $params = [] ) {
$this->title = $title;
$this->msg = $msg;
$this->params = $params;
// T46111: Messages in the log files should be in English and not
// customized by the local wiki. So get the default English version for
// passing to the parent constructor. Our overridden report() below
// makes sure that the page shown to the user is not forced to English.
$enMsg = $this->getMessageObject();
$enMsg->inLanguage( 'en' )->useDatabase( false );
parent::__construct( $enMsg->text() );
}
/**
* Return a Message object for this exception
* @since 1.29
* @return Message
*/
public function getMessageObject() {
if ( $this->msg instanceof Message ) {
return clone $this->msg;
}
return wfMessage( $this->msg, $this->params );
}
public function report( $action = self::SEND_OUTPUT ) {
if ( self::isCommandLine() || defined( 'MW_API' ) ) {
parent::report();
} else {
global $wgOut;
$wgOut->showErrorPage( $this->title, $this->msg, $this->params );
// Allow skipping of the final output step, so that web-based page views
// from MediaWiki.php, can inspect the staged OutputPage state, and perform
// graceful shutdown via doPreOutputCommit first, just like for regular
// output when there isn't an error page.
if ( $action === self::SEND_OUTPUT ) {
$wgOut->output();
}
}
}
}