locale.module 22.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 you to present your Drupal site in a language other than the default English. You can use it to set up a multi-lingual website or replace given <em>built-in</em> text with text which has been customized for your site. Whenever the locale module encounters text which needs to be displayed, it tries to translate it into the currently selected language. If a translation is not available, then the string is remembered, so you can look up untranslated strings easily.') .'</p>';
36
      $output .= '<p>'. t('The locale module provides two options for providing translations. The first is the integrated web interface, via which you can search for untranslated strings, and specify their translations. An easier and less time-consuming method is to import existing translations for your language. These translations are available as <em>GNU gettext Portable Object files</em> (<em>.po</em> files for short). Translations for many languages are available for download from the translation page.') .'</p>';
37
      $output .= '<p>'. t("If an existing translation does not meet your needs, the <em>.po</em> files are easily edited with special editing tools. The locale module's import feature allows you to add strings from such files into your site's database. The export functionality enables you to share your translations with others, generating Portable Object files from your site strings.") .'</p>';
38
      $output .= '<p>'. t('For more information please read the configuration and customization handbook <a href="@locale">Locale page</a>.', array('@locale' => 'http://drupal.org/handbook/modules/locale/')) .'</p>';
39
      return $output;
40
41
42
43

    case 'admin/settings/language':
      return t("<p>Drupal provides support for the translation of its interface text into different languages. This page provides an overview of the installed languages. You can add a language on the <a href=\"@add-language\">add language page</a>, or directly by <a href=\"@import\">importing a translation</a>. If multiple languages are enabled, registered users will be able to set their preferred language. The site default will be used for anonymous visitors and for users without their own settings.</p><p>Drupal interface translations may be added or extended by several courses: by <a href=\"@import\">importing</a> an existing translation, by <a href=\"@search\">translating everything</a> from scratch, or by a combination of these approaches.</p>", array("@search" => url("admin/build/translate/search"), "@import" => url("admin/build/translate/import"), "@add-language" => url("admin/settings/language/add")));
    case 'admin/settings/language/add':
44
      return '<p>'. t("You need to add all languages in which you would like to display the site interface. If you can't find the desired language in the quick-add dropdown, then you will need to provide the proper language code yourself. The language code may be used to negotiate with browsers and to present flags, etc., so it is important to pick a code that is standardized for the desired language. You can also add a language by <a href=\"@import\">importing a translation</a>.", array("@import" => url("admin/build/translate/import"))) .'</p>';
45
46
47
48
    case 'admin/settings/language/configure':
      return '<p>'. t('The language used to display a web page is determined with a negotiation algorithm. You can choose how this algorithm should work. By default, there is no negotiation and the default language is used. You can use path prefixes (like "de" and "it" for German and Italian content) with different fallback options, so you can have web addresses like /de/contact and /it/contact. Alternatively you can use custom domains like de.example.com and it.example.com. Customize path prefixes and set domain names on the <a href="@languages">language editing pages</a>.', array('@languages' => url('admin/settings/language'))) .'</p>';

    case 'admin/build/translate':
49
      return '<p>'. t("This page provides an overview of interface translation on the site. Drupal groups all translatable strings in so called 'text groups'. Modules may provide more text groups additionaly to the 'built-in interface' default, to separate strings used for other purposes, allowing you to focus your translation efforts on the groups of text you care most about. For example, a translation team could choose not to fully translate a text group that includes less important data, being still able to ensure that built-in interface is always fully translated.") .'</p>';
50
    case 'admin/build/translate/import':
51
      return '<p>'. t("This page allows you to import a translation provided in the gettext Portable Object (.po) format. The easiest way to get your site translated is to obtain an existing Drupal translation and to import it. You can find existing translations on the <a href=\"@url\">Drupal translation page</a>. Note that importing a translation file might take a while.", array('@url' => 'http://drupal.org/project/translations')) .'</p>';
52
    case 'admin/build/translate/export':
53
      return '<p>'. t("This page allows you to export Drupal strings. The first option is to export a translation so it can be shared. The second option generates a translation template, which contains all Drupal strings, but without their translations. You can use this template to start a new translation using various software packages designed for this task.") .'</p>';
