locale.module 18.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 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 158 159
      $default = language_default();
      $user->language = $default->language;
    }
    $names = array();
    foreach($languages as $langcode => $language) {
      $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 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
/**
 * Implementation of hook_form_alter(). Adds language fields to forms.
 */
function locale_form_alter($form_id, &$form) {
  switch ($form_id) {
    case 'path_admin_edit':
      $form['language'] = array(
        '#type' => 'radios',
        '#title' => t('Language'),
        '#options' => array('' => t('All languages')) + locale_language_list('name'),
        '#default_value' => $form['#alias'] ? $form['#alias']['language'] : '',
        '#weight' => -10
      );
      break;
  }
}


Dries's avatar
 
Dries committed
193 194
// ---------------------------------------------------------------------------------
// Locale core functionality (needed on all page loads)
Dries's avatar
 
Dries committed
195

Dries's avatar
 
Dries committed
196
/**
197
 * Provides interface translation services.
Dries's avatar
 
Dries committed
198 199 200 201
 *
 * This function is called from t() to translate a string if needed.
 */
function locale($string) {
202
  global $language;
Dries's avatar
 
Dries committed
203
  static $locale_t;
Dries's avatar
 
Dries committed
204

205
  // Store database cached translations in a static var.
Dries's avatar
 
Dries committed
206
  if (!isset($locale_t)) {
207
    if (!($cache = cache_get('locale:'. $language->language, 'cache'))) {
Dries's avatar
 
Dries committed
208
      locale_refresh_cache();
209
      $cache = cache_get('locale:'. $language->language, 'cache');
Dries's avatar
 
Dries committed
210 211
    }
    $locale_t = unserialize($cache->data);
Dries's avatar
 
Dries committed
212 213
  }

Dries's avatar
 
Dries committed
214 215 216 217 218
  // 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
219

220
  // We do not have this translation cached, so get it from the DB.
Dries's avatar
 
Dries committed
221
  else {
222
    $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
223 224 225 226 227
    // Translation found
    if ($trans = db_fetch_object($result)) {
      if (!empty($trans->translation)) {
        $locale_t[$string] = $trans->translation;
        $string = $trans->translation;
228
      }
Dries's avatar
 
Dries committed
229
    }
Dries's avatar
 
Dries committed
230

Dries's avatar
 
Dries committed
231 232 233 234 235
    // 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)) {
236 237
        if ($language) {
          db_query("INSERT INTO {locales_target} (lid, language, translation) VALUES (%d, '%s', '')", $obj->lid, $language->language);
Dries's avatar
 
Dries committed
238 239 240
        }
      }
      // We have no such source string
241
      else {
Dries's avatar
 
Dries committed
242
        db_query("INSERT INTO {locales_source} (location, source) VALUES ('%s', '%s')", request_uri(), $string);
243
        if ($language) {
244
          $lid = db_fetch_object(db_query("SELECT lid FROM {locales_source} WHERE source = '%s'", $string));
245
          db_query("INSERT INTO {locales_target} (lid, language, translation) VALUES (%d, '%s', '')", $lid->lid, $language->language);
Dries's avatar
 
Dries committed
246
        }
247
      }
Dries's avatar
 
Dries committed
248
      // Clear locale cache in DB
249
      cache_clear_all('locale:' . $language->language, 'cache');
Dries's avatar
 
Dries committed
250
    }
Dries's avatar
 
Dries committed
251 252
  }

Dries's avatar
 
Dries committed
253 254
  return $string;
}
Dries's avatar
 
Dries committed
255

Dries's avatar
 
Dries committed
256
/**
257
 * Refreshes database stored cache of translations.
Dries's avatar
 
Dries committed
258 259 260 261
 *
 * We only store short strings to improve performance and consume less memory.
 */
function locale_refresh_cache() {
262 263
  $languages = language_list('enabled');
  $languages = $languages['1'];
Dries's avatar
 
Dries committed
264

265 266
  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);
267
    $t = array();
Dries's avatar
 
Dries committed
268 269
    while ($data = db_fetch_object($result)) {
      $t[$data->source] = (empty($data->translation) ? TRUE : $data->translation);
Dries's avatar
 
Dries committed
270
    }
271
    cache_set('locale:' . $language->language, 'cache', serialize($t));
Dries's avatar
 
Dries committed
272 273 274
  }
}

Dries's avatar
 
Dries committed
275
/**
276
 * Returns plural form index for a specific number.
Dries's avatar
 
Dries committed
277
 *
278
 * The index is computed from the formula of this language.
Dries's avatar
 
Dries committed
279 280
 */
function locale_get_plural($count) {
281
  global $language;
Dries's avatar
 
Dries committed
282 283 284 285
  static $locale_formula, $plurals = array();

  if (!isset($plurals[$count])) {
    if (!isset($locale_formula)) {
286
      $locale_formula = $language->formula;
Dries's avatar
 
Dries committed
287 288 289 290 291 292 293 294 295
    }
    if ($locale_formula) {
      $n = $count;
      $plurals[$count] = @eval("return intval($locale_formula);");
      return $plurals[$count];
    }
    else {
      $plurals[$count] = -1;
      return -1;
296
    }
Dries's avatar
 
Dries committed
297
  }
Dries's avatar
 
Dries committed
298
  return $plurals[$count];
299
}
Dries's avatar
 
