locale.module 20.7 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 6 7 8 9
/**
 * @file
 * Enables administrators to manage the site interface languages.
 *
 * When enabled, the site interface can be displayed in different
 * languages. The setup of languages and translations is completely
10
 * web based. Gettext portable object files are supported.
Dries's avatar
 
Dries committed
11 12 13 14
 */

// ---------------------------------------------------------------------------------
// Hook implementations (needed on all page loads)
Dries's avatar
 
Dries committed
15

Dries's avatar
 
Dries committed
16 17 18
/**
 * Implementation of hook_help().
 */
19
function locale_help($section) {
Dries's avatar
 
Dries committed
20
  switch ($section) {
21
    case 'admin/help#locale':
22
      $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>';
23
      $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>';
24
      $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>';
25
      $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>';
26
      return $output;
27
    case 'admin/build/locale':
28
    case 'admin/build/locale/language':
29 30 31 32 33
    case 'admin/build/locale/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/locale/string/search"), "@import" => url("admin/build/locale/language/import"), "@add-language" => url("admin/build/locale/language/add")));
    case 'admin/build/locale/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/locale/language/import"))) .'</p>';
    case 'admin/build/locale/language/import':
34
      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>';
35
    case 'admin/build/locale/language/export':
36
      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>';
37
    case 'admin/build/locale/string':
38 39
    case 'admin/build/locale/string/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/locale/language/export"))) .'</p>';
40 41
    case 'admin/build/locale/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/build/locale/language/overview'))) .'</p>';
Dries's avatar
 
Dries committed
42
  }
Dries's avatar
 
Dries committed
43 44
}

Dries's avatar
 
Dries committed
45
/**
Dries's avatar
 
Dries committed
46
 * Implementation of hook_menu().
Dries's avatar
 
Dries committed
47
 */
48 49
function locale_menu() {
  // Main admin menu item
50
  $items['admin/build/locale'] = array(
51 52
    'title' => t('Languages'),
    'description' => t('Configure languages and user interface translation.'),
53 54 55 56 57
    'page callback' => 'locale_admin_manage',
    'access arguments' => array('administer locales'),
  );

  // Top level tabs
58
  $items['admin/build/locale/language'] = array(
59 60 61 62
    'title' => t('Manage languages'),
    'weight' => -10,
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
63 64
  $items['admin/build/locale/string'] = array(
    'title' => t('Manage interface strings'),
65 66 67
    'page callback' => 'locale_string_search',
    'weight' => 10,
    'type' => MENU_LOCAL_TASK,
68
    'parent' => 'admin/build/locale',
69 70 71
  );

  // Manage languages subtabs
72
  $items['admin/build/locale/language/overview'] = array(
73 74 75 76
    'title' => t('List'),
    'weight' => 0,
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
77
  $items['admin/build/locale/language/add'] = array(
78 79 80 81 82
    'title' => t('Add language'),
    'page callback' => 'locale_admin_manage_add',
    'weight' => 5,
    'type' => MENU_LOCAL_TASK,
  );
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
  $items['admin/build/locale/language/configure'] = array(
    'title' => t('Configure'),
    'page callback' => 'locale_admin_manage_configure',
    'weight' => 10,
    'type' => MENU_LOCAL_TASK,
  );
  $items['admin/build/locale/language/edit/%'] = array(
    'title' => t('Edit language'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_admin_manage_edit', 5),
    'type' => MENU_CALLBACK,
  );

  // Manage interface translations subtabs
  $items['admin/build/locale/string/search'] = array(
    'title' => t('Search'),
    'weight' => 0,
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
  $items['admin/build/locale/string/import'] = array(
103 104 105 106 107
    'title' => t('Import'),
    'page callback' => 'locale_admin_import',
    'weight' => 10,
    'type' => MENU_LOCAL_TASK,
  );
108
  $items['admin/build/locale/string/export'] = array(
109 110 111 112 113 114 115
    'title' => t('Export'),
    'page callback' => 'locale_admin_export',
    'weight' => 20,
    'type' => MENU_LOCAL_TASK,
  );

  // Language related callbacks
116
  $items['admin/build/locale/language/delete'] = array(
117 118 119 120 121 122
    'title' => t('Confirm'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_admin_manage_delete_form'),
    'type' => MENU_CALLBACK,
  );
  // String related callbacks
123
  $items['admin/build/locale/string/edit/%'] = array(
124 125 126 127 128
    'title' => t('Edit string'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_admin_string_edit', 5),
    'type' => MENU_CALLBACK,
  );
129
  $items['admin/build/locale/string/delete/%'] = array(
130 131 132 133 134
    'title' => t('Delete string'),
    'page callback' => 'locale_admin_string_delete',
    'page arguments' => array(5),
    'type' => MENU_CALLBACK,
  );
Dries's avatar
 
Dries committed
135

Dries's avatar
 
Dries committed
136
  return $items;
Dries's avatar
 
Dries committed
137 138
}

Dries's avatar
 
Dries committed
139
/**
Dries's avatar
 
Dries committed
140
 * Implementation of hook_perm().
Dries's avatar
 
Dries committed
141
 */
Dries's avatar
 
Dries committed
142 143 144 145 146 147 148 149
function locale_perm() {
  return array('administer locales');
}

/**
 * Implementation of hook_user().
 */
function locale_user($type, $edit, &$user, $category = NULL) {
150 151 152
  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
153
    if ($user->language == '') {
154 155 156 157
      $default = language_default();
      $user->language = $default->language;
    }
    $names = array();
158
    foreach ($languages as $langcode => $language) {
159
      $names[$langcode] = t($language->name) .' ('. $language->native .')';
Dries's avatar
 
Dries committed
160
    }
161 162 163 164 165 166 167
    $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,
168
      '#options' => $names,
169 170
      '#description' => t('Selecting a different locale will change the interface language of the site.'),
    );
171
    return $form;
Dries's avatar
 
Dries committed
172 173 174
  }
}

175 176 177
/**
 * Implementation of hook_form_alter(). Adds language fields to forms.
 */
178
function locale_form_alter(&$form, $form_id) {
179
  switch ($form_id) {
180 181

    // Language field for paths
182 183
    case 'path_admin_edit':
      $form['language'] = array(
184
        '#type' => 'select',
185 186
        '#title' => t('Language'),
        '#options' => array('' => t('All languages')) + locale_language_list('name'),
187 188 189
        '#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.'),
190 191
      );
      break;
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225

    // 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')),
          '#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/build/locale'))),
        );
      }
      break;

    // Language field for nodes
    default:
      if ($form['#id'] == 'node-form') {
        if (variable_get('language_' . $form['#node']->type, 0)) {
          $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
          );
        }
      }
