1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
<?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
*/
use MediaWiki\Languages\LanguageNameUtils;
use MediaWiki\MainConfigNames;
use Wikimedia\ParamValidator\ParamValidator;
use Wikimedia\Rdbms\IConnectionProvider;
/**
* 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 {
/** @var IConnectionProvider */
private $dbProvider;
/** @var LanguageNameUtils */
private $languageNameUtils;
/**
* @param ApiMain $mainModule
* @param string $moduleName
* @param IConnectionProvider $dbProvider
* @param LanguageNameUtils $languageNameUtils
*/
public function __construct(
ApiMain $mainModule,
$moduleName,
IConnectionProvider $dbProvider,
LanguageNameUtils $languageNameUtils
) {
parent::__construct( $mainModule, $moduleName );
$this->dbProvider = $dbProvider;
$this->languageNameUtils = $languageNameUtils;
}
// Check if change language feature is enabled
protected function getExtendedDescription() {
if ( !$this->getConfig()->get( MainConfigNames::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( 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 => array_merge(
[ '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() {
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';
}
}
|
