locale.module 29.4 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
      $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>';
36
      $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>';
37
38
39
40
      $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>';
41
      $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
45
      $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. The site's default language is used for anonymous visitors and for users who have not selected a preferred language.") .'</p>';
      $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>';
46
      $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
      return $output;
48
    case 'admin/settings/language/add':
49
      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>';
50
    case 'admin/settings/language/configure':
51
      $output = '<p>'. t("Language negotiation settings determine the site's presentation language. Available options include:") .'</p>';
52
53
      $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>';
54
55
56
57
      $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.") .'</t>';
      $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>';
      return $output;
58
    case 'admin/build/translate':
59
60
      $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>';
61
      return $output;
62
    case 'admin/build/translate/import':
63
64
65
      $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 off-line editing in a Gettext translation editor. Importing an individual <em>.po</em> file may be a lengthy process.') .'</p>';
      $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>';
      return $output;
66
    case 'admin/build/translate/export':
67
      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>';
68
    case 'admin/build/translate/search':
69
      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 off-line 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>';
70
71
    case 'admin/build/block/configure':
      if ($arg[4] == 'locale' && $arg[5] == 0) {
72
        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>';
73
74
      }
      break;
Dries's avatar
   
Dries committed
75
  }
Dries's avatar
   
Dries committed
76
77
}

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

125
126
127
128
129
130
131
132
133
134
  // Translation functionality
  $items['admin/build/translate'] = array(
    'title' => 'Translate interface',
    'description' => 'Translate the built in interface as well as menu items and taxonomies.',
    'page callback' => 'locale_inc_callback',
    'page arguments' => array('locale_translate_overview_screen'), // not a form, just a table
    '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
143
    'page callback' => 'locale_inc_callback',
    'page arguments' => array('locale_translate_seek_screen'), // search results and form concatenated
144
  );
145
146
147
148
  $items['admin/build/translate/import'] = array(
    'title' => 'Import',
    'page callback' => 'locale_inc_callback',
    'page arguments' => array('drupal_get_form', 'locale_translate_import_form'),
149
150
151
    'weight' => 20,
    'type' => MENU_LOCAL_TASK,
  );
152
153
154
155
156
157
  $items['admin/build/translate/export'] = array(
    'title' => 'Export',
    'page callback' => 'locale_inc_callback',
    'page arguments' => array('locale_translate_export_screen'), // possibly multiple forms concatenated
    'weight' => 30,
    'type' => MENU_LOCAL_TASK,
158
  );
159
  $items['admin/build/translate/edit/%'] = array(
160
    'title' => 'Edit string',
161
162
    'page callback' => 'locale_inc_callback',
    'page arguments' => array('drupal_get_form', 'locale_translate_edit_form', 4),
163
164
    'type' => MENU_CALLBACK,
  );
165
  $items['admin/build/translate/delete/%'] = array(
166
    'title' => 'Delete string',
167
168
    'page callback' => 'locale_inc_callback',
    'page arguments' => array('locale_translate_delete', 4),  // directly deletes, no confirmation
169
170
    'type' => MENU_CALLBACK,
  );
Dries's avatar
   
Dries committed
171

Dries's avatar
   
Dries committed
172
  return $items;
Dries's avatar
   
Dries committed
173
174
}

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

Dries's avatar
   
Dries committed
185
/**
Dries's avatar
   
Dries committed
186
 * Implementation of hook_perm().
Dries's avatar
   
Dries committed
187
 */
Dries's avatar
   
Dries committed
188
function locale_perm() {
189
190
191
192
193
194
195
196
197
198
199
  return array('administer languages', 'translate interface');
}

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

/**
 * Implementation of hook_user().
 */
function locale_user($type, $edit, &$user, $category = NULL) {
206
207
208
209
210
  global $language;

  // 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 && ($type == 'register' && user_access('administer users') || $type == 'form' && $category == 'account' )) {
211
212
    $languages = language_list('enabled');
    $languages = $languages['1'];
213
214

    // If the user is being created, we set the user language to the page language.
215
    $user_preferred_language = $user ? user_preferred_language($user) : $language;
216

217
    $names = array();
218
219
220
    foreach ($languages as $langcode => $item) {
      $name = t($item->name);
      $names[$langcode] = $name . ($item->native != $name ? ' ('. $item->native .')' : '');
Dries's avatar
   
Dries committed
221
    }
222
223
224
    $form['locale'] = array(
      '#type' => 'fieldset',
      '#title' => t('Language settings'),
225
226
      '#weight' => 1,
    );
Dries's avatar
Dries committed
227

228
229
    $form['locale']['language'] = array(
      '#type' => 'radios',
230
      '#title' => t('Language'),
231
      '#default_value' => $user_preferred_language->language,
232
      '#options' => $names,
233
      '#description' => t('Sets the default site interface and e-mail language for this account.'),
234
    );
235
    return $form;
Dries's avatar
   
Dries committed
236
237
238
  }
}