226 227 228 229
  }
}


Dries's avatar
 
Dries committed
230 231
// ---------------------------------------------------------------------------------
// Locale core functionality (needed on all page loads)
Dries's avatar
 
Dries committed
232

Dries's avatar
 
Dries committed
233
/**
234
 * Provides interface translation services.
Dries's avatar
 
Dries committed
235 236 237 238
 *
 * This function is called from t() to translate a string if needed.
 */
function locale($string) {
239
  global $language;
Dries's avatar
 
Dries committed
240
  static $locale_t;
Dries's avatar
 
Dries committed
241

242
  // Store database cached translations in a static var.
Dries's avatar
 
Dries committed
243
  if (!isset($locale_t)) {
244
    if (!($cache = cache_get('locale:'. $language->language, 'cache'))) {
Dries's avatar
 
Dries committed
245
      locale_refresh_cache();
246
      $cache = cache_get('locale:'. $language->language, 'cache');
Dries's avatar
 
Dries committed
247
    }
248
    $locale_t = $cache->data;
Dries's avatar
 
Dries committed
249 250
  }

Dries's avatar
 
Dries committed
251 252 253 254 255
  // We have the translation cached (if it is TRUE, then there is no
  // translation, so there is no point in checking the database)
  if (isset($locale_t[$string])) {
    $string = ($locale_t[$string] === TRUE ? $string : $locale_t[$string]);
  }
Dries's avatar
 
Dries committed
256

257
  // We do not have this translation cached, so get it from the DB.
Dries's avatar
 
Dries committed
258
  else {
259
    $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'", $string, $language->language);
Dries's avatar
 
Dries committed
260 261 262 263 264
    // Translation found
    if ($trans = db_fetch_object($result)) {
      if (!empty($trans->translation)) {
        $locale_t[$string] = $trans->translation;
        $string = $trans->translation;
265
      }
Dries's avatar
 
Dries committed
266
    }
Dries's avatar
 
Dries committed
267

Dries's avatar
 
Dries committed
268 269 270 271 272
    // Either we have no such source string, or no translation
    else {
      $result = db_query("SELECT lid, source FROM {locales_source} WHERE source = '%s'", $string);
      // We have no such translation
      if ($obj = db_fetch_object($result)) {
273 274
        if ($language) {
          db_query("INSERT INTO {locales_target} (lid, language, translation) VALUES (%d, '%s', '')", $obj->lid, $language->language);
Dries's avatar
 
Dries committed
275 276 277
        }
      }
      // We have no such source string
278
      else {
Dries's avatar
 
Dries committed
279
        db_query("INSERT INTO {locales_source} (location, source) VALUES ('%s', '%s')", request_uri(), $string);
280
        if ($language) {
281
          $lid = db_fetch_object(db_query("SELECT lid FROM {locales_source} WHERE source = '%s'", $string));
282
          db_query("INSERT INTO {locales_target} (lid, language, translation) VALUES (%d, '%s', '')", $lid->lid, $language->language);
Dries's avatar
 
Dries committed
283
        }
284
      }
Dries's avatar
 
Dries committed
285
      // Clear locale cache in DB
286
      cache_clear_all('locale:'. $language->language, 'cache');
Dries's avatar
 
Dries committed
287
    }
Dries's avatar
 
Dries committed
288 289
  }

Dries's avatar
 
Dries committed
290 291
  return $string;
}
Dries's avatar
 
