locale.module 30.8 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
20
/**
 * Implementation of hook_help().
 */
21
22
function locale_help($path, $arg) {
  switch ($path) {
23
    case 'admin/help#locale':
24
25
26
27
28
29
30
      $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>';
31
      return $output;
32
    case 'admin/settings/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/settings/language/add'), '@search' => url('admin/build/translate/translate'), '@import' => url('admin/build/translate/import'), '@translations' => 'http://drupal.org/project/translations')) . '</p>';
36
      $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>';
37
      return $output;
38
    case 'admin/settings/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/settings/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
46
      $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>';
47
      return $output;
48
    case 'admin/build/translate':
49
50
      $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>';
51
      return $output;
52
    case 'admin/build/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/settings/language/add'), '@translations' => 'http://drupal.org/project/translations')) . '</p>';
55
      return $output;
56
    case 'admin/build/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
    case 'admin/build/translate/translate':
59
      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>';
60
61
    case 'admin/build/block/configure':
      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/settings/language'), '@configuration' => url('admin/settings/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
/**
Dries's avatar
   
Dries committed
69
 * Implementation of hook_menu().
Dries's avatar
   
Dries committed
70
 */
71
function locale_menu() {
72
73
  // Manage languages
  $items['admin/settings/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
  $items['admin/settings/language/overview'] = array(
81
    'title' => 'List',
82
83
84
    'weight' => 0,
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
85
  $items['admin/settings/language/add'] = array(
86
    'title' => 'Add language',
87
    'page callback' => 'locale_languages_add_screen', // two forms concatenated
88
    'access arguments' => array('administer languages'),
89
90
91
    'weight' => 5,
    'type' => MENU_LOCAL_TASK,
  );
92
  $items['admin/settings/language/configure'] = array(
93
    'title' => 'Configure',
94
95
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_languages_configure_form'),
96
    'access arguments' => array('administer languages'),
97
98
99
    'weight' => 10,
    'type' => MENU_LOCAL_TASK,
  );
100
  $items['admin/settings/language/edit/%'] = array(
101
    'title' => 'Edit language',
102
103
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_languages_edit_form', 4),
104
    'access arguments' => array('administer languages'),
105
106
107
108
    'type' => MENU_CALLBACK,
  );
  $items['admin/settings/language/delete/%'] = array(
    'title' => 'Confirm',
109
110
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_languages_delete_form', 4),
111
    'access arguments' => array('administer languages'),
112
113
114
    'type' => MENU_CALLBACK,
  );

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

Dries's avatar
   
Dries committed
164
  return $items;
Dries's avatar
   
Dries committed
165
166
}

167
168
169
170
171
172
/**
 * Wrapper function to be able to set callbacks in locale.inc
 */
function locale_inc_callback() {
  $args = func_get_args();
  $function = array_shift($args);
173
  include_once DRUPAL_ROOT . '/includes/locale.inc';
174
175
176
  return call_user_func_array($function, $args);
}

Dries's avatar
   
Dries committed
177
/**
Dries's avatar
   
Dries committed
178
 * Implementation of hook_perm().
Dries's avatar
   
Dries committed
179
 */
Dries's avatar
   
Dries committed
180
function locale_perm() {
181
  return array(
182
183
184
185
186
187
188
189
    '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.'),
    ),
190
  );
191
192
193
194
195
196
197
198
199
200
}

/**
 * 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
201
202
203
}

/**
204
 * Implementation of hook_user_register().
Dries's avatar
   
Dries committed
205
 */
206
207
208
209
210
211
212
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);
  }
}
213

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

225
226
227
228
function locale_language_selector_form($user) {
  global $language;
  $languages = language_list('enabled');
  $languages = $languages[1];
229

230
231
  // 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
232

233
234
235
236
  $names = array();
  foreach ($languages as $langcode => $item) {
    $name = t($item->name);
    $names[$langcode] = $name . ($item->native != $name ? ' (' . $item->native . ')' : '');
Dries's avatar
   
Dries committed
237
  }
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
  $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
254
255
}

256
/**
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 * Implementation of hook_form_FORM_ID_alter().
 */
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>.'),
  );
}

/**
 * Implementation of hook_form_FORM_ID_alter().
272
 */
273
274
275
276
277
278
279
280
281
282
283
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')),
      '#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'))),
    );
  }
}
284

285
286
287
288
289
290
/**
 * Implementation of hook_form_alter(). Adds language fields to forms.
 */
function locale_form_alter(&$form, &$form_state, $form_id) {
  if (isset($form['#id']) && $form['#id'] == 'node-form') {
    if (isset($form['#node']->type) && variable_get('language_content_type_' . $form['#node']->type, 0)) {
291
      $form['language'] = array(
292
        '#type' => 'select',
293
        '#title' => t('Language'),
294
295
        '#default_value' => (isset($form['#node']->language) ? $form['#node']->language : ''),
        '#options' => array('' => t('Language neutral')) + locale_language_list('name'),
296
      );
297
298
299
300
301
302
303
304
305
    }
    // 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
      );
    }
306
307
308
  }
}

309
/**
310
 * Implementation of hook_theme().
311
312
313
314
315
316
 */
function locale_theme() {
  return array(
    'locale_languages_overview_form' => array(
      'arguments' => array('form' => array()),
    ),
317
318
319
    'locale_translation_filters' => array(
      'arguments' => array('form' => array()),
    ),
320
321
  );
}
322

Dries's avatar
   
Dries committed
323
// ---------------------------------------------------------------------------------
324
// Locale core functionality
Dries's avatar
   
Dries committed
325

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

344
345
  if ($reset) {
    // Reset in-memory cache.
346
    $locale_t = NULL;
347
  }
348

349
  if (!isset($string)) {
350
    // Return all cached strings if no string was specified
351
352
353
    return $locale_t;
  }

354
355
  $langcode = isset($langcode) ? $langcode : $language->language;

356
  // Store database cached translations in a static var.
357
358
  if (!isset($locale_t[$langcode])) {
    $locale_t[$langcode] = array();
359
360
361
    // 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
362
363
    // interface for this. Be careful when turning this option off!
    if (variable_get('locale_cache_strings', 1) == 1) {
364
      if ($cache = cache_get('locale:' . $langcode, 'cache')) {
365
366
        $locale_t[$langcode] = $cache->data;
      }
367
368
369
370
371
372
373
374
      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);
        }
375
        cache_set('locale:' . $langcode, $locale_t[$langcode]);
376
      }
377
    }
Dries's avatar
   
Dries committed
378
379
  }

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

383
    // We do not have this translation cached, so get it from the DB.
384
    $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));
385
386
    if ($translation) {
      // We have the source string at least.
387
388
      // Cache translation string or TRUE if no translation exists.
      $locale_t[$langcode][$string] = (empty($translation->translation) ? TRUE : $translation->translation);
389
390
391
392
393

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

407
  return ($locale_t[$langcode][$string] === TRUE ? $string : $locale_t[$langcode][$string]);
Dries's avatar
   
Dries committed
408
}
Dries's avatar
   
Dries committed
409

Dries's avatar
   
Dries committed
410
/**
411
 * Returns plural form index for a specific number.
Dries's avatar
   
Dries committed
412
 *
413
 * The index is computed from the formula of this language.
414
 *
415
416
417
418
419
 * @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
420
 */
421
function locale_get_plural($count, $langcode = NULL) {
422
  global $language;
Dries's avatar
   
Dries committed
423
424
  static $locale_formula, $plurals = array();

425
  $langcode = $langcode ? $langcode : $language->language;
426

427
  if (!isset($plurals[$langcode][$count])) {
Dries's avatar
   
Dries committed
428
    if (!isset($locale_formula)) {
429
430
      $language_list = language_list();
      $locale_formula[$langcode] = $language_list[$langcode]->formula;
Dries's avatar
   
Dries committed
431
    }
432
    if ($locale_formula[$langcode]) {
Dries's avatar
   
Dries committed
433
      $n = $count;
434
      $plurals[$langcode][$count] = @eval('return intval(' . $locale_formula[$langcode] . ');');
435
      return $plurals[$langcode][$count];
Dries's avatar
   
Dries committed
436
437
    }
    else {
438
      $plurals[$langcode][$count] = -1;
Dries's avatar
   
Dries committed
439
      return -1;
440
    }
Dries's avatar
   
Dries committed
441
  }
442
  return $plurals[$langcode][$count];
443
}
Dries's avatar
   
Dries committed
444

445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462

/**
 * 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
463
464
 * @param $all
 *   Boolean to return all languages or only enabled ones
465
 */
466
467
468
469
470
471
472
473
function locale_language_list($field = 'name', $all = FALSE) {
  if ($all) {
    $languages = language_list();
  }
  else {
    $languages = language_list('enabled');
    $languages = $languages[1];
  }
474
  $list = array();
475
  foreach ($languages as $language) {
476
477
478
479
    $list[$language->language] = ($field == 'name') ? t($language->name) : $language->$field;
  }
  return $list;
}
480
481
482
483
484
485
486
487
488
489
490
491

/**
 * 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) {
492
  include_once DRUPAL_ROOT . '/includes/locale.inc';
493
  if ($batch = locale_batch_by_component($components)) {
494
495
496
497
    batch_set($batch);
  }
}

498
/**
499
 * Implementation of hook_js_alter().
500
501
502
503
504
505
 *
 * 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.
 */
506
function locale_js_alter(&$javascript) {
507
508
509
510
511
512
  global $language;

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

513
514
515
516
517
518
519
520
521
522
523
  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;
524
525
526
527
528
529
530
531
532
533
534
535
536
        }
      }
    }
  }

  // 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.
537
  if (!empty($parsed['refresh:' . $language->language])) {
538
539
540
    // Don't clear the refresh flag on failure, so that another try will
    // be performed later.
    if (locale_inc_callback('_locale_rebuild_js')) {
541
      unset($parsed['refresh:' . $language->language]);
542
543
544
545
546
547
    }
    // 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.
548
  elseif ($new_files) {
549
550
551
552
553
    variable_set('javascript_parsed', $parsed);
  }

  // Add the translation JavaScript file to the page.
  if ($files && !empty($language->javascript)) {
554
555
556
    // Add the translation JavaScript file to the page.
    $file = $dir . '/' . $language->language . '_' . $language->javascript . '.js';
    $javascript[$file] = drupal_js_defaults($file);
557
558
559
  }
}

560
561
562
563
// ---------------------------------------------------------------------------------
// Language switcher block

/**
564
 * Implementation of hook_block_list().
565
 */
566
567
568
569
570
571
function locale_block_list() {
  $block['language-switcher']['info'] = t('Language switcher');
  // Not worth caching.
  $block['language-switcher']['cache'] = BLOCK_NO_CACHE;
  return $block;
}
572

573
574
575
576
577
578
579
580
581
/**
 * Implementation of hook_block_view().
 *
 * 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) {
582
    $path = drupal_is_front_page() ? '<front>' : $_GET['q'];
583
584
585
586
    $languages = language_list('enabled');
    $links = array();
    foreach ($languages[1] as $language) {
      $links[$language->language] = array(
587
        'href'       => $path,
588
589
590
591
592
        'title'      => $language->native,
        'language'   => $language,
        'attributes' => array('class' => 'language-link'),
      );
    }
593

594
    // Allow modules to provide translations for specific links.
595
    drupal_alter('translation_link', $links, $path);
596

597
598
599
600
601
    $block['subject'] = t('Languages');
    $block['content'] = theme('links', $links, array());
    return $block;
  }
}
602
603
604
605
606
607
608
609
610
611
612
613
614
615

/**
 * Theme locale translation filter selector.
 *
 * @ingroup themeable
 */
function theme_locale_translation_filters($form) {
  $output = '';
  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;
}