locale.module 51.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
 * 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\Form\FormStateInterface;
18
use Drupal\Core\Language\Language;
19
use Drupal\Core\Routing\RouteMatchInterface;
20
use Drupal\Core\StringTranslation\TranslationWrapper;
21
use Drupal\Core\Language\LanguageInterface;
22
use Drupal\language\Entity\ConfigurableLanguage;
23
use Drupal\Component\Utility\Crypt;
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 75
/**
 * 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;

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

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

158
    case 'language.admin_overview':
159 160
      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>';

161
    case 'locale.translate_page':
162
      $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>';
163
      return $output;
164

165
    case 'locale.translate_import':
166
      $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>';
167
      $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>';
168
      $output .= '<p>' . t('Note that importing large .po files may take several minutes.') . '</p>';
169
      return $output;
170

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

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

198 199 200 201 202 203
/**
 * Implements hook_stream_wrappers().
 */
function locale_stream_wrappers() {
  $wrappers = array(
    'translations' => array(
204
      'name' => new TranslationWrapper('Translation files'),
205
      'class' => 'Drupal\locale\TranslationsStream',
206
      'description' => new TranslationWrapper('Translation files'),
207
      'type' => STREAM_WRAPPERS_LOCAL_HIDDEN,
208 209 210 211 212
    ),
  );
  return $wrappers;
}

213
/**
214
 * Implements hook_ENTITY_TYPE_insert() for 'configurable_language'.
215
 */
216
function locale_configurable_language_insert(ConfigurableLanguage $language) {
217
  // @todo move these two cache clears out. See http://drupal.org/node/1293252
218 219
  // Changing the language settings impacts the interface: clear render cache.
  \Drupal::cache('render')->deleteAll();
220
  // Force JavaScript translation file re-creation for the new language.
221
  _locale_invalidate_js($language->id());
222 223 224
}

/**
225
 * Implements hook_ENTITY_TYPE_update() for 'configurable_language'.
226
 */
227
function locale_configurable_language_update(ConfigurableLanguage $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 modified language.
232
  _locale_invalidate_js($language->id());
233 234 235
}

/**
236
 * Implements hook_ENTITY_TYPE_delete() for 'configurable_language'.
237
 */
238
function locale_configurable_language_delete(ConfigurableLanguage $language) {
239
  // Remove translations.
240
  \Drupal::service('locale.storage')->deleteTranslations(array('language' => $language->id()));
241

242 243
  // Remove interface translation files.
  module_load_include('inc', 'locale', 'locale.bulk');
244
  locale_translate_delete_translation_files(array(), array($language->id()));
245

246
  // Remove translated configuration objects.
247
  \Drupal\locale\Locale::config()->deleteLanguageTranslations($language->id());
248

249
  // Changing the language settings impacts the interface:
250
  _locale_invalidate_js($language->id());
251
  \Drupal::cache('render')->deleteAll();
252

253
  // Clear locale translation caches.
254 255
  locale_translation_status_delete_languages(array($language->id()));
  \Drupal::cache()->delete('locale:' . $language->id());
256 257
}

258 259 260 261 262 263 264 265
/**
 * 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() {
266
  $languages = \Drupal::languageManager()->getLanguages();
267 268 269 270 271
  if (!locale_translate_english()) {
    unset($languages['en']);
  }
  return $languages;
}
Dries's avatar
 
Dries committed
272

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

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

298
  $langcode = $langcode ? $langcode : $language_interface->id;
299

300 301 302
  if (!isset($plural_indexes[$langcode][$count])) {
    // Retrieve and statically cache the plural formulas for all languages.
    if (empty($plural_formulas)) {
303
      $plural_formulas = \Drupal::state()->get('locale.translation.plurals') ?: array();
Dries's avatar
 
Dries committed
304
    }
305 306 307 308
    // 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])) {
309 310 311 312 313
      // 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'];
314 315 316 317 318
    }
    // 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
319
    }
320
    // Otherwise, return -1 (unknown).
Dries's avatar
 
Dries committed
321
    else {
322
      $plural_indexes[$langcode][$count] = -1;
323
    }
Dries's avatar
 
Dries committed
324
  }
325
  return $plural_indexes[$langcode][$count];
326
}
Dries's avatar
 
Dries committed
327

328

329
/**
330 331 332
 * Implements hook_modules_installed().
 */