Dries committed
292

Dries's avatar
 
Dries committed
293
/**
294
 * Refreshes database stored cache of translations.
Dries's avatar
 
Dries committed
295 296 297 298
 *
 * We only store short strings to improve performance and consume less memory.
 */
function locale_refresh_cache() {
299 300
  $languages = language_list('enabled');
  $languages = $languages['1'];
Dries's avatar
 
Dries committed
301

302 303
  foreach ($languages as $language) {
    $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 LENGTH(s.source) < 75", $language->language);
304
    $t = array();
Dries's avatar
 
Dries committed
305 306
    while ($data = db_fetch_object($result)) {
      $t[$data->source] = (empty($data->translation) ? TRUE : $data->translation);
Dries's avatar
 
Dries committed
307
    }
308
    cache_set('locale:'. $language->language, $t);
Dries's avatar
 
Dries committed
309 310 311
  }
}

Dries's avatar
 
Dries committed
312
/**
313
 * Returns plural form index for a specific number.
Dries's avatar
 
Dries committed
314
 *
315
 * The index is computed from the formula of this language.
Dries's avatar
 
Dries committed
316 317
 */
function locale_get_plural($count) {
318
  global $language;
Dries's avatar
 
Dries committed
319 320 321 322
  static $locale_formula, $plurals = array();

  if (!isset($plurals[$count])) {
    if (!isset($locale_formula)) {
323
      $locale_formula = $language->formula;
Dries's avatar
 
Dries committed
324 325 326 327 328 329 330 331 332
    }
    if ($locale_formula) {
      $n = $count;
      $plurals[$count] = @eval("return intval($locale_formula);");
      return $plurals[$count];
    }
    else {
      $plurals[$count] = -1;
      return -1;
333
    }
Dries's avatar
 
Dries committed
334
  }
Dries's avatar
 
Dries committed
335
  return $plurals[$count];
336
}
Dries's avatar
 
Dries committed
337

338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355

/**
 * 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
356 357
 * @param $all
 *   Boolean to return all languages or only enabled ones
358
 */
359 360 361 362 363 364 365 366
function locale_language_list($field = 'name', $all = FALSE) {
  if ($all) {
    $languages = language_list();
  }
  else {
    $languages = language_list('enabled');
    $languages = $languages[1];
  }
367
  $list = array();
368
  foreach ($languages as $language) {
369 370 371 372 373
    $list[$language->language] = ($field == 'name') ? t($language->name) : $language->$field;
  }
  return $list;
}

Dries's avatar
 
Dries committed
374
// ---------------------------------------------------------------------------------
375
// Language management functionality (administration only)
Dries's avatar
 
Dries committed
376

Dries's avatar
 
Dries committed
377
/**
378
 * Page handler for the language management screen.
Dries's avatar
 
Dries committed
379 380
 */
function locale_admin_manage() {
381
  include_once './includes/locale.inc';
382
  return drupal_get_form('_locale_admin_manage_screen');
Dries's avatar
 
Dries committed
383
}
Dries's avatar
 
Dries committed
384

Dries's avatar
 
Dries committed
385
/**
386
 * User interface for the language deletion confirmation screen.
Dries's avatar
 
Dries committed
387
 */
