11e3172c03
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
106 lines
3.4 KiB
PHP
106 lines
3.4 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
|
|
*/
|
|
|
|
/**
|
|
* Redirect a user to the login page
|
|
*
|
|
* This is essentially an ErrorPageError exception which by default uses the
|
|
* 'exception-nologin' as a title and 'exception-nologin-text' for the message.
|
|
*
|
|
* @note In order for this exception to redirect, the error message passed to the
|
|
* constructor has to be explicitly added to LoginHelper::validErrorMessages or with
|
|
* the LoginFormValidErrorMessages hook. Otherwise, the user will just be shown the message
|
|
* rather than redirected.
|
|
*
|
|
* @par Example:
|
|
* @code
|
|
* if( $user->isAnon() ) {
|
|
* throw new UserNotLoggedIn();
|
|
* }
|
|
* @endcode
|
|
*
|
|
* Note the parameter order differs from ErrorPageError, this allows you to
|
|
* simply specify a reason without overriding the default title.
|
|
*
|
|
* @par Example:
|
|
* @code
|
|
* if( $user->isAnon() ) {
|
|
* throw new UserNotLoggedIn( 'action-require-loggedin' );
|
|
* }
|
|
* @endcode
|
|
*
|
|
* @see T39627
|
|
* @since 1.20
|
|
* @ingroup Exception
|
|
*/
|
|
class UserNotLoggedIn extends ErrorPageError {
|
|
|
|
/**
|
|
* @note The value of the $reasonMsg parameter must be set with the LoginFormValidErrorMessages
|
|
* hook if you want the user to be automatically redirected to the login form.
|
|
*
|
|
* @param string $reasonMsg A message key containing the reason for the error.
|
|
* Optional, default: 'exception-nologin-text'
|
|
* @param string $titleMsg A message key to set the page title.
|
|
* Optional, default: 'exception-nologin'
|
|
* @param array $params Parameters to wfMessage().
|
|
* Optional, default: []
|
|
*/
|
|
public function __construct(
|
|
$reasonMsg = 'exception-nologin-text',
|
|
$titleMsg = 'exception-nologin',
|
|
$params = []
|
|
) {
|
|
parent::__construct( $titleMsg, $reasonMsg, $params );
|
|
}
|
|
|
|
/**
|
|
* Redirect to Special:Userlogin if the specified message is compatible. Otherwise,
|
|
* show an error page as usual.
|
|
*/
|
|
public function report( $action = self::SEND_OUTPUT ) {
|
|
// If an unsupported message is used, don't try redirecting to Special:Userlogin,
|
|
// since the message may not be compatible.
|
|
if ( !in_array( $this->msg, LoginHelper::getValidErrorMessages() ) ) {
|
|
parent::report( $action );
|
|
return;
|
|
}
|
|
|
|
// Message is valid. Redirect to Special:Userlogin
|
|
|
|
$context = RequestContext::getMain();
|
|
|
|
$output = $context->getOutput();
|
|
$query = $context->getRequest()->getValues();
|
|
// Title will be overridden by returnto
|
|
unset( $query['title'] );
|
|
// Redirect to Special:Userlogin
|
|
$output->redirect( SpecialPage::getTitleFor( 'Userlogin' )->getFullURL( [
|
|
// Return to this page when the user logs in
|
|
'returnto' => $context->getTitle()->getFullText(),
|
|
'returntoquery' => wfArrayToCgi( $query ),
|
|
'warning' => $this->msg,
|
|
] ) );
|
|
|
|
if ( $action === self::SEND_OUTPUT ) {
|
|
$output->output();
|
|
}
|
|
}
|
|
}
|