5 * Created on Apr 15, 2012
7 * Copyright © 2012 Szymon Świerkosz beau@adres.pl
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
28 * API module that facilitates the changing of user's preferences.
29 * Requires API write mode to be enabled.
33 class ApiOptions
extends ApiBase
{
36 * Changes preferences of the current user.
38 public function execute() {
39 $user = $this->getUser();
41 if ( $user->isAnon() ) {
42 $this->dieUsage( 'Anonymous users cannot change preferences', 'notloggedin' );
45 $params = $this->extractRequestParams();
48 if ( isset( $params['optionvalue'] ) && !isset( $params['optionname'] ) ) {
49 $this->dieUsageMsg( array( 'missingparam', 'optionname' ) );
52 if ( $params['reset'] ) {
53 $user->resetOptions( $params['resetkinds'] );
58 if ( count( $params['change'] ) ) {
59 foreach ( $params['change'] as $entry ) {
60 $array = explode( '=', $entry, 2 );
61 $changes[$array[0]] = isset( $array[1] ) ?
$array[1] : null;
64 if ( isset( $params['optionname'] ) ) {
65 $newValue = isset( $params['optionvalue'] ) ?
$params['optionvalue'] : null;
66 $changes[$params['optionname']] = $newValue;
68 if ( !$changed && !count( $changes ) ) {
69 $this->dieUsage( 'No changes were requested', 'nochanges' );
72 $prefs = Preferences
::getPreferences( $user, $this->getContext() );
73 $prefsKinds = $user->getOptionKinds( $this->getContext(), $changes );
75 foreach ( $changes as $key => $value ) {
76 switch ( $prefsKinds[$key] ) {
79 $field = HTMLForm
::loadInputFromParameters( $key, $prefs[$key] );
80 $validation = $field->validate( $value, $user->getOptions() );
82 case 'registered-multiselect':
83 // A key for a multiselect option.
85 $value = $value !== null ?
(bool) $value : null;
88 // Allow non-default preferences prefixed with 'userjs-', to be set by user scripts
89 if ( strlen( $key ) > 255 ) {
90 $validation = "key too long (no more than 255 bytes allowed)";
91 } elseif ( preg_match( "/[^a-zA-Z0-9_-]/", $key ) !== 0 ) {
92 $validation = "invalid key (only a-z, A-Z, 0-9, _, - allowed)";
99 $validation = "not a valid preference";
102 if ( $validation === true ) {
103 $user->setOption( $key, $value );
106 $this->setWarning( "Validation error for '$key': $validation" );
112 $user->saveSettings();
115 $this->getResult()->addValue( null, $this->getModuleName(), 'success' );
118 public function mustBePosted() {
122 public function isWriteMode() {
126 public function getAllowedParams() {
127 $optionKinds = User
::listOptionKinds();
128 $optionKinds[] = 'all';
132 ApiBase
::PARAM_TYPE
=> 'string',
133 ApiBase
::PARAM_REQUIRED
=> true
136 'resetkinds' => array(
137 ApiBase
::PARAM_TYPE
=> $optionKinds,
138 ApiBase
::PARAM_DFLT
=> 'all',
139 ApiBase
::PARAM_ISMULTI
=> true
142 ApiBase
::PARAM_ISMULTI
=> true,
144 'optionname' => array(
145 ApiBase
::PARAM_TYPE
=> 'string',
147 'optionvalue' => array(
148 ApiBase
::PARAM_TYPE
=> 'string',
153 public function getResultProperties() {
157 ApiBase
::PROP_TYPE
=> array(
165 public function getParamDescription() {
167 'token' => 'An options token previously obtained through the action=tokens',
168 'reset' => 'Resets preferences to the site defaults',
169 'resetkinds' => 'List of types of options to reset when the "reset" option is set',
170 'change' => 'List of changes, formatted name=value (e.g. skin=vector), value cannot contain pipe characters. If no value is given (not even an equals sign), e.g., optionname|otheroption|..., the option will be reset to its default value',
171 'optionname' => 'A name of a option which should have an optionvalue set',
172 'optionvalue' => 'A value of the option specified by the optionname, can contain pipe characters',
176 public function getDescription() {
178 'Change preferences of the current user',
179 'Only options which are registered in core or in one of installed extensions,',
180 'or as options with keys prefixed with \'userjs-\' (intended to be used by user scripts), can be set.'
184 public function getPossibleErrors() {
185 return array_merge( parent
::getPossibleErrors(), array(
186 array( 'code' => 'notloggedin', 'info' => 'Anonymous users cannot change preferences' ),
187 array( 'code' => 'nochanges', 'info' => 'No changes were requested' ),
191 public function needsToken() {
195 public function getTokenSalt() {
199 public function getHelpUrls() {
200 return 'https://www.mediawiki.org/wiki/API:Options';
203 public function getExamples() {
205 'api.php?action=options&reset=&token=123ABC',
206 'api.php?action=options&change=skin=vector|hideminor=1&token=123ABC',
207 'api.php?action=options&reset=&change=skin=monobook&optionname=nickname&optionvalue=[[User:Beau|Beau]]%20([[User_talk:Beau|talk]])&token=123ABC',