locale.module 32.9 KB
Newer Older
Dries's avatar
 
Dries committed
1
<?php
2
// $Id$
Dries's avatar
 
Dries committed
3

Dries's avatar
 
Dries committed
4 5
/**
 * @file
6 7
 *   Add language handling functionality and enables the translation of the
 *   user interface to languages other than English.
Dries's avatar
 
Dries committed
8
 *
9 10 11 12
 *   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
13 14 15
 */

// ---------------------------------------------------------------------------------
16
// Hook implementations
Dries's avatar
 
Dries committed
17

Dries's avatar
 
Dries committed
18
/**
19
 * Implement hook_help().
Dries's avatar
 
Dries committed
20
 */
21 22
function locale_help($path, $arg) {
  switch ($path) {
23
    case 'admin/help#locale':
24 25 26 27 28
      $output = '<p>' . t('The locale module allows your Drupal site to be presented in languages other than the default English, a defining feature of multi-lingual websites. The locale module works by 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 later review by a translator.') . '</p>';
      $output .= '<p>' . t('Beyond translation of the Drupal interface, the locale module provides a feature set tailored to the needs of a multi-lingual site. 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. Your site content can be created in (and translated to) any enabled language, and each post may have a language-appropriate alias for each of its translations. The locale module works in concert with the <a href="@content-help">content translation module</a> to manage translated content.', array('@content-help' => url('admin/help/translation'))) . '</p>';
      $output .= '<p>' . t('Translations may be provided by:') . '</p>';
      $output .= '<ul><li>' . t("translating the original text via the locale module's integrated web interface, or") . '</li>';
      $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 contain 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 translation page</a>.', array('@translations' => 'http://drupal.org/project/translations')) . '</li></ul>';
29
      $output .= '<p>' . 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'))) . '</p>';
30
      $output .= '<p>' . t('For more information, see the online handbook entry for <a href="@locale">Locale module</a>.', array('@locale' => 'http://drupal.org/handbook/modules/locale/')) . '</p>';
31
      return $output;
32
    case 'admin/config/regional/language':
33
      $output = '<p>' . t("This page provides an overview of your site's enabled languages. If multiple languages are available and enabled, the text on your site interface may be translated, registered users may select their preferred language on the <em>My account</em> page, and site authors may indicate a specific language when creating posts. Languages will be displayed in the order you specify in places such as the language switcher block, or the language dropdown when creating or editing posts. The site's default language is used for anonymous visitors and for users who have not selected a preferred language.") . '</p>';
34
      $output .= '<p>' . t('For each language available on the site, use the <em>edit</em> link to configure language details, including name, an optional language-specific path or domain, and whether the language is natively presented either left-to-right or right-to-left. These languages also appear in the <em>Language</em> selection when creating a post of a content type with multilingual support.') . '</p>';
35
      $output .= '<p>' . t('Use the <a href="@add-language">add language page</a> to enable additional languages (and automatically import files from a translation package, if available), the <a href="@search">translate interface page</a> to locate strings for manual translation, or the <a href="@import">import page</a> to add translations from individual <em>.po</em> files. A number of contributed translation packages containing <em>.po</em> files are available on the <a href="@translations">Drupal.org translations page</a>.', array('@add-language' => url('admin/config/regional/language/add'), '@search' => url('admin/config/regional/translate/translate'), '@import' => url('admin/config/regional/translate/import'), '@translations' => 'http://drupal.org/project/translations')) . '</p>';
36
      $output .= '<p>' . t('Remember that your changes will not be saved until you click the <em>Save configuration</em> button at the bottom of the page.') . '</p>';
37
      return $output;
38
    case 'admin/config/regional/language/add':
39
      return '<p>' . t('Add all languages to be supported by your site. If your desired language is not available in the <em>Language name</em> drop-down, click <em>Custom language</em> and provide a language code and other details manually. When providing a language code manually, be sure to enter a standardized language code, since this code may be used by browsers to determine an appropriate display language.') . '</p>';
40
    case 'admin/config/regional/language/configure':
41 42 43
      $output = '<p>' . t("Language negotiation settings determine the site's presentation language. Available options include:") . '</p>';
      $output .= '<ul><li>' . t('<strong>None.</strong> The default language is used for site presentation, though users may (optionally) select a preferred language on the <em>My Account</em> page. (User language preferences will be used for site e-mails, if available.)') . '</li>';
      $output .= '<li>' . t('<strong>Path prefix only.</strong> The presentation language is determined by examining the path for a language code or other custom string that matches the path prefix (if any) specified for each language. If a suitable prefix is not identified, the default language is used. <em>Example: "example.com/de/contact" sets presentation language to German based on the use of "de" within the path.</em>') . '</li>';
44
      $output .= '<li>' . t("<strong>Path prefix with language fallback.</strong> The presentation language is determined by examining the path for a language code or other custom string that matches the path prefix (if any) specified for each language. If a suitable prefix is not identified, the display language is determined by the user's language preferences from the <em>My Account</em> page, or by the browser's language settings. If a presentation language cannot be determined, the default language is used.") . '</li>';
45
      $output .= '<li>' . t('<strong>Domain name only.</strong> The presentation language is determined by examining the domain used to access the site, and comparing it to the language domain (if any) specified for each language. If a match is not identified, the default language is used. <em>Example: "http://de.example.com/contact" sets presentation language to German based on the use of "http://de.example.com" in the domain.</em>') . '</li></ul>';
46
      $output .= '<p>' . t('The path prefix or domain name for a language may be set by editing the <a href="@languages">available languages</a>. In the absence of an appropriate match, the site is displayed in the <a href="@languages">default language</a>.', array('@languages' => url('admin/config/regional/language'))) . '</p>';
47
      return $output;
48
    case 'admin/config/regional/translate':
49
      $output = '<p>' . t('This page provides an overview of available translatable strings. Drupal displays translatable strings in text groups; modules may define additional text groups containing other translatable strings. Because text groups provide a method of grouping related strings, they are often used to focus translation efforts on specific areas of the Drupal interface.') . '</p>';
50
      $output .= '<p>' . t('Review the <a href="@languages">languages page</a> for more information on adding support for additional languages.', array('@languages' => url('admin/config/regional/language'))) . '</p>';
51
      return $output;
52
    case 'admin/config/regional/translate/import':
53
      $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>';
54
      $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://drupal.org/project/translations')) . '</p>';
55
      return $output;
56
    case 'admin/config/regional/translate/export':
57
      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>';
58 59
    case 'admin/config/regional/translate/translate':
      return '<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 found within a specific text group or in a specific language.', array('@export' => url('admin/config/regional/translate/export'))) . '</p>';
60
    case 'admin/structure/block/configure':
61
      if ($arg[4] == 'locale' && $arg[5] == 0) {
62
        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 something other than <em>None</em>.', array('@languages' => url('admin/config/regional/language'), '@configuration' => url('admin/config/regional/language/configure'))) . '</p>';
63 64
      }
      break;
Dries's avatar
 
Dries committed
65
  }
