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
{
35 * Changes preferences of the current user.
37 public function execute() {
38 $user = $this->getUser();
40 if ( $user->isAnon() ) {
41 $this->dieUsage( 'Anonymous users cannot change preferences', 'notloggedin' );
44 if ( !$user->isAllowed( 'editmyoptions' ) ) {
45 $this->dieUsage( 'You don\'t have permission to edit your options', 'permissiondenied' );
48 $params = $this->extractRequestParams();
51 if ( isset( $params['optionvalue'] ) && !isset( $params['optionname'] ) ) {
52 $this->dieUsageMsg( array( 'missingparam', 'optionname' ) );
55 if ( $params['reset'] ) {
56 $user->resetOptions( $params['resetkinds'], $this->getContext() );
61 if ( count( $params['change'] ) ) {
62 foreach ( $params['change'] as $entry ) {
63 $array = explode( '=', $entry, 2 );
64 $changes[$array[0]] = isset( $array[1] ) ?
$array[1] : null;
67 if ( isset( $params['optionname'] ) ) {
68 $newValue = isset( $params['optionvalue'] ) ?
$params['optionvalue'] : null;
69 $changes[$params['optionname']] = $newValue;
71 if ( !$changed && !count( $changes ) ) {
72 $this->dieUsage( 'No changes were requested', 'nochanges' );
75 $prefs = Preferences
::getPreferences( $user, $this->getContext() );
76 $prefsKinds = $user->getOptionKinds( $this->getContext(), $changes );
78 foreach ( $changes as $key => $value ) {
79 switch ( $prefsKinds[$key] ) {
82 $field = HTMLForm
::loadInputFromParameters( $key, $prefs[$key] );
83 $validation = $field->validate( $value, $user->getOptions() );
85 case 'registered-multiselect':
86 case 'registered-checkmatrix':
87 // A key for a multiselect or checkmatrix option.
89 $value = $value !== null ?
(bool)$value : null;
92 // Allow non-default preferences prefixed with 'userjs-', to be set by user scripts
93 if ( strlen( $key ) > 255 ) {
94 $validation = "key too long (no more than 255 bytes allowed)";
95 } elseif ( preg_match( "/[^a-zA-Z0-9_-]/", $key ) !== 0 ) {
96 $validation = "invalid key (only a-z, A-Z, 0-9, _, - allowed)";
102 $validation = "cannot be set by this module";
106 $validation = "not a valid preference";
109 if ( $validation === true ) {
110 $user->setOption( $key, $value );
113 $this->setWarning( "Validation error for '$key': $validation" );
119 $user->saveSettings();
122 $this->getResult()->addValue( null, $this->getModuleName(), 'success' );
125 public function mustBePosted() {
129 public function isWriteMode() {
133 public function getAllowedParams() {
134 $optionKinds = User
::listOptionKinds();
135 $optionKinds[] = 'all';
139 'resetkinds' => array(
140 ApiBase
::PARAM_TYPE
=> $optionKinds,
141 ApiBase
::PARAM_DFLT
=> 'all',
142 ApiBase
::PARAM_ISMULTI
=> true
145 ApiBase
::PARAM_ISMULTI
=> true,
147 'optionname' => array(
148 ApiBase
::PARAM_TYPE
=> 'string',
150 'optionvalue' => array(
151 ApiBase
::PARAM_TYPE
=> 'string',
156 public function getParamDescription() {
158 'reset' => 'Resets preferences to the site defaults',
159 'resetkinds' => 'List of types of options to reset when the "reset" option is set',
160 'change' => array( 'List of changes, formatted name=value (e.g. skin=vector), ' .
161 'value cannot contain pipe characters. If no value is given (not ',
162 'even an equals sign), e.g., optionname|otheroption|..., the ' .
163 'option will be reset to its default value'
165 'optionname' => 'A name of a option which should have an optionvalue set',
166 'optionvalue' => 'A value of the option specified by the optionname, ' .
167 'can contain pipe characters',
171 public function getDescription() {
173 'Change preferences of the current user.',
174 'Only options which are registered in core or in one of installed extensions,',
175 'or as options with keys prefixed with \'userjs-\' (intended to be used by user',
176 'scripts), can be set.'
180 public function needsToken() {
184 public function getHelpUrls() {
185 return 'https://www.mediawiki.org/wiki/API:Options';
188 public function getExamples() {
190 'api.php?action=options&reset=&token=123ABC',
191 'api.php?action=options&change=skin=vector|hideminor=1&token=123ABC',
192 'api.php?action=options&reset=&change=skin=monobook&optionname=nickname&' .
193 'optionvalue=[[User:Beau|Beau]]%20([[User_talk:Beau|talk]])&token=123ABC',