ApiSetPageLanguage.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Api;
 
use MediaWiki\ChangeTags\ChangeTags;
use MediaWiki\Language\LanguageNameUtils;
use MediaWiki\MainConfigNames;
use MediaWiki\Specials\SpecialPageLanguage;
use MediaWiki\Title\Title;
use Wikimedia\ParamValidator\ParamValidator;
use Wikimedia\Rdbms\IConnectionProvider;
 
class ApiSetPageLanguage extends ApiBase {
 
    public function __construct(
        ApiMain $mainModule,
        string $moduleName,
        private readonly IConnectionProvider $dbProvider,
        private readonly LanguageNameUtils $languageNameUtils,
    ) {
        parent::__construct( $mainModule, $moduleName );
    }
 
    protected function getExtendedDescription() {
        // Check if change language feature is enabled
        if ( !$this->getConfig()->get( MainConfigNames::PageLanguageUseDB ) ) {
            return 'apihelp-setpagelanguage-extended-description-disabled';
        }
        return parent::getExtendedDescription();
    }
 
    public function execute() {
        // Check if change language feature is enabled
        if ( !$this->getConfig()->get( MainConfigNames::PageLanguageUseDB ) ) {
            $this->dieWithError( 'apierror-pagelang-disabled' );
        }
 
        // Check if the user has permissions
        $this->checkUserRightsAny( 'pagelang' );
 
        $this->useTransactionalTimeLimit();
 
        $params = $this->extractRequestParams();
 
        $pageObj = $this->getTitleOrPageId( $params, 'fromdbmaster' );
        $titleObj = $pageObj->getTitle();
        $this->getErrorFormatter()->setContextTitle( $titleObj );
        if ( !$pageObj->exists() ) {
            $this->dieWithError( 'apierror-missingtitle' );
        }
 
        // Check that the user is allowed to edit the page
        $this->checkTitleUserPermissions( $titleObj, 'edit' );
 
        // If change tagging was requested, check that the user is allowed to tag,
        // and the tags are valid
        if ( $params['tags'] ) {
            $tagStatus = ChangeTags::canAddTagsAccompanyingChange( $params['tags'], $this->getAuthority() );
            if ( !$tagStatus->isOK() ) {
                $this->dieStatus( $tagStatus );
            }
        }
 
        $status = SpecialPageLanguage::changePageLanguage(
            $this,
            $titleObj,
            $params['lang'],
            $params['reason'] ?? '',
            $params['tags'] ?: [],
            $this->dbProvider->getPrimaryDatabase()
        );
 
        if ( !$status->isOK() ) {
            $this->dieStatus( $status );
        }
 
        $r = [
            'title' => $titleObj->getPrefixedText(),
            'oldlanguage' => $status->value->oldLanguage,
            'newlanguage' => $status->value->newLanguage,
            'logid' => $status->value->logId
        ];
        $this->getResult()->addValue( null, $this->getModuleName(), $r );
    }
 
    public function mustBePosted() {
        return true;
    }
 
    public function isWriteMode() {
        return true;
    }
 
    public function getAllowedParams() {
        return [
            'title' => null,
            'pageid' => [
                ParamValidator::PARAM_TYPE => 'integer'
            ],
            'lang' => [
                ParamValidator::PARAM_TYPE => [
                    'default',
                    ...array_keys( $this->languageNameUtils->getLanguageNames(
                        LanguageNameUtils::AUTONYMS,
                        LanguageNameUtils::SUPPORTED
                    ) )
                ],
                ParamValidator::PARAM_REQUIRED => true,
            ],
            'reason' => null,
            'tags' => [
                ParamValidator::PARAM_TYPE => 'tags',
                ParamValidator::PARAM_ISMULTI => true,
            ],
        ];
    }
 
    public function needsToken() {
        return 'csrf';
    }
 
    protected function getExamplesMessages() {
        $title = Title::newMainPage()->getPrefixedText();
        $mp = rawurlencode( $title );
 
        return [
            "action=setpagelanguage&title={$mp}&lang=eu&token=123ABC"
                => 'apihelp-setpagelanguage-example-language',
            'action=setpagelanguage&pageid=123&lang=default&token=123ABC'
                => 'apihelp-setpagelanguage-example-default',
        ];
    }
 
    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:SetPageLanguage';
    }
}
 
class_alias( ApiSetPageLanguage::class, 'ApiSetPageLanguage' );