ApiOptions.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;

class ApiOptions extends ApiBase {
    private $userForUpdates;

    public function execute() {
        $user = $this->getUserForUpdates();
        if ( !$user || $user->isAnon() ) {
            $this->dieWithError(
                [ 'apierror-mustbeloggedin', $this->msg( 'action-editmyoptions' ) ], 'notloggedin'
            );
        }

        $this->checkUserRightsAny( 'editmyoptions' );

        $params = $this->extractRequestParams();
        $changed = false;

        if ( isset( $params['optionvalue'] ) && !isset( $params['optionname'] ) ) {
            $this->dieWithError( [ 'apierror-missingparam', 'optionname' ] );
        }

        $resetKinds = $params['resetkinds'];
        if ( !$params['reset'] ) {
            $resetKinds = [];
        }

        $changes = [];
        if ( $params['change'] ) {
            foreach ( $params['change'] as $entry ) {
                $array = explode( '=', $entry, 2 );
                $changes[$array[0]] = $array[1] ?? null;
            }
        }
        if ( isset( $params['optionname'] ) ) {
            $newValue = $params['optionvalue'] ?? null;
            $changes[$params['optionname']] = $newValue;
        }

        Hooks::run( 'ApiOptions', [ $this, $user, $changes, $resetKinds ] );

        if ( $resetKinds ) {
            $this->resetPreferences( $resetKinds );
            $changed = true;
        }

        if ( !$changed && !count( $changes ) ) {
            $this->dieWithError( 'apierror-nochanges' );
        }

        $prefs = $this->getPreferences();
        $prefsKinds = $user->getOptionKinds( $this->getContext(), $changes );

        $htmlForm = null;
        foreach ( $changes as $key => $value ) {
            switch ( $prefsKinds[$key] ) {
                case 'registered':
                    // Regular option.
                    if ( $value === null ) {
                        // Reset it
                        $validation = true;
                    } else {
                        // Validate
                        if ( $htmlForm === null ) {
                            // We need a dummy HTMLForm for the validate callback...
                            $htmlForm = new HTMLForm( [], $this );
                        }
                        $field = HTMLForm::loadInputFromParameters( $key, $prefs[$key], $htmlForm );
                        $validation = $field->validate( $value, $user->getOptions() );
                    }
                    break;
                case 'registered-multiselect':
                case 'registered-checkmatrix':
                    // A key for a multiselect or checkmatrix option.
                    $validation = true;
                    $value = $value !== null ? (bool)$value : null;
                    break;
                case 'userjs':
                    // Allow non-default preferences prefixed with 'userjs-', to be set by user scripts
                    if ( strlen( $key ) > 255 ) {
                        $validation = $this->msg( 'apiwarn-validationfailed-keytoolong', Message::numParam( 255 ) );
                    } elseif ( preg_match( '/[^a-zA-Z0-9_-]/', $key ) !== 0 ) {
                        $validation = $this->msg( 'apiwarn-validationfailed-badchars' );
                    } else {
                        $validation = true;
                    }
                    break;
                case 'special':
                    $validation = $this->msg( 'apiwarn-validationfailed-cannotset' );
                    break;
                case 'unused':
                default:
                    $validation = $this->msg( 'apiwarn-validationfailed-badpref' );
                    break;
            }
            if ( $validation === true ) {
                $this->setPreference( $key, $value );
                $changed = true;
            } else {
                $this->addWarning( [ 'apiwarn-validationfailed', wfEscapeWikiText( $key ), $validation ] );
            }
        }

        if ( $changed ) {
            $this->commitChanges();
        }

        $this->getResult()->addValue( null, $this->getModuleName(), 'success' );
    }

    protected function getUserForUpdates() {
        if ( !$this->userForUpdates ) {
            $this->userForUpdates = $this->getUser()->getInstanceForUpdate();
        }

        return $this->userForUpdates;
    }

    protected function getPreferences() {
        $preferencesFactory = MediaWikiServices::getInstance()->getPreferencesFactory();
        return $preferencesFactory->getFormDescriptor( $this->getUserForUpdates(),
            $this->getContext() );
    }

    protected function resetPreferences( array $kinds ) {
        $this->getUserForUpdates()->resetOptions( $kinds, $this->getContext() );
    }

    protected function setPreference( $preference, $value ) {
        $this->getUserForUpdates()->setOption( $preference, $value );
    }

    protected function commitChanges() {
        $this->getUserForUpdates()->saveSettings();
    }

    public function mustBePosted() {
        return true;
    }

    public function isWriteMode() {
        return true;
    }

    public function getAllowedParams() {
        $optionKinds = User::listOptionKinds();
        $optionKinds[] = 'all';

        return [
            'reset' => false,
            'resetkinds' => [
                ApiBase::PARAM_TYPE => $optionKinds,
                ApiBase::PARAM_DFLT => 'all',
                ApiBase::PARAM_ISMULTI => true
            ],
            'change' => [
                ApiBase::PARAM_ISMULTI => true,
            ],
            'optionname' => [
                ApiBase::PARAM_TYPE => 'string',
            ],
            'optionvalue' => [
                ApiBase::PARAM_TYPE => 'string',
            ],
        ];
    }

    public function needsToken() {
        return 'csrf';
    }

    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Options';
    }

    protected function getExamplesMessages() {
        return [
            'action=options&reset=&token=123ABC'
                => 'apihelp-options-example-reset',
            'action=options&change=skin=vector|hideminor=1&token=123ABC'
                => 'apihelp-options-example-change',
            'action=options&reset=&change=skin=monobook&optionname=nickname&' .
                'optionvalue=[[User:Beau|Beau]]%20([[User_talk:Beau|talk]])&token=123ABC'
                => 'apihelp-options-example-complex',
        ];
    }
}