locale.module 52.5 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\Component\Utility\Json;
14
use Drupal\Core\Cache\Cache;
15
use Drupal\Core\Language\Language;
16
use Drupal\language\Entity\Language as LanguageEntity;
17
use Drupal\Component\Utility\Crypt;
18

19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
/**
 * 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;

70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
/**
 * 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';

/**
96 97 98 99 100 101 102 103 104 105 106 107
 * 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.
108
 */
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
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
132
/**
133
 * Implements hook_help().
Dries's avatar
 
Dries committed
134
 */
135 136
function locale_help($path, $arg) {
  switch ($path) {
137
    case 'admin/help#locale':
138 139
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
140
      $output .= '<p>' . t('The Interface Translation module allows you to translate interface text (<em>strings</em>) into different languages, and to switch between them for the display of interface text. It uses the functionality provided by the <a href="!language">Language module</a>. For more information, see the <a href="!doc-url">online documentation for the Interface Translation module</a>.', array('!doc-url' => 'https://drupal.org/documentation/modules/locale/', '!language' => \Drupal::url('help.page', array('name' => 'language')))) . '</p>';
141 142
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
143 144 145 146 147 148
      $output .= '<dt>' . t('Importing translation files') . '</dt>';
      $output .= '<dd>' . t('Translation files with translated interface text are imported automatically when languages are added on the <a href="!languages">Languages</a> page, or when modules or themes are enabled. On the <a href=!locale-settings">Settings</a> page, the <em>Translation source</em> can be restricted to local files only, or to include the <a href="!server">Drupal translation server</a>. Although modules and themes may not be fully translated in all languages, new translations become available frequently. You can specify whether and how often to check for translation file updates and whether to overwrite existing translations on the <a href="!locale-settings">Settings</a> page. You can also manually import a translation file on the <a href="!import">Import</a> page.', array('!import' => \Drupal::url('locale.translate_import'), '!locale-settings' => \Drupal::url('locale.settings'), '!languages' => \Drupal::url('language.admin_overview'), '!server' => 'https://localize.drupal.org')) . '</dd>';
      $output .= '<dt>' . t('Checking the translation status') . '</dt>';
      $output .= '<dd>' . t('You can check how much of the interface on your site is translated into which language on the <a href="!languages">Languages</a> page. On the <a href="!translation-updates">Available translation updates</a> page, you can check whether interface translation updates are available on the <a href="!server">Drupal translation server</a>.', array('!languages' => \Drupal::url('language.admin_overview'), '!translation-updates' => \Drupal::url('locale.translate_status'), '!server' => 'https://localize.drupal.org')) . '<dd>';
      $output .= '<dt>' . t('Translating individual strings') . '</dt>';
      $output .= '<dd>' . t('You can translate individual strings directly on the <a href="!translate">User interface translation</a> page, or download the currently-used translation file for a specific language on the <a href="!export">Export</a> page. Once you have edited the translation file, you can then import it again on the <a href="!import">Import</a> page.', array('!translate' => \Drupal::url('locale.translate_page'), '!export' => \Drupal::url('locale.translate_export'), '!import' => \Drupal::url('locale.translate_import'))) . '</dd>';
149
      $output .= '</dl>';
150
      return $output;
151

152
    case 'admin/config/regional/language':
153
      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>';
154

155
    case 'admin/config/regional/translate':
156
      $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>';
157
      return $output;
158

159
    case 'admin/config/regional/translate/import':
160
      $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>';
161 162
      $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>';
163
      return $output;
164

165
    case 'admin/config/regional/translate/export':
166
      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
167
  }
Dries's avatar
 
Dries committed
168 169
}

Dries's avatar
 
Dries committed
170
/**
171
 * Implements hook_permission().
Dries's avatar
 
Dries committed
172
 */
173
function locale_permission() {
174
  return array(
175
    'translate interface' => array(
176
      'title' => t('Translate interface texts'),
177
      'restrict access' => TRUE,
178
    ),
179
  );
180 181 182
}

