locale.module 45.7 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
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
25
      $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>';
26 27 28 29 30 31
      $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
      'restrict access' => TRUE,
211
    ),
212
  );
213 214
}

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

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

229 230
  $names = array();
  foreach ($languages as $langcode => $item) {
231
    $names[$langcode] = $item->name;
Dries's avatar
 
Dries committed
232
  }
233
  // Get language negotiation settings.
234
  $mode = language_negotiation_method_get_first(LANGUAGE_TYPE_INTERFACE) != LANGUAGE_NEGOTIATION_DEFAULT;
235 236 237 238 239
  $form['locale'] = array(
    '#type' => 'fieldset',
    '#title' => t('Language settings'),
    '#weight' => 1,
  );
240
  $form['locale']['preferred_langcode'] = array(
241 242
    '#type' => (count($names) <= 5 ? 'radios' : 'select'),
    '#title' => t('Language'),
243
    '#default_value' => $user_preferred_language->langcode,
244
    '#options' => $names,
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
    '#description' => $mode ? t("This account's preferred language for e-mails and site presentation.") : t("This account's preferred language for e-mails."),
  );
  // User entities contain both a langcode property (for identifying the
  // language of the entity data) and a preferred_langcode property (see above).
  // Rather than provide a UI forcing the user to choose both separately,
  // assume that the user profile data is in the user's preferred language. This
  // element provides that synchronization. For use-cases where this
  // synchronization is not desired, a module can alter or remove this element.
  $form['locale']['langcode'] = array(
    '#type' => 'value',
    '#value_callback' => '_locale_language_selector_langcode_value',
    // For the synchronization to work, this element must have a larger weight
    // than the preferred_langcode element. Set a large weight here in case
    // a module alters the weight of the other element.
    '#weight' => 100,
260
  );
261
  return $form;
Dries's avatar
 
Dries committed
262 263
}

264 265 266 267 268 269 270 271 272 273
/**
 * Sets the value of the user register and profile forms' langcode element.
 *
 * @see locale_language_selector_form()
 */
function _locale_language_selector_langcode_value($element, $input, &$form_state) {
  $form_state['complete_form']['locale']['preferred_langcode']['#description'] .= ' ' . t("This is also assumed to be the primary language of this account's profile information.");
  return $form_state['values']['preferred_langcode'];
}

274
/**
275
 * Implements hook_form_alter().
276
 *
277
 * Adds language fields to user forms.
278 279
 */
function locale_form_alter(&$form, &$form_state, $form_id) {
280
  // Only alter user forms if there is more than one language.
281
  if (language_multilingual()) {
282 283
    // Display language selector when either creating a user on the admin
    // interface or editing a user account.
284 285 286 287 288 289
    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;
290 291
    }
  }
292 293 294 295 296 297 298
}

/**
 * Implements hook_form_BASE_FORM_ID_alter().
 */
function locale_form_node_form_alter(&$form, &$form_state) {
  $form['#submit'][] = 'locale_field_node_form_submit';
299 300 301 302 303
}

/**
 * Form submit handler for node_form().
 *
304
 * Checks if Locale is registered as a translation handler and handle possible
305
 * node language changes.
306 307 308 309
 *
 * 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.
310 311
 */
function locale_field_node_form_submit($form, &$form_state) {
312 313 314 315 316 317 318 319
  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);
320
      $previous_langcode = $form[$field_name]['#language'];
321 322 323

      // Handle a possible language change: new language values are inserted,
      // previous ones are deleted.
324 325 326
      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();
327 328
      }
    }
329 330 331
  }
}

332
/**
333
 * Implements hook_theme().
334 335 336
 */
function locale_theme() {
  return array(
337
    'language_negotiation_configure_form' => array(
338
      'render element' => 'form',
339
    ),
340
    'locale_date_format_form' => array(
341
      'render element' => 'form',
342
    ),
343 344
  );
}
345

346
/**
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
 * 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
373
 *   The language code $entity has to be displayed in.
374
 */
375 376 377 378 379 380 381 382 383 384 385 386 387
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)) {
388
        require_once DRUPAL_ROOT . '/core/includes/language.inc';
389 390 391 392 393 394 395 396 397
        $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;
        }
      }
    }
398 399 400 401
  }
}

/**
402
 * Implements hook_entity_info_alter().
403 404
 */
function locale_entity_info_alter(&$entity_info) {
405
  $entity_info['node']['translation']['locale'] = TRUE;
406 407
}

408
/**
409
 * Implements hook_language_types_info().
410 411 412 413 414 415 416 417
 *
 * 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
418 419 420
 *   URL language negotiation method or the URL fallback language negotiation
 *   method if no language can be detected. It is used by l() as the default
 *   language if none is specified.
421 422
 */
function locale_language_types_info() {
423
  require_once DRUPAL_ROOT . '/core/includes/locale.inc';
424 425
  return array(
    LANGUAGE_TYPE_INTERFACE => array(
426
      'name' => t('User interface text'),
427
      '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.'),
428
    ),
429
    LANGUAGE_TYPE_CONTENT => array(
430 431
      '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.'),
432
      'fixed' => array(LANGUAGE_NEGOTIATION_INTERFACE),
433
    ),
434
    LANGUAGE_TYPE_URL => array(
435
      'fixed' => array(LANGUAGE_NEGOTIATION_URL, LANGUAGE_NEGOTIATION_URL_FALLBACK),
436 437 438 439 440
    ),
  );
}

/**
441
 * Implements hook_language_negotiation_info().
442 443
 */
function locale_language_negotiation_info() {
444 445
  require_once DRUPAL_ROOT . '/core/includes/locale.inc';
  $file = '/core/includes/locale.inc';
446
  $negotiation_info = array();
447

448
  $negotiation_info[LANGUAGE_NEGOTIATION_URL] = array(
449 450
    'types' => array(LANGUAGE_TYPE_CONTENT, LANGUAGE_TYPE_INTERFACE, LANGUAGE_TYPE_URL),
    'callbacks' => array(
451 452
      'negotiation' => 'locale_language_from_url',
      'language_switch' => 'locale_language_switcher_url',
453 454 455 456 457
      'url_rewrite' => 'locale_language_url_rewrite_url',
    ),
    'file' => $file,
    'weight' => -8,
    'name' => t('URL'),
458
    'description' => t('Determine the language from the URL (Path prefix or domain).'),
459
    'config' => 'admin/config/regional/language/detection/url',
460 461
  );

462
  $negotiation_info[LANGUAGE_NEGOTIATION_SESSION] = array(
463
    'callbacks' => array(
464 465
      'negotiation' => 'locale_language_from_session',
      'language_switch' => 'locale_language_switcher_session',
466 467 468 469 470
      'url_rewrite' => 'locale_language_url_rewrite_session',
    ),
    'file' => $file,
    'weight' => -6,
    'name' => t('Session'),
471
    'description' => t('Determine the language from a request/session parameter.'),
472
    'config' => 'admin/config/regional/language/detection/session',
473 474
  );

475 476
  $negotiation_info[LANGUAGE_NEGOTIATION_USER] = array(
    'callbacks' => array('negotiation' => 'locale_language_from_user'),
477 478 479
    'file' => $file,
    'weight' => -4,
    'name' => t('User'),
480
    'description' => t("Follow the user's language preference."),
481 482
  );

483 484
  $negotiation_info[LANGUAGE_NEGOTIATION_BROWSER] = array(
    'callbacks' => array('negotiation' => 'locale_language_from_browser'),
485
    'file' => $file,
486
    'weight' => -2,
487
    'cache' => 0,
488
    'name' => t('Browser'),
489
    'description' => t("Determine the language from the browser's language settings."),
490 491
  );

492
  $negotiation_info[LANGUAGE_NEGOTIATION_INTERFACE] = array(
493
    'types' => array(LANGUAGE_TYPE_CONTENT),
494
    'callbacks' => array('negotiation' => 'locale_language_from_interface'),
495 496
    'file' => $file,
    'weight' => 8,
497 498
    'name' => t('Interface'),
    'description' => t('Use the detected interface language.'),
499 500
  );

501
  $negotiation_info[LANGUAGE_NEGOTIATION_URL_FALLBACK] = array(
502
    'types' => array(LANGUAGE_TYPE_URL),
503
    'callbacks' => array('negotiation' => 'locale_language_url_fallback'),
504 505 506 507 508 509
    'file' => $file,
    'weight' => 8,
    'name' => t('URL fallback'),
    'description' => t('Use an already detected language for URLs if none is found.'),
  );

510
  return $negotiation_info;
511 512
}

513 514 515 516
/**
 * Implements hook_modules_enabled().
 */
function locale_modules_enabled($modules) {
517
  include_once DRUPAL_ROOT . '/core/includes/language.inc';
518 519 520 521 522 523 524 525 526 527 528
  language_types_set();
  language_negotiation_purge();
}

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

529
/**
530
 * Implements hook_language_insert().
531
 */
532
function locale_language_insert($language) {
533 534
  // Add new language to the list of language prefixes.
  $prefixes = locale_language_negotiation_url_prefixes();
535
  $prefixes[$language->langcode] = (empty($language->default) ? $language->langcode : '');
536 537 538 539
  locale_language_negotiation_url_prefixes_save($prefixes);

  // Add language to the list of language domains.
  $domains = locale_language_negotiation_url_domains();
540
  $domains[$language->langcode] = '';
541
  locale_language_negotiation_url_domains_save($domains);
542 543 544 545 546

  // @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.
547
  _locale_invalidate_js($language->langcode);
548 549 550
}

/**
551
 * Implements hook_language_update().
552
 */
553
function locale_language_update($language) {
554 555 556 557 558 559

  // 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) {
560
      if ($prefix == '' && $langcode != $language->langcode) {
561 562 563 564 565 566
        $prefixes[$langcode] = $langcode;
      }
    }
    locale_language_negotiation_url_prefixes_save($prefixes);
  }

567 568 569 570
  // @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.
571
  _locale_invalidate_js($language->langcode);
572 573 574
}

/**
575
 * Implements hook_language_delete().
576
 */
577
function locale_language_delete($language) {
578 579
  // Remove language from language prefix list.
  $prefixes = locale_language_negotiation_url_prefixes();
580
  unset($prefixes[$language->langcode]);
581 582 583 584
  locale_language_negotiation_url_prefixes_save($prefixes);

  // Remove language from language domain list.
  $domains = locale_language_negotiation_url_domains();
585
  unset($domains[$language->langcode]);
586
  locale_language_negotiation_url_domains_save($domains);
587 588 589

  // Remove translations.
  db_delete('locales_target')
590
    ->condition('language', $language->langcode)
591 592
    ->execute();

593
  _locale_invalidate_js($language->langcode);
594 595 596 597 598

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

  // Clearing all locale cache from database
599
  cache()->delete('locale:' . $language->langcode);
600 601 602
}


Dries's avatar
 
Dries committed
603
// ---------------------------------------------------------------------------------
604
// Locale core functionality
Dries's avatar
 
Dries committed
605

Dries's avatar
 
Dries committed
606
/**
607
 * Provides interface translation services.
Dries's avatar
 
Dries committed
608 609
 *
 * This function is called from t() to translate a string if needed.
610 611 612
 *
 * @param $string
 *   A string to look up translation for. If omitted, all the
613
 *   cached strings will be returned in all languages already
614
 *   used on the page.
615 616
 * @param $context
 *   The context of this string.
617 618
 * @param $langcode
 *   Language code to use for the lookup.
Dries's avatar
 
Dries committed
619
 */
620
function locale($string = NULL, $context = NULL, $langcode = NULL) {
621
  global $language_interface;
622 623 624 625 626 627 628 629

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

630

631
  if (!isset($string)) {
632
    // Return all cached strings if no string was specified
633 634 635
    return $locale_t;
  }

636
  $langcode = isset($langcode) ? $langcode : $language_interface->langcode;
637

638
  // Store database cached translations in a static variable. Only build the
639 640 641
  // cache after $language_interface has been set to avoid an unnecessary cache
  // rebuild.
  if (!isset($locale_t[$langcode]) && isset($language_interface)) {
642
    $locale_t[$langcode] = array();
643 644 645
    // 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
646 647
    // interface for this. Be careful when turning this option off!
    if (variable_get('locale_cache_strings', 1) == 1) {
648
      if ($cache = cache()->get('locale:' . $langcode)) {
649 650
        $locale_t[$langcode] = $cache->data;
      }
651
      elseif (lock_acquire('locale_cache_' . $langcode)) {
652 653 654
        // 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.
655
        $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)));
656
        foreach ($result as $data) {
657
          $locale_t[$langcode][$data->context][$data->source] = (empty($data->translation) ? TRUE : $data->translation);
658
        }
659
        cache()->set('locale:' . $langcode, $locale_t[$langcode]);
660
        lock_release('locale_cache_' . $langcode);
661
      }
662
    }
Dries's avatar
 
Dries committed
663 664
  }

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

668
    // We do not have this translation cached, so get it from the DB.
669
    $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(
670 671
      ':language' => $langcode,
      ':source' => $string,
672
      ':context' => (string) $context,
673
    ))->fetchObject();
674 675
    if ($translation) {
      // We have the source string at least.
676
      // Cache translation string or TRUE if no translation exists.
677
      $locale_t[$langcode][$context][$string] = (empty($translation->translation) ? TRUE : $translation->translation);
678 679 680 681 682

      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.
683 684 685 686
        db_update('locales_source')
          ->fields(array('version' => VERSION))
          ->condition('lid', $translation->lid)
          ->execute();
687
        cache()->deletePrefix('locale:');
688
      }
Dries's avatar
 
Dries committed
689 690
    }
    else {
691
      // We don't have the source string, cache this as untranslated.
692 693
      db_merge('locales_source')
        ->insertFields(array(
694
          'location' => request_uri(),
695 696 697
          'version' => VERSION,
        ))
        ->key(array(
698
          'source' => $string,
699
          'context' => (string) $context,
700 701
        ))
        ->execute();
702
      $locale_t[$langcode][$context][$string] = TRUE;
703
      // Clear locale cache so this string can be added in a later request.
704
      cache()->deletePrefix('locale:');
Dries's avatar
 
Dries committed
705
    }
Dries's avatar
 
Dries committed
706 707
  }

708
  return ($locale_t[$langcode][$context][$string] === TRUE ? $string : $locale_t[$langcode][$context][$string]);
Dries's avatar
 
Dries committed
709
}
Dries's avatar
 
Dries committed
710

711 712 713 714 715 716 717
/**
 * Reset static variables used by locale().
 */
function locale_reset() {
  drupal_static_reset('locale');
}

Dries's avatar
 
Dries committed
718
/**
719
 * Returns plural form index for a specific number.
Dries's avatar
 
Dries committed
720
 *
721
 * The index is computed from the formula of this language.
722
 *
723 724 725 726 727
 * @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.
728 729 730 731
 * @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
732
 */
733
function locale_get_plural($count, $langcode = NULL) {
734
  global $language_interface;
735 736 737 738 739 740

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

742
  $langcode = $langcode ? $langcode : $language_interface->langcode;
743

744 745 746 747
  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
748
    }
749 750 751 752 753
    // 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
754
      $n = $count;
755 756 757 758 759 760
      $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
761
    }
762
    // Otherwise, return -1 (unknown).
Dries's avatar
 
Dries committed
763
    else {
764
      $plural_indexes[$langcode][$count] = -1;
765
    }
Dries's avatar
 
Dries committed
766
  }
767