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

Dries's avatar
 
Dries committed
3 4
/**
 * @file
5
 * Enables the translation of the user interface to languages other than English.
Dries's avatar
 
Dries committed
6
 *
7 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 129 130 131 132 133 134 135 136 137
const LOCALE_TRANSLATION_OVERWRITE_NON_CUSTOMIZED = 'non_customized';

/**
 * UI option for override of existing translations. Don't override existing
 * translations.
 */
const LOCALE_TRANSLATION_OVERWRITE_NONE = 'none';

/**
 * Translation source is a remote file.
 */
const LOCALE_TRANSLATION_REMOTE = 'remote';

/**
 * Translation source is a local file.
 */
const LOCALE_TRANSLATION_LOCAL = 'local';

/**
 * Translation source is the current translation.
 */
const LOCALE_TRANSLATION_CURRENT = 'current';

/**
 * Translation source is a downloaded file.
 */
const LOCALE_TRANSLATION_DOWNLOADED = 'download';

/**
 * Translation source is an imported file.
 */
const LOCALE_TRANSLATION_IMPORTED = 'import';
138

Dries's avatar
 
Dries committed
139
/**
140
 * Implements hook_help().
Dries's avatar
 
Dries committed
141
 */
142 143
function locale_help($path, $arg) {
  switch ($path) {
144
    case 'admin/help#locale':
145 146
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
147
      $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>';
148 149 150 151 152
      $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>';
153
      $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>';
154
      $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>';
155
      $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>';
156 157
      $output .= '</ul></dd>';
      $output .= '</dl>';
158
      return $output;
159

160
    case 'admin/config/regional/language':
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 <a href="@translate">customized</a>.', array('@update' => url('admin/reports/translations'), '@translate' => url('admin/config/regional/translate'))) . '</p>';
162

163
    case 'admin/config/regional/translate':
164
      $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>';
165
      return $output;
166

167
    case 'admin/config/regional/translate/import':
168
      $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>';
169 170
      $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>';
171
      return $output;
172

173
    case 'admin/config/regional/translate/export':
174
      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
175
  }
Dries's avatar
 
Dries committed
176 177
}

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

Dries's avatar
 
Dries committed
236
  return $items;
Dries's avatar
 
Dries committed
237 238
}

Dries's avatar
 
Dries committed
239
/**
240
 * Implements hook_permission().
Dries's avatar
 
Dries committed
241
 */
242
function locale_permission() {
243
  return array(
244
    'translate interface' => array(
245
      'title' => t('Translate interface texts'),
246
      'restrict access' => TRUE,
247
    ),
248
  );
249 250 251
}

/**
252
 * Implements hook_theme().
253 254 255
 */
function locale_theme() {
  return array(
256 257 258 259
    'locale_translate_edit_form_strings' => array(
      'render element' => 'form',
      'file' => 'locale.pages.inc',
    ),
260 261 262
    'locale_translation_last_check' => array(
      'variables' => array('last' => NULL),
      'file' => 'locale.pages.inc',
263
      'template' => 'locale-translation-last-check',
264 265 266 267
    ),
    'locale_translation_update_info' => array(
      'arguments' => array('updates' => array(), 'not_found' => array()),
      'file' => 'locale.pages.inc',
268
      'template' => 'locale-translation-update-info',
269
    ),
270 271
  );
}
272

273 274 275 276 277 278 279 280 281
/**
 * Implements hook_stream_wrappers().
 */
function locale_stream_wrappers() {
  $wrappers = array(
    'translations' => array(
      'name' => t('Translation files'),
      'class' => 'Drupal\locale\TranslationsStream',
      'description' => t('Translation files'),
282
      'type' => STREAM_WRAPPERS_LOCAL_HIDDEN,
283 284 285 286 287
    ),
  );
  return $wrappers;
}

288
/**
289
 * Implements hook_language_insert().
290
 */
291 292 293
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.
294
  cache('page')->deleteAll();
295
  // Force JavaScript translation file re-creation for the new language.
296
  _locale_invalidate_js($language->langcode);