/**
183
 * Implements hook_theme().
184 185 186
 */
function locale_theme() {
  return array(
187 188 189 190
    'locale_translate_edit_form_strings' => array(
      'render element' => 'form',
      'file' => 'locale.pages.inc',
    ),
191 192 193
    'locale_translation_last_check' => array(
      'variables' => array('last' => NULL),
      'file' => 'locale.pages.inc',
194
      'template' => 'locale-translation-last-check',
195 196
    ),
    'locale_translation_update_info' => array(
197
      'variables' => array('updates' => array(), 'not_found' => array()),
198
      'file' => 'locale.pages.inc',
199
      'template' => 'locale-translation-update-info',
200
    ),
201 202
  );
}
203

204 205 206 207 208 209 210 211 212
/**
 * Implements hook_stream_wrappers().
 */
function locale_stream_wrappers() {
  $wrappers = array(
    'translations' => array(
      'name' => t('Translation files'),
      'class' => 'Drupal\locale\TranslationsStream',
      'description' => t('Translation files'),
213
      'type' => STREAM_WRAPPERS_LOCAL_HIDDEN,
214 215 216 217 218
    ),
  );
  return $wrappers;
}

219
/**
220
 * Implements hook_ENTITY_TYPE_insert() for 'language_entity'.
221
 */
222
function locale_language_entity_insert(LanguageEntity $language) {
223
  // @todo move these two cache clears out. See http://drupal.org/node/1293252
224 225
  // Changing the language settings impacts the interface: clear render cache.
  \Drupal::cache('render')->deleteAll();
226
  // Force JavaScript translation file re-creation for the new language.
227
  _locale_invalidate_js($language->id());
228 229 230
}

/**
231
 * Implements hook_ENTITY_TYPE_update() for 'language_entity'.
232
 */
233
function locale_language_entity_update(LanguageEntity $language) {
234
  // @todo move these two cache clears out. See http://drupal.org/node/1293252
235 236
  // Changing the language settings impacts the interface: clear render cache.
  \Drupal::cache('render')->deleteAll();
237
  // Force JavaScript translation file re-creation for the modified language.
238
  _locale_invalidate_js($language->id());
239 240 241
}

/**
242
 * Implements hook_ENTITY_TYPE_delete() for 'language_entity'.
243
 */
244
function locale_language_entity_delete(LanguageEntity $language) {
245
  // Remove translations.
246
  \Drupal::service('locale.storage')->deleteTranslations(array('language' => $language->id()));
247

248 249
  // Remove interface translation files.
  module_load_include('inc', 'locale', 'locale.bulk');
250
  locale_translate_delete_translation_files(array(), array($language->id()));
251

252
  // Remove translated configuration objects.
253
  \Drupal\locale\Locale::config()->deleteLanguageTranslations($language->id());
254

255
  // Changing the language settings impacts the interface:
256
  _locale_invalidate_js($language->id());
257
  \Drupal::cache('render')->deleteAll();
258

259
  // Clear locale translation caches.
260 261
  locale_translation_status_delete_languages(array($language->id()));
  \Drupal::cache()->delete('locale:' . $language->id());
262 263
}

264 265 266 267 268 269 270 271
/**
 * 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() {
272
  $languages = \Drupal::languageManager()->getLanguages();
273 274 275 276 277
  if (!locale_translate_english()) {
    unset($languages['en']);
  }
  return $languages;
}
Dries's avatar
 
Dries committed
278

Dries's avatar
 
Dries committed
279
/**
280
 * Returns plural form index for a specific number.
Dries's avatar
 
Dries committed
281
 *
282
 * The index is computed from the formula of this language.
283
 *
284 285 286 287 288
 * @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.
289 290 291 292
 * @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
293
 */
