1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
<?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
*/
namespace MediaWiki\Exception;
use LoginHelper;
use MediaWiki\Context\RequestContext;
use MediaWiki\SpecialPage\SpecialPage;
/**
* Redirect a user to the login page or account creation page
*
* This is essentially an ErrorPageError exception which by default uses the
* 'exception-nologin' as a title and 'exception-nologin-text' for the message.
*
* When the user is a temporary account, the redirect will point to the Special:CreateAccount page unless
* specifically set not to. In all other cases, the redirect is to the Special:UserLogin page.
*
* The message key for the reason will be modified to include '-for-temp-user' when the user is logged
* in to a temporary account and this message key exists (i.e. defined and not empty).
*
* @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
*
* You can use {@link SpecialPage::requireLogin} and {@link SpecialPage::requireNamedUser} to throw this
* exception when the user is an anon user or not named respectively.
*
* @newable
* @see T39627
* @since 1.20
* @ingroup Exception
*/
class UserNotLoggedIn extends ErrorPageError {
private bool $alwaysRedirectToLoginPage;
/**
* @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. '-for-temp-user' will be
* appended to the end of the message key if the user is a temporary account and the redirect is
* to the Special:CreateAccount page. The modification is skipped if the message key does not
* exist.
* 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() for $reasonMsg and $tempUserReasonMsg
* Optional, default: []
* @param bool $alwaysRedirectToLoginPage Whether we should always redirect to the login page, even if the
* user is a temporary account. If false (the default), the redirect will be to Special:CreateAccount
* when the user is logged in to a temporary account.
*/
public function __construct(
$reasonMsg = 'exception-nologin-text',
$titleMsg = 'exception-nologin',
$params = [],
bool $alwaysRedirectToLoginPage = false
) {
$context = RequestContext::getMain();
// Replace the reason message for one that describes creating account when the user is a temporary account
// when such a custom message exists (T358586).
if ( $context->getUser()->isTemp() && !$alwaysRedirectToLoginPage ) {
// For grep to find usages: exception-nologin-text-for-temp-user
$tempUserReasonMsg = $reasonMsg . '-for-temp-user';
if ( $context->msg( $tempUserReasonMsg )->exists() ) {
$reasonMsg = $tempUserReasonMsg;
}
}
parent::__construct( $titleMsg, $reasonMsg, $params );
$this->alwaysRedirectToLoginPage = $alwaysRedirectToLoginPage;
}
/**
* Redirect to Special:Userlogin or Special:CreateAccount 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;
}
$context = RequestContext::getMain();
// Message is valid. Redirect to Special:Userlogin, unless the user is a temporary account in which case
// redirect to Special:CreateAccount (T358586).
$specialPageName = 'Userlogin';
if ( $context->getUser()->isTemp() && !$this->alwaysRedirectToLoginPage ) {
$specialPageName = 'CreateAccount';
}
$output = $context->getOutput();
$query = $context->getRequest()->getQueryValues();
// Title will be overridden by returnto
unset( $query['title'] );
// Redirect to Special:Userlogin
$output->redirect( SpecialPage::getTitleFor( $specialPageName )->getFullURL( [
// Return to this page when the user logs in
'returnto' => $context->getTitle()->getFullText(),
'returntoquery' => wfArrayToCgi( $query ),
'warning' => $this->msg,
// Forward the 'display' parameter if provided
'display' => $query['display'] ?? null,
] ) );
if ( $action === self::SEND_OUTPUT ) {
$output->output();
}
}
}
/** @deprecated class alias since 1.44 */
class_alias( UserNotLoggedIn::class, 'UserNotLoggedIn' );
|
