locale.module 53.9 KB
Newer Older
Dries's avatar
 
Dries committed
1
<?php
Dries's avatar
 
Dries committed
2

Dries's avatar
 
Dries committed
3 4
/**
 * @file
5
 * Enables the translation of the user interface to languages other than English.
Dries's avatar
 
Dries committed
6
 *
7 8 9 10
 * When enabled, multiple languages can be set up. The site interface can be
 * displayed in different languages, and nodes can have languages assigned. The
 * setup of languages and translations is completely web based. Gettext portable
 * object files are supported.
Dries's avatar
 
Dries committed
11 12
 */

13
use Drupal\Core\Language\Language;
14
use Drupal\Component\Utility\Crypt;
15

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

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

/**
93 94 95 96 97 98 99 100 101 102 103 104
 * 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.
105
 */
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
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
129
/**
130
 * Implements hook_help().
Dries's avatar
 
Dries committed
131
 */
132 133
function locale_help($path, $arg) {
  switch ($path) {
134
    case 'admin/help#locale':
135 136
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
137
      $output .= '<p>' . t('The Locale module allows your Drupal site to be presented in languages other than the default English, and to be multilingual. The Locale module works by maintaining a database of translations, and examining text as it is about to be displayed. When a translation of the text is available in the language to be displayed, the translation is displayed rather than the original text. When a translation is unavailable, the original text is displayed, and then stored for review by a translator. For more information, see the online handbook entry for <a href="@locale">Locale module</a>.', array('@locale' => 'http://drupal.org/documentation/modules/locale/')) . '</p>';
138 139 140 141 142
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Translating interface text') . '</dt>';
      $output .= '<dd>' . t('Translations of text in the Drupal interface may be provided by:');
      $output .= '<ul>';
143
      $output .= '<li>' . t('<a href="@update">Automatic import</a> of translations when you add a language or enable a module or theme. These translations are obtained from the <a href="@url">Drupal translation server</a>. Although Drupal modules and themes may not be fully translated in all languages, new translations become available frequently. Interface translation updates can be downloaded and installed automatically at <a href="@config">regular intervals</a>.', array('@url' => 'http://localize.drupal.org', '@update' => url('admin/reports/translations'), '@config' => url('admin/config/regional/translate/settings'))) . '</li>';
144
      $output .= '<li>' . t("Translating within your site, using the Locale module's integrated <a href='@translate'>translation interface</a>.", array('@translate' => url('admin/config/regional/translate'))) . '</li>';
145
      $output .= '<li>' . t("If an existing translations do not meet your needs, the interface translations files in Gettext Portable Object (<em>.po</em>) format may be modified, or new <em>.po</em> files may be created, using a desktop Gettext editor. The Locale module's <a href='@import'>manual import</a> feature allows the translated strings from a new or modified <em>.po</em> file to be added to your site. The Locale module's <a href='@export'>export</a> feature generates files from your site's translated strings, that can either be shared with others or edited offline by a Gettext translation editor.", array('@import' => url('admin/config/regional/translate/import'), '@export' => url('admin/config/regional/translate/export'))) . '</li>';
146 147
      $output .= '</ul></dd>';
      $output .= '</dl>';
148
      return $output;
149

150
    case 'admin/config/regional/language':
151
      return '<p>' . t('Interface translations are automatically imported when a language is added, or when new modules or themes are enabled. The report, <a href="@update">Available translation updates</a>, shows the status. Interface text can be <a href="@translate">customized</a>.', array('@update' => url('admin/reports/translations'), '@translate' => url('admin/config/regional/translate'))) . '</p>';
152

153
    case 'admin/config/regional/translate':
154
      $output = '<p>' . t('This page allows a translator to search for specific translated and untranslated strings, and is used when creating or editing translations. (Note: Because translation tasks involves many strings, it may be more convenient to <a href="@export">export</a> strings for offline editing in a desktop Gettext translation editor). Searches may be limited to strings in a specific language.', array('@export' => url('admin/config/regional/translate/export'))) . '</p>';
155
      return $output;
156

157
    case 'admin/config/regional/translate/import':
158
      $output = '<p>' . t('Translation files are automatically downloaded and imported when <a href="@language">languages</a> are added, or when modules or themes are enabled.', array('@language' => url('admin/config/regional/language'))). '</p>';
159 160
      $output .= '<p>' . t('This page allows translators to manually import translated strings contained in a Gettext Portable Object (.po) file. Manual import may be used for customized translations or for the translation of custom modules and themes. To customize translations you can download a translation file from the <a href="@url">Drupal translation server</a> or <a href="@export">export</a> translations from the site, customize the translations using a Gettext translation editor, and import the result using this page.', array('@url' => 'http://localize.drupal.org', '@export' => url('admin/config/regional/translate/export'))) . '</p>';
      $output .= '<p>' . t('Note that importing large .po files may take several minutes.') . '</p>';
161
      return $output;
162

163
    case 'admin/config/regional/translate/export':
164
      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
165
  }
Dries's avatar
 
Dries committed
166 167
}