294
function locale_get_plural($count, $langcode = NULL) {
295
  $language_interface = \Drupal::languageManager()->getCurrentLanguage();
296 297 298 299 300 301

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

303
  $langcode = $langcode ? $langcode : $language_interface->id;
304

305 306 307
  if (!isset($plural_indexes[$langcode][$count])) {
    // Retrieve and statically cache the plural formulas for all languages.
    if (empty($plural_formulas)) {
308
      $plural_formulas = \Drupal::state()->get('locale.translation.plurals') ?: array();
Dries's avatar
 
Dries committed
309
    }
310 311 312 313
    // 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])) {
314 315 316 317 318
      // Plural formulas are stored as an array for 0-199. 100 is the highest
      // modulo used but storing 0-99 is not enough because below 100 we often
      // find exceptions (1, 2, etc).
      $index = $count > 199 ? 100 + ($count % 100) : $count;
      $plural_indexes[$langcode][$count] = isset($plural_formulas[$langcode]['formula'][$index]) ? $plural_formulas[$langcode]['formula'][$index] : $plural_formulas[$langcode]['formula']['default'];
319 320 321 322 323
    }
    // 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
324
    }
325
    // Otherwise, return -1 (unknown).
Dries's avatar
 
Dries committed
326
    else {
327
      $plural_indexes[$langcode][$count] = -1;
328
    }
Dries's avatar
 
Dries committed
329
  }
330
  return $plural_indexes[$langcode][$count];
331
}
Dries's avatar
 
Dries committed
332

333

334
/**
335 336 337
 * Implements hook_modules_installed().
 */
function locale_modules_installed($modules) {
338 339
  $components['module'] = $modules;
  locale_system_update($components);
340 341
}

342 343 344 345
/**
 * Implements hook_modules_uninstalled().
 */
function locale_modules_uninstalled($modules) {
346 347
  $components['module'] = $modules;
  locale_system_remove($components);
348 349
}

350 351 352 353 354 355 356
/**
 * 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) {
357 358
  $components['theme'] = $themes;
  locale_system_update($components);
359 360
}

361 362 363 364
/**
 * Implements hook_themes_disabled().
 */
function locale_themes_disabled($themes) {
365 366
  $components['theme'] = $themes;
  locale_system_remove($components);
367 368
}

369 370 371 372 373 374 375 376 377 378
/**
 * Implements hook_cron().
 *
 * @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().
379
  if ($frequency = \Drupal::config('locale.settings')->get('translation.update_interval_days') && locale_translatable_language_list()) {
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
    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']);
449
    $queue = \Drupal::queue('locale_translation', TRUE);
450 451 452 453
    $queue->createItem(array($function, $args));
  }
}

454 455
/**
 * Imports translations when new modules or themes are installed.
456
 *
457 458
 * This function will start a batch to import translations for the added
 * components.
459
 *
460
 * @param array $components
461 462
 *   An array of arrays of component (theme and/or module) names to import
 *   translations for, indexed by type.
463
 */
464 465 466 467
function locale_system_update(array $components) {
  $components += array('module' => array(), 'theme' => array());
  $list = array_merge($components['module'], $components['theme']);

468 469 470
  // 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.
471
  if (!drupal_installation_attempted() && locale_translatable_language_list() && \Drupal::config('locale.settings')->get('translation.import_enabled')) {
472 473 474 475 476 477
    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());
478
    if ($list = array_intersect($list, $projects)) {
479 480 481
      module_load_include('fetch.inc', 'locale');
      // Get translation status of the projects, download and update translations.
      $options = _locale_translation_default_update_options();
482 483 484
      $batch = locale_translation_batch_update_build($list, array(), $options);
      batch_set($batch);
    }
485
    \Drupal::moduleHandler()->loadInclude('locale', 'bulk.inc');
486
    if ($batch = locale_config_batch_update_components(array(), array(), $components)) {
487 488
      batch_set($batch);
    }
489 490 491
  }
}

492 493 494 495 496 497 498 499
/**
 * 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
500 501
 *   An array of arrays of component (theme and/or module) names to import
 *   translations for, indexed by type.
502 503
 */
