locale.module 51 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 190 191
    'locale_translation_last_check' => array(
      'variables' => array('last' => NULL),
      'file' => 'locale.pages.inc',
    ),
    'locale_translation_update_info' => array(
192
      'variables' => array('updates' => array(), 'not_found' => array()),
193 194
      'file' => 'locale.pages.inc',
    ),
195 196
  );
}
197

198
/**
199
 * Implements hook_ENTITY_TYPE_insert() for 'configurable_language'.
200
 */
201
function locale_configurable_language_insert(ConfigurableLanguage $language) {
202
  // @todo move these two cache clears out. See http://drupal.org/node/1293252
203 204
  // Changing the language settings impacts the interface: clear render cache.
  \Drupal::cache('render')->deleteAll();
205
  // Force JavaScript translation file re-creation for the new language.
206
  _locale_invalidate_js($language->id());
207 208 209
}

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

/**
221
 * Implements hook_ENTITY_TYPE_delete() for 'configurable_language'.
222
 */
223
function locale_configurable_language_delete(ConfigurableLanguage $language) {
224
  // Remove translations.
225
  \Drupal::service('locale.storage')->deleteTranslations(array('language' => $language->id()));
226

227 228
  // Remove interface translation files.
  module_load_include('inc', 'locale', 'locale.bulk');
229
  locale_translate_delete_translation_files(array(), array($language->id()));
230

231
  // Remove translated configuration objects.
232
  \Drupal\locale\Locale::config()->deleteLanguageTranslations($language->id());
233

234
  // Changing the language settings impacts the interface:
235
  _locale_invalidate_js($language->id());
236
  \Drupal::cache('render')->deleteAll();
237

238
  // Clear locale translation caches.
239 240
  locale_translation_status_delete_languages(array($language->id()));
  \Drupal::cache()->delete('locale:' . $language->id());
241 242
}

243 244 245 246 247 248 249 250
/**
 * 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() {
251
  $languages = \Drupal::languageManager()->getLanguages();
252 253 254 255 256
  if (!locale_translate_english()) {
    unset($languages['en']);
  }
  return $languages;
}
Dries's avatar
 
Dries committed
257

Dries's avatar
 
Dries committed
258
/**
259
 * Returns plural form index for a specific number.
Dries's avatar
 
Dries committed
260
 *
261
 * The index is computed from the formula of this language.
262
 *
263 264 265 266 267
 * @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.
268
 *
269 270 271 272
 * @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
273
 */
274
function locale_get_plural($count, $langcode = NULL) {
275
  $language_interface = \Drupal::languageManager()->getCurrentLanguage();
276 277 278 279 280 281

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

283
  $langcode = $langcode ? $langcode : $language_interface->getId();
284

285 286 287
  if (!isset($plural_indexes[$langcode][$count])) {
    // Retrieve and statically cache the plural formulas for all languages.
    if (empty($plural_formulas)) {
288
      $plural_formulas = \Drupal::state()->get('locale.translation.plurals') ?: array();
Dries's avatar
 
Dries committed
289
    }
290 291 292 293
    // 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])) {
294 295 296 297 298
      // 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'];
299 300 301 302 303
    }
    // 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
304
    }
305
    // Otherwise, return -1 (unknown).
Dries's avatar
 
Dries committed
306
    else {
307
      $plural_indexes[$langcode][$count] = -1;
308
    }
Dries's avatar
 
Dries committed
309
  }
310
  return $plural_indexes[$langcode][$count];
311
}
Dries's avatar
 
Dries committed
312

313

314
/**
315 316 317
 * Implements hook_modules_installed().
 */
function locale_modules_installed($modules) {
318 319
  $components['module'] = $modules;
  locale_system_update($components);
320 321
}

322 323 324 325
/**
 * Implements hook_modules_uninstalled().
 */
function locale_modules_uninstalled($modules) {
326 327
  $components['module'] = $modules;
  locale_system_remove($components);
328 329
}

330
/**
331
 * Implements hook_themes_installed().
332
 */
333
function locale_themes_installed($themes) {
334 335
  $components['theme'] = $themes;
  locale_system_update($components);
336 337
}

338
/**
339
 * Implements hook_themes_uninstalled().
340
 */
341
function locale_themes_uninstalled($themes) {
342 343
  $components['theme'] = $themes;
  locale_system_remove($components);
344 345
}