Dries's avatar
 
Dries committed
168
/**
169
 * Implements hook_menu().
Dries's avatar
 
Dries committed
170
 */
171
function locale_menu() {
172
  // Translation functionality.
173
  $items['admin/config/regional/translate'] = array(
174 175
    'title' => 'User interface translation',
    'description' => 'Translate the built-in user interface.',
176
    'page callback' => 'locale_translate_page',
177
    'access arguments' => array('translate interface'),
178
    'file' => 'locale.pages.inc',
179
    'weight' => -5,
180
  );
181
  $items['admin/config/regional/translate/translate'] = array(
182
    'title' => 'Translate',
183
    'type' => MENU_DEFAULT_LOCAL_TASK,
184
  );
185
  $items['admin/config/regional/translate/import'] = array(
186
    'title' => 'Import',
187 188
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_translate_import_form'),
189
    'access arguments' => array('translate interface'),
190 191
    'weight' => 20,
    'type' => MENU_LOCAL_TASK,
192
    'file' => 'locale.bulk.inc',
193
  );
194
  $items['admin/config/regional/translate/export'] = array(
195
    'title' => 'Export',
196 197
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_translate_export_form'),
198
    'access arguments' => array('translate interface'),
199 200
    'weight' => 30,
    'type' => MENU_LOCAL_TASK,
201
    'file' => 'locale.bulk.inc',
202
  );
203 204
  $items['admin/config/regional/translate/settings'] = array(
    'title' => 'Settings',
205
    'route_name' => 'locale_settings',
206
    'access arguments' => array('translate interface'),
207
    'weight' => 100,
208 209
    'type' => MENU_LOCAL_TASK,
  );
210 211 212
  $items['admin/reports/translations'] = array(
    'title' => 'Available translation updates',
    'description' => 'Get a status report about available interface translations for your installed modules and themes.',
213 214
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_translation_status_form'),
215 216 217
    'access arguments' => array('translate interface'),
    'file' => 'locale.pages.inc',
  );
Dries's avatar
 
Dries committed
218

Dries's avatar
 
Dries committed
219
  return $items;
Dries's avatar
 
Dries committed
220 221
}

Dries's avatar
 
Dries committed
222
/**
223
 * Implements hook_permission().
Dries's avatar
 
Dries committed
224
 */
225
function locale_permission() {
226
  return array(
227
    'translate interface' => array(
228
      'title' => t('Translate interface texts'),
229
      'restrict access' => TRUE,
230
    ),
231
  );
232 233 234
}

/**
235
 * Implements hook_theme().
236 237 238
 */
function locale_theme() {
  return array(
239 240 241 242
    'locale_translate_edit_form_strings' => array(
      'render element' => 'form',
      'file' => 'locale.pages.inc',
    ),
243 244 245
    'locale_translation_last_check' => array(
      'variables' => array('last' => NULL),
      'file' => 'locale.pages.inc',
246
      'template' => 'locale-translation-last-check',
247 248 249 250
    ),
    'locale_translation_update_info' => array(
      'arguments' => array('updates' => array(), 'not_found' => array()),
      'file' => 'locale.pages.inc',
251
      'template' => 'locale-translation-update-info',
252
    ),
253 254
  );
}
255