297 298 299
}

/**
300
 * Implements hook_language_update().
301
 */
302 303 304
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.
305
  cache('page')->deleteAll();
306
  // Force JavaScript translation file re-creation for the modified language.
307
  _locale_invalidate_js($language->langcode);
308 309 310
}

/**
311
 * Implements hook_language_delete().
312
 */
313 314
function locale_language_delete($language) {
  // Remove translations.
315
  Drupal::service('locale.storage')->deleteTranslations(array('language' => $language->langcode));
316

317 318
  // Remove interface translation files.
  module_load_include('inc', 'locale', 'locale.bulk');
319
  locale_translate_delete_translation_files(array(), array($language->langcode));
320

321 322 323
  // Remove translated configuration objects.
  \Drupal\locale\Locale::config()->deleteLanguageTranslations($language->langcode);

324
  // Changing the language settings impacts the interface:
325
  _locale_invalidate_js($language->langcode);
326
  cache('page')->deleteAll();
327

328 329
  // Clear locale translation caches.
  locale_translation_status_delete_languages(array($language->langcode));
330
  cache()->delete('locale:' . $language->langcode);
331 332
}

333 334 335 336 337 338 339 340 341 342 343 344 345 346
/**
 * 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
347

Dries's avatar
 
Dries committed
348
/**
349
 * Returns plural form index for a specific number.
Dries's avatar
 
Dries committed
350
 *
351
 * The index is computed from the formula of this language.
352
 *
353 354 355 356 357
 * @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.
358 359 360 361
 * @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
362
 */
363
function locale_get_plural($count, $langcode = NULL) {
364
  $language_interface = language(Language::TYPE_INTERFACE);
365 366 367 368 369 370

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

372
  $langcode = $langcode ? $langcode : $language_interface->langcode;
373

374 375 376
  if (!isset($plural_indexes[$langcode][$count])) {
    // Retrieve and statically cache the plural formulas for all languages.
    if (empty($plural_formulas)) {
377
      $plural_formulas = Drupal::state()->get('locale.translation.plurals') ?: array();
Dries's avatar
 
Dries committed
378
    }
379 380 381 382 383
    // 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])) {
      // $n is used inside the expression in the eval().
Dries's avatar
 
Dries committed
384
      $n = $count;
385 386 387 388 389 390
      $plural_indexes[$langcode][$count] = @eval('return intval(' . $plural_formulas[$langcode]['formula'] . ');');
    }
    // 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
391
    }
392
    // Otherwise, return -1 (unknown).
Dries's avatar
 
Dries committed
393
    else {
394
      $plural_indexes[$langcode][$count] = -1;
395
    }
Dries's avatar
 
Dries committed
396
  }
397
  return $plural_indexes[$langcode][$count];
398
}
Dries's avatar
 
Dries committed
399

400

401
/**
402 403 404
 * Implements hook_modules_installed().
 */
function locale_modules_installed($modules) {
405 406
  $components['module'] = $modules;
  locale_system_update($components);
407 408
}

409 410 411 412
/**
 * Implements hook_modules_uninstalled().
 */
function locale_modules_uninstalled($modules) {
413 414
  $components['module'] = $modules;
  locale_system_remove($components);
415 416
}

417 418 419 420 421 422 423
/**
 * 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) {
424 425
  $components['theme'] = $themes;
  locale_system_update($components);
426 427
}

428 429 430 431
/**
 * Implements hook_themes_disabled().
 */
function locale_themes_disabled($themes) {
432 433
  $components['theme'] = $themes;
  locale_system_remove($components);
434 435
}

436 437
/**
 * Imports translations when new modules or themes are installed.
438
 *
439 440
 * This function will start a batch to import translations for the added
 * components.
441
 *
442
 * @param array $components
443 444
 *   An array of arrays of component (theme and/or module) names to import
 *   translations for, indexed by type.
445
 */
