locale.module 54.1 KB
Newer Older
Dries's avatar
   
Dries committed
1
<?php
Dries's avatar
   
Dries committed
2

Dries's avatar
   
Dries committed
3
4
/**
 * @file
5
 * Enables the translation of the user interface to languages other than English.
Dries's avatar
   
Dries committed
6
 *
7
8
9
10
 * When enabled, multiple languages can be set up. The site interface can be
 * displayed in different languages, and nodes can have languages assigned. The
 * setup of languages and translations is completely web based. Gettext portable
 * object files are supported.
Dries's avatar
   
Dries committed
11
12
 */

13
use Drupal\Core\Language\Language;
14
use Drupal\Component\Utility\Crypt;
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
/**
 * Regular expression pattern used to localize JavaScript strings.
 */
const LOCALE_JS_STRING = '(?:(?:\'(?:\\\\\'|[^\'])*\'|"(?:\\\\"|[^"])*")(?:\s*\+\s*)?)+';

/**
 * Regular expression pattern used to match simple JS object literal.
 *
 * This pattern matches a basic JS object, but will fail on an object with
 * nested objects. Used in JS file parsing for string arg processing.
 */
const LOCALE_JS_OBJECT = '\{.*?\}';

/**
 * Regular expression to match an object containing a key 'context'.
 *
 * Pattern to match a JS object containing a 'context key' with a string value,
 * which is captured. Will fail if there are nested objects.
 */
