includes/specials/SpecialUserLogout.php

   1 <?php
   2 /**
   3  * Implements Special:Userlogout
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @ingroup SpecialPage
  22  */
  23
  24 /**
  25  * Implements Special:Userlogout
  26  *
  27  * @ingroup SpecialPage
  28  */
  29 class SpecialUserLogout extends FormSpecialPage {
  30         function __construct() {
  31                 parent::__construct( 'Userlogout' );
  32         }
  33
  34         public function doesWrites() {
  35                 return true;
  36         }
  37
  38         public function isListed() {
  39                 return false;
  40         }
  41
  42         protected function getGroupName() {
  43                 return 'login';
  44         }
  45
  46         protected function getFormFields() {
  47                 return [];
  48         }
  49
  50         protected function getDisplayFormat() {
  51                 return 'ooui';
  52         }
  53
  54         public function execute( $par ) {
  55                 if ( $this->getUser()->isAnon() ) {
  56                         $this->setHeaders();
  57                         $this->showSuccess();
  58                         return;
  59                 }
  60
  61                 parent::execute( $par );
  62         }
  63
  64         public function alterForm( HTMLForm $form ) {
  65                 $form->setTokenSalt( 'logoutToken' );
  66                 $form->addHeaderText( $this->msg( 'userlogout-continue' ) );
  67
  68                 $form->addHiddenFields( $this->getRequest()->getValues( 'returnto', 'returntoquery' ) );
  69         }
  70
  71         /**
  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
  74          * resets are allowed.
  75          * @param array $data
  76          * @throws MWException
  77          * @throws ThrottledError|PermissionsError
  78          * @return Status
  79          */
  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',
  87                                 [
  88                                         $session->getProvider()->describe( RequestContext::getMain()->getLanguage() )
  89                                 ]
  90                         );
  91                 }
  92
  93                 $user = $this->getUser();
  94
  95                 $user->logout();
  96                 return new Status();
  97         }
  98
  99         public function onSuccess() {
 100                 $this->showSuccess();
 101
 102                 $user = $this->getUser();
 103                 $oldName = $user->getName();
 104                 $out = $this->getOutput();
 105                 // Hook.
 106                 $injected_html = '';
 107                 Hooks::run( 'UserLogoutComplete', [ &$user, &$injected_html, $oldName ] );
 108                 $out->addHTML( $injected_html );
 109         }
 110
 111         private function showSuccess() {
 112                 $loginURL = SpecialPage::getTitleFor( 'Userlogin' )->getFullURL(
 113                         $this->getRequest()->getValues( 'returnto', 'returntoquery' ) );
 114
 115                 $out = $this->getOutput();
 116                 $out->addWikiMsg( 'logouttext', $loginURL );
 117
 118                 $out->returnToMain();
 119         }
 120
 121         /**
 122          * Let blocked users to log out and come back with their sockpuppets
 123          */
 124         public function requiresUnblock() {
 125                 return false;
 126         }
 127 }