346 347 348
/**
 * Implements hook_cron().
 *
349
 * @see \Drupal\locale\Plugin\QueueWorker\LocaleTranslation
350 351 352 353
 */
function locale_cron() {
  // Update translations only when an update frequency was set by the admin
  // and a translatable language was set.
354
  // Update tasks are added to the queue here but processed by Drupal's cron.
355
  if ($frequency = \Drupal::config('locale.settings')->get('translation.update_interval_days') && locale_translatable_language_list()) {
356 357 358 359 360
    module_load_include('translation.inc', 'locale');
    locale_cron_fill_queue();
  }
}

361 362
/**
 * Imports translations when new modules or themes are installed.
363
 *
364 365
 * This function will start a batch to import translations for the added
 * components.
366
 *
367
 * @param array $components
368 369
 *   An array of arrays of component (theme and/or module) names to import
 *   translations for, indexed by type.
370
 */
371 372 373 374
function locale_system_update(array $components) {
  $components += array('module' => array(), 'theme' => array());
  $list = array_merge($components['module'], $components['theme']);

375 376 377
  // 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.
378
  if (!drupal_installation_attempted() && locale_translatable_language_list() && \Drupal::config('locale.settings')->get('translation.import_enabled')) {
379 380 381 382 383 384
    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());
385
    if ($list = array_intersect($list, $projects)) {
386
      module_load_include('fetch.inc', 'locale');
387 388
      // Get translation status of the projects, download and update
      // translations.
389
      $options = _locale_translation_default_update_options();
390 391 392
      $batch = locale_translation_batch_update_build($list, array(), $options);
      batch_set($batch);
    }
393
    \Drupal::moduleHandler()->loadInclude('locale', 'bulk.inc');
394
    if ($batch = locale_config_batch_update_components(array(), array(), $components)) {
395 396
      batch_set($batch);
    }
397 398 399
  }
}

400 401 402 403 404 405 406 407
/**
 * 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
408 409
 *   An array of arrays of component (theme and/or module) names to import
 *   translations for, indexed by type.
410 411
 */
function locale_system_remove($components) {
412 413 414
  $components += array('module' => array(), 'theme' => array());
  $list = array_merge($components['module'], $components['theme']);
  if ($language_list = locale_translatable_language_list()) {
415
    module_load_include('compare.inc', 'locale');
416
    \Drupal::moduleHandler()->loadInclude('locale', 'bulk.inc');
417 418
    // Delete configuration translations.
    \Drupal\locale\Locale::config()->deleteComponentTranslations($components, array_keys($language_list));
419 420

    // Only when projects are removed, the translation files and records will be
421 422
    // deleted. Not each disabled module will remove a project, e.g., sub
    // modules.
423
    $projects = array_keys(locale_translation_get_projects());
424 425
    if ($list = array_intersect($list, $projects)) {
      locale_translation_file_history_delete($list);
426 427

      // Remove translation files.
428
      locale_translate_delete_translation_files($list, array());
429 430 431 432

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

      // Clear the translation status.
436
      locale_translation_status_delete_projects($list);
437
    }
438

439 440 441
  }
}

442 443 444 445 446 447 448
/**
 * Implements hook_cache_flush().
 */
function locale_cache_flush() {
  \Drupal::state()->delete('system.javascript_parsed');
}

449
/**
450
 * Implements hook_js_alter().
451
 */
452
function locale_js_alter(&$javascript) {
453 454 455 456 457 458 459 460 461 462
  $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);
  }
}
463

464 465 466 467 468 469 470 471 472 473
/**
 * 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.
474
 *
475
 * @return string|null
476 477 478 479
 *   The filepath to the translation file or NULL if no translation is
 *   applicable.
 */
function locale_js_translate(array $files = array()) {
480
  $language_interface = \Drupal::languageManager()->getCurrentLanguage();
481

482 483
  $dir = 'public://' . \Drupal::config('locale.settings')->get('javascript.directory');
  $parsed = \Drupal::state()->get('system.javascript_parsed') ?: array();
484 485 486 487 488 489 490 491 492
  $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;
493 494 495 496 497 498 499 500
      }
    }
  }

  // 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) {
501
    $parsed += _locale_invalidate_js();
502 503 504
  }

  // If necessary, rebuild the translation file for the current language.
