locale.module 46.8 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
      $output = '<p>' . t('With multiple languages enabled, interface text can be translated, registered users may select their preferred language, and authors can assign a specific language to content. <a href="@translations">Download contributed translations</a> from Drupal.org.', array('@translations' => 'http://localize.drupal.org')) . '</p>';
42
      return $output;
43

44
    case 'admin/config/regional/language/add':
45
      return '<p>' . t('Add a language to be supported by your site. If your desired language is not available, pick <em>Custom language...</em> at the end and provide a language code and other details manually.') . '</p>';
46

47
    case 'admin/config/regional/language/configure':
48
      $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>';
49
      return $output;
50

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

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

59
    case 'admin/config/regional/translate/import':
60
      $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>';
61
      $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>';
62
      return $output;
63

64
    case 'admin/config/regional/translate/export':
65
      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>';
66

67 68 69
    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>';
70 71
      }
      break;
Dries's avatar
 
Dries committed
72
  }
Dries's avatar
 
Dries committed
73 74
}

Dries's avatar
 
Dries committed
75
/**
76
 * Implements hook_menu().
Dries's avatar
 
Dries committed
77
 */
78
function locale_menu() {
79
  // Manage languages
80
  $items['admin/config/regional/language'] = array(
81
    'title' => 'Languages',
82
    'description' => 'Configure languages for content and the user interface.',
83
    'page callback' => 'drupal_get_form',
84
    'page arguments' => array('locale_language_overview_form'),
85
    'access arguments' => array('administer languages'),
86
    'file' => 'locale.admin.inc',
87
    'weight' => -10,
88
  );
89
  $items['admin/config/regional/language/overview'] = array(
90
    'title' => 'List',
91 92 93
    'weight' => 0,
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
94
  $items['admin/config/regional/language/add'] = array(
95
    'title' => 'Add language',
96 97
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_languages_add_form'),
98
    'access arguments' => array('administer languages'),
99
    'weight' => 5,
100
    'type' => MENU_LOCAL_ACTION,
101
    'file' => 'locale.admin.inc',
102
  );
103
  $items['admin/config/regional/language/configure'] = array(
104
    'title' => 'Detection and selection',
105 106
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_languages_configure_form'),
107
    'access arguments' => array('administer languages'),
108
    'weight' => 10,
109
    'file' => 'locale.admin.inc',
110 111
    'type' => MENU_LOCAL_TASK,
  );
112
  $items['admin/config/regional/language/configure/url'] = array(
113
    'title' => 'URL language detection configuration',
114 115 116
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_language_providers_url_form'),
    'access arguments' => array('administer languages'),
117
    'file' => 'locale.admin.inc',
118
    'type' => MENU_VISIBLE_IN_BREADCRUMB,
119 120
  );
  $items['admin/config/regional/language/configure/session'] = array(
121
    'title' => 'Session language detection configuration',
122 123 124
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_language_providers_session_form'),
    'access arguments' => array('administer languages'),
125
    'file' => 'locale.admin.inc',
126
    'type' => MENU_VISIBLE_IN_BREADCRUMB,
127
  );
128
  $items['admin/config/regional/language/edit/%language'] = array(
129
    'title' => 'Edit language',
130
    'page callback' => 'drupal_get_form',
131
    'page arguments' => array('locale_languages_edit_form', 5),
132
    'access arguments' => array('administer languages'),
133
    'file' => 'locale.admin.inc',
134
  );
135
  $items['admin/config/regional/language/delete/%language'] = array(
136
    'title' => 'Confirm',
137
    'page callback' => 'drupal_get_form',
138
    'page arguments' => array('locale_languages_delete_form', 5),
139
    'access arguments' => array('administer languages'),
140
    'file' => 'locale.admin.inc',
141 142
  );

143
  // Translation functionality
144
  $items['admin/config/regional/translate'] = array(
145 146 147
    'title' => 'User interface translation',
    'description' => 'Translate the built-in user interface.',
    'page callback' => 'locale_translate_seek_screen',
148
    'access arguments' => array('translate interface'),
149
    'file' => 'locale.pages.inc',
150
    'weight' => -5,
151
  );
152
  $items['admin/config/regional/translate/translate'] = array(
153
    'title' => 'Translate',
154 155
    'weight' => -10,
    'type' => MENU_DEFAULT_LOCAL_TASK,
156
  );
157
  $items['admin/config/regional/translate/import'] = array(
158
    'title' => 'Import',
159 160
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_translate_import_form'),
161
    'access arguments' => array('translate interface'),
162 163
    'weight' => 20,
    'type' => MENU_LOCAL_TASK,
164
    'file' => 'locale.bulk.inc',
165
  );
166
  $items['admin/config/regional/translate/export'] = array(
167
    'title' => 'Export',
168
    'page callback' => 'locale_translate_export_screen',  // possibly multiple forms concatenated
169
    'access arguments' => array('translate interface'),
170 171
    'weight' => 30,
    'type' => MENU_LOCAL_TASK,
172
    'file' => 'locale.bulk.inc',
173
  );
174
  $items['admin/config/regional/translate/edit/%'] = array(
175
    'title' => 'Edit string',
176
    'page callback' => 'drupal_get_form',
177
    'page arguments' => array('locale_translate_edit_form', 5),
178
    'access arguments' => array('translate interface'),
179
    'file' => 'locale.pages.inc',
180
  );
181
  $items['admin/config/regional/translate/delete/%'] = array(
182
    'title' => 'Delete string',
183
    'page callback' => 'locale_translate_delete_page',
184
    'page arguments' => array(5),
185
    'access arguments' => array('translate interface'),
186
    'file' => 'locale.pages.inc',
187
  );
Dries's avatar
 
Dries committed
188

189 190 191 192 193 194 195 196
  // 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,
197
    'file' => 'locale.admin.inc',
198 199 200 201 202 203 204
  );
  $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'),
205
    'file' => 'locale.admin.inc',
206 207 208 209 210 211 212
  );
  $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'),
