locale.bulk.inc 12.9 KB
Newer Older
1
2
3
4
5
6
7
<?php

/**
 * @file
 * Mass import-export and batch import functionality for Gettext .po files.
 */

8
include_once DRUPAL_ROOT . '/core/includes/gettext.inc';
9
10
11
12

/**
 * User interface for the translation import screen.
 */
13
function locale_translate_import_form($form, &$form_state) {
14
  drupal_static_reset('language_list');
15
  $languages = language_list();
16
17
18
19
20
21
22
23

  // Initialize a language list to the ones available, including English if we
  // are to translate Drupal to English as well.
  $existing_languages = array();
  foreach ($languages as $langcode => $language) {
    if ($langcode != 'en' || locale_translate_english()) {
      $existing_languages[$langcode] = $language->name;
    }
24
  }
25

26
27
28
  // If we have no languages available, present the list of predefined languages
  // only. If we do have already added languages, set up two option groups with
  // the list of existing and then predefined languages.
29
  form_load_include($form_state, 'inc', 'language', 'language.admin');
30
31
32
  if (empty($existing_languages)) {
    $language_options = language_admin_predefined_list();
    $default = key($language_options);
33
34
  }
  else {
35
36
    $default = key($existing_languages);
    $language_options = array(
37
      t('Existing languages') => $existing_languages,
38
      t('Languages not yet added') => language_admin_predefined_list()
39
40
41
    );
  }

42
43
44
  $form['file'] = array(
    '#type' => 'file',
    '#title' => t('Translation file'),
45
46
47
    '#size' => 50,
    '#description' => t('A Gettext Portable Object (<em>.po</em>) file.'),
  );
48
49
50
  $form['langcode'] = array(
    '#type' => 'select',
    '#title' => t('Language'),
51
    '#options' => $language_options,
52
53
    '#default_value' => $default,
  );
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

  $form['customized'] = array(
    '#title' => t('Treat imported strings as custom translations'),
    '#type' => 'checkbox',
  );
  $form['overwrite_options'] = array(
    '#type' => 'container',
    '#tree' => TRUE,
  );
  $form['overwrite_options']['not_customized'] = array(
    '#title' => t('Overwrite non-customized translations'),
    '#type' => 'checkbox',
    '#states' => array(
      'checked' => array(
         ':input[name="customized"]' => array('checked' => TRUE),
      ),
70
71
    ),
  );
72
73
74
75
  $form['overwrite_options']['customized'] = array(
    '#title' => t('Overwrite existing customized translations'),
    '#type' => 'checkbox',
  );
76

77
78
79
80
81
82
83
  $form['actions'] = array(
    '#type' => 'actions'
  );
  $form['actions']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Import')
  );
84
85
86
87
  return $form;
}

/**
88
 * Processes the locale import form submission.
89
90
91
 */
function locale_translate_import_form_submit($form, &$form_state) {
  $validators = array('file_validate_extensions' => array('po'));
92
93

  // Ensure we have the file uploaded.
94
95
  if ($file = file_save_upload('file', $validators)) {

96
97
98
    // Add language, if not yet supported.
    $language = language_load($form_state['values']['langcode']);
    if (empty($language)) {
99
      include_once DRUPAL_ROOT . '/core/includes/standard.inc';
100
      $predefined = standard_language_list();
101
      $language = (object) array(
102
        'langcode' => $form_state['values']['langcode'],
103
      );
104
105
      $language = language_save($language);
      drupal_set_message(t('The language %language has been created.', array('%language' => t($language->name))));
106
    }
107
    $customized = $form_state['values']['customized'] ? LOCALE_CUSTOMIZED : LOCALE_NOT_CUSTOMIZED;
108
109

    // Now import strings into the language
110
    if ($return = _locale_import_po($file, $language->langcode, $form_state['values']['overwrite_options'], $customized) == FALSE) {
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
      $variables = array('%filename' => $file->filename);
      drupal_set_message(t('The translation import of %filename failed.', $variables), 'error');
      watchdog('locale', 'The translation import of %filename failed.', $variables, WATCHDOG_ERROR);
    }
  }
  else {
    drupal_set_message(t('File to import not found.'), 'error');
    $form_state['redirect'] = 'admin/config/regional/translate/import';
    return;
  }

  $form_state['redirect'] = 'admin/config/regional/translate';
  return;
}

/**
127
 * Builds form to export Gettext translation files.
128
 */
