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
|
<?php
/**
* API module for managing aggregate message groups
* @file
* @author Santhosh Thottingal
* @author Niklas Laxström
* @copyright Copyright © 2012-2013, Santhosh Thottingal
* @license GPL-2.0+
*/
/**
* API module for managing aggregate message groups
* Only supports aggregate message groups defined inside the wiki.
* Aggregate message group defined in YAML configuration cannot be altered.
*
* @ingroup API TranslateAPI
*/
class ApiAggregateGroups extends ApiBase {
protected static $right = 'translate-manage';
public function execute() {
if ( !$this->getUser()->isAllowed( self::$right ) ) {
$this->dieUsage( 'Permission denied', 'permissiondenied' );
}
$params = $this->extractRequestParams();
$action = $params['do'];
$output = array();
if ( $action === 'associate' || $action === 'dissociate' ) {
// Group is mandatory only for these two actions
if ( !isset( $params['group'] ) ) {
$this->dieUsageMsg( array( 'missingparam', 'group' ) );
}
if ( !isset( $params['aggregategroup'] ) ) {
$this->dieUsageMsg( array( 'missingparam', 'aggregategroup' ) );
}
$aggregateGroup = $params['aggregategroup'];
$subgroups = TranslateMetadata::getSubgroups( $aggregateGroup );
if ( count( $subgroups ) === 0 ) {
// For newly created groups the subgroups value might be empty,
// but check that.
if ( TranslateMetadata::get( $aggregateGroup, 'name' ) === false ) {
$this->dieUsage( 'Invalid aggregate message group', 'invalidaggregategroup' );
}
$subgroups = array();
}
$subgroupId = $params['group'];
$group = MessageGroups::getGroup( $subgroupId );
// Add or remove from the list
if ( $action === 'associate' ) {
if ( !$group instanceof WikiPageMessageGroup ) {
$this->dieUsage( 'Group does not exist or invalid', 'invalidgroup' );
}
$subgroups[] = $subgroupId;
$subgroups = array_unique( $subgroups );
} elseif ( $action === 'dissociate' ) {
// Allow removal of non-existing groups
$subgroups = array_flip( $subgroups );
unset( $subgroups[$subgroupId] );
$subgroups = array_flip( $subgroups );
}
TranslateMetadata::setSubgroups( $aggregateGroup, $subgroups );
$logParams = array(
'aggregategroup' => TranslateMetadata::get( $aggregateGroup, 'name' ),
'aggregategroup-id' => $aggregateGroup,
);
/* Note that to allow removing no longer existing groups from
* aggregate message groups, the message group object $group
* might not always be available. In this case we need to fake
* some title. */
$title = $group ?
$group->getTitle() :
Title::newFromText( "Special:Translate/$subgroupId" );
$entry = new ManualLogEntry( 'pagetranslation', $action );
$entry->setPerformer( $this->getUser() );
$entry->setTarget( $title );
// @todo
// $entry->setComment( $comment );
$entry->setParameters( $logParams );
$logid = $entry->insert();
$entry->publish( $logid );
} elseif ( $action === 'remove' ) {
if ( !isset( $params['aggregategroup'] ) ) {
$this->dieUsageMsg( array( 'missingparam', 'aggregategroup' ) );
}
TranslateMetadata::deleteGroup( $params['aggregategroup'] );
// @todo Logging
} elseif ( $action === 'add' ) {
if ( !isset( $params['groupname'] ) ) {
$this->dieUsageMsg( array( 'missingparam', 'groupname' ) );
}
$name = trim( $params['groupname'] );
if ( strlen( $name ) === 0 ) {
$this->dieUsage( 'Invalid aggregate message group name', 'invalidaggregategroupname' );
}
if ( !isset( $params['groupdescription'] ) ) {
$this->dieUsageMsg( array( 'missingparam', 'groupdescription' ) );
}
$desc = trim( $params['groupdescription'] );
$aggregateGroupId = self::generateAggregateGroupId( $name );
// Throw error if group already exists
$nameExists = MessageGroups::labelExists( $name );
if ( $nameExists ) {
$this->dieUsage( 'Message group already exists', 'duplicateaggregategroup' );
}
// ID already exists- Generate a new ID by adding a number to it.
$idExists = MessageGroups::getGroup( $aggregateGroupId );
if ( $idExists ) {
$i = 1;
while ( $idExists ) {
$tempId = $aggregateGroupId . '-' . $i;
$idExists = MessageGroups::getGroup( $tempId );
$i++;
}
$aggregateGroupId = $tempId;
}
TranslateMetadata::set( $aggregateGroupId, 'name', $name );
TranslateMetadata::set( $aggregateGroupId, 'description', $desc );
TranslateMetadata::setSubgroups( $aggregateGroupId, array() );
// Once new aggregate group added, we need to show all the pages that can be added to that.
$output['groups'] = self::getAllPages();
$output['aggregategroupId'] = $aggregateGroupId;
// @todo Logging
} elseif ( $action === 'update' ) {
if ( !isset( $params['groupname'] ) ) {
$this->dieUsageMsg( array( 'missingparam', 'groupname' ) );
}
$name = trim( $params['groupname'] );
if ( strlen( $name ) === 0 ) {
$this->dieUsage( 'Invalid aggregate message group name', 'invalidaggregategroupname' );
}
$desc = trim( $params['groupdescription'] );
$aggregateGroupId = $params['aggregategroup'];
$oldName = TranslateMetadata::get( $aggregateGroupId, 'name' );
$oldDesc = TranslateMetadata::get( $aggregateGroupId, 'description' );
// Error if the label exists already
$exists = MessageGroups::labelExists( $name );
if ( $exists && $oldName !== $name ) {
$this->dieUsage( 'Message group name already exists', 'duplicateaggregategroup' );
}
if ( $oldName === $name && $oldDesc === $desc ) {
$this->dieUsage( 'Invalid update', 'invalidupdate' );
}
TranslateMetadata::set( $aggregateGroupId, 'name', $name );
TranslateMetadata::set( $aggregateGroupId, 'description', $desc );
}
// If we got this far, nothing has failed
$output['result'] = 'ok';
$this->getResult()->addValue( null, $this->getModuleName(), $output );
// Cache needs to be cleared after any changes to groups
MessageGroups::singleton()->recache();
MessageIndexRebuildJob::newJob()->insert();
}
protected function generateAggregateGroupId( $aggregateGroupName, $prefix = 'agg-' ) {
// The database field has maximum limit of 200 bytes
if ( strlen( $aggregateGroupName ) + strlen( $prefix ) >= 200 ) {
return $prefix . substr( sha1( $aggregateGroupName ), 0, 5 );
} else {
$pattern = '/[\x00-\x1f\x23\x27\x2c\x2e\x3c\x3e\x5b\x5d\x7b\x7c\x7d\x7f\s]+/i';
return $prefix . preg_replace( $pattern, '_', $aggregateGroupName );
}
}
public function isWriteMode() {
return true;
}
public function needsToken() {
return 'csrf';
}
public function getAllowedParams() {
return array(
'do' => array(
ApiBase::PARAM_TYPE => array( 'associate', 'dissociate', 'remove', 'add', 'update' ),
ApiBase::PARAM_REQUIRED => true,
),
'aggregategroup' => array(
ApiBase::PARAM_TYPE => 'string',
),
'group' => array(
// Not providing list of values, to allow dissociation of unknown groups
ApiBase::PARAM_TYPE => 'string',
),
'groupname' => array(
ApiBase::PARAM_TYPE => 'string',
),
'groupdescription' => array(
ApiBase::PARAM_TYPE => 'string',
),
'token' => array(
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_REQUIRED => true,
),
);
}
protected function getExamplesMessages() {
return array(
'action=aggregategroups&do=associate&group=groupId&aggregategroup=aggregateGroupId'
=> 'apihelp-aggregategroups-example-1',
);
}
public static function getAllPages() {
$groups = MessageGroups::getAllGroups();
$pages = array();
foreach ( $groups as $group ) {
if ( $group instanceof WikiPageMessageGroup ) {
$pages[$group->getId()] = $group->getTitle()->getPrefixedText();
}
}
return $pages;
}
}
|