213
    'file' => 'locale.admin.inc',
214 215
  );

Dries's avatar
 
Dries committed
216
  return $items;
Dries's avatar
 
Dries committed
217 218
}

219 220 221 222 223 224 225
/**
 * Implements hook_init().
 *
 * Initialize date formats according to the user's current locale.
 */
function locale_init() {
  global $conf, $language;
226
  include_once DRUPAL_ROOT . '/core/includes/locale.inc';
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243

  // 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
244
/**
245
 * Implements hook_permission().
Dries's avatar
 
Dries committed
246
 */
247
function locale_permission() {
248
  return array(
249 250 251 252
    'administer languages' => array(
      'title' => t('Administer languages'),
    ),
    'translate interface' => array(
253
      'title' => t('Translate interface texts'),
254
    ),
255
  );
256 257
}

258 259 260 261 262 263 264 265 266 267 268 269 270 271
/**
 * Loads a language object from the database.
 *
 * @param $langcode
 *   The language code.
 *
 * @return
 *   A fully-populated language object or FALSE.
 */
function language_load($langcode) {
  $languages = language_list();
  return isset($languages[$langcode]) ? $languages[$langcode] : FALSE;
}

Dries's avatar
 
Dries committed
272
/**
273 274 275 276
 * Form builder callback to display language selection widget.
 *
 * @ingroup forms
 * @see locale_form_alter()
277
 */
278
function locale_language_selector_form($user) {
279 280 281
  global $language;
  $languages = language_list('enabled');
  $languages = $languages[1];
282

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

286 287
  $names = array();
  foreach ($languages as $langcode => $item) {
288
    $names[$langcode] = $item->name;
Dries's avatar
 
Dries committed
289
  }
290 291
  // Get language negotiation settings.
  $mode = language_negotiation_get(LANGUAGE_TYPE_INTERFACE) != LANGUAGE_NEGOTIATION_DEFAULT;
292 293 294 295 296 297 298 299 300 301
  $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,
302
    '#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."),
303
  );
304
  return $form;
Dries's avatar
 
Dries committed
305 306
}

307
/**
308
 * Implements hook_form_FORM_ID_alter().
309
 */
310
function locale_form_node_type_form_alter(&$form, &$form_state) {
311
  if (isset($form['type'])) {
312 313 314 315 316
    $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')),
317
      '#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'))),
318 319 320
    );
  }
}
321

322 323 324 325 326 327 328 329 330 331
/**
 * 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);
}

332
/**
333
 * Implements hook_form_alter().
334
 *
335
 * Adds language fields to user forms.
336 337
 */
