locale.module 54.2 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\Component\Utility\Crypt;
17

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

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

/**
95 96 97 98 99 100 101 102 103 104 105 106
 * 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.
107
 */
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
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
131
/**
132
 * Implements hook_help().
Dries's avatar
 
Dries committed
133
 */
134 135
function locale_help($path, $arg) {
  switch ($path) {
136
    case 'admin/help#locale':
137 138
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
139
      $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>';
140 141 142 143 144
      $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>';
145
      $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>';
146
      $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>';
147
      $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>';
148 149
      $output .= '</ul></dd>';
      $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_menu().
Dries's avatar
 
Dries committed
172
 */
173
function locale_menu() {
174
  // Translation functionality.
175
  $items['admin/config/regional/translate'] = array(
176 177
    'title' => 'User interface translation',
    'description' => 'Translate the built-in user interface.',
178
    'route_name' => 'locale.translate_page',
179
    'weight' => 15,
180
  );
181

182 183
  $items['admin/reports/translations'] = array(
    'title' => 'Available translation updates',
184
    'route_name' => 'locale.translate_status',
185 186
    'description' => 'Get a status report about available interface translations for your installed modules and themes.',
  );
Dries's avatar
 
Dries committed
187

Dries's avatar
 
Dries committed
188
  return $items;
Dries's avatar
 
Dries committed
189 190
}

191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
/**
 * Implements hook_menu_link_defaults().
 */
function locale_menu_link_defaults() {
  // Translation functionality.
  $links['locale.admin.config.regional.translate'] = array(
    'link_title' => 'User interface translation',
    'description' => 'Translate the built-in user interface.',
    'route_name' => 'locale.translate_page',
    'parent' => 'system.admin.config.regional',
    'weight' => 15,
  );

  $links['locale.admin.reports.translations'] = array(
    'link_title' => 'Available translation updates',
    'route_name' => 'locale.translate_status',
    'description' => 'Get a status report about available interface translations for your installed modules and themes.',
    'parent' => 'system.admin.reports',
  );

  return $links;
}

Dries's avatar
 
Dries committed
214
/**
215
 * Implements hook_permission().
Dries's avatar
 
Dries committed
216
 */
217
function locale_permission() {
218
  return array(
219
    'translate interface' => array(
220
      'title' => t('Translate interface texts'),
221
      'restrict access' => TRUE,
222
    ),
223
  );
224 225 226
}

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

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

263
/**
264
 * Implements hook_language_insert().
265
 */
266 267 268
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.
269
  \Drupal::cache('page')->deleteAll();
270
  // Force JavaScript translation file re-creation for the new language.
271
  _locale_invalidate_js($language->id);
272 273 274
}

/**
275
 * Implements hook_language_update().
276
 */
277 278 279
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.
280
  \Drupal::cache('page')->deleteAll();
281
  // Force JavaScript translation file re-creation for the modified language.
282
  _locale_invalidate_js($language->id);
283 284 285
}

/**
286
 * Implements hook_language_delete().
287
 */
288 289
function locale_language_delete($language) {
  // Remove translations.
290
  \Drupal::service('locale.storage')->deleteTranslations(array('language' => $language->id));
291

292 293
  // Remove interface translation files.
  module_load_include('inc', 'locale', 'locale.bulk');
294
  locale_translate_delete_translation_files(array(), array($language->id));
295

296
  // Remove translated configuration objects.
297
  \Drupal\locale\Locale::config()->deleteLanguageTranslations($language->id);
298

299
  // Changing the language settings impacts the interface:
300
  _locale_invalidate_js($language->id);
301
  \Drupal::cache('page')->deleteAll();
302

303
  // Clear locale translation caches.
304
  locale_translation_status_delete_languages(array($language->id));
305
  \Drupal::cache()->delete('locale:' . $language->id);
306 307
}

308 309 310 311 312 313 314 315 316 317 318 319 320 321
/**
 * 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
322

Dries's avatar
 
Dries committed
323
/**
324
 * Returns plural form index for a specific number.
Dries's avatar
 
Dries committed
325
 *
326
 * The index is computed from the formula of this language.
327
 *
328 329 330 331 332
 * @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.
333 334 335 336
 * @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
337
 */
