class-wpml-tm-xliff-writer.php
13.8 KB
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
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
<?php
/**
* @package wpml-core
*/
use WPML\FP\Obj;
use WPML\TM\Jobs\FieldId;
class WPML_TM_Xliff_Writer {
const TAB = "\t";
protected $job_factory;
private $xliff_version;
private $xliff_shortcodes;
private $translator_notes;
/**
* WPML_TM_xliff constructor.
*
* @param WPML_Translation_Job_Factory $job_factory
* @param string $xliff_version
* @param \WPML_TM_XLIFF_Shortcodes|null $xliff_shortcodes
*/
public function __construct( WPML_Translation_Job_Factory $job_factory, $xliff_version = TRANSLATION_PROXY_XLIFF_VERSION, WPML_TM_XLIFF_Shortcodes $xliff_shortcodes = null ) {
$this->job_factory = $job_factory;
$this->xliff_version = $xliff_version;
if ( ! $xliff_shortcodes ) {
$xliff_shortcodes = wpml_tm_xliff_shortcodes();
}
$this->xliff_shortcodes = $xliff_shortcodes;
$this->translator_notes = new WPML_TM_XLIFF_Translator_Notes();
}
/**
* Generate a XLIFF file for a given job.
*
* @param int $job_id
*
* @return resource XLIFF representation of the job
*/
public function get_job_xliff_file( $job_id ) {
return $this->generate_xliff_file( $this->generate_job_xliff( $job_id ) );
}
/**
* Generate a XLIFF string for a given post or external type (e.g. package) job.
*
* @param int $job_id
* @param bool $apply_memory
*
* @return string XLIFF representation of the job
*/
public function generate_job_xliff( $job_id, $apply_memory = true ) {
/** @var TranslationManagement $iclTranslationManagement */
global $iclTranslationManagement;
// don't include not-translatable and don't auto-assign
$job = $iclTranslationManagement->get_translation_job( (int) $job_id, false, false, 1 );
$translation_units = $this->get_job_translation_units_data( $job, $apply_memory );
$original = $job_id . '-' . md5( $job_id . $job->original_doc_id );
$original_post_type = isset( $job->original_post_type ) ? $job->original_post_type : null;
$external_file_url = $this->get_external_url( $job );
$this->get_translator_notes( $job );
$xliff = $this->generate_xliff(
$original,
$job->source_language_code,
$job->language_code,
$translation_units,
$external_file_url,
$original_post_type
);
return $xliff;
}
/**
* Generate a XLIFF file for a given set of strings.
*
* @param array $strings
* @param string $source_language
* @param string $target_language
*
* @return resource XLIFF file
*/
public function get_strings_xliff_file( $strings, $source_language, $target_language ) {
$strings = $this->pre_populate_strings_with_translation_memory( $strings, $source_language, $target_language );
return $this->generate_xliff_file(
$this->generate_xliff(
uniqid( 'string-', true ),
$source_language,
$target_language,
$this->generate_strings_translation_units_data( $strings )
)
);
}
private function generate_xliff(
$original_id,
$source_language,
$target_language,
array $translation_units = array(),
$external_file_url = null,
$original_post_type = null
) {
$xliff = new WPML_TM_XLIFF( $this->get_xliff_version(), '1.0', 'utf-8' );
$phase_group = array();
$phase_group = array_merge( $phase_group, $this->xliff_shortcodes->get() );
$phase_group = array_merge( $phase_group, $this->translator_notes->get() );
$post_type_phase = new WPML_TM_XLIFF_Post_Type( $original_post_type );
$phase_group = array_merge( $phase_group, $post_type_phase->get() );
$string = $xliff
->setFileAttributes(
array(
'original' => $original_id,
'source-language' => $source_language,
'target-language' => $target_language,
'datatype' => 'plaintext',
)
)
->setReferences(
array(
'external-file' => $external_file_url,
)
)
->setPhaseGroup( $phase_group )
->setTranslationUnits( $translation_units )
->toString();
return $string;
}
private function get_xliff_version() {
switch ( $this->xliff_version ) {
case '10':
return '1.0';
case '11':
return '1.1';
case '12':
default:
return '1.2';
}
}
/**
* Generate translation units for a given set of strings.
*
* The units are the actual content to be translated
* Represented as a source and a target
*
* @param array $strings
*
* @return array The translation units representation
*/
private function generate_strings_translation_units_data( $strings ) {
$translation_units = array();
foreach ( $strings as $string ) {
$id = 'string-' . $string->id;
$translation_units[] = $this->get_translation_unit_data( $id, 'string', $string->value, $string->translation, $string->translated_from_memory );
}
return $translation_units;
}
/**
* @param stdClass[] $strings
* @param string $source_lang
* @param string $target_lang
*
* @return stdClass[]
*/
private function pre_populate_strings_with_translation_memory( $strings, $source_lang, $target_lang ) {
$strings_to_translate = wp_list_pluck( $strings, 'value' );
$original_translated_map = $this->get_original_translated_map_from_translation_memory( $strings_to_translate, $source_lang, $target_lang );
foreach ( $strings as &$string ) {
$string->translated_from_memory = false;
$string->translation = $string->value;
if ( array_key_exists( $string->value, $original_translated_map ) ) {
$string->translation = $original_translated_map[ $string->value ];
$string->translated_from_memory = true;
}
}
return $strings;
}
/**
* @param array $strings_to_translate
* @param string $source_lang
* @param string $target_lang
*
* @return array
*/
private function get_original_translated_map_from_translation_memory( $strings_to_translate, $source_lang, $target_lang ) {
$args = array(
'strings' => $strings_to_translate,
'source_lang' => $source_lang,
'target_lang' => $target_lang,
);
$strings_in_memory = apply_filters( 'wpml_st_get_translation_memory', array(), $args );
if ( $strings_in_memory ) {
return wp_list_pluck( $strings_in_memory, 'translation', 'original' );
}
return array();
}
/**
* Generate translation units.
*
* The units are the actual content to be translated
* Represented as a source and a target
*
* @param stdClass $job
* @param bool $apply_memory
*
* @return array The translation units data
*/
private function get_job_translation_units_data( $job, $apply_memory ) {
$translation_units = array();
/** @var array $elements */
$elements = $job->elements;
if ( $elements ) {
$elements = $this->pre_populate_elements_with_translation_memory( $elements, $job->source_language_code, $job->language_code );
foreach ( $elements as $element ) {
if ( 1 === (int) $element->field_translate ) {
$field_data_translated = base64_decode( $element->field_data_translated );
$field_data = base64_decode( $element->field_data );
/**
* It modifies the content of a single field data which represents, for example, one paragraph in post content.
*
* @since 2.10.0
* @param string $field_data
*/
$field_data = apply_filters( 'wpml_tm_xliff_unit_field_data', $field_data );
if ( 0 === strpos( $element->field_type, 'field-' ) ) {
$field_data_translated = apply_filters(
'wpml_tm_xliff_export_translated_cf',
$field_data_translated,
$element
);
$field_data = apply_filters(
'wpml_tm_xliff_export_original_cf',
$field_data,
$element
);
}
// check for untranslated fields and copy the original if required.
if ( ! null === $field_data_translated || '' === $field_data_translated ) {
$field_data_translated = $this->remove_invalid_chars( $field_data );
}
if ( $this->is_valid_unit_content( $field_data ) ) {
$translation_units[] = $this->get_translation_unit_data(
$element->field_type,
$element->field_type,
$field_data,
$apply_memory ? $field_data_translated : null,
$apply_memory && $element->translated_from_memory,
$element->field_wrap_tag,
$this->get_field_title( $element, $job )
);
}
}
}
}
return $translation_units;
}
/**
* @param \stdClass $field
* @param \stdClass $job
*
* @return string
*/
private function get_field_title( $field, $job ) {
$result = apply_filters( 'wpml_tm_adjust_translation_fields', [ (array) $field ], $job, null );
return Obj::pathOr( '', [ 0, 'title' ], $result );
}
/**
* @param array $elements
* @param string $source_lang
* @param string $target_lang
*
* @return array
*/
private function pre_populate_elements_with_translation_memory( array $elements, $source_lang, $target_lang ) {
$strings_to_translate = array();
foreach ( $elements as &$element ) {
if ( preg_match( '/^package-string/', $element->field_type ) ) {
$strings_to_translate[ $element->tid ] = base64_decode( $element->field_data );
}
$element->translated_from_memory = FieldId::is_any_term_field( $element->field_type )
&& $element->field_data_translated
&& $element->field_data != $element->field_data_translated;
}
$original_translated_map = $this->get_original_translated_map_from_translation_memory( $strings_to_translate, $source_lang, $target_lang );
if ( $original_translated_map ) {
foreach ( $elements as &$element ) {
if ( array_key_exists( $element->tid, $strings_to_translate )
&& array_key_exists( $strings_to_translate[ $element->tid ], $original_translated_map )
) {
$element->field_data_translated = base64_encode( $original_translated_map[ $strings_to_translate[ $element->tid ] ] );
$element->translated_from_memory = true;
}
}
}
return $elements;
}
/**
* Get translation unit data.
*
* @param string $field_id Field ID.
* @param string $field_name Field name.
* @param string $field_data Field content.
* @param string $field_data_translated Field translated content.
* @param boolean $is_translated_from_memory Boolean flag - is translated from memory.
* @param string $field_wrap_tag Field wrap tag (h1...h6, etc.)
* @param string $title
*
* @return array
*/
private function get_translation_unit_data(
$field_id,
$field_name,
$field_data,
$field_data_translated,
$is_translated_from_memory = false,
$field_wrap_tag = '',
$title = ''
) {
global $sitepress;
$field_data = $this->remove_invalid_chars( $field_data );
$translation_unit = array();
$field_data = $this->remove_line_breaks_inside_tags( $field_data );
$field_data_translated = $this->remove_line_breaks_inside_tags( $field_data_translated );
if ( $sitepress->get_setting( 'xliff_newlines' ) === WPML_XLIFF_TM_NEWLINES_REPLACE ) {
$field_data = $this->replace_new_line_with_tag( $field_data );
$field_data_translated = $this->replace_new_line_with_tag( $field_data_translated );
}
if ( $title ) {
$translation_unit['attributes']['extradata'] = $title;
}
$translation_unit['attributes']['resname'] = $field_name;
$translation_unit['attributes']['restype'] = 'string';
$translation_unit['attributes']['datatype'] = 'html';
$translation_unit['attributes']['id'] = $field_id;
$translation_unit['source'] = array( 'content' => $field_data );
$translation_unit['target'] = array( 'content' => $field_data_translated );
$translation_unit['note'] = array( 'content' => $field_wrap_tag );
if ( $is_translated_from_memory ) {
$translation_unit['target']['attributes'] = array(
'state' => 'needs-review-translation',
'state-qualifier' => 'tm-suggestion',
);
}
return $translation_unit;
}
/**
* @param string $string
*
* @return string
*/
protected function replace_new_line_with_tag( $string ) {
return str_replace( array( "\n", "\r" ), array( '<br class="xliff-newline" />', '' ), $string );
}
private function remove_line_breaks_inside_tags( $string ) {
return preg_replace_callback( '/(<[^>]*>)/m', array( $this, 'remove_line_breaks_inside_tag_callback' ), $string );
}
/**
* @param array $matches
*
* @return string
*/
private function remove_line_breaks_inside_tag_callback( array $matches ) {
$tag_string = preg_replace( '/([\n\r\t ]+)/', ' ', $matches[0] );
$tag_string = preg_replace( '/(<[\s]+)/', '<', $tag_string );
return preg_replace( '/([\s]+>)/', '>', $tag_string );
}
/**
* @param string $string
*
* Remove all characters below 0x20 except for 0x09, 0x0A and 0x0D
* @see https://www.w3.org/TR/xml/#charsets
*
* @return string
*/
private function remove_invalid_chars( $string ) {
return preg_replace( '/[\x00-\x08\x0B-\x0C\x0E-\x1F]/', '', $string );
}
/**
* Save a xliff string to a temporary file and return the file ressource
* handle
*
* @param string $xliff_content
*
* @return resource XLIFF
*/
private function generate_xliff_file( $xliff_content ) {
$file = fopen( 'php://temp', 'rb+' );
if ( $file ) {
fwrite( $file, $xliff_content );
rewind( $file );
}
return $file;
}
/**
* @param $job
*
* @return false|null|string
*/
private function get_external_url( $job ) {
$external_file_url = null;
if ( isset( $job->original_doc_id ) && 'post' === $job->element_type_prefix ) {
$external_file_url = get_permalink( $job->original_doc_id );
return $external_file_url;
}
return $external_file_url;
}
/**
* @param $content
*
* @return bool
*/
private function is_valid_unit_content( $content ) {
$content = preg_replace( '/[^#\w]*/u', '', $content );
return $content || '0' === $content;
}
private function get_translator_notes( $job ) {
$this->translator_notes = new WPML_TM_XLIFF_Translator_Notes(
isset( $job->original_doc_id ) ? $job->original_doc_id : 0
);
}
}