locale.module 44.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 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
// Hook implementations
Dries's avatar
 
Dries committed
16

Dries's avatar
 
Dries committed
17
/**
18
 * Implements hook_help().
Dries's avatar
 
Dries committed
19
 */
20 21
function locale_help($path, $arg) {
  switch ($path) {
22
    case 'admin/help#locale':
23 24 25 26 27 28 29 30 31
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
      $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/handbook/modules/locale/')) . '</p>';
      $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>';
32
      $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>';
33 34 35
      $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 .= '<dt>' . t('Configuring a multilingual site') . '</dt>';
36
      $output .= '<dd>' . t("Language negotiation allows your site to automatically change language based on the domain or path used for each request. Users may (optionally) select their preferred language on their <em>My account</em> page, and your site can be configured to honor a web browser's preferred language settings. Site content can be translated using the <a href='@content-help'>Content Translation module</a>.", array('@content-help' => url('admin/help/translation'))) . '</dd>';
37
      $output .= '</dl>';
38
      return $output;
39

40
    case 'admin/config/regional/language':
41
      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>';
42

43
    case 'admin/config/regional/language/detection':
44
      $output = '<p>' . t("Define how to decide which language is used to display page elements (primarily text provided by Drupal and modules, such as field labels and help text). This decision is made by evaluating a series of detection methods for languages; the first detection method that gets a result will determine which language is used for that type of text. Define the order of evaluation of language detection methods on this page.") . '</p>';
45
      return $output;
46

47
    case 'admin/config/regional/language/detection/session':
48
      $output = '<p>' . t('Determine the language from a request/session parameter. Example: "http://example.com?language=de" sets language to German based on the use of "de" within the "language" parameter.') . '</p>';
49
      return $output;
50

51
    case 'admin/config/regional/translate':
52
      $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>';
53
      return $output;
54

55
    case 'admin/config/regional/translate/import':
56
      $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>';
57
      $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>';
58
      return $output;
59

60
    case 'admin/config/regional/translate/export':
61
      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>';
62

63 64
    case 'admin/structure/block/manage/%/%':
      if ($arg[4] == 'locale' && $arg[5] == 'language') {
65
        return '<p>' . t('This block is only shown if <a href="@languages">at least two languages are enabled</a> and <a href="@configuration">language negotiation</a> is set to <em>URL</em> or <em>Session</em>.', array('@languages' => url('admin/config/regional/language'), '@configuration' => url('admin/config/regional/language/detection'))) . '</p>';
66 67
      }
      break;
Dries's avatar
 
Dries committed
68
  }
Dries's avatar
 
Dries committed
69 70
}

Dries's avatar
 
Dries committed
71
/**
72
 * Implements hook_menu().
Dries's avatar
 
Dries committed
73
 */
74
function locale_menu() {
75
  // Language negotiation.
76
  $items['admin/config/regional/language/detection'] = array(
77
    'title' => 'Detection and selection',
78
    'page callback' => 'drupal_get_form',
79
    'page arguments' => array('language_negotiation_configure_form'),
80
    'access arguments' => array('administer languages'),
81
    'weight' => 10,
82
    'file' => 'locale.admin.inc',
83 84
    'type' => MENU_LOCAL_TASK,
  );
85
  $items['admin/config/regional/language/detection/url'] = array(
86
    'title' => 'URL language detection configuration',
87
    'page callback' => 'drupal_get_form',
88
    'page arguments' => array('language_negotiation_configure_url_form'),
89
    'access arguments' => array('administer languages'),
90
    'file' => 'locale.admin.inc',
91
    'type' => MENU_VISIBLE_IN_BREADCRUMB,
92
  );
93
  $items['admin/config/regional/language/detection/session'] = array(
94
    'title' => 'Session language detection configuration',
95
    'page callback' => 'drupal_get_form',
96
    'page arguments' => array('language_negotiation_configure_session_form'),
97
    'access arguments' => array('administer languages'),
98
    'file' => 'locale.admin.inc',
99
    'type' => MENU_VISIBLE_IN_BREADCRUMB,
100
  );
101

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

148 149 150 151 152 153 154 155
  // 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,
156
    'file' => 'locale.admin.inc',
157 158 159 160 161 162 163
  );
  $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'),
164
    'file' => 'locale.admin.inc',
165 166 167 168 169 170 171
  );
  $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'),
172
    'file' => 'locale.admin.inc',
173 174
  );

Dries's avatar
 
Dries committed
175
  return $items;
Dries's avatar
 
Dries committed
176 177
}

178 179 180 181 182 183
/**
 * Implements hook_init().
 *
 * Initialize date formats according to the user's current locale.
 */
function locale_init() {
184
  global $conf, $language_interface;
185
  include_once DRUPAL_ROOT . '/core/includes/locale.inc';
186 187 188 189 190 191 192

  // 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.
  if (strpos($_GET['q'], 'admin/config/regional/date-time/formats') !== 0) {
193
    $languages = array($language_interface->langcode);
194 195 196 197 198 199 200 201 202

    // 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
203
/**
204
 * Implements hook_permission().
Dries's avatar
 
Dries committed
205
 */
206
function locale_permission() {
207
  return array(
208
    'translate interface' => array(
209
      'title' => t('Translate interface texts'),
210
    ),
211
  );
212 213
}

Dries's avatar
 
Dries committed
214
/**
215 216 217 218
 * Form builder callback to display language selection widget.
 *
 * @ingroup forms
 * @see locale_form_alter()
219
 */
220
function locale_language_selector_form($user) {
221
  global $language_interface;
222 223
  // Get list of enabled languages only.
  $languages = language_list(TRUE);
224

225
  // If the user is being created, we set the user language to the page language.
226
  $user_preferred_language = $user->uid ? user_preferred_language($user) : $language_interface;
Dries's avatar
Dries committed
227

228 229
  $names = array();
  foreach ($languages as $langcode => $item) {
230
    $names[$langcode] = $item->name;
Dries's avatar
 
Dries committed
231
  }
232 233
  // Get language negotiation settings.
  $mode = language_negotiation_get(LANGUAGE_TYPE_INTERFACE) != LANGUAGE_NEGOTIATION_DEFAULT;
234 235 236 237 238 239 240 241
  $form['locale'] = array(
    '#type' => 'fieldset',
    '#title' => t('Language settings'),
    '#weight' => 1,
  );
  $form['locale']['language'] = array(
    '#type' => (count($names) <= 5 ? 'radios' : 'select'),
    '#title' => t('Language'),
242
    '#default_value' => $user_preferred_language->langcode,
243
    '#options' => $names,
244
    '#description' => $mode ? t("This account's default language for e-mails, and preferred language for site presentation.") : t("This account's default language for e-mails."),
245
  );
246
  return $form;
Dries's avatar
 
Dries committed
247 248
}

249
/**
250
 * Implements hook_form_alter().
251
 *
252
 * Adds language fields to user forms.
253 254
 */
function locale_form_alter(&$form, &$form_state, $form_id) {
255
  // Only alter user forms if there is more than one language.
256
  if (language_multilingual()) {
257 258
    // Display language selector when either creating a user on the admin
    // interface or editing a user account.
259 260 261 262 263 264
    if ($form_id == 'user_register_form' || $form_id == 'user_profile_form') {
      $selector = locale_language_selector_form($form['#user']);
      if ($form_id == 'user_register_form') {
        $selector['locale']['#access'] = user_access('administer users');
      }
      $form += $selector;
265 266
    }
  }
267 268 269 270 271 272 273
}

/**
 * Implements hook_form_BASE_FORM_ID_alter().
 */
function locale_form_node_form_alter(&$form, &$form_state) {
  $form['#submit'][] = 'locale_field_node_form_submit';
274 275 276 277 278
}

/**
 * Form submit handler for node_form().
 *
279
 * Checks if Locale is registered as a translation handler and handle possible
280
 * node language changes.
281 282 283 284
 *
 * 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.
285 286
 */
function locale_field_node_form_submit($form, &$form_state) {
287 288 289 290 291 292 293 294
  if (field_has_translation_handler('node', 'locale')) {
    $node = (object) $form_state['values'];
    $available_languages = field_content_languages();
    list(, , $bundle) = entity_extract_ids('node', $node);

    foreach (field_info_instances('node', $bundle) as $instance) {
      $field_name = $instance['field_name'];
      $field = field_info_field($field_name);
295
      $previous_langcode = $form[$field_name]['#language'];
296 297 298

      // Handle a possible language change: new language values are inserted,
      // previous ones are deleted.
299 300 301
      if ($field['translatable'] && $previous_langcode != $node->langcode) {
        $form_state['values'][$field_name][$node->langcode] = $node->{$field_name}[$previous_langcode];
        $form_state['values'][$field_name][$previous_langcode] = array();
302 303
      }
    }
304 305 306
  }
}

307
/**
308
 * Implements hook_theme().
309 310 311
 */
function locale_theme() {
  return array(
312
    'language_negotiation_configure_form' => array(
313
      'render element' => 'form',
314
    ),
315
    'locale_date_format_form' => array(
316
      'render element' => 'form',
317
    ),
318 319
  );
}
320

321
/**
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
 * Implements hook_field_language_alter().
 */
function locale_field_language_alter(&$display_language, $context) {
  // 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')) {
    locale_field_language_fallback($display_language, $context['entity'], $context['language']);
  }
}

/**
 * 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.
 *
 * @param $display_language
 *   A reference to an array of language codes keyed by field name.
 * @param $entity
 *   The entity to be displayed.
 * @param $langcode
348
 *   The language code $entity has to be displayed in.
349
 */
350 351 352 353 354 355 356 357 358 359 360 361 362
function locale_field_language_fallback(&$display_language, $entity, $langcode) {
  // Lazily init fallback candidates to avoid unnecessary calls.
  $fallback_candidates = NULL;
  $field_languages = array();

  foreach ($display_language as $field_name => $field_language) {
    // 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])) {
      $display_language[$field_name] = $langcode;
    }
    elseif (!empty($entity->{$field_name})) {
      if (!isset($fallback_candidates)) {
363
        require_once DRUPAL_ROOT . '/core/includes/language.inc';
364 365 366 367 368 369 370 371 372
        $fallback_candidates = language_fallback_get_candidates();
      }
      foreach ($fallback_candidates as $fallback_language) {
        if (isset($entity->{$field_name}[$fallback_language])) {
          $display_language[$field_name] = $fallback_language;
          break;
        }
      }
    }
373 374 375 376
  }
}

/**
377
 * Implements hook_entity_info_alter().
378 379
 */
function locale_entity_info_alter(&$entity_info) {
380
  $entity_info['node']['translation']['locale'] = TRUE;
381 382
}

383
/**
384
 * Implements hook_language_types_info().
385 386 387 388 389 390 391 392
 *
 * Defines the three core language types:
 * - Interface language is the only configurable language type in core. It is
 *   used by t() as the default language if none is specified.
 * - Content language is by default non-configurable and inherits the interface
 *   language negotiated value. It is used by the Field API to determine the
 *   display language for fields if no explicit value is specified.
 * - URL language is by default non-configurable and is determined through the
393 394
 *   URL language provider or the URL fallback provider if no language can be
 *   detected. It is used by l() as the default language if none is specified.
395 396
 */
function locale_language_types_info() {
397
  require_once DRUPAL_ROOT . '/core/includes/locale.inc';
398 399
  return array(
    LANGUAGE_TYPE_INTERFACE => array(
400
      'name' => t('User interface text'),
401
      'description' => t('Order of language detection methods for user interface text. If a translation of user interface text is available in the detected language, it will be displayed.'),
402
    ),
403
    LANGUAGE_TYPE_CONTENT => array(
404 405
      'name' => t('Content'),
      'description' => t('Order of language detection methods for content. If a version of content is available in the detected language, it will be displayed.'),
406
      'fixed' => array(LANGUAGE_NEGOTIATION_INTERFACE),
407
    ),
408
    LANGUAGE_TYPE_URL => array(
409
      'fixed' => array(LANGUAGE_NEGOTIATION_URL, LANGUAGE_NEGOTIATION_URL_FALLBACK),
410 411 412 413 414
    ),
  );
}

/**
415
 * Implements hook_language_negotiation_info().
416 417
 */
function locale_language_negotiation_info() {
418 419
  require_once DRUPAL_ROOT . '/core/includes/locale.inc';
  $file = '/core/includes/locale.inc';
420 421
  $providers = array();

422
  $providers[LANGUAGE_NEGOTIATION_URL] = array(
423 424 425 426 427 428 429 430 431
    'types' => array(LANGUAGE_TYPE_CONTENT, LANGUAGE_TYPE_INTERFACE, LANGUAGE_TYPE_URL),
    'callbacks' => array(
      'language' => 'locale_language_from_url',
      'switcher' => 'locale_language_switcher_url',
      'url_rewrite' => 'locale_language_url_rewrite_url',
    ),
    'file' => $file,
    'weight' => -8,
    'name' => t('URL'),
432
    'description' => t('Determine the language from the URL (Path prefix or domain).'),
433
    'config' => 'admin/config/regional/language/detection/url',
434 435
  );

436
  $providers[LANGUAGE_NEGOTIATION_SESSION] = array(
437 438 439 440 441 442 443 444
    'callbacks' => array(
      'language' => 'locale_language_from_session',
      'switcher' => 'locale_language_switcher_session',
      'url_rewrite' => 'locale_language_url_rewrite_session',
    ),
    'file' => $file,
    'weight' => -6,
    'name' => t('Session'),
445
    'description' => t('Determine the language from a request/session parameter.'),
446
    'config' => 'admin/config/regional/language/detection/session',
447 448
  );

449
  $providers[LANGUAGE_NEGOTIATION_USER] = array(
450 451 452 453
    'callbacks' => array('language' => 'locale_language_from_user'),
    'file' => $file,
    'weight' => -4,
    'name' => t('User'),
454
    'description' => t("Follow the user's language preference."),
455 456
  );

457
  $providers[LANGUAGE_NEGOTIATION_BROWSER] = array(
458
    'callbacks' => array('language' => 'locale_language_from_browser'),
459
    'file' => $file,
460
    'weight' => -2,
461
    'cache' => 0,
462
    'name' => t('Browser'),
463
    'description' => t("Determine the language from the browser's language settings."),
464 465
  );

466
  $providers[LANGUAGE_NEGOTIATION_INTERFACE] = array(
467 468
    'types' => array(LANGUAGE_TYPE_CONTENT),
    'callbacks' => array('language' => 'locale_language_from_interface'),
469 470
    'file' => $file,
    'weight' => 8,
471 472
    'name' => t('Interface'),
    'description' => t('Use the detected interface language.'),
473 474
  );

475
  $providers[LANGUAGE_NEGOTIATION_URL_FALLBACK] = array(
476 477 478 479 480 481 482 483
    'types' => array(LANGUAGE_TYPE_URL),
    'callbacks' => array('language' => 'locale_language_url_fallback'),
    'file' => $file,
    'weight' => 8,
    'name' => t('URL fallback'),
    'description' => t('Use an already detected language for URLs if none is found.'),
  );

484 485 486
  return $providers;
}

487 488 489 490
/**
 * Implements hook_modules_enabled().
 */
function locale_modules_enabled($modules) {
491
  include_once DRUPAL_ROOT . '/core/includes/language.inc';
492 493 494 495 496 497 498 499 500 501 502
  language_types_set();
  language_negotiation_purge();
}

/**
 * Implements hook_modules_disabled().
 */
function locale_modules_disabled($modules) {
  locale_modules_enabled($modules);
}

503
/**
504
 * Implements hook_language_insert().
505
 */
506
function locale_language_insert($language) {
507 508
  // Add new language to the list of language prefixes.
  $prefixes = locale_language_negotiation_url_prefixes();
509
  $prefixes[$language->langcode] = (empty($language->default) ? $language->langcode : '');
510 511 512 513
  locale_language_negotiation_url_prefixes_save($prefixes);

  // Add language to the list of language domains.
  $domains = locale_language_negotiation_url_domains();
514
  $domains[$language->langcode] = '';
515
  locale_language_negotiation_url_domains_save($domains);
516 517 518 519 520

  // @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.
521
  _locale_invalidate_js($language->langcode);
522 523 524
}

/**
525
 * Implements hook_language_update().
526
 */
527
function locale_language_update($language) {
528 529 530 531 532 533

  // If the language is the default, then ensure that no other languages have
  // blank prefix codes.
  if (!empty($language->default)) {
    $prefixes = locale_language_negotiation_url_prefixes();
    foreach ($prefixes as $langcode => $prefix) {
534
      if ($prefix == '' && $langcode != $language->langcode) {
535 536 537 538 539 540
        $prefixes[$langcode] = $langcode;
      }
    }
    locale_language_negotiation_url_prefixes_save($prefixes);
  }

541 542 543 544
  // @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.
545
  _locale_invalidate_js($language->langcode);
546 547 548
}

/**
549
 * Implements hook_language_delete().
550
 */
551
function locale_language_delete($language) {
552 553
  // Remove language from language prefix list.
  $prefixes = locale_language_negotiation_url_prefixes();
554
  unset($prefixes[$language->langcode]);
555 556 557 558
  locale_language_negotiation_url_prefixes_save($prefixes);

  // Remove language from language domain list.
  $domains = locale_language_negotiation_url_domains();
559
  unset($domains[$language->langcode]);
560
  locale_language_negotiation_url_domains_save($domains);
561 562 563

  // Remove translations.
  db_delete('locales_target')
564
    ->condition('language', $language->langcode)
565 566
    ->execute();

567
  _locale_invalidate_js($language->langcode);
568 569 570 571 572

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

  // Clearing all locale cache from database
573
  cache()->delete('locale:' . $language->langcode);
574 575 576
}


Dries's avatar
 
Dries committed
577
// ---------------------------------------------------------------------------------
578
// Locale core functionality
Dries's avatar
 
Dries committed
579

Dries's avatar
 
Dries committed
580
/**
581
 * Provides interface translation services.
Dries's avatar
 
Dries committed
582 583
 *
 * This function is called from t() to translate a string if needed.
584 585 586
 *
 * @param $string
 *   A string to look up translation for. If omitted, all the
587
 *   cached strings will be returned in all languages already
588
 *   used on the page.
589 590
 * @param $context
 *   The context of this string.
591 592
 * @param $langcode
 *   Language code to use for the lookup.
Dries's avatar
 
Dries committed
593
 */