function locale_modules_installed($modules) {
333 334
  $components['module'] = $modules;
  locale_system_update($components);
335 336
}

337 338 339 340
/**
 * Implements hook_modules_uninstalled().
 */
function locale_modules_uninstalled($modules) {
341 342
  $components['module'] = $modules;
  locale_system_remove($components);
343 344
}

345
/**
346
 * Implements hook_themes_installed().
347
 */
348
function locale_themes_installed($themes) {
349 350
  $components['theme'] = $themes;
  locale_system_update($components);
351 352
}

353
/**
354
 * Implements hook_themes_uninstalled().
355
 */
356
function locale_themes_uninstalled($themes) {
357 358
  $components['theme'] = $themes;
  locale_system_remove($components);
359 360
}

361 362 363
/**
 * Implements hook_cron().
 *
364
 * @see \Drupal\locale\Plugin\QueueWorker\LocaleTranslation
365 366 367 368
 */
function locale_cron() {
  // Update translations only when an update frequency was set by the admin
  // and a translatable language was set.
369
  // Update tasks are added to the queue here but processed by Drupal's cron.
370
  if ($frequency = \Drupal::config('locale.settings')->get('translation.update_interval_days') && locale_translatable_language_list()) {
371 372 373 374 375
    module_load_include('translation.inc', 'locale');
    locale_cron_fill_queue();
  }
}

376 377
/**
 * Imports translations when new modules or themes are installed.
378
 *
379 380
 * This function will start a batch to import translations for the added
 * components.
381
 *
382
 * @param array $components
383 384
 *   An array of arrays of component (theme and/or module) names to import
 *   translations for, indexed by type.
385
 */
386 387 388 389
function locale_system_update(array $components) {
  $components += array('module' => array(), 'theme' => array());
  $list = array_merge($components['module'], $components['theme']);

390 391 392
  // 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.
393
  if (!drupal_installation_attempted() && locale_translatable_language_list() && \Drupal::config('locale.settings')->get('translation.import_enabled')) {
394 395 396 397 398 399
    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());
400
    if ($list = array_intersect($list, $projects)) {
401
      module_load_include('fetch.inc', 'locale');
402 403
      // Get translation status of the projects, download and update
      // translations.
404
      $options = _locale_translation_default_update_options();
405 406 407
      $batch = locale_translation_batch_update_build($list, array(), $options);
      batch_set($batch);
    }
408
    \Drupal::moduleHandler()->loadInclude('locale', 'bulk.inc');
409
    if ($batch = locale_config_batch_update_components(array(), array(), $components)) {
410 411
      batch_set($batch);
    }
412 413 414
  }
}

415 416 417 418 419 420 421 422
/**
 * 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
423 424
 *   An array of arrays of component (theme and/or module) names to import
 *   translations for, indexed by type.
425 426
 */
function locale_system_remove($components) {
427 428 429
  $components += array('module' => array(), 'theme' => array());
  $list = array_merge($components['module'], $components['theme']);
  if ($language_list = locale_translatable_language_list()) {
430
    module_load_include('compare.inc', 'locale');
431
    \Drupal::moduleHandler()->loadInclude('locale', 'bulk.inc');
432 433
    // Delete configuration translations.
    \Drupal\locale\Locale::config()->deleteComponentTranslations($components, array_keys($language_list));
434 435

    // Only when projects are removed, the translation files and records will be
436 437
    // deleted. Not each disabled module will remove a project, e.g., sub
    // modules.
438
    $projects = array_keys(locale_translation_get_projects());
439 440
    if ($list = array_intersect($list, $projects)) {
      locale_translation_file_history_delete($list);
441 442

      // Remove translation files.
443
      locale_translate_delete_translation_files($list, array());
444 445 446 447

      // Remove translatable projects.
      // Followup issue http://drupal.org/node/1842362 to replace the
      // {locale_project} table. Then change this to a function call.
448
      \Drupal::service('locale.project')->deleteMultiple($list);
449 450

      // Clear the translation status.
451
      locale_translation_status_delete_projects($list);
452
    }
453

454 455 456
  }
}