129
function locale_translate_export_form($form, &$form_state) {
130
  $languages = language_list();
131
132
133
134
135
  $language_options = array();
  foreach ($languages as $langcode => $language) {
    if ($langcode != 'en' || locale_translate_english()) {
      $language_options[$langcode] = $language->name;
    }
136
  }
137
  $language_default = language_default();
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
  if (empty($language_options)) {
    $form['langcode'] = array(
      '#type' => 'value',
      '#value' => LANGUAGE_SYSTEM,
    );
    $form['langcode_text'] = array(
      '#type' => 'item',
      '#title' => t('Language'),
      '#markup' => t('No language available. The export will only contain source strings.'),
    );
  }
  else {
    $form['langcode'] = array(
      '#type' => 'select',
      '#title' => t('Language'),
      '#options' => $language_options,
      '#default_value' => $language_default->langcode,
      '#empty_option' => t('Source text only, no translations'),
      '#empty_value' => LANGUAGE_SYSTEM,
    );
    $form['content_options'] = array(
      '#type' => 'fieldset',
      '#title' => t('Export options'),
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
      '#tree' => TRUE,
      '#states' => array(
        'invisible' => array(
           ':input[name="langcode"]' => array('value' => LANGUAGE_SYSTEM),
        ),
      ),
    );
    $form['content_options']['not_customized'] = array(
      '#type' => 'checkbox',
      '#title' => t('Include non-customized translations'),
      '#default_value' => TRUE,
    );
    $form['content_options']['customized'] = array(
      '#type' => 'checkbox',
      '#title' => t('Include customized translations'),
      '#default_value' => TRUE,
    );
    $form['content_options']['not_translated'] = array(
      '#type' => 'checkbox',
      '#title' => t('Include untranslated text'),
      '#default_value' => TRUE,
    );
186
187
  }

188
189
  $form['actions'] = array(
    '#type' => 'actions'
190
  );
191
192
193
  $form['actions']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Export')
194
195
196
197
198
  );
  return $form;
}

/**
199
 * Processes a translation (or template) export form submission.
200
 */
201
function locale_translate_export_form_submit($form, &$form_state) {
202
  // If template is required, language code is not given.
203
204
205
206
207
  if ($form_state['values']['langcode'] != LANGUAGE_SYSTEM) {
    $language = language_load($form_state['values']['langcode']);
  }
  else {
    $language = NULL;
208
  }
209
210
  $content_options = isset($form_state['values']['content_options']) ? $form_state['values']['content_options'] : array();
  _locale_export_po($language, _locale_export_po_generate($language, _locale_export_get_strings($language, $content_options)));
211
212
}

213
214
215
216
217
218
219
220
221
222
223
/**
 * Set a batch for newly added language.
 */
function locale_translate_add_language_set_batch($langcode) {
  // See if we have language files to import for the newly added language,
  // collect and import them.
  if ($batch = locale_translate_batch_import_files($langcode, TRUE)) {
    batch_set($batch);
  }
}

224
/**
225
 * Prepare a batch to import all translations.
226
227
 *
 * @param $langcode
228
229
230
 *   (optional) Language code to limit files being imported.
 * @param $finish_feedback
 *   (optional) Whether to give feedback to the user when finished.
231
232
 * @param $force
 *   (optional) Import all available files, even if they were imported before.
233
 *
234
235
236
237
 * @todo
 *   Integrate with update status to identify projects needed and integrate
 *   l10n_update functionality to feed in translation files alike.
 *   See http://drupal.org/node/1191488.
238
 */
239
function locale_translate_batch_import_files($langcode = NULL, $finish_feedback = FALSE, $force = FALSE) {
240
241
242
243
244
245
246
247
248
249
  $files = array();
  if (!empty($langcode)) {
    $langcodes = array($langcode);
  }
  else {
    // If langcode was not provided, make sure to only import files for the
    // languages we have enabled.
    $langcodes = array_keys(language_list());
  }
  foreach ($langcodes as $langcode) {
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
    $files = array_merge($files, locale_translate_get_interface_translation_files($langcode));
  }
  if (!$force) {
    $result = db_select('locale_file', 'lf')
      ->fields('lf', array('langcode', 'uri', 'timestamp'))
      ->condition('langcode', $langcodes)
      ->execute()
      ->fetchAllAssoc('uri');
    foreach ($result as $uri => $info) {
      if (isset($files[$uri]) && filemtime($uri) <= $info->timestamp) {
        // The file is already imported and it did not change since the import.
        // Remove it from file list and don't import it again.
        unset($files[$uri]);
      }
    }
265
  }
266
  return locale_translate_batch_build($files, $finish_feedback);
267
268
}

269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
/**
 * Get an array of available interface translation file.
 *
 * @param $langcode
 *   The langcode for the interface translation files. Pass NULL to get all
 *   available interface translation files.
 *
 * @return array
 *   An array of interface translation files.
 */