239
240
241
/**
 * Implementation of hook_form_alter(). Adds language fields to forms.
 */
242
function locale_form_alter(&$form, $form_state, $form_id) {
243
  switch ($form_id) {
244
245

    // Language field for paths
246
    case 'path_admin_form':
247
      $form['language'] = array(
248
        '#type' => 'select',
249
250
        '#title' => t('Language'),
        '#options' => array('' => t('All languages')) + locale_language_list('name'),
251
252
        '#default_value' => $form['language']['#value'],
        '#weight' => -10,
253
        '#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 <am>All languages</em>.'),
254
255
      );
      break;
256
257
258
259
260
261
262
263
264

    // Language setting for content types
    case 'node_type_form':
      if (isset($form['identity']['type'])) {
        $form['workflow']['language'] = array(
          '#type' => 'radios',
          '#title' => t('Multilingual support'),
          '#default_value' => variable_get('language_'. $form['#node_type']->type, 0),
          '#options' => array(t('Disabled'), t('Enabled')),
265
          '#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'))),
266
267
268
269
270
271
        );
      }
      break;

    // Language field for nodes
    default:
272
      if (isset($form['#id']) && $form['#id'] == 'node-form') {
273
        if (isset($form['#node']->type) && variable_get('language_'. $form['#node']->type, 0)) {
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
          $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
          );
        }
      }
290
291
292
  }
}

293
294
295
296
297
298
299
300
301
302
/**
 * Implementation of hook_theme()
 */
function locale_theme() {
  return array(
    'locale_languages_overview_form' => array(
      'arguments' => array('form' => array()),
    ),
  );
}
303

Dries's avatar
   
Dries committed
304
// ---------------------------------------------------------------------------------
305
// Locale core functionality
Dries's avatar
   
Dries committed
306

Dries's avatar
   
Dries committed
307
/**
308
 * Provides interface translation services.
Dries's avatar
   
Dries committed
309
310
 *
 * This function is called from t() to translate a string if needed.
311
312
313
 *
 * @param $string
 *   A string to look up translation for. If omitted, all the
314
 *   cached strings will be returned in all languages already
315
316
317
 *   used on the page.
 * @param $langcode
 *   Language code to use for the lookup.
Dries's avatar
   
Dries committed
318
 */
319
function locale($string = NULL, $langcode = NULL) {
320
  global $language;
Dries's avatar
   
Dries committed
321
  static $locale_t;
Dries's avatar
   
Dries committed
322

323
324
325
326
327
  // Return all cached strings if no string was specified
  if (!isset($string)) {
    return $locale_t;
  }

328
329
  $langcode = isset($langcode) ? $langcode : $language->language;

330
  // Store database cached translations in a static var.
331
332
  if (!isset($locale_t[$langcode])) {
    $locale_t[$langcode] = array();
333
334
335
    // 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
336
337
    // interface for this. Be careful when turning this option off!
    if (variable_get('locale_cache_strings', 1) == 1) {
338
      if ($cache = cache_get('locale:'. $langcode, 'cache')) {
339
340
        $locale_t[$langcode] = $cache->data;
      }
341
342
343
344
345
346
347
348
349
350
      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);
        }
        cache_set('locale:'. $langcode, $locale_t[$langcode]);
      }
351
    }
Dries's avatar
   
Dries committed
352
353
  }

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

357
    // We do not have this translation cached, so get it from the DB.
358
    $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));
359
360
    if ($translation) {
      // We have the source string at least.
361
362
      // Cache translation string or TRUE if no translation exists.
      $locale_t[$langcode][$string] = (empty($translation->translation) ? TRUE : $translation->translation);
363
364
365
366
367

      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.
368
        db_query("UPDATE {locales_source} SET version = '%s' WHERE lid = %d", VERSION, $translation->lid);
369
        cache_clear_all('locale:', 'cache', TRUE);
370
      }
Dries's avatar
   
Dries committed
371
372
    }
    else {
373
      // We don't have the source string, cache this as untranslated.
374
      db_query("INSERT INTO {locales_source} (location, source, textgroup, version) VALUES ('%s', '%s', 'default', '%s')", request_uri(), $string, VERSION);
375
376
      $locale_t[$langcode][$string] = TRUE;
      // Clear locale cache so this string can be added in a later request.
377
      cache_clear_all('locale:', 'cache', TRUE);
Dries's avatar
   
Dries committed
378
    }
Dries's avatar
   
Dries committed
379
380
  }

381
  return ($locale_t[$langcode][$string] === TRUE ? $string : $locale_t[$langcode][$string]);
Dries's avatar
   
Dries committed
382
}
Dries's avatar
   
Dries committed
383

Dries's avatar
   
Dries committed
384
/**
385
 * Returns plural form index for a specific number.
Dries's avatar
   
Dries committed
386
 *
387
 * The index is computed from the formula of this language.
388
 *
389
390
391
392
393
 * @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
394
 */
395
function locale_get_plural($count, $langcode = NULL) {
396
  global $language;
Dries's avatar
   
Dries committed
397
398
  static $locale_formula, $plurals = array();

399
  $langcode = $langcode ? $langcode : $language->language;
400

401
  if (!isset($plurals[$langcode][$count])) {
Dries's avatar
   
Dries committed
402
    if (!isset($locale_formula)) {
403
404
      $language_list = language_list();
      $locale_formula[$langcode] = $language_list[$langcode]->formula;
Dries's avatar
   
Dries committed
405
    }
406
    if ($locale_formula[$langcode]) {
Dries's avatar
   
Dries committed
407
      $n = $count;
408
409
      $plurals[$langcode][$count] = @eval('return intval('. $locale_formula[$langcode] .');');
      return $plurals[$langcode][$count];
Dries's avatar
   
Dries committed
410
411
    }
    else {
412
      $plurals[$langcode][$count] = -1;
Dries's avatar
   
Dries committed
413
      return -1;
414
    }
Dries's avatar
   
Dries committed
415
  }
416
  return $plurals[$langcode][$count];
417
}
Dries's avatar
   
Dries committed
418

419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436

/**
 * 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
437
438
 * @param $all
 *   Boolean to return all languages or only enabled ones
439
 */
440
441
442
443
444
445
446
447
function locale_language_list($field = 'name', $all = FALSE) {
  if ($all) {
    $languages = language_list();
  }
  else {
    $languages = language_list('enabled');
    $languages = $languages[1];
  }
448
  $list = array();
449
  foreach ($languages as $language) {
450
451
452
453
    $list[$language->language] = ($field == 'name') ? t($language->name) : $language->$field;
  }
  return $list;
}
454
455
456
457
458
459
460
461
462
463
464
465
466

/**
 * 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) {
  include_once 'includes/locale.inc';
467
  if ($batch = locale_batch_by_component($components)) {
468
469
470
471
    batch_set($batch);
  }
}

472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
/**
 * 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());

  // The first three parameters are NULL in order to get an array with all
  // scopes. This is necessary to prevent recreation of JS translation files
  // when new files are added for example in the footer.
  $javascript = drupal_add_js(NULL, NULL, NULL);
  $files = $new_files = FALSE;

  foreach ($javascript as $scope) {
    foreach ($scope as $type => $data) {
      if ($type != 'setting' && $type != 'inline') {
        foreach ($data as $filepath => $info) {
          $files = TRUE;
          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;
            }
          }
        }
      }
    }
  }

  // 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.
  if (!empty($parsed['refresh:'. $language->language])) {
    // Don't clear the refresh flag on failure, so that another try will
    // be performed later.
    if (locale_inc_callback('_locale_rebuild_js')) {
      unset($parsed['refresh:'. $language->language]);
    }
    // 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.
  else if ($new_files) {
    variable_set('javascript_parsed', $parsed);
  }

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

540
541
542
543
544
545
546
547
548
549
// ---------------------------------------------------------------------------------
// Language switcher block

/**
 * Implementation of hook_block().
 * Displays a language switcher. Translation links may be provided by other modules.
 */
function locale_block($op = 'list', $delta = 0) {
  if ($op == 'list') {
    $block[0]['info'] = t('Language switcher');
550
551
    // Not worth caching.
    $block[0]['cache'] = BLOCK_NO_CACHE;
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
    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) {
    $languages = language_list('enabled');
    $links = array();
    foreach ($languages[1] as $language) {
      $links[$language->language] = array(
        'href'       => $_GET['q'],
        'title'      => $language->native,
        'language'   => $language,
        'attributes' => array('class' => 'language-link'),
      );
    }
568

569
570
571
572
573
    // 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.
    drupal_alter('translation_link', $links, $_GET['q']);
574

575
576
577
578
579
    $block['subject'] = t('Languages');
    $block['content'] = theme('links', $links, array());
    return $block;
  }
}