function locale_system_remove($components) {
504 505 506
  $components += array('module' => array(), 'theme' => array());
  $list = array_merge($components['module'], $components['theme']);
  if ($language_list = locale_translatable_language_list()) {
507
    module_load_include('compare.inc', 'locale');
508
    \Drupal::moduleHandler()->loadInclude('locale', 'bulk.inc');
509 510
    // Delete configuration translations.
    \Drupal\locale\Locale::config()->deleteComponentTranslations($components, array_keys($language_list));
511 512 513 514

    // 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());
515 516
    if ($list = array_intersect($list, $projects)) {
      locale_translation_file_history_delete($list);
517 518

      // Remove translation files.
519
      locale_translate_delete_translation_files($list, array());
520 521 522 523 524

      // 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')
525
        ->condition('name', $list)
526 527 528
        ->execute();

      // Clear the translation status.
529
      locale_translation_status_delete_projects($list);
530
    }
531

532 533 534
  }
}

535
/**
536
 * Implements hook_js_alter().
537
 */
538
function locale_js_alter(&$javascript) {
539 540 541 542 543 544 545 546 547 548
  $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);
  }
}
549

550 551 552 553 554 555 556 557 558 559
/**
 * 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.
560
 * @return string|null
561 562 563 564
 *   The filepath to the translation file or NULL if no translation is
 *   applicable.
 */
function locale_js_translate(array $files = array()) {
565
  $language_interface = \Drupal::languageManager()->getCurrentLanguage();
566

567 568
  $dir = 'public://' . \Drupal::config('locale.settings')->get('javascript.directory');
  $parsed = \Drupal::state()->get('system.javascript_parsed') ?: array();
569 570 571 572 573 574 575 576 577
  $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;
578 579 580 581 582 583 584 585
      }
    }
  }

  // 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) {
586
    $parsed += _locale_invalidate_js();
587 588 589
  }

  // If necessary, rebuild the translation file for the current language.
590
  if (!empty($parsed['refresh:' . $language_interface->id])) {
591 592
    // Don't clear the refresh flag on failure, so that another try will
    // be performed later.
593
    if (_locale_rebuild_js()) {
594
      unset($parsed['refresh:' . $language_interface->id]);
595 596
    }
    // Store any changes after refresh was attempted.
597
    \Drupal::state()->set('system.javascript_parsed', $parsed);
598 599 600
  }
  // 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.
601
  elseif ($new_files) {
602
    \Drupal::state()->set('system.javascript_parsed', $parsed);
603 604 605
  }

  // Add the translation JavaScript file to the page.
606
  $locale_javascripts = \Drupal::state()->get('locale.translation.javascript') ?: array();
607 608
  $translation_file = NULL;
  if (!empty($files) && !empty($locale_javascripts[$language_interface->id])) {
609
    // Add the translation JavaScript file to the page.
610
    $translation_file = $dir . '/' . $language_interface->id . '_' . $locale_javascripts[$language_interface->id] . '.js';
611
  }
612
  return $translation_file;
613 614
}

615
/**
616
 * Implements hook_library_alter().
617 618 619
 *
 * Provides the language support for the jQuery UI Date Picker.
 */
620 621
function locale_library_alter(array &$library, $name) {
  if ($name == 'core/jquery.ui.datepicker') {
622
    // locale.datepicker.js should be added in the JS_LIBRARY group, so that
623
    // the behavior executes early. JS_LIBRARY is the default.
624
    $library['dependencies'][] = 'locale/drupal.locale.datepicker';
625

626
    $language_interface = \Drupal::languageManager()->getCurrentLanguage();
627 628 629 630 631
    $settings['jquery']['ui']['datepicker'] = array(
      'isRTL' => $language_interface->direction == Language::DIRECTION_RTL,
      'firstDay' => \Drupal::config('system.date')->get('first_day'),
    );
    $library['js'][] = array(
632
      'type' => 'setting',
633
      'data' => $settings,
634 635 636 637
    );
  }
}

