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

Dries's avatar
 
Dries committed
3 4
/**
 * @file
5
 * Enables the translation of the user interface to languages other than English.
Dries's avatar
 
Dries committed
6
 *
7 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\locale\LocaleLookup;
14
use Drupal\locale\LocaleConfigSubscriber;
15 16
use Drupal\locale\SourceString;
use Drupal\locale\StringDatabaseStorage;
17
use Drupal\locale\TranslationsStream;
18
use Drupal\Core\Database\Database;
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 67 68 69 70
/**
 * 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;

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

/**
97 98 99 100 101 102 103 104 105 106 107 108
 * 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.
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 138 139 140 141
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';
142

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

164
    case 'admin/config/regional/language':
165
      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>';
166

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

171
    case 'admin/config/regional/translate/import':
172 173
      $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>';
      $output .= '<p>' . t('For situations where translations need to be manually imported, this page imports the translated strings contained in a Gettext Portable Object (.po) file, which can be downloaded from the <a href="@url">Drupal translation server</a>. Alternatively, a .po file may need to be imported after offline editing in a Gettext translation editor. Importing an individual .po file may be a lengthy process.', array('@url' => 'http://localize.drupal.org')) . '</p>';
174
      return $output;
175

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

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

Dries's avatar
 
Dries committed
242
  return $items;
Dries's avatar
 
Dries committed
243 244
}

Dries's avatar
 
Dries committed
245
/**
246
 * Implements hook_permission().
Dries's avatar
 
Dries committed
247
 */
248
function locale_permission() {
249
  return array(
250
    'translate interface' => array(
251
      'title' => t('Translate interface texts'),
252
      'restrict access' => TRUE,
253
    ),
254
  );
255 256 257
}

/**
258
 * Implements hook_theme().
259 260 261
 */
function locale_theme() {
  return array(
262 263 264 265
    'locale_translate_edit_form_strings' => array(
      'render element' => 'form',
      'file' => 'locale.pages.inc',
    ),
266 267
  );
}
268

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

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

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

/**
307
 * Implements hook_language_delete().
308
 */
309 310
function locale_language_delete($language) {
  // Remove translations.
311
  locale_storage()->deleteTranslations(array('language' => $language->langcode));
312

313 314
  // Remove interface translation files.
  module_load_include('inc', 'locale', 'locale.bulk');
315
  locale_translate_delete_translation_files(array(), array($language->langcode));
316 317

  // Changing the language settings impacts the interface:
318
  _locale_invalidate_js($language->langcode);
319
  cache('page')->deleteAll();
320

321 322
  // Clear locale translation caches.
  locale_translation_status_delete_languages(array($language->langcode));
323
  cache()->delete('locale:' . $language->langcode);
324 325
}

326 327 328 329 330 331 332 333 334 335 336 337 338 339
/**
 * 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
340

Dries's avatar
 
Dries committed
341
/**
342
 * Provides interface translation services.
Dries's avatar
 
Dries committed
343 344
 *
 * This function is called from t() to translate a string if needed.
345 346 347
 *
 * @param $string
 *   A string to look up translation for. If omitted, all the
348
 *   cached strings will be returned in all languages already
349
 *   used on the page.
350 351
 * @param $context
 *   The context of this string.
352 353
 * @param $langcode
 *   Language code to use for the lookup.
Dries's avatar
 
Dries committed
354
 */
355
function locale($string = NULL, $context = NULL, $langcode = NULL) {
356
  $language_interface = language(LANGUAGE_TYPE_INTERFACE);
357 358 359 360

  // Use the advanced drupal_static() pattern, since this is called very often.
  static $drupal_static_fast;
  if (!isset($drupal_static_fast)) {
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
    $drupal_static_fast['locale'] = &drupal_static(__FUNCTION__, array('cache' => array(), 'exists' => NULL));
  }
  $locale_t = &$drupal_static_fast['locale']['cache'];
  $locale_exists = &$drupal_static_fast['locale']['exists'];

  // Check whether Locale module is actually installed and operational.
  // The mere existence of locale() does not imply that Locale module is
  // actually enabled and its database tables are installed. Since PHP code
  // cannot be unloaded, this is typically the case in the environment that
  // is executing a test.
  if (!isset($locale_exists)) {
    $locale_exists = function_exists('module_exists') && module_exists('locale');
  }
  if (!$locale_exists) {
    return $string;
376
  }
377

378
  if (!isset($string)) {
379
    // Return all cached strings if no string was specified
380 381 382
    return $locale_t;
  }

383
  $langcode = isset($langcode) ? $langcode : $language_interface->langcode;
384

385 386 387
  // Strings are cached by langcode, context and roles, using instances of the
  // LocaleLookup class to handle string lookup and caching.
  if (!isset($locale_t[$langcode][$context]) && isset($language_interface)) {
388
    $locale_t[$langcode][$context] = new LocaleLookup($langcode, $context, locale_storage());
Dries's avatar
 
Dries committed
389
  }
390
  return ($locale_t[$langcode][$context][$string] === TRUE ? $string : $locale_t[$langcode][$context][$string]);
Dries's avatar
 
Dries committed
391
}
Dries's avatar
 