256 257 258 259 260 261 262 263 264
/**
 * Implements hook_stream_wrappers().
 */
function locale_stream_wrappers() {
  $wrappers = array(
    'translations' => array(
      'name' => t('Translation files'),
      'class' => 'Drupal\locale\TranslationsStream',
      'description' => t('Translation files'),
265
      'type' => STREAM_WRAPPERS_LOCAL_HIDDEN,
266 267 268 269 270
    ),
  );
  return $wrappers;
}

271
/**
272
 * Implements hook_language_insert().
273
 */
274 275 276
function locale_language_insert($language) {
  // @todo move these two cache clears out. See http://drupal.org/node/1293252
  // Changing the language settings impacts the interface.
277
  cache('page')->deleteAll();
278
  // Force JavaScript translation file re-creation for the new language.
279
  _locale_invalidate_js($language->id);
280 281 282
}

/**
283
 * Implements hook_language_update().
284
 */
285 286 287
function locale_language_update($language) {
  // @todo move these two cache clears out. See http://drupal.org/node/1293252
  // Changing the language settings impacts the interface.
288
  cache('page')->deleteAll();
289
  // Force JavaScript translation file re-creation for the modified language.
290
  _locale_invalidate_js($language->id);
291 292 293
}

/**
294
 * Implements hook_language_delete().
295
 */
296 297
function locale_language_delete($language) {
  // Remove translations.
298
  Drupal::service('locale.storage')->deleteTranslations(array('language' => $language->id));
299

300 301
  // Remove interface translation files.
  module_load_include('inc', 'locale', 'locale.bulk');
302
  locale_translate_delete_translation_files(array(), array($language->id));
303

304
  // Remove translated configuration objects.
305
  \Drupal\locale\Locale::config()->deleteLanguageTranslations($language->id);
306

307
  // Changing the language settings impacts the interface:
308
  _locale_invalidate_js($language->id);
309
  cache('page')->deleteAll();
310

311
  // Clear locale translation caches.
312 313
  locale_translation_status_delete_languages(array($language->id));
  cache()->delete('locale:' . $language->id);
314 315
}

316 317 318 319 320 321 322 323 324 325 326 327 328 329
/**
 * Returns list of translatable languages.
 *
 * @return array
 *   Array of installed languages keyed by language name. English is omitted
 *   unless it is marked as translatable.
 */
function locale_translatable_language_list() {
  $languages = language_list();
  if (!locale_translate_english()) {
    unset($languages['en']);
  }
  return $languages;
}
Dries's avatar
 
Dries committed
330

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

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

355
  $langcode = $langcode ? $langcode : $language_interface->id;
356

357 358 359
  if (!isset($plural_indexes[$langcode][$count])) {
    // Retrieve and statically cache the plural formulas for all languages.
    if (empty($plural_formulas)) {
360
      $plural_formulas = Drupal::state()->get('locale.translation.plurals') ?: array();
Dries's avatar
 
Dries committed
361
    }
362 363 364 365
    // 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])) {
366 367 368 369 370 371
      // 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'];

372 373 374 375 376
    }
    // 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
377
    }
378
    // Otherwise, return -1 (unknown).
Dries's avatar
 
Dries committed
379
    else {
380
      $plural_indexes[$langcode][$count] = -1;
381
    }
Dries's avatar
 
Dries committed
382
  }
383
  return $plural_indexes[$langcode][$count];
384
}
Dries's avatar
 
Dries committed
385

386

387
/**
388 389 390
 * Implements hook_modules_installed().
 */
function locale_modules_installed($modules) {
391 392
  $components['module'] = $modules;
  locale_system_update($components);
393 394
}

395 396 397 398
/**
 * Implements hook_modules_uninstalled().
 */
function locale_modules_uninstalled($modules) {
399 400
  $components['module'] = $modules;
  locale_system_remove($components);
401 402
}

