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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
<?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\Specials;
use ErrorPageError;
use MediaWiki\HTMLForm\HTMLForm;
use MediaWiki\Session\SessionManager;
use MediaWiki\SpecialPage\FormSpecialPage;
use MediaWiki\SpecialPage\SpecialPage;
use MediaWiki\Status\Status;
use MediaWiki\User\TempUser\TempUserConfig;
/**
* Implements Special:Userlogout
*
* @ingroup SpecialPage
* @ingroup Auth
*/
class SpecialUserLogout extends FormSpecialPage {
/**
* @var string|null
*/
private $oldUserName;
private TempUserConfig $tempUserConfig;
public function __construct( TempUserConfig $tempUserConfig ) {
parent::__construct( 'Userlogout' );
$this->tempUserConfig = $tempUserConfig;
}
public function doesWrites() {
return true;
}
public function isListed() {
return $this->getAuthManager()->canAuthenticateNow();
}
protected function getGroupName() {
return 'login';
}
protected function getFormFields() {
return [];
}
protected function getDisplayFormat() {
return 'ooui';
}
public function execute( $par ) {
$user = $this->getUser();
if ( $user->isAnon() ) {
$this->setHeaders();
$this->showSuccess();
return;
}
$this->oldUserName = $user->getName();
parent::execute( $par );
}
public function alterForm( HTMLForm $form ) {
$form->setTokenSalt( 'logoutToken' );
$form->addHeaderHtml( $this->msg(
$this->getUser()->isTemp() ? 'userlogout-temp' : 'userlogout-continue'
) );
$form->addHiddenFields( $this->getRequest()->getValues( 'returnto', 'returntoquery' ) );
}
/**
* Process the form. At this point we know that the user passes all the criteria in
* userCanExecute(), and if the data array contains 'Username', etc, then Username
* resets are allowed.
* @param array $data
* @return Status
*/
public function onSubmit( array $data ) {
// Make sure it's possible to log out
$session = SessionManager::getGlobalSession();
if ( !$session->canSetUser() ) {
throw new ErrorPageError(
'cannotlogoutnow-title',
'cannotlogoutnow-text',
[
$session->getProvider()->describe( $this->getLanguage() )
]
);
}
$user = $this->getUser();
$user->logout();
return new Status();
}
public function onSuccess() {
$this->showSuccess();
$out = $this->getOutput();
// Hook.
$injected_html = '';
$this->getHookRunner()->onUserLogoutComplete( $this->getUser(), $injected_html, $this->oldUserName );
$out->addHTML( $injected_html );
}
private function showSuccess() {
$loginURL = SpecialPage::getTitleFor( 'Userlogin' )->getFullURL(
$this->getRequest()->getValues( 'returnto', 'returntoquery' ) );
$out = $this->getOutput();
$messageKey = 'logouttext';
if (
( $this->oldUserName !== null && $this->tempUserConfig->isTempName( $this->oldUserName ) ) ||
$this->getRequest()->getCheck( 'wasTempUser' )
) {
// Generates the message key logouttext-for-temporary-account which is used to customise the success
// message for a temporary account.
$messageKey .= '-for-temporary-account';
}
$out->addWikiMsg( $messageKey, $loginURL );
$out->returnToMain();
}
/**
* Let blocked users to log out and come back with their sockpuppets
* @return bool
*/
public function requiresUnblock() {
return false;
}
public function getDescription() {
// Set the page title as "templogout" if the user is (or just was) logged in to a temporary account
if (
$this->getUser()->isTemp() ||
( $this->oldUserName !== null && $this->tempUserConfig->isTempName( $this->oldUserName ) ) ||
$this->getRequest()->getCheck( 'wasTempUser' )
) {
return $this->msg( 'templogout' );
}
return parent::getDescription();
}
}
/**
* Retain the old class name for backwards compatibility.
* @deprecated since 1.41
*/
class_alias( SpecialUserLogout::class, 'SpecialUserLogout' );
|
