locale.module 48.9 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\locale\LocaleLookup;
14
use Drupal\locale\LocaleConfigSubscriber;
15
16
use Drupal\locale\SourceString;
use Drupal\locale\StringDatabaseStorage;
17
use Drupal\locale\TranslationsStream;
18
use Drupal\Core\Database\Database;
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
/**
 * 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;

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
/**
 * 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';

/**
97
98
99
100
101
102
103
104
105
106
107
108
 * 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.
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
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';

/**
 * Translation source is a downloaded file.
 */
const LOCALE_TRANSLATION_DOWNLOADED = 'download';

/**
 * Translation source is an imported file.
 */
const LOCALE_TRANSLATION_IMPORTED = 'import';
142

Dries's avatar
   
Dries committed
143
/**
144
 * Implements hook_help().
Dries's avatar
   
Dries committed
145
 */
146
147
function locale_help($path, $arg) {
  switch ($path) {
148
    case 'admin/help#locale':
149
150
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
151
      $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>';
152
153
154
155
156
      $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>';
157
      $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>';
158
      $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>';
159
      $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>';
160
161
      $output .= '</ul></dd>';
      $output .= '</dl>';
162
      return $output;
163

164
    case 'admin/config/regional/language':
165
      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>';
166

167
    case 'admin/config/regional/translate':
168
      $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>';
169
      return $output;
170

171
    case 'admin/config/regional/translate/import':
172
173
      $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>';
      $output .= '<p>' . t('For situations where translations need to be manually imported, this page imports the translated strings contained in a Gettext Portable Object (.po) file, which can be downloaded from the <a href="@url">Drupal translation server</a>. Alternatively, a .po file may need to be imported after offline editing in a Gettext translation editor. Importing an individual .po file may be a lengthy process.', array('@url' => 'http://localize.drupal.org')) . '</p>';
174
      return $output;
175

176
    case 'admin/config/regional/translate/export':
177
      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
178
  }
Dries's avatar
   
Dries committed
179
180
}

Dries's avatar
   
Dries committed
181
/**
182
 * Implements hook_menu().
Dries's avatar
   
Dries committed
183
 */
184
function locale_menu() {
185
  // Translation functionality.
186
  $items['admin/config/regional/translate'] = array(
187
188
    'title' => 'User interface translation',
    'description' => 'Translate the built-in user interface.',
189
    'page callback' => 'locale_translate_page',
190
    'access arguments' => array('translate interface'),
191
    'file' => 'locale.pages.inc',
192
    'weight' => -5,
193
  );
194
  $items['admin/config/regional/translate/translate'] = array(
195
    'title' => 'Translate',
196
197
    'weight' => -10,
    'type' => MENU_DEFAULT_LOCAL_TASK,
198
  );
199
  $items['admin/config/regional/translate/import'] = array(
200
    'title' => 'Import',
201
202
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_translate_import_form'),
203
    'access arguments' => array('translate interface'),
204
205
    'weight' => 20,
    'type' => MENU_LOCAL_TASK,
206
    'file' => 'locale.bulk.inc',
207
  );
208
  $items['admin/config/regional/translate/export'] = array(
209
    'title' => 'Export',
210
211
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_translate_export_form'),
212
    'access arguments' => array('translate interface'),
213
214
    'weight' => 30,
    'type' => MENU_LOCAL_TASK,
215
    'file' => 'locale.bulk.inc',
216
  );
217
218
219
220
221
222
223
224
225
  $items['admin/config/regional/translate/settings'] = array(
    'title' => 'Settings',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_translate_settings'),
    'access arguments' => array('translate interface'),
    'weight' => 40,
    'type' => MENU_LOCAL_TASK,
    'file' => 'locale.pages.inc',
  );
226
227
228
  $items['admin/reports/translations'] = array(
    'title' => 'Available translation updates',
    'description' => 'Get a status report about available interface translations for your installed modules and themes.',
229
230
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_translation_status_form'),
231
232
233
234
235
236
237
238
239
240
    'access arguments' => array('translate interface'),
    'file' => 'locale.pages.inc',
  );
  $items['admin/reports/translations/check'] = array(
    'title' => 'Manual translation update check',
    'page callback' => 'locale_translation_manual_status',
    'access arguments' => array('translate interface'),
    'type' => MENU_CALLBACK,
    'file' => 'locale.pages.inc',
  );
Dries's avatar
   
Dries committed
241

Dries's avatar
   
Dries committed
242
  return $items;
Dries's avatar
   
Dries committed
243
244
}