403 404 405 406 407 408 409
/**
 * Implements hook_themes_enabled().
 *
 * @todo This is technically wrong. We must not import upon enabling, but upon
 *   initial installation. The theme system is missing an installation hook.
 */
function locale_themes_enabled($themes) {
410 411
  $components['theme'] = $themes;
  locale_system_update($components);
412 413
}

414 415 416 417
/**
 * Implements hook_themes_disabled().
 */
function locale_themes_disabled($themes) {
418 419
  $components['theme'] = $themes;
  locale_system_remove($components);
420 421
}

422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
/**
 * Implements hook_cron().
 *
 * @see drupal_cron_run()
 * @see locale_queue_info()
 */
function locale_cron() {
  // Update translations only when an update frequency was set by the admin
  // and a translatable language was set.
  // Update tasks are added to the queue here but processed by Drupal's cron
  // using the cron worker defined in locale_queue_info().
  if ($frequency = config('locale.settings')->get('translation.update_interval_days') && locale_translatable_language_list()) {
    module_load_include('translation.inc', 'locale');
    locale_cron_fill_queue();
  }
}

/**
 * Implements hook_queue_info().
 */
function locale_queue_info() {
  $queues['locale_translation'] = array(
    'title' => t('Update translations'),
    'worker callback' => 'locale_translation_worker',
    'cron' => array(
      'time' => 30,
    ),
  );
  return $queues;
}

/**
 * Callback: Executes interface translation queue tasks.
 *
 * The translation update functions executed here are batch operations which
 * are also used in translation update batches. The batch functions may need to
 * be executed multiple times to complete their task, typically this is the
 * translation import function. When a batch function is not finished, a new
 * queue task is created and added to the end of the queue. The batch context
 * data is needed to continue the batch task is stored in the queue with the
 * queue data.
 *
 * @param array $data
 * Queue data array containing:
 *   - Function name.
 *   - Array of function arguments. Optionally contains the batch context data.
 *
 * @see locale_queue_info()
 */
function locale_translation_worker($data) {
  module_load_include('batch.inc', 'locale');
  list($function, $args) = $data;

  // We execute batch operation functions here to check, download and import the
  // translation files. Batch functions use a context variable as last argument
  // which is passed by reference. When a batch operation is called for the
  // first time a default batch context is created. When called iterative
  // (usually the batch import function) the batch context is passed through via
  // the queue and is part of the $data.
  $last = count($args) - 1;
  if (!is_array($args[$last]) || !isset($args[$last]['finished'])) {
    $batch_context = array(
      'sandbox'  => array(),
      'results'  => array(),
      'finished' => 1,
      'message'  => '',
    );
  }
  else {
    $batch_context = $args[$last];
    unset ($args[$last]);
  }
  $args = array_merge($args, array(&$batch_context));

  // Call the batch operation function.
  call_user_func_array($function, $args);

  // If the batch operation is not finished we create a new queue task to
  // continue the task. This is typically the translation import task.
  if ($batch_context['finished'] < 1) {
    unset($batch_context['strings']);
    $queue = Drupal::queue('locale_translation', TRUE);
    $queue->createItem(array($function, $args));
  }
}

508 509
/**
 * Imports translations when new modules or themes are installed.
510
 *
511 512
 * This function will start a batch to import translations for the added
 * components.
513
 *
514
 * @param array $components
515 516
 *   An array of arrays of component (theme and/or module) names to import
 *   translations for, indexed by type.
517
 */
518 519 520 521
function locale_system_update(array $components) {
  $components += array('module' => array(), 'theme' => array());
  $list = array_merge($components['module'], $components['theme']);

522 523 524
  // 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.
525
  if (!drupal_installation_attempted() && locale_translatable_language_list() && config('locale.settings')->get('translation.import_enabled')) {
526 527 528 529 530 531
    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());
532
    if ($list = array_intersect($list, $projects)) {
533 534 535
      module_load_include('fetch.inc', 'locale');
      // Get translation status of the projects, download and update translations.
      $options = _locale_translation_default_update_options();
536 537 538 539 540
      $batch = locale_translation_batch_update_build($list, array(), $options);
      batch_set($batch);
    }
    Drupal::moduleHandler()->loadInclude('locale', 'bulk.inc');
    if ($batch = locale_config_batch_update_components(array(), array(), $components)) {
541 542
      batch_set($batch);
    }
543 544 545
  }
}

