includes/specials/SpecialPreferences.php

   1 <?php
   2 /**
   3  * Implements Special:Preferences
   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 use MediaWiki\MediaWikiServices;
  25
  26 /**
  27  * A special page that allows users to change their preferences
  28  *
  29  * @ingroup SpecialPage
  30  */
  31 class SpecialPreferences extends SpecialPage {
  32         function __construct() {
  33                 parent::__construct( 'Preferences' );
  34         }
  35
  36         public function doesWrites() {
  37                 return true;
  38         }
  39
  40         public function execute( $par ) {
  41                 $this->setHeaders();
  42                 $this->outputHeader();
  43                 $out = $this->getOutput();
  44                 $out->disallowUserJs(); # Prevent hijacked user scripts from sniffing passwords etc.
  45
  46                 $this->requireLogin( 'prefsnologintext2' );
  47                 $this->checkReadOnly();
  48
  49                 if ( $par == 'reset' ) {
  50                         $this->showResetForm();
  51
  52                         return;
  53                 }
  54
  55                 $out->addModules( 'mediawiki.special.preferences.ooui' );
  56                 $out->addModuleStyles( [
  57                         'mediawiki.special.preferences.styles.ooui',
  58                         'mediawiki.widgets.TagMultiselectWidget.styles',
  59                 ] );
  60                 $out->addModuleStyles( 'oojs-ui-widgets.styles' );
  61
  62                 $session = $this->getRequest()->getSession();
  63                 if ( $session->get( 'specialPreferencesSaveSuccess' ) ) {
  64                         // Remove session data for the success message
  65                         $session->remove( 'specialPreferencesSaveSuccess' );
  66                         $out->addModuleStyles( 'mediawiki.notification.convertmessagebox.styles' );
  67
  68                         $out->addHTML(
  69                                 Html::rawElement(
  70                                         'div',
  71                                         [
  72                                                 'class' => 'mw-preferences-messagebox mw-notify-success successbox',
  73                                                 'id' => 'mw-preferences-success',
  74                                                 'data-mw-autohide' => 'false',
  75                                         ],
  76                                         Html::element( 'p', [], $this->msg( 'savedprefs' )->text() )
  77                                 )
  78                         );
  79                 }
  80
  81                 $this->addHelpLink( 'Help:Preferences' );
  82
  83                 // Load the user from the master to reduce CAS errors on double post (T95839)
  84                 if ( $this->getRequest()->wasPosted() ) {
  85                         $user = $this->getUser()->getInstanceForUpdate() ?: $this->getUser();
  86                 } else {
  87                         $user = $this->getUser();
  88                 }
  89
  90                 $htmlForm = $this->getFormObject( $user, $this->getContext() );
  91                 $sectionTitles = $htmlForm->getPreferenceSections();
  92
  93                 $prefTabs = [];
  94                 foreach ( $sectionTitles as $key ) {
  95                         $prefTabs[] = [
  96                                 'name' => $key,
  97                                 'label' => $htmlForm->getLegend( $key ),
  98                         ];
  99                 }
 100                 $out->addJsConfigVars( 'wgPreferencesTabs', $prefTabs );
 101
 102                 $htmlForm->show();
 103         }
 104
 105         /**
 106          * Get the preferences form to use.
 107          * @param User $user The user.
 108          * @param IContextSource $context The context.
 109          * @return PreferencesFormOOUI|HTMLForm
 110          */
 111         protected function getFormObject( $user, IContextSource $context ) {
 112                 $preferencesFactory = MediaWikiServices::getInstance()->getPreferencesFactory();
 113                 $form = $preferencesFactory->getForm( $user, $context, PreferencesFormOOUI::class );
 114                 return $form;
 115         }
 116
 117         protected function showResetForm() {
 118                 if ( !MediaWikiServices::getInstance()
 119                                 ->getPermissionManager()
 120                                 ->userHasRight( $this->getUser(), 'editmyoptions' )
 121                 ) {
 122                         throw new PermissionsError( 'editmyoptions' );
 123                 }
 124
 125                 $this->getOutput()->addWikiMsg( 'prefs-reset-intro' );
 126
 127                 $context = new DerivativeContext( $this->getContext() );
 128                 $context->setTitle( $this->getPageTitle( 'reset' ) ); // Reset subpage
 129                 $htmlForm = HTMLForm::factory( 'ooui', [], $context, 'prefs-restore' );
 130
 131                 $htmlForm->setSubmitTextMsg( 'restoreprefs' );
 132                 $htmlForm->setSubmitDestructive();
 133                 $htmlForm->setSubmitCallback( [ $this, 'submitReset' ] );
 134                 $htmlForm->suppressReset();
 135
 136                 $htmlForm->show();
 137         }
 138
 139         public function submitReset( $formData ) {
 140                 if ( !MediaWikiServices::getInstance()
 141                                 ->getPermissionManager()
 142                                 ->userHasRight( $this->getUser(), 'editmyoptions' )
 143                 ) {
 144                         throw new PermissionsError( 'editmyoptions' );
 145                 }
 146
 147                 $user = $this->getUser()->getInstanceForUpdate();
 148                 $user->resetOptions( 'all', $this->getContext() );
 149                 $user->saveSettings();
 150
 151                 // Set session data for the success message
 152                 $this->getRequest()->getSession()->set( 'specialPreferencesSaveSuccess', 1 );
 153
 154                 $url = $this->getPageTitle()->getFullUrlForRedirect();
 155                 $this->getOutput()->redirect( $url );
 156
 157                 return true;
 158         }
 159
 160         protected function getGroupName() {
 161                 return 'users';
 162         }
 163 }