locale.module 17.3 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
    case 'admin/settings/locale':
    case 'admin/settings/locale/language/overview':
29
      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/settings/locale/string/search"), "@import" => url("admin/settings/locale/language/import"), "@add-language" => url("admin/settings/locale/language/add")));
30
    case 'admin/settings/locale/language/add':
31
      return t("<p>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>.</p>", array("@import" => url("admin/settings/locale/language/import")));
32
    case 'admin/settings/locale/language/import':
33
      return t("<p>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.</p>", array('@url' => 'http://drupal.org/project/translations'));
34
    case 'admin/settings/locale/language/export':
35
      return t("<p>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
    case 'admin/settings/locale/string/search':
37
      return t("<p>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.</p>", array("@export" => url("admin/settings/locale/language/export")));
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
 */
Dries's avatar
   
Dries committed
44
function locale_menu($may_cache) {
Dries's avatar
   
Dries committed
45
  $items = array();
46
  $access = user_access('administer locales');
Dries's avatar
   
Dries committed
47

Dries's avatar
   
Dries committed
48
49
  if ($may_cache) {
    // Main admin menu item
50
    $items[] = array('path' => 'admin/settings/locale',
51
      'title' => t('Localization'),
52
      'description' => t('Configure site localization and user interface translation.'),
53
54
      'callback' => 'locale_admin_manage',
      'access' => $access);
Dries's avatar
   
Dries committed
55

Dries's avatar
   
Dries committed
56
    // Top level tabs
57
    $items[] = array('path' => 'admin/settings/locale/language',
58
      'title' => t('Manage languages'),
59
60
61
      'access' => $access,
      'weight' => -10,
      'type' => MENU_DEFAULT_LOCAL_TASK);
62
    $items[] = array('path' => 'admin/settings/locale/string/search',
63
      'title' => t('Manage strings'),
64
65
66
      'callback' => 'locale_string_search',
      'access' => $access,
      'weight' => 10,
Dries's avatar
   
Dries committed
67
      'type' => MENU_LOCAL_TASK);
Dries's avatar
   
Dries committed
68

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

Dries's avatar
   
Dries committed
95
    // Language related callbacks
96
    $items[] = array('path' => 'admin/settings/locale/language/delete',
97
      'title' => t('Confirm'),
98
99
      'callback' => 'drupal_get_form',
      'callback arguments' => array('locale_admin_manage_delete_form'),
100
      'access' => $access,
Dries's avatar
   
Dries committed
101
      'type' => MENU_CALLBACK);
102
103
  }
  else {
104
105
106
107
    // Add the CSS for this module
    // We put this in !$may_cache so it's only added once per request
    drupal_add_css(drupal_get_path('module', 'locale') .'/locale.css');

108
    if (is_numeric(arg(5))) {
109
      // String related callbacks
110
      $items[] = array('path' => 'admin/settings/locale/string/edit/'. arg(5),
111
        'title' => t('Edit string'),
112
113
        'callback' => 'drupal_get_form',
        'callback arguments' => array('locale_admin_string_edit', arg(5)),
114
115
        'access' => $access,
        'type' => MENU_CALLBACK);
116
      $items[] = array('path' => 'admin/settings/locale/string/delete/'. arg(5),
117
        'title' => t('Delete string'),
118
        'callback' => 'locale_admin_string_delete',
119
        'callback arguments' => array(arg(5)),
120
121
122
        'access' => $access,
        'type' => MENU_CALLBACK);
    }
Dries's avatar
   
Dries committed
123
  }
Dries's avatar
   
Dries committed
124

Dries's avatar
   
Dries committed
125
  return $items;
Dries's avatar
   
Dries committed
126
127
}

Dries's avatar
   
Dries committed
128
/**
Dries's avatar
   
Dries committed
129
 * Implementation of hook_perm().
Dries's avatar
   
Dries committed
130
 */
Dries's avatar
   
Dries committed
131
132
133
134
135
136
137
138
139
140
141
142
143
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']);
    }
144
    $languages['name'] = array_map('check_plain', $languages['name']);
145
146
147
148
149
150
151
152
153
154
    $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.'),
    );
155
    return $form;
Dries's avatar
   
Dries committed
156
157
158
  }
}

Dries's avatar
   
Dries committed
159
160
// ---------------------------------------------------------------------------------
// Locale core functionality (needed on all page loads)
Dries's avatar
   
Dries committed
161

Dries's avatar
   
