locale.module 46.5 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 36 37
      $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>';
      $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>';
      $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/configure':
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/configure/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 65
    case 'admin/structure/block/manage/%/%':
      if ($arg[4] == 'locale' && $arg[5] == 'language') {
        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/configure'))) . '</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/configure'] = array(
77
    'title' => 'Detection and selection',
78 79
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_languages_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/configure/url'] = array(
86
    'title' => 'URL language detection configuration',
87 88 89
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_language_providers_url_form'),
    'access arguments' => array('administer languages'),
90
    'file' => 'locale.admin.inc',
91
    'type' => MENU_VISIBLE_IN_BREADCRUMB,
92 93
  );
  $items['admin/config/regional/language/configure/session'] = array(
94
    'title' => 'Session language detection configuration',
95 96 97
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_language_providers_session_form'),
    '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 184
/**
 * Implements hook_init().
 *
 * Initialize date formats according to the user's current locale.
 */
function locale_init() {
  global $conf, $language;
185
  include_once DRUPAL_ROOT . '/core/includes/locale.inc';
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202

  // 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) {
    $languages = array($language->language);

    // 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 222 223
  global $language;
  $languages = language_list('enabled');
  $languages = $languages[1];
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;
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 242 243
  $form['locale'] = array(
    '#type' => 'fieldset',
    '#title' => t('Language settings'),
    '#weight' => 1,
  );
  $form['locale']['language'] = array(
    '#type' => (count($names) <= 5 ? 'radios' : 'select'),
    '#title' => t('Language'),
    '#default_value' => $user_preferred_language->language,
    '#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_FORM_ID_alter().
251
 */
252
function locale_form_node_type_form_alter(&$form, &$form_state) {
253
  if (isset($form['type'])) {
254 255 256 257 258
    $form['workflow']['language_content_type'] = array(
      '#type' => 'radios',
      '#title' => t('Multilingual support'),
      '#default_value' => variable_get('language_content_type_' . $form['#node_type']->type, 0),
      '#options' => array(t('Disabled'), t('Enabled')),
259
      '#description' => t('Enable multilingual support for this content type. If enabled, a language selection field will be added to the editing form, allowing you to select from one of the <a href="!languages">enabled languages</a>. If disabled, new posts are saved with the default language. Existing content will not be affected by changing this option.', array('!languages' => url('admin/config/regional/language'))),
260 261 262
    );
  }
}
263

264 265 266 267 268 269 270 271 272 273
/**
 * Return whether the given content type has multilingual support.
 *
 * @return
 *   True if multilingual support is enabled.
 */
function locale_multilingual_node_type($type_name) {
  return (bool) variable_get('language_content_type_' . $type_name, 0);
}

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 (drupal_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 299 300 301 302 303 304 305 306 307 308 309 310 311 312
}

/**
 * Implements hook_form_BASE_FORM_ID_alter().
 */
function locale_form_node_form_alter(&$form, &$form_state) {
  if (isset($form['#node']->type) && locale_multilingual_node_type($form['#node']->type)) {
    $form['language'] = array(
      '#type' => 'select',
      '#title' => t('Language'),
      '#default_value' => (isset($form['#node']->language) ? $form['#node']->language : ''),
      '#options' => array(LANGUAGE_NONE => t('Language neutral')) + locale_language_list('name'),
    );
  }
  // Node type without language selector: assign the default for new nodes
  elseif (!isset($form['#node']->nid)) {
    $default = language_default();
    $form['language'] = array(
      '#type' => 'value',
      '#value' => $default->language
    );
313
  }
314
  $form['#submit'][] = 'locale_field_node_form_submit';
315 316 317 318 319
}

/**
 * Form submit handler for node_form().
 *
320
 * Checks if Locale is registered as a translation handler and handle possible
321
 * node language changes.
322 323 324 325
 *
 * 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.
326 327
 */
function locale_field_node_form_submit($form, &$form_state) {
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
  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);
      $previous_language = $form[$field_name]['#language'];

      // Handle a possible language change: new language values are inserted,
      // previous ones are deleted.
      if ($field['translatable'] && $previous_language != $node->language) {
        $form_state['values'][$field_name][$node->language] = $node->{$field_name}[$previous_language];
        $form_state['values'][$field_name][$previous_language] = array();
      }
    }
345 346 347
  }
}

348
/**
349
 * Implements hook_theme().
350 351 352
 */
function locale_theme() {
  return array(
353
    'locale_languages_configure_form' => array(
354
      'render element' => 'form',
355
    ),
356
    'locale_date_format_form' => array(
357
      'render element' => 'form',
358
    ),
359 360
  );
}
361

362
/**
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
 * 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
389
 *   The language code $entity has to be displayed in.
390
 */
391 392 393 394 395 396 397 398 399 400 401 402 403
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)) {
404
        require_once DRUPAL_ROOT . '/core/includes/language.inc';
405 406 407 408 409 410 411 412 413
        $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;
        }
      }
    }
414 415 416 417
  }
}

/**
418
 * Implements hook_entity_info_alter().
419 420
 */
function locale_entity_info_alter(&$entity_info) {
421
  $entity_info['node']['translation']['locale'] = TRUE;
422 423
}

424
/**
425
 * Implements hook_language_types_info().
426 427 428 429 430 431 432 433
 *
 * 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
434 435
 *   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.
436 437
 */
function locale_language_types_info() {
438
  require_once DRUPAL_ROOT . '/core/includes/locale.inc';
439 440
  return array(
    LANGUAGE_TYPE_INTERFACE => array(
441
      'name' => t('User interface text'),
442
      '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.'),
443
    ),
444
    LANGUAGE_TYPE_CONTENT => array(
445 446
      '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.'),
447 448
      'fixed' => array(LOCALE_LANGUAGE_NEGOTIATION_INTERFACE),
    ),
449
    LANGUAGE_TYPE_URL => array(
450
      'fixed' => array(LOCALE_LANGUAGE_NEGOTIATION_URL, LOCALE_LANGUAGE_NEGOTIATION_URL_FALLBACK),
451 452 453 454 455
    ),
  );
}

/**
456
 * Implements hook_language_negotiation_info().
457 458
 */
function locale_language_negotiation_info() {
459 460
  require_once DRUPAL_ROOT . '/core/includes/locale.inc';
  $file = '/core/includes/locale.inc';
461 462 463 464 465 466 467 468 469 470 471 472
  $providers = array();

  $providers[LOCALE_LANGUAGE_NEGOTIATION_URL] = array(
    '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'),
473
    'description' => t('Determine the language from the URL (Path prefix or domain).'),
474 475 476 477 478 479 480 481 482 483 484 485
    'config' => 'admin/config/regional/language/configure/url',
  );

  $providers[LOCALE_LANGUAGE_NEGOTIATION_SESSION] = array(
    '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'),
486
    'description' => t('Determine the language from a request/session parameter.'),
487 488 489 490 491 492 493 494
    'config' => 'admin/config/regional/language/configure/session',
  );

  $providers[LOCALE_LANGUAGE_NEGOTIATION_USER] = array(
    'callbacks' => array('language' => 'locale_language_from_user'),
    'file' => $file,
    'weight' => -4,
    'name' => t('User'),
495
    'description' => t("Follow the user's language preference."),
496 497 498 499
  );

  $providers[LOCALE_LANGUAGE_NEGOTIATION_BROWSER] = array(
    'callbacks' => array('language' => 'locale_language_from_browser'),
500
    'file' => $file,
501
    'weight' => -2,
502
    'cache' => 0,
503
    'name' => t('Browser'),
504
    'description' => t("Determine the language from the browser's language settings."),
505 506
  );

507 508 509
  $providers[LOCALE_LANGUAGE_NEGOTIATION_INTERFACE] = array(
    'types' => array(LANGUAGE_TYPE_CONTENT),
    'callbacks' => array('language' => 'locale_language_from_interface'),
510 511
    'file' => $file,
    'weight' => 8,
512 513
    'name' => t('Interface'),
    'description' => t('Use the detected interface language.'),
514 515
  );

516 517 518 519 520 521 522 523 524
  $providers[LOCALE_LANGUAGE_NEGOTIATION_URL_FALLBACK] = array(
    '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.'),
  );

525 526 527
  return $providers;
}

528 529 530 531
/**
 * Implements hook_modules_enabled().
 */
function locale_modules_enabled($modules) {
532
  include_once DRUPAL_ROOT . '/core/includes/language.inc';
533 534 535 536 537 538 539 540 541 542 543
  language_types_set();
  language_negotiation_purge();
}

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

544
/**
545
 * Implements hook_language_insert().
546
 */
547
function locale_language_insert($language) {
548 549 550 551 552 553 554 555 556
  // Add new language to the list of language prefixes.
  $prefixes = locale_language_negotiation_url_prefixes();
  $prefixes[$language->language] = (empty($language->default) ? $language->language : '');
  locale_language_negotiation_url_prefixes_save($prefixes);

  // Add language to the list of language domains.
  $domains = locale_language_negotiation_url_domains();
  $domains[$language->language] = '';
  locale_language_negotiation_url_domains_save($domains);
557 558 559 560 561 562

  // @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.
  _locale_invalidate_js($language->language);
563 564 565
}

/**
566
 * Implements hook_language_update().
567
 */
568
function locale_language_update($language) {
569 570 571 572 573 574 575 576 577 578 579 580 581

  // 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) {
      if ($prefix == '' && $langcode != $language->language) {
        $prefixes[$langcode] = $langcode;
      }
    }
    locale_language_negotiation_url_prefixes_save($prefixes);
  }

582 583 584 585 586
  // @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.
  _locale_invalidate_js($language->language);
587 588 589
}

/**
590
 * Implements hook_language_delete().
591
 */
592
function locale_language_delete($language) {
593 594 595 596 597 598 599 600 601
  // Remove language from language prefix list.
  $prefixes = locale_language_negotiation_url_prefixes();
  unset($prefixes[$language->language]);
  locale_language_negotiation_url_prefixes_save($prefixes);

  // Remove language from language domain list.
  $domains = locale_language_negotiation_url_domains();
  unset($domains[$language->language]);
  locale_language_negotiation_url_domains_save($domains);
602 603 604 605 606 607 608 609 610 611 612 613 614

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

  _locale_invalidate_js($language->language);

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

  // Clearing all locale cache from database
  cache()->delete('locale:' . $language->language);
615 616 617
}


Dries's avatar
 
Dries committed
618
// ---------------------------------------------------------------------------------
619
// Locale core functionality
Dries's avatar
 
Dries committed
620

Dries's avatar
 
Dries committed
621
/**
622
 * Provides interface translation services.
Dries's avatar
 
Dries committed
623 624
 *
 * This function is called from t() to translate a string if needed.
625 626 627
 *
 * @param $string
 *   A string to look up translation for. If omitted, all the
628
 *   cached strings will be returned in all languages already
629
 *   used on the page.
630 631
 * @param $context
 *   The context of this string.
632 633
 * @param $langcode
 *   Language code to use for the lookup.
Dries's avatar
 
Dries committed
634
 */
635
function locale($string = NULL, $context = NULL, $langcode = NULL) {
636
  global $language;
637
  $locale_t = &drupal_static(__FUNCTION__);
638

639
  if (!isset($string)) {
640
    // Return all cached strings if no string was specified
641 642 643
    return $locale_t;
  }

644 645
  $langcode = isset($langcode) ? $langcode : $language->language;

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

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

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

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

713
  return ($locale_t[$langcode][$context][$string] === TRUE ? $string : $locale_t[$langcode][$context][$string]);
Dries's avatar
 
Dries committed
714
}
Dries's avatar
 
Dries committed
715

716 717 718 719 720 721 722
/**
 * Reset static variables used by locale().
 */
function locale_reset() {
  drupal_static_reset('locale');
}

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

739
  $langcode = $langcode ? $langcode : $language->language;
740

741
  if (!isset($plurals[$langcode][$count])) {
742 743
    if (empty($locale_plural_formulas)) {
      $locale_plurals = variable_get('locale_translation_plurals', array());
Dries's avatar
 
Dries committed
744
    }
745
    if (!empty($locale_plurals[$langcode])) {
Dries's avatar
 
Dries committed
746
      $n = $count;
747
      $plurals[$langcode][$count] = @eval('return intval(' . $locale_plurals[$langcode]['formula'] . ');');
748
      return $plurals[$langcode][$count];
Dries's avatar
 
Dries committed
749 750
    }
    else {
751
      $plurals[$langcode][$count] = -1;
Dries's avatar
 
Dries committed
752
      return -1;
753
    }
Dries's avatar
 
Dries committed
754
  }
755
  return $plurals[$langcode][$count];
756
}
Dries's avatar
 
Dries committed
757

758 759 760 761 762

/**
 * Returns a language name
 */
function locale_language_name($lang) {
763
  $list = &drupal_static(__FUNCTION__);
764 765 766 767 768 769 770 771 772 773
  if (!isset($list)) {
    $list = locale_language_list();
  }
  return ($lang && isset($list[$lang])) ? $list[$lang] : t('All');
}

/**
 * Returns array of language names
 *
 * @param $field
774
 *   Name of language object field.
775 776
 * @param $all
 *   Boolean to return all languages or only enabled ones
777
 */
778 779 780 781 782 783 784 785
function locale_language_list($field = 'name', $all = FALSE) {
  if ($all) {
    $languages = language_list();
  }
  else {
    $languages = language_list('enabled');
    $languages = $languages[1];
  }
786
  $list = array();
787
  foreach ($languages as $language) {
788
    $list[$language->language] = $language->$field;
789 790 791
  }
  return $list;
}
792 793

/**
794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811
 * 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.
812 813 814 815 816 817 818
 *
 * 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.
819 820 821 822 823 824
 *
 * @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.
825 826
 */
function locale_system_update($components) {
827
  include_once drupal_get_path('module', 'locale') . '/locale.bulk.inc';
828
  if ($batch = locale_translate_batch_import_files(NULL, TRUE)) {
829 830 831 832
    batch_set($batch);
  }
}

833
/**
834
 * Implements hook_js_alter().
835 836 837 838 839 840
 *
 * 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.
 */
841
function locale_js_alter(&$javascript) {
842 843
  global $language;

844
  $dir = 'public://' . variable_get('locale_js_directory', 'languages');
845 846 847
  $parsed = variable_get('javascript_parsed', array());
  $files = $new_files = FALSE;

848
  // Require because locale_js_alter() could be called without locale_init().
849
  require_once DRUPAL_ROOT . '/core/includes/locale.inc';