338
function locale_get_plural($count, $langcode = NULL) {
339
  $language_interface = language(Language::TYPE_INTERFACE);
340 341 342 343 344 345

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

347
  $langcode = $langcode ? $langcode : $language_interface->id;
348

349 350 351
  if (!isset($plural_indexes[$langcode][$count])) {
    // Retrieve and statically cache the plural formulas for all languages.
    if (empty($plural_formulas)) {
352
      $plural_formulas = \Drupal::state()->get('locale.translation.plurals') ?: array();
Dries's avatar
 
Dries committed
353
    }
354 355 356 357
    // 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])) {
358 359 360
      // $n is used inside the expression in the eval().
      $n = $count;
      $plural_indexes[$langcode][$count] = @eval('return intval(' . $plural_formulas[$langcode]['formula'] . ');');
361 362 363 364 365
    }
    // 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
366
    }
367
    // Otherwise, return -1 (unknown).
Dries's avatar
 
Dries committed
368
    else {
369
      $plural_indexes[$langcode][$count] = -1;
370
    }
Dries's avatar
 
Dries committed
371
  }
372
  return $plural_indexes[$langcode][$count];
373
}
Dries's avatar
 
Dries committed
374

375

376
/**
377 378 379
 * Implements hook_modules_installed().
 */
function locale_modules_installed($modules) {
380 381
  $components['module'] = $modules;
  locale_system_update($components);
382 383
}

384 385 386 387
/**
 * Implements hook_modules_uninstalled().
 */
function locale_modules_uninstalled($modules) {
388 389
  $components['module'] = $modules;
  locale_system_remove($components);
390 391
}

392 393 394 395 396 397 398
/**
 * 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) {
399 400
  $components['theme'] = $themes;
  locale_system_update($components);
401 402
}

403 404 405 406
/**
 * Implements hook_themes_disabled().
 */
function locale_themes_disabled($themes) {
407 408
  $components['theme'] = $themes;
  locale_system_remove($components);
409 410
}

411 412 413 414 415 416 417 418 419 420
/**
 * 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().
421
  if ($frequency = \Drupal::config('locale.settings')->get('translation.update_interval_days') && locale_translatable_language_list()) {
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
    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']);
491
    $queue = \Drupal::queue('locale_translation', TRUE);
492 493 494 495
    $queue->createItem(array($function, $args));
  }
}

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

510 511 512
  // 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.
513
  if (!drupal_installation_attempted() && locale_translatable_language_list() && \Drupal::config('locale.settings')->get('translation.import_enabled')) {
514 515 516 517 518 519
    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());
520
    if ($list = array_intersect($list, $projects)) {
521 522 523
      module_load_include('fetch.inc', 'locale');
      // Get translation status of the projects, download and update translations.
      $options = _locale_translation_default_update_options();
524 525 526
      $batch = locale_translation_batch_update_build($list, array(), $options);
      batch_set($batch);
    }
527
    \Drupal::moduleHandler()->loadInclude('locale', 'bulk.inc');
528
    if ($batch = locale_config_batch_update_components(array(), array(), $components)) {
529 530
      batch_set($batch);
    }
531 532 533
  }
}

534 535 536 537 538 539 540 541
/**
 * 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
542 543
 *   An array of arrays of component (theme and/or module) names to import
 *   translations for, indexed by type.
544 545
 */
function locale_system_remove($components) {
546 547 548
  $components += array('module' => array(), 'theme' => array());
  $list = array_merge($components['module'], $components['theme']);
  if ($language_list = locale_translatable_language_list()) {
549
    module_load_include('compare.inc', 'locale');
550
    \Drupal::moduleHandler()->loadInclude('locale', 'bulk.inc');
551 552
    // Delete configuration translations.
    \Drupal\locale\Locale::config()->deleteComponentTranslations($components, array_keys($language_list));
553 554 555 556

    // 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());
557 558
    if ($list = array_intersect($list, $projects)) {
      locale_translation_file_history_delete($list);
559 560

      // Remove translation files.
561
      locale_translate_delete_translation_files($list, array());
562 563 564 565 566

      // 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')
567
        ->condition('name', $list)
568 569 570
        ->execute();

      // Clear the translation status.
571
      locale_translation_status_delete_projects($list);
572
    }
573

574 575 576
  }
}

577
/**
578
 * Implements hook_js_alter().
579
 */
580
function locale_js_alter(&$javascript) {
581 582 583 584 585 586 587 588 589 590
  $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);
  }
}
591

