locale.module 30.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 17 18 19 20 21 22 23 24 25
/**
 * Language written left to right. Possible value of $language->direction.
 */
define('LANGUAGE_LTR', 0);

/**
 * Language written right to left. Possible value of $language->direction.
 */
define('LANGUAGE_RTL', 1);


Dries's avatar
 
Dries committed
26
// ---------------------------------------------------------------------------------
27
// Hook implementations
Dries's avatar
 
Dries committed
28

Dries's avatar
 
Dries committed
29 30 31
/**
 * Implementation of hook_help().
 */
32 33
function locale_help($path, $arg) {
  switch ($path) {
34
    case 'admin/help#locale':
35 36 37 38 39 40 41
      $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>';
      $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/build/translate/import'), '@export' => url('admin/build/translate/export'))) . '</p>';
      $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>';
42
      return $output;
43
    case 'admin/settings/language':
44
      $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>';
45 46
      $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>';
      $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/settings/language/add'), '@search' => url('admin/build/translate/search'), '@import' => url('admin/build/translate/import'), '@translations' => 'http://drupal.org/project/translations')) . '</p>';
47
      $output .= '<p>' . t('To rearrange languages, grab a drag-and-drop handle under the <em>English name</em> column and drag the item to a new location in the list. (Grab a handle by clicking and holding the mouse while hovering over a handle icon.) Remember that your changes will not be saved until you click the <em>Save configuration</em> button at the bottom of the page.') . '</p>';
48
      return $output;
49
    case 'admin/settings/language/add':
50
      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>';
51
    case 'admin/settings/language/configure':
52 53 54
      $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>';
55
      $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>';
56 57
      $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>';
      $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/settings/language'))) . '</p>';
58
      return $output;
59
    case 'admin/build/translate':
60 61
      $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>';
      $output .= '<p>' . t('Review the <a href="@languages">languages page</a> for more information on adding support for additional languages.', array('@languages' => url('admin/settings/language'))) . '</p>';
62
      return $output;
63
    case 'admin/build/translate/import':
64
      $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>';
65
      $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/settings/language/add'), '@translations' => 'http://drupal.org/project/translations')) . '</p>';
66
      return $output;
67
    case 'admin/build/translate/export':
68
      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>';
69
    case 'admin/build/translate/search':
70
      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/build/translate/export'))) . '</p>';
71 72
    case 'admin/build/block/configure':
      if ($arg[4] == 'locale' && $arg[5] == 0) {
73
        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/settings/language'), '@configuration' => url('admin/settings/language/configure'))) . '</p>';
74 75
      }
      break;
Dries's avatar
 
Dries committed
76
  }
Dries's avatar
 
Dries committed
77 78
}

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

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

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

178 179 180 181 182 183
/**
 * Wrapper function to be able to set callbacks in locale.inc
 */
function locale_inc_callback() {
  $args = func_get_args();
  $function = array_shift($args);
184
  include_once DRUPAL_ROOT . '/includes/locale.inc';
185 186 187
  return call_user_func_array($function, $args);
}

Dries's avatar
 
Dries committed
188
/**
Dries's avatar
 
Dries committed
189
 * Implementation of hook_perm().
Dries's avatar
 
Dries committed
190
 */
Dries's avatar
 
Dries committed
191
function locale_perm() {
192
  return array(
193 194 195 196 197 198 199 200
    '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.'),
    ),
201
  );
202 203 204 205 206 207 208 209 210 211
}

/**
 * Implementation of hook_locale().
 */
function locale_locale($op = 'groups') {
  switch ($op) {
    case 'groups':
      return array('default' => t('Built-in interface'));
  }
Dries's avatar
 
Dries committed
212 213 214
}

/**
215
 * Implementation of hook_user_register().
Dries's avatar
 
Dries committed
216
 */
217 218 219 220 221 222 223
function locale_user_register(&$edit, &$user, $category = NULL) {
  // If we have more then one language and either creating a user on the
  // admin interface or edit the user, show the language selector.
  if (variable_get('language_count', 1) > 1 && user_access('administer users')) {
    return locale_language_selector_form($user);
  }
}
224

225 226 227 228
/**
 * Implementation of hook_user_form().
 */
function locale_user_form(&$edit, &$user, $category = NULL) {
229 230
  // If we have more then one language and either creating a user on the
  // admin interface or edit the user, show the language selector.
231 232 233 234
  if (variable_get('language_count', 1) > 1 && $category == 'account') {
    return locale_language_selector_form($user);
  }
}
235

236 237 238 239
function locale_language_selector_form($user) {
  global $language;
  $languages = language_list('enabled');
  $languages = $languages[1];
240

241 242
  // If the user is being created, we set the user language to the page language.
  $user_preferred_language = $user ? user_preferred_language($user) : $language;
Dries's avatar
Dries committed
243

244 245 246 247
  $names = array();
  foreach ($languages as $langcode => $item) {
    $name = t($item->name);
    $names[$langcode] = $name . ($item->native != $name ? ' (' . $item->native . ')' : '');
Dries's avatar
 
Dries committed
248
  }
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
  $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."),
  );
  return $form;
