includes/api/ApiOptions.php

   1 <?php
   2 /**
   3  * Copyright © 2012 Szymon Świerkosz beau@adres.pl
   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  */
  22
  23 use MediaWiki\MediaWikiServices;
  24
  25 /**
  26  * API module that facilitates the changing of user's preferences.
  27  * Requires API write mode to be enabled.
  28  *
  29  * @ingroup API
  30  */
  31 class ApiOptions extends ApiBase {
  32         /** @var User User account to modify */
  33         private $userForUpdates;
  34
  35         /**
  36          * Changes preferences of the current user.
  37          */
  38         public function execute() {
  39                 $user = $this->getUserForUpdates();
  40                 if ( !$user || $user->isAnon() ) {
  41                         $this->dieWithError(
  42                                 [ 'apierror-mustbeloggedin', $this->msg( 'action-editmyoptions' ) ], 'notloggedin'
  43                         );
  44                 }
  45
  46                 $this->checkUserRightsAny( 'editmyoptions' );
  47
  48                 $params = $this->extractRequestParams();
  49                 $changed = false;
  50
  51                 if ( isset( $params['optionvalue'] ) && !isset( $params['optionname'] ) ) {
  52                         $this->dieWithError( [ 'apierror-missingparam', 'optionname' ] );
  53                 }
  54
  55                 if ( $params['reset'] ) {
  56                         $this->resetPreferences( $params['resetkinds'] );
  57                         $changed = true;
  58                 }
  59
  60                 $changes = [];
  61                 if ( $params['change'] ) {
  62                         foreach ( $params['change'] as $entry ) {
  63                                 $array = explode( '=', $entry, 2 );
  64                                 $changes[$array[0]] = $array[1] ?? null;
  65                         }
  66                 }
  67                 if ( isset( $params['optionname'] ) ) {
  68                         $newValue = $params['optionvalue'] ?? null;
  69                         $changes[$params['optionname']] = $newValue;
  70                 }
  71                 if ( !$changed && !count( $changes ) ) {
  72                         $this->dieWithError( 'apierror-nochanges' );
  73                 }
  74
  75                 $prefs = $this->getPreferences();
  76                 $prefsKinds = $user->getOptionKinds( $this->getContext(), $changes );
  77
  78                 $htmlForm = null;
  79                 foreach ( $changes as $key => $value ) {
  80                         switch ( $prefsKinds[$key] ) {
  81                                 case 'registered':
  82                                         // Regular option.
  83                                         if ( $value === null ) {
  84                                                 // Reset it
  85                                                 $validation = true;
  86                                         } else {
  87                                                 // Validate
  88                                                 if ( $htmlForm === null ) {
  89                                                         // We need a dummy HTMLForm for the validate callback...
  90                                                         $htmlForm = new HTMLForm( [], $this );
  91                                                 }
  92                                                 $field = HTMLForm::loadInputFromParameters( $key, $prefs[$key], $htmlForm );
  93                                                 $validation = $field->validate( $value, $user->getOptions() );
  94                                         }
  95                                         break;
  96                                 case 'registered-multiselect':
  97                                 case 'registered-checkmatrix':
  98                                         // A key for a multiselect or checkmatrix option.
  99                                         $validation = true;
 100                                         $value = $value !== null ? (bool)$value : null;
 101                                         break;
 102                                 case 'userjs':
 103                                         // Allow non-default preferences prefixed with 'userjs-', to be set by user scripts
 104                                         if ( strlen( $key ) > 255 ) {
 105                                                 $validation = $this->msg( 'apiwarn-validationfailed-keytoolong', Message::numParam( 255 ) );
 106                                         } elseif ( preg_match( '/[^a-zA-Z0-9_-]/', $key ) !== 0 ) {
 107                                                 $validation = $this->msg( 'apiwarn-validationfailed-badchars' );
 108                                         } else {
 109                                                 $validation = true;
 110                                         }
 111                                         break;
 112                                 case 'special':
 113                                         $validation = $this->msg( 'apiwarn-validationfailed-cannotset' );
 114                                         break;
 115                                 case 'unused':
 116                                 default:
 117                                         $validation = $this->msg( 'apiwarn-validationfailed-badpref' );
 118                                         break;
 119                         }
 120                         if ( $validation === true ) {
 121                                 $this->setPreference( $key, $value );
 122                                 $changed = true;
 123                         } else {
 124                                 $this->addWarning( [ 'apiwarn-validationfailed', wfEscapeWikiText( $key ), $validation ] );
 125                         }
 126                 }
 127
 128                 if ( $changed ) {
 129                         $this->commitChanges();
 130                 }
 131
 132                 $this->getResult()->addValue( null, $this->getModuleName(), 'success' );
 133         }
 134
 135         /**
 136          * Load the user from the master to reduce CAS errors on double post (T95839)
 137          *
 138          * @return null|User
 139          */
 140         protected function getUserForUpdates() {
 141                 if ( !$this->userForUpdates ) {
 142                         $this->userForUpdates = $this->getUser()->getInstanceForUpdate();
 143                 }
 144
 145                 return $this->userForUpdates;
 146         }
 147
 148         /**
 149          * Returns preferences form descriptor
 150          * @return mixed[][]
 151          */
 152         protected function getPreferences() {
 153                 $preferencesFactory = MediaWikiServices::getInstance()->getPreferencesFactory();
 154                 return $preferencesFactory->getFormDescriptor( $this->getUserForUpdates(),
 155                         $this->getContext() );
 156         }
 157
 158         /**
 159          * @param string[] $kinds One or more types returned by User::listOptionKinds() or 'all'
 160          */
 161         protected function resetPreferences( array $kinds ) {
 162                 $this->getUserForUpdates()->resetOptions( $kinds, $this->getContext() );
 163         }
 164
 165         /**
 166          * Sets one user preference to be applied by commitChanges()
 167          *
 168          * @param string $preference
 169          * @param mixed $value
 170          */
 171         protected function setPreference( $preference, $value ) {
 172                 $this->getUserForUpdates()->setOption( $preference, $value );
 173         }
 174
 175         /**
 176          * Applies changes to user preferences
 177          */
 178         protected function commitChanges() {
 179                 $this->getUserForUpdates()->saveSettings();
 180         }
 181
 182         public function mustBePosted() {
 183                 return true;
 184         }
 185
 186         public function isWriteMode() {
 187                 return true;
 188         }
 189
 190         public function getAllowedParams() {
 191                 $optionKinds = User::listOptionKinds();
 192                 $optionKinds[] = 'all';
 193
 194                 return [
 195                         'reset' => false,
 196                         'resetkinds' => [
 197                                 ApiBase::PARAM_TYPE => $optionKinds,
 198                                 ApiBase::PARAM_DFLT => 'all',
 199                                 ApiBase::PARAM_ISMULTI => true
 200                         ],
 201                         'change' => [
 202                                 ApiBase::PARAM_ISMULTI => true,
 203                         ],
 204                         'optionname' => [
 205                                 ApiBase::PARAM_TYPE => 'string',
 206                         ],
 207                         'optionvalue' => [
 208                                 ApiBase::PARAM_TYPE => 'string',
 209                         ],
 210                 ];
 211         }
 212
 213         public function needsToken() {
 214                 return 'csrf';
 215         }
 216
 217         public function getHelpUrls() {
 218                 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Options';
 219         }
 220
 221         protected function getExamplesMessages() {
 222                 return [
 223                         'action=options&reset=&token=123ABC'
 224                                 => 'apihelp-options-example-reset',
 225                         'action=options&change=skin=vector|hideminor=1&token=123ABC'
 226                                 => 'apihelp-options-example-change',
 227                         'action=options&reset=&change=skin=monobook&optionname=nickname&' .
 228                                 'optionvalue=[[User:Beau|Beau]]%20([[User_talk:Beau|talk]])&token=123ABC'
 229                                 => 'apihelp-options-example-complex',
 230                 ];
 231         }
 232 }