592 593 594 595 596 597 598 599 600 601
/**
 * 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.
602
 * @return string|null
603 604 605 606
 *   The filepath to the translation file or NULL if no translation is
 *   applicable.
 */
function locale_js_translate(array $files = array()) {
607
  $language_interface = language(Language::TYPE_INTERFACE);
608

609 610
  $dir = 'public://' . \Drupal::config('locale.settings')->get('javascript.directory');
  $parsed = \Drupal::state()->get('system.javascript_parsed') ?: array();
611 612 613 614 615 616 617 618 619
  $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;
620 621 622 623 624 625 626 627
      }
    }
  }

  // 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) {
628
    $parsed += _locale_invalidate_js();
629 630 631
  }

  // If necessary, rebuild the translation file for the current language.
632
  if (!empty($parsed['refresh:' . $language_interface->id])) {
633 634
    // Don't clear the refresh flag on failure, so that another try will
    // be performed later.
635
    if (_locale_rebuild_js()) {
636
      unset($parsed['refresh:' . $language_interface->id]);
637 638
    }
    // Store any changes after refresh was attempted.
639
    \Drupal::state()->set('system.javascript_parsed', $parsed);
640 641 642
  }
  // 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.
643
  elseif ($new_files) {
644
    \Drupal::state()->set('system.javascript_parsed', $parsed);
645 646 647
  }

  // Add the translation JavaScript file to the page.
648
  $locale_javascripts = \Drupal::state()->get('locale.translation.javascript') ?: array();
649 650
  $translation_file = NULL;
  if (!empty($files) && !empty($locale_javascripts[$language_interface->id])) {
651
    // Add the translation JavaScript file to the page.
652
    $translation_file = $dir . '/' . $language_interface->id . '_' . $locale_javascripts[$language_interface->id] . '.js';
653
  }
654
  return $translation_file;
655 656
}

657 658 659 660 661 662
/**
 * Implements hook_library_info().
 */
function locale_library_info() {
  $libraries['drupal.locale.admin'] = array(
    'title' => 'Locale',
663
    'version' => \Drupal::VERSION,
664 665 666 667 668 669 670 671 672 673 674
    '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',
675
    'version' => \Drupal::VERSION,
676 677 678 679 680 681
    'js' => array(
      drupal_get_path('module', 'locale') . '/locale.datepicker.js' => array(),
    ),
    'dependencies' => array(
      array('system', 'jquery'),
      array('system', 'drupal'),
682
      array('system', 'drupalSettings'),
683 684 685 686 687 688
    ),
  );

  return $libraries;
}

689
/**
690
 * Implement hook_library_info_alter().
691 692 693
 *
 * Provides the language support for the jQuery UI Date Picker.
 */
694
function locale_library_info_alter(&$libraries, $module) {
695
  if ($module == 'system' && isset($libraries['jquery.ui.datepicker'])) {
696
    $language_interface = language(Language::TYPE_INTERFACE);
697 698 699
    // 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.
700
    $libraries['jquery.ui.datepicker']['dependencies'][] = array('locale', 'drupal.locale.datepicker');
701
    $libraries['jquery.ui.datepicker']['js'][] = array(
702
      'data' => array(
703 704 705
        'jquery' => array(
          'ui' => array(
            'datepicker' => array(
706
              'isRTL' => $language_interface->direction == Language::DIRECTION_RTL,
707
              'firstDay' => \Drupal::config('system.date')->get('first_day'),
708 709
            ),
          ),
710 711 712 713 714 715 716
        ),
      ),
      'type' => 'setting',
    );
  }
}

717
/**
718
 * Implements hook_form_FORM_ID_alter() for language_admin_overview_form().
719
 */
720
function locale_form_language_admin_overview_form_alter(&$form, &$form_state) {
721 722
  $languages = $form['languages']['#languages'];

723
  $total_strings = \Drupal::service('locale.storage')->countStrings();
724 725 726 727
  $stats = array_fill_keys(array_keys($languages), array());

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

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

  foreach ($languages as $langcode => $language) {
    $stats[$langcode] += array(
      'translated' => 0,
      'ratio' => 0,
    );
744
    if (!$language->locked && ($langcode != 'en' || locale_translate_english())) {
745
      $form['languages'][$langcode]['locale_statistics'] = array(
746 747 748 749 750 751
        '#markup' => l(
          t('@translated/@total (@ratio%)', array(
            '@translated' => $stats[$langcode]['translated'],
            '@total' => $total_strings,
            '@ratio' => $stats[$langcode]['ratio'],
          )),
752
          'admin/config/regional/translate',
753 754
          array('query' => array('langcode' => $langcode))
        ),
755 756 757 758
      );
    }
    else {
      $form['languages'][$langcode]['locale_statistics'] = array(
759
        '#markup' => t('not applicable'),
760 761
      );
    }
762 763 764 765 766
    // #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;
767 768
  }
}
769 770