388
function locale_admin_manage_delete_form($langcode) {
389
  include_once './includes/locale.inc';
390

391 392 393
  // Do not allow deletion of English locale.
  if ($langcode == 'en') {
    drupal_set_message(t('The English locale cannot be deleted.'));
394
    drupal_goto('admin/build/locale/language/overview');
395
  }
Dries's avatar
 
Dries committed
396

397 398 399 400 401 402
  $default = language_default();
  if ($default->language == $langcode) {
    drupal_set_message(t('The default language cannot be deleted.'));
    drupal_goto('admin/build/locale/language/overview');
  }

403
  // For other locales, warn user that data loss is ahead.
404
  $languages = language_list();
405

406
  if (!isset($languages[$langcode])) {
407 408 409 410
    drupal_not_found();
  }
  else {
    $form['langcode'] = array('#type' => 'value', '#value' => $langcode);
411
    return confirm_form($form, t('Are you sure you want to delete the language %name?', array('%name' => t($languages[$langcode]->name))), 'admin/build/locale/language/overview', t('Deleting a language will remove all data associated with it. This action cannot be undone.'), t('Delete'), t('Cancel'));
Dries's avatar
 
Dries committed
412
  }
413
}
Dries's avatar
 
Dries committed
414

415 416 417 418
/**
 * Process language deletion submissions.
 */
function locale_admin_manage_delete_form_submit($form_id, $form_values) {
419 420 421 422
  $languages = language_list();
  if (isset($languages[$form_values['langcode']])) {
    db_query("DELETE FROM {languages} WHERE language = '%s'", $form_values['langcode']);
    db_query("DELETE FROM {locales_target} WHERE language = '%s'", $form_values['langcode']);
423 424 425
    $variables = array('%locale' => $languages[$form_values['langcode']]->name);
    drupal_set_message(t('The language %locale has been removed.', $variables));
    watchdog('locale', 'The language %locale has been removed.', $variables);
426 427 428
  }

  // Changing the locale settings impacts the interface:
429
  cache_clear_all('*', 'cache_page', TRUE);
430

431
  return 'admin/build/locale/language/overview';
Dries's avatar
 
Dries committed
432
}
Dries's avatar
 
Dries committed
433

Dries's avatar
 
Dries committed
434 435 436 437
/**
 * Page handler for the language addition screen
 */
function locale_admin_manage_add() {
438
  include_once './includes/locale.inc';
Dries's avatar
 
Dries committed
439
  return _locale_admin_manage_add_screen();
Dries's avatar
 
Dries committed
440
}
441

442 443 444 445 446 447 448 449 450 451
function locale_admin_manage_edit($langcode) {
  include_once './includes/locale.inc';
  return _locale_admin_manage_edit_screen($langcode);
}

function locale_admin_manage_configure() {
  include_once './includes/locale.inc';
  return drupal_get_form("locale_configure_language_form");
}

Dries's avatar
 
Dries committed
452
// ---------------------------------------------------------------------------------
453
// Gettext Portable Object import functionality (administration only)
Dries's avatar
 
Dries committed
454

Dries's avatar
 
Dries committed
455 456 457 458
/**
 * Page handler for the translation import screen
 */
function locale_admin_import() {
459
  include_once './includes/locale.inc';
460
  return drupal_get_form('_locale_admin_import');
Dries's avatar
 
Dries committed
461
}
Dries's avatar
 
Dries committed
462

Dries's avatar
 
Dries committed
463 464
// ---------------------------------------------------------------------------------
// Gettext Portable Object export functionality (administration only)
Kjartan's avatar
Kjartan committed
465

Dries's avatar
 
Dries committed
466 467 468 469
/**
 * Page handler for the translation export screen
 */
function locale_admin_export() {
470
  include_once './includes/locale.inc';
Dries's avatar
 
Dries committed
471
  return _locale_admin_export_screen();
Kjartan's avatar
Kjartan committed
472 473
}

Dries's avatar
 
Dries committed
474
// ---------------------------------------------------------------------------------
475
// String search and editing functionality (administration only)
Dries's avatar
 
Dries committed
476 477

/**
478
 * Page handler for the string search.
Dries's avatar
 
Dries committed
479
 */
480
function locale_string_search() {
481
  include_once './includes/locale.inc';
482
  $output = _locale_string_seek();
483
  $output .= drupal_get_form('_locale_string_seek_form');
Dries's avatar
 
Dries committed
484
  return $output;
Dries's avatar
 
Dries committed
485 486
}

487 488 489 490 491 492 493
/**
 * Display the string edit form.
 */
function locale_admin_string_edit($lid) {
  include_once './includes/locale.inc';
  return _locale_string_edit($lid);
}
494

495 496 497 498 499 500 501 502
/**
 * Process the string edit form.
 */
function locale_admin_string_edit_submit($form_id, $form_values) {
  include_once './includes/locale.inc';
  return _locale_string_edit_submit($form_id, $form_values);
}

503 504 505 506 507 508 509
/**
 * Delete a string.
 */
function locale_admin_string_delete($lid) {
  include_once './includes/locale.inc';
  _locale_string_delete($lid);
}