54
55
    case 'admin/build/translate/search':
      return '<p>'. t("It is often convenient to get the strings from your setup on the <a href=\"@export\">export page</a>, and use a desktop Gettext translation editor to edit the translations. On this page you can search in the translated and untranslated strings, and the default English texts provided by Drupal.", array("@export" => url("admin/build/translate/export"))) .'</p>';
56

57
58
59
60
61
    case 'admin/build/block/configure':
      if ($arg[4] == 'locale' && $arg[5] == 0) {
        return '<p>'. t("This block is only shown if you have <a href=\"@languages\">at least two languages enabled</a> and you have a <a href=\"@configuration\">language negotiation setting</a> different from 'none', so you have different web addresses for different language versions.", array('@languages' => url('admin/settings/language'), '@configuration' => url('admin/settings/language/configure'))) .'</p>';
      }
      break;
Dries's avatar
   
Dries committed
62
  }
Dries's avatar
   
Dries committed
63
64
}

Dries's avatar
   
Dries committed
65
/**
Dries's avatar
   
Dries committed
66
 * Implementation of hook_menu().
67
68
69
 *
 * Locale module only provides administrative menu items, so all
 * menu items are invoked through locale_inc_callback().
Dries's avatar
   
Dries committed
70
 */
71
function locale_menu() {
72
73
  // Manage languages
  $items['admin/settings/language'] = array(
74
    'title' => 'Languages',
75
76
77
78
    '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'),
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
88
    'page callback' => 'locale_inc_callback',
    'page arguments' => array('locale_languages_add_screen'), // two forms concatenated
89
90
91
    'weight' => 5,
    'type' => MENU_LOCAL_TASK,
  );
92
  $items['admin/settings/language/configure'] = array(
93
    'title' => 'Configure',
94
95
    'page callback' => 'locale_inc_callback',
    'page arguments' => array('drupal_get_form', 'locale_languages_configure_form'),
96
97
98
    'weight' => 10,
    'type' => MENU_LOCAL_TASK,
  );
99
  $items['admin/settings/language/edit/%'] = array(
100
    'title' => 'Edit language',
101
102
103
104
105
106
107
108
    '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),
109
110
111
    'type' => MENU_CALLBACK,
  );

112
113
114
115
116
117
118
119
120
121
  // 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',
122
123
124
    'weight' => 0,
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
125
126
  $items['admin/build/translate/search'] = array(
    'title' => 'Search',
127
128
    'weight' => 10,
    'type' => MENU_LOCAL_TASK,
129
130
    'page callback' => 'locale_inc_callback',
    'page arguments' => array('locale_translate_seek_screen'), // search results and form concatenated
131
  );
132
133
134
135
  $items['admin/build/translate/import'] = array(
    'title' => 'Import',
    'page callback' => 'locale_inc_callback',
    'page arguments' => array('drupal_get_form', 'locale_translate_import_form'),
136
137
138
    'weight' => 20,
    'type' => MENU_LOCAL_TASK,
  );
139
140
141
142
143
144
  $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,
145
  );
146
  $items['admin/build/translate/edit/%'] = array(
147
    'title' => 'Edit string',
148
149
    'page callback' => 'locale_inc_callback',
    'page arguments' => array('drupal_get_form', 'locale_translate_edit_form', 4),
150
151
    'type' => MENU_CALLBACK,
  );
152
  $items['admin/build/translate/delete/%'] = array(
153
    'title' => 'Delete string',
154
155
    'page callback' => 'locale_inc_callback',
    'page arguments' => array('locale_translate_delete', 4),  // directly deletes, no confirmation
156
157
    'type' => MENU_CALLBACK,
  );
Dries's avatar
   
Dries committed
158

Dries's avatar
   
Dries committed
159
  return $items;
Dries's avatar
   
Dries committed
160
161
}

162
163
164
165
166
167
168
169
170
171
/**
 * 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
172
/**
Dries's avatar
   
Dries committed
173
 * Implementation of hook_perm().
Dries's avatar
   
Dries committed
174
 */
Dries's avatar
   
Dries committed
175
function locale_perm() {
176
177
178
179
180
181
182
183
184
185
186
  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
187
188
189
190
191
192
}

/**
 * Implementation of hook_user().
 */
function locale_user($type, $edit, &$user, $category = NULL) {
193
194
195
196
197
  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' )) {
198
199
    $languages = language_list('enabled');
    $languages = $languages['1'];
200
201

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

204
    $names = array();
205
    foreach ($languages as $langcode => $language) {
206
      $names[$langcode] = t($language->name) .' ('. $language->native .')';
Dries's avatar
   
Dries committed
207
    }
208
209
210
    $form['locale'] = array(
      '#type' => 'fieldset',
      '#title' => t('Language settings'),
211
212
      '#weight' => 1,
    );
Dries's avatar
Dries committed
213

214
215
    $form['locale']['language'] = array(
      '#type' => 'radios',
216
      '#title' => t('Language'),
217
      '#default_value' => $user_preferred_language->language,
218
      '#options' => $names,
219
      '#description' => t('Sets the default site interface and e-mail language for this account.'),
220
    );
221
    return $form;
Dries's avatar
   
Dries committed
222
223
224
  }
}

225
226
227
/**
 * Implementation of hook_form_alter(). Adds language fields to forms.
 */
228
function locale_form_alter(&$form, $form_state, $form_id) {
229
  switch ($form_id) {
230
231

    // Language field for paths
232
233
    case 'path_admin_edit':
      $form['language'] = array(
234
        '#type' => 'select',
235
236
        '#title' => t('Language'),
        '#options' => array('' => t('All languages')) + locale_language_list('name'),
237
238
239
        '#default_value' => $form['language']['#value'],
        '#weight' => -10,
        '#description' => t('Path aliases added for languages take precedence over path aliases added for all languages for the same Drupal path.'),
240
241
      );
      break;
242
243
244
245
246
247
248
249
250

    // 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')),
251
          '#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'))),
252
253
254
255
256
257
        );
      }
      break;

    // Language field for nodes
    default:
258
      if (isset($form['#id']) && $form['#id'] == 'node-form') {
259
        if (isset($form['#node']->type) && variable_get('language_'. $form['#node']->type, 0)) {
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
          $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
          );
        }
      }
276
277
278
  }
}

279
280
281
282
283
284
285
286
287
288
/**
 * Implementation of hook_theme()
 */
function locale_theme() {
  return array(
    'locale_languages_overview_form' => array(
      'arguments' => array('form' => array()),
    ),
  );
}
289

Dries's avatar
   
Dries committed
290
// ---------------------------------------------------------------------------------
291
// Locale core functionality
Dries's avatar
   
Dries committed
292

Dries's avatar
   
Dries committed
293
/**
294
 * Provides interface translation services.
Dries's avatar
   
Dries committed
295
296
 *
 * This function is called from t() to translate a string if needed.
297
298
299
 *
 * @param $string
 *   A string to look up translation for. If omitted, all the
300
 *   cached strings will be returned in all languages already
301
302
303
 *   used on the page.
 * @param $langcode
 *   Language code to use for the lookup.
Dries's avatar
   
Dries committed
304
 */
305
function locale($string = NULL, $langcode = NULL) {
306
  global $language;
Dries's avatar
   
Dries committed
307
  static $locale_t;
Dries's avatar
   
Dries committed
308

309
310
311
312
313
  // Return all cached strings if no string was specified
  if (!isset($string)) {
    return $locale_t;
  }

314
315
  $langcode = isset($langcode) ? $langcode : $language->language;

316
  // Store database cached translations in a static var.
317
318
  if (!isset($locale_t[$langcode])) {
    $locale_t[$langcode] = array();
319
320
321
    // 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
322
323
    // interface for this. Be careful when turning this option off!
    if (variable_get('locale_cache_strings', 1) == 1) {
324
      if ($cache = cache_get('locale:'. $langcode, 'cache')) {
325
326
        $locale_t[$langcode] = $cache->data;
      }
327
328
329
330
331
332
333
334
335
336
      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]);
      }
337
    }
Dries's avatar
   
Dries committed
338
339
  }

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

343
    // We do not have this translation cached, so get it from the DB.
344
    $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));
345
346
    if ($translation) {
      // We have the source string at least.
347
348
      // Cache translation string or TRUE if no translation exists.
      $locale_t[$langcode][$string] = (empty($translation->translation) ? TRUE : $translation->translation);
349
350
351
352
353

      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.
354
        db_query("UPDATE {locales_source} SET version = '%s' WHERE lid = %d", VERSION, $translation->lid);
355
        cache_clear_all('locale:', 'cache', TRUE);
356
      }
Dries's avatar
   
Dries committed
357
358
    }
    else {
359
      // We don't have the source string, cache this as untranslated.
360
      db_query("INSERT INTO {locales_source} (location, source, textgroup, version) VALUES ('%s', '%s', 'default', '%s')", request_uri(), $string, VERSION);
361
362
      $locale_t[$langcode][$string] = TRUE;
      // Clear locale cache so this string can be added in a later request.
363
      cache_clear_all('locale:', 'cache', TRUE);
Dries's avatar
   
Dries committed
364
    }
Dries's avatar
   
Dries committed
365
366
  }

367
  return ($locale_t[$langcode][$string] === TRUE ? $string : $locale_t[$langcode][$string]);
Dries's avatar
   
Dries committed
368
}
Dries's avatar
   
Dries committed
369

Dries's avatar
   
Dries committed
370
/**
371
 * Returns plural form index for a specific number.
Dries's avatar
   
Dries committed
372
 *
373
 * The index is computed from the formula of this language.
374
 *
375
376
377
378
379
 * @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
380
 */
381
function locale_get_plural($count, $langcode = NULL) {
382
  global $language;
Dries's avatar
   
Dries committed
383
384
  static $locale_formula, $plurals = array();

385
  $langcode = $langcode ? $langcode : $language->language;
386

387
  if (!isset($plurals[$langcode][$count])) {
Dries's avatar
   
Dries committed
388
    if (!isset($locale_formula)) {
389
390
      $language_list = language_list();
      $locale_formula[$langcode] = $language_list[$langcode]->formula;
Dries's avatar
   
Dries committed
391
    }
392
    if ($locale_formula[$langcode]) {
Dries's avatar
   
Dries committed
393
      $n = $count;
394
395
      $plurals[$langcode][$count] = @eval('return intval('. $locale_formula[$langcode] .');');
      return $plurals[$langcode][$count];
Dries's avatar
   
Dries committed
396
397
    }
    else {
398
      $plurals[$langcode][$count] = -1;
Dries's avatar
   
Dries committed
399
      return -1;
400
    }
Dries's avatar
   
Dries committed
401
  }
402
  return $plurals[$langcode][$count];
403
}
Dries's avatar
   
Dries committed
404

405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422

/**
 * 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
423
424
 * @param $all
 *   Boolean to return all languages or only enabled ones
425
 */
426
427
428
429
430
431
432
433
function locale_language_list($field = 'name', $all = FALSE) {
  if ($all) {
    $languages = language_list();
  }
  else {
    $languages = language_list('enabled');
    $languages = $languages[1];
  }
434
  $list = array();
435
  foreach ($languages as $language) {
436
437
438
439
    $list[$language->language] = ($field == 'name') ? t($language->name) : $language->$field;
  }
  return $list;
}
440
441
442
443
444
445
446
447
448
449
450
451
452

/**
 * 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';
453
  if ($batch = locale_batch_by_component($components)) {
454
455
456
457
    batch_set($batch);
  }
}

458
459
460
461
462
463
464
465
466
467
// ---------------------------------------------------------------------------------
// 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');
468
469
    // Not worth caching.
    $block[0]['cache'] = BLOCK_NO_CACHE;
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
    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'),
      );
    }
486

487
488
489
490
491
    // 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']);
492

493
494
495
496
497
    $block['subject'] = t('Languages');
    $block['content'] = theme('links', $links, array());
    return $block;
  }
}