locale.module 16.5 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 web site 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
28
29
30
31
32
    case 'admin/build/locale':
    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':
33
      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>';
34
    case 'admin/build/locale/language/export':
35
      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>';
36
37
    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>';
Dries's avatar
   
Dries committed
38
  }
Dries's avatar
   
Dries committed
39
40
}

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

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

  // Manage languages subtabs
68
  $items['admin/build/locale/language/overview'] = array(
69
70
71
72
    'title' => t('List'),
    'weight' => 0,
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
73
  $items['admin/build/locale/language/add'] = array(
74
75
76
77
78
    'title' => t('Add language'),
    'page callback' => 'locale_admin_manage_add',
    'weight' => 5,
    'type' => MENU_LOCAL_TASK,
  );
79
  $items['admin/build/locale/language/import'] = array(
80
81
82
83
84
    'title' => t('Import'),
    'page callback' => 'locale_admin_import',
    'weight' => 10,
    'type' => MENU_LOCAL_TASK,
  );
85
  $items['admin/build/locale/language/export'] = array(
86
87
88
89
90
91
92
    'title' => t('Export'),
    'page callback' => 'locale_admin_export',
    'weight' => 20,
    'type' => MENU_LOCAL_TASK,
  );

  // Language related callbacks
93
  $items['admin/build/locale/language/delete'] = array(
94
95
96
97
98
99
    'title' => t('Confirm'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_admin_manage_delete_form'),
    'type' => MENU_CALLBACK,
  );
  // String related callbacks
100
  $items['admin/build/locale/string/edit/%'] = array(
101
102
103
104
105
    'title' => t('Edit string'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_admin_string_edit', 5),
    'type' => MENU_CALLBACK,
  );
106
  $items['admin/build/locale/string/delete/%'] = array(
107
108
109
110
111
    'title' => t('Delete string'),
    'page callback' => 'locale_admin_string_delete',
    'page arguments' => array(5),
    'type' => MENU_CALLBACK,
  );
Dries's avatar
   
Dries committed
112

Dries's avatar
   
Dries committed
113
  return $items;
Dries's avatar
   
Dries committed
114
115
}

Dries's avatar
   
Dries committed
116
/**
Dries's avatar
   
Dries committed
117
 * Implementation of hook_perm().
Dries's avatar
   
Dries committed
118
 */
Dries's avatar
   
Dries committed
119
120
121
122
123
124
125
126
127
128
129
130
131
function locale_perm() {
  return array('administer locales');
}

/**
 * Implementation of hook_user().
 */
function locale_user($type, $edit, &$user, $category = NULL) {
  $languages = locale_supported_languages();
  if ($type == 'form' && $category == 'account' && count($languages['name']) > 1) {
    if ($user->language == '') {
      $user->language = key($languages['name']);
    }
132
    $languages['name'] = array_map('check_plain', array_map('t', $languages['name']));
133
134
135
136
137
138
139
140
141
142
    $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,
      '#options' => $languages['name'],
      '#description' => t('Selecting a different locale will change the interface language of the site.'),
    );
143
    return $form;
Dries's avatar
   
Dries committed
144
145
146
  }
}

Dries's avatar
   
Dries committed
147
148
// ---------------------------------------------------------------------------------
// Locale core functionality (needed on all page loads)
Dries's avatar
   
Dries committed
149

Dries's avatar
   
Dries committed
150
/**
151
 * Provides interface translation services.
Dries's avatar
   
Dries committed
152
153
154
155
156
157
 *
 * This function is called from t() to translate a string if needed.
 */
function locale($string) {
  global $locale;
  static $locale_t;
Dries's avatar
   
Dries committed
158

159
  // Store database cached translations in a static var.
Dries's avatar
   
Dries committed
160
  if (!isset($locale_t)) {
161
    $cache = cache_get("locale:$locale", 'cache');
Dries's avatar
   
Dries committed
162

163
    if (!$cache) {
Dries's avatar
   
Dries committed
164
      locale_refresh_cache();
165
      $cache = cache_get("locale:$locale", 'cache');
Dries's avatar
   
Dries committed
166
167
    }
    $locale_t = unserialize($cache->data);
Dries's avatar
   
Dries committed
168
169
  }

Dries's avatar
   
Dries committed
170
171
172
173
174
  // 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
175

176
  // We do not have this translation cached, so get it from the DB.
Dries's avatar
   
Dries committed
177
178
179
180
181
182
183
  else {
    $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.locale = '%s'", $string, $locale);
    // Translation found
    if ($trans = db_fetch_object($result)) {
      if (!empty($trans->translation)) {
        $locale_t[$string] = $trans->translation;
        $string = $trans->translation;
184
      }
Dries's avatar
   
Dries committed
185
    }
Dries's avatar
   
Dries committed
186

Dries's avatar
   
Dries committed
187
188
189
190
191
192
    // 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)) {
        if ($locale) {
193
          db_query("INSERT INTO {locales_target} (lid, locale, translation) VALUES (%d, '%s', '')", $obj->lid, $locale);
Dries's avatar
   
Dries committed
194
195
196
        }
      }
      // We have no such source string
197
      else {
Dries's avatar
   
Dries committed
198
199
        db_query("INSERT INTO {locales_source} (location, source) VALUES ('%s', '%s')", request_uri(), $string);
        if ($locale) {
200
          $lid = db_fetch_object(db_query("SELECT lid FROM {locales_source} WHERE source = '%s'", $string));
201
          db_query("INSERT INTO {locales_target} (lid, locale, translation) VALUES (%d, '%s', '')", $lid->lid, $locale);
Dries's avatar
   
Dries committed
202
        }
203
      }
Dries's avatar
   
Dries committed
204
      // Clear locale cache in DB
205
      cache_clear_all("locale:$locale", 'cache');
Dries's avatar
   
Dries committed
206
    }
Dries's avatar
   
Dries committed
207
208
  }

Dries's avatar
   
Dries committed
209
210
  return $string;
}
Dries's avatar
   
Dries committed
211

Dries's avatar
   
Dries committed
212
/**
213
 * Refreshes database stored cache of translations.
Dries's avatar
   
Dries committed
214
215
216
217
218
 *
 * We only store short strings to improve performance and consume less memory.
 */
function locale_refresh_cache() {
  $languages = locale_supported_languages();
Dries's avatar
   
Dries committed
219

Dries's avatar
   
Dries committed
220
221
  foreach (array_keys($languages['name']) as $locale) {
    $result = db_query("SELECT s.source, t.translation, t.locale FROM {locales_source} s INNER JOIN {locales_target} t ON s.lid = t.lid WHERE t.locale = '%s' AND LENGTH(s.source) < 75", $locale);
222
    $t = array();
Dries's avatar
   
Dries committed
223
224
    while ($data = db_fetch_object($result)) {
      $t[$data->source] = (empty($data->translation) ? TRUE : $data->translation);
Dries's avatar
   
Dries committed
225
    }
226
    cache_set("locale:$locale", 'cache', serialize($t));
Dries's avatar
   
Dries committed
227
228
229
  }
}

Dries's avatar
   
Dries committed
230
/**
231
 * Returns list of languages supported on this site.
Dries's avatar
   
Dries committed
232
 *
233
 * @param $reset Refresh cached language list.
Dries's avatar
   
Dries committed
234
235
236
237
238
 * @param $getall Return all languages (even disabled ones)
 */
function locale_supported_languages($reset = FALSE, $getall = FALSE) {
  static $enabled = NULL;
  static $all = NULL;
Dries's avatar
   
Dries committed
239

Dries's avatar
   
Dries committed
240
241
  if ($reset) {
    unset($enabled); unset($all);
Dries's avatar
   
Dries committed
242
243
  }

244
  if (!isset($enabled)) {
Dries's avatar
   
Dries committed
245
246
247
248
249
    $enabled = $all = array();
    $all['name'] = $all['formula'] = $enabled['name'] = $enabled['formula'] = array();
    $result = db_query('SELECT locale, name, formula, enabled FROM {locales_meta} ORDER BY isdefault DESC, enabled DESC, name ASC');
    while ($row = db_fetch_object($result)) {
      $all['name'][$row->locale] = $row->name;
Dries's avatar
   
Dries committed
250
      $all['formula'][$row->locale] = $row->formula;
Dries's avatar
   
Dries committed
251
252
253
      if ($row->enabled) {
        $enabled['name'][$row->locale] = $row->name;
        $enabled['formula'][$row->locale] = $row->formula;
254
255
      }
    }
Kjartan's avatar
Kjartan committed
256
  }
Dries's avatar
   
Dries committed
257
258
259
260
  return $getall ? $all : $enabled;
}

/**
261
 * Returns plural form index for a specific number.
Dries's avatar
   
Dries committed
262
 *
263
 * The index is computed from the formula of this language.
Dries's avatar
   
Dries committed
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 */
function locale_get_plural($count) {
  global $locale;
  static $locale_formula, $plurals = array();

  if (!isset($plurals[$count])) {
    if (!isset($locale_formula)) {
      $languages = locale_supported_languages();
      $locale_formula = $languages['formula'][$locale];
    }
    if ($locale_formula) {
      $n = $count;
      $plurals[$count] = @eval("return intval($locale_formula);");
      return $plurals[$count];
    }
    else {
      $plurals[$count] = -1;
      return -1;
282
    }
Dries's avatar
   
Dries committed
283
  }
Dries's avatar
   
Dries committed
284
  return $plurals[$count];
285
}
Dries's avatar
   
Dries committed
286

Dries's avatar
   
Dries committed
287
// ---------------------------------------------------------------------------------
288
// Language management functionality (administration only)
Dries's avatar
   
Dries committed
289

Dries's avatar
   
Dries committed
290
/**
291
 * Page handler for the language management screen.
Dries's avatar
   
Dries committed
292
293
 */
function locale_admin_manage() {
294
  include_once './includes/locale.inc';
295
  return drupal_get_form('_locale_admin_manage_screen');
Dries's avatar
   
Dries committed
296
}
Dries's avatar
   
Dries committed
297

Dries's avatar
   
Dries committed
298
/**
299
 * User interface for the language deletion confirmation screen.
Dries's avatar
   
Dries committed
300
 */
301
function locale_admin_manage_delete_form($langcode) {
302
  include_once './includes/locale.inc';
303

304
305
306
  // Do not allow deletion of English locale.
  if ($langcode == 'en') {
    drupal_set_message(t('The English locale cannot be deleted.'));
307
    drupal_goto('admin/build/locale/language/overview');
308
  }
Dries's avatar
   
Dries committed
309

310
311
312
313
314
315
316
317
  // For other locales, warn user that data loss is ahead.
  $languages = locale_supported_languages(FALSE, TRUE);

  if (!isset($languages['name'][$langcode])) {
    drupal_not_found();
  }
  else {
    $form['langcode'] = array('#type' => 'value', '#value' => $langcode);
318
    return confirm_form($form, t('Are you sure you want to delete the language %name?', array('%name' => t($languages['name'][$langcode]))), '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
319
  }
320
}
Dries's avatar
   
Dries committed
321

322
323
324
325
/**
 * Process language deletion submissions.
 */
function locale_admin_manage_delete_form_submit($form_id, $form_values) {
Dries's avatar
   
Dries committed
326
  $languages = locale_supported_languages(FALSE, TRUE);
327
328
329
  if (isset($languages['name'][$form_values['langcode']])) {
    db_query("DELETE FROM {locales_meta} WHERE locale = '%s'", $form_values['langcode']);
    db_query("DELETE FROM {locales_target} WHERE locale = '%s'", $form_values['langcode']);
330
    $message = t('The language %locale has been removed.', array('%locale' => t($languages['name'][$form_values['langcode']])));
331
332
333
334
335
    drupal_set_message($message);
    watchdog('locale', $message);
  }

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

338
  return 'admin/build/locale/language/overview';
Dries's avatar
   
Dries committed
339
}
Dries's avatar
   
Dries committed
340

Dries's avatar
   
Dries committed
341
342
343
344
/**
 * Page handler for the language addition screen
 */
function locale_admin_manage_add() {
345
  include_once './includes/locale.inc';
Dries's avatar
   
Dries committed
346
  return _locale_admin_manage_add_screen();
Dries's avatar
   
Dries committed
347
}
348

Dries's avatar
   
Dries committed
349
// ---------------------------------------------------------------------------------
350
// Gettext Portable Object import functionality (administration only)
Dries's avatar
   
Dries committed
351

Dries's avatar
   
Dries committed
352
353
354
355
/**
 * Page handler for the translation import screen
 */
function locale_admin_import() {
356
  include_once './includes/locale.inc';
357
  return drupal_get_form('_locale_admin_import');
Dries's avatar
   
Dries committed
358
}
Dries's avatar
   
Dries committed
359

Dries's avatar
   
Dries committed
360
361
// ---------------------------------------------------------------------------------
// Gettext Portable Object export functionality (administration only)
Kjartan's avatar
Kjartan committed
362

Dries's avatar
   
Dries committed
363
364
365
366
/**
 * Page handler for the translation export screen
 */
function locale_admin_export() {
367
  include_once './includes/locale.inc';
Dries's avatar
   
Dries committed
368
  return _locale_admin_export_screen();
Kjartan's avatar
Kjartan committed
369
370
}

Dries's avatar
   
Dries committed
371
// ---------------------------------------------------------------------------------
372
// String search and editing functionality (administration only)
Dries's avatar
   
Dries committed
373
374

/**
375
 * Page handler for the string search.
Dries's avatar
   
Dries committed
376
 */
377
function locale_string_search() {
378
  include_once './includes/locale.inc';
379
  $output = _locale_string_seek();
380
  $output .= drupal_get_form('_locale_string_seek_form');
Dries's avatar
   
Dries committed
381
  return $output;
Dries's avatar
   
Dries committed
382
383
}

384
385
386
387
388
389
390
/**
 * Display the string edit form.
 */
function locale_admin_string_edit($lid) {
  include_once './includes/locale.inc';
  return _locale_string_edit($lid);
}
391

392
393
394
395
396
397
398
399
/**
 * 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);
}

400
401
402
403
404
405
406
/**
 * Delete a string.
 */
function locale_admin_string_delete($lid) {
  include_once './includes/locale.inc';
  _locale_string_delete($lid);
}