Dries committed
162
/**
163
 * Provides interface translation services.
Dries's avatar
   
Dries committed
164
165
166
167
168
169
 *
 * 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
170

171
  // Store database cached translations in a static var.
Dries's avatar
   
Dries committed
172
  if (!isset($locale_t)) {
173
    $cache = cache_get("locale:$locale", 'cache');
Dries's avatar
   
Dries committed
174

175
    if (!$cache) {
Dries's avatar
   
Dries committed
176
      locale_refresh_cache();
177
      $cache = cache_get("locale:$locale", 'cache');
Dries's avatar
   
Dries committed
178
179
    }
    $locale_t = unserialize($cache->data);
Dries's avatar
   
Dries committed
180
181
  }

Dries's avatar
   
Dries committed
182
183
184
185
186
  // 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
187

188
  // We do not have this translation cached, so get it from the DB.
Dries's avatar
   
Dries committed
189
190
191
192
193
194
195
  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;
196
      }
Dries's avatar
   
Dries committed
197
    }
Dries's avatar
   
Dries committed
198

Dries's avatar
   
Dries committed
199
200
201
202
203
204
    // 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) {
205
          db_query("INSERT INTO {locales_target} (lid, locale, translation) VALUES (%d, '%s', '')", $obj->lid, $locale);
Dries's avatar
   
Dries committed
206
207
208
        }
      }
      // We have no such source string
209
      else {
Dries's avatar
   
Dries committed
210
211
        db_query("INSERT INTO {locales_source} (location, source) VALUES ('%s', '%s')", request_uri(), $string);
        if ($locale) {
212
          $lid = db_fetch_object(db_query("SELECT lid FROM {locales_source} WHERE source = '%s'", $string));
213
          db_query("INSERT INTO {locales_target} (lid, locale, translation) VALUES (%d, '%s', '')", $lid->lid, $locale);
Dries's avatar
   
Dries committed
214
        }
215
      }
Dries's avatar
   
Dries committed
216
      // Clear locale cache in DB
217
      cache_clear_all("locale:$locale", 'cache');
Dries's avatar
   
Dries committed
218
    }
Dries's avatar
   
Dries committed
219
220
  }

Dries's avatar
   
Dries committed
221
222
  return $string;
}
Dries's avatar
   
Dries committed
223

Dries's avatar
   
Dries committed
224
/**
225
 * Refreshes database stored cache of translations.
Dries's avatar
   
Dries committed
226
227
228
229
230
 *
 * 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
231

Dries's avatar
   
Dries committed
232
233
  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);
234
    $t = array();
Dries's avatar
   
Dries committed
235
236
    while ($data = db_fetch_object($result)) {
      $t[$data->source] = (empty($data->translation) ? TRUE : $data->translation);
Dries's avatar
   
Dries committed
237
    }
238
    cache_set("locale:$locale", 'cache', serialize($t));
Dries's avatar
   
Dries committed
239
240
241
  }
}

Dries's avatar
   
Dries committed
242
/**
243
 * Returns list of languages supported on this site.
Dries's avatar
   
Dries committed
244
 *
245
 * @param $reset Refresh cached language list.
Dries's avatar
   
Dries committed
246
247
248
249
250
 * @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
251

Dries's avatar
   
Dries committed
252
253
  if ($reset) {
    unset($enabled); unset($all);
Dries's avatar
   
Dries committed
254
255
  }

Dries's avatar
   
Dries committed
256
257
258
259
260
261
  if (is_null($enabled)) {
    $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
262
      $all['formula'][$row->locale] = $row->formula;
Dries's avatar
   
Dries committed
263
264
265
      if ($row->enabled) {
        $enabled['name'][$row->locale] = $row->name;
        $enabled['formula'][$row->locale] = $row->formula;
266
267
      }
    }
Kjartan's avatar
Kjartan committed
268
  }
Dries's avatar
   
Dries committed
269
270
271
272
  return $getall ? $all : $enabled;
}

/**
273
 * Returns plural form index for a specific number.
Dries's avatar
   
Dries committed
274
 *
275
 * The index is computed from the formula of this language.
Dries's avatar
   
Dries committed
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 */
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;
294
    }
Dries's avatar
   
Dries committed
295
  }
Dries's avatar
   
Dries committed
296
  return $plurals[$count];
297
}
Dries's avatar
   
Dries committed
298

Dries's avatar
   
Dries committed
299
// ---------------------------------------------------------------------------------
300
// Language management functionality (administration only)
Dries's avatar
   
Dries committed
301

Dries's avatar
   
Dries committed
302
/**
303
 * Page handler for the language management screen.
Dries's avatar
   
Dries committed
304
305
 */
function locale_admin_manage() {
306
  include_once './includes/locale.inc';
307
  return drupal_get_form('_locale_admin_manage_screen');
Dries's avatar
   
Dries committed
308
}
Dries's avatar
   
Dries committed
309

Dries's avatar
   
Dries committed
310
/**
311
 * User interface for the language deletion confirmation screen.
Dries's avatar
   
Dries committed
312
 */
313
function locale_admin_manage_delete_form($langcode) {
314
  include_once './includes/locale.inc';
315

316
317
318
  // Do not allow deletion of English locale.
  if ($langcode == 'en') {
    drupal_set_message(t('The English locale cannot be deleted.'));
319
    drupal_goto('admin/settings/locale/language/overview');
320
  }
Dries's avatar
   
Dries committed
321

322
323
324
325
326
327
328
329
  // 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);
330
    return confirm_form($form, t('Are you sure you want to delete the language %name?', array('%name' => t($languages['name'][$langcode]))), 'admin/settings/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
331
  }
332
}
Dries's avatar
   
Dries committed
333

334
335
336
337
/**
 * Process language deletion submissions.
 */
function locale_admin_manage_delete_form_submit($form_id, $form_values) {
Dries's avatar
   
Dries committed
338
  $languages = locale_supported_languages(FALSE, TRUE);
339
340
341
  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']);
342
    $message = t('The language %locale has been removed.', array('%locale' => t($languages['name'][$form_values['langcode']])));
343
344
345
346
347
    drupal_set_message($message);
    watchdog('locale', $message);
  }

  // Changing the locale settings impacts the interface:
348
349
  cache_clear_all('*', 'cache_menu', TRUE);
  cache_clear_all('*', 'cache_page', TRUE);
350

351
  return 'admin/settings/locale/language/overview';
Dries's avatar
   
Dries committed
352
}
Dries's avatar
   
Dries committed
353

Dries's avatar
   
Dries committed
354
355
356
357
/**
 * Page handler for the language addition screen
 */
function locale_admin_manage_add() {
358
  include_once './includes/locale.inc';
Dries's avatar
   
Dries committed
359
  return _locale_admin_manage_add_screen();
Dries's avatar
   
Dries committed
360
}
361

Dries's avatar
   
Dries committed
362
// ---------------------------------------------------------------------------------
363
// Gettext Portable Object import functionality (administration only)
Dries's avatar
   
Dries committed
364

Dries's avatar
   
Dries committed
365
366
367
368
/**
 * Page handler for the translation import screen
 */
function locale_admin_import() {
369
  include_once './includes/locale.inc';
370
  return drupal_get_form('_locale_admin_import');
Dries's avatar
   
Dries committed
371
}
Dries's avatar
   
Dries committed
372

Dries's avatar
   
Dries committed
373
374
// ---------------------------------------------------------------------------------
// Gettext Portable Object export functionality (administration only)
Kjartan's avatar
Kjartan committed
375

Dries's avatar
   
Dries committed
376
377
378
379
/**
 * Page handler for the translation export screen
 */
function locale_admin_export() {
380
  include_once './includes/locale.inc';
Dries's avatar
   
Dries committed
381
  return _locale_admin_export_screen();
Kjartan's avatar
Kjartan committed
382
383
}

Dries's avatar
   
Dries committed
384
// ---------------------------------------------------------------------------------
385
// String search and editing functionality (administration only)
Dries's avatar
   
Dries committed
386
387

/**
388
 * Page handler for the string search.
Dries's avatar
   
Dries committed
389
 */
390
function locale_string_search() {
391
  include_once './includes/locale.inc';
392
  $output = _locale_string_seek();
393
  $output .= drupal_get_form('_locale_string_seek_form');
Dries's avatar
   
Dries committed
394
  return $output;
Dries's avatar
   
Dries committed
395
396
}

397
398
399
400
401
402
403
/**
 * Display the string edit form.
 */
function locale_admin_string_edit($lid) {
  include_once './includes/locale.inc';
  return _locale_string_edit($lid);
}
404

405
406
407
408
409
410
411
412
/**
 * 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);
}

413
414
415
416
417
418
419
/**
 * Delete a string.
 */
function locale_admin_string_delete($lid) {
  include_once './includes/locale.inc';
  _locale_string_delete($lid);
}