457 458 459 460 461 462 463
/**
 * Implements hook_cache_flush().
 */
function locale_cache_flush() {
  \Drupal::state()->delete('system.javascript_parsed');
}

464
/**
465
 * Implements hook_js_alter().
466
 */
467
function locale_js_alter(&$javascript) {
468 469 470 471 472 473 474 475 476 477
  $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);
  }
}
478

479 480 481 482 483 484 485 486 487 488
/**
 * 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.
489
 *
490
 * @return string|null
491 492 493 494
 *   The filepath to the translation file or NULL if no translation is
 *   applicable.
 */
function locale_js_translate(array $files = array()) {
495
  $language_interface = \Drupal::languageManager()->getCurrentLanguage();
496

497 498
  $dir = 'public://' . \Drupal::config('locale.settings')->get('javascript.directory');
  $parsed = \Drupal::state()->get('system.javascript_parsed') ?: array();
499 500 501 502 503 504 505 506 507
  $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;
508 509 510 511 512 513 514 515
      }
    }
  }

  // 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) {
516
    $parsed += _locale_invalidate_js();
517 518 519
  }

  // If necessary, rebuild the translation file for the current language.
520
  if (!empty($parsed['refresh:' . $language_interface->id])) {
521 522
    // Don't clear the refresh flag on failure, so that another try will
    // be performed later.
523
    if (_locale_rebuild_js()) {
524
      unset($parsed['refresh:' . $language_interface->id]);
525 526
    }
    // Store any changes after refresh was attempted.
527
    \Drupal::state()->set('system.javascript_parsed', $parsed);
528 529 530
  }
  // 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.
531
  elseif ($new_files) {
532
    \Drupal::state()->set('system.javascript_parsed', $parsed);
533 534 535
  }

  // Add the translation JavaScript file to the page.
536
  $locale_javascripts = \Drupal::state()->get('locale.translation.javascript') ?: array();
537 538
  $translation_file = NULL;
  if (!empty($files) && !empty($locale_javascripts[$language_interface->id])) {
539
    // Add the translation JavaScript file to the page.
540
    $translation_file = $dir . '/' . $language_interface->id . '_' . $locale_javascripts[$language_interface->id] . '.js';
541
  }
542
  return $translation_file;
543 544
}

545
/**
546
 * Implements hook_library_alter().
547 548 549
 *
 * Provides the language support for the jQuery UI Date Picker.
 */
550 551
function locale_library_alter(array &$library, $name) {
  if ($name == 'core/jquery.ui.datepicker') {
552
    // locale.datepicker.js should be added in the JS_LIBRARY group, so that
553
    // the behavior executes early. JS_LIBRARY is the default.
554
    $library['dependencies'][] = 'locale/drupal.locale.datepicker';
555

556
    $language_interface = \Drupal::languageManager()->getCurrentLanguage();
557
    $settings['jquery']['ui']['datepicker'] = array(
558
      'isRTL' => $language_interface->direction == LanguageInterface::DIRECTION_RTL,
559 560 561
      'firstDay' => \Drupal::config('system.date')->get('first_day'),
    );
    $library['js'][] = array(
562
      'type' => 'setting',
563
      'data' => $settings,
564 565 566 567
    );
  }
}

568
/**
569
 * Implements hook_form_FORM_ID_alter() for language_admin_overview_form().
570
 */
