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

Dries's avatar
   
Dries committed
4
5
/**
 * @file
6
7
 *   Add language handling functionality and enables the translation of the
 *   user interface to languages other than English.
Dries's avatar
   
Dries committed
8
 *
9
10
11
12
 *   When enabled, multiple languages can be set up. The site interface
 *   can be displayed in different languages, as well as nodes can have languages
 *   assigned. The setup of languages and translations is completely web based.
 *   Gettext portable object files are supported.
Dries's avatar
   
Dries committed
13
14
 */

15
16
17
18
19
20
21
22
23
24
25
/**
 * Language written left to right. Possible value of $language->direction.
 */
define('LANGUAGE_LTR', 0);

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


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

Dries's avatar
   
Dries committed
29
30
31
/**
 * Implementation of hook_help().
 */
32
function locale_help($section) {
Dries's avatar
   
Dries committed
33
  switch ($section) {
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
44
45
46
47
48
49
50
51
52

    case 'admin/settings/language':
    case 'admin/settings/language/overview':
      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':
      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 standardised 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>';
    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':
    case 'admin/build/translate/overview':
      return '<p>'. t("This page provides an overview of interface translation on the site. Drupal groups all translatable strings in so called 'text groups'. Text groups are useful, because you can focus your translation efforts on the groups of text you care most about.  For example, a translation team could choose not to fully translate the text group that includes all the long help texts on the administration pages. Similarly, text groups are useful to ensure that certain aspects of the site are always fully translated.") . '</p>';
    case 'admin/build/translate/import':
53
      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>';
54
    case 'admin/build/translate/export':
55
      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>';
56
57
    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>';
Dries's avatar
   
Dries committed
58
  }
Dries's avatar
   
Dries committed
59
60
}

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

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

Dries's avatar
   
Dries committed
155
  return $items;
Dries's avatar
   
Dries committed
156
157
}

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

/**
 * Implementation of hook_user().
 */
function locale_user($type, $edit, &$user, $category = NULL) {
189
190
191
  if ($type == 'form' && $category == 'account' && variable_get('language_count', 1) > 1 && variable_get('language_negotiation', LANGUAGE_NEGOTIATION_NONE) == LANGUAGE_NEGOTIATION_PATH) {
    $languages = language_list('enabled');
    $languages = $languages['1'];
Dries's avatar
   
Dries committed
192
    if ($user->language == '') {
193
194
195
196
      $default = language_default();
      $user->language = $default->language;
    }
    $names = array();
197
    foreach ($languages as $langcode => $language) {
198
      $names[$langcode] = t($language->name) .' ('. $language->native .')';
Dries's avatar
   
Dries committed
199
    }
200
201
202
203
204
205
206
    $form['locale'] = array('#type' => 'fieldset',
      '#title' => t('Interface language settings'),
      '#weight' => 1,
    );
    $form['locale']['language'] = array('#type' => 'radios',
      '#title' => t('Language'),
      '#default_value' => $user->language,
207
      '#options' => $names,
208
209
      '#description' => t('Selecting a different locale will change the interface language of the site.'),
    );
210
    return $form;
Dries's avatar
   
Dries committed
211
212
213
  }
}

214
215
216
/**
 * Implementation of hook_form_alter(). Adds language fields to forms.
 */
217
function locale_form_alter(&$form, $form_id) {
218
  switch ($form_id) {
219
220

    // Language field for paths
221
222
    case 'path_admin_edit':
      $form['language'] = array(
223
        '#type' => 'select',
224
225
        '#title' => t('Language'),
        '#options' => array('' => t('All languages')) + locale_language_list('name'),
226
227
228
        '#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.'),
229
230
      );
      break;
231
232
233
234
235
236
237
238
239

    // 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')),
240
          '#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'))),
241
242
243
244
245
246
247
        );
      }
      break;

    // Language field for nodes
    default:
      if ($form['#id'] == 'node-form') {
248
        if (isset($form['#node']->type) && variable_get('language_' . $form['#node']->type, 0)) {
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
          $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
          );
        }
      }
265
266
267
  }
}

268
269
270
271
272
273
274
275
276
277
/**
 * Implementation of hook_theme()
 */