546 547 548 549 550 551 552 553
/**
 * 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
554 555
 *   An array of arrays of component (theme and/or module) names to import
 *   translations for, indexed by type.
556 557
 */
function locale_system_remove($components) {
558 559 560
  $components += array('module' => array(), 'theme' => array());
  $list = array_merge($components['module'], $components['theme']);
  if ($language_list = locale_translatable_language_list()) {
561
    module_load_include('compare.inc', 'locale');
562 563 564
    Drupal::moduleHandler()->loadInclude('locale', 'bulk.inc');
    // Delete configuration translations.
    \Drupal\locale\Locale::config()->deleteComponentTranslations($components, array_keys($language_list));
565 566 567 568

    // Only when projects are removed, the translation files and records will be
    // deleted. Not each disabled module will remove a project. E.g. sub modules.
    $projects = array_keys(locale_translation_get_projects());
569 570
    if ($list = array_intersect($list, $projects)) {
      locale_translation_file_history_delete($list);
571 572

      // Remove translation files.
573
      locale_translate_delete_translation_files($list, array());
574 575 576 577 578

      // Remove translatable projects.
      // Followup issue http://drupal.org/node/1842362 to replace the
      // {locale_project} table. Then change this to a function call.
      db_delete('locale_project')
579
        ->condition('name', $list)
580 581 582
        ->execute();

      // Clear the translation status.
583
      locale_translation_status_delete_projects($list);
584
    }
585

586 587 588
  }
}

589
/**
590
 * Implements hook_js_alter().
591 592 593 594 595 596
 *
 * This function checks all JavaScript files currently added via drupal_add_js()
 * and invokes parsing if they have not yet been parsed for Drupal.t()
 * and Drupal.formatPlural() calls. Also refreshes the JavaScript translation
 * file if necessary, and adds it to the page.
 */
597
function locale_js_alter(&$javascript) {
598

599
  $language_interface = language(Language::TYPE_INTERFACE);
600

601
  $dir = 'public://' . config('local.settings')->get('javascript.directory');
602
  $parsed = Drupal::state()->get('system.javascript_parsed') ?: array();
603 604
  $files = $new_files = FALSE;

605
  foreach ($javascript as $item) {
606
    if (isset($item['type']) && $item['type'] == 'file') {
607 608 609 610 611
      $files = TRUE;
      $filepath = $item['data'];
      if (!in_array($filepath, $parsed)) {
        // Don't parse our own translations files.
        if (substr($filepath, 0, strlen($dir)) != $dir) {
612
          _locale_parse_js_file($filepath);
613 614
          $parsed[] = $filepath;
          $new_files = TRUE;
615 616 617 618 619 620 621 622 623
        }
      }
    }
  }

  // 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) {
624
    $parsed += _locale_invalidate_js();
625 626 627
  }

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

  // Add the translation JavaScript file to the page.
644
  $locale_javascripts = Drupal::state()->get('translation.javascript') ?: array();
645
  if ($files && !empty($locale_javascripts[$language_interface->id])) {
646
    // Add the translation JavaScript file to the page.
647
    $file = $dir . '/' . $language_interface->id . '_' . $locale_javascripts[$language_interface->id] . '.js';
648
    $javascript[$file] = drupal_js_defaults($file);
649 650 651
  }
}

652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676
/**
 * Implements hook_library_info().
 */