function locale_form_alter(&$form, &$form_state, $form_id) {
338
  // Only alter user forms if there is more than one language.
339
  if (drupal_multilingual()) {
340 341
    // Display language selector when either creating a user on the admin
    // interface or editing a user account.
342 343 344 345 346 347
    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;
348 349
    }
  }
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
}

/**
 * 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
    );
371
  }
372
  $form['#submit'][] = 'locale_field_node_form_submit';
373 374 375 376 377
}

/**
 * Form submit handler for node_form().
 *
378
 * Checks if Locale is registered as a translation handler and handle possible
379
 * node language changes.
380 381 382 383
 *
 * 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.
384 385
 */
function locale_field_node_form_submit($form, &$form_state) {
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
  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();
      }
    }
403 404 405
  }
}

406
/**
407
 * Implements hook_theme().
408 409 410
 */
function locale_theme() {
  return array(
411
    'locale_language_overview_form_table' => array(
412
      'render element' => 'form',
413 414 415 416 417
      'file' => 'locale.admin.inc',
    ),
    'locale_language_operations' => array(
      'render element' => 'elements',
      'file' => 'locale.admin.inc',
418
    ),
419
    'locale_languages_configure_form' => array(
420
      'render element' => 'form',
421
    ),
422
    'locale_date_format_form' => array(
423
      'render element' => 'form',
424
    ),
425 426
  );
}
427

428
/**
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
 * 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
455
 *   The language code $entity has to be displayed in.
456
 */
457 458 459 460 461 462 463 464 465 466 467 468 469
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)) {
470
        require_once DRUPAL_ROOT . '/core/includes/language.inc';
471 472 473 474 475 476 477 478 479
        $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;
        }
      }
    }
480 481 482 483
  }
}

/**
484
 * Implements hook_entity_info_alter().
485 486
 */
function locale_entity_info_alter(&$entity_info) {
487
  $entity_info['node']['translation']['locale'] = TRUE;
488 489
}

490
/**
491
 * Implements hook_language_types_info().
492 493 494 495 496 497 498 499
 *
 * 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
500 501
 *   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.
502 503
 */
function locale_language_types_info() {
504
  require_once DRUPAL_ROOT . '/core/includes/locale.inc';
505 506
  return array(
    LANGUAGE_TYPE_INTERFACE => array(
507
      'name' => t('User interface text'),
508
      '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.'),
509
    ),
510
    LANGUAGE_TYPE_CONTENT => array(
511 512
      '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.'),
513 514
      'fixed' => array(LOCALE_LANGUAGE_NEGOTIATION_INTERFACE),
    ),
515
    LANGUAGE_TYPE_URL => array(
516
      'fixed' => array(LOCALE_LANGUAGE_NEGOTIATION_URL, LOCALE_LANGUAGE_NEGOTIATION_URL_FALLBACK),
517 518 519 520 521
    ),
  );
}

/**
522
 * Implements hook_language_negotiation_info().
523 524
 */
function locale_language_negotiation_info() {
525 526
  require_once DRUPAL_ROOT . '/core/includes/locale.inc';
  $file = '/core/includes/locale.inc';
527 528 529 530 531 532 533 534 535 536 537 538
  $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'),
539
    'description' => t('Determine the language from the URL (Path prefix or domain).'),
540 541 542 543 544 545 546 547 548 549 550 551
    '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'),
552
    'description' => t('Determine the language from a request/session parameter.'),
553 554 555 556 557 558 559 560
    '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'),
561
    'description' => t("Follow the user's language preference."),
562 563 564 565
  );

  $providers[LOCALE_LANGUAGE_NEGOTIATION_BROWSER] = array(
    'callbacks' => array('language' => 'locale_language_from_browser'),
566
    'file' => $file,
567
    'weight' => -2,
568
    'cache' => 0,
569
    'name' => t('Browser'),
570
    'description' => t("Determine the language from the browser's language settings."),
571 572
  );

573 574 575
  $providers[LOCALE_LANGUAGE_NEGOTIATION_INTERFACE] = array(
    'types' => array(LANGUAGE_TYPE_CONTENT),
    'callbacks' => array('language' => 'locale_language_from_interface'),
576 577
    'file' => $file,
    'weight' => 8,
578 579
    'name' => t('Interface'),
    'description' => t('Use the detected interface language.'),
580 581
  );