Dries's avatar
   
Dries committed
245
/**
246
 * Implements hook_permission().
Dries's avatar
   
Dries committed
247
 */
248
function locale_permission() {
249
  return array(
250
    'translate interface' => array(
251
      'title' => t('Translate interface texts'),
252
      'restrict access' => TRUE,
253
    ),
254
  );
255
256
257
}

/**
258
 * Implements hook_theme().
259
260
261
 */
function locale_theme() {
  return array(
262
263
264
265
    'locale_translate_edit_form_strings' => array(
      'render element' => 'form',
      'file' => 'locale.pages.inc',
    ),
266
267
268
269
270
271
272
273
    'locale_translation_last_check' => array(
      'variables' => array('last' => NULL),
      'file' => 'locale.pages.inc',
    ),
    'locale_translation_update_info' => array(
      'arguments' => array('updates' => array(), 'not_found' => array()),
      'file' => 'locale.pages.inc',
    ),
274
275
  );
}
276

277
278
279
280
281
282
283
284
285
/**
 * Implements hook_stream_wrappers().
 */
function locale_stream_wrappers() {
  $wrappers = array(
    'translations' => array(
      'name' => t('Translation files'),
      'class' => 'Drupal\locale\TranslationsStream',
      'description' => t('Translation files'),
286
      'type' => STREAM_WRAPPERS_LOCAL_HIDDEN,
287
288
289
290
291
    ),
  );
  return $wrappers;
}

292
/**
293
 * Implements hook_language_insert().
294
 */
295
296
297
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.
298
  cache('page')->deleteAll();
299
  // Force JavaScript translation file re-creation for the new language.
300
  _locale_invalidate_js($language->langcode);
301
302
303
}

/**
304
 * Implements hook_language_update().
305
 */
306
307
308
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.
309
  cache('page')->deleteAll();
310
  // Force JavaScript translation file re-creation for the modified language.
311
  _locale_invalidate_js($language->langcode);
312
313
314
}

/**
315
 * Implements hook_language_delete().
316
 */
317
318
function locale_language_delete($language) {
  // Remove translations.
319
  locale_storage()->deleteTranslations(array('language' => $language->langcode));
320

321
322
  // Remove interface translation files.
  module_load_include('inc', 'locale', 'locale.bulk');
323
  locale_translate_delete_translation_files(array(), array($language->langcode));
324
325

  // Changing the language settings impacts the interface:
326
  _locale_invalidate_js($language->langcode);
327
  cache('page')->deleteAll();
328

329
330
  // Clear locale translation caches.
  locale_translation_status_delete_languages(array($language->langcode));
331
  cache()->delete('locale:' . $language->langcode);
332
333
}

334
335
336
337
338
339
340
341
342
343
344
345
346
347
/**
 * 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
348

Dries's avatar
   
Dries committed
349
/**
350
 * Provides interface translation services.
Dries's avatar
   
Dries committed
351
352
 *
 * This function is called from t() to translate a string if needed.
353
354
355
 *
 * @param $string
 *   A string to look up translation for. If omitted, all the
356
 *   cached strings will be returned in all languages already
357
 *   used on the page.
358
359
 * @param $context
 *   The context of this string.
360
361
 * @param $langcode
 *   Language code to use for the lookup.
Dries's avatar
   
Dries committed
362
 */