Dries committed
392

393 394 395 396 397 398 399
/**
 * Reset static variables used by locale().
 */
function locale_reset() {
  drupal_static_reset('locale');
}

400 401 402 403 404 405 406 407 408 409 410 411 412 413
/**
 * Gets the locale storage controller class .
 *
 * @return Drupal\locale\StringStorageInterface
 */
function locale_storage() {
  $storage = &drupal_static(__FUNCTION__);
  if (!isset($storage)) {
    $options = array('target' => 'default');
    $storage = new StringDatabaseStorage(Database::getConnection($options['target']), $options);
  }
  return $storage;
}

Dries's avatar
 
Dries committed
414
/**
415
 * Returns plural form index for a specific number.
Dries's avatar
 
Dries committed
416
 *
417
 * The index is computed from the formula of this language.
418
 *
419 420 421 422 423
 * @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.
424 425 426 427
 * @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
428
 */
429
function locale_get_plural($count, $langcode = NULL) {
430
  $language_interface = language(LANGUAGE_TYPE_INTERFACE);
431 432 433 434 435 436

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

438
  $langcode = $langcode ? $langcode : $language_interface->langcode;
439

440 441 442 443
  if (!isset($plural_indexes[$langcode][$count])) {
    // Retrieve and statically cache the plural formulas for all languages.
    if (empty($plural_formulas)) {
      $plural_formulas = variable_get('locale_translation_plurals', array());
Dries's avatar
 
Dries committed
444
    }
445 446 447 448 449
    // 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
450
      $n = $count;
451 452 453 454 455 456
      $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
457
    }
458
    // Otherwise, return -1 (unknown).
Dries's avatar
 
Dries committed
459
    else {
460
      $plural_indexes[$langcode][$count] = -1;
461
    }
Dries's avatar
 
Dries committed
462
  }
463
  return $plural_indexes[$langcode][$count];
464
}
Dries's avatar
 
Dries committed
465

466

467
/**
468 469 470 471 472 473
 * Implements hook_modules_installed().
 */
function locale_modules_installed($modules) {
  locale_system_update($modules);
}

474 475 476 477 478 479 480
/**
 * Implements hook_modules_uninstalled().
 */
function locale_modules_uninstalled($modules) {
  locale_system_remove($modules);
}

481 482 483 484 485 486 487 488 489 490
/**
 * 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) {
  locale_system_update($themes);
}

491 492 493 494 495 496 497
/**
 * Implements hook_themes_disabled().
 */
function locale_themes_disabled($themes) {
  locale_system_remove($themes);
}

498 499
/**
 * Imports translations when new modules or themes are installed.
500
 *
501 502
 * This function will start a batch to import translations for the added
 * components.
503
 *
504
 * @param array $components
505 506 507 508
 *   An array of component (theme and/or module) names to import
 *   translations for.
 */
function locale_system_update($components) {
509 510 511
  // 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.
512 513 514 515 516 517 518 519 520 521 522 523
  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());
    if ($components = array_intersect($components, $projects)) {
      module_load_include('fetch.inc', 'locale');
      // Get translation status of the projects, download and update translations.
      $options = _locale_translation_default_update_options();
      $batch = locale_translation_batch_update_build($components, array(), $options);
524 525
      batch_set($batch);
    }
526 527 528
  }
}

529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
/**
 * 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
 *   An array of component (theme and/or module) names to remove
 *   translation history.
 */
function locale_system_remove($components) {
  if (locale_translatable_language_list()) {
    module_load_include('compare.inc', 'locale');

    // 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());
    if ($components = array_intersect($components, $projects)) {
      locale_translation_file_history_delete($components);

      // Remove translation files.
      module_load_include('inc', 'locale', 'locale.bulk');
      locale_translate_delete_translation_files($components, array());

      // 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')
        ->condition('name', $components)
        ->execute();

      // Clear the translation status.
      locale_translation_status_delete_projects($components);
    }
  }
}


568
/**
569
 * Implements hook_js_alter().
570 571 572 573 574 575
 *
 * 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.
 */