446 447 448 449 450
function locale_system_update(array $components) {

  $components += array('module' => array(), 'theme' => array());
  $list = array_merge($components['module'], $components['theme']);

451 452 453
  // 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.
454 455 456 457 458 459 460
  if (!drupal_installation_attempted() && locale_translatable_language_list()) {
    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());
461
    if ($list = array_intersect($list, $projects)) {
462 463 464
      module_load_include('fetch.inc', 'locale');
      // Get translation status of the projects, download and update translations.
      $options = _locale_translation_default_update_options();
465 466 467 468 469
      $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)) {
470 471
      batch_set($batch);
    }
472 473 474
  }
}

475 476 477 478 479 480 481 482
/**
 * 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
483 484
 *   An array of arrays of component (theme and/or module) names to import
 *   translations for, indexed by type.
485 486
 */
function locale_system_remove($components) {
487 488 489
  $components += array('module' => array(), 'theme' => array());
  $list = array_merge($components['module'], $components['theme']);
  if ($language_list = locale_translatable_language_list()) {
490
    module_load_include('compare.inc', 'locale');
491 492 493
    Drupal::moduleHandler()->loadInclude('locale', 'bulk.inc');
    // Delete configuration translations.
    \Drupal\locale\Locale::config()->deleteComponentTranslations($components, array_keys($language_list));
494 495 496 497

    // 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());
498 499
    if ($list = array_intersect($list, $projects)) {
      locale_translation_file_history_delete($list);
500 501

      // Remove translation files.
502
      locale_translate_delete_translation_files($list, array());
503 504 505 506 507

      // 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')
508
        ->condition('name', $list)
509 510 511
        ->execute();

      // Clear the translation status.
512
      locale_translation_status_delete_projects($list);
513
    }
514

515 516 517
  }
}

518
/**
519
 * Implements hook_js_alter().
520 521 522 523 524 525
 *
 * 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.
 */
526
function locale_js_alter(&$javascript) {
527

528
  $language_interface = language(Language::TYPE_INTERFACE);
529

530
  $dir = 'public://' . config('local.settings')->get('javascript.directory');
531
  $parsed = Drupal::state()->get('system.javascript_parsed') ?: array();
532 533
  $files = $new_files = FALSE;

534
  foreach ($javascript as $item) {
535
    if (isset($item['type']) && $item['type'] == 'file') {
536 537 538 539 540
      $files = TRUE;
      $filepath = $item['data'];
      if (!in_array($filepath, $parsed)) {
        // Don't parse our own translations files.
        if (substr($filepath, 0, strlen($dir)) != $dir) {
541
          _locale_parse_js_file($filepath);
542 543
          $parsed[] = $filepath;
          $new_files = TRUE;
544 545 546 547 548 549 550 551 552
        }
      }
    }
  }

  // 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) {
553
    $parsed += _locale_invalidate_js();
554 555 556
  }

  // If necessary, rebuild the translation file for the current language.
557
  if (!empty($parsed['refresh:' . $language_interface->langcode])) {
558 559
    // Don't clear the refresh flag on failure, so that another try will
    // be performed later.
560
    if (_locale_rebuild_js()) {
561
      unset($parsed['refresh:' . $language_interface->langcode]);
562 563
    }
    // Store any changes after refresh was attempted.
564
    Drupal::state()->set('system.javascript_parsed', $parsed);
565 566 567
  }
  // 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.
568
  elseif ($new_files) {
569
    Drupal::state()->set('system.javascript_parsed', $parsed);
570 571 572
  }

  // Add the translation JavaScript file to the page.
573
  $locale_javascripts = Drupal::state()->get('translation.javascript') ?: array();
574
  if ($files && !empty($locale_javascripts[$language_interface->langcode])) {
575
    // Add the translation JavaScript file to the page.
576
    $file = $dir . '/' . $language_interface->langcode . '_' . $locale_javascripts[$language_interface->langcode] . '.js';
577
    $javascript[$file] = drupal_js_defaults($file);
578 579 580
  }
}

581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
/**
 * 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'),
606
      array('system', 'drupalSettings'),
607 608 609 610 611 612
    ),
  );

  return $libraries;
}

613
/**
614
 * Implement hook_library_info_alter().
615 616 617
 *
 * Provides the language support for the jQuery UI Date Picker.
 */