function locale_theme() {
  return array(
    'locale_languages_overview_form' => array(
      'arguments' => array('form' => array()),
    ),
  );
}
278

Dries's avatar
   
Dries committed
279
// ---------------------------------------------------------------------------------
280
// Locale core functionality
Dries's avatar
   
Dries committed
281

Dries's avatar
   
Dries committed
282
/**
283
 * Provides interface translation services.
Dries's avatar
   
Dries committed
284
285
286
 *
 * This function is called from t() to translate a string if needed.
 */
287
function locale($string, $langcode = NULL) {
288
  global $language;
Dries's avatar
   
Dries committed
289
  static $locale_t;
Dries's avatar
   
Dries committed
290

291
292
  $langcode = isset($langcode) ? $langcode : $language->language;

293
  // Store database cached translations in a static var.
294
295
296
  if (!isset($locale_t[$langcode])) {
    $locale_t[$langcode] = array();
    if (!($cache = cache_get('locale:'. $langcode, 'cache'))) {
Dries's avatar
   
Dries committed
297
      locale_refresh_cache();
298
      $cache = cache_get('locale:'. $langcode, 'cache');
Dries's avatar
   
Dries committed
299
    }
300
    if ($cache) {
301
      $locale_t[$langcode] = $cache->data;
302
    }
Dries's avatar
   
Dries committed
303
304
  }

Dries's avatar
   
Dries committed
305
306
  // We have the translation cached (if it is TRUE, then there is no
  // translation, so there is no point in checking the database)
307
308
  if (isset($locale_t[$langcode][$string])) {
    $string = ($locale_t[$langcode][$string] === TRUE ? $string : $locale_t[$langcode][$string]);
Dries's avatar
   
Dries committed
309
  }
Dries's avatar
   
Dries committed
310

311
  // We do not have this translation cached, so get it from the DB.
Dries's avatar
   
Dries committed
312
  else {
313
    $result = db_query("SELECT s.lid, t.translation FROM {locales_source} s INNER JOIN {locales_target} t ON s.lid = t.lid WHERE s.source = '%s' AND t.language = '%s' AND s.textgroup = 'default'", $string, $langcode);
Dries's avatar
   
Dries committed
314
315
316
    // Translation found
    if ($trans = db_fetch_object($result)) {
      if (!empty($trans->translation)) {
317
        $locale_t[$langcode][$string] = $trans->translation;
Dries's avatar
   
Dries committed
318
        $string = $trans->translation;
319
      }
Dries's avatar
   
Dries committed
320
    }
Dries's avatar
   
Dries committed
321

Dries's avatar
   
Dries committed
322
323
    // Either we have no such source string, or no translation
    else {
324
      $result = db_query("SELECT lid, source FROM {locales_source} WHERE source = '%s' AND textgroup = 'default'", $string);
Dries's avatar
   
Dries committed
325
326
      // We have no such translation
      if ($obj = db_fetch_object($result)) {
327
328
        if ($langcode) {
          db_query("INSERT INTO {locales_target} (lid, language, translation) VALUES (%d, '%s', '')", $obj->lid, $langcode);
Dries's avatar
   
Dries committed
329
330
331
        }
      }
      // We have no such source string
332
      else {
333
        db_query("INSERT INTO {locales_source} (location, source, textgroup) VALUES ('%s', '%s', 'default')", request_uri(), $string);
334
        if ($langcode) {
335
          $lid = db_fetch_object(db_query("SELECT lid FROM {locales_source} WHERE source = '%s' AND textgroup = 'default'", $string));
336
          db_query("INSERT INTO {locales_target} (lid, language, translation) VALUES (%d, '%s', '')", $lid->lid, $langcode);
Dries's avatar
   
Dries committed
337
        }
338
      }
Dries's avatar
   
Dries committed
339
      // Clear locale cache in DB
340
      cache_clear_all('locale:'. $langcode, 'cache');
Dries's avatar
   
Dries committed
341
    }
Dries's avatar
   
Dries committed
342
343
  }

Dries's avatar
   
Dries committed
344
345
  return $string;
}
Dries's avatar
   
Dries committed
346

Dries's avatar
   
Dries committed
347
/**
348
 * Refreshes database stored cache of translations.
Dries's avatar
   
Dries committed
349
350
351
352
 *
 * We only store short strings to improve performance and consume less memory.
 */
function locale_refresh_cache() {
353
354
  $languages = language_list('enabled');
  $languages = $languages['1'];
Dries's avatar
   
Dries committed
355

356
  foreach ($languages as $language) {
357
    $result = db_query("SELECT s.source, t.translation, t.language FROM {locales_source} s INNER JOIN {locales_target} t ON s.lid = t.lid WHERE t.language = '%s' AND s.textgroup = 'default' AND LENGTH(s.source) < 75", $language->language);
358
    $t = array();
Dries's avatar
   
Dries committed
359
360
    while ($data = db_fetch_object($result)) {
      $t[$data->source] = (empty($data->translation) ? TRUE : $data->translation);
Dries's avatar
   
Dries committed
361
    }
362
    cache_set('locale:'. $language->language, $t);
Dries's avatar
   
Dries committed
363
364
365
  }
}

Dries's avatar
   
Dries committed
366
/**
367
 * Returns plural form index for a specific number.
Dries's avatar
   
Dries committed
368
 *
369
 * The index is computed from the formula of this language.
Dries's avatar
   
Dries committed
370
371
 */
function locale_get_plural($count) {
372
  global $language;
Dries's avatar
   
Dries committed
373
374
375
376
  static $locale_formula, $plurals = array();

  if (!isset($plurals[$count])) {
    if (!isset($locale_formula)) {
377
      $locale_formula = $language->formula;
Dries's avatar
   
Dries committed
378
379
380
381
382
383
384
385
386
    }
    if ($locale_formula) {
      $n = $count;
      $plurals[$count] = @eval("return intval($locale_formula);");
      return $plurals[$count];
    }
    else {
      $plurals[$count] = -1;
      return -1;
387
    }
Dries's avatar
   
Dries committed
388
  }
Dries's avatar
   
Dries committed
389
  return $plurals[$count];
390
}
Dries's avatar
   
Dries committed
391

392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409

/**
 * 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
410
411
 * @param $all
 *   Boolean to return all languages or only enabled ones
412
 */
413
414
415
416
417
418
419
420
function locale_language_list($field = 'name', $all = FALSE) {
  if ($all) {
    $languages = language_list();
  }
  else {
    $languages = language_list('enabled');
    $languages = $languages[1];
  }
421
  $list = array();
422
  foreach ($languages as $language) {
423
424
425
426
    $list[$language->language] = ($field == 'name') ? t($language->name) : $language->$field;
  }
  return $list;
}
427
428
429
430
431
432
433
434
435
436
437
438
439

/**
 * 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';
440
  if ($batch = locale_batch_by_component($components)) {
441
442
443
444
445
446
447
448
449
450
451
452
453
454
    batch_set($batch);
  }
}

/**
 * Finished callback of system page locale import batch.
 * Inform the user of translation files imported.
 */
function _locale_batch_system_finished($success, $results) {
  if ($success) {
    drupal_set_message(format_plural(count($results), 'One translation file imported for the newly installed modules.', '@count translation files imported for the newly installed modules.'));
  }
}

455
456
457
458
459
460
461
462
463
464
/**
 * Finished callback of language addition locale import batch.
 * Inform the user of translation files imported.
 */
function _locale_batch_language_finished($success, $results) {
  if ($success) {
    drupal_set_message(format_plural(count($results), 'One translation file imported for the enabled modules.', '@count translation files imported for the enabled modules.'));
  }
}

465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
/**
 * Perform interface translation import as a batch step.
 *
 * @param $filepath
 *   Path to a file to import.
 * @param $results
 *   Contains a list of files imported.
 */
function _locale_batch_import($filepath, &$context) {
  include_once 'includes/locale.inc';
  // The filename is either {langcode}.po or {prefix}.{langcode}.po, so
  // we can extract the language code to use for the import from the end.
  if (preg_match('!(/|\.)([^\.]+)\.po$!', $filepath, $langcode)) {
    $file = (object) array('filename' => basename($filepath), 'filepath' => $filepath);
    _locale_import_read_po('db-store', $file, 'keep', $langcode[2]);
    $context['results'][] = $filepath;
  }
}