576
function locale_js_alter(&$javascript) {
577
  $language_interface = language(LANGUAGE_TYPE_INTERFACE);
578

579
  $dir = 'public://' . variable_get('locale_js_directory', 'languages');
580
  $parsed = state()->get('system.javascript_parsed') ?: array();
581 582
  $files = $new_files = FALSE;

583
  foreach ($javascript as $item) {
584
    if (isset($item['type']) && $item['type'] == 'file') {
585 586 587 588 589
      $files = TRUE;
      $filepath = $item['data'];
      if (!in_array($filepath, $parsed)) {
        // Don't parse our own translations files.
        if (substr($filepath, 0, strlen($dir)) != $dir) {
590
          _locale_parse_js_file($filepath);
591 592
          $parsed[] = $filepath;
          $new_files = TRUE;
593 594 595 596 597 598 599 600 601
        }
      }
    }
  }

  // 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) {
602
    $parsed += _locale_invalidate_js();
603 604 605
  }

  // If necessary, rebuild the translation file for the current language.
606
  if (!empty($parsed['refresh:' . $language_interface->langcode])) {
607 608
    // Don't clear the refresh flag on failure, so that another try will
    // be performed later.
609
    if (_locale_rebuild_js()) {
610
      unset($parsed['refresh:' . $language_interface->langcode]);
611 612
    }
    // Store any changes after refresh was attempted.
613
    state()->set('system.javascript_parsed', $parsed);
614 615 616
  }
  // 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.
617
  elseif ($new_files) {
618
    state()->set('system.javascript_parsed', $parsed);
619 620 621
  }

  // Add the translation JavaScript file to the page.
622
  $locale_javascripts = variable_get('locale_translation_javascript', array());
623
  if ($files && !empty($locale_javascripts[$language_interface->langcode])) {
624
    // Add the translation JavaScript file to the page.
625
    $file = $dir . '/' . $language_interface->langcode . '_' . $locale_javascripts[$language_interface->langcode] . '.js';
626
    $javascript[$file] = drupal_js_defaults($file);
627 628 629
  }
}

630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654
/**
 * 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'),
655
      array('system', 'drupalSettings'),
656 657 658 659 660 661
    ),
  );

  return $libraries;
}

662
/**
663
 * Implement hook_library_info_alter().
664 665 666
 *
 * Provides the language support for the jQuery UI Date Picker.
 */
667
function locale_library_info_alter(&$libraries, $module) {
668
  if ($module == 'system' && isset($libraries['jquery.ui.datepicker'])) {
669
    $language_interface = language(LANGUAGE_TYPE_INTERFACE);
670 671 672
    // 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.
673
    $libraries['jquery.ui.datepicker']['dependencies'][] = array('locale', 'drupal.locale.datepicker');
674
    $libraries['jquery.ui.datepicker']['js'][] = array(
675
      'data' => array(
676 677 678 679
        'jquery' => array(
          'ui' => array(
            'datepicker' => array(
              'isRTL' => $language_interface->direction == LANGUAGE_RTL,
680
              'firstDay' => config('system.date')->get('first_day'),
681 682
            ),
          ),
683 684 685 686 687 688 689
        ),
      ),
      'type' => 'setting',
    );
  }
}

690
/**
691
 * Implements hook_form_FORM_ID_alter() for language_admin_overview_form().
692
 */
693
function locale_form_language_admin_overview_form_alter(&$form, &$form_state) {
694 695
  $languages = $form['languages']['#languages'];

696
  $total_strings = locale_storage()->countStrings();
697 698 699 700
  $stats = array_fill_keys(array_keys($languages), array());

  // If we have source strings, count translations and calculate progress.
  if (!empty($total_strings)) {
701 702 703 704 705
    $translations = locale_storage()->countTranslations();
    foreach ($translations as $langcode => $translated) {
      $stats[$langcode]['translated'] = $translated;
      if ($translated > 0) {
        $stats[$langcode]['ratio'] = round($translated / $total_strings * 100, 2);
706 707 708 709 710 711 712 713 714 715 716
      }
    }
  }

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

  foreach ($languages as $langcode => $language) {
    $stats[$langcode] += array(
      'translated' => 0,
      'ratio' => 0,
    );
717
    if (!$language->locked && ($langcode != 'en' || locale_translate_english())) {
718
      $form['languages'][$langcode]['locale_statistics'] = array(
719 720 721 722 723 724 725 726 727
        '#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))
        ),
728 729 730 731
      );
    }
    else {
      $form['languages'][$langcode]['locale_statistics'] = array(
732
        '#markup' => t('not applicable'),
733 734 735 736
      );
    }
  }
}
737 738

/**
739 740 741 742 743 744 745 746
 * 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';
}

/**
747 748 749
 * Form submission handler for language_admin_add_form().
 *
 * Set a batch for a newly-added language.
750 751 752 753 754 755 756 757 758
 */
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'];
  }

759 760 761 762 763
  // 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);
764 765 766 767
}

/**
 * Implements hook_form_FORM_ID_alter() for language_admin_edit_form().
768
 */