363
function locale($string = NULL, $context = NULL, $langcode = NULL) {
364
  $language_interface = language(LANGUAGE_TYPE_INTERFACE);
365
366
367
368

  // Use the advanced drupal_static() pattern, since this is called very often.
  static $drupal_static_fast;
  if (!isset($drupal_static_fast)) {
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
    $drupal_static_fast['locale'] = &drupal_static(__FUNCTION__, array('cache' => array(), 'exists' => NULL));
  }
  $locale_t = &$drupal_static_fast['locale']['cache'];
  $locale_exists = &$drupal_static_fast['locale']['exists'];

  // Check whether Locale module is actually installed and operational.
  // The mere existence of locale() does not imply that Locale module is
  // actually enabled and its database tables are installed. Since PHP code
  // cannot be unloaded, this is typically the case in the environment that
  // is executing a test.
  if (!isset($locale_exists)) {
    $locale_exists = function_exists('module_exists') && module_exists('locale');
  }
  if (!$locale_exists) {
    return $string;
384
  }
385

386
  if (!isset($string)) {
387
    // Return all cached strings if no string was specified
388
389
390
    return $locale_t;
  }

391
  $langcode = isset($langcode) ? $langcode : $language_interface->langcode;
392

393
394
395
  // Strings are cached by langcode, context and roles, using instances of the
  // LocaleLookup class to handle string lookup and caching.
  if (!isset($locale_t[$langcode][$context]) && isset($language_interface)) {
396
    $locale_t[$langcode][$context] = new LocaleLookup($langcode, $context, locale_storage());
Dries's avatar
   
Dries committed
397
  }
398
  return ($locale_t[$langcode][$context][$string] === TRUE ? $string : $locale_t[$langcode][$context][$string]);
Dries's avatar
   
Dries committed
399
}
Dries's avatar
   
Dries committed
400

401
402
403
404
405
406
407
/**
 * Reset static variables used by locale().
 */
function locale_reset() {
  drupal_static_reset('locale');
}

408
409
410
411
412
413
414
415
416
417
418
419
420
421
/**
 * Gets the locale storage controller class .
 *
 * @return Drupal\locale\StringStorageInterface
 */
function locale_storage() {
  $storage = &drupal_static(__FUNCTION__);
  if (!isset($storage)) {
    $options = array('target' => 'default');
    $storage = new StringDatabaseStorage(Database::getConnection($options['target']), $options);
  }
  return $storage;
}

Dries's avatar
   
Dries committed
422
/**
423
 * Returns plural form index for a specific number.
Dries's avatar
   
Dries committed
424
 *
425
 * The index is computed from the formula of this language.
426
 *
427
428
429
430
431
 * @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.
432
433
434
435
 * @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
436
 */
437
function locale_get_plural($count, $langcode = NULL) {
438
  $language_interface = language(LANGUAGE_TYPE_INTERFACE);
439
440
441
442
443
444

  // 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
445

446
  $langcode = $langcode ? $langcode : $language_interface->langcode;
447

448
449
450
  if (!isset($plural_indexes[$langcode][$count])) {
    // Retrieve and statically cache the plural formulas for all languages.
    if (empty($plural_formulas)) {
451
      $plural_formulas = state()->get('locale.translation.plurals') ?: array();
Dries's avatar
   
Dries committed
452
    }
453
454
455
456
457
    // 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])) {
      // $n is used inside the expression in the eval().
Dries's avatar
   
Dries committed
458
      $n = $count;
459
460
461
462
463
464
      $plural_indexes[$langcode][$count] = @eval('return intval(' . $plural_formulas[$langcode]['formula'] . ');');
    }
    // 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
465
    }
466
    // Otherwise, return -1 (unknown).
Dries's avatar
   
Dries committed
467
    else {
468
      $plural_indexes[$langcode][$count] = -1;
469
    }
Dries's avatar
   
Dries committed
470
  }
471
  return $plural_indexes[$langcode][$count];
472
}
Dries's avatar
   
Dries committed
473

474

475
/**
476
477
478
479
480
481
 * Implements hook_modules_installed().
 */
function locale_modules_installed($modules) {
  locale_system_update($modules);
}

482
483
484
485
486
487
488
/**
 * Implements hook_modules_uninstalled().
 */
function locale_modules_uninstalled($modules) {
  locale_system_remove($modules);
}

489
490
491
492
493
494
495
496
497
498
/**
 * 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) {
  locale_system_update($themes);
}

499
500
501
502
503
504
505
/**
 * Implements hook_themes_disabled().
 */
function locale_themes_disabled($themes) {
  locale_system_remove($themes);
}

506
507
/**
 * Imports translations when new modules or themes are installed.
508
 *
509
510
 * This function will start a batch to import translations for the added
 * components.
511
 *
512
 * @param array $components
513
514
515
516
 *   An array of component (theme and/or module) names to import
 *   translations for.
 */
function locale_system_update($components) {
517
518
519
  // 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.
520
521
522
523
524
525
526
527
528
529
530
531
  if (!drupal_installation_attempted() && locale_translatable_language_list()) {
    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());
    if ($components = array_intersect($components, $projects)) {
      module_load_include('fetch.inc', 'locale');
      // Get translation status of the projects, download and update translations.
      $options = _locale_translation_default_update_options();
      $batch = locale_translation_batch_update_build($components, array(), $options);
532
533
      batch_set($batch);
    }
534
535
536
  }
}

