Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F7425908
SpecialUserLogout.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
4 KB
Referenced Files
None
Subscribers
None
SpecialUserLogout.php
View Options
<?php
/**
* @license GPL-2.0-or-later
* @file
*/
namespace
MediaWiki\Specials
;
use
MediaWiki\Exception\ErrorPageError
;
use
MediaWiki\Html\Html
;
use
MediaWiki\HTMLForm\HTMLForm
;
use
MediaWiki\SpecialPage\FormSpecialPage
;
use
MediaWiki\SpecialPage\SpecialPage
;
use
MediaWiki\Status\Status
;
use
MediaWiki\User\TempUser\TempUserConfig
;
use
OOUI\HtmlSnippet
;
use
OOUI\MessageWidget
;
/**
* 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
;
}
/** @inheritDoc */
public
function
doesWrites
()
{
return
true
;
}
/** @inheritDoc */
public
function
isListed
()
{
return
$this
->
getAuthManager
()->
canAuthenticateNow
();
}
/** @inheritDoc */
protected
function
getGroupName
()
{
return
'login'
;
}
/** @inheritDoc */
protected
function
getFormFields
()
{
return
[];
}
/** @inheritDoc */
protected
function
getDisplayFormat
()
{
return
'ooui'
;
}
/** @inheritDoc */
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
->
setSubmitTextMsg
(
'userlogout-submit'
);
if
(
$this
->
getUser
()->
isTemp
()
)
{
$form
->
addHeaderHtml
(
Html
::
rawElement
(
'p'
,
[],
$this
->
msg
(
'userlogout-temp'
)
)
.
Html
::
rawElement
(
'p'
,
[],
$this
->
msg
(
'userlogout-temp-moreinfo'
)
)
.
new
MessageWidget
(
[
'type'
=>
'notice'
,
'label'
=>
new
HtmlSnippet
(
Html
::
rawElement
(
'strong'
,
[],
$this
->
msg
(
'userlogout-temp-messagebox-title'
)
)
.
Html
::
element
(
'br'
)
.
$this
->
msg
(
'userlogout-temp-messagebox-body'
)
),
]
)
);
}
else
{
$form
->
addHeaderHtml
(
Html
::
rawElement
(
'p'
,
[],
$this
->
msg
(
'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
=
$this
->
getRequest
()->
getSession
();
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
;
}
/** @inheritDoc */
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'
);
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Sun, Nov 22, 08:09 (19 h, 16 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
6e/8a/7808b607c40a4b64bd98edbb389c
Default Alt Text
SpecialUserLogout.php (4 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment