locale.module 47 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 6
 *   Add language handling functionality and enables the translation of the
 *   user interface to languages other than English.
Dries's avatar
 
Dries committed
7
 *
8 9 10 11
 *   When enabled, multiple languages can be set up. The site interface
 *   can be displayed in different languages, as well as 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
12 13
 */

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

Dries's avatar
 
Dries committed
65
// ---------------------------------------------------------------------------------
66
// Hook implementations
Dries's avatar
 
Dries committed
67

Dries's avatar
 
Dries committed
68
/**
69
 * Implements hook_help().
Dries's avatar
 
Dries committed
70
 */
71 72
function locale_help($path, $arg) {
  switch ($path) {
73
    case 'admin/help#locale':
74 75
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
76
      $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>';
77 78 79 80 81 82
      $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>';
83
      $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>';
84 85 86
      $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>';
87
      return $output;
88

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

92
    case 'admin/config/regional/translate':
93
      $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>';
94
      return $output;
95

96
    case 'admin/config/regional/translate/import':
97
      $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>';
98
      $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>';
99
      return $output;
100

101
    case 'admin/config/regional/translate/export':
102
      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
103
  }
Dries's avatar
 
Dries committed
104 105
}

Dries's avatar
 
Dries committed
106
/**
107
 * Implements hook_menu().
Dries's avatar
 
Dries committed
108
 */
109
function locale_menu() {
110
  // Translation functionality.
111
  $items['admin/config/regional/translate'] = array(
112 113 114
    'title' => 'User interface translation',
    'description' => 'Translate the built-in user interface.',
    'page callback' => 'locale_translate_seek_screen',
115
    'access arguments' => array('translate interface'),
116
    'file' => 'locale.pages.inc',
117
    'weight' => -5,
118
  );
119
  $items['admin/config/regional/translate/translate'] = array(
120
    'title' => 'Translate',
121 122
    'weight' => -10,
    'type' => MENU_DEFAULT_LOCAL_TASK,
123
  );
124
  $items['admin/config/regional/translate/import'] = array(
125
    'title' => 'Import',
126 127
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_translate_import_form'),
128
    'access arguments' => array('translate interface'),
129 130
    'weight' => 20,
    'type' => MENU_LOCAL_TASK,
131
    'file' => 'locale.bulk.inc',
132
  );
133
  $items['admin/config/regional/translate/export'] = array(
134
    'title' => 'Export',
135 136
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_translate_export_form'),
137
    'access arguments' => array('translate interface'),
138 139
    'weight' => 30,
    'type' => MENU_LOCAL_TASK,
140
    'file' => 'locale.bulk.inc',
141
  );
142
  $items['admin/config/regional/translate/edit/%'] = array(
143
    'title' => 'Edit string',
144
    'page callback' => 'drupal_get_form',
145
    'page arguments' => array('locale_translate_edit_form', 5),
146
    'access arguments' => array('translate interface'),
147
    'file' => 'locale.pages.inc',
148
  );
149
  $items['admin/config/regional/translate/delete/%'] = array(
150
    'title' => 'Delete string',
151
    'page callback' => 'locale_translate_delete_page',
152
    'page arguments' => array(5),
153
    'access arguments' => array('translate interface'),
154
    'file' => 'locale.pages.inc',
155
  );
Dries's avatar
 
Dries committed
156

157 158 159 160 161 162 163 164
  // Localize date formats.
  $items['admin/config/regional/date-time/locale'] = array(
    'title' => 'Localize',
    'description' => 'Configure date formats for each locale',
    'page callback' => 'locale_date_format_language_overview_page',
    'access arguments' => array('administer site configuration'),
    'type' => MENU_LOCAL_TASK,
    'weight' => -8,
165
    'file' => 'locale.admin.inc',
166 167 168 169 170 171 172
  );
  $items['admin/config/regional/date-time/locale/%/edit'] = array(
    'title' => 'Localize date formats',
    'description' => 'Configure date formats for each locale',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_date_format_form', 5),
    'access arguments' => array('administer site configuration'),
173
    'file' => 'locale.admin.inc',
174 175 176 177 178 179 180
  );
  $items['admin/config/regional/date-time/locale/%/reset'] = array(
    'title' => 'Reset date formats',
    'description' => 'Reset localized date formats to global defaults',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_date_format_reset_form', 5),
    'access arguments' => array('administer site configuration'),
181
    'file' => 'locale.admin.inc',
182 183
  );

Dries's avatar
 
Dries committed
184
  return $items;
Dries's avatar
 
Dries committed
185 186
}