571
function locale_form_language_admin_overview_form_alter(&$form, FormStateInterface $form_state) {
572 573
  $languages = $form['languages']['#languages'];

574
  $total_strings = \Drupal::service('locale.storage')->countStrings();
575 576 577 578
  $stats = array_fill_keys(array_keys($languages), array());

  // If we have source strings, count translations and calculate progress.
  if (!empty($total_strings)) {
579
    $translations = \Drupal::service('locale.storage')->countTranslations();
580 581 582 583
    foreach ($translations as $langcode => $translated) {
      $stats[$langcode]['translated'] = $translated;
      if ($translated > 0) {
        $stats[$langcode]['ratio'] = round($translated / $total_strings * 100, 2);
584 585 586 587 588 589 590 591 592 593 594
      }
    }
  }

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

  foreach ($languages as $langcode => $language) {
    $stats[$langcode] += array(
      'translated' => 0,
      'ratio' => 0,
    );
595
    if (!$language->locked && ($langcode != 'en' || locale_translate_english())) {
596
      $form['languages'][$langcode]['locale_statistics'] = array(
597 598 599 600 601 602
        '#markup' => l(
          t('@translated/@total (@ratio%)', array(
            '@translated' => $stats[$langcode]['translated'],
            '@total' => $total_strings,
            '@ratio' => $stats[$langcode]['ratio'],
          )),
603
          'admin/config/regional/translate',
604 605
          array('query' => array('langcode' => $langcode))
        ),
606 607 608 609
      );
    }
    else {
      $form['languages'][$langcode]['locale_statistics'] = array(
610
        '#markup' => t('not applicable'),
611 612
      );
    }
613 614 615 616 617
    // #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;
618 619
  }
}
620 621

/**
622
 * Implements hook_form_FORM_ID_alter() for language_admin_add_form().
623
 */
624
function locale_form_language_admin_add_form_alter(&$form, FormStateInterface $form_state) {
625 626 627 628 629
  $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';
}

/**
630 631 632
 * Form submission handler for language_admin_add_form().
 *
 * Set a batch for a newly-added language.
633
 */
634
function locale_form_language_admin_add_form_alter_submit($form, FormStateInterface $form_state) {
635
  if (\Drupal::config('locale.settings')->get('translation.import_enabled')) {
636 637
    if ($form_state->isValueEmpty('predefined_langcode') || $form_state->getValue('predefined_langcode') == 'custom') {
      $langcode = $form_state->getValue('langcode');
638 639
    }
    else {
640
      $langcode = $form_state->getValue('predefined_langcode');
641
    }
642

643 644 645 646
    // 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);
647
    batch_set($batch);
648 649

    // Create or update all configuration translations for this language.
650
    \Drupal::moduleHandler()->loadInclude('locale', 'bulk.inc');
651 652 653
    if ($batch = locale_config_batch_update_components($options, array($langcode))) {
      batch_set($batch);
    }
654
  }
655 656 657 658
}

/**
 * Implements hook_form_FORM_ID_alter() for language_admin_edit_form().
659
 */
660
function locale_form_language_admin_edit_form_alter(&$form, FormStateInterface $form_state) {
661 662 663 664 665 666
  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(),
    );
667
    $form['actions']['submit']['#submit'][] = 'locale_form_language_admin_edit_form_alter_submit';
668 669 670 671
  }
}

/**
672
 * Form submission handler for language_admin_edit_form().
673
 */
674
function locale_form_language_admin_edit_form_alter_submit($form, FormStateInterface $form_state) {
675
  \Drupal::config('locale.settings')->set('translate_english', intval($form_state->getValue('locale_translate_english')))->save();
676 677 678
}

/**
679 680 681 682
 * Checks whether locale translates to English.
 *
 * @return bool
 *   Returns TRUE if content should be translated to English, FALSE otherwise.
683 684
 */
function locale_translate_english() {
685
  return \Drupal::config('locale.settings')->get('translate_english');
686
}
687 688 689 690 691 692

/**
 * Implements hook_form_FORM_ID_alter() for system_file_system_settings().
 *
 * Add interface translation directory setting to directories configuration.
 */
