6866cfec37
Also remove not necessary surrounding parentheses. Change-Id: I0eb5c9c1bdfb09a800258379cdcefb5fd4d3d21c
145 lines
4.1 KiB
PHP
145 lines
4.1 KiB
PHP
<?php
|
|
/**
|
|
* Copyright © 2017 Justin Du "<justin.d128@gmail.com>"
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
/**
|
|
* API module that facilitates changing the language of a page.
|
|
* The API equivalent of SpecialPageLanguage.
|
|
* Requires API write mode to be enabled.
|
|
*
|
|
* @ingroup API
|
|
*/
|
|
class ApiSetPageLanguage extends ApiBase {
|
|
// Check if change language feature is enabled
|
|
protected function getExtendedDescription() {
|
|
if ( !$this->getConfig()->get( 'PageLanguageUseDB' ) ) {
|
|
return 'apihelp-setpagelanguage-extended-description-disabled';
|
|
}
|
|
return parent::getExtendedDescription();
|
|
}
|
|
|
|
/**
|
|
* Extracts the title and language from the request parameters and invokes
|
|
* the static SpecialPageLanguage::changePageLanguage() function with these as arguments.
|
|
* If the language change succeeds, the title, old language, and new language
|
|
* of the article changed, as well as the performer of the language change
|
|
* are added to the result object.
|
|
*/
|
|
public function execute() {
|
|
// Check if change language feature is enabled
|
|
if ( !$this->getConfig()->get( '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' );
|
|
if ( !$pageObj->exists() ) {
|
|
$this->dieWithError( 'apierror-missingtitle' );
|
|
}
|
|
|
|
$titleObj = $pageObj->getTitle();
|
|
$user = $this->getUser();
|
|
|
|
// 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'], $user );
|
|
if ( !$tagStatus->isOK() ) {
|
|
$this->dieStatus( $tagStatus );
|
|
}
|
|
}
|
|
|
|
$status = SpecialPageLanguage::changePageLanguage(
|
|
$this,
|
|
$titleObj,
|
|
$params['lang'],
|
|
$params['reason'] ?? '',
|
|
$params['tags'] ?: []
|
|
);
|
|
|
|
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' => [
|
|
ApiBase::PARAM_TYPE => 'integer'
|
|
],
|
|
'lang' => [
|
|
ApiBase::PARAM_TYPE => array_merge(
|
|
[ 'default' ],
|
|
array_keys( Language::fetchLanguageNames( null, 'mwfile' ) )
|
|
),
|
|
ApiBase::PARAM_REQUIRED => true,
|
|
],
|
|
'reason' => null,
|
|
'tags' => [
|
|
ApiBase::PARAM_TYPE => 'tags',
|
|
ApiBase::PARAM_ISMULTI => true,
|
|
],
|
|
];
|
|
}
|
|
|
|
public function needsToken() {
|
|
return 'csrf';
|
|
}
|
|
|
|
protected function getExamplesMessages() {
|
|
return [
|
|
'action=setpagelanguage&title=Main%20Page&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';
|
|
}
|
|
}
|