Dries committed
300

301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318

/**
 * 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
319 320
 * @param $all
 *   Boolean to return all languages or only enabled ones
321
 */
322 323 324 325 326 327 328 329
function locale_language_list($field = 'name', $all = FALSE) {
  if ($all) {
    $languages = language_list();
  }
  else {
    $languages = language_list('enabled');
    $languages = $languages[1];
  }
330
  $list = array();
331
  foreach($languages as $language) {
332 333 334 335 336
    $list[$language->language] = ($field == 'name') ? t($language->name) : $language->$field;
  }
  return $list;
}

Dries's avatar
 
Dries committed
337
// ---------------------------------------------------------------------------------
338
// Language management functionality (administration only)
Dries's avatar
 
Dries committed
339

Dries's avatar
 
Dries committed
340
/**
341
 * Page handler for the language management screen.
Dries's avatar
 
Dries committed
342 343
 */
function locale_admin_manage() {
344
  include_once './includes/locale.inc';
345
  return drupal_get_form('_locale_admin_manage_screen');
Dries's avatar
 
Dries committed
346
}
Dries's avatar
 
Dries committed
347

Dries's avatar
 
Dries committed
348
/**
349
 * User interface for the language deletion confirmation screen.
Dries's avatar
 
Dries committed
350
 */
351
function locale_admin_manage_delete_form($langcode) {
352
  include_once './includes/locale.inc';
353

354 355 356
  // Do not allow deletion of English locale.
  if ($langcode == 'en') {
    drupal_set_message(t('The English locale cannot be deleted.'));
357
    drupal_goto('admin/build/locale/language/overview');
358
  }
Dries's avatar
 
Dries committed
359

360 361 362 363 364 365
  $default = language_default();
  if ($default->language == $langcode) {
    drupal_set_message(t('The default language cannot be deleted.'));
    drupal_goto('admin/build/locale/language/overview');
  }

366
  // For other locales, warn user that data loss is ahead.
367
  $languages = language_list();
368

369
  if (!isset($languages[$langcode])) {
370 371 372 373
    drupal_not_found();
  }
  else {
    $form['langcode'] = array('#type' => 'value', '#value' => $langcode);
374
    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
375
  }
376
}
Dries's avatar
 
Dries committed
377

378 379 380 381
/**
 * Process language deletion submissions.
 */
function locale_admin_manage_delete_form_submit($form_id, $form_values) {
382 383 384 385 386
  $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']);
    $message = t('The language %locale has been removed.', array('%locale' => t($languages[$form_values['langcode']]->name)));
387 388 389 390 391
    drupal_set_message($message);
    watchdog('locale', $message);
  }

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

394
  return 'admin/build/locale/language/overview';
Dries's avatar
 
Dries committed
395
}
Dries's avatar
 
Dries committed
396

Dries's avatar
 
Dries committed
397 398 399 400
/**
 * Page handler for the language addition screen
 */
function locale_admin_manage_add() {
401
  include_once './includes/locale.inc';
Dries's avatar
 
Dries committed
402
  return _locale_admin_manage_add_screen();
Dries's avatar
 
Dries committed
403
}
404

405 406 407 408 409 410 411 412 413 414
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
415
// ---------------------------------------------------------------------------------
416
// Gettext Portable Object import functionality (administration only)
Dries's avatar
 
Dries committed
417

Dries's avatar
 
Dries committed
418 419 420 421
/**
 * Page handler for the translation import screen
 */
function locale_admin_import() {
422
  include_once './includes/locale.inc';
423
  return drupal_get_form('_locale_admin_import');
Dries's avatar
 
Dries committed
424
}
Dries's avatar
 
Dries committed
425

Dries's avatar
 
Dries committed
426 427
// ---------------------------------------------------------------------------------
// Gettext Portable Object export functionality (administration only)
Kjartan's avatar
Kjartan committed
428

Dries's avatar
 
Dries committed
429 430 431 432
/**
 * Page handler for the translation export screen
 */
function locale_admin_export() {
433
  include_once './includes/locale.inc';
Dries's avatar
 
Dries committed
434
  return _locale_admin_export_screen();
Kjartan's avatar
Kjartan committed
435 436
}

Dries's avatar
 
Dries committed
437
// ---------------------------------------------------------------------------------
438
// String search and editing functionality (administration only)
Dries's avatar
 
Dries committed
439 440

/**
441
 * Page handler for the string search.
Dries's avatar
 
Dries committed
442
 */
443
function locale_string_search() {
444
  include_once './includes/locale.inc';
445
  $output = _locale_string_seek();
446
  $output .= drupal_get_form('_locale_string_seek_form');
Dries's avatar
 
Dries committed
447
  return $output;
Dries's avatar
 
Dries committed
448 449
}

450 451 452 453 454 455 456
/**
 * Display the string edit form.
 */
function locale_admin_string_edit($lid) {
  include_once './includes/locale.inc';
  return _locale_string_edit($lid);
}
457

458 459 460 461 462 463 464 465
/**
 * 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);
}

466 467 468 469 470 471 472
/**
 * Delete a string.
 */
function locale_admin_string_delete($lid) {
  include_once './includes/locale.inc';
  _locale_string_delete($lid);
}