locale.module 53.6 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
 * When enabled, multiple languages can be added. The site interface can be
8 9 10
 * 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\Serialization\Json;
14
use Drupal\Component\Utility\UrlHelper;
15
use Drupal\Component\Utility\Xss;
16
use Drupal\Core\Cache\Cache;
17
use Drupal\Core\Language\Language;
18
use Drupal\Core\Routing\RouteMatchInterface;
19
use Drupal\Core\StringTranslation\TranslationWrapper;
20
use Drupal\Core\Language\LanguageInterface;
21
use Drupal\language\Entity\Language as LanguageEntity;
22
use Drupal\Component\Utility\Crypt;
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 71 72 73 74
/**
 * 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;

75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
/**
 * 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';

/**
101 102 103 104 105 106 107 108 109 110 111 112
 * 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.
113
 */
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
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
137
/**
138
 * Implements hook_help().
Dries's avatar
 
Dries committed
139
 */
140
function locale_help($route_name, RouteMatchInterface $route_match) {
141 142
  switch ($route_name) {
    case 'help.page.locale':
143 144
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
145
      $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>';
146 147
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
148
      $output .= '<dt>' . t('Importing translation files') . '</dt>';
149
      $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 title="User interface translation import" 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>';
150 151 152
      $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>';
153
      $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 title="User interface translation export" href="!export">Export</a> page. Once you have edited the translation file, you can then import it again on the <a title="User interface translation import" 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>';
154
      $output .= '</dl>';
155
      return $output;
156

157
    case 'language.admin_overview':
158 159
      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 customized in the <a href="!translate">user interface translation</a> page.', array('!update' => \Drupal::url('locale.translate_status'), '!translate' => \Drupal::url('locale.translate_page'))) . '</p>';

160
    case 'locale.translate_page':
161
      $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 involve many strings, it may be more convenient to <a title="User interface translation export" 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' => \Drupal::url('locale.translate_export'))) . '</p>';
162
      return $output;
163

164
    case 'locale.translate_import':
165
      $output = '<p>' . t('Translation files are automatically downloaded and imported when <a title="Languages" href="!language">languages</a> are added, or when modules or themes are enabled.', array('!language' => \Drupal::url('language.admin_overview'))) . '</p>';
166
      $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 title="User interface translation export" 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' => 'https://localize.drupal.org', '!export' => \Drupal::url('locale.translate_export'))) . '</p>';
167
      $output .= '<p>' . t('Note that importing large .po files may take several minutes.') . '</p>';
168
      return $output;
169

170
    case 'locale.translate_export':
171
      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
172
  }
Dries's avatar
 
Dries committed
173 174
}

Dries's avatar
 
Dries committed
175
/**
176
 * Implements hook_permission().
Dries's avatar
 
Dries committed
177
 */
178
function locale_permission() {
179
  return array(
180
    'translate interface' => array(
181
      'title' => t('Translate interface texts'),
182
      'restrict access' => TRUE,
183
    ),
184
  );
185 186 187
}

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

209 210 211 212 213 214
/**
 * Implements hook_stream_wrappers().
 */
function locale_stream_wrappers() {
  $wrappers = array(
    'translations' => array(
215
      'name' => new TranslationWrapper('Translation files'),
216
      'class' => 'Drupal\locale\TranslationsStream',
217
      'description' => new TranslationWrapper('Translation files'),
218
      'type' => STREAM_WRAPPERS_LOCAL_HIDDEN,
219 220 221 222 223
    ),
  );
  return $wrappers;
}

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

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

/**
247
 * Implements hook_ENTITY_TYPE_delete() for 'language_entity'.
248
 */
249
function locale_language_entity_delete(LanguageEntity $language) {
250
  // Remove translations.
251
  \Drupal::service('locale.storage')->deleteTranslations(array('language' => $language->id()));
252

253 254
  // Remove interface translation files.
  module_load_include('inc', 'locale', 'locale.bulk');
255
  locale_translate_delete_translation_files(array(), array($language->id()));
256

257
  // Remove translated configuration objects.
258
  \Drupal\locale\Locale::config()->deleteLanguageTranslations($language->id());
259

260
  // Changing the language settings impacts the interface:
261
  _locale_invalidate_js($language->id());
262
  \Drupal::cache('render')->deleteAll();
263

264
  // Clear locale translation caches.
265 266
  locale_translation_status_delete_languages(array($language->id()));
  \Drupal::cache()->delete('locale:' . $language->id());
267 268
}

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

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

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

309
  $langcode = $langcode ? $langcode : $language_interface->id;
310

311 312 313
  if (!isset($plural_indexes[$langcode][$count])) {
    // Retrieve and statically cache the plural formulas for all languages.
    if (empty($plural_formulas)) {
314
      $plural_formulas = \Drupal::state()->get('locale.translation.plurals') ?: array();
Dries's avatar
 
Dries committed
315
    }
316 317 318 319
    // 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])) {
320 321 322 323 324
      // 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'];
325 326 327 328 329
    }
    // 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
330
    }