187 188 189 190 191 192
/**
 * Implements hook_init().
 *
 * Initialize date formats according to the user's current locale.
 */
function locale_init() {
193
  global $conf, $language_interface;
194 195 196 197 198 199

  // For each date type (e.g. long, short), get the localized date format
  // for the user's current language and override the default setting for it
  // in $conf. This should happen on all pages except the date and time formats
  // settings page, where we want to display the site default and not the
  // localized version.
200
  if (strpos(current_path(), 'admin/config/regional/date-time/formats') !== 0) {
201
    $languages = array($language_interface->langcode);
202 203 204 205 206 207 208 209 210

    // Setup appropriate date formats for this locale.
    $formats = locale_get_localized_date_format($languages);
    foreach ($formats as $format_type => $format) {
      $conf[$format_type] = $format;
    }
  }
}

Dries's avatar
 
Dries committed
211
/**
212
 * Implements hook_permission().
Dries's avatar
 
Dries committed
213
 */
214
function locale_permission() {
215
  return array(
216
    'translate interface' => array(
217
      'title' => t('Translate interface texts'),
218
      'restrict access' => TRUE,
219
    ),
220
  );
221 222
}

223 224 225 226 227
/**
 * Implements hook_form_BASE_FORM_ID_alter().
 */
function locale_form_node_form_alter(&$form, &$form_state) {
  $form['#submit'][] = 'locale_field_node_form_submit';
228 229 230 231 232
}

/**
 * Form submit handler for node_form().
 *
233
 * Checks if Locale is registered as a translation handler and handle possible
234
 * node language changes.
235 236 237 238
 *
 * This submit handler needs to run before entity_form_submit_build_entity()
 * is invoked by node_form_submit_build_node(), because it alters the values of
 * attached fields. Therefore, it cannot be a hook_node_submit() implementation.
239 240
 */
function locale_field_node_form_submit($form, &$form_state) {
241
  if (field_has_translation_handler('node', 'locale')) {
242 243
    $bundle = $form_state['values']['type'];
    $node_language = $form_state['values']['langcode'];
244 245 246 247

    foreach (field_info_instances('node', $bundle) as $instance) {
      $field_name = $instance['field_name'];
      $field = field_info_field($field_name);
248
      $previous_langcode = $form[$field_name]['#language'];
249 250 251

      // Handle a possible language change: new language values are inserted,
      // previous ones are deleted.
252 253
      if ($field['translatable'] && $previous_langcode != $node_language) {
        $form_state['values'][$field_name][$node_language] = $form_state['values'][$field_name][$previous_langcode];
254
        $form_state['values'][$field_name][$previous_langcode] = array();
255 256
      }
    }
257 258 259
  }
}

260
/**
261
 * Implements hook_theme().
262 263 264
 */
function locale_theme() {
  return array(
265
    'locale_date_format_form' => array(
266
      'render element' => 'form',
267
    ),
268 269
  );
}
270

271
/**
272 273
 * Implements hook_field_language_alter().
 */
274
function locale_field_language_alter(&$display_langcode, $context) {
275 276 277
  // Do not apply core language fallback rules if they are disabled or if Locale
  // is not registered as a translation handler.
  if (variable_get('locale_field_language_fallback', TRUE) && field_has_translation_handler($context['entity_type'], 'locale')) {
278
    locale_field_language_fallback($display_langcode, $context['entity'], $context['langcode']);
279 280 281 282 283 284 285 286 287 288 289 290 291 292
  }
}

/**
 * Applies language fallback rules to the fields attached to the given entity.
 *
 * Core language fallback rules simply check if fields have a field translation
 * for the requested language code. If so the requested language is returned,
 * otherwise all the fallback candidates are inspected to see if there is a
 * field translation available in another language.
 * By default this is called by locale_field_language_alter(), but this
 * behavior can be disabled by setting the 'locale_field_language_fallback'
 * variable to FALSE.
 *
293
 * @param $field_langcodes
294 295 296 297
 *   A reference to an array of language codes keyed by field name.
 * @param $entity
 *   The entity to be displayed.
 * @param $langcode
298
 *   The language code $entity has to be displayed in.
299
 */
300
function locale_field_language_fallback(&$field_langcodes, $entity, $langcode) {
301 302 303 304
  // Lazily init fallback candidates to avoid unnecessary calls.
  $fallback_candidates = NULL;
  $field_languages = array();

305
  foreach ($field_langcodes as $field_name => $field_langcode) {
306 307 308
    // If the requested language is defined for the current field use it,
    // otherwise search for a fallback value among the fallback candidates.
    if (isset($entity->{$field_name}[$langcode])) {
309
      $field_langcodes[$field_name] = $langcode;
310 311 312
    }
    elseif (!empty($entity->{$field_name})) {
      if (!isset($fallback_candidates)) {
313
        require_once DRUPAL_ROOT . '/core/includes/language.inc';
314 315
        $fallback_candidates = language_fallback_get_candidates();
      }
316 317 318
      foreach ($fallback_candidates as $fallback_langcode) {
        if (isset($entity->{$field_name}[$fallback_langcode])) {
          $field_langcodes[$field_name] = $fallback_langcode;
319 320 321 322
          break;
        }
      }
    }
323 324 325 326
  }
}

/**
327
 * Implements hook_entity_info_alter().
328 329
 */
function locale_entity_info_alter(&$entity_info) {
330
  $entity_info['node']['translation']['locale'] = TRUE;
331 332
}

333
/**
334
 * Implements hook_language_insert().
335
 */
336 337 338 339 340
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.
  cache('page')->flush();
  // Force JavaScript translation file re-creation for the new language.
341
  _locale_invalidate_js($language->langcode);
342 343 344
}

/**
345
 * Implements hook_language_update().
346
 */
347 348 349 350 351
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.
  cache('page')->flush();
  // Force JavaScript translation file re-creation for the modified language.
352
  _locale_invalidate_js($language->langcode);
353 354 355
}

/**
356
 * Implements hook_language_delete().
357
 */
358 359 360
function locale_language_delete($language) {
  // Remove translations.
  db_delete('locales_target')
361
    ->condition('language', $language->langcode)
362 363
    ->execute();

364
  _locale_invalidate_js($language->langcode);
365 366 367 368 369

  // Changing the language settings impacts the interface:
  cache('page')->flush();

  // Clearing all locale cache from database
370
  cache()->delete('locale:' . $language->langcode);
371 372 373
}


Dries's avatar
 
Dries committed
374
// ---------------------------------------------------------------------------------
375
// Locale core functionality
Dries's avatar
 
Dries committed
376

Dries's avatar
 
Dries committed
377
/**
378
 * Provides interface translation services.
Dries's avatar
 
Dries committed
379 380
 *
 * This function is called from t() to translate a string if needed.
381 382 383
 *
 * @param $string
 *   A string to look up translation for. If omitted, all the
384
 *   cached strings will be returned in all languages already
385
 *   used on the page.
386 387
 * @param $context
 *   The context of this string.
388 389
 * @param $langcode
 *   Language code to use for the lookup.
Dries's avatar
 
Dries committed
390
 */
391
function locale($string = NULL, $context = NULL, $langcode = NULL) {
392
  global $language_interface;
393 394 395 396 397 398 399 400

  // Use the advanced drupal_static() pattern, since this is called very often.
  static $drupal_static_fast;
  if (!isset($drupal_static_fast)) {
    $drupal_static_fast['locale'] = &drupal_static(__FUNCTION__);
  }
  $locale_t = &$drupal_static_fast['locale'];

401

402
  if (!isset($string)) {
403
    // Return all cached strings if no string was specified
404 405 406
    return $locale_t;
  }

407
  $langcode = isset($langcode) ? $langcode : $language_interface->langcode;
408

409
  // Store database cached translations in a static variable. Only build the
410 411 412
  // cache after $language_interface has been set to avoid an unnecessary cache
  // rebuild.
  if (!isset($locale_t[$langcode]) && isset($language_interface)) {
413
    $locale_t[$langcode] = array();
414 415 416
    // Disabling the usage of string caching allows a module to watch for
    // the exact list of strings used on a page. From a performance
    // perspective that is a really bad idea, so we have no user
417 418
    // interface for this. Be careful when turning this option off!
    if (variable_get('locale_cache_strings', 1) == 1) {
419
      if ($cache = cache()->get('locale:' . $langcode)) {
420 421
        $locale_t[$langcode] = $cache->data;
      }
422
      elseif (lock_acquire('locale_cache_' . $langcode)) {
423 424 425
        // Refresh database stored cache of translations for given language.
        // We only store short strings used in current version, to improve
        // performance and consume less memory.
426
        $result = db_query("SELECT s.source, s.context, t.translation, t.language FROM {locales_source} s LEFT JOIN {locales_target} t ON s.lid = t.lid AND t.language = :language WHERE s.version = :version AND LENGTH(s.source) < :length", array(':language' => $langcode, ':version' => VERSION, ':length' => variable_get('locale_cache_length', 75)));
427
        foreach ($result as $data) {
428
          $locale_t[$langcode][$data->context][$data->source] = (empty($data->translation) ? TRUE : $data->translation);
429
        }
430
        cache()->set('locale:' . $langcode, $locale_t[$langcode]);
431
        lock_release('locale_cache_' . $langcode);
432
      }
433
    }
Dries's avatar
 
Dries committed
434 435
  }

436
  // If we have the translation cached, skip checking the database
437
  if (!isset($locale_t[$langcode][$context][$string])) {
Dries's avatar
 
Dries committed
438

439
    // We do not have this translation cached, so get it from the DB.
440
    $translation = db_query("SELECT s.lid, t.translation, s.version FROM {locales_source} s LEFT JOIN {locales_target} t ON s.lid = t.lid AND t.language = :language WHERE s.source = :source AND s.context = :context", array(
441 442
      ':language' => $langcode,
      ':source' => $string,
443
      ':context' => (string) $context,
444
    ))->fetchObject();
445 446
    if ($translation) {
      // We have the source string at least.
447
      // Cache translation string or TRUE if no translation exists.
448
      $locale_t[$langcode][$context][$string] = (empty($translation->translation) ? TRUE : $translation->translation);
449 450 451 452 453

      if ($translation->version != VERSION) {
        // This is the first use of this string under current Drupal version. Save version
        // and clear cache, to include the string into caching next time. Saved version is
        // also a string-history information for later pruning of the tables.
454 455 456 457
        db_update('locales_source')
          ->fields(array('version' => VERSION))
          ->condition('lid', $translation->lid)
          ->execute();
458
        cache()->deletePrefix('locale:');
459
      }
Dries's avatar
 
Dries committed
460 461
    }
    else {
462
      // We don't have the source string, cache this as untranslated.
463 464
      db_merge('locales_source')
        ->insertFields(array(
465
          'location' => request_uri(),
466 467 468
          'version' => VERSION,
        ))
        ->key(array(
469
          'source' => $string,
470
          'context' => (string) $context,
471 472
        ))
        ->execute();
473
      $locale_t[$langcode][$context][$string] = TRUE;
474
      // Clear locale cache so this string can be added in a later request.
475
      cache()->deletePrefix('locale:');
Dries's avatar
 
Dries committed
476
    }
Dries's avatar
 
Dries committed
477 478
  }

479
  return ($locale_t[$langcode][$context][$string] === TRUE ? $string : $locale_t[$langcode][$context][$string]);
Dries's avatar
 
Dries committed
480
}
Dries's avatar
 
Dries committed
481

482 483 484 485 486 487 488
/**
 * Reset static variables used by locale().
 */
function locale_reset() {
  drupal_static_reset('locale');
}

Dries's avatar
 
Dries committed
489
/**
490
 * Returns plural form index for a specific number.
Dries's avatar
 
Dries committed
491
 *
492
 * The index is computed from the formula of this language.
493
 *
494 495 496 497 498
 * @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.
499 500 501 502
 * @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
503
 */
504
function locale_get_plural($count, $langcode = NULL) {
505
  global $language_interface;
506 507 508 509 510 511

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

513
  $langcode = $langcode ? $langcode : $language_interface->langcode;
514

515 516 517 518
  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
519
    }
520 521 522 523 524
    // 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
525
      $n = $count;
526 527 528 529 530 531
      $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
532
    }
533
    // Otherwise, return -1 (unknown).
Dries's avatar
 