Dries's avatar
 
Dries committed
66 67
}

Dries's avatar
 
Dries committed
68
/**
69
 * Implement hook_menu().
Dries's avatar
 
Dries committed
70
 */
71
function locale_menu() {
72
  // Manage languages
73
  $items['admin/config/regional/language'] = array(
74
    'title' => 'Languages',
75
    'description' => 'Configure languages for content and the user interface.',
76 77
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_languages_overview_form'),
78
    'access arguments' => array('administer languages'),
79 80
    'file' => 'locale.inc',
    'file path' => 'includes',
81
  );
82
  $items['admin/config/regional/language/overview'] = array(
83
    'title' => 'List',
84 85 86
    'weight' => 0,
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
87
  $items['admin/config/regional/language/add'] = array(
88
    'title' => 'Add language',
89
    'page callback' => 'locale_languages_add_screen', // two forms concatenated
90
    'access arguments' => array('administer languages'),
91
    'weight' => 5,
92
    'type' => MENU_LOCAL_ACTION,
93 94
    'file' => 'locale.inc',
    'file path' => 'includes',
95
  );
96
  $items['admin/config/regional/language/configure'] = array(
97
    'title' => 'Configure',
98 99
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_languages_configure_form'),
100
    'access arguments' => array('administer languages'),
101
    'weight' => 10,
102 103
    'file' => 'locale.inc',
    'file path' => 'includes',
104 105
    'type' => MENU_LOCAL_TASK,
  );
106
  $items['admin/config/regional/language/edit/%'] = array(
107
    'title' => 'Edit language',
108
    'page callback' => 'drupal_get_form',
109
    'page arguments' => array('locale_languages_edit_form', 5),
110
    'access arguments' => array('administer languages'),
111 112
    'file' => 'locale.inc',
    'file path' => 'includes',
113 114
    'type' => MENU_CALLBACK,
  );
115
  $items['admin/config/regional/language/delete/%'] = array(
116
    'title' => 'Confirm',
117
    'page callback' => 'drupal_get_form',
118
    'page arguments' => array('locale_languages_delete_form', 5),
119
    'access arguments' => array('administer languages'),
120 121
    'file' => 'locale.inc',
    'file path' => 'includes',
122 123 124
    'type' => MENU_CALLBACK,
  );

125
  // Translation functionality
126
  $items['admin/config/regional/translate'] = array(
127
    'title' => 'Translate interface',
128
    'description' => 'Translate the built in interface and optionally other text.',
129 130
    'page callback' => 'locale_inc_callback',
    'page arguments' => array('locale_translate_overview_screen'), // not a form, just a table
131
    'access arguments' => array('translate interface'),
132 133
    'file' => 'locale.inc',
    'file path' => 'includes',
134
  );
135
  $items['admin/config/regional/translate/overview'] = array(
136
    'title' => 'Overview',
137 138 139
    'weight' => 0,
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
140
  $items['admin/config/regional/translate/translate'] = array(
141
    'title' => 'Translate',
142 143
    'weight' => 10,
    'type' => MENU_LOCAL_TASK,
144
    'page callback' => 'locale_translate_seek_screen', // search results and form concatenated
145
    'access arguments' => array('translate interface'),
146 147
    'file' => 'locale.inc',
    'file path' => 'includes',
148
  );
149
  $items['admin/config/regional/translate/import'] = array(
150
    'title' => 'Import',
151 152
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_translate_import_form'),
153
    'access arguments' => array('translate interface'),
154 155
    'weight' => 20,
    'type' => MENU_LOCAL_TASK,
156 157
    'file' => 'locale.inc',
    'file path' => 'includes',
158
  );
159
  $items['admin/config/regional/translate/export'] = array(
160
    'title' => 'Export',
161
    'page callback' => 'locale_translate_export_screen',  // possibly multiple forms concatenated
162
    'access arguments' => array('translate interface'),
163 164
    'weight' => 30,
    'type' => MENU_LOCAL_TASK,
165 166
    'file' => 'locale.inc',
    'file path' => 'includes',
167
  );
168
  $items['admin/config/regional/translate/edit/%'] = array(
169
    'title' => 'Edit string',
170
    'page callback' => 'drupal_get_form',
171
    'page arguments' => array('locale_translate_edit_form', 5),
172
    'access arguments' => array('translate interface'),
173
    'type' => MENU_CALLBACK,
174 175
    'file' => 'locale.inc',
    'file path' => 'includes',
176
  );
177
  $items['admin/config/regional/translate/delete/%'] = array(
178
    'title' => 'Delete string',
179
    'page callback' => 'locale_translate_delete_page',
180
    'page arguments' => array(5),
181
    'access arguments' => array('translate interface'),
182
    'type' => MENU_CALLBACK,
183 184
    'file' => 'locale.inc',
    'file path' => 'includes',
185
  );
Dries's avatar
 
Dries committed
186

Dries's avatar
 
Dries committed
187
  return $items;
Dries's avatar
 
Dries committed
188 189
}

190 191 192 193 194 195
/**
 * Wrapper function to be able to set callbacks in locale.inc
 */
function locale_inc_callback() {
  $args = func_get_args();
  $function = array_shift($args);
196
  include_once DRUPAL_ROOT . '/includes/locale.inc';
197 198 199
  return call_user_func_array($function, $args);
}

Dries's avatar
 
Dries committed
200
/**
201
 * Implement hook_permission().
Dries's avatar
 
Dries committed
202
 */
203
function locale_permission() {
204
  return array(
205 206 207 208 209 210 211 212
    'administer languages' => array(
      'title' => t('Administer languages'),
      'description' => t('Manage the languages in which the website content and interface text may be displayed.'),
    ),
    'translate interface' => array(
      'title' => t('Translate the interface'),
      'description' => t('Translate the text of the website interface.'),
    ),
213
  );
214 215 216
}

/**
217
 * Implement hook_locale().
218 219 220 221 222 223
 */
function locale_locale($op = 'groups') {
  switch ($op) {
    case 'groups':
      return array('default' => t('Built-in interface'));
  }
Dries's avatar
 
Dries committed
224 225 226
}

/**
227 228 229 230
 * Form builder callback to display language selection widget.
 *
 * @ingroup forms
 * @see locale_form_alter()
231
 */
232
function locale_language_selector_form(&$form, &$form_state, $user) {
233 234 235
  global $language;
  $languages = language_list('enabled');
  $languages = $languages[1];
236

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

240 241 242 243
  $names = array();
  foreach ($languages as $langcode => $item) {
    $name = t($item->name);
    $names[$langcode] = $name . ($item->native != $name ? ' (' . $item->native . ')' : '');
Dries's avatar
 
Dries committed
244
  }
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
  $form['locale'] = array(
    '#type' => 'fieldset',
    '#title' => t('Language settings'),
    '#weight' => 1,
  );

  // Get language negotiation settings.
  $mode = variable_get('language_negotiation', LANGUAGE_NEGOTIATION_NONE);
  $form['locale']['language'] = array(
    '#type' => (count($names) <= 5 ? 'radios' : 'select'),
    '#title' => t('Language'),
    '#default_value' => $user_preferred_language->language,
    '#options' => $names,
    '#description' => ($mode == LANGUAGE_NEGOTIATION_PATH) ? t("This account's default language for e-mails, and preferred language for site presentation.") : t("This account's default language for e-mails."),
  );
Dries's avatar
 
Dries committed
260 261
}

262
/**
263
 * Implement hook_form_FORM_ID_alter().
264 265 266 267 268 269 270 271 272 273 274 275 276
 */
function locale_form_path_admin_form_alter(&$form, &$form_state) {
  $form['language'] = array(
    '#type' => 'select',
    '#title' => t('Language'),
    '#options' => array('' => t('All languages')) + locale_language_list('name'),
    '#default_value' => $form['language']['#value'],
    '#weight' => -10,
    '#description' => t('A path alias set for a specific language will always be used when displaying this page in that language, and takes precedence over path aliases set for <em>All languages</em>.'),
  );
}

/**
277
 * Implement hook_form_FORM_ID_alter().
278
 */
279 280 281 282 283 284 285
function locale_form_node_type_form_alter(&$form, &$form_state) {
  if (isset($form['identity']['type'])) {
    $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')),
286
      '#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'))),
287 288 289
    );
  }
}
290

291
/**
292 293 294
 * Implement hook_form_alter().
 *
 * Adds language fields to forms.
295 296
 */
function locale_form_alter(&$form, &$form_state, $form_id) {
297 298 299 300 301 302 303 304
  // Only alter user forms if there is more than one language.
  if (variable_get('language_count', 1) > 1) {
    // Display language selector when either creating a user on the admin
    // interface or editing a user account.
    if (($form_id == 'user_register' && user_access('administer users')) || ($form_id == 'user_profile_form' && $form['#user_category'] == 'account')) {
      locale_language_selector_form($form, $form_state, $form['#user']);
    }
  }
305 306
  if (isset($form['#id']) && $form['#id'] == 'node-form') {
    if (isset($form['#node']->type) && variable_get('language_content_type_' . $form['#node']->type, 0)) {
307
      $form['language'] = array(
308
        '#type' => 'select',
309
        '#title' => t('Language'),
310 311
        '#default_value' => (isset($form['#node']->language) ? $form['#node']->language : ''),
        '#options' => array('' => t('Language neutral')) + locale_language_list('name'),
312
      );
313 314 315 316 317 318 319 320 321
    }
    // 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
      );
    }
322 323 324
  }
}

325
/**
326
 * Implement hook_theme().
327 328 329 330 331 332
 */
function locale_theme() {
  return array(
    'locale_languages_overview_form' => array(
      'arguments' => array('form' => array()),
    ),
333 334 335
    'locale_translation_filters' => array(
      'arguments' => array('form' => array()),
    ),
336 337
  );
}
338

Dries's avatar
 
Dries committed
339
// ---------------------------------------------------------------------------------
340
// Locale core functionality
Dries's avatar
 
Dries committed
341

Dries's avatar
 
Dries committed
342
/**
343
 * Provides interface translation services.
Dries's avatar
 
Dries committed
344 345
 *
 * This function is called from t() to translate a string if needed.
346 347 348
 *
 * @param $string
 *   A string to look up translation for. If omitted, all the
349
 *   cached strings will be returned in all languages already
350
 *   used on the page.
351 352
 * @param $context
 *   The context of this string.
353 354
 * @param $langcode
 *   Language code to use for the lookup.
355 356
 * @param $reset
 *   Set to TRUE to reset the in-memory cache.
Dries's avatar
 
Dries committed
357
 */
358
function locale($string = NULL, $context = NULL, $langcode = NULL, $reset = FALSE) {
359
  global $language;
Dries's avatar
 
Dries committed
360
  static $locale_t;
Dries's avatar
 
Dries committed
361

362 363
  if ($reset) {
    // Reset in-memory cache.
364
    $locale_t = NULL;
365
  }
366

367
  if (!isset($string)) {
368
    // Return all cached strings if no string was specified
369 370 371
    return $locale_t;
  }

372 373
  $langcode = isset($langcode) ? $langcode : $language->language;

374
  // Store database cached translations in a static var.
375 376
  if (!isset($locale_t[$langcode])) {
    $locale_t[$langcode] = array();
377 378 379
    // 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
380 381
    // interface for this. Be careful when turning this option off!
    if (variable_get('locale_cache_strings', 1) == 1) {
382
      if ($cache = cache_get('locale:' . $langcode, 'cache')) {
383 384
        $locale_t[$langcode] = $cache->data;
      }
385
      elseif (lock_acquire('locale_cache_' . $langcode)) {
386 387 388
        // 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.
389
        $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.textgroup = 'default' AND s.version = :version AND LENGTH(s.source) < 75", array(':language' => $langcode, ':version' => VERSION));
390
        foreach ($result as $data) {
391
          $locale_t[$langcode][$data->context][$data->source] = (empty($data->translation) ? TRUE : $data->translation);
392
        }
393
        cache_set('locale:' . $langcode, $locale_t[$langcode]);
394
        lock_release('locale_cache_' . $langcode);
395
      }
396
    }
Dries's avatar
 
Dries committed
397 398
  }

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

402
    // We do not have this translation cached, so get it from the DB.
403
    $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 AND s.textgroup = 'default'", array(
404 405
      ':language' => $langcode,
      ':source' => $string,
406
      ':context' => (string) $context,
407
    ))->fetchObject();
408 409
    if ($translation) {
      // We have the source string at least.
410
      // Cache translation string or TRUE if no translation exists.
411
      $locale_t[$langcode][$context][$string] = (empty($translation->translation) ? TRUE : $translation->translation);
412 413 414 415 416

      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.
417 418 419 420
        db_update('locales_source')
          ->fields(array('version' => VERSION))
          ->condition('lid', $translation->lid)
          ->execute();
421
        cache_clear_all('locale:', 'cache', TRUE);
422
      }
Dries's avatar
 
Dries committed
423 424
    }
    else {
425
      // We don't have the source string, cache this as untranslated.
426 427 428 429
      db_insert('locales_source')
        ->fields(array(
          'location' => request_uri(),
          'source' => $string,
430
          'context' => (string) $context,
431 432 433 434
          'textgroup' => 'default',
          'version' => VERSION,
        ))
        ->execute();
435
      $locale_t[$langcode][$context][$string] = TRUE;
436
      // Clear locale cache so this string can be added in a later request.
437
      cache_clear_all('locale:', 'cache', TRUE);
Dries's avatar
 
Dries committed
438
    }
Dries's avatar
 
Dries committed
439 440
  }

441
  return ($locale_t[$langcode][$context][$string] === TRUE ? $string : $locale_t[$langcode][$context][$string]);
Dries's avatar
 
Dries committed
442
}
Dries's avatar
 
Dries committed
443

Dries's avatar
 
Dries committed
444
/**
445
 * Returns plural form index for a specific number.
Dries's avatar
 
Dries committed
446
 *
447
 * The index is computed from the formula of this language.
448
 *
449 450 451 452 453
 * @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
454
 */
455
function locale_get_plural($count, $langcode = NULL) {
456
  global $language;
Dries's avatar
 
Dries committed
457 458
  static $locale_formula, $plurals = array();

459
  $langcode = $langcode ? $langcode : $language->language;
460

461
  if (!isset($plurals[$langcode][$count])) {
Dries's avatar
 
Dries committed
462
    if (!isset($locale_formula)) {
463 464
      $language_list = language_list();
      $locale_formula[$langcode] = $language_list[$langcode]->formula;
Dries's avatar
 
Dries committed
465
    }
466
    if ($locale_formula[$langcode]) {
Dries's avatar
 
Dries committed
467
      $n = $count;
468
      $plurals[$langcode][$count] = @eval('return intval(' . $locale_formula[$langcode] . ');');
469
      return $plurals[$langcode][$count];
Dries's avatar
 
Dries committed
470 471
    }
    else {
472
      $plurals[$langcode][$count] = -1;
Dries's avatar
 
Dries committed
473
      return -1;
474
    }
Dries's avatar
 
Dries committed
475
  }
476
  return $plurals[$langcode][$count];
477
}
Dries's avatar
 
Dries committed
478

479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496

/**
 * Returns a language name
 */
function locale_language_name($lang) {
  static $list = NULL;
  if (!isset($list)) {
    $list = locale_language_list();
  }
  return ($lang && isset($list[$lang])) ? $list[$lang] : t('All');
}

/**
 * Returns array of language names
 *
 * @param $field
 *   'name' => names in current language, localized
 *   'native' => native names
497 498
 * @param $all
 *   Boolean to return all languages or only enabled ones
499
 */
500 501 502 503 504 505 506 507
function locale_language_list($field = 'name', $all = FALSE) {
  if ($all) {
    $languages = language_list();
  }
  else {
    $languages = language_list('enabled');
    $languages = $languages[1];
  }
508
  $list = array();
509
  foreach ($languages as $language) {
510 511 512 513
    $list[$language->language] = ($field == 'name') ? t($language->name) : $language->$field;
  }
  return $list;
}
514 515 516 517 518 519 520 521 522 523 524 525

/**
 * Imports translations when new modules or themes are installed or enabled.
 *
 * 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.
 */
function locale_system_update($components) {
526
  include_once DRUPAL_ROOT . '/includes/locale.inc';
527
  if ($batch = locale_batch_by_component($components)) {
528 529 530 531
    batch_set($batch);
  }
}

532
/**
533
 * Implement hook_js_alter().
534 535 536 537 538 539
 *
 * 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.
 */