693
function locale_form_system_file_system_settings_alter(&$form, FormStateInterface $form_state) {
694
  $form['translation_path'] = array(
695 696
    '#type' => 'textfield',
    '#title' => t('Interface translations directory'),
697
    '#default_value' => \Drupal::config('locale.settings')->get('translation.path'),
698
    '#maxlength' => 255,
699
    '#description' => t('A local file system path where interface translation files will be stored.'),
700
    '#required' => TRUE,
701 702 703 704 705 706
    '#after_build' => array('system_check_directory'),
    '#weight' => 10,
  );
  if ($form['file_default_scheme']) {
    $form['file_default_scheme']['#weight'] = 20;
  }
707 708 709 710 711 712 713 714 715 716
  $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.
 */
717
function locale_system_file_system_settings_submit(&$form, FormStateInterface $form_state) {
718
  if ($form['translation_path']['#default_value'] != $form_state->getValue('translation_path')) {
719 720
    locale_translation_clear_status();
  }
721

722
  \Drupal::config('locale.settings')
723
    ->set('translation.path', $form_state->getValue('translation_path'))
724
    ->save();
725
}
726 727

/**
728
 * Implements hook_preprocess_HOOK() for node templates.
729 730
 */
function locale_preprocess_node(&$variables) {
731
  if ($variables['node']->language()->id != LanguageInterface::LANGCODE_NOT_SPECIFIED) {
732
    $language_interface = \Drupal::languageManager()->getCurrentLanguage();
733

734
    $node_language = $variables['node']->language();
735
    if ($node_language->id != $language_interface->id) {
736 737 738
      // If the node language was different from the page language, we should
      // add markup to identify the language. Otherwise the page language is
      // inherited.
739
      $variables['attributes']['lang'] = $node_language->id;
740
      if ($node_language->direction != $language_interface->direction) {
741 742 743
        // If text direction is different form the page's text direction, add
        // direction information as well.
        $dir = array('ltr', 'rtl');
744
        $variables['attributes']['dir'] = $dir[$node_language->direction];
745 746 747 748
      }
    }
  }
}
749

750 751 752 753 754 755 756 757 758 759 760 761 762
/**
 * 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) {
763
      $file->type = $file->timestamp ? LOCALE_TRANSLATION_CURRENT : '';
764 765 766 767 768 769 770 771 772 773 774 775
      $history[$file->project][$file->langcode] = $file;
    }
  }
  return $history;
}

/**
 * Updates the {locale_file} table.
 *
 * @param object $file
 *   Object representing the file just imported.
 *
776
 * @return int
777 778 779
 *   FALSE on failure. Otherwise SAVED_NEW or SAVED_UPDATED.
 */
function locale_translation_update_file_history($file) {
780 781 782 783 784 785 786 787 788 789 790
  $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();
791 792 793
  // 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');
794
  return $status;
795 796 797 798 799 800 801 802
}

/**
 * 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.
803
 * @param array $langcodes
804 805 806 807 808 809 810 811 812 813 814 815 816
 *   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();
}

817 818 819 820 821 822 823
/**
 * Gets the current translation status.
 *
 * @todo What is 'translation status'?
 */
function locale_translation_get_status($projects = NULL, $langcodes = NULL) {
  $result = array();
824
  $status = \Drupal::state()->get('locale.translation_status');
825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846
  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;
}

847 848 849
/**
 * Saves the status of translation sources in static cache.
 *
850 851 852 853 854 855
 * @param string $project
 *   Machine readable project name.
 * @param string $langcode
 *   Language code.
 * @param string $type
 *   Type of data to be stored.
856
 * @param array $data
857
 *   File object also containing timestamp when the translation is last updated.
858
 */
859
function locale_translation_status_save($project, $langcode, $type, $data) {
860 861 862 863
  // Followup issue: http://drupal.org/node/1842362
  // Split status storage per module/language and expire individually. This will
  // improve performance for large sites.

864 865 866 867 868 869 870
  // 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);
871 872 873
    }
  }

874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891
  // 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;