537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
/**
 * 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
 *   An array of component (theme and/or module) names to remove
 *   translation history.
 */
function locale_system_remove($components) {
  if (locale_translatable_language_list()) {
    module_load_include('compare.inc', 'locale');

    // 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());
    if ($components = array_intersect($components, $projects)) {
      locale_translation_file_history_delete($components);

      // Remove translation files.
      module_load_include('inc', 'locale', 'locale.bulk');
      locale_translate_delete_translation_files($components, array());

      // 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')
        ->condition('name', $components)
        ->execute();

      // Clear the translation status.
      locale_translation_status_delete_projects($components);
    }
  }
}


576
/**
577
 * Implements hook_js_alter().
578
579
580
581
582
583
 *
 * This function checks all JavaScript files currently added via drupal_add_js()
 * and invokes parsing if they have not yet been parsed for Drupal.t()
 * and Drupal.formatPlural() calls. Also refreshes the JavaScript translation
 * file if necessary, and adds it to the page.
 */
584
function locale_js_alter(&$javascript) {
585

586
  $language_interface = language(LANGUAGE_TYPE_INTERFACE);
587

588
  $dir = 'public://' . config('local.settings')->get('javascript.directory');
589
  $parsed = state()->get('system.javascript_parsed') ?: array();
590
591
  $files = $new_files = FALSE;

592
  foreach ($javascript as $item) {
593
    if (isset($item['type']) && $item['type'] == 'file') {
594
595
596
597
598
      $files = TRUE;
      $filepath = $item['data'];
      if (!in_array($filepath, $parsed)) {
        // Don't parse our own translations files.
        if (substr($filepath, 0, strlen($dir)) != $dir) {
599
          _locale_parse_js_file($filepath);
600
601
          $parsed[] = $filepath;
          $new_files = TRUE;
602
603
604
605
606
607
608
609
610
        }
      }
    }
  }

  // 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) {
611
    $parsed += _locale_invalidate_js();
612
613
614
  }

  // If necessary, rebuild the translation file for the current language.
615
  if (!empty($parsed['refresh:' . $language_interface->langcode])) {
616
617
    // Don't clear the refresh flag on failure, so that another try will
    // be performed later.
618
    if (_locale_rebuild_js()) {
619
      unset($parsed['refresh:' . $language_interface->langcode]);
620
621
    }
    // Store any changes after refresh was attempted.
622
    state()->set('system.javascript_parsed', $parsed);
623
624
625
  }
  // 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.
626
  elseif ($new_files) {
627
    state()->set('system.javascript_parsed', $parsed);
628
629
630
  }

  // Add the translation JavaScript file to the page.
631
  $locale_javascripts = state()->get('translation.javascript') ?: array();
632
  if ($files && !empty($locale_javascripts[$language_interface->langcode])) {
633
    // Add the translation JavaScript file to the page.
634
    $file = $dir . '/' . $language_interface->langcode . '_' . $locale_javascripts[$language_interface->langcode] . '.js';
635
    $javascript[$file] = drupal_js_defaults($file);
636
637
638
  }
}

639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
/**
 * Implements hook_library_info().
 */
function locale_library_info() {
  $libraries['drupal.locale.admin'] = array(
    'title' => 'Locale',
    'version' => VERSION,
    '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',
    'version' => VERSION,
    'js' => array(
      drupal_get_path('module', 'locale') . '/locale.datepicker.js' => array(),
    ),
    'dependencies' => array(
      array('system', 'jquery'),
      array('system', 'drupal'),
664
      array('system', 'drupalSettings'),
665
666
667
668
669
670
    ),
  );

  return $libraries;
}

671
/**
672
 * Implement hook_library_info_alter().
673
674
675
 *
 * Provides the language support for the jQuery UI Date Picker.
 */
