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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

300
  $langcode = $langcode ? $langcode : $language_interface->id;
301

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

330

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

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

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

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

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

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

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

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

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

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

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

      // Clear the translation status.
453
      locale_translation_status_delete_projects($list);
454
    }
455

456 457 458
  }
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

875 876 877 878