3 * Implements Special:Userlogout
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup SpecialPage
25 * Implements Special:Userlogout
27 * @ingroup SpecialPage
29 class SpecialUserLogout
extends FormSpecialPage
{
30 function __construct() {
31 parent
::__construct( 'Userlogout' );
34 public function doesWrites() {
38 public function isListed() {
42 protected function getGroupName() {
46 protected function getFormFields() {
50 protected function getDisplayFormat() {
54 public function execute( $par ) {
55 if ( $this->getUser()->isAnon() ) {
61 parent
::execute( $par );
64 public function alterForm( HTMLForm
$form ) {
65 $form->setTokenSalt( 'logoutToken' );
66 $form->addHeaderText( $this->msg( 'userlogout-continue' ) );
68 $form->addHiddenFields( $this->getRequest()->getValues( 'returnto', 'returntoquery' ) );
72 * Process the form. At this point we know that the user passes all the criteria in
73 * userCanExecute(), and if the data array contains 'Username', etc, then Username
77 * @throws ThrottledError|PermissionsError
80 public function onSubmit( array $data ) {
81 // Make sure it's possible to log out
82 $session = MediaWiki\Session\SessionManager
::getGlobalSession();
83 if ( !$session->canSetUser() ) {
84 throw new ErrorPageError(
85 'cannotlogoutnow-title',
86 'cannotlogoutnow-text',
88 $session->getProvider()->describe( RequestContext
::getMain()->getLanguage() )
93 $user = $this->getUser();
99 public function onSuccess() {
100 $this->showSuccess();
102 $user = $this->getUser();
103 $oldName = $user->getName();
104 $out = $this->getOutput();
107 Hooks
::run( 'UserLogoutComplete', [ &$user, &$injected_html, $oldName ] );
108 $out->addHTML( $injected_html );
111 private function showSuccess() {
112 $loginURL = SpecialPage
::getTitleFor( 'Userlogin' )->getFullURL(
113 $this->getRequest()->getValues( 'returnto', 'returntoquery' ) );
115 $out = $this->getOutput();
116 $out->addWikiMsg( 'logouttext', $loginURL );
118 $out->returnToMain();
122 * Let blocked users to log out and come back with their sockpuppets
124 public function requiresUnblock() {