function locale_translate_get_interface_translation_files($langcode = NULL) {
  $directory = variable_get('locale_translate_file_directory', conf_path() . '/files/translations');
  return file_scan_directory($directory, '!' . (!empty($langcode) ? '\.' . preg_quote($langcode, '!') : '') . '\.po$!', array('recurse' => FALSE));
}

284
285
286
287
/**
 * Build a locale batch from an array of files.
 *
 * @param $files
288
289
290
 *   Array of file objects to import.
 * @param $finish_feedback
 *   (optional) Whether to give feedback to the user when finished.
291
292
 *
 * @return
293
 *   A batch structure or FALSE if $files was empty.
294
 */
295
function locale_translate_batch_build($files, $finish_feedback = FALSE) {
296
297
298
299
  $t = get_t();
  if (count($files)) {
    $operations = array();
    foreach ($files as $file) {
300
301
      // We call locale_translate_batch_import for every batch operation.
      $operations[] = array('locale_translate_batch_import', array($file->uri));
302
303
304
305
306
307
308
309
    }
    $batch = array(
      'operations'    => $operations,
      'title'         => $t('Importing interface translations'),
      'init_message'  => $t('Starting import'),
      'error_message' => $t('Error importing interface translations'),
      'file'          => drupal_get_path('module', 'locale') . '/locale.bulk.inc',
    );
310
311
    if ($finish_feedback) {
      $batch['finished'] = 'locale_translate_batch_finished';
312
313
314
315
316
317
318
319
320
321
322
323
324
325
    }
    return $batch;
  }
  return FALSE;
}

/**
 * Perform interface translation import as a batch step.
 *
 * @param $filepath
 *   Path to a file to import.
 * @param $results
 *   Contains a list of files imported.
 */
326
function locale_translate_batch_import($filepath, &$context) {
327
328
329
  // The filename is either {langcode}.po or {prefix}.{langcode}.po, so
  // we can extract the language code to use for the import from the end.
  if (preg_match('!(/|\.)([^\./]+)\.po$!', $filepath, $langcode)) {
330
331
332
333
334
335
    $file = locale_translate_file_create($filepath, $langcode[2]);
    $success = _locale_import_read_po('db-store', $file, array(), $langcode[2]);
    if ($success == NULL) {
      $file->langcode = $langcode[2];
      locale_translate_update_file_history($file);
    }
336
337
338
339
340
341
342
    $context['results'][] = $filepath;
  }
}

/**
 * Finished callback of system page locale import batch.
 */
343
function locale_translate_batch_finished($success, $results) {
344
  if ($success) {
345
    drupal_set_message(format_plural(count($results), 'One translation file imported.', '@count translation files imported.'));
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

/**
 * Creates a file object and populates the timestamp property.
 *
 * @param $filepath
 *   The filepath of a file to import.
 *
 * @return
 *   An object representing the file.
 */
function locale_translate_file_create($filepath) {
  $file = new stdClass();
  $file->filename = drupal_basename($filepath);
  $file->uri = $filepath;
  $file->timestamp = filemtime($file->uri);
  return $file;
}

/**
 * Update the {locale_file} table.
 *
 * @param $file
 *   Object representing the file just imported.
 *
 * @return integer
 *   FALSE on failure. Otherwise SAVED_NEW or SAVED_UPDATED.
 *
 * @see drupal_write_record()
 */
function locale_translate_update_file_history($file) {
  // Update or write new record.
  if (db_query("SELECT uri FROM {locale_file} WHERE uri = :uri AND langcode = :langcode", array(':uri' => $file->uri, ':langcode' => $file->langcode))->fetchField()) {
    $update = array('uri', 'langcode');
  }
  else {
    $update = array();
  }
  return drupal_write_record('locale_file', $file, $update);
}

/**
 * Deletes all interface translation files depending on the langcode.
 *
 * @param $langcode
 *   A langcode or NULL. Pass NULL to delete all interface translation files.
 */
function locale_translate_delete_translation_files($langcode) {
  $files = locale_translate_get_interface_translation_files($langcode);
396
  $return = TRUE;
397
398
399
400
  if (!empty($files)) {
    foreach ($files as $file) {
      $success = file_unmanaged_delete($file->uri);
      if (!$success) {
401
402
403
404
405
406
407
408
        $return = FALSE;
      }
      else {
        // Remove the registered translation file if any.
        db_delete('locale_file')
          ->condition('langcode', $langcode)
          ->condition('uri', $file->uri)
          ->execute();
409
410
411
      }
    }
  }
412
  return $return;
413
}