676
function locale_library_info_alter(&$libraries, $module) {
677
  if ($module == 'system' && isset($libraries['jquery.ui.datepicker'])) {
678
    $language_interface = language(LANGUAGE_TYPE_INTERFACE);
679
680
681
    // 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.
682
    $libraries['jquery.ui.datepicker']['dependencies'][] = array('locale', 'drupal.locale.datepicker');
683
    $libraries['jquery.ui.datepicker']['js'][] = array(
684
      'data' => array(
685
686
687
688
        'jquery' => array(
          'ui' => array(
            'datepicker' => array(
              'isRTL' => $language_interface->direction == LANGUAGE_RTL,
689
              'firstDay' => config('system.date')->get('first_day'),
690
691
            ),
          ),
692
693
694
695
696
697
698
        ),
      ),
      'type' => 'setting',
    );
  }
}

699
/**
700
 * Implements hook_form_FORM_ID_alter() for language_admin_overview_form().
701
 */
702
function locale_form_language_admin_overview_form_alter(&$form, &$form_state) {
703
704
  $languages = $form['languages']['#languages'];

705
  $total_strings = locale_storage()->countStrings();
706
707
708
709
  $stats = array_fill_keys(array_keys($languages), array());

  // If we have source strings, count translations and calculate progress.
  if (!empty($total_strings)) {
710
711
712
713
714
    $translations = locale_storage()->countTranslations();
    foreach ($translations as $langcode => $translated) {
      $stats[$langcode]['translated'] = $translated;
      if ($translated > 0) {
        $stats[$langcode]['ratio'] = round($translated / $total_strings * 100, 2);
715
716
717
718
719
720
721
722
723
724
725
      }
    }
  }

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

  foreach ($languages as $langcode => $language) {
    $stats[$langcode] += array(
      'translated' => 0,
      'ratio' => 0,
    );
726
    if (!$language->locked && ($langcode != 'en' || locale_translate_english())) {
727
      $form['languages'][$langcode]['locale_statistics'] = array(
728
729
730
731
732
733
734
735
736
        '#markup' => l(
          t('@translated/@total (@ratio%)', array(
            '@translated' => $stats[$langcode]['translated'],
            '@total' => $total_strings,
            '@ratio' => $stats[$langcode]['ratio'],
          )),
          'admin/config/regional/translate/translate',
          array('query' => array('langcode' => $langcode))
        ),
737
738
739
740
      );
    }
    else {
      $form['languages'][$langcode]['locale_statistics'] = array(
741
        '#markup' => t('not applicable'),
742
743
      );
    }
744
745
746
747
748
    // #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;
749
750
  }
}
751
752

/**
753
754
755
756
757
758
759
760
 * 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';
}

/**
761
762
763
 * Form submission handler for language_admin_add_form().
 *
 * Set a batch for a newly-added language.
764
765
766
767
768
769
770
771
772
 */
function locale_form_language_admin_add_form_alter_submit($form, $form_state) {
  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'];
  }

773
774
775
776
777
  // 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);
  batch_set($batch);
778
779
780
781
}

/**
 * Implements hook_form_FORM_ID_alter() for language_admin_edit_form().
782
 */
783
function locale_form_language_admin_edit_form_alter(&$form, &$form_state) {
784
785
786
787
788
789
  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(),
    );
790
    $form['#submit'][] = 'locale_form_language_admin_edit_form_alter_submit';
791
792
793
794
  }
}

/**
795
 * Form submission handler for language_admin_edit_form().
796
 */
797
function locale_form_language_admin_edit_form_alter_submit($form, $form_state) {
798
799
800
801
  variable_set('locale_translate_english', $form_state['values']['locale_translate_english']);
}

/**
802
803
804
805
 * Checks whether locale translates to English.
 *
 * @return bool
 *   Returns TRUE if content should be translated to English, FALSE otherwise.
806
807
808
809
 */
function locale_translate_english() {
  return variable_get('locale_translate_english', FALSE);
}
810
811
812
813
814
815
816

/**
 * 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) {
817
  $form['translation_path'] = array(
818
819
    '#type' => 'textfield',
    '#title' => t('Interface translations directory'),
820
    '#default_value' => config('locale.settings')->get('translation.path'),
821
    '#maxlength' => 255,
822
    '#description' => t('A local file system path where interface translation files will be stored.'),
823
824
825
826
827
828
    '#after_build' => array('system_check_directory'),
    '#weight' => 10,
  );
  if ($form['file_default_scheme']) {
    $form['file_default_scheme']['#weight'] = 20;
  }
829
830
831
832
833
834
835
836
837
838
839
  $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) {
840
  if ($form['translation_path']['#default_value'] != $form_state['values']['translation_path']) {
841
842
    locale_translation_clear_status();
  }
843
844
845
846

  config('locale.settings')
    ->set('translation.path', $form_state['values']['translation_path'])
    ->save();
847
}
848
849

/**
850
 * Implements hook_preprocess_HOOK() for node.tpl.php.
851
852
 */
