272db6afde
For compliance with the new version of the table interface policy (T255803). This patch was created by an automated search & replace operation on the includes/ directory. Bug: T257789 Change-Id: If560596f5e1e0a3da91afc36e656e7c27f040968
110 lines
3.5 KiB
PHP
110 lines
3.5 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
|
|
*
|
|
* @newable
|
|
* @see T39627
|
|
* @since 1.20
|
|
* @ingroup Exception
|
|
*/
|
|
class UserNotLoggedIn extends ErrorPageError {
|
|
|
|
/**
|
|
* @stable to call
|
|
*
|
|
* @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.
|
|
* @param int $action
|
|
*/
|
|
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();
|
|
}
|
|
}
|
|
}
|