function locale_library_info() {
  $libraries['drupal.locale.admin'] = array(
    'title' => 'Locale',
    'version' => VERSION,
    'js' => array(
      drupal_get_path('module', 'locale') . '/locale.admin.js' => array(),
    ),
    'dependencies' => array(
      array('system', 'jquery'),
      array('system', 'drupal'),
      array('system', 'jquery.once'),
    ),
  );
  $libraries['drupal.locale.datepicker'] = array(
    'title' => 'Locale Datepicker UI',
    'version' => VERSION,
    'js' => array(
      drupal_get_path('module', 'locale') . '/locale.datepicker.js' => array(),
    ),
    'dependencies' => array(
      array('system', 'jquery'),
      array('system', 'drupal'),
677
      array('system', 'drupalSettings'),
678 679 680 681 682 683
    ),
  );

  return $libraries;
}

684
/**
685
 * Implement hook_library_info_alter().
686 687 688
 *
 * Provides the language support for the jQuery UI Date Picker.
 */
689
function locale_library_info_alter(&$libraries, $module) {
690
  if ($module == 'system' && isset($libraries['jquery.ui.datepicker'])) {
691
    $language_interface = language(Language::TYPE_INTERFACE);
692 693 694
    // locale.datepicker.js should be added in the JS_LIBRARY group, so that
    // this attach behavior will execute early. JS_LIBRARY is the default for
    // hook_library_info_alter(), thus does not have to be specified explicitly.
695
    $libraries['jquery.ui.datepicker']['dependencies'][] = array('locale', 'drupal.locale.datepicker');
696
    $libraries['jquery.ui.datepicker']['js'][] = array(
697
      'data' => array(
698 699 700
        'jquery' => array(
          'ui' => array(
            'datepicker' => array(
701
              'isRTL' => $language_interface->direction == Language::DIRECTION_RTL,
702
              'firstDay' => config('system.date')->get('first_day'),
703 704
            ),
          ),
705 706 707 708 709 710 711
        ),
      ),
      'type' => 'setting',
    );
  }
}

712
/**
713
 * Implements hook_form_FORM_ID_alter() for language_admin_overview_form().
714
 */