/**
771 772 773 774 775 776 777 778
 * 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';
}

/**
779 780 781
 * Form submission handler for language_admin_add_form().
 *
 * Set a batch for a newly-added language.
782 783
 */
function locale_form_language_admin_add_form_alter_submit($form, $form_state) {
784
  if (\Drupal::config('locale.settings')->get('translation.import_enabled')) {
785 786 787 788 789 790
    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'];
    }
791

792 793 794 795
    // 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);
796
    batch_set($batch);
797 798

    // Create or update all configuration translations for this language.
799
    \Drupal::moduleHandler()->loadInclude('locale', 'bulk.inc');
800 801 802
    if ($batch = locale_config_batch_update_components($options, array($langcode))) {
      batch_set($batch);
    }
803
  }
804 805 806 807
}

/**
 * Implements hook_form_FORM_ID_alter() for language_admin_edit_form().
808
 */
809
function locale_form_language_admin_edit_form_alter(&$form, &$form_state) {
810 811 812 813 814 815
  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(),
    );
816
    $form['actions']['submit']['#submit'][] = 'locale_form_language_admin_edit_form_alter_submit';
817 818 819 820
  }
}

/**
821
 * Form submission handler for language_admin_edit_form().
822
 */
823
function locale_form_language_admin_edit_form_alter_submit($form, $form_state) {
824
  \Drupal::config('locale.settings')->set('translate_english', intval($form_state['values']['locale_translate_english']))->save();
825 826 827
}

/**
828 829 830 831
 * Checks whether locale translates to English.
 *
 * @return bool
 *   Returns TRUE if content should be translated to English, FALSE otherwise.
832 833
 */
function locale_translate_english() {
834
  return \Drupal::config('locale.settings')->get('translate_english');
835
}
836 837 838 839 840 841 842

/**
 * 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) {
843
  $form['translation_path'] = array(
844 845
    '#type' => 'textfield',
    '#title' => t('Interface translations directory'),
846
    '#default_value' => \Drupal::config('locale.settings')->get('translation.path'),
847
    '#maxlength' => 255,
848
    '#description' => t('A local file system path where interface translation files will be stored.'),
849
    '#required' => TRUE,
850 851 852 853 854 855
    '#after_build' => array('system_check_directory'),
    '#weight' => 10,
  );
  if ($form['file_default_scheme']) {
    $form['file_default_scheme']['#weight'] = 20;
  }
856 857 858 859 860 861 862 863 864 865 866
  $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) {
867
  if ($form['translation_path']['#default_value'] != $form_state['values']['translation_path']) {
868 869
    locale_translation_clear_status();
  }
870

871
  \Drupal::config('locale.settings')
872 873
    ->set('translation.path', $form_state['values']['translation_path'])
    ->save();
874
}
875 876

/**
877
 * Implements hook_preprocess_HOOK() for node templates.
878 879
 */
function locale_preprocess_node(&$variables) {
880
  if ($variables['node']->language()->id != Language::LANGCODE_NOT_SPECIFIED) {
881
    $language_interface = language(Language::TYPE_INTERFACE);
882

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

899 900 901 902 903 904 905 906 907 908 909 910 911
/**
 * 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) {
912
      $file->type = $file->timestamp ? LOCALE_TRANSLATION_CURRENT : '';
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
      $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();
  }
938 939 940 941 942
  $result = drupal_write_record('locale_file', $file, $update);
  // The file history has changed, flush the static cache now.
  // @todo Can we make this more fine grained?
  drupal_static_reset('locale_translation_get_file_history');
  return $result;
943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964
}

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

965 966 967 968 969 970 971
/**
 * Gets the current translation status.
 *
 * @todo What is 'translation status'?
 */
function locale_translation_get_status($projects = NULL, $langcodes = NULL) {
  $result = array();
972
  $status = \Drupal::state()->get('locale.translation_status');
973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992