505
  if (!empty($parsed['refresh:' . $language_interface->getId()])) {
506 507
    // Don't clear the refresh flag on failure, so that another try will
    // be performed later.
508
    if (_locale_rebuild_js()) {
509
      unset($parsed['refresh:' . $language_interface->getId()]);
510 511
    }
    // Store any changes after refresh was attempted.
512
    \Drupal::state()->set('system.javascript_parsed', $parsed);
513 514 515
  }
  // 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.
516
  elseif ($new_files) {
517
    \Drupal::state()->set('system.javascript_parsed', $parsed);
518 519 520
  }

  // Add the translation JavaScript file to the page.
521
  $locale_javascripts = \Drupal::state()->get('locale.translation.javascript') ?: array();
522
  $translation_file = NULL;
523
  if (!empty($files) && !empty($locale_javascripts[$language_interface->getId()])) {
524
    // Add the translation JavaScript file to the page.
525
    $translation_file = $dir . '/' . $language_interface->getId() . '_' . $locale_javascripts[$language_interface->getId()] . '.js';
526
  }
527
  return $translation_file;
528 529
}

530
/**
531
 * Implements hook_library_alter().
532 533 534
 *
 * Provides the language support for the jQuery UI Date Picker.
 */
535 536
function locale_library_alter(array &$library, $name) {
  if ($name == 'core/jquery.ui.datepicker') {
537
    // locale.datepicker.js should be added in the JS_LIBRARY group, so that
538
    // the behavior executes early. JS_LIBRARY is the default.
539
    $library['dependencies'][] = 'locale/drupal.locale.datepicker';
540

541
    $language_interface = \Drupal::languageManager()->getCurrentLanguage();
542
    $settings['jquery']['ui']['datepicker'] = array(
543
      'isRTL' => $language_interface->getDirection() == LanguageInterface::DIRECTION_RTL,
544 545 546
      'firstDay' => \Drupal::config('system.date')->get('first_day'),
    );
    $library['js'][] = array(
547
      'type' => 'setting',
548
      'data' => $settings,
549 550 551 552
    );
  }
}

553
/**
554
 * Implements hook_form_FORM_ID_alter() for language_admin_overview_form().
555
 */
556
function locale_form_language_admin_overview_form_alter(&$form, FormStateInterface $form_state) {
557 558
  $languages = $form['languages']['#languages'];

559
  $total_strings = \Drupal::service('locale.storage')->countStrings();
560 561 562 563
  $stats = array_fill_keys(array_keys($languages), array());

  // If we have source strings, count translations and calculate progress.
  if (!empty($total_strings)) {
564
    $translations = \Drupal::service('locale.storage')->countTranslations();
565 566 567 568
    foreach ($translations as $langcode => $translated) {
      $stats[$langcode]['translated'] = $translated;
      if ($translated > 0) {
        $stats[$langcode]['ratio'] = round($translated / $total_strings * 100, 2);
569 570 571 572 573 574 575 576 577 578 579
      }
    }
  }

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

  foreach ($languages as $langcode => $language) {
    $stats[$langcode] += array(
      'translated' => 0,
      'ratio' => 0,
    );
580
    if (!$language->isLocked() && ($langcode != 'en' || locale_translate_english())) {
581
      $form['languages'][$langcode]['locale_statistics'] = array(
582
        '#markup' => \Drupal::l(
583 584 585 586 587
          t('@translated/@total (@ratio%)', array(
            '@translated' => $stats[$langcode]['translated'],
            '@total' => $total_strings,
            '@ratio' => $stats[$langcode]['ratio'],
          )),
588
          new Url('locale.translate_page', array(), array('query' => array('langcode' => $langcode)))
589
        ),
590 591 592 593
      );
    }
    else {
      $form['languages'][$langcode]['locale_statistics'] = array(
594
        '#markup' => t('not applicable'),
595 596
      );
    }
597 598 599 600 601
    // #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;
602 603
  }
}
604 605

/**
606
 * Implements hook_form_FORM_ID_alter() for language_admin_add_form().
607
 */
608
function locale_form_language_admin_add_form_alter(&$form, FormStateInterface $form_state) {
609 610 611 612 613
  $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';
}

/**
614 615 616
 * Form submission handler for language_admin_add_form().
 *
 * Set a batch for a newly-added language.
617
 */