582 583 584 585 586 587 588 589 590
  $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.'),
  );

591 592 593
  return $providers;
}

594 595 596 597
/**
 * Implements hook_modules_enabled().
 */
function locale_modules_enabled($modules) {
598
  include_once DRUPAL_ROOT . '/core/includes/language.inc';
599 600 601 602 603 604 605 606 607 608 609
  language_types_set();
  language_negotiation_purge();
}

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

Dries's avatar
 
Dries committed
610
// ---------------------------------------------------------------------------------
611
// Locale core functionality
Dries's avatar
 
Dries committed
612

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

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

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

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

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

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

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

705
  return ($locale_t[$langcode][$context][$string] === TRUE ? $string : $locale_t[$langcode][$context][$string]);
Dries's avatar
 
Dries committed
706
}
Dries's avatar
 
Dries committed
707

708 709 710 711 712 713 714
/**
 * Reset static variables used by locale().
 */
function locale_reset() {
  drupal_static_reset('locale');
}

Dries's avatar
 
Dries committed
715
/**
716
 * Returns plural form index for a specific number.
Dries's avatar
 
Dries committed
717
 *
718
 * The index is computed from the formula of this language.
719
 *
720 721 722 723 724
 * @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
725
 */
726
function locale_get_plural($count, $langcode = NULL) {
727
  global $language;
728
  $locale_plurals = &drupal_static(__FUNCTION__, array());
729
  $plurals = &drupal_static(__FUNCTION__ . ':plurals', array());
Dries's avatar
 
Dries committed
730

731
  $langcode = $langcode ? $langcode : $language->language;
732

733
  if (!isset($plurals[$langcode][$count])) {
734 735
    if (empty($locale_plural_formulas)) {
      $locale_plurals = variable_get('locale_translation_plurals', array());
Dries's avatar
 
Dries committed
736
    }
737
    if (!empty($locale_plurals[$langcode])) {
Dries's avatar
 
Dries committed
738
      $n = $count;
739
      $plurals[$langcode][$count] = @eval('return intval(' . $locale_plurals[$langcode]['formula'] . ');');
740
      return $plurals[$langcode][$count];
Dries's avatar
 
Dries committed
741 742
    }
    else {
743
      $plurals[$langcode][$count] = -1;
Dries's avatar
 
Dries committed
744
      return -1;
745
    }
Dries's avatar
 
Dries committed
746
  }
747
  return $plurals[$langcode][$count];
748
}
Dries's avatar
 
Dries committed
749

750 751 752 753 754

/**
 * Returns a language name
 */
function locale_language_name($lang) {
755
  $list = &drupal_static(__FUNCTION__);
756 757 758 759 760 761 762 763 764 765
  if (!isset($list)) {
    $list = locale_language_list();
  }
  return ($lang && isset($list[$lang])) ? $list[$lang] : t('All');
}

/**
 * Returns array of language names
 *
 * @param $field
766
 *   Name of language object field.
767 768
 * @param $all
 *   Boolean to return all languages or only enabled ones
769
 */
770 771 772 773 774 775 776 777
function locale_language_list($field = 'name', $all = FALSE) {
  if ($all) {
    $languages = language_list();
  }
  else {
    $languages = language_list('enabled');
    $languages = $languages[1];
  }
778
  $list = array();
779
  foreach ($languages as $language) {
780
    $list[$language->language] = $language->$field;
781 782 783
  }
  return $list;
}
784

785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817
/**
 * Delete a language.
 *
 * @param $langcode
 *   Language code of the language to be deleted.
 * @return
 *   TRUE if language is successfully deleted. Otherwise FALSE.
 */
function locale_language_delete($langcode) {
  $languages = language_list();
  if (isset($languages[$langcode])) {
    $language = $languages[$langcode];

    module_invoke_all('locale_language_delete', $language);

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

    // Remove the language.
    db_delete('languages')
      ->condition('language', $language->language)
      ->execute();

    if ($language->enabled) {
      variable_set('language_count', variable_get('language_count', 1) - 1);
    }

    drupal_static_reset('language_list');
    _locale_invalidate_js($language->language);

    // Changing the language settings impacts the interface: