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
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
|
<?php
/**
* File format support classes.
*
* @file
* @author Niklas Laxström
*/
/**
* A very basic FFS module that implements some basic functionality and
* a simple binary based file format.
* Other FFS classes can extend SimpleFFS and override suitable methods.
* @ingroup FFS
*/
use UtfNormal\Validator;
class SimpleFFS implements FFS {
public function supportsFuzzy() {
return 'no';
}
public function getFileExtensions() {
return [];
}
/**
* @var FileBasedMessageGroup
*/
protected $group;
protected $writePath;
/**
* Stores the FILES section of the YAML configuration,
* which can be accessed for extra FFS class specific options.
*/
protected $extra;
private const RECORD_SEPARATOR = "\0";
private const PART_SEPARATOR = "\0\0\0\0";
public function __construct( FileBasedMessageGroup $group ) {
$this->setGroup( $group );
$conf = $group->getConfiguration();
$this->extra = $conf['FILES'];
}
/**
* @param FileBasedMessageGroup $group
*/
public function setGroup( FileBasedMessageGroup $group ) {
$this->group = $group;
}
/**
* @return FileBasedMessageGroup
*/
public function getGroup() {
return $this->group;
}
/**
* @param string $writePath
*/
public function setWritePath( $writePath ) {
$this->writePath = $writePath;
}
/**
* @return string
*/
public function getWritePath() {
return $this->writePath;
}
/**
* Returns true if the file for this message group in a given language
* exists. If no $code is given, the groups source language is assumed.
* NB: Some formats store all languages in the same file, and then this
* function will return true even if there are no translations to that
* language.
*
* @param string|bool $code
* @return bool
*/
public function exists( $code = false ) {
if ( $code === false ) {
$code = $this->group->getSourceLanguage();
}
$filename = $this->group->getSourceFilePath( $code );
if ( $filename === null ) {
return false;
}
return file_exists( $filename );
}
/**
* Reads messages from the file in a given language and returns an array
* of AUTHORS, MESSAGES and possibly other properties.
*
* @param string $code Language code.
* @return array|bool False if the file does not exist
* @throws MWException if the file is not readable or has bad encoding
*/
public function read( $code ) {
if ( !$this->exists( $code ) ) {
return false;
}
$filename = $this->group->getSourceFilePath( $code );
$input = file_get_contents( $filename );
if ( $input === false ) {
throw new MWException( "Unable to read file $filename." );
}
if ( !StringUtils::isUtf8( $input ) ) {
throw new MWException( "Contents of $filename are not valid utf-8." );
}
$input = Validator::cleanUp( $input );
// Strip BOM mark
$input = ltrim( $input, "\u{FEFF}" );
try {
return $this->readFromVariable( $input );
} catch ( Exception $e ) {
throw new MWException( "Parsing $filename failed: " . $e->getMessage() );
}
}
/**
* Parse the message data given as a string in the SimpleFFS format
* and return it as an array of AUTHORS and MESSAGES.
*
* @param string $data
* @return array Parsed data.
* @throws MWException
*/
public function readFromVariable( $data ) {
$parts = explode( self::PART_SEPARATOR, $data );
if ( count( $parts ) !== 2 ) {
throw new MWException( 'Wrong number of parts.' );
}
list( $authorsPart, $messagesPart ) = $parts;
$authors = explode( self::RECORD_SEPARATOR, $authorsPart );
$messages = [];
foreach ( explode( self::RECORD_SEPARATOR, $messagesPart ) as $line ) {
if ( $line === '' ) {
continue;
}
$lineParts = explode( '=', $line, 2 );
if ( count( $lineParts ) !== 2 ) {
throw new MWException( "Wrong number of parts in line $line." );
}
list( $key, $message ) = $lineParts;
$key = trim( $key );
$messages[$key] = $message;
}
$messages = $this->group->getMangler()->mangleArray( $messages );
return [
'AUTHORS' => $authors,
'MESSAGES' => $messages,
];
}
/**
* Write the collection to file.
*
* @param MessageCollection $collection
* @throws MWException
*/
public function write( MessageCollection $collection ) {
$writePath = $this->writePath;
if ( $writePath === null ) {
throw new MWException( 'Write path is not set.' );
}
if ( !file_exists( $writePath ) ) {
throw new MWException( "Write path '$writePath' does not exist." );
}
if ( !is_writable( $writePath ) ) {
throw new MWException( "Write path '$writePath' is not writable." );
}
$targetFile = $writePath . '/' . $this->group->getTargetFilename( $collection->code );
$targetFileExists = file_exists( $targetFile );
if ( $targetFileExists ) {
$this->tryReadSource( $targetFile, $collection );
} else {
$sourceFile = $this->group->getSourceFilePath( $collection->code );
$this->tryReadSource( $sourceFile, $collection );
}
$output = $this->writeReal( $collection );
if ( !$output ) {
return;
}
// Some file formats might have changing parts, such as timestamp.
// This allows the file handler to skip updating files, where only
// the timestamp would change.
if ( $targetFileExists ) {
$oldContent = $this->tryReadFile( $targetFile );
if ( !$this->shouldOverwrite( $oldContent, $output ) ) {
return;
}
}
wfMkdirParents( dirname( $targetFile ), null, __METHOD__ );
file_put_contents( $targetFile, $output );
}
/**
* Read a collection and return it as a SimpleFFS formatted string.
*
* @param MessageCollection $collection
* @return string
*/
public function writeIntoVariable( MessageCollection $collection ) {
$sourceFile = $this->group->getSourceFilePath( $collection->code );
$this->tryReadSource( $sourceFile, $collection );
return $this->writeReal( $collection );
}
/**
* @param MessageCollection $collection
* @return string
*/
protected function writeReal( MessageCollection $collection ) {
$output = '';
$authors = $collection->getAuthors();
$authors = $this->filterAuthors( $authors, $collection->code );
$output .= implode( self::RECORD_SEPARATOR, $authors );
$output .= self::PART_SEPARATOR;
$mangler = $this->group->getMangler();
/** @var TMessage $m */
foreach ( $collection as $key => $m ) {
$key = $mangler->unmangle( $key );
$trans = $m->translation();
$output .= "$key=$trans" . self::RECORD_SEPARATOR;
}
return $output;
}
/**
* This tries to pick up external authors in the source files so that they
* are not lost if those authors are not among those who have translated in
* the wiki.
*
* @todo Get rid of this
* @param string $filename
* @param MessageCollection $collection
*/
protected function tryReadSource( $filename, MessageCollection $collection ) {
$ffs = $this->group->getFFS();
if ( $ffs === null ) {
return;
}
if ( get_class( $ffs ) !== get_class( $this ) ) {
return;
}
$sourceText = $this->tryReadFile( $filename );
// No need to do anything in SimpleFFS if it's false,
// it only reads author data from it.
if ( $sourceText !== false ) {
$sourceData = $this->readFromVariable( $sourceText );
if ( isset( $sourceData['AUTHORS'] ) ) {
$collection->addCollectionAuthors( $sourceData['AUTHORS'] );
}
}
}
/**
* Read the contents of $filename and return it as a string.
* Return false if the file doesn't exist.
* Throw an exception if the file isn't readable
* or if the reading fails strangely.
*
* @param string $filename
* @return bool|string
* @throws MWException
*/
protected function tryReadFile( $filename ) {
if ( !$filename ) {
return false;
}
if ( !file_exists( $filename ) ) {
return false;
}
if ( !is_readable( $filename ) ) {
throw new MWException( "File $filename is not readable." );
}
$data = file_get_contents( $filename );
if ( $data === false ) {
throw new MWException( "Unable to read file $filename." );
}
return $data;
}
/**
* Remove blacklisted authors.
*
* @param array $authors
* @param string $code
* @return array
*/
protected function filterAuthors( array $authors, $code ) {
global $wgTranslateAuthorBlacklist;
$groupId = $this->group->getId();
foreach ( $authors as $i => $v ) {
$hash = "$groupId;$code;$v";
$blacklisted = false;
foreach ( $wgTranslateAuthorBlacklist as $rule ) {
list( $type, $regex ) = $rule;
if ( preg_match( $regex, $hash ) ) {
if ( $type === 'white' ) {
$blacklisted = false;
break;
} else {
$blacklisted = true;
}
}
}
if ( $blacklisted ) {
unset( $authors[$i] );
}
}
return $authors;
}
/**
* Replaces all Windows and Mac line endings with Unix line endings.
* This is needed in some file types.
*
* @param string $data
* @return string
*/
public static function fixNewLines( $data ) {
$data = str_replace( "\r\n", "\n", $data );
$data = str_replace( "\r", "\n", $data );
return $data;
}
public function isContentEqual( $a, $b ) {
return $a === $b;
}
public function shouldOverwrite( $a, $b ) {
return true;
}
}
|