540
function locale_js_alter(&$javascript) {
541 542
  global $language;

543
  $dir = 'public://' . variable_get('locale_js_directory', 'languages');
544 545 546
  $parsed = variable_get('javascript_parsed', array());
  $files = $new_files = FALSE;

547 548 549 550 551 552 553 554 555 556 557
  foreach ($javascript as $item) {
    if ($item['type'] == 'file') {
      $files = TRUE;
      $filepath = $item['data'];
      if (!in_array($filepath, $parsed)) {
        // Don't parse our own translations files.
        if (substr($filepath, 0, strlen($dir)) != $dir) {
          locale_inc_callback('_locale_parse_js_file', $filepath);
          watchdog('locale', 'Parsed JavaScript file %file.', array('%file' => $filepath));
          $parsed[] = $filepath;
          $new_files = TRUE;
558 559 560 561 562 563 564 565 566 567 568 569 570
        }
      }
    }
  }

  // If there are any new source files we parsed, invalidate existing
  // JavaScript translation files for all languages, adding the refresh
  // flags into the existing array.
  if ($new_files) {
    $parsed += locale_inc_callback('_locale_invalidate_js');
  }

  // If necessary, rebuild the translation file for the current language.
571
  if (!empty($parsed['refresh:' . $language->language])) {
572 573 574
    // Don't clear the refresh flag on failure, so that another try will
    // be performed later.
    if (locale_inc_callback('_locale_rebuild_js')) {
575
      unset($parsed['refresh:' . $language->language]);
576 577 578 579 580 581
    }
    // Store any changes after refresh was attempted.
    variable_set('javascript_parsed', $parsed);
  }
  // If no refresh was attempted, but we have new source files, we need
  // to store them too. This occurs if current page is in English.
582
  elseif ($new_files) {
583 584 585 586 587
    variable_set('javascript_parsed', $parsed);
  }

  // Add the translation JavaScript file to the page.
  if ($files && !empty($language->javascript)) {
588 589 590
    // Add the translation JavaScript file to the page.
    $file = $dir . '/' . $language->language . '_' . $language->javascript . '.js';
    $javascript[$file] = drupal_js_defaults($file);
591 592 593
  }
}

594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620
/*
 * Implement hook_css_alter().
 *
 * This function checks all CSS files currently added via drupal_add_css() and
 * and checks to see if a related right to left CSS file should be included.
 */
function locale_css_alter(&$css) {
  global $language;

  // If the current language is RTL, add the CSS file with the RTL overrides.
  if ($language->direction == LANGUAGE_RTL) {
    foreach ($css as $data => $item) {
      // Only provide RTL overrides for files.
      if ($item['type'] == 'file') {
        $rtl_path = str_replace('.css', '-rtl.css', $item['data']);
        if (file_exists($rtl_path) && !isset($css[$rtl_path])) {
          // Replicate the same item, but with the RTL path and a little larger
          // weight so that it appears directly after the original CSS file.
          $item['data'] = $rtl_path;
          $item['weight'] += 0.01;
          $css[$rtl_path] = $item;
        }
      }
    }
  }
}

621 622 623 624
// ---------------------------------------------------------------------------------
// Language switcher block

/**
625
 * Implement hook_block_info().
626
 */
627
function locale_block_info() {
628 629
  $block['language-switcher']['info'] = t('Language switcher');
  // Not worth caching.
630
  $block['language-switcher']['cache'] = DRUPAL_NO_CACHE;
631 632
  return $block;
}
633

634
/**
635
 * Implement hook_block_view().
636 637 638 639 640 641 642
 *
 * Displays a language switcher. Translation links may be provided by other modules.
 * Only show if we have at least two languages and language dependent
 * web addresses, so we can actually link to other language versions.
 */
function locale_block_view($delta = '') {
  if (variable_get('language_count', 1) > 1 && variable_get('language_negotiation', LANGUAGE_NEGOTIATION_NONE) != LANGUAGE_NEGOTIATION_NONE) {
643
    $path = drupal_is_front_page() ? '<front>' : $_GET['q'];
644 645 646 647
    $languages = language_list('enabled');
    $links = array();
    foreach ($languages[1] as $language) {
      $links[$language->language] = array(
648
        'href'       => $path,
649 650
        'title'      => $language->native,
        'language'   => $language,
651
        'attributes' => array('class' => array('language-link')),
652 653
      );
    }
654

655
    // Allow modules to provide translations for specific links.
656
    drupal_alter('translation_link', $links, $path);
657

658
    $block['subject'] = t('Languages');
659
    $block['content'] = theme('links', array('links' => $links, 'attributes' => array()));
660 661 662
    return $block;
  }
}
663 664 665 666 667 668

/**
 * Theme locale translation filter selector.
 *
 * @ingroup themeable
 */
669 670
function theme_locale_translation_filters($variables) {
  $form = $variables['form'];
671
  $output = '';
672

673 674 675 676 677 678
  foreach (element_children($form['status']) as $key) {
    $output .= drupal_render($form['status'][$key]);
  }
  $output .= '<div id="locale-translation-buttons">' . drupal_render($form['buttons']) . '</div>';
  return $output;
}