618
function locale_library_info_alter(&$libraries, $module) {
619
  if ($module == 'system' && isset($libraries['jquery.ui.datepicker'])) {
620
    $language_interface = language(Language::TYPE_INTERFACE);
621 622 623
    // 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.
624
    $libraries['jquery.ui.datepicker']['dependencies'][] = array('locale', 'drupal.locale.datepicker');
625
    $libraries['jquery.ui.datepicker']['js'][] = array(
626
      'data' => array(
627 628 629
        'jquery' => array(
          'ui' => array(
            'datepicker' => array(
630
              'isRTL' => $language_interface->direction == Language::DIRECTION_RTL,
631
              'firstDay' => config('system.date')->get('first_day'),
632 633
            ),
          ),
634 635 636 637 638 639 640
        ),
      ),
      'type' => 'setting',
    );
  }
}

641
/**
642
 * Implements hook_form_FORM_ID_alter() for language_admin_overview_form().
643
 */
644
function locale_form_language_admin_overview_form_alter(&$form, &$form_state) {
645 646
  $languages = $form['languages']['#languages'];

647
  $total_strings = Drupal::service('locale.storage')->countStrings();
648 649 650 651
  $stats = array_fill_keys(array_keys($languages), array());

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

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

  foreach ($languages as $langcode => $language) {
    $stats[$langcode] += array(
      'translated' => 0,
      'ratio' => 0,
    );
668
    if (!$language->locked && ($langcode != 'en' || locale_translate_english())) {
669
      $form['languages'][$langcode]['locale_statistics'] = array(
670 671 672 673 674 675 676 677 678
        '#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))
        ),
679 680 681 682
      );
    }
    else {
      $form['languages'][$langcode]['locale_statistics'] = array(
683
        '#markup' => t('not applicable'),
684 685
      );
    }
686 687 688 689 690
    // #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;
691 692
  }
}
693 694

/**
695 696 697 698 699 700 701 702
 * 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';
}

/**
703 704 705
 * Form submission handler for language_admin_add_form().
 *
 * Set a batch for a newly-added language.
706 707 708 709 710 711 712 713 714
 */
function locale_form_language_admin_add_form_alter_submit($form, $form_state) {
  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'];
  }

715 716 717 718 719
  // 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);
  batch_set($batch);
720 721 722 723 724 725

  // 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);
  }
726 727 728 729
}

/**
 * Implements hook_form_FORM_ID_alter() for language_admin_edit_form().
730
 */
731
function locale_form_language_admin_edit_form_alter(&$form, &$form_state) {
732 733 734 735 736 737
  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(),
    );
738
    $form['#submit'][] = 'locale_form_language_admin_edit_form_alter_submit';
739 740 741 742
  }
}

/**
743
 * Form submission handler for language_admin_edit_form().
744
 */
745
function locale_form_language_admin_edit_form_alter_submit($form, $form_state) {
746 747 748 749
  variable_set('locale_translate_english', $form_state['values']['locale_translate_english']);
}

/**
750 751 752 753
 * Checks whether locale translates to English.
 *
 * @return bool
 *   Returns TRUE if content should be translated to English, FALSE otherwise.
754 755 756 757
 */
function locale_translate_english() {
  return variable_get('locale_translate_english', FALSE);
}
758 759 760 761 762 763 764

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

  config('locale.settings')
    ->set('translation.path', $form_state['values']['translation_path'])
    ->save();
795
}
796 797

/**
798
 * Implements hook_preprocess_HOOK() for node.html.twig.
799 800
 */