618
function locale_form_language_admin_add_form_alter_submit($form, FormStateInterface $form_state) {
619
  if (\Drupal::config('locale.settings')->get('translation.import_enabled')) {
620 621
    if ($form_state->isValueEmpty('predefined_langcode') || $form_state->getValue('predefined_langcode') == 'custom') {
      $langcode = $form_state->getValue('langcode');
622 623
    }
    else {
624
      $langcode = $form_state->getValue('predefined_langcode');
625
    }
626

627 628 629 630
    // 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);
631
    batch_set($batch);
632 633

    // Create or update all configuration translations for this language.
634
    \Drupal::moduleHandler()->loadInclude('locale', 'bulk.inc');
635 636 637
    if ($batch = locale_config_batch_update_components($options, array($langcode))) {
      batch_set($batch);
    }
638
  }
639 640 641 642
}

/**
 * Implements hook_form_FORM_ID_alter() for language_admin_edit_form().
643
 */
644
function locale_form_language_admin_edit_form_alter(&$form, FormStateInterface $form_state) {
645 646 647 648 649 650
  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(),
    );
651
    $form['actions']['submit']['#submit'][] = 'locale_form_language_admin_edit_form_alter_submit';
652 653 654 655
  }
}

/**
656
 * Form submission handler for language_admin_edit_form().
657
 */
658
function locale_form_language_admin_edit_form_alter_submit($form, FormStateInterface $form_state) {
659
  \Drupal::config('locale.settings')->set('translate_english', intval($form_state->getValue('locale_translate_english')))->save();
660 661 662
}

/**
663 664 665 666
 * Checks whether locale translates to English.
 *
 * @return bool
 *   Returns TRUE if content should be translated to English, FALSE otherwise.
667 668
 */
function locale_translate_english() {
669
  return \Drupal::config('locale.settings')->get('translate_english');
670
}
671 672 673 674 675 676

/**
 * Implements hook_form_FORM_ID_alter() for system_file_system_settings().
 *
 * Add interface translation directory setting to directories configuration.
 */
677
function locale_form_system_file_system_settings_alter(&$form, FormStateInterface $form_state) {
678
  $form['translation_path'] = array(
679 680
    '#type' => 'textfield',
    '#title' => t('Interface translations directory'),
681
    '#default_value' => \Drupal::config('locale.settings')->get('translation.path'),
682
    '#maxlength' => 255,
683
    '#description' => t('A local file system path where interface translation files will be stored.'),
684
    '#required' => TRUE,
685 686 687 688 689 690
    '#after_build' => array('system_check_directory'),
    '#weight' => 10,
  );
  if ($form['file_default_scheme']) {
    $form['file_default_scheme']['#weight'] = 20;
  }
691 692 693 694 695 696 697 698 699 700
  $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.
 */
701
function locale_system_file_system_settings_submit(&$form, FormStateInterface $form_state) {
702
  if ($form['translation_path']['#default_value'] != $form_state->getValue('translation_path')) {
703 704
    locale_translation_clear_status();
  }
705

706
  \Drupal::config('locale.settings')
707
    ->set('translation.path', $form_state->getValue('translation_path'))
708
    ->save();
709
}
710 711

/**
712
 * Implements hook_preprocess_HOOK() for node templates.
713 714
 */
function locale_preprocess_node(&$variables) {
715 716 717 718
  /* @var $node \Drupal\node\NodeInterface */
  $node = $variables['node'];
  if ($node->language()->getId() != LanguageInterface::LANGCODE_NOT_SPECIFIED) {
    $interface_language = \Drupal::languageManager()->getCurrentLanguage();
719

720 721
    $node_language = $node->language();
    if ($node_language->getId() != $interface_language->getId()) {
722 723 724
      // If the node language was different from the page language, we should
      // add markup to identify the language. Otherwise the page language is
      // inherited.
725 726
      $variables['attributes']['lang'] = $node_language->getId();
      if ($node_language->getDirection() != $interface_language->getDirection()) {
727 728
        // If text direction is different form the page's text direction, add
        // direction information as well.
729
        $variables['attributes']['dir'] = $node_language->getDirection();
730 731 732 733
      }
    }
  }
}
734

735 736 737 738 739 740 741 742 743 744 745 746 747
/**
 * 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) {
748
      $file->type = $file->timestamp ? LOCALE_TRANSLATION_CURRENT : '';
749 750 751 752 753 754 755 756 757 758 759 760
      $history[$file->project][$file->langcode] = $file;
    }
  }
  return $history;
}

/**
 * Updates the {locale_file} table.
 *
 * @param object $file
 *   Object representing the file just imported.
 *
761
 * @return int
762 763 764
 *   FALSE on failure. Otherwise SAVED_NEW or SAVED_UPDATED.
 */
function locale_translation_update_file_history($file) {
765 766 767 768 769 770 771 772 773 774 775
  $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();
776 777 778
  // 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');
779
  return $status;
780 781 782 783 784 785 786 787
}

/**
 * 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.
788
 * @param array $langcodes
789 790 791 792 793 794 795 796 797 798 799 800 801
 *   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();
}

802 803 804 805 806 807 808
/**
 * Gets the current translation status.
 *
 * @todo What is 'translation status'?
 */
function locale_translation_get_status($projects = NULL, $langcodes = NULL) {
  $result = array();
809
  $status = \Drupal::state()->get('locale.translation_status');
810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831
  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;
}

832 833 834
/**
 * Saves the status of translation sources in static cache.
 *
835 836 837 838 839 840
 * @param string $project
 *   Machine readable project name.
 * @param string $langcode
 *   Language code.
 * @param string $type
 *   Type of data to be stored.
841
 * @param array $data
842
 *   File object also containing timestamp when the translation is last updated.
843
 */
844
function locale_translation_status_save($project, $langcode, $type, $data) {
845 846 847 848
  // Followup issue: http://drupal.org/node/1842362
  // Split status storage per module/language and expire individually. This will
  // improve performance for large sites.

849 850 851 852 853 854 855
  // 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);
856 857 858
    }
  }