Dries committed
534
    else {
535
      $plural_indexes[$langcode][$count] = -1;
536
    }
Dries's avatar
 
Dries committed
537
  }
538
  return $plural_indexes[$langcode][$count];
539
}
Dries's avatar
 
Dries committed
540

541

542
/**
543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560
 * 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.
561 562 563 564 565 566 567
 *
 * 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.
568 569 570 571 572 573
 *
 * @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.
574 575
 */
function locale_system_update($components) {
576
  include_once drupal_get_path('module', 'locale') . '/locale.bulk.inc';
577
  if ($batch = locale_translate_batch_import_files(NULL, TRUE)) {
578 579 580 581
    batch_set($batch);
  }
}

582
/**
583
 * Implements hook_js_alter().
584 585 586 587 588 589
 *
 * 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.
 */
590
function locale_js_alter(&$javascript) {
591
  global $language_interface;
592

593
  $dir = 'public://' . variable_get('locale_js_directory', 'languages');
594 595 596
  $parsed = variable_get('javascript_parsed', array());
  $files = $new_files = FALSE;

597 598 599 600 601 602 603
  foreach ($javascript as $item) {
    if ($item['type'] == 'file') {
      $files = TRUE;
      $filepath = $item['data'];
      if (!in_array($filepath, $parsed)) {
        // Don't parse our own translations files.
        if (substr($filepath, 0, strlen($dir)) != $dir) {
604
          _locale_parse_js_file($filepath);
605 606
          $parsed[] = $filepath;
          $new_files = TRUE;
607 608 609 610 611 612 613 614 615
        }
      }
    }
  }

  // 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) {
616
    $parsed += _locale_invalidate_js();
617 618 619
  }

  // If necessary, rebuild the translation file for the current language.
620
  if (!empty($parsed['refresh:' . $language_interface->langcode])) {
621 622
    // Don't clear the refresh flag on failure, so that another try will
    // be performed later.
623
    if (_locale_rebuild_js()) {
624
      unset($parsed['refresh:' . $language_interface->langcode]);
625 626 627 628 629 630
    }
    // Store any changes after refresh was attempted.
    variable_set('javascript_parsed', $parsed);
  }
  // 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.
631
  elseif ($new_files) {
632 633 634 635
    variable_set('javascript_parsed', $parsed);
  }

  // Add the translation JavaScript file to the page.
636
  $locale_javascripts = variable_get('locale_translation_javascript', array());
637
  if ($files && !empty($locale_javascripts[$language_interface->langcode])) {
638
    // Add the translation JavaScript file to the page.
639
    $file = $dir . '/' . $language_interface->langcode . '_' . $locale_javascripts[$language_interface->langcode] . '.js';
640
    $javascript[$file] = drupal_js_defaults($file);
641 642 643
  }
}

644
 /**
645
 * Implement hook_library_info_alter().
646 647 648
 *
 * Provides the language support for the jQuery UI Date Picker.
 */
649
function locale_library_info_alter(&$libraries, $module) {
650
  global $language_interface;
651 652
  if ($module == 'system' && isset($libraries['system']['ui.datepicker'])) {
    $datepicker = drupal_get_path('module', 'locale') . '/locale.datepicker.js';
653
    $libraries['system']['ui.datepicker']['js'][$datepicker] = array('group' => JS_THEME);
654 655 656
    $libraries['system']['ui.datepicker']['js'][] = array(
      'data' => array(
        'jqueryuidatepicker' => array(
657
          'rtl' => $language_interface->direction == LANGUAGE_RTL,
658 659 660 661 662 663 664 665
          'firstDay' => variable_get('date_first_day', 0),
        ),
      ),
      'type' => 'setting',
    );
  }
}

666
/**
667
 * Implements hook_form_FORM_ID_alter() for language_admin_overview_form().
668
 */