function locale_preprocess_node(&$variables) {
853
  if ($variables['node']->langcode != LANGUAGE_NOT_SPECIFIED) {
854
    $language_interface = language(LANGUAGE_TYPE_INTERFACE);
855

856
    $node_language = language_load($variables['node']->langcode);
857
    if ($node_language->langcode != $language_interface->langcode) {
858
859
860
      // If the node language was different from the page language, we should
      // add markup to identify the language. Otherwise the page language is
      // inherited.
861
      $variables['attributes']['lang'] = $variables['node']->langcode;
862
      if ($node_language->direction != $language_interface->direction) {
863
864
865
        // If text direction is different form the page's text direction, add
        // direction information as well.
        $dir = array('ltr', 'rtl');
866
        $variables['attributes']['dir'] = $dir[$node_language->direction];
867
868
869
870
      }
    }
  }
}
871

872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
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
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
/**
 * 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) {
      $file->type = LOCALE_TRANSLATION_CURRENT;
      $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();
  }
  return drupal_write_record('locale_file', $file, $update);
}

/**
 * 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();
}

/**
 * Saves the status of translation sources in static cache.
 *
 * @param array $data
 *   Array of translation source data, structured by project name and langcode.
 */
function locale_translation_status_save($data) {
  // Followup issue: http://drupal.org/node/1842362
  // Split status storage per module/language and expire individually. This will
  // improve performance for large sites.
  $status = state()->get('locale.translation_status');
  $status = empty($status) ? array() : $status;

  // Merge the new data into the existing structured status array.
  foreach ($data as $project => $languages) {
    foreach ($languages as $langcode => $source) {
      $status[$project][$langcode] = $source;
    }
  }

  state()->set('locale.translation_status', $status);
  state()->set('locale.translation_last_checked', REQUEST_TIME);
}

/**
 * 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) {
965
966
967
968
969
970
  if ($status = state()->get('locale.translation_status')) {
    foreach ($status as $project => $languages) {
      foreach ($languages as $langcode => $source) {
        if (in_array($langcode, $langcodes)) {
          unset($status[$project][$langcode]);
        }
971
972
      }
    }
973
    state()->set('locale.translation_status', $status);
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
  }
}

/**
 * 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) {
  $status = state()->get('locale.translation_status');

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

994
995
996
997
/**
 * Clear the translation status cache.
 */
function locale_translation_clear_status() {
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
  state()->delete('locale.translation_status');
  state()->delete('locale.translation_last_checked');
}

/**
 * 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() {
  return config('locale.settings')->get('translation.use_source') == LOCALE_TRANSLATION_USE_SOURCE_REMOTE_AND_LOCAL;
1011
1012
}

1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
/**
 * 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')));
}

1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
/**
 * 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
1041
1042
 *   (optional) List of string identifiers that have been updated / created.
 *   If not provided, all caches for the affected languages are cleared.
1043
 */
1044
1045
1046
1047
1048
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.
    if (empty($lids) || ($strings = locale_storage()->getStrings(array('lid' => $lids, 'type' => 'javascript')))) {
1049
1050
1051
1052
      array_map('_locale_invalidate_js', $langcodes);
    }
  }
  // Clear locale cache.
1053
  cache()->deleteTags(array('locale' => TRUE));
1054
1055
}