function locale_preprocess_node(&$variables) {
801 802
  if ($variables['node']->langcode != Language::LANGCODE_NOT_SPECIFIED) {
    $language_interface = language(Language::TYPE_INTERFACE);
803

804
    $node_language = language_load($variables['node']->langcode);
805
    if ($node_language->langcode != $language_interface->langcode) {
806 807 808
      // If the node language was different from the page language, we should
      // add markup to identify the language. Otherwise the page language is
      // inherited.
809
      $variables['attributes']['lang'] = $variables['node']->langcode;
810
      if ($node_language->direction != $language_interface->direction) {
811 812 813
        // If text direction is different form the page's text direction, add
        // direction information as well.
        $dir = array('ltr', 'rtl');
814
        $variables['attributes']['dir'] = $dir[$node_language->direction];
815 816 817 818
      }
    }
  }
}
819

820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891
/**
 * 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) {
      $file->type = LOCALE_TRANSLATION_CURRENT;
      $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();
  }
  return drupal_write_record('locale_file', $file, $update);
}

/**
 * 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();
}

/**
 * Saves the status of translation sources in static cache.
 *
 * @param array $data
 *   Array of translation source data, structured by project name and langcode.
 */
function locale_translation_status_save($data) {
  // Followup issue: http://drupal.org/node/1842362
  // Split status storage per module/language and expire individually. This will
  // improve performance for large sites.
892
  $status = Drupal::state()->get('locale.translation_status');
893 894 895 896 897 898 899 900 901
  $status = empty($status) ? array() : $status;

  // Merge the new data into the existing structured status array.
  foreach ($data as $project => $languages) {
    foreach ($languages as $langcode => $source) {
      $status[$project][$langcode] = $source;
    }
  }

902 903
  Drupal::state()->set('locale.translation_status', $status);
  Drupal::state()->set('locale.translation_last_checked', REQUEST_TIME);
904 905 906 907 908 909 910 911 912
}

/**
 * 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) {
913
  if ($status = Drupal::state()->get('locale.translation_status')) {
914 915 916 917 918
    foreach ($status as $project => $languages) {
      foreach ($languages as $langcode => $source) {
        if (in_array($langcode, $langcodes)) {
          unset($status[$project][$langcode]);
        }
919 920
      }
    }
921
    Drupal::state()->set('locale.translation_status', $status);
922 923 924 925 926 927 928 929 930 931
  }
}

/**
 * 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) {
932
  $status = Drupal::state()->get('locale.translation_status');
933 934 935 936 937 938

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

942 943 944 945
/**
 * Clear the translation status cache.
 */
function locale_translation_clear_status() {
946 947
  Drupal::state()->delete('locale.translation_status');
  Drupal::state()->delete('locale.translation_last_checked');
948 949 950 951 952 953 954 955 956 957 958
}

/**
 * Checks whether remote translation sources are used.
 *
 * @return bool
 *   Returns TRUE if remote translations sources should be taken into account
 *   when checking or importing translation files, FALSE otherwise.
 */
function locale_translation_use_remote_source() {
  return config('locale.settings')->get('translation.use_source') == LOCALE_TRANSLATION_USE_SOURCE_REMOTE_AND_LOCAL;
959 960
}

961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978
/**
 * Check that a string is safe to be added or imported as a translation.
 *
 * This test can be used to detect possibly bad translation strings. It should
 * not have any false positives. But it is only a test, not a transformation,
 * as it destroys valid HTML. We cannot reliably filter translation strings
 * on import because some strings are irreversibly corrupted. For example,
 * a &amp; in the translation would get encoded to &amp;amp; by filter_xss()
 * before being put in the database, and thus would be displayed incorrectly.
 *
 * The allowed tag list is like filter_xss_admin(), but omitting div and img as
 * not needed for translation and likely to cause layout issues (div) or a
 * possible attack vector (img).
 */
function locale_string_is_safe($string) {
  return decode_entities($string) == decode_entities(filter_xss($string, array('a', 'abbr', 'acronym', 'address', 'b', 'bdo', 'big', 'blockquote', 'br', 'caption', 'cite', 'code', 'col', 'colgroup', 'dd', 'del', 'dfn', 'dl', 'dt', 'em', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'ins', 'kbd', 'li', 'ol', 'p', 'pre', 'q', 'samp', 'small', 'span', 'strong', 'sub', 'sup', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead', 'tr', 'tt', 'ul', 'var')));
}

979