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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
|
<?php
/**
* Api module for querying MessageGroups.
*
* @file
* @author Niklas Laxström
* @author Harry Burt
* @copyright Copyright © 2012-2013, Harry Burt
* @license GPL-2.0-or-later
*/
/**
* Api module for querying MessageGroups.
*
* @ingroup API TranslateAPI
*/
class ApiQueryMessageGroups extends ApiQueryBase {
public function __construct( $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'mg' );
}
public function execute() {
$params = $this->extractRequestParams();
$filter = $params['filter'];
$groups = [];
$props = array_flip( $params['prop'] );
$needsMetadata = isset( $props['prioritylangs'] ) || isset( $props['priorityforce'] );
// Parameter root as all for all pages subgroups
if ( $params['root'] === 'all' ) {
$allGroups = MessageGroups::getAllGroups();
foreach ( $allGroups as $id => $group ) {
if ( $group instanceof WikiPageMessageGroup ) {
$groups[$id] = $group;
}
}
} elseif ( $params['format'] === 'flat' ) {
if ( $params['root'] !== '' ) {
$group = MessageGroups::getGroup( $params['root'] );
if ( $group ) {
$groups[$params['root']] = $group;
}
} else {
$groups = MessageGroups::getAllGroups();
usort( $groups, [ 'MessageGroups', 'groupLabelSort' ] );
}
TranslateMetadata::preloadGroups( array_keys( $groups ), __METHOD__ );
} elseif ( $params['root'] !== '' ) {
// format=tree from now on, as it is the only other valid option
$group = MessageGroups::getGroup( $params['root'] );
if ( $group instanceof AggregateMessageGroup ) {
$childIds = [];
$groups = MessageGroups::subGroups( $group, $childIds );
// The parent group is the first, ignore it
array_shift( $groups );
}
} else {
$groups = MessageGroups::getGroupStructure();
}
if ( $needsMetadata && $groups ) {
TranslateMetadata::preloadGroups( array_keys( $groups ), __METHOD__ );
}
if ( $params['root'] === '' ) {
$dynamicGroups = [];
foreach ( array_keys( MessageGroups::getDynamicGroups() ) as $id ) {
$dynamicGroups[$id] = MessageGroups::getGroup( $id );
}
// Have dynamic groups appear first in the list
$groups = $dynamicGroups + $groups;
}
'@phan-var (MessageGroup|array)[] $groups';
// Do not list the sandbox group. The code that knows it
// exists can access it directly.
if ( isset( $groups['!sandbox'] ) ) {
unset( $groups['!sandbox'] );
}
$result = $this->getResult();
$matcher = new StringMatcher( '', $filter );
/** @var MessageGroup|array $mixed */
foreach ( $groups as $mixed ) {
// array when Format = tree
$group = is_array( $mixed ) ? reset( $mixed ) : $mixed;
if ( $filter !== [] && !$matcher->matches( $group->getId() ) ) {
continue;
}
if (
$params['languageFilter'] !== '' &&
TranslateMetadata::isExcluded( $group->getId(), $params['languageFilter'] )
) {
continue;
}
$a = $this->formatGroup( $mixed, $props );
$result->setIndexedTagName( $a, 'group' );
// @todo Add a continue?
$fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $a );
if ( !$fit ) {
// Even if we're not going to give a continue, no point carrying on
// if the result is full
break;
}
}
$result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'group' );
}
/**
* @param array|MessageGroup $mixed
* @param array $props List of props as the array keys
* @param int $depth
* @return array
*/
protected function formatGroup( $mixed, $props, $depth = 0 ) {
$params = $this->extractRequestParams();
$context = $this->getContext();
// Default
$g = $mixed;
$subgroups = [];
// Format = tree and has subgroups
if ( is_array( $mixed ) ) {
$g = array_shift( $mixed );
$subgroups = $mixed;
}
$a = [];
$groupId = $g->getId();
if ( isset( $props['id'] ) ) {
$a['id'] = $groupId;
}
if ( isset( $props['label'] ) ) {
$a['label'] = $g->getLabel( $context );
}
if ( isset( $props['description'] ) ) {
$a['description'] = $g->getDescription( $context );
}
if ( isset( $props['class'] ) ) {
$a['class'] = get_class( $g );
}
if ( isset( $props['namespace'] ) ) {
$a['namespace'] = $g->getNamespace();
}
if ( isset( $props['exists'] ) ) {
$a['exists'] = $g->exists();
}
if ( isset( $props['icon'] ) ) {
$formats = TranslateUtils::getIcon( $g, $params['iconsize'] );
if ( $formats ) {
$a['icon'] = $formats;
}
}
if ( isset( $props['priority'] ) ) {
$priority = MessageGroups::getPriority( $g );
$a['priority'] = $priority ?: 'default';
}
if ( isset( $props['prioritylangs'] ) ) {
$prioritylangs = TranslateMetadata::get( $groupId, 'prioritylangs' );
$a['prioritylangs'] = $prioritylangs ? explode( ',', $prioritylangs ) : false;
}
if ( isset( $props['priorityforce'] ) ) {
$a['priorityforce'] = ( TranslateMetadata::get( $groupId, 'priorityforce' ) === 'on' );
}
if ( isset( $props['workflowstates'] ) ) {
$a['workflowstates'] = $this->getWorkflowStates( $g );
}
Hooks::run(
'TranslateProcessAPIMessageGroupsProperties',
[ &$a, $props, $params, $g ]
);
// Depth only applies to tree format
if ( $depth >= $params['depth'] && $params['format'] === 'tree' ) {
$a['groupcount'] = count( $subgroups );
// Prevent going further down in the three
return $a;
}
// Always empty array for flat format, only sometimes for tree format
if ( $subgroups !== [] ) {
foreach ( $subgroups as $sg ) {
$a['groups'][] = $this->formatGroup( $sg, $props );
}
$result = $this->getResult();
// @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset
$result->setIndexedTagName( $a['groups'], 'group' );
}
return $a;
}
/**
* Get the workflow states applicable to the given message group
*
* @param MessageGroup $group
* @return bool|array Associative array with states as key and localized state
* labels as values
*/
protected function getWorkflowStates( MessageGroup $group ) {
if ( MessageGroups::isDynamic( $group ) ) {
return false;
}
$stateConfig = $group->getMessageGroupStates()->getStates();
if ( !is_array( $stateConfig ) || $stateConfig === [] ) {
return false;
}
$user = $this->getUser();
foreach ( $stateConfig as $state => $config ) {
if ( is_array( $config ) ) {
// Check if user is allowed to change states generally
$allowed = $user->isAllowed( 'translate-groupreview' );
// Check further restrictions
if ( $allowed && isset( $config['right'] ) ) {
$allowed = $user->isAllowed( $config['right'] );
}
if ( $allowed ) {
$stateConfig[$state]['canchange'] = 1;
}
$stateConfig[$state]['name'] =
$this->msg( "translate-workflow-state-$state" )->text();
}
}
return $stateConfig;
}
protected function getAllowedParams() {
$allowedParams = [
'depth' => [
ApiBase::PARAM_TYPE => 'integer',
ApiBase::PARAM_DFLT => 100,
],
'filter' => [
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_DFLT => '',
ApiBase::PARAM_ISMULTI => true,
],
'format' => [
ApiBase::PARAM_TYPE => [ 'flat', 'tree' ],
ApiBase::PARAM_DFLT => 'flat',
],
'iconsize' => [
ApiBase::PARAM_TYPE => 'integer',
ApiBase::PARAM_DFLT => 64,
],
'prop' => [
ApiBase::PARAM_TYPE => array_keys( self::getPropertyList() ),
ApiBase::PARAM_DFLT => 'id|label|description|class|exists',
ApiBase::PARAM_ISMULTI => true,
],
'root' => [
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_DFLT => '',
],
'languageFilter' => [
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_DFLT => '',
]
];
Hooks::run( 'TranslateGetAPIMessageGroupsParameterList', [ &$allowedParams ] );
return $allowedParams;
}
/**
* Returns an array of properties and their descriptions. Descriptions are ignored.
*
* Descriptions come from apihelp-query+messagegroups-param-prop and that is not
* extensible.
*
* @return array
*/
protected static function getPropertyList() {
$properties = array_flip( [
'id',
'label',
'description',
'class',
'namespace',
'exists',
'icon',
'priority',
'prioritylangs',
'priorityforce',
'workflowstates',
] );
Hooks::run( 'TranslateGetAPIMessageGroupsPropertyDescs', [ &$properties ] );
return $properties;
}
protected function getExamplesMessages() {
return [
'action=query&meta=messagegroups' => 'apihelp-query+messagegroups-example-1',
];
}
}
|