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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
|
<?php
/**
* 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\LanguageConverterFactory;
use MediaWiki\Languages\LanguageFactory;
use MediaWiki\Languages\LanguageFallback;
use MediaWiki\Languages\LanguageNameUtils;
use Wikimedia\ParamValidator\ParamValidator;
use Wikimedia\Timestamp\ConvertibleTimestamp;
/**
* API module to enumerate language information.
*
* @ingroup API
*/
class ApiQueryLanguageinfo extends ApiQueryBase {
/**
* The maximum time for {@link execute()};
* if execution takes longer than this, apply continuation.
*
* If the localization cache is used, this time is not expected to ever be
* exceeded; on the other hand, if it is not used, a typical request will
* not yield more than a handful of languages before the time is exceeded
* and continuation is applied, if one of the expensive props is requested.
*/
private const MAX_EXECUTE_SECONDS = 2;
/** @var LanguageFactory */
private $languageFactory;
/** @var LanguageNameUtils */
private $languageNameUtils;
/** @var LanguageFallback */
private $languageFallback;
/** @var LanguageConverterFactory */
private $languageConverterFactory;
/**
* @param ApiQuery $queryModule
* @param string $moduleName
* @param LanguageFactory $languageFactory
* @param LanguageNameUtils $languageNameUtils
* @param LanguageFallback $languageFallback
* @param LanguageConverterFactory $languageConverterFactory
*/
public function __construct(
ApiQuery $queryModule,
$moduleName,
LanguageFactory $languageFactory,
LanguageNameUtils $languageNameUtils,
LanguageFallback $languageFallback,
LanguageConverterFactory $languageConverterFactory
) {
parent::__construct( $queryModule, $moduleName, 'li' );
$this->languageFactory = $languageFactory;
$this->languageNameUtils = $languageNameUtils;
$this->languageFallback = $languageFallback;
$this->languageConverterFactory = $languageConverterFactory;
}
public function execute() {
// ConvertibleTimestamp::time() used so we can fake the current time in tests
$endTime = ConvertibleTimestamp::time() + self::MAX_EXECUTE_SECONDS;
$props = array_fill_keys( $this->getParameter( 'prop' ), true );
$includeCode = isset( $props['code'] );
$includeBcp47 = isset( $props['bcp47'] );
$includeDir = isset( $props['dir'] );
$includeAutonym = isset( $props['autonym'] );
$includeName = isset( $props['name'] );
$includeFallbacks = isset( $props['fallbacks'] );
$includeVariants = isset( $props['variants'] );
$targetLanguageCode = $this->getLanguage()->getCode();
$include = 'all';
$availableLanguageCodes = array_keys( $this->languageNameUtils->getLanguageNames(
// MediaWiki and extensions may return different sets of language codes
// when asked for language names in different languages;
// asking for English language names is most likely to give us the full set,
// even though we may not need those at all
'en',
$include
) );
$selectedLanguageCodes = $this->getParameter( 'code' );
if ( $selectedLanguageCodes === [ '*' ] ) {
$languageCodes = $availableLanguageCodes;
} else {
$languageCodes = array_values( array_intersect(
$availableLanguageCodes,
$selectedLanguageCodes
) );
$unrecognizedCodes = array_values( array_diff(
$selectedLanguageCodes,
$availableLanguageCodes
) );
if ( $unrecognizedCodes !== [] ) {
$this->addWarning( [
'apiwarn-unrecognizedvalues',
$this->encodeParamName( 'code' ),
Message::listParam( $unrecognizedCodes, 'comma' ),
count( $unrecognizedCodes ),
] );
}
}
// order of $languageCodes is guaranteed by LanguageNameUtils::getLanguageNames()
// and preserved by array_values() + array_intersect()
$continue = $this->getParameter( 'continue' );
if ( $continue === null ) {
$continue = reset( $languageCodes );
}
$result = $this->getResult();
$rootPath = [
$this->getQuery()->getModuleName(),
$this->getModuleName(),
];
$result->addArrayType( $rootPath, 'assoc' );
foreach ( $languageCodes as $languageCode ) {
if ( $languageCode < $continue ) {
continue;
}
$now = ConvertibleTimestamp::time();
if ( $now >= $endTime ) {
$this->setContinueEnumParameter( 'continue', $languageCode );
break;
}
$info = [];
ApiResult::setArrayType( $info, 'assoc' );
if ( $includeCode ) {
$info['code'] = $languageCode;
}
if ( $includeBcp47 ) {
$bcp47 = LanguageCode::bcp47( $languageCode );
$info['bcp47'] = $bcp47;
}
if ( $includeDir ) {
$dir = $this->languageFactory->getLanguage( $languageCode )->getDir();
$info['dir'] = $dir;
}
if ( $includeAutonym ) {
$autonym = $this->languageNameUtils->getLanguageName(
$languageCode,
LanguageNameUtils::AUTONYMS,
$include
);
$info['autonym'] = $autonym;
}
if ( $includeName ) {
$name = $this->languageNameUtils->getLanguageName(
$languageCode,
$targetLanguageCode,
$include
);
$info['name'] = $name;
}
if ( $includeFallbacks ) {
$fallbacks = $this->languageFallback->getAll(
$languageCode,
// allow users to distinguish between implicit and explicit 'en' fallbacks
LanguageFallback::STRICT
);
ApiResult::setIndexedTagName( $fallbacks, 'fb' );
$info['fallbacks'] = $fallbacks;
}
if ( $includeVariants ) {
$language = $this->languageFactory->getLanguage( $languageCode );
$converter = $this->languageConverterFactory->getLanguageConverter( $language );
$variants = $converter->getVariants();
ApiResult::setIndexedTagName( $variants, 'var' );
$info['variants'] = $variants;
}
$fit = $result->addValue( $rootPath, $languageCode, $info );
if ( !$fit ) {
$this->setContinueEnumParameter( 'continue', $languageCode );
break;
}
}
}
public function getCacheMode( $params ) {
return 'public';
}
public function getAllowedParams() {
return [
'prop' => [
ParamValidator::PARAM_DEFAULT => 'code',
ParamValidator::PARAM_ISMULTI => true,
ParamValidator::PARAM_TYPE => [
'code',
'bcp47',
'dir',
'autonym',
'name',
'fallbacks',
'variants',
],
self::PARAM_HELP_MSG_PER_VALUE => [],
],
'code' => [
ParamValidator::PARAM_DEFAULT => '*',
ParamValidator::PARAM_ISMULTI => true,
],
'continue' => [
self::PARAM_HELP_MSG => 'api-help-param-continue',
],
];
}
protected function getExamplesMessages() {
$pathUrl = 'action=' . $this->getQuery()->getModuleName() .
'&meta=' . $this->getModuleName();
$pathMsg = $this->getModulePath();
$prefix = $this->getModulePrefix();
return [
"$pathUrl"
=> "apihelp-$pathMsg-example-simple",
"$pathUrl&{$prefix}prop=autonym|name&uselang=de"
=> "apihelp-$pathMsg-example-autonym-name-de",
"$pathUrl&{$prefix}prop=fallbacks|variants&{$prefix}code=oc"
=> "apihelp-$pathMsg-example-fallbacks-variants-oc",
"$pathUrl&{$prefix}prop=bcp47|dir"
=> "apihelp-$pathMsg-example-bcp47-dir",
];
}
}
|