769
function locale_form_language_admin_edit_form_alter(&$form, &$form_state) {
770 771 772 773 774 775
  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(),
    );
776
    $form['#submit'][] = 'locale_form_language_admin_edit_form_alter_submit';
777 778 779 780
  }
}

/**
781
 * Form submission handler for language_admin_edit_form().
782
 */
783
function locale_form_language_admin_edit_form_alter_submit($form, $form_state) {
784 785 786 787
  variable_set('locale_translate_english', $form_state['values']['locale_translate_english']);
}

/**
788 789 790 791
 * Checks whether locale translates to English.
 *
 * @return bool
 *   Returns TRUE if content should be translated to English, FALSE otherwise.
792 793 794 795
 */
function locale_translate_english() {
  return variable_get('locale_translate_english', FALSE);
}
796 797 798 799 800 801 802 803 804 805 806 807

/**
 * 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) {
  $form['locale_translate_file_directory'] = array(
    '#type' => 'textfield',
    '#title' => t('Interface translations directory'),
    '#default_value' => variable_get('locale_translate_file_directory', conf_path() . '/files/translations'),
    '#maxlength' => 255,
808
    '#description' => t('A local file system path where interface translation files will be stored.'),
809 810 811 812 813 814
    '#after_build' => array('system_check_directory'),
    '#weight' => 10,
  );
  if ($form['file_default_scheme']) {
    $form['file_default_scheme']['#weight'] = 20;
  }
815 816 817 818 819 820 821 822 823 824 825 826 827 828
  $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) {
  if ($form['locale_translate_file_directory']['#default_value'] != $form_state['values']['locale_translate_file_directory']) {
    locale_translation_clear_status();
  }
829
}
830 831

/**
832
 * Implements hook_preprocess_HOOK() for node.tpl.php.
833 834
 */
function locale_preprocess_node(&$variables) {
835
  if ($variables['node']->langcode != LANGUAGE_NOT_SPECIFIED) {
836
    $language_interface = language(LANGUAGE_TYPE_INTERFACE);
837

838
    $node_language = language_load($variables['node']->langcode);
839
    if ($node_language->langcode != $language_interface->langcode) {
840 841 842
      // If the node language was different from the page language, we should
      // add markup to identify the language. Otherwise the page language is
      // inherited.
843
      $variables['attributes']['lang'] = $variables['node']->langcode;
844
      if ($node_language->direction != $language_interface->direction) {
845 846 847
        // If text direction is different form the page's text direction, add
        // direction information as well.
        $dir = array('ltr', 'rtl');
848
        $variables['attributes']['dir'] = $dir[$node_language->direction];
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 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 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 933 934 935 936 937 938 939 940 941 942 943 944 945 946
/**
 * 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.
  $status = state()->get('locale.translation_status');
  $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;
    }
  }

  state()->set('locale.translation_status', $status);
  state()->set('locale.translation_last_checked', REQUEST_TIME);
}

/**
 * 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) {
947 948 949 950 951 952
  if ($status = state()->get('locale.translation_status')) {
    foreach ($status as $project => $languages) {
      foreach ($languages as $langcode => $source) {
        if (in_array($langcode, $langcodes)) {
          unset($status[$project][$langcode]);
        }
953 954
      }
    }
955
    state()->set('locale.translation_status', $status);
956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975
  }
}

/**
 * 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) {
  $status = state()->get('locale.translation_status');

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

976 977 978 979
/**
 * Clear the translation status cache.
 */
function locale_translation_clear_status() {
980 981 982 983 984 985 986 987 988 989 990 991 992
  state()->delete('locale.translation_status');
  state()->delete('locale.translation_last_checked');
}

/**
 * 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;
993 994
}

995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
/**
 * 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')));
}

1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
/**
 * Refresh related information after string translations have been updated.
 *
 * The information that will be refreshed includes:
 * - JavaScript translations.
 * - Locale cache.
 *
 * @param array $langcodes
 *   Language codes for updated translations.
 * @param array $lids
 *   List of string identifiers that have been updated / created.
 */
function _locale_refresh_translations($langcodes, $lids) {
  if ($lids && $langcodes) {
    // Update javascript translations if any of the strings has a javascript location.
    if ($strings = locale_storage()->getStrings(array('lid' => $lids, 'type' => 'javascript'))) {
      array_map('_locale_invalidate_js', $langcodes);
    }
  }
  // Clear locale cache.
1033
  cache()->deleteTags(array('locale' => TRUE));
1034 1035
}

1036 1037 1038
/**
 * Parses a JavaScript file, extracts strings wrapped in Drupal.t() and
 * Drupal.formatPlural() and inserts them into the database.
1039 1040 1041 1042 1043 1044
 *
 * @param string $filepath
 *   File name to parse.
 *
 * @return array
 *   Array of string objects to update indexed by context and source.
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115