594
function locale($string = NULL, $context = NULL, $langcode = NULL) {
595
  global $language_interface;
596 597 598 599 600 601 602 603

  // 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'];

604

605
  if (!isset($string)) {
606
    // Return all cached strings if no string was specified
607 608 609
    return $locale_t;
  }

610
  $langcode = isset($langcode) ? $langcode : $language_interface->langcode;
611

612
  // Store database cached translations in a static variable. Only build the
613 614 615
  // cache after $language_interface has been set to avoid an unnecessary cache
  // rebuild.
  if (!isset($locale_t[$langcode]) && isset($language_interface)) {
616
    $locale_t[$langcode] = array();
617 618 619
    // 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
620 621
    // interface for this. Be careful when turning this option off!
    if (variable_get('locale_cache_strings', 1) == 1) {
622
      if ($cache = cache()->get('locale:' . $langcode)) {
623 624
        $locale_t[$langcode] = $cache->data;
      }
625
      elseif (lock_acquire('locale_cache_' . $langcode)) {
626 627 628
        // 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.
629
        $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)));
630
        foreach ($result as $data) {
631
          $locale_t[$langcode][$data->context][$data->source] = (empty($data->translation) ? TRUE : $data->translation);
632
        }
633
        cache()->set('locale:' . $langcode, $locale_t[$langcode]);
634
        lock_release('locale_cache_' . $langcode);
635
      }
636
    }
Dries's avatar
 
Dries committed
637 638
  }

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

642
    // We do not have this translation cached, so get it from the DB.
643
    $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(
644 645
      ':language' => $langcode,
      ':source' => $string,
646
      ':context' => (string) $context,
647
    ))->fetchObject();
648 649
    if ($translation) {
      // We have the source string at least.
650
      // Cache translation string or TRUE if no translation exists.
651
      $locale_t[$langcode][$context][$string] = (empty($translation->translation) ? TRUE : $translation->translation);
652 653 654 655 656

      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.
657 658 659 660
        db_update('locales_source')
          ->fields(array('version' => VERSION))
          ->condition('lid', $translation->lid)
          ->execute();
661
        cache()->deletePrefix('locale:');
662
      }
Dries's avatar
 
Dries committed
663 664
    }
    else {
665
      // We don't have the source string, cache this as untranslated.
666 667
      db_merge('locales_source')
        ->insertFields(array(
668
          'location' => request_uri(),
669 670 671
          'version' => VERSION,
        ))
        ->key(array(
672
          'source' => $string,
673
          'context' => (string) $context,
674 675
        ))
        ->execute();
676
      $locale_t[$langcode][$context][$string] = TRUE;
677
      // Clear locale cache so this string can be added in a later request.
678
      cache()->deletePrefix('locale:');
Dries's avatar
 
Dries committed
679
    }
Dries's avatar
 
Dries committed
680 681
  }

682
  return ($locale_t[$langcode][$context][$string] === TRUE ? $string : $locale_t[$langcode][$context][$string]);
Dries's avatar
 
Dries committed
683
}
Dries's avatar
 
Dries committed
684

685 686 687 688 689 690 691
/**
 * Reset static variables used by locale().
 */
function locale_reset() {
  drupal_static_reset('locale');
}

Dries's avatar
 
Dries committed
692
/**
693
 * Returns plural form index for a specific number.
Dries's avatar
 
Dries committed
694
 *
695
 * The index is computed from the formula of this language.
696
 *
697 698 699 700 701
 * @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.
702 703 704 705
 * @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
706
 */
707
function locale_get_plural($count, $langcode = NULL) {
708
  global $language_interface;
709 710 711 712 713 714

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

716
  $langcode = $langcode ? $langcode : $language_interface->langcode;
717

718 719 720 721
  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
722
    }
723 724 725 726 727
    // 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
728
      $n = $count;
729 730 731 732 733 734
      $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
735
    }
736
    // Otherwise, return -1 (unknown).
Dries's avatar
 
Dries committed
737
    else {
738
      $plural_indexes[$langcode][$count] = -1;
739
    }
Dries's avatar
 
Dries committed
740
  }
741
  return $plural_indexes[$langcode][$count];
742
}
Dries's avatar
 
Dries committed
743

744

745
/**
746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763
 * 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.
764 765 766 767 768 769 770
 *
 * 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.
771 772 773 774 775 776
 *
 * @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.
777 778
 */
function locale_system_update($components) {
779
  include_once drupal_get_path('module', 'locale') . '/locale.bulk.inc';
780
  if ($batch = locale_translate_batch_import_files(NULL, TRUE)) {
781