331
    // Otherwise, return -1 (unknown).
Dries's avatar
 
Dries committed
332
    else {
333
      $plural_indexes[$langcode][$count] = -1;
334
    }
Dries's avatar
 
Dries committed
335
  }
336
  return $plural_indexes[$langcode][$count];
337
}
Dries's avatar
 
Dries committed
338

339

340
/**
341 342 343
 * Implements hook_modules_installed().
 */
function locale_modules_installed($modules) {
344 345
  $components['module'] = $modules;
  locale_system_update($components);
346 347
}

348 349 350 351
/**
 * Implements hook_modules_uninstalled().
 */
function locale_modules_uninstalled($modules) {
352 353
  $components['module'] = $modules;
  locale_system_remove($components);
354 355
}

356 357 358 359 360 361 362
/**
 * 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) {
363 364
  $components['theme'] = $themes;
  locale_system_update($components);
365 366
}

367 368 369 370
/**
 * Implements hook_themes_disabled().
 */
function locale_themes_disabled($themes) {
371 372
  $components['theme'] = $themes;
  locale_system_remove($components);
373 374
}

375 376 377 378 379 380 381 382 383 384
/**
 * 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().
385
  if ($frequency = \Drupal::config('locale.settings')->get('translation.update_interval_days') && locale_translatable_language_list()) {
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
    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
417
 *   Queue data array containing:
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 449 450 451 452 453 454
 *   - 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']);
455
    $queue = \Drupal::queue('locale_translation', TRUE);
456 457 458 459
    $queue->createItem(array($function, $args));
  }
}

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

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

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

    // Only when projects are removed, the translation files and records will be
520 521
    // deleted. Not each disabled module will remove a project, e.g., sub
    // modules.
522
    $projects = array_keys(locale_translation_get_projects());
523 524
    if ($list = array_intersect($list, $projects)) {
      locale_translation_file_history_delete($list);
525 526

      // Remove translation files.
527
      locale_translate_delete_translation_files($list, array());
528 529 530 531 532

      // 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')
533
        ->condition('name', $list)
534 535 536
        ->execute();

      // Clear the translation status.
537
      locale_translation_status_delete_projects($list);
538
    }
539

540 541 542
  }
}

543
/**
544
 * Implements hook_js_alter().
545
 */
546
function locale_js_alter(&$javascript) {
547 548 549 550 551 552 553 554 555 556
  $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);
  }
}
557

558 559 560 561 562 563 564 565 566 567
/**
 * 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.
568
 *
569
 * @return string|null
570 571 572 573
 *   The filepath to the translation file or NULL if no translation is
 *   applicable.
 */
function locale_js_translate(array $files = array()) {
574
  $language_interface = \Drupal::languageManager()->getCurrentLanguage();
575

576 577
  $dir = 'public://' . \Drupal::config('locale.settings')->get('javascript.directory');
  $parsed = \Drupal::state()->get('system.javascript_parsed') ?: array();
578 579 580 581 582 583 584 585 586
  $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;
587 588 589 590 591 592 593 594
      }
    }
  }

  // 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) {
595
    $parsed += _locale_invalidate_js();
596 597 598
  }

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

  // Add the translation JavaScript file to the page.
615
  $locale_javascripts = \Drupal::state()->get('locale.translation.javascript') ?: array();
616 617
  $translation_file = NULL;
  if (!empty($files) && !empty($locale_javascripts[$language_interface->id])) {
618
    // Add the translation JavaScript file to the page.
619
    $translation_file = $dir . '/' . $language_interface->id . '_' . $locale_javascripts[$language_interface->id] . '.js';
620
  }
621
  return $translation_file;
622 623
}

624
/**
625
 * Implements hook_library_alter().
626 627 628
 *
 * Provides the language support for the jQuery UI Date Picker.
 */
629 630
function locale_library_alter(array &$library, $name) {
  if ($name == 'core/jquery.ui.datepicker') {
631
    // locale.datepicker.js should be added in the JS_LIBRARY group, so that
632
    // the behavior executes early. JS_LIBRARY is the default.
633
    $library['dependencies'][] = 'locale/drupal.locale.datepicker';
634

635
    $language_interface = \Drupal::languageManager()->getCurrentLanguage();
636
    $settings['jquery']['ui']['datepicker'] = array(
637
      'isRTL' => $language_interface->direction == LanguageInterface::DIRECTION_RTL,
638 639 640
      'firstDay' => \Drupal::config('system.date')->get('first_day'),
    );
    $library['js'][] = array(
641
      'type' => 'setting',
642
      'data' => $settings,
643 644 645 646
    );
  }
}

647
/**
648
 * Implements hook_form_FORM_ID_alter() for language_admin_overview_form().
649
 */