669
function locale_form_language_admin_overview_form_alter(&$form, &$form_state) {
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692
  $languages = $form['languages']['#languages'];

  $total_strings = db_query("SELECT COUNT(*) FROM {locales_source}")->fetchField();
  $stats = array_fill_keys(array_keys($languages), array());

  // If we have source strings, count translations and calculate progress.
  if (!empty($total_strings)) {
    $translations = db_query("SELECT COUNT(*) AS translated, t.language FROM {locales_source} s INNER JOIN {locales_target} t ON s.lid = t.lid GROUP BY language");
    foreach ($translations as $data) {
      $stats[$data->language]['translated'] = $data->translated;
      if ($data->translated > 0) {
        $stats[$data->language]['ratio'] = round($data->translated / $total_strings * 100, 2);
      }
    }
  }

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

  foreach ($languages as $langcode => $language) {
    $stats[$langcode] += array(
      'translated' => 0,
      'ratio' => 0,
    );
693
    if ($langcode != 'en' || locale_translate_english()) {
694 695 696 697 698 699 700 701 702 703 704 705
      $form['languages'][$langcode]['locale_statistics'] = array(
        '#type' => 'link',
        '#title' => t('@translated/@total (@ratio%)', array(
          '@translated' => $stats[$langcode]['translated'],
          '@total' => $total_strings,
          '@ratio' => $stats[$langcode]['ratio'],
        )),
        '#href' => 'admin/config/regional/translate/translate',
      );
    }
    else {
      $form['languages'][$langcode]['locale_statistics'] = array(
706
        '#markup' => t('not applicable'),
707 708 709 710
      );
    }
  }
}
711 712

/**
713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
 * 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';
}

/**
 * Set a batch for newly added language.
 */
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';
  locale_translate_add_language_set_batch($langcode);
}

/**
 * Implements hook_form_FORM_ID_alter() for language_admin_edit_form().
737
 */
738
function locale_form_language_admin_edit_form_alter(&$form, &$form_state) {
739 740 741 742 743 744
  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(),
    );
745
    $form['#submit'][] = 'locale_form_language_admin_edit_form_alter_submit';
746 747 748 749 750 751
  }
}

/**
 * Submission handler to record our custom setting.
 */
752
function locale_form_language_admin_edit_form_alter_submit($form, $form_state) {
753 754 755 756 757 758 759 760 761
  variable_set('locale_translate_english', $form_state['values']['locale_translate_english']);
}

/**
 * Utility function to tell if locale translates to English.
 */
function locale_translate_english() {
  return variable_get('locale_translate_english', FALSE);
}
762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781

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

/**
784
 * Implements hook_preprocess_HOOK() for node.tpl.php.
785 786
 */
function locale_preprocess_node(&$variables) {
787
  if ($variables['langcode'] != LANGUAGE_NOT_SPECIFIED) {
788
    global $language_interface;
789

790
    $node_language = language_load($variables['langcode']);
791
    if ($node_language->langcode != $language_interface->langcode) {
792 793 794
      // If the node language was different from the page language, we should
      // add markup to identify the language. Otherwise the page language is
      // inherited.
795
      $variables['attributes_array']['lang'] = $variables['langcode'];
796
      if ($node_language->direction != $language_interface->direction) {
797 798 799 800 801 802 803 804
        // If text direction is different form the page's text direction, add
        // direction information as well.
        $dir = array('ltr', 'rtl');
        $variables['attributes_array']['dir'] = $dir[$node_language->direction];
      }
    }
  }
}
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 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 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986

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

/**
 * Parses a JavaScript file, extracts strings wrapped in Drupal.t() and
 * Drupal.formatPlural() and inserts them into the database.
 */
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)));

    $source = db_query("SELECT lid, location FROM {locales_source} WHERE source = :source AND context = :context", array(':source' => $string, ':context' => $context))->fetchObject();
    if ($source) {
      // We already have this source string and now have to add the location
      // to the location column, if this file is not yet present in there.
      $locations = preg_split('~\s*;\s*~', $source->location);

      if (!in_array($filepath, $locations)) {
        $locations[] = $filepath;
        $locations = implode('; ', $locations);

        // Save the new locations string to the database.
        db_update('locales_source')
          ->fields(array(
            'location' => $locations,
          ))
          ->condition('lid', $source->lid)
          ->execute();
      }
    }
    else {
      // We don't have the source string yet, thus we insert it into the database.
      db_insert('locales_source')
        ->fields(array(
          'location'  => $filepath,
          'source'    => $string,
          'context'   => $context,
        ))
        ->execute();
    }
  }
}

/**
 * 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
 *   New content of the 'javascript_parsed' variable.
 */
function _locale_invalidate_js($langcode = NULL) {
  $parsed = variable_get('javascript_parsed', array());

  if <