define('LOCALE_JS_OBJECT_CONTEXT', '
  \{              # match object literal start
  .*?             # match anything, non-greedy
  (?:             # match a form of "context"
    \'context\'
    |
    "context"
    |
    context
  )
  \s*:\s*         # match key-value separator ":"
  (' . LOCALE_JS_STRING . ')  # match context string
  .*?             # match anything, non-greedy
  \}              # match end of object literal
');

/**
 * Flag for locally not customized interface translation.
 *
 * Such translations are imported from .po files downloaded from
 * localize.drupal.org for example.
 */
const LOCALE_NOT_CUSTOMIZED = 0;

/**
 * Flag for locally customized interface translation.
 *
 * Such translations are edited from their imported originals on the user
 * interface or are imported as customized.
 */
const LOCALE_CUSTOMIZED = 1;

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
/**
 * Translation update mode: Use local files only.
 *
 * When checking for available translation updates, only local files will be
 * used. Any remote translation file will be ignored. Also custom modules and
 * themes which have set a "server pattern" to use a remote translation server
 * will be ignored.
 */
const LOCALE_TRANSLATION_USE_SOURCE_LOCAL = 'local';

/**
 * Translation update mode: Use both remote and local files.
 *
 * When checking for available translation updates, both local and remote files
 * will be checked.
 */
const LOCALE_TRANSLATION_USE_SOURCE_REMOTE_AND_LOCAL = 'remote_and_local';

/**
 * Default location of gettext file on the translation server.
 *
 * @see locale_translation_default_translation_server().
 */
const LOCALE_TRANSLATION_DEFAULT_SERVER_PATTERN = 'http://ftp.drupal.org/files/translations/%core/%project/%project-%version.%language.po';

/**
93
94
95
96
97
98
99
100
101
102
103
104
 * The number of seconds that the translations status entry should be considered.
 */
const LOCALE_TRANSLATION_STATUS_TTL = 600;

/**
 * UI option for override of existing translations. Override any translation.
 */
const LOCALE_TRANSLATION_OVERWRITE_ALL = 'all';

/**
 * UI option for override of existing translations. Only override non-customized
 * translations.
105
 */
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
const LOCALE_TRANSLATION_OVERWRITE_NON_CUSTOMIZED = 'non_customized';

/**
 * UI option for override of existing translations. Don't override existing
 * translations.
 */
const LOCALE_TRANSLATION_OVERWRITE_NONE = 'none';

/**
 * Translation source is a remote file.
 */
const LOCALE_TRANSLATION_REMOTE = 'remote';

/**
 * Translation source is a local file.
 */
const LOCALE_TRANSLATION_LOCAL = 'local';

/**
 * Translation source is the current translation.
 */
const LOCALE_TRANSLATION_CURRENT = 'current';

Dries's avatar
   
Dries committed
129
/**
130
 * Implements hook_help().
Dries's avatar
   
Dries committed
131
 */
132
133
function locale_help($path, $arg) {
  switch ($path) {
134
    case 'admin/help#locale':
135
136
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
137
      $output .= '<p>' . t('The Locale module allows your Drupal site to be presented in languages other than the default English, and to be multilingual. The Locale module works by maintaining a database of translations, and examining text as it is about to be displayed. When a translation of the text is available in the language to be displayed, the translation is displayed rather than the original text. When a translation is unavailable, the original text is displayed, and then stored for review by a translator. For more information, see the online handbook entry for <a href="@locale">Locale module</a>.', array('@locale' => 'http://drupal.org/documentation/modules/locale/')) . '</p>';
138
139
140
141
142
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Translating interface text') . '</dt>';
      $output .= '<dd>' . t('Translations of text in the Drupal interface may be provided by:');
      $output .= '<ul>';
143
      $output .= '<li>' . t('<a href="@update">Automatic import</a> of translations when you add a language or enable a module or theme. These translations are obtained from the <a href="@url">Drupal translation server</a>. Although Drupal modules and themes may not be fully translated in all languages, new translations become available frequently. Interface translation updates can be downloaded and installed automatically at <a href="@config">regular intervals</a>.', array('@url' => 'http://localize.drupal.org', '@update' => url('admin/reports/translations'), '@config' => url('admin/config/regional/translate/settings'))) . '</li>';
144
      $output .= '<li>' . t("Translating within your site, using the Locale module's integrated <a href='@translate'>translation interface</a>.", array('@translate' => url('admin/config/regional/translate'))) . '</li>';
145
      $output .= '<li>' . t("If an existing translations do not meet your needs, the interface translations files in Gettext Portable Object (<em>.po</em>) format may be modified, or new <em>.po</em> files may be created, using a desktop Gettext editor. The Locale module's <a href='@import'>manual import</a> feature allows the translated strings from a new or modified <em>.po</em> file to be added to your site. The Locale module's <a href='@export'>export</a> feature generates files from your site's translated strings, that can either be shared with others or edited offline by a Gettext translation editor.", array('@import' => url('admin/config/regional/translate/import'), '@export' => url('admin/config/regional/translate/export'))) . '</li>';
146
147
      $output .= '</ul></dd>';
      $output .= '</dl>';
148
      return $output;
149

150
    case 'admin/config/regional/language':
151
      return '<p>' . t('Interface translations are automatically imported when a language is added, or when new modules or themes are enabled. The report, <a href="@update">Available translation updates</a>, shows the status. Interface text can be <a href="@translate">customized</a>.', array('@update' => url('admin/reports/translations'), '@translate' => url('admin/config/regional/translate'))) . '</p>';
152

153
    case 'admin/config/regional/translate':
154
      $output = '<p>' . t('This page allows a translator to search for specific translated and untranslated strings, and is used when creating or editing translations. (Note: Because translation tasks involves many strings, it may be more convenient to <a href="@export">export</a> strings for offline editing in a desktop Gettext translation editor). Searches may be limited to strings in a specific language.', array('@export' => url('admin/config/regional/translate/export'))) . '</p>';
155
      return $output;
156

157
    case 'admin/config/regional/translate/import':
158
      $output = '<p>' . t('Translation files are automatically downloaded and imported when <a href="@language">languages</a> are added, or when modules or themes are enabled.', array('@language' => url('admin/config/regional/language'))). '</p>';
159
160
      $output .= '<p>' . t('This page allows translators to manually import translated strings contained in a Gettext Portable Object (.po) file. Manual import may be used for customized translations or for the translation of custom modules and themes. To customize translations you can download a translation file from the <a href="@url">Drupal translation server</a> or <a href="@export">export</a> translations from the site, customize the translations using a Gettext translation editor, and import the result using this page.', array('@url' => 'http://localize.drupal.org', '@export' => url('admin/config/regional/translate/export'))) . '</p>';
      $output .= '<p>' . t('Note that importing large .po files may take several minutes.') . '</p>';
161
      return $output;
162

163
    case 'admin/config/regional/translate/export':
164
      return '<p>' . t('This page exports the translated strings used by your site. An export file may be in Gettext Portable Object (<em>.po</em>) form, which includes both the original string and the translation (used to share translations with others), or in Gettext Portable Object Template (<em>.pot</em>) form, which includes the original strings only (used to create new translations with a Gettext translation editor).') . '</p>';
Dries's avatar
   
Dries committed
165
  }
Dries's avatar
   
Dries committed
166
167
}

Dries's avatar
   
Dries committed
168
/**
169
 * Implements hook_menu().
Dries's avatar
   
Dries committed
170
 */
171
function locale_menu() {
172
  // Translation functionality.
173
  $items['admin/config/regional/translate'] = array(
174
175
    'title' => 'User interface translation',
    'description' => 'Translate the built-in user interface.',
176
    'route_name' => 'locale.translate_page',
177
    'weight' => -5,
178
  );
179
  $items['admin/config/regional/translate/translate'] = array(
180
    'title' => 'Translate',
181
    'type' => MENU_DEFAULT_LOCAL_TASK,
182
  );
183
  $items['admin/config/regional/translate/import'] = array(
184
    'title' => 'Import',
185
186
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_translate_import_form'),
187
    'access arguments' => array('translate interface'),
188
189
    'weight' => 20,
    'type' => MENU_LOCAL_TASK,
190
    'file' => 'locale.bulk.inc',
191
  );
192
  $items['admin/config/regional/translate/export'] = array(
193
    'title' => 'Export',
194
195
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_translate_export_form'),
196
    'access arguments' => array('translate interface'),
197
198
    'weight' => 30,
    'type' => MENU_LOCAL_TASK,
199
    'file' => 'locale.bulk.inc',
200
  );
201
202
  $items['admin/config/regional/translate/settings'] = array(
    'title' => 'Settings',
203
    'route_name' => 'locale.settings',
204
    'weight' => 100,
205
206
    'type' => MENU_LOCAL_TASK,
  );
207
208
209
  $items['admin/reports/translations'] = array(
    'title' => 'Available translation updates',
    'description' => 'Get a status report about available interface translations for your installed modules and themes.',
210
211
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_translation_status_form'),
212
213
214
    'access arguments' => array('translate interface'),
    'file' => 'locale.pages.inc',
  );
Dries's avatar
   
Dries committed
215

Dries's avatar
   
Dries committed
216
  return $items;
Dries's avatar
   
Dries committed
217
218
}

Dries's avatar
   
Dries committed
219
/**
220
 * Implements hook_permission().
Dries's avatar
   
Dries committed
221
 */
222
function locale_permission() {
223
  return array(
224
    'translate interface' => array(
225
      'title' => t('Translate interface texts'),
226
      'restrict access' => TRUE,
227
    ),
228
  );
229
230
231
}

/**
232
 * Implements hook_theme().
233
234
235
 */
function locale_theme() {
  return array(
236
237
238
239
    'locale_translate_edit_form_strings' => array(
      'render element' => 'form',
      'file' => 'locale.pages.inc',
    ),
240
241
242
    'locale_translation_last_check' => array(
      'variables' => array('last' => NULL),
      'file' => 'locale.pages.inc',
243
      'template' => 'locale-translation-last-check',
244
245
    ),
    'locale_translation_update_info' => array(
246
      'variables' => array('updates' => array(), 'not_found' => array()),
247
      'file' => 'locale.pages.inc',
248
      'template' => 'locale-translation-update-info',
249
    ),
250
251
  );
}
252

253
254
255
256
257
258
259
260
261
/**
 * Implements hook_stream_wrappers().
 */
function locale_stream_wrappers() {
  $wrappers = array(
    'translations' => array(
      'name' => t('Translation files'),
      'class' => 'Drupal\locale\TranslationsStream',
      'description' => t('Translation files'),
262
      'type' => STREAM_WRAPPERS_LOCAL_HIDDEN,
263
264
265
266
267
    ),
  );
  return $wrappers;
}

268
/**
269
 * Implements hook_language_insert().
270
 */
271
272
273
function locale_language_insert($language) {
  // @todo move these two cache clears out. See http://drupal.org/node/1293252
  // Changing the language settings impacts the interface.
274
  cache('page')->deleteAll();
275
  // Force JavaScript translation file re-creation for the new language.
276
  _locale_invalidate_js($language->id);
277
278
279
}

/**
280
 * Implements hook_language_update().
281
 */
282
283
284
function locale_language_update($language) {
  // @todo move these two cache clears out. See http://drupal.org/node/1293252
  // Changing the language settings impacts the interface.
285
  cache('page')->deleteAll();
286
  // Force JavaScript translation file re-creation for the modified language.
287
  _locale_invalidate_js($language->id);
288
289
290
}

/**
291
 * Implements hook_language_delete().
292
 */
293
294
function locale_language_delete($language) {
  // Remove translations.
295
  Drupal::service('locale.storage')->deleteTranslations(array('language' => $language->id));
296

297
298
  // Remove interface translation files.
  module_load_include('inc', 'locale', 'locale.bulk');
299
  locale_translate_delete_translation_files(array(), array($language->id));
300

301
  // Remove translated configuration objects.
302
  \Drupal\locale\Locale::config()->deleteLanguageTranslations($language->id);
303

304
  // Changing the language settings impacts the interface:
305
  _locale_invalidate_js($language->id);
306
  cache('page')->deleteAll();
307

308
  // Clear locale translation caches.
309
310
  locale_translation_status_delete_languages(array($language->id));
  cache()->delete('locale:' . $language->id);
311
312
}

313
314
315
316
317
318
319
320
321
322
323
324
325
326
/**
 * Returns list of translatable languages.
 *
 * @return array
 *   Array of installed languages keyed by language name. English is omitted
 *   unless it is marked as translatable.
 */
function locale_translatable_language_list() {
  $languages = language_list();
  if (!locale_translate_english()) {
    unset($languages['en']);
  }
  return $languages;
}
Dries's avatar
   
Dries committed
327

Dries's avatar
   
Dries committed
328
/**
329
 * Returns plural form index for a specific number.
Dries's avatar
   
Dries committed
330
 *
331
 * The index is computed from the formula of this language.
332
 *
333
334
335
336
337
 * @param $count
 *   Number to return plural for.
 * @param $langcode
 *   Optional language code to translate to a language other than
 *   what is used to display the page.
338
339
340
341
 * @return
 *   The numeric index of the plural variant to use for this $langcode and
 *   $count combination or -1 if the language was not found or does not have a
 *   plural formula.
Dries's avatar
   
Dries committed
342
 */
343
function locale_get_plural($count, $langcode = NULL) {
344
  $language_interface = language(Language::TYPE_INTERFACE);
345
346
347
348
349
350

  // Used to locally cache the plural formulas for all languages.
  $plural_formulas = &drupal_static(__FUNCTION__, array());
  // Used to store precomputed plural indexes corresponding to numbers
  // individually for each language.
  $plural_indexes = &drupal_static(__FUNCTION__ . ':plurals', array());
Dries's avatar
   
Dries committed
351

352
  $langcode = $langcode ? $langcode : $language_interface->id;
353

354
355
356
  if (!isset($plural_indexes[$langcode][$count])) {
    // Retrieve and statically cache the plural formulas for all languages.
    if (empty($plural_formulas)) {
357
      $plural_formulas = Drupal::state()->get('locale.translation.plurals') ?: array();
Dries's avatar
   
Dries committed
358
    }
359
360
361
362
    // If there is a plural formula for the language, evaluate it for the given
    // $count and statically cache the result for the combination of language
    // and count, since the result will always be identical.
    if (!empty($plural_formulas[$langcode])) {
363
364
365
      // $n is used inside the expression in the eval().
      $n = $count;
      $plural_indexes[$langcode][$count] = @eval('return intval(' . $plural_formulas[$langcode]['formula'] . ');');
366
367
368
369
370
    }
    // In case there is no plural formula for English (no imported translation
    // for English), use a default formula.
    elseif ($langcode == 'en') {
      $plural_indexes[$langcode][$count] = (int) ($count != 1);
Dries's avatar
   
Dries committed
371
    }
372
    // Otherwise, return -1 (unknown).
Dries's avatar
   
Dries committed
373
    else {
374
      $plural_indexes[$langcode][$count] = -1;
375
    }
Dries's avatar
   
Dries committed
376
  }
377
  return $plural_indexes[$langcode][$count];
378
}
Dries's avatar
   
Dries committed
379

380

381
/**
382
383
384
 * Implements hook_modules_installed().
 */
function locale_modules_installed($modules) {
385
386
  $components['module'] = $modules;
  locale_system_update($components);
387
388
}

389
390
391
392
/**
 * Implements hook_modules_uninstalled().
 */
function locale_modules_uninstalled($modules) {
393
394
  $components['module'] = $modules;
  locale_system_remove($components);
395
396
}

397
398
399
400
401
402
403
/**
 * Implements hook_themes_enabled().
 *
 * @todo This is technically wrong. We must not import upon enabling, but upon
 *   initial installation. The theme system is missing an installation hook.
 */
function locale_themes_enabled($themes) {
404
405
  $components['theme'] = $themes;
  locale_system_update($components);
406
407
}

408
409
410
411
/**
 * Implements hook_themes_disabled().
 */
function locale_themes_disabled($themes) {
412
413
  $components['theme'] = $themes;
  locale_system_remove($components);
414
415
}

416
417
418
419
420
421
422
423
424
425
426
/**
 * Implements hook_cron().
 *
 * @see drupal_cron_run()
 * @see locale_queue_info()
 */
function locale_cron() {
  // Update translations only when an update frequency was set by the admin
  // and a translatable language was set.
  // Update tasks are added to the queue here but processed by Drupal's cron
  // using the cron worker defined in locale_queue_info().
427
  if ($frequency = Drupal::config('locale.settings')->get('translation.update_interval_days') && locale_translatable_language_list()) {
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
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
    module_load_include('translation.inc', 'locale');
    locale_cron_fill_queue();
  }
}

/**
 * Implements hook_queue_info().
 */
function locale_queue_info() {
  $queues['locale_translation'] = array(
    'title' => t('Update translations'),
    'worker callback' => 'locale_translation_worker',
    'cron' => array(
      'time' => 30,
    ),
  );
  return $queues;
}

/**
 * Callback: Executes interface translation queue tasks.
 *
 * The translation update functions executed here are batch operations which
 * are also used in translation update batches. The batch functions may need to
 * be executed multiple times to complete their task, typically this is the
 * translation import function. When a batch function is not finished, a new
 * queue task is created and added to the end of the queue. The batch context
 * data is needed to continue the batch task is stored in the queue with the
 * queue data.
 *
 * @param array $data
 * Queue data array containing:
 *   - Function name.
 *   - Array of function arguments. Optionally contains the batch context data.
 *
 * @see locale_queue_info()
 */
function locale_translation_worker($data) {
  module_load_include('batch.inc', 'locale');
  list($function, $args) = $data;

  // We execute batch operation functions here to check, download and import the
  // translation files. Batch functions use a context variable as last argument
  // which is passed by reference. When a batch operation is called for the
  // first time a default batch context is created. When called iterative
  // (usually the batch import function) the batch context is passed through via
  // the queue and is part of the $data.
  $last = count($args) - 1;
  if (!is_array($args[$last]) || !isset($args[$last]['finished'])) {
    $batch_context = array(
      'sandbox'  => array(),
      'results'  => array(),
      'finished' => 1,
      'message'  => '',
    );
  }
  else {
    $batch_context = $args[$last];
    unset ($args[$last]);
  }
  $args = array_merge($args, array(&$batch_context));

  // Call the batch operation function.
  call_user_func_array($function, $args);

  // If the batch operation is not finished we create a new queue task to
  // continue the task. This is typically the translation import task.
  if ($batch_context['finished'] < 1) {
    unset($batch_context['strings']);
    $queue = Drupal::queue('locale_translation', TRUE);
    $queue->createItem(array($function, $args));
  }
}

502
503
/**
 * Imports translations when new modules or themes are installed.
504
 *
505
506
 * This function will start a batch to import translations for the added
 * components.
507
 *
508
 * @param array $components
509
510
 *   An array of arrays of component (theme and/or module) names to import
 *   translations for, indexed by type.
511
 */
512
513
514
515
function locale_system_update(array $components) {
  $components += array('module' => array(), 'theme' => array());
  $list = array_merge($components['module'], $components['theme']);

516
517
518
  // Skip running the translation imports if in the installer,
  // because it would break out of the installer flow. We have
  // built-in support for translation imports in the installer.
519
  if (!drupal_installation_attempted() && locale_translatable_language_list() && Drupal::config('locale.settings')->get('translation.import_enabled')) {
520
521
522
523
524
525
    module_load_include('compare.inc', 'locale');

    // Update the list of translatable projects and start the import batch.
    // Only when new projects are added the update batch will be triggered. Not
    // each enabled module will introduce a new project. E.g. sub modules.
    $projects = array_keys(locale_translation_build_projects());
526
    if ($list = array_intersect($list, $projects)) {
527
528
529
      module_load_include('fetch.inc', 'locale');
      // Get translation status of the projects, download and update translations.
      $options = _locale_translation_default_update_options();
530
531
532
533
534
      $batch = locale_translation_batch_update_build($list, array(), $options);
      batch_set($batch);
    }
    Drupal::moduleHandler()->loadInclude('locale', 'bulk.inc');
    if ($batch = locale_config_batch_update_components(array(), array(), $components)) {
535
536
      batch_set($batch);
    }
537
538
539
  }
}

540
541
542
543
544
545
546
547
/**
 * Delete translation history of modules and themes.
 *
 * Only the translation history is removed, not the source strings or
 * translations. This is not possible because strings are shared between
 * modules and we have no record of which string is used by which module.
 *
 * @param array $components
548
549
 *   An array of arrays of component (theme and/or module) names to import
 *   translations for, indexed by type.
550
551
 */
function locale_system_remove($components) {
552
553
554
  $components += array('module' => array(), 'theme' => array());
  $list = array_merge($components['module'], $components['theme']);
  if ($language_list = locale_translatable_language_list()) {
555
    module_load_include('compare.inc', 'locale');
556
557
558
    Drupal::moduleHandler()->loadInclude('locale', 'bulk.inc');
    // Delete configuration translations.
    \Drupal\locale\Locale::config()->deleteComponentTranslations($components, array_keys($language_list));
559
560
561
562

    // Only when projects are removed, the translation files and records will be
    // deleted. Not each disabled module will remove a project. E.g. sub modules.
    $projects = array_keys(locale_translation_get_projects());
563
564
    if ($list = array_intersect($list, $projects)) {
      locale_translation_file_history_delete($list);
565
566

      // Remove translation files.
567
      locale_translate_delete_translation_files($list, array());
568
569
570
571
572

      // Remove translatable projects.
      // Followup issue http://drupal.org/node/1842362 to replace the
      // {locale_project} table. Then change this to a function call.
      db_delete('locale_project')
573
        ->condition('name', $list)
574
575
576
        ->execute();

      // Clear the translation status.
577
      locale_translation_status_delete_projects($list);
578
    }
579

580
581
582
  }
}

583
/**
584
 * Implements hook_js_alter().
585
 */
586
function locale_js_alter(&$javascript) {
587
588
589
590
591
592
593
594
595
596
  $files = array();
  foreach ($javascript as $item) {
    if (isset($item['type']) && $item['type'] == 'file') {
      $files[] = $item['data'];
    }
  }
  if ($translation_file = locale_js_translate($files)) {
    $javascript[$translation_file] = drupal_js_defaults($translation_file);
  }
}
597

598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
/**
 * Returns a list of translation files given a list of JavaScript files.
 *
 * This function checks all JavaScript files passed and invokes parsing if they
 * have not yet been parsed for Drupal.t() and Drupal.formatPlural() calls.
 * Also refreshes the JavaScript translation files if necessary, and returns
 * the filepath to the translation file (if any).
 *
 * @param array $files
 *   An array of local file paths.
 * @return string|NULL
 *   The filepath to the translation file or NULL if no translation is
 *   applicable.
 */
function locale_js_translate(array $files = array()) {
613
  $language_interface = language(Language::TYPE_INTERFACE);
614

615
  $dir = 'public://' . Drupal::config('locale.settings')->get('javascript.directory');
616
  $parsed = Drupal::state()->get('system.javascript_parsed') ?: array();
617
618
619
620
621
622
623
624
625
  $new_files = FALSE;

  foreach ($files as $filepath) {
    if (!in_array($filepath, $parsed)) {
      // Don't parse our own translations files.
      if (substr($filepath, 0, strlen($dir)) != $dir) {
        _locale_parse_js_file($filepath);
        $parsed[] = $filepath;
        $new_files = TRUE;
626
627
628
629
630
631
632
633
      }
    }
  }

  // If there are any new source files we parsed, invalidate existing
  // JavaScript translation files for all languages, adding the refresh
  // flags into the existing array.
  if ($new_files) {
634
    $parsed += _locale_invalidate_js();
635
636
637
  }

  // If necessary, rebuild the translation file for the current language.
638
  if (!empty($parsed['refresh:' . $language_interface->id])) {
639
640
    // Don't clear the refresh flag on failure, so that another try will
    // be performed later.
641
    if (_locale_rebuild_js()) {
642
      unset($parsed['refresh:' . $language_interface->id]);
643
644
    }
    // Store any changes after refresh was attempted.
645
    Drupal::state()->set('system.javascript_parsed', $parsed);
646
647
648
  }
  // If no refresh was attempted, but we have new source files, we need
  // to store them too. This occurs if current page is in English.
649
  elseif ($new_files) {
650
    Drupal::state()->set('system.javascript_parsed', $parsed);
651
652
653
  }

  // Add the translation JavaScript file to the page.
654
  $locale_javascripts = Drupal::state()->get('translation.javascript') ?: array();
655
656
  $translation_file = NULL;
  if (!empty($files) && !empty($locale_javascripts[$language_interface->id])) {
657
    // Add the translation JavaScript file to the page.
658
    $translation_file = $dir . '/' . $language_interface->id . '_' . $locale_javascripts[$language_interface->id] . '.js';
659
  }
660
  return $translation_file;
661
662
}

663
664
665
666
667
668
/**
 * Implements hook_library_info().
 */
function locale_library_info() {
  $libraries['drupal.locale.admin'] = array(
    'title' => 'Locale',
669
    'version' => Drupal::VERSION,
670
671
672
673
674
675
676
677
678
679
680
    'js' => array(
      drupal_get_path('module', 'locale') . '/locale.admin.js' => array(),
    ),
    'dependencies' => array(
      array('system', 'jquery'),
      array('system', 'drupal'),
      array('system', 'jquery.once'),
    ),
  );
  $libraries['drupal.locale.datepicker'] = array(
    'title' => 'Locale Datepicker UI',
681
    'version' => Drupal::VERSION,
682
683
684
685
686
687
    'js' => array(
      drupal_get_path('module', 'locale') . '/locale.datepicker.js' => array(),
    ),
    'dependencies' => array(
      array('system', 'jquery'),
      array('system', 'drupal'),
688
      array('system', 'drupalSettings'),
689
690
691
692
693
694
    ),
  );

  return $libraries;
}

695
/**
696
 * Implement hook_library_info_alter().
697
698
699
 *
 * Provides the language support for the jQuery UI Date Picker.
 */
700
function locale_library_info_alter(&$libraries, $module) {
701
  if ($module == 'system' && isset($libraries['jquery.ui.datepicker'])) {
702
    $language_interface = language(Language::TYPE_INTERFACE);
703
704
705
    // locale.datepicker.js should be added in the JS_LIBRARY group, so that
    // this attach behavior will execute early. JS_LIBRARY is the default for
    // hook_library_info_alter(), thus does not have to be specified explicitly.
706
    $libraries['jquery.ui.datepicker']['dependencies'][] = array('locale', 'drupal.locale.datepicker');
707
    $libraries['jquery.ui.datepicker']['js'][] = array(
708
      'data' => array(
709
710
711
        'jquery' => array(
          'ui' => array(
            'datepicker' => array(
712
              'isRTL' => $language_interface->direction == Language::DIRECTION_RTL,
713
              'firstDay' => Drupal::config('system.date')->get('first_day'),
714
715
            ),
          ),
716
717
718
719
720
721
722
        ),
      ),
      'type' => 'setting',
    );
  }
}

723
/**
724
 * Implements hook_form_FORM_ID_alter() for language_admin_overview_form().
725
 */
726
function locale_form_language_admin_overview_form_alter(&$form, &$form_state) {
727
728
  $languages = $form['languages']['#languages'];

729
  $total_strings = Drupal::service('locale.storage')->countStrings();
730
731
732
733
  $stats = array_fill_keys(array_keys($languages), array());

  // If we have source strings, count translations and calculate progress.
  if (!empty($total_strings)) {
734
    $translations = Drupal::service('locale.storage')->countTranslations();
735
736
737
738
    foreach ($translations as $langcode => $translated) {
      $stats[$langcode]['translated'] = $translated;
      if ($translated > 0) {
        $stats[$langcode]['ratio'] = round($translated / $total_strings * 100, 2);
739
740
741
742
743
744
745
746
747
748
749
      }
    }
  }

  array_splice($form['languages']['#header'], -1, 0, t('Interface translation'));

  foreach ($languages as $langcode => $language) {
    $stats[$langcode] += array(
      'translated' => 0,
      'ratio' => 0,
    );
750
    if (!$language->locked && ($langcode != 'en' || locale_translate_english())) {
751
      $form['languages'][$langcode]['locale_statistics'] = array(
752
753
754
755
756
757
        '#markup' => l(
          t('@translated/@total (@ratio%)', array(
            '@translated' => $stats[$langcode]['translated'],
            '@total' => $total_strings,
            '@ratio' => $stats[$langcode]['ratio'],
          )),
758
          'admin/config/regional/translate',
759
760
          array('query' => array('langcode' => $langcode))
        ),
761
762
763
764
      );
    }
    else {
      $form['languages'][$langcode]['locale_statistics'] = array(
765
        '#markup' => t('not applicable'),
766
767
      );
    }
768
769
770
771
772
    // #type = link doesn't work with #weight on table.
    // reset and set it back after locale_statistics to get it at the right end.
    $operations = $form['languages'][$langcode]['operations'];
    unset($form['languages'][$langcode]['operations']);
    $form['languages'][$langcode]['operations'] = $operations;
773
774
  }
}
775
776

/**
777
778
779
780
781
782
783
784
 * Implements hook_form_FORM_ID_alter() for language_admin_add_form(().
 */
function locale_form_language_admin_add_form_alter(&$form, &$form_state) {
  $form['predefined_submit']['#submit'][] = 'locale_form_language_admin_add_form_alter_submit';
  $form['custom_language']['submit']['#submit'][] = 'locale_form_language_admin_add_form_alter_submit';
}

/**
785
786
787
 * Form submission handler for language_admin_add_form().
 *
 * Set a batch for a newly-added language.
788
789
 */
function locale_form_language_admin_add_form_alter_submit($form, $form_state) {
790
  if (Drupal::config('locale.settings')->get('translation.import_enabled')) {
791
792
793
794
795
796
    if (empty($form_state['values']['predefined_langcode']) || $form_state['values']['predefined_langcode'] == 'custom') {
      $langcode = $form_state['values']['langcode'];
    }
    else {
      $langcode = $form_state['values']['predefined_langcode'];
    }
797

798
799
800
801
    // Download and import translations for the newly added language.
    module_load_include('fetch.inc', 'locale');
    $options = _locale_translation_default_update_options();
    $batch = locale_translation_batch_update_build(array(), array($langcode), $options);
802
    batch_set($batch);
803
804
805
806
807
808

    // Create or update all configuration translations for this language.
    Drupal::moduleHandler()->loadInclude('locale', 'bulk.inc');
    if ($batch = locale_config_batch_update_components($options, array($langcode))) {
      batch_set($batch);
    }
809
  }
810
811
812
813
}

/**
 * Implements hook_form_FORM_ID_alter() for language_admin_edit_form().
814
 */
815
function locale_form_language_admin_edit_form_alter(&$form, &$form_state) {
816
817
818
819
820
821
  if ($form['langcode']['#type'] == 'value' && $form['langcode']['#value'] == 'en') {
    $form['locale_translate_english'] = array(
      '#title' => t('Enable interface translation to English'),
      '#type' => 'checkbox',
      '#default_value' => locale_translate_english(),
    );
822
    $form['actions']['submit']['#submit'][] = 'locale_form_language_admin_edit_form_alter_submit';
823
824
825
826
  }
}

/**
827
 * Form submission handler for language_admin_edit_form().
828
 */
829
function locale_form_language_admin_edit_form_alter_submit($form, $form_state) {
830
831
832
833
  variable_set('locale_translate_english', $form_state['values']['locale_translate_english']);
}

/**
834
835
836
837
 * Checks whether locale translates to English.
 *
 * @return bool
 *   Returns TRUE if content should be translated to English, FALSE otherwise.
838
839
840
841
 */
function locale_translate_english() {
  return variable_get('locale_translate_english', FALSE);
}
842
843
844
845
846
847
848

/**
 * Implements hook_form_FORM_ID_alter() for system_file_system_settings().
 *
 * Add interface translation directory setting to directories configuration.
 */
function locale_form_system_file_system_settings_alter(&$form, $form_state) {
849
  $form['translation_path'] = array(
850
851
    '#type' => 'textfield',
    '#title' => t('Interface translations directory'),
852
    '#default_value' => Drupal::config('locale.settings')->get('translation.path'),
853
    '#maxlength' => 255,
854
    '#description' => t('A local file system path where interface translation files will be stored.'),
855
    '#required' => TRUE,
856
857
858
859
860
861
    '#after_build' => array('system_check_directory'),
    '#weight' => 10,
  );
  if ($form['file_default_scheme']) {
    $form['file_default_scheme']['#weight'] = 20;
  }
862
863
864
865
866
867
868
869
870
871
872
  $form['#submit'][] = 'locale_system_file_system_settings_submit';
}

/**
 * Submit handler for the file system settings form.
 *
 * Clears the translation status when the Interface translations directory
 * changes. Without a translations directory local po files in the directory
 * should be ignored. The old translation status is no longer valid.
 */
function locale_system_file_system_settings_submit(&$form, $form_state) {
873
  if ($form['translation_path']['#default_value'] != $form_state['values']['translation_path']) {
874
875
    locale_translation_clear_status();
  }
876

877
  Drupal::config('locale.settings')
878
879
    ->set('translation.path', $form_state['values']['translation_path'])
    ->save();
880
}
881
882

/**
883
 * Implements hook_preprocess_HOOK() for node.html.twig.
884
885
 */
function locale_preprocess_node(&$variables) {
886
  if ($variables['node']->language()->id != Language::LANGCODE_NOT_SPECIFIED) {
887
    $language_interface = language(Language::TYPE_INTERFACE);
888

889
    $node_language = $variables['node']->language();
890
    if ($node_language->id != $language_interface->id) {
891
892
893
      // If the node language was different from the page language, we should
      // add markup to identify the language. Otherwise the page language is
      // inherited.
894
      $variables['attributes']['lang'] = $node_language->id;
895
      if ($node_language->direction != $language_interface->direction) {
896
897
898
        // If text direction is different form the page's text direction, add
        // direction information as well.
        $dir = array('ltr', 'rtl');
899
        $variables['attributes']['dir'] = $dir[$node_language->direction];
900
901
902
903
      }
    }
  }
}
904

905
906
907
908
909
910
911
912
913
914
915
916
917
/**
 * Gets current translation status from the {locale_file} table.
 *
 * @return array
 *   Array of translation file objects.
 */
function locale_translation_get_file_history() {
  $history = &drupal_static(__FUNCTION__, array());

  if (empty($history)) {
    // Get file history from the database.
    $result = db_query('SELECT project, langcode, filename, version, uri, timestamp, last_checked FROM {locale_file}');
    foreach ($result as $file) {
918
      $file->type = $file->timestamp ? LOCALE_TRANSLATION_CURRENT : '';
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
      $history[$file->project][$file->langcode] = $file;
    }
  }
  return $history;
}

/**
 * Updates the {locale_file} table.
 *
 * @param object $file
 *   Object representing the file just imported.
 *
 * @return integer
 *   FALSE on failure. Otherwise SAVED_NEW or SAVED_UPDATED.
 *
 * @see drupal_write_record()
 */
function locale_translation_update_file_history($file) {
  // Update or write new record.
  if (db_query("SELECT project FROM {locale_file} WHERE project = :project AND langcode = :langcode", array(':project' => $file->project, ':langcode' => $file->langcode))->fetchField()) {
    $update = array('project', 'langcode');
  }
  else {
    $update = array();
  }
944
945
946
947
948
  $result = drupal_write_record('locale_file', $file, $update);
  // The file history has changed, flush the static cache now.
  // @todo Can we make this more fine grained?
  drupal_static_reset('locale_translation_get_file_history');
  return $result;
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
}

/**
 * Deletes the history of downloaded translations.
 *
 * @param array $projects
 *   Project name(s) to be deleted from the file history. If both project(s) and
 *   language code(s) are specified the conditions will be ANDed.
 * @param array $langcode
 *   Language code(s) to be deleted from the file history.
 */
function locale_translation_file_history_delete($projects = array(), $langcodes = array()) {
  $query = db_delete('locale_file');
  if (!empty($projects)) {
    $query->condition('project', $projects);
  }
  if (!empty($langcodes)) {
    $query->condition('langcode', $langcodes);
  }
  $query->execute();
}

971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
 * Gets the current translation status.
 *
 * @todo What is 'translation status'?
 */
function locale_translation_get_status($projects = NULL, $langcodes = NULL) {
  $result = array();
  $status = Drupal::state()->get('locale.translation_status');
  module_load_include('translation.inc', 'locale');
  $projects = $projects ? $projects : array_keys(locale_translation_get_projects());
  $langcodes = $langcodes ? $langcodes : array_keys(locale_translatable_language_list());

  // Get the translation status of each project-language combination. If no
  // status was stored, a new translation source is created.
  foreach ($projects as $project) {
    foreach ($langcodes as $langcode) {
      if (isset($status[$project][$langcode])) {
        $result[$project][$langcode] = $status[$project][$langcode];
      }
      else {
        $sources = locale_translation_build_sources(array($project), array($langcode));
        if (isset($sources[$project][$langcode])) {
          $result[$project][$langcode] = $sources[$project][$langcode];
        }
      }
    }
  }
  return $result;
}

1001
1002
1003
/**
 * Saves the status of translation sources in static cache.
 *
1004
1005
1006
1007
1008
1009
 * @param string $project
 *   Machine readable project name.
 * @param string $langcode
 *   Language code.
 * @param string $type
 *   Type of data to be stored.
1010
 * @param array $data
1011
 *   File object also containing timestamp when the translation is last updated.
1012
 */
1013
function locale_translation_status_save($project, $langcode, $type, $data) {
1014
1015
1016
1017
  // Followup issue: http://drupal.org/node/1842362
  // Split status storage per module/language and expire individually. This will
  // improve performance for large sites.

1018
1019
1020
1021
1022
1023
1024
  // Load the translation status or build it if not already available.
  module_load_include('translation.inc', 'locale');
  $status = locale_translation_get_status();
  if (empty($status)) {
    $projects = locale_translation_get_projects(array($project));
    if (isset($projects[$project])) {
      $status[$project][$langcode] = locale_translation_source_build($projects[$project], $langcode);
1025
1026
1027
    }
  }

1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
  // Merge the new status data with the existing status.
  if (isset($status[$project][$langcode])) {
    switch ($type) {
      case LOCALE_TRANSLATION_REMOTE:
      case LOCALE_TRANSLATION_LOCAL:
        // Add the source data to the status array.
        $status[$project][$langcode]->files[$type] = $data;

        // Check if this translation is the most recent one. Set timestamp and
        // data type of the most recent translation source.
        if (isset($data->timestamp) && $data->timestamp) {
          if ($data->timestamp > $status[$project][$langcode]->timestamp) {
            $status[$project][$langcode]->timestamp = $data->timestamp;
            $status[$project][$langcode]->last_checked = REQUEST_TIME;
            $status[$project][$langcode]->type = $type;
          }
        }
        break;
      case LOCALE_TRANSLATION_CURRENT:
        $data->last_checked = REQUEST_TIME;
        $status[$project][$langcode]->timestamp = $data->timestamp;
        $status[$project][$langcode]->last_checked = $data->last_checked;
        $status[$project][$langcode]->type = $type;
        locale_translation_update_file_history($data);
        break;
    }

    Drupal::state()->set('locale.translation_status', $status);
    Drupal::state()->set('locale.translation_last_checked', REQUEST_TIME);
  }
1058
1059
1060
1061
1062
1063
1064
1065
1066
}

/**
 * Delete language entries from the status cache.
 *
 * @param array $langcodes
 *   Language code(s) to be deleted from the cache.
 */
function locale_translation_status_delete_languages($langcodes) {
1067
  if ($status = locale_translation_get_status()) {
1068
1069
1070
1071
1072
    foreach ($status as $project => $languages) {
      foreach ($languages as $langcode => $source) {
        if (in_array($langcode, $langcodes)) {
          unset($status[$project][$langcode]);
        }
1073
1074
      }
    }
1075
    Drupal::state()->set('locale.translation_status', $status);
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
  }
}

/**
 * Delete project entries from the status cache.
 *
 * @param array $projects
 *   Project name(s) to be deleted from the cache.
 */
function locale_translation_status_delete_projects($projects) {
1086
  $status = locale_translation_get_status();
1087
1088
1089
1090
1091
1092

  foreach ($status as $project => $languages) {
    if (in_array($project, $projects)) {
      unset($status[$project]);
    }
  }
1093
  Drupal::state()->set('locale.translation_status', $status);
1094
1095
}

1096
1097
1098
1099
/**
 * Clear the translation status cache.
 */
function locale_translation_clear_status() {
1100
1101
  Drupal::state()->delete('locale.translation_status');
  Drupal::state()->delete('locale.translation_last_checked');
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
}

/**
 * Checks whether remote translation sources are used.
 *
 * @return bool
 *   Returns TRUE if remote translations sources should be taken into account
 *   when checking or importing translation files, FALSE otherwise.
 */
function locale_translation_use_remote_source() {
1112
  return Drupal::config('locale.settings')->get('translation.use_source') == LOCALE_TRANSLATION_USE_SOURCE_REMOTE_AND_LOCAL;
1113
1114
}

1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
/**
 * Check that a string is safe to be added or imported as a translation.
 *
 * This test can be used to detect possibly bad translation strings. It should
 * not have any false positives. But it is only a test, not a transformation,
 * as it destroys valid HTML. We cannot reliably filter translation strings
 * on import because some strings are irreversibly corrupted. For example,
 * a &amp; in the translation would get encoded to &amp;amp; by filter_xss()
 * before being put in the database, and thus would be displayed incorrectly.
 *
 * The allowed tag list is like filter_xss_admin(), but omitting div and img as
 * not needed for translation and likely to cause layout issues (div) or a
 * possible attack vector (img).
 */
function locale_string_is_safe($string) {
  return decode_entities($string) == decode_entities(filter_xss($string, array('a', 'abbr', 'acronym', 'address', 'b', 'bdo', 'big', 'blockquote', 'br', 'caption', 'cite', 'code', 'col', 'colgroup', 'dd', 'del', 'dfn', 'dl', 'dt', 'em', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'ins', 'kbd', 'li', 'ol', 'p', 'pre', 'q', 'samp', 'small', 'span', 'strong', 'sub', 'sup', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead', 'tr', 'tt', 'ul', 'var')));
}

1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
/**
 * Refresh related information after string translations have been updated.
 *
 * The information that will be refreshed includes:
 * - JavaScript translations.
 * - Locale cache.
 *
 * @param array $langcodes
 *   Language codes for updated translations.
 * @param array $lids
1143
1144
 *   (optional) List of string identifiers that have been updated / created.
 *   If not provided, all caches for the affected languages are cleared.
1145
 */
1146
1147
1148
1149
function _locale_refresh_translations($langcodes, $lids = array()) {
  if (!empty($langcodes)) {
    // Update javascript translations if any of the strings has a javascript
    // location, or if no string ids were provided, update all languages.
1150
    if (empty($lids) || ($strings = Drupal::service('locale.storage')->getStrings(array('lid' => $lids, 'type' => 'javascript')))) {
1151
1152
1153
1154
      array_map('_locale_invalidate_js', $langcodes);
    }
  }
  // Clear locale cache.
1155
  cache()->deleteTags(array('locale' => TRUE));
1156
1157
}

1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
/**
 * Refreshes configuration after string translations have been updated.
 *
 * The information that will be refreshed includes:
 * - JavaScript translations.
 * - Locale cache.
 *
 * @param array $langcodes
 *   Language codes for updated translations.
 * @param array $lids
 *   List of string identifiers that have been updated / created.
 */
function _locale_refresh_configuration(array $langcodes, array $lids) {
  if ($lids && $langcodes && $names = \Drupal\locale\Locale::config()->getStringNames($lids)) {
    Drupal::moduleHandler()->loadInclude('locale', 'bulk.inc');
    locale_config_update_multiple($names, $langcodes);
  }
}

1177
1178
1179
/**
 * Parses a JavaScript file, extracts strings wrapped in Drupal.t() and
 * Drupal.formatPlural() and inserts them into the database.
1180
1181
1182
1183
1184
1185
 *
 * @param string $filepath
 *   File name to parse.
 *
 * @return array
 *   Array of string objects to update indexed by context and source.
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
 */
function _locale_parse_js_file($filepath) {
  // The file path might contain a query string, so make sure we only use the
  // actual file.
  $parsed_url = drupal_parse_url($filepath);
  $filepath = $parsed_url['path'];
  // Load the JavaScript file.
  $file = file_get_contents($filepath);

  // Match all calls to Drupal.t() in an array.
  // Note: \s also matches newlines with the 's' modifier.
  preg_match_all('~
    [^\w]Drupal\s*\.\s*t\s*                       # match "Drupal.t" with whitespace
    \(\s*                                         # match "(" argument list start
    (' . LOCALE_JS_STRING . ')\s*                 # capture string argument
    (?:,\s*' . LOCALE_JS_OBJECT . '\s*            # optionally capture str args
      (?:,\s*' . LOCALE_JS_OBJECT_CONTEXT . '\s*) # optionally capture context
    ?)?                                           # close optional args
    [,\)]                                         # match ")" or "," to finish
    ~sx', $file, $t_matches