650
function locale_form_language_admin_overview_form_alter(&$form, &$form_state) {
651 652
  $languages = $form['languages']['#languages'];

653
  $total_strings = \Drupal::service('locale.storage')->countStrings();
654 655 656 657
  $stats = array_fill_keys(array_keys($languages), array());

  // If we have source strings, count translations and calculate progress.
  if (!empty($total_strings)) {
658
    $translations = \Drupal::service('locale.storage')->countTranslations();
659 660 661 662
    foreach ($translations as $langcode => $translated) {
      $stats[$langcode]['translated'] = $translated;
      if ($translated > 0) {
        $stats[$langcode]['ratio'] = round($translated / $total_strings * 100, 2);
663 664 665 666 667 668 669 670 671 672 673
      }
    }
  }

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

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

/**
701
 * Implements hook_form_FORM_ID_alter() for language_admin_add_form().
702 703 704 705 706 707 708
 */
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';
}

/**
709 710 711
 * Form submission handler for language_admin_add_form().
 *
 * Set a batch for a newly-added language.
712 713
 */
function locale_form_language_admin_add_form_alter_submit($form, $form_state) {
714
  if (\Drupal::config('locale.settings')->get('translation.import_enabled')) {
715 716 717 718 719 720
    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'];
    }
721

722 723 724 725
    // 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);
726
    batch_set($batch);
727 728

    // Create or update all configuration translations for this language.
729
    \Drupal::moduleHandler()->loadInclude('locale', 'bulk.inc');
730 731 732
    if ($batch = locale_config_batch_update_components($options, array($langcode))) {
      batch_set($batch);
    }
733
  }
734 735 736 737
}

/**
 * Implements hook_form_FORM_ID_alter() for language_admin_edit_form().
738
 */
739
function locale_form_language_admin_edit_form_alter(&$form, &$form_state) {
740 741 742 743 744 745
  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(),
    );
746
    $form['actions']['submit']['#submit'][] = 'locale_form_language_admin_edit_form_alter_submit';
747 748 749 750
  }
}

/**
751
 * Form submission handler for language_admin_edit_form().
752
 */
753
function locale_form_language_admin_edit_form_alter_submit($form, $form_state) {
754
  \Drupal::config('locale.settings')->set('translate_english', intval($form_state['values']['locale_translate_english']))->save();
755 756 757
}

/**
758 759 760 761
 * Checks whether locale translates to English.
 *
 * @return bool
 *   Returns TRUE if content should be translated to English, FALSE otherwise.
762 763
 */
function locale_translate_english() {
764
  return \Drupal::config('locale.settings')->get('translate_english');
765
}
766 767 768 769 770 771 772

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

801
  \Drupal::config('locale.settings')
802 803
    ->set('translation.path', $form_state['values']['translation_path'])
    ->save();
804
}
805 806

/**
807
 * Implements hook_preprocess_HOOK() for node templates.
808 809
 */
function locale_preprocess_node(&$variables) {
810
  if ($variables['node']->language()->id != LanguageInterface::LANGCODE_NOT_SPECIFIED) {
811
    $language_interface = \Drupal::languageManager()->getCurrentLanguage();
812

813
    $node_language = $variables['node']->language();
814
    if ($node_language->id != $language_interface->id) {
815 816 817
      // If the node language was different from the page language, we should
      // add markup to identify the language. Otherwise the page language is
      // inherited.
818
      $variables['attributes']['lang'] = $node_language->id;
819
      if ($node_language->direction != $language_interface->direction) {
820 821 822
        // If text direction is different form the page's text direction, add
        // direction information as well.
        $dir = array('ltr', 'rtl');
823
        $variables['attributes']['dir'] = $dir[$node_language->direction];
824 825 826 827
      }
    }
  }
}
828

829 830 831 832 833 834 835 836 837 838 839 840 841
/**
 * 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) {
842
      $file->type = $file->timestamp ? LOCALE_TRANSLATION_CURRENT : '';
843 844 845 846 847 848 849 850 851 852 853 854
      $history[$file->project][$file->langcode] = $file;
    }
  }
  return $history;
}

/**
 * Updates the {locale_file} table.
 *
 * @param object $file
 *   Object representing the file just imported.
 *
855
 * @return int
856 857 858
 *   FALSE on failure. Otherwise SAVED_NEW or SAVED_UPDATED.
 */
function locale_translation_update_file_history($file) {
859 860 861 862 863 864 865 866 867 868 869
  $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();
870 871 872
  // 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');
873
  return $status;
874 875 876 877 878 879 880 881
}

/**
 * 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.
882
 * @param array $langcodes
883 884 885 886 887 888 889 890 891 892 893 894 895
 *   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();
}

896 897 898 899 900 901 902
/**
 * Gets the current translation status.
 *
 * @todo What is 'translation status'?
 */
function locale_translation_get_status($projects = NULL, $langcodes = NULL) {
  $result = array();
903
  $status = \Drupal::state()->get('locale.translation_status');
904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925
  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;
}

926 927 928
/**
 * Saves the status of translation sources in static cache.
 *
929 930 931 932 933 934
 * @param string $project
 *   Machine readable project name.
 * @param string $langcode
 *   Language code.
 * @param string $type
 *   Type of data to be stored.
935
 * @param array $data
936
 *   File object also containing timestamp when the translation is last updated.
937