638
/**
639
 * Implements hook_form_FORM_ID_alter() for language_admin_overview_form().
640
 */
641
function locale_form_language_admin_overview_form_alter(&$form, &$form_state) {
642 643
  $languages = $form['languages']['#languages'];

644
  $total_strings = \Drupal::service('locale.storage')->countStrings();
645 646 647 648
  $stats = array_fill_keys(array_keys($languages), array());

  // If we have source strings, count translations and calculate progress.
  if (!empty($total_strings)) {
649
    $translations = \Drupal::service('locale.storage')->countTranslations();
650 651 652 653
    foreach ($translations as $langcode => $translated) {
      $stats[$langcode]['translated'] = $translated;
      if ($translated > 0) {
        $stats[$langcode]['ratio'] = round($translated / $total_strings * 100, 2);
654 655 656 657 658 659 660 661 662 663 664
      }
    }
  }

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

  foreach ($languages as $langcode => $language) {
    $stats[$langcode] += array(
      'translated' => 0,
      'ratio' => 0,
    );
665
    if (!$language->locked && ($langcode != 'en' || locale_translate_english())) {
666
      $form['languages'][$langcode]['locale_statistics'] = array(
667 668 669 670 671 672
        '#markup' => l(
          t('@translated/@total (@ratio%)', array(
            '@translated' => $stats[$langcode]['translated'],
            '@total' => $total_strings,
            '@ratio' => $stats[$langcode]['ratio'],
          )),
673
          'admin/config/regional/translate',
674 675
          array('query' => array('langcode' => $langcode))
        ),
676 677 678 679
      );
    }
    else {
      $form['languages'][$langcode]['locale_statistics'] = array(
680
        '#markup' => t('not applicable'),
681 682
      );
    }
683 684 685 686 687
    // #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;
688 689
  }
}
690 691

/**
692 693 694 695 696 697 698 699
 * 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';
}

/**
700 701 702
 * Form submission handler for language_admin_add_form().
 *
 * Set a batch for a newly-added language.
703 704
 */
function locale_form_language_admin_add_form_alter_submit($form, $form_state) {
705
  if (\Drupal::config('locale.settings')->get('translation.import_enabled')) {
706 707 708 709 710 711
    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'];
    }
712

713 714 715 716
    // 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);
717
    batch_set($batch);
718 719

    // Create or update all configuration translations for this language.
720
    \Drupal::moduleHandler()->loadInclude('locale', 'bulk.inc');
721 722 723
    if ($batch = locale_config_batch_update_components($options, array($langcode))) {
      batch_set($batch);
    }
724
  }
725 726 727 728
}

/**
 * Implements hook_form_FORM_ID_alter() for language_admin_edit_form().
729
 */
730
function locale_form_language_admin_edit_form_alter(&$form, &$form_state) {
731 732 733 734 735 736
  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(),
    );
737
    $form['actions']['submit']['#submit'][] = 'locale_form_language_admin_edit_form_alter_submit';
738 739 740 741
  }
}

/**
742
 * Form submission handler for language_admin_edit_form().
743
 */
744
function locale_form_language_admin_edit_form_alter_submit($form, $form_state) {
745
  \Drupal::config('locale.settings')->set('translate_english', intval($form_state['values']['locale_translate_english']))->save();
746 747 748
}

/**
749 750 751 752
 * Checks whether locale translates to English.
 *
 * @return bool
 *   Returns TRUE if content should be translated to English, FALSE otherwise.
753 754
 */
function locale_translate_english() {
755
  return \Drupal::config('locale.settings')->get('translate_english');
756
}
757 758 759 760 761 762 763