Dries's avatar
 
Dries committed
265 266
}

267 268 269
/**
 * Implementation of hook_form_alter(). Adds language fields to forms.
 */
270
function locale_form_alter(&$form, $form_state, $form_id) {
271
  switch ($form_id) {
272 273

    // Language field for paths
274
    case 'path_admin_form':
275
      $form['language'] = array(
276
        '#type' => 'select',
277 278
        '#title' => t('Language'),
        '#options' => array('' => t('All languages')) + locale_language_list('name'),
279 280
        '#default_value' => $form['language']['#value'],
        '#weight' => -10,
281
        '#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>.'),
282 283
      );
      break;
284 285 286 287

    // Language setting for content types
    case 'node_type_form':
      if (isset($form['identity']['type'])) {
288
        $form['workflow']['language_content_type'] = array(
289 290
          '#type' => 'radios',
          '#title' => t('Multilingual support'),
291
          '#default_value' => variable_get('language_content_type_' . $form['#node_type']->type, 0),
292
          '#options' => array(t('Disabled'), t('Enabled')),
293
          '#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/settings/language'))),
294 295 296 297 298 299
        );
      }
      break;

    // Language field for nodes
    default:
300
      if (isset($form['#id']) && $form['#id'] == 'node-form') {
301
        if (isset($form['#node']->type) && variable_get('language_content_type_' . $form['#node']->type, 0)) {
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
          $form['language'] = array(
            '#type' => 'select',
            '#title' => t('Language'),
            '#default_value' => (isset($form['#node']->language) ? $form['#node']->language : ''),
            '#options' => array('' => 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
          );
        }
      }
318 319 320
  }
}

321
/**
322
 * Implementation of hook_theme().
323 324 325 326 327 328 329 330
 */
function locale_theme() {
  return array(
    'locale_languages_overview_form' => array(
      'arguments' => array('form' => array()),
    ),
  );
}
331

Dries's avatar
 
Dries committed
332
// ---------------------------------------------------------------------------------
333
// Locale core functionality
Dries's avatar
 
Dries committed
334

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

353 354
  if ($reset) {
    // Reset in-memory cache.
355
    $locale_t = NULL;
356
  }
357

358
  if (!isset($string)) {
359
    // Return all cached strings if no string was specified
360 361 362
    return $locale_t;
  }

363 364
  $langcode = isset($langcode) ? $langcode : $language->language;

365
  // Store database cached translations in a static var.
366 367
  if (!isset($locale_t[$langcode])) {
    $locale_t[$langcode] = array();
368 369 370
    // 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
371 372
    // interface for this. Be careful when turning this option off!
    if (variable_get('locale_cache_strings', 1) == 1) {
373
      if ($cache = cache_get('locale:' . $langcode, 'cache')) {
374 375
        $locale_t[$langcode] = $cache->data;
      }
376 377 378 379 380 381 382 383
      else {
        // 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.
        $result = db_query("SELECT s.source, t.translation, t.language FROM {locales_source} s LEFT JOIN {locales_target} t ON s.lid = t.lid AND t.language = '%s' WHERE s.textgroup = 'default' AND s.version = '%s' AND LENGTH(s.source) < 75", $langcode, VERSION);
        while ($data = db_fetch_object($result)) {
          $locale_t[$langcode][$data->source] = (empty($data->translation) ? TRUE : $data->translation);
        }
384
        cache_set('locale:' . $langcode, $locale_t[$langcode]);
385
      }
386
    }
Dries's avatar
 
Dries committed
387 388
  }

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

392
    // We do not have this translation cached, so get it from the DB.
393
    $translation = db_fetch_object(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 = '%s' WHERE s.source = '%s' AND s.textgroup = 'default'", $langcode, $string));
394 395
    if ($translation) {
      // We have the source string at least.
396 397
      // Cache translation string or TRUE if no translation exists.
      $locale_t[$langcode][$string] = (empty($translation->translation) ? TRUE : $translation->translation);
398 399 400 401 402

      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.
403
        db_query("UPDATE {locales_source} SET version = '%s' WHERE lid = %d", VERSION, $translation->lid);
404
        cache_clear_all('locale:', 'cache', TRUE);
405
      }
Dries's avatar
 
Dries committed
406 407
    }
    else {
408
      // We don't have the source string, cache this as untranslated.
409
      db_query("INSERT INTO {locales_source} (location, source, textgroup, version) VALUES ('%s', '%s', 'default', '%s')", request_uri(), $string, VERSION);
410 411
      $locale_t[$langcode][$string] = TRUE;
      // Clear locale cache so this string can be added in a later request.
412
      cache_clear_all('locale:', 'cache', TRUE);
Dries's avatar
 
Dries committed
413
    }
Dries's avatar
 
Dries committed
414 415
  }

416
  return ($locale_t[$langcode][$string] === TRUE ? $string : $locale_t[$langcode][$string]);
Dries's avatar
 
Dries committed
417
}
Dries's avatar
 
Dries committed
418

Dries's avatar
 
Dries committed
419
/**
420
 * Returns plural form index for a specific number.
Dries's avatar
 
Dries committed
421
 *
422
 * The index is computed from the formula of this language.
423
 *
424 425 426 427 428
 * @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
429
 */
430
function locale_get_plural($count, $langcode = NULL) {
431
  global $language;
Dries's avatar
 
Dries committed
432 433
  static $locale_formula, $plurals = array();

434
  $langcode = $langcode ? $langcode : $language->language;
435

436
  if (!isset($plurals[$langcode][$count])) {
Dries's avatar
 
Dries committed
437
    if (!isset($locale_formula)) {
438 439
      $language_list = language_list();
      $locale_formula[$langcode] = $language_list[$langcode]->formula;
Dries's avatar
 
Dries committed
440
    }
441
    if ($locale_formula[$langcode]) {
Dries's avatar
 
Dries committed
442
      $n = $count;
443
      $plurals[$langcode][$count] = @eval('return intval(' . $locale_formula[$langcode] . ');');
444
      return $plurals[$langcode][$count];
Dries's avatar
 
Dries committed
445 446
    }
    else {
447
      $plurals[$langcode][$count] = -1;
Dries's avatar
 
Dries committed
448
      return -1;
449
    }
Dries's avatar
 
Dries committed
450
  }
451
  return $plurals[$langcode][$count];
452
}
Dries's avatar
 
Dries committed
453

454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471

/**
 * 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
472 473
 * @param $all
 *   Boolean to return all languages or only enabled ones
474
 */
475 476 477 478 479 480 481 482
function locale_language_list($field = 'name', $all = FALSE) {
  if ($all) {
    $languages = language_list();
  }
  else {
    $languages = language_list('enabled');
    $languages = $languages[1];
  }
483
  $list = array();
484
  foreach ($languages as $language) {
485 486 487 488
    $list[$language->language] = ($field == 'name') ? t($language->name) : $language->$field;
  }
  return $list;
}
489 490 491 492 493 494 495 496 497 498 499 500

/**
 * 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) {
501
  include_once DRUPAL_ROOT . '/includes/locale.inc';
502
  if ($batch = locale_batch_by_component($components)) {
503 504 505 506
    batch_set($batch);
  }
}

507 508 509 510 511 512 513 514 515 516 517 518 519 520
/**
 * Update JavaScript translation file, if required, and add it to the page.
 *
 * 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.
 */
function locale_update_js_files() {
  global $language;

  $dir = file_create_path(variable_get('locale_js_directory', 'languages'));
  $parsed = variable_get('javascript_parsed', array());

521 522
  // Get an array of all the JavaScript added so far.
  $javascript = drupal_add_js();
523 524
  $files = $new_files = FALSE;

525 526 527 528 529 530 531 532 533 534 535
  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;
536 537 538 539 540 541 542 543 544 545 546 547 548
        }
      }
    }
  }

  // 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.
549
  if (!empty($parsed['refresh:' . $language->language])) {
550 551 552
    // Don't clear the refresh flag on failure, so that another try will
    // be performed later.
    if (locale_inc_callback('_locale_rebuild_js')) {
553
      unset($parsed['refresh:' . $language->language]);
554 555 556 557 558 559
    }
    // 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.
560
  elseif ($new_files) {
561 562 563 564 565
    variable_set('javascript_parsed', $parsed);
  }

  // Add the translation JavaScript file to the page.
  if ($files && !empty($language->javascript)) {
566
    drupal_add_js($dir . '/' . $language->language . '_' . $language->javascript . '.js');
567 568 569
  }
}

570 571 572 573 574 575 576
// ---------------------------------------------------------------------------------
// Language switcher block

/**
 * Implementation of hook_block().
 * Displays a language switcher. Translation links may be provided by other modules.
 */
577
function locale_block($op = 'list', $delta = '') {
578
  if ($op == 'list') {
579
    $block['language-switcher']['info'] = t('Language switcher');
580
    // Not worth caching.
581
    $block['language-switcher']['cache'] = BLOCK_NO_CACHE;
582 583 584 585 586 587
    return $block;
  }

  // Only show if we have at least two languages and language dependent
  // web addresses, so we can actually link to other language versions.
  elseif ($op == 'view' && variable_get('language_count', 1) > 1 && variable_get('language_negotiation', LANGUAGE_NEGOTIATION_NONE) != LANGUAGE_NEGOTIATION_NONE) {
588
    $path = drupal_is_front_page() ? '<front>' : $_GET['q'];
589 590 591 592
    $languages = language_list('enabled');
    $links = array();
    foreach ($languages[1] as $language) {
      $links[$language->language] = array(
593
        'href'       => $path,
594 595 596 597 598
        'title'      => $language->native,
        'language'   => $language,
        'attributes' => array('class' => 'language-link'),
      );
    }
599

600 601 602 603
    // Allow modules to provide translations for specific links.
    // A translation link may need to point to a different path or use
    // a translated link text before going through l(), which will just
    // handle the path aliases.
604
    drupal_alter('translation_link', $links, $path);
605

606 607 608 609 610
    $block['subject'] = t('Languages');
    $block['content'] = theme('links', $links, array());
    return $block;
  }
}