locale.module 41.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 97 98 99 100 101 102 103 104
/**
 * 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';

/**
 * Default file name of translation files stored in the local file system.
 *
 * The file name containing placeholders which are also used by the server
 * pattern. See locale_translation_build_server_pattern() for supported
 * placeholders.
 */
const LOCALE_TRANSLATION_DEFAULT_FILENAME = '%project-%version.%language.po';

Dries's avatar
 
Dries committed
105
/**
106
 * Implements hook_help().
Dries's avatar
 
Dries committed
107
 */
108 109
function locale_help($path, $arg) {
  switch ($path) {
110
    case 'admin/help#locale':
111 112
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
113
      $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>';
114 115 116 117 118 119
      $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>';
      $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>';
120
      $output .= '<li>' . t('Importing files from a set of existing translations, known as a translation package. A translation package enables the display of a specific version of Drupal in a specific language, and contains files in the Gettext Portable Object (<em>.po</em>) format. Although not all languages are available for every version of Drupal, translation packages for many languages are available for download from the <a href="@translations">Drupal translations page</a>.', array('@translations' => 'http://localize.drupal.org')) . '</li>';
121 122 123
      $output .= '<li>' . t("If an existing translation package does not meet your needs, the Gettext Portable Object (<em>.po</em>) files within a package may be modified, or new <em>.po</em> files may be created, using a desktop Gettext editor. The Locale module's <a href='@import'>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>';
      $output .= '</ul></dd>';
      $output .= '</dl>';
124
      return $output;
125

126
    case 'admin/config/regional/language':
127
      return '<p>' . t('Interface text can be <a href="@translate">translated</a>. <a href="@translations">Download contributed translations</a> from Drupal.org.', array('@translations' => 'http://localize.drupal.org/download', '@translate' => url('admin/config/regional/translate'))) . '</p>';
128

129
    case 'admin/config/regional/translate':
130
      $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: For translation tasks involving 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>';
131
      return $output;
132

133
    case 'admin/config/regional/translate/import':
134
      $output = '<p>' . t('This page imports the translated strings contained in an individual Gettext Portable Object (<em>.po</em>) file. Normally distributed as part of a translation package (each translation package may contain several <em>.po</em> files), a <em>.po</em> file may need to be imported after offline editing in a Gettext translation editor. Importing an individual <em>.po</em> file may be a lengthy process.') . '</p>';
135
      $output .= '<p>' . t('Note that the <em>.po</em> files within a translation package are imported automatically (if available) when new modules or themes are enabled, or as new languages are added. Since this page only allows the import of one <em>.po</em> file at a time, it may be simpler to download and extract a translation package into your Drupal installation directory and <a href="@language-add">add the language</a> (which automatically imports all <em>.po</em> files within the package). Translation packages are available for download on the <a href="@translations">Drupal translation page</a>.', array('@language-add' => url('admin/config/regional/language/add'), '@translations' => 'http://localize.drupal.org')) . '</p>';
136
      return $output;
137

138
    case 'admin/config/regional/translate/export':
139
      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
140
  }
Dries's avatar
 
Dries committed
141 142
}

Dries's avatar
 
Dries committed
143
/**
144
 * Implements hook_menu().
Dries's avatar
 
Dries committed
145
 */
146
function locale_menu() {
147
  // Translation functionality.
148
  $items['admin/config/regional/translate'] = array(
149 150
    'title' => 'User interface translation',
    'description' => 'Translate the built-in user interface.',
151
    'page callback' => 'locale_translate_page',
152
    'access arguments' => array('translate interface'),
153
    'file' => 'locale.pages.inc',
154
    'weight' => -5,
155
  );
156
  $items['admin/config/regional/translate/translate'] = array(
157
    'title' => 'Translate',
158 159
    'weight' => -10,
    'type' => MENU_DEFAULT_LOCAL_TASK,
160
  );
161
  $items['admin/config/regional/translate/import'] = array(
162
    'title' => 'Import',
163 164
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_translate_import_form'),
165
    'access arguments' => array('translate interface'),
166 167
    'weight' => 20,
    'type' => MENU_LOCAL_TASK,
168
    'file' => 'locale.bulk.inc',
169
  );
170
  $items['admin/config/regional/translate/export'] = array(
171
    'title' => 'Export',
172 173
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_translate_export_form'),
174
    'access arguments' => array('translate interface'),
175 176
    'weight' => 30,
    'type' => MENU_LOCAL_TASK,
177
    'file' => 'locale.bulk.inc',
178
  );
179 180 181 182 183 184 185 186 187 188 189 190 191 192
  $items['admin/reports/translations'] = array(
    'title' => 'Available translation updates',
    'description' => 'Get a status report about available interface translations for your installed modules and themes.',
    'page callback' => 'locale_translation_status',
    '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
193

Dries's avatar
 
Dries committed
194
  return $items;
Dries's avatar
 
Dries committed
195 196
}

Dries's avatar
 
Dries committed
197
/**
198
 * Implements hook_permission().
Dries's avatar
 
Dries committed
199
 */
200
function locale_permission() {
201
  return array(
202
    'translate interface' => array(
203
      'title' => t('Translate interface texts'),
204
      'restrict access' => TRUE,
205
    ),
206
  );
207 208 209
}

/**
210
 * Implements hook_theme().
211 212 213
 */
function locale_theme() {
  return array(
214 215 216 217
    'locale_translate_edit_form_strings' => array(
      'render element' => 'form',
      'file' => 'locale.pages.inc',
    ),
218 219
  );
}
220

221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
/**
 * Implements hook_stream_wrappers().
 */
function locale_stream_wrappers() {
  $wrappers = array(
    'translations' => array(
      'name' => t('Translation files'),
      'class' => 'Drupal\locale\TranslationsStream',
      'description' => t('Translation files'),
      'type' => STREAM_WRAPPERS_LOCAL_NORMAL,
    ),
  );
  return $wrappers;
}

236
/**
237
 * Implements hook_language_insert().
238
 */
239 240 241
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.
242
  cache('page')->deleteAll();
243
  // Force JavaScript translation file re-creation for the new language.
244
  _locale_invalidate_js($language->langcode);
245 246 247
}

/**
248
 * Implements hook_language_update().
249
 */
250 251 252
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.
253
  cache('page')->deleteAll();
254
  // Force JavaScript translation file re-creation for the modified language.
255
  _locale_invalidate_js($language->langcode);
256 257 258
}

/**
259
 * Implements hook_language_delete().
260
 */
261 262
function locale_language_delete($language) {
  // Remove translations.
263
  locale_storage()->deleteTranslations(array('language' => $language->langcode));
264

265 266 267 268
  // Remove interface translation files.
  module_load_include('inc', 'locale', 'locale.bulk');
  locale_translate_delete_translation_files($language->langcode);

269
  _locale_invalidate_js($language->langcode);
270 271

  // Changing the language settings impacts the interface:
272
  cache('page')->deleteAll();
273 274

  // Clearing all locale cache from database
275
  cache()->delete('locale:' . $language->langcode);
276 277
}

278 279 280 281 282 283 284 285 286 287 288 289 290 291
/**
 * 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
292

Dries's avatar
 
Dries committed
293
/**
294
 * Provides interface translation services.
Dries's avatar
 
Dries committed
295 296
 *
 * This function is called from t() to translate a string if needed.
297 298 299
 *
 * @param $string
 *   A string to look up translation for. If omitted, all the
300
 *   cached strings will be returned in all languages already
301
 *   used on the page.
302 303
 * @param $context
 *   The context of this string.
304 305
 * @param $langcode
 *   Language code to use for the lookup.
Dries's avatar
 
Dries committed
306
 */
307
function locale($string = NULL, $context = NULL, $langcode = NULL) {
308
  $language_interface = language(LANGUAGE_TYPE_INTERFACE);
309 310 311 312

  // Use the advanced drupal_static() pattern, since this is called very often.
  static $drupal_static_fast;
  if (!isset($drupal_static_fast)) {
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
    $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;
328
  }
329

330
  if (!isset($string)) {
331
    // Return all cached strings if no string was specified
332 333 334
    return $locale_t;
  }

335
  $langcode = isset($langcode) ? $langcode : $language_interface->langcode;
336

337 338 339
  // 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)) {
340
    $locale_t[$langcode][$context] = new LocaleLookup($langcode, $context, locale_storage());
Dries's avatar
 
Dries committed
341
  }
342
  return ($locale_t[$langcode][$context][$string] === TRUE ? $string : $locale_t[$langcode][$context][$string]);
Dries's avatar
 
Dries committed
343
}
Dries's avatar
 
Dries committed
344

345 346 347 348 349 350 351
/**
 * Reset static variables used by locale().
 */
function locale_reset() {
  drupal_static_reset('locale');
}

352 353 354 355 356 357 358 359 360 361 362 363 364 365
/**
 * 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
366
/**
367
 * Returns plural form index for a specific number.
Dries's avatar
 
Dries committed
368
 *
369
 * The index is computed from the formula of this language.
370
 *
371 372 373 374 375
 * @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.
376 377 378 379
 * @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
380
 */
381
function locale_get_plural($count, $langcode = NULL) {
382
  $language_interface = language(LANGUAGE_TYPE_INTERFACE);
383 384 385 386 387 388

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

390
  $langcode = $langcode ? $langcode : $language_interface->langcode;
391

392 393 394 395
  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
396
    }
397 398 399 400 401
    // 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
402
      $n = $count;
403 404 405 406 407 408
      $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
409
    }
410
    // Otherwise, return -1 (unknown).
Dries's avatar
 
Dries committed
411
    else {
412
      $plural_indexes[$langcode][$count] = -1;
413
    }
Dries's avatar
 
Dries committed
414
  }
415
  return $plural_indexes[$langcode][$count];
416
}
Dries's avatar
 
Dries committed
417

418

419
/**
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
 * Implements hook_modules_installed().
 */
function locale_modules_installed($modules) {
  locale_system_update($modules);
}

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

/**
 * Imports translations when new modules or themes are installed.
438 439 440 441 442 443 444
 *
 * This function will either import translation for the component change
 * right away, or start a batch if more files need to be imported.
 *
 * @param $components
 *   An array of component (theme and/or module) names to import
 *   translations for.
445 446 447 448 449 450
 *
 * @todo
 *   This currently imports all .po files available, independent of
 *   $components. Once we integrated with update status for project
 *   identification, we should revisit and only import files for the
 *   identified projects for the components.
451 452
 */
function locale_system_update($components) {
453 454 455 456 457 458 459 460
  // 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.
  if (!drupal_installation_attempted()) {
    include_once drupal_get_path('module', 'locale') . '/locale.bulk.inc';
    if ($batch = locale_translate_batch_import_files(array(), TRUE)) {
      batch_set($batch);
    }
461 462 463
  }
}

464
/**
465
 * Implements hook_js_alter().
466 467 468 469 470 471
 *
 * 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.
 */
472
function locale_js_alter(&$javascript) {
473
  $language_interface = language(LANGUAGE_TYPE_INTERFACE);
474

475
  $dir = 'public://' . variable_get('locale_js_directory', 'languages');
476
  $parsed = state()->get('system.javascript_parsed') ?: array();
477 478
  $files = $new_files = FALSE;

479
  foreach ($javascript as $item) {
480
    if (isset($item['type']) && $item['type'] == 'file') {
481 482 483 484 485
      $files = TRUE;
      $filepath = $item['data'];
      if (!in_array($filepath, $parsed)) {
        // Don't parse our own translations files.
        if (substr($filepath, 0, strlen($dir)) != $dir) {
486
          _locale_parse_js_file($filepath);
487 488
          $parsed[] = $filepath;
          $new_files = TRUE;
489 490 491 492 493 494 495 496 497
        }
      }
    }
  }

  // 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) {
498
    $parsed += _locale_invalidate_js();
499 500 501
  }

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

  // Add the translation JavaScript file to the page.
518
  $locale_javascripts = variable_get('locale_translation_javascript', array());
519
  if ($files && !empty($locale_javascripts[$language_interface->langcode])) {
520
    // Add the translation JavaScript file to the page.
521
    $file = $dir . '/' . $language_interface->langcode . '_' . $locale_javascripts[$language_interface->langcode] . '.js';
522
    $javascript[$file] = drupal_js_defaults($file);
523 524 525
  }
}

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
/**
 * 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'),
551
      array('system', 'drupalSettings'),
552 553 554 555 556 557
    ),
  );

  return $libraries;
}

558
/**
559
 * Implement hook_library_info_alter().
560 561 562
 *
 * Provides the language support for the jQuery UI Date Picker.
 */
563
function locale_library_info_alter(&$libraries, $module) {
564
  if ($module == 'system' && isset($libraries['jquery.ui.datepicker'])) {
565
    $language_interface = language(LANGUAGE_TYPE_INTERFACE);
566 567 568
    // 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.
569
    $libraries['jquery.ui.datepicker']['dependencies'][] = array('locale', 'drupal.locale.datepicker');
570
    $libraries['jquery.ui.datepicker']['js'][] = array(
571
      'data' => array(
572 573 574 575
        'jquery' => array(
          'ui' => array(
            'datepicker' => array(
              'isRTL' => $language_interface->direction == LANGUAGE_RTL,
576
              'firstDay' => config('system.date')->get('first_day'),
577 578
            ),
          ),
579 580 581 582 583 584 585
        ),
      ),
      'type' => 'setting',
    );
  }
}

586
/**
587
 * Implements hook_form_FORM_ID_alter() for language_admin_overview_form().
588
 */
589
function locale_form_language_admin_overview_form_alter(&$form, &$form_state) {
590 591
  $languages = $form['languages']['#languages'];

592
  $total_strings = locale_storage()->countStrings();
593 594 595 596
  $stats = array_fill_keys(array_keys($languages), array());

  // If we have source strings, count translations and calculate progress.
  if (!empty($total_strings)) {
597 598 599 600 601
    $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);
602 603 604 605 606 607 608 609 610 611 612
      }
    }
  }

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

  foreach ($languages as $langcode => $language) {
    $stats[$langcode] += array(
      'translated' => 0,
      'ratio' => 0,
    );
613
    if (!$language->locked && ($langcode != 'en' || locale_translate_english())) {
614
      $form['languages'][$langcode]['locale_statistics'] = array(
615 616 617 618 619 620 621 622 623
        '#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))
        ),
624 625 626 627
      );
    }
    else {
      $form['languages'][$langcode]['locale_statistics'] = array(
628
        '#markup' => t('not applicable'),
629 630 631 632
      );
    }
  }
}
633 634

/**
635 636 637 638 639 640 641 642
 * 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';
}

/**
643 644 645
 * Form submission handler for language_admin_add_form().
 *
 * Set a batch for a newly-added language.
646 647 648 649 650 651 652 653 654 655
 */
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'];
  }

  include_once drupal_get_path('module', 'locale') . '/locale.bulk.inc';
656
  locale_translate_add_language_set_batch(array('langcode' => $langcode));
657 658 659 660
}

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

/**
674
 * Form submission handler for language_admin_edit_form().
675
 */
676
function locale_form_language_admin_edit_form_alter_submit($form, $form_state) {
677 678 679 680
  variable_set('locale_translate_english', $form_state['values']['locale_translate_english']);
}

/**
681 682 683 684
 * Checks whether locale translates to English.
 *
 * @return bool
 *   Returns TRUE if content should be translated to English, FALSE otherwise.
685 686 687 688
 */
function locale_translate_english() {
  return variable_get('locale_translate_english', FALSE);
}
689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707

/**
 * 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,
    '#description' => t('A local file system path where interface translation files are looked for. This directory must exist.'),
    '#after_build' => array('system_check_directory'),
    '#weight' => 10,
  );
  if ($form['file_default_scheme']) {
    $form['file_default_scheme']['#weight'] = 20;
  }
708 709 710 711 712 713 714 715 716 717 718 719 720 721
  $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();
  }
722
}
723 724

/**
725
 * Implements hook_preprocess_HOOK() for node.tpl.php.
726 727
 */
function locale_preprocess_node(&$variables) {
728
  if ($variables['node']->langcode != LANGUAGE_NOT_SPECIFIED) {
729
    $language_interface = language(LANGUAGE_TYPE_INTERFACE);
730

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

747 748 749 750 751 752 753 754
/**
 * Clear the translation status cache.
 */
function locale_translation_clear_status() {
  state()->delete('locale_translation_status');
  state()->delete('locale_translation_status_last_update');
}

755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772
/**
 * 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')));
}

773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792
/**
 * 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.
793
  cache()->deleteTags(array('locale' => TRUE));
794 795
}

796 797 798
/**
 * Parses a JavaScript file, extracts strings wrapped in Drupal.t() and
 * Drupal.formatPlural() and inserts them into the database.
799 800 801 802 803 804
 *
 * @param string $filepath
 *   File name to parse.
 *
 * @return array
 *   Array of string objects to update indexed by context and source.
805 806 807 808 809 810 811 812 813 814 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
 */
function _locale_parse_js_file($filepath) {
  // The file path might contain a query string, so make sure we only use the
  // actual file.
  $parsed_url = drupal_parse_url($filepath);
  $filepath = $parsed_url['path'];
  // Load the JavaScript file.
  $file = file_get_contents($filepath);

  // Match all calls to Drupal.t() in an array.
  // Note: \s also matches newlines with the 's' modifier.
  preg_match_all('~
    [^\w]Drupal\s*\.\s*t\s*                       # match "Drupal.t" with whitespace
    \(\s*                                         # match "(" argument list start
    (' . LOCALE_JS_STRING . ')\s*                 # capture string argument
    (?:,\s*' . LOCALE_JS_OBJECT . '\s*            # optionally capture str args
      (?:,\s*' . LOCALE_JS_OBJECT_CONTEXT . '\s*) # optionally capture context
    ?)?                                           # close optional args
    [,\)]                                         # match ")" or "," to finish
    ~sx', $file, $t_matches);

  // Match all Drupal.formatPlural() calls in another array.
  preg_match_all('~
    [^\w]Drupal\s*\.\s*formatPlural\s*  # match "Drupal.formatPlural" with whitespace
    \(                                  # match "(" argument list start
    \s*.+?\s*,\s*                       # match count argument
    (' . LOCALE_JS_STRING . ')\s*,\s*   # match singular string argument
    (                             # capture plural string argument
      (?:                         # non-capturing group to repeat string pieces
        (?:
          \'                      # match start of single-quoted string
          (?:\\\\\'|[^\'])*       # match any character except unescaped single-quote
          @count                  # match "@count"
          (?:\\\\\'|[^\'])*       # match any character except unescaped single-quote
          \'                      # match end of single-quoted string
          |
          "                       # match start of double-quoted string
          (?:\\\\"|[^"])*         # match any character except unescaped double-quote
          @count                  # match "@count"
          (?:\\\\"|[^"])*         # match any character except unescaped double-quote
          "                       # match end of double-quoted string
        )
        (?:\s*\+\s*)?             # match "+" with possible whitespace, for str concat
      )+                          # match multiple because we supports concatenating strs
    )\s*                          # end capturing of plural string argument
    (?:,\s*' . LOCALE_JS_OBJECT . '\s*          # optionally capture string args
      (?:,\s*' . LOCALE_JS_OBJECT_CONTEXT . '\s*)?  # optionally capture context
    )?
    [,\)]
    ~sx', $file, $plural_matches);

  $matches = array();

  // Add strings from Drupal.t().
  foreach ($t_matches[1] as $key => $string) {
    $matches[] = array(
      'string'  => $string,
      'context' => $t_matches[2][$key],
    );
  }

  // Add string from Drupal.formatPlural().
  foreach ($plural_matches[1] as $key => $string) {
    $matches[] = array(
      'string'  => $string,
      'context' => $plural_matches[3][$key],
    );

    // If there is also a plural version of this string, add it to the strings array.
    if (isset($plural_matches[2][$key])) {
      $matches[] = array(
        'string'  => $plural_matches[2][$key],
        'context' => $plural_matches[3][$key],
      );
    }
  }

  // Loop through all matches and process them.
  foreach ($matches as $key => $match) {

    // Remove the quotes and string concatenations from the string and context.
    $string =  implode('', preg_split('~(?<!\\\\)[\'"]\s*\+\s*[\'"]~s', substr($match['string'], 1, -1)));
    $context = implode('', preg_split('~(?<!\\\\)[\'"]\s*\+\s*[\'"]~s', substr($match['context'], 1, -1)));

889
    $source = locale_storage()->findString(array('source' => $string, 'context' => $context));
890 891

    if (!$source) {
892
      // We don't have the source string yet, thus we insert it into the database.
893
      $source = locale_storage()->createString(array(
894 895
        'source'    => $string,
        'context'   => $context,
896
      ));
897
    }
898 899 900
    // Besides adding the location this will tag it for current version.
    $source->addLocation('javascript', $filepath);
    $source->save();
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915
  }
}

/**
 * Force the JavaScript translation file(s) to be refreshed.
 *
 * This function sets a refresh flag for a specified language, or all
 * languages except English, if none specified. JavaScript translation
 * files are rebuilt (with locale_update_js_files()) the next time a
 * request is served in that language.
 *
 * @param $langcode
 *   The language code for which the file needs to be refreshed.
 *
 * @return
916
 *   New content of the 'system.javascript_parsed' variable.
917 918
 */
function _locale_invalidate_js($langcode = NULL) {
919
  $parsed = state()->get('system.javascript_parsed') ?: array();
920 921 922

  if (empty($langcode)) {
    // Invalidate all languages.
923
    $languages = locale_translatable_language_list();
924 925 926 927 928 929 930 931 932
    foreach ($languages as $lcode => $data) {
      $parsed['refresh:' . $lcode] = 'waiting';
    }
  }
  else {
    // Invalidate single language.
    $parsed['refresh:' . $langcode] = 'waiting';
  }

933
  state()->set('system.javascript_parsed', $parsed);
934 935 936 937 938 939 940 941 942 943 944
  return $parsed;
}

/**
 * (Re-)Creates the JavaScript translation file for a language.
 *
 * @param $langcode
 *   The language, the translation file should be (re)created for.
 */
function _locale_rebuild_js($langcode = NULL) {
  if (!isset($langcode)) {
945
    $language = language(LANGUAGE_TYPE_INTERFACE);
946 947 948 949 950 951 952 953 954
  }
  else {
    // Get information about the locale.
    $languages = language_list();
    $language = $languages[$langcode];
  }

  // Construct the array for JavaScript translations.
  // Only add strings with a translation to the translations array.
955 956 957 958 959
  $conditions = array(
    'type' => 'javascript',
    'language' =>  $language->langcode,
    'translated' => TRUE,
  );
960
  $translations = array();
961
  foreach (locale_storage()->getTranslations($conditions) as $data) {
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 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
    $translations[$data->context][$data->source] = $data->translation;
  }

  // Construct the JavaScript file, if there are translations.
  $data_hash = NULL;
  $data = $status = '';
  if (!empty($translations)) {

    $data = "Drupal.locale = { ";

    $locale_plurals = variable_get('locale_translation_plurals', array());
    if (!empty($locale_plurals[$language->langcode])) {
      $data .= "'pluralFormula': function (\$n) { return Number({$locale_plurals[$language->langcode]['formula']}); }, ";
    }

    $data .= "'strings': " . drupal_json_encode($translations) . " };";
    $data_hash = drupal_hash_base64($data);
  }

  // Construct the filepath where JS translation files are stored.
  // There is (on purpose) no front end to edit that variable.
  $dir = 'public://' . variable_get('locale_js_directory', 'languages');

  // Delete old file, if we have no translations anymore, or a different file to be saved.
  $locale_javascripts = variable_get('locale_translation_javascript', array());
  $changed_hash = !isset($locale_javascripts[$language->langcode]) || ($locale_javascripts[$language->langcode] != $data_hash);
  if (!empty($locale_javascripts[$language->langcode]) && (!$data || $changed_hash)) {
    file_unmanaged_delete($dir . '/' . $language->langcode . '_' . $locale_javascripts[$language->langcode] . '.js');
    $locale_javascripts[$language->langcode] = '';
    $status = 'deleted';
  }

  // Only create a new file if the content has changed or the original file got
  // lost.
  $dest = $dir . '/' . $language->langcode . '_' . $data_hash . '.js';
  if ($data && ($changed_hash || !file_exists($dest))) {
    // Ensure that the directory exists and is writable, if possible.
    file_prepare_directory($dir, FILE_CREATE_DIRECTORY);

    // Save the file.
    if (file_unmanaged_save_data($data, $dest)) {
      $locale_javascripts[$language->langcode] = $data_hash;
      // If we deleted a previous version of the file and we replace it with a
      // new one we have an update.
      if ($status == 'deleted') {
        $status = 'updated';
      }
      // If the file did not exist previously and the data has changed we have
      // a fresh creation.
      elseif ($changed_hash) {
        $status = 'created';
      }
      // If the data hash is unchanged the translation was lost and has to be
      // rebuilt.
      else {
        $status = 'rebuilt';
      }
    }
    else {
      $locale_javascripts[$language->langcode] = '';
      $status = 'error';
    }
  }

  // Save the new JavaScript hash (or an empty value if the file just got
  // deleted). Act only if some operation was executed that changed the hash
  // code.
  if ($status && $changed_hash) {
    variable_set('locale_translation_javascript', $locale_javascripts);
  }

  // Log the operation and return success flag.
  switch ($status) {
    case 'updated':
      watchdog('locale', 'Updated JavaScript translation file for the language %language.', array('%language' => $language->name));
      return TRUE;
    case 'rebuilt':
      watchdog('locale', 'JavaScript translation file %file.js was lost.', array('%file' => $locale_javascripts[$language->langcode]), WATCHDOG_WARNING);
      // Proceed to the 'created' case as the JavaScript translation file has
      // been created again.
    case 'created':
      watchdog('locale', 'Created JavaScript translation file for the language %language.', array('%language' => $language->name));
      return TRUE;
    case 'deleted':
      watchdog('locale', 'Removed JavaScript translation file for the language %language because no translations currently exist for that language.', array('%language' => $language->name));
      return TRUE;
    case 'error':
      watchdog('locale', 'An error occurred during creation of the JavaScript translation file for the language %language.', array('%language' => $language->name), WATCHDOG_ERROR);
      return FALSE;
    default:
      // No operation needed.
      return TRUE;
  }
}
1056 1057 1058 1059 1060 1061 1062 1063

/**
 * Implements hook_language_init().
 */
function locale_language_init() {
  // Add locale helper to configuration subscribers.
  drupal_container()->get('dispatcher')->addSubscriber(new LocaleConfigSubscriber());
}