1056
1057
1058
/**
 * Parses a JavaScript file, extracts strings wrapped in Drupal.t() and
 * Drupal.formatPlural() and inserts them into the database.
1059
1060
1061
1062
1063
1064
 *
 * @param string $filepath
 *   File name to parse.
 *
 * @return array
 *   Array of string objects to update indexed by context and source.
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
 */
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);

  // Match all Drupal.formatPlural() calls in another array.
  preg_match_all('~
    [^\w]Drupal\s*\.\s*formatPlural\s*  # match "Drupal.formatPlural" with whitespace
    \(                                  # match "(" argument list start
    \s*.+?\s*,\s*                       # match count argument
    (' . LOCALE_JS_STRING . ')\s*,\s*   # match singular string argument
    (                             # capture plural string argument
      (?:                         # non-capturing group to repeat string pieces
        (?:
          \'                      # match start of single-quoted string
          (?:\\\\\'|[^\'])*       # match any character except unescaped single-quote
          @count                  # match "@count"
          (?:\\\\\'|[^\'])*       # match any character except unescaped single-quote
          \'                      # match end of single-quoted string
          |
          "                       # match start of double-quoted string
          (?:\\\\"|[^"])*         # match any character except unescaped double-quote
          @count                  # match "@count"
          (?:\\\\"|[^"])*         # match any character except unescaped double-quote
          "                       # match end of double-quoted string
        )
        (?:\s*\+\s*)?             # match "+" with possible whitespace, for str concat
      )+                          # match multiple because we supports concatenating strs
    )\s*                          # end capturing of plural string argument
    (?:,\s*' . LOCALE_JS_OBJECT . '\s*          # optionally capture string args
      (?:,\s*' . LOCALE_JS_OBJECT_CONTEXT . '\s*)?  # optionally capture context
    )?
    [,\)]
    ~sx', $file, $plural_matches);

  $matches = array();

  // Add strings from Drupal.t().
  foreach ($t_matches[1] as $key => $string) {
    $matches[] = array(
      'string'  => $string,
      'context' => $t_matches[2][$key],
    );
  }

  // Add string from Drupal.formatPlural().
  foreach ($plural_matches[1] as $key => $string) {
    $matches[] = array(
      'string'  => $string,
      'context' => $plural_matches[3][$key],
    );

    // If there is also a plural version of this string, add it to the strings array.
    if (isset($plural_matches[2][$key])) {
      $matches[] = array(
        'string'  => $plural_matches[2][$key],
        'context' => $plural_matches[3][$key],
      );
    }
  }

  // Loop through all matches and process them.
  foreach ($matches as $key => $match) {

    // Remove the quotes and string concatenations from the string and context.
    $string =  implode('', preg_split('~(?<!\\\\)[\'"]\s*\+\s*[\'"]~s', substr($match['string'], 1, -1)));
    $context = implode('', preg_split('~(?<!\\\\)[\'"]\s*\+\s*[\'"]~s', substr($match['context'], 1, -1)));

1149
    $source = locale_storage()->findString(array('source' => $string, 'context' => $context));
1150
1151

    if (!$source) {
1152
      // We don't have the source string yet, thus we insert it into the database.
1153
      $source = locale_storage()->createString(array(
1154
1155
        'source'    => $string,
        'context'   => $context,
1156
      ));
1157
    }
1158
1159
1160
    // Besides adding the location this will tag it for current version.
    $source->addLocation('javascript', $filepath);
    $source->save();
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
  }
}

/**
 * Force the JavaScript translation file(s) to be refreshed.
 *
 * This function sets a refresh flag for a specified language, or all
 * languages except English, if none specified. JavaScript translation
 * files are rebuilt (with locale_update_js_files()) the next time a
 * request is served in that language.
 *
 * @param $langcode
 *   The language code for which the file needs to be refreshed.
 *
 * @return
1176
 *   New content of the 'system.javascript_parsed' variable.
1177
1178
 */
function _locale_invalidate_js($langcode = NULL) {
1179
  $parsed = state()->get('system.javascript_parsed') ?: array();
1180
1181
1182

  if (empty($langcode)) {
    // Invalidate all languages.
1183
    $languages = locale_translatable_language_list();
1184
1185
1186
1187
1188
1189
1190
1191
1192
    foreach ($languages as $lcode => $data) {
      $parsed['refresh:' . $lcode] = 'waiting';
    }
  }
  else {
    // Invalidate single language.
    $parsed['refresh:' . $langcode] = 'waiting';
  }

1193
  state()->set('system.javascript_parsed', $parsed);
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
  return $parsed;
}

/**
 * (Re-)Creates the JavaScript translation file for a language.
 *
 * @param $langcode
 *   The language, the translation file should be (re)created for.
 */