715
function locale_form_language_admin_overview_form_alter(&$form, &$form_state) {
716 717
  $languages = $form['languages']['#languages'];

718
  $total_strings = Drupal::service('locale.storage')->countStrings();
719 720 721 722
  $stats = array_fill_keys(array_keys($languages), array());

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

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

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

/**
766 767 768 769 770 771 772 773
 * Implements hook_form_FORM_ID_alter() for language_admin_add_form(().
 */
function locale_form_language_admin_add_form_alter(&$form, &$form_state) {
  $form['predefined_submit']['#submit'][] = 'locale_form_language_admin_add_form_alter_submit';
  $form['custom_language']['submit']['#submit'][] = 'locale_form_language_admin_add_form_alter_submit';
}

/**
774 775 776
 * Form submission handler for language_admin_add_form().
 *
 * Set a batch for a newly-added language.
777 778
 */
function locale_form_language_admin_add_form_alter_submit($form, $form_state) {
779 780 781 782 783 784 785
  if (config('locale.settings')->get('translation.import_enabled')) {
    if (empty($form_state['values']['predefined_langcode']) || $form_state['values']['predefined_langcode'] == 'custom') {
      $langcode = $form_state['values']['langcode'];
    }
    else {
      $langcode = $form_state['values']['predefined_langcode'];
    }
786

787 788 789 790
    // 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);
791
    batch_set($batch);
792 793 794 795 796 797

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

/**
 * Implements hook_form_FORM_ID_alter() for language_admin_edit_form().
803
 */
804
function locale_form_language_admin_edit_form_alter(&$form, &$form_state) {
805 806 807 808 809 810
  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(),
    );
811
    $form['#submit'][] = 'locale_form_language_admin_edit_form_alter_submit';
812 813 814 815
  }
}

/**
816
 * Form submission handler for language_admin_edit_form().
817
 */
818
function locale_form_language_admin_edit_form_alter_submit($form, $form_state) {
819 820 821 822
  variable_set('locale_translate_english', $form_state['values']['locale_translate_english']);
}

/**
823 824 825 826
 * Checks whether locale translates to English.
 *
 * @return bool
 *   Returns TRUE if content should be translated to English, FALSE otherwise.
827 828 829 830
 */
function locale_translate_english() {
  return variable_get('locale_translate_english', FALSE);
}
831 832 833 834 835 836 837

/**
 * Implements hook_form_FORM_ID_alter() for system_file_system_settings().
 *
 * Add interface translation directory setting to directories configuration.
 */
function locale_form_system_file_system_settings_alter(&$form, $form_state) {
838
  $form['translation_path'] = array(
839 840
    '#type' => 'textfield',
    '#title' => t('Interface translations directory'),
841
    '#default_value' => config('locale.settings')->get('translation.path'),
842
    '#maxlength' => 255,
843
    '#description' => t('A local file system path where interface translation files will be stored.'),
844
    '#required' => TRUE,
845 846 847 848 849 850
    '#after_build' => array('system_check_directory'),
    '#weight' => 10,
  );
  if ($form['file_default_scheme']) {
    $form['file_default_scheme']['#weight'] = 20;
  }
851 852 853 854 855 856 857 858 859 860 861
  $form['#submit'][] = 'locale_system_file_system_settings_submit';
}

/**
 * Submit handler for the file system settings form.
 *
 * Clears the translation status when the Interface translations directory
 * changes. Without a translations directory local po files in the directory
 * should be ignored. The old translation status is no longer valid.
 */
function locale_system_file_system_settings_submit(&$form, $form_state) {
862
  if ($form['translation_path']['#default_value'] != $form_state['values']['translation_path']) {
863 864
    locale_translation_clear_status();
  }
865 866 867 868

  config('locale.settings')
    ->set('translation.path', $form_state['values']['translation_path'])
    ->save();
869
}
870 871

/**
872
 * Implements hook_preprocess_HOOK() for node.html.twig.
873 874
 */
function locale_preprocess_node(&$variables) {
875 876
  if ($variables['node']->langcode != Language::LANGCODE_NOT_SPECIFIED) {
    $language_interface = language(Language::TYPE_INTERFACE);
877

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

894 895 896 897 898 899 900 901 902 903 904 905 906
/**
 * 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) {
907
      $file->type = $file->timestamp ? LOCALE_TRANSLATION_CURRENT : '';
908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932
      $history[$file->project][$file->langcode] = $file;
    }
  }
  return $history;
}

/**
 * Updates the {locale_file} table.
 *
 * @param object $file
 *   Object representing the file just imported.
 *
 * @return integer
 *   FALSE on failure. Otherwise SAVED_NEW or SAVED_UPDATED.
 *
 * @see drupal_write_record()
 */
function locale_translation_update_file_history($file) {
  // Update or write new record.
  if (db_query("SELECT project FROM {locale_file} WHERE project = :project AND langcode = :langcode", array(':project' => $file->project, ':langcode' => $file->langcode))->fetchField()) {
    $update = array('project', 'langcode');
  }
  else {
    $update = array();
  }
933 934 935 936 937
  $result = drupal_write_record('locale_file', $file, $update);
  // The file history has changed, flush the static cache now.
  // @todo Can we make this more fine grained?
  drupal_static_reset('locale_translation_get_file_history');
  return $result;
938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959
}

/**
 * Deletes the history of downloaded translations.
 *
 * @param array $projects
 *   Project name(s) to be deleted from the file history. If both project(s) and
 *   language code(s) are specified the conditions will be ANDed.
 * @param array $langcode
 *   Language code(s) to be deleted from the file history.
 */
function locale_translation_file_history_delete($projects = array(), $langcodes = array()) {
  $query = db_delete('locale_file');
  if (!empty($projects)) {
    $query->condition('project', $projects);
  }
  if (!empty($langcodes)) {
    $query->condition('langcode', $langcodes);
  }
  $query->execute();
}

960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989
/**
 * Gets the current translation status.
 *
 * @todo What is 'translation status'?
 */
function locale_translation_get_status($projects = NULL, $langcodes = NULL) {
  $result = array();
  $status = Drupal::state()->get('locale.translation_status');
  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;
}

990 991 992
/**
 * Saves the status of translation sources in static cache.
 *