/**
 * 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) {
764
  $form['translation_path'] = array(
765 766
    '#type' => 'textfield',
    '#title' => t('Interface translations directory'),
767
    '#default_value' => \Drupal::config('locale.settings')->get('translation.path'),
768
    '#maxlength' => 255,
769
    '#description' => t('A local file system path where interface translation files will be stored.'),
770
    '#required' => TRUE,
771 772 773 774 775 776
    '#after_build' => array('system_check_directory'),
    '#weight' => 10,
  );
  if ($form['file_default_scheme']) {
    $form['file_default_scheme']['#weight'] = 20;
  }
777 778 779 780 781 782 783 784 785 786 787
  $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) {
788
  if ($form['translation_path']['#default_value'] != $form_state['values']['translation_path']) {
789 790
    locale_translation_clear_status();
  }
791

792
  \Drupal::config('locale.settings')
793 794
    ->set('translation.path', $form_state['values']['translation_path'])
    ->save();
795
}
796 797

/**
798
 * Implements hook_preprocess_HOOK() for node templates.
799 800
 */
function locale_preprocess_node(&$variables) {
801
  if ($variables['node']->language()->id != Language::LANGCODE_NOT_SPECIFIED) {
802
    $language_interface = \Drupal::languageManager()->getCurrentLanguage();
803

804
    $node_language = $variables['node']->language();
805
    if ($node_language->id != $language_interface->id) {
806 807 808
      // If the node language was different from the page language, we should
      // add markup to identify the language. Otherwise the page language is
      // inherited.
809
      $variables['attributes']['lang'] = $node_language->id;
810
      if ($node_language->direction != $language_interface->direction) {
811 812 813
        // If text direction is different form the page's text direction, add
        // direction information as well.
        $dir = array('ltr', 'rtl');
814
        $variables['attributes']['dir'] = $dir[$node_language->direction];
815 816 817 818
      }
    }
  }
}
819

820 821 822 823 824 825 826 827 828 829 830 831 832
/**
 * 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) {
833
      $file->type = $file->timestamp ? LOCALE_TRANSLATION_CURRENT : '';
834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849
      $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.
 */
function locale_translation_update_file_history($file) {
850 851 852 853 854 855 856 857 858 859 860
  $status = db_merge('locale_file')
    ->key(array(
      'project' => $file->project,
      'langcode' => $file->langcode,
    ))
    ->fields(array(
      'version' => $file->version,
      'timestamp' => $file->timestamp,
      'last_checked' => $file->last_checked,
    ))
    ->execute();
861 862 863
  // 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');
864
  return $status;
865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886
}

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

887 888 889 890 891 892 893
/**
 * Gets the current translation status.
 *
 * @todo What is 'translation status'?
 */
function locale_translation_get_status($projects = NULL, $langcodes = NULL) {
  $result = array();
894
  $status = \Drupal::state()->get('locale.translation_status');
895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916
  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;
}

917 918 919
/**
 * Saves the status of translation sources in static cache.
 *
920 921 922 923 924 925
 * @param string $project
 *   Machine readable project name.
 * @param string $langcode
 *   Language code.
 * @param string $type
 *   Type of data to be stored.
926
 * @param array $data
927
 *   File object also containing timestamp when the translation is last updated.
928
 */
929
function locale_translation_status_save($project, $langcode, $type, $data) {
930 931 932 933
  // Followup issue: http://drupal.org/node/1842362
  // Split status storage per module/language and expire individually. This will
  // improve performance for large sites.

934 935 936 937 938 939 940
  // 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);
941 942 943
    }
  }

944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970
  // 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;
    }

971 972
    \Drupal::state()->set('locale.translation_status', $status);
    \Drupal::state()->set('locale.translation_last_checked', REQUEST_TIME);
973
  }
974 975 976 977 978 979 980 981 982
}

/**
 * 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) {
983
  if ($status = locale_translation_get_status()) {
984 985 986 987 988
    foreach ($status as $project => $languages) {
      foreach ($languages as $langcode => $source) {
        if (in_array($langcode, $langcodes)) {
          unset($status[$project][$langcode]);
        }