859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876
  // Merge the new status data with the existing status.
  if (isset($status[$project][$langcode])) {
    switch ($type) {
      case LOCALE_TRANSLATION_REMOTE:
      case LOCALE_TRANSLATION_LOCAL:
        // Add the source data to the status array.
        $status[$project][$langcode]->files[$type] = $data;

        // Check if this translation is the most recent one. Set timestamp and
        // data type of the most recent translation source.
        if (isset($data->timestamp) && $data->timestamp) {
          if ($data->timestamp > $status[$project][$langcode]->timestamp) {
            $status[$project][$langcode]->timestamp = $data->timestamp;
            $status[$project][$langcode]->last_checked = REQUEST_TIME;
            $status[$project][$langcode]->type = $type;
          }
        }
        break;
877

878 879 880 881 882 883 884 885 886
      case LOCALE_TRANSLATION_CURRENT:
        $data->last_checked = REQUEST_TIME;
        $status[$project][$langcode]->timestamp = $data->timestamp;
        $status[$project][$langcode]->last_checked = $data->last_checked;
        $status[$project][$langcode]->type = $type;
        locale_translation_update_file_history($data);
        break;
    }

887 888
    \Drupal::state()->set('locale.translation_status', $status);
    \Drupal::state()->set('locale.translation_last_checked', REQUEST_TIME);
889
  }
890 891 892 893 894 895 896 897 898
}

/**
 * Delete language entries from the status cache.
 *
 * @param array $langcodes
 *   Language code(s) to be deleted from the cache.
 */
function locale_translation_status_delete_languages($langcodes) {
899
  if ($status = locale_translation_get_status()) {
900 901 902 903 904
    foreach ($status as $project => $languages) {
      foreach ($languages as $langcode => $source) {
        if (in_array($langcode, $langcodes)) {
          unset($status[$project][$langcode]);
        }
905 906
      }
    }
907
    \Drupal::state()->set('locale.translation_status', $status);
908 909 910 911 912 913 914 915 916 917
  }
}

/**
 * Delete project entries from the status cache.
 *
 * @param array $projects
 *   Project name(s) to be deleted from the cache.
 */
function locale_translation_status_delete_projects($projects) {
918
  $status = locale_translation_get_status();
919 920 921 922 923 924

  foreach ($status as $project => $languages) {
    if (in_array($project, $projects)) {
      unset($status[$project]);
    }
  }
925
  \Drupal::state()->set('locale.translation_status', $status);
926 927
}

928 929 930 931
/**
 * Clear the translation status cache.
 */
function locale_translation_clear_status() {
932 933
  \Drupal::state()->delete('locale.translation_status');
  \Drupal::state()->delete('locale.translation_last_checked');
934 935 936 937 938 939 940 941