function _locale_rebuild_js($langcode = NULL) {
1204
  $config = config('locale.settings');
1205
  if (!isset($langcode)) {
1206
    $language = language(LANGUAGE_TYPE_INTERFACE);
1207
1208
1209
1210
1211
1212
1213
1214
1215
  }
  else {
    // Get information about the locale.
    $languages = language_list();
    $language = $languages[$langcode];
  }

  // Construct the array for JavaScript translations.
  // Only add strings with a translation to the translations array.
1216
1217
1218
1219
1220
  $conditions = array(
    'type' => 'javascript',
    'language' =>  $language->langcode,
    'translated' => TRUE,
  );
1221
  $translations = array();
1222
  foreach (locale_storage()->getTranslations($conditions) as $data) {
1223
1224
1225
1226
1227
1228
1229
1230
1231
    $translations[$data->context][$data->source] = $data->translation;
  }

  // Construct the JavaScript file, if there are translations.
  $data_hash = NULL;
  $data = $status = '';
  if (!empty($translations)) {

    $data = "Drupal.locale = { ";
1232
    $locale_plurals = state()->get('locale.translation.plurals') ?: array();
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
    if (!empty($locale_plurals[$language->langcode])) {
      $data .= "'pluralFormula': function (\$n) { return Number({$locale_plurals[$language->langcode]['formula']}); }, ";
    }

    $data .= "'strings': " . drupal_json_encode($translations) . " };";
    $data_hash = drupal_hash_base64($data);
  }

  // Construct the filepath where JS translation files are stored.
  // There is (on purpose) no front end to edit that variable.
1243
  $dir = 'public://' . $config->get('javascript.directory');
1244
1245

  // Delete old file, if we have no translations anymore, or a different file to be saved.
1246
  $locale_javascripts = state()->get('locale.translation.javascript') ?: array();
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
  $changed_hash = !isset($locale_javascripts[$language->langcode]) || ($locale_javascripts[$language->langcode] != $data_hash);
  if (!empty($locale_javascripts[$language->langcode]) && (!$data || $changed_hash)) {
    file_unmanaged_delete($dir . '/' . $language->langcode . '_' . $locale_javascripts[$language->langcode] . '.js');
    $locale_javascripts[$language->langcode] = '';
    $status = 'deleted';
  }

  // Only create a new file if the content has changed or the original file got
  // lost.
  $dest = $dir . '/' . $language->langcode . '_' . $data_hash . '.js';
  if ($data && ($changed_hash || !file_exists($dest))) {
    // Ensure that the directory exists and is writable, if possible.
    file_prepare_directory($dir, FILE_CREATE_DIRECTORY);

    // Save the file.
    if (file_unmanaged_save_data($data, $dest)) {
      $locale_javascripts[$language->langcode] = $data_hash;
      // If we deleted a previous version of the file and we replace it with a
      // new one we have an update.
      if ($status == 'deleted') {
        $status = 'updated';
      }
      // If the file did not exist previously and the data has changed we have
      // a fresh creation.
      elseif ($changed_hash) {
        $status = 'created';
      }
      // If the data hash is unchanged the translation was lost and has to be
      // rebuilt.
      else {
        $status = 'rebuilt';
      }
    }
    else {
      $locale_javascripts[$language->langcode] = '';
      $status = 'error';
    }
  }

  // Save the new JavaScript hash (or an empty value if the file just got
  // deleted). Act only if some operation was executed that changed the hash
  // code.
  if ($status && $changed_hash) {
1290
    state()->set('locale.translation.javascript', $locale_javascripts);
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
  }

  // Log the operation and return success flag.
  switch ($status) {
    case 'updated':
      watchdog('locale', 'Updated JavaScript translation file for the language %language.', array('%language' => $language->name));
      return TRUE;
    case 'rebuilt':
      watchdog('locale', 'JavaScript translation file %file.js was lost.', array('%file' => $locale_javascripts[$language->langcode]), WATCHDOG_WARNING);
      // Proceed to the 'created' case as the JavaScript translation file has
      // been created again.
    case 'created':
      watchdog('locale', 'Created JavaScript translation file for the language %language.', array('%language' => $language->name));
      return TRUE;
    case 'deleted':
      watchdog('locale', 'Removed JavaScript translation file for the language %language because no translations currently exist for that language.', array('%language' => $language->name));
      return TRUE;
    case 'error':
      watchdog('locale', 'An error occurred during creation of the JavaScript translation file for the language %language.', array('%language' => $language->name), WATCHDOG_ERROR);
      return FALSE;
    default:
      // No operation needed.
      return TRUE;
  }
}