locale.module 18.1 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
22
    case 'admin/help#locale':
      $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
25
26
      $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>';
      $output .= t('<p>You can</p>
<ul>
27
28
29
30
<li>administer localization at <a href="@admin-locale">administer &gt;&gt; site configuration &gt;&gt; localization</a>.</li>
<li>manage strings for the localization: <a href="@admin-locale-string-search">administer &gt;&gt; site configuration &gt;&gt; localization &gt;&gt; manage strings</a>.</li>
<li>add a locale language: <a href="@admin-locale-language-add">administer &gt;&gt; site configuration &gt;&gt; localization &gt;&gt; add language</a>.</li>
<li>download translation files from the <a href="@external-http-drupal-org-project-Translations">Drupal translations page</a>.
31
32
</li>
</ul>
33
34
', array('@admin-locale' => url('admin/settings/locale'), '@admin-locale-string-search' => url('admin/settings/locale/string/search'), '@admin-locale-language-add' => url('admin/settings/locale/language/add'), '@external-http-drupal-org-project-Translations' => 'http://drupal.org/project/Translations'));
      $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>';
35
      return $output;
36
    case 'admin/settings/modules#description':
Dries's avatar
   
Dries committed
37
      return t('Enables the translation of the user interface to languages other than English.');
38
39
    case 'admin/settings/locale':
    case 'admin/settings/locale/language/overview':
40
      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")));
41
    case 'admin/settings/locale/language/add':
42
      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")));
43
    case 'admin/settings/locale/language/import':
44
      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'));
45
    case 'admin/settings/locale/language/export':
46
      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>");
47
    case 'admin/settings/locale/string/search':
48
      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
49
  }
Dries's avatar
   
Dries committed
50
51
}

Dries's avatar
   
Dries committed
52
/**
Dries's avatar
   
Dries committed
53
 * Implementation of hook_menu().
Dries's avatar
   
Dries committed
54
 */
Dries's avatar
   
Dries committed
55
function locale_menu($may_cache) {
Dries's avatar
   
Dries committed
56
  $items = array();
57
  $access = user_access('administer locales');
Dries's avatar
   
Dries committed
58

Dries's avatar
   
Dries committed
59
60
  if ($may_cache) {
    // Main admin menu item
61
    $items[] = array('path' => 'admin/settings/locale',
62
      'title' => t('localization'),
63
      'description' => t('Configure site localization and user interface translation.'),
64
65
      'callback' => 'locale_admin_manage',
      'access' => $access);
Dries's avatar
   
Dries committed
66

Dries's avatar
   
Dries committed
67
    // Top level tabs
68
    $items[] = array('path' => 'admin/settings/locale/language',
69
70
71
72
      'title' => t('manage languages'),
      'access' => $access,
      'weight' => -10,
      'type' => MENU_DEFAULT_LOCAL_TASK);
73
    $items[] = array('path' => 'admin/settings/locale/string/search',
74
75
76
77
      'title' => t('manage strings'),
      'callback' => 'locale_string_search',
      'access' => $access,
      'weight' => 10,
Dries's avatar
   
Dries committed
78
      'type' => MENU_LOCAL_TASK);
Dries's avatar
   
Dries committed
79

Dries's avatar
   
Dries committed
80
    // Manage languages subtabs
81
    $items[] = array('path' => 'admin/settings/locale/language/overview',
82
83
84
85
      'title' => t('list'),
      'callback' => 'locale_admin_manage',
      'access' => $access,
      'weight' => 0,
Dries's avatar
   
Dries committed
86
      'type' => MENU_DEFAULT_LOCAL_TASK);
87
    $items[] = array('path' => 'admin/settings/locale/language/add',
88
89
90
91
      'title' => t('add language'),
      'callback' => 'locale_admin_manage_add',
      'access' => $access,
      'weight' => 5,
Dries's avatar
   
Dries committed
92
      'type' => MENU_LOCAL_TASK);
93
    $items[] = array('path' => 'admin/settings/locale/language/import',
94
95
96
97
      'title' => t('import'),
      'callback' => 'locale_admin_import',
      'access' => $access,
      'weight' => 10,
Dries's avatar
   
Dries committed
98
      'type' => MENU_LOCAL_TASK);
99
    $items[] = array('path' => 'admin/settings/locale/language/export',
100
101
102
103
      'title' => t('export'),
      'callback' => 'locale_admin_export',
      'access' => $access,
      'weight' => 20,
Dries's avatar
   
Dries committed
104
      'type' => MENU_LOCAL_TASK);
Dries's avatar
   
Dries committed
105

Dries's avatar
   
Dries committed
106
    // Language related callbacks
107
    $items[] = array('path' => 'admin/settings/locale/language/delete',
108
      'title' => t('confirm'),
109
110
      'callback' => 'drupal_get_form',
      'callback arguments' => array('locale_admin_manage_delete_form'),
111
      'access' => $access,
Dries's avatar
   
Dries committed
112
      'type' => MENU_CALLBACK);
113
114
  }
  else {
115
116
117
118
    // 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');

119
120
    if (is_numeric(arg(4))) {
      // String related callbacks
121
      $items[] = array('path' => 'admin/settings/locale/string/edit/'. arg(4),
122
123
124
125
126
        'title' => t('edit string'),
        'callback' => 'locale_admin_string_edit',
        'callback arguments' => arg(4),
        'access' => $access,
        'type' => MENU_CALLBACK);
127
      $items[] = array('path' => 'admin/settings/locale/string/delete/'. arg(4),
128
129
130
131
132
133
        'title' => t('delete string'),
        'callback' => 'locale_admin_string_delete',
        'callback arguments' => arg(4),
        'access' => $access,
        'type' => MENU_CALLBACK);
    }
Dries's avatar
   
Dries committed
134
  }
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
150
151
152
153
154
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']);
    }
155
    $languages['name'] = array_map('check_plain', $languages['name']);
156
157
158
159
160
161
162
163
164
165
    $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.'),
    );
166
    return $form;
Dries's avatar
   
Dries committed
167
168
169
  }
}

Dries's avatar
   
Dries committed
170
171
// ---------------------------------------------------------------------------------
// Locale core functionality (needed on all page loads)
Dries's avatar
   
Dries committed
172

Dries's avatar
   
Dries committed
173
/**
174
 * Provides interface translation services.
Dries's avatar
   
Dries committed
175
176
177
178
179
180
 *
 * 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
181

182
  // Store database cached translations in a static var.
Dries's avatar
   
Dries committed
183
  if (!isset($locale_t)) {
184
    $cache = cache_get("locale:$locale", 'cache');
Dries's avatar
   
Dries committed
185

186
    if (!$cache) {
Dries's avatar
   
Dries committed
187
      locale_refresh_cache();
188
      $cache = cache_get("locale:$locale", 'cache');
Dries's avatar
   
Dries committed
189
190
    }
    $locale_t = unserialize($cache->data);
Dries's avatar
   
Dries committed
191
192
  }

Dries's avatar
   
Dries committed
193
194
195
196
197
  // 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
198

199
  // We do not have this translation cached, so get it from the DB.
Dries's avatar
   
Dries committed
200
201
202
203
204
205
206
  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;
207
      }
Dries's avatar
   
Dries committed
208
    }
Dries's avatar
   
Dries committed
209

Dries's avatar
   
Dries committed
210
211
212
213
214
215
    // 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) {
216
          db_query("INSERT INTO {locales_target} (lid, locale, translation) VALUES (%d, '%s', '')", $obj->lid, $locale);
Dries's avatar
   
Dries committed
217
218
219
        }
      }
      // We have no such source string
220
      else {
Dries's avatar
   
Dries committed
221
222
        db_query("INSERT INTO {locales_source} (location, source) VALUES ('%s', '%s')", request_uri(), $string);
        if ($locale) {
223
          $lid = db_fetch_object(db_query("SELECT lid FROM {locales_source} WHERE source = '%s'", $string));
224
          db_query("INSERT INTO {locales_target} (lid, locale, translation) VALUES (%d, '%s', '')", $lid->lid, $locale);
Dries's avatar
   
Dries committed
225
        }
226
      }
Dries's avatar
   
Dries committed
227
      // Clear locale cache in DB
228
      cache_clear_all("locale:$locale", 'cache');
Dries's avatar
   
Dries committed
229
    }
Dries's avatar
   
Dries committed
230
231
  }

Dries's avatar
   
Dries committed
232
233
  return $string;
}
Dries's avatar
   
Dries committed
234

Dries's avatar
   
Dries committed
235
/**
236
 * Refreshes database stored cache of translations.
Dries's avatar
   
Dries committed
237
238
239
240
241
 *
 * 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
242

Dries's avatar
   
Dries committed
243
244
  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);
245
    $t = array();
Dries's avatar
   
Dries committed
246
247
    while ($data = db_fetch_object($result)) {
      $t[$data->source] = (empty($data->translation) ? TRUE : $data->translation);
Dries's avatar
   
Dries committed
248
    }
249
    cache_set("locale:$locale", 'cache', serialize($t));
Dries's avatar
   
Dries committed
250
251
252
  }
}

Dries's avatar
   
Dries committed
253
/**
254
 * Returns list of languages supported on this site.
Dries's avatar
   
Dries committed
255
 *
256
 * @param $reset Refresh cached language list.
Dries's avatar
   
Dries committed
257
258
259
260
261
 * @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
262

Dries's avatar
   
Dries committed
263
264
  if ($reset) {
    unset($enabled); unset($all);
Dries's avatar
   
Dries committed
265
266
  }

Dries's avatar
   
Dries committed
267
268
269
270
271
272
  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
273
      $all['formula'][$row->locale] = $row->formula;
Dries's avatar
   
Dries committed
274
275
276
      if ($row->enabled) {
        $enabled['name'][$row->locale] = $row->name;
        $enabled['formula'][$row->locale] = $row->formula;
277
278
      }
    }
Kjartan's avatar
Kjartan committed
279
  }
Dries's avatar
   
Dries committed
280
281
282
283
  return $getall ? $all : $enabled;
}

/**
284
 * Returns plural form index for a specific number.
Dries's avatar
   
Dries committed
285
 *
286
 * The index is computed from the formula of this language.
Dries's avatar
   
Dries committed
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 */
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;
305
    }
Dries's avatar
   
Dries committed
306
  }
Dries's avatar
   
Dries committed
307
  return $plurals[$count];
308
}
Dries's avatar
   
Dries committed
309

Dries's avatar
   
Dries committed
310
// ---------------------------------------------------------------------------------
311
// Language management functionality (administration only)
Dries's avatar
   
Dries committed
312

Dries's avatar
   
Dries committed
313
/**
314
 * Page handler for the language management screen.
Dries's avatar
   
Dries committed
315
316
 */
function locale_admin_manage() {
317
  include_once './includes/locale.inc';
318
  return drupal_get_form('_locale_admin_manage_screen');
Dries's avatar
   
Dries committed
319
}
Dries's avatar
   
Dries committed
320

Dries's avatar
   
Dries committed
321
/**
322
 * User interface for the language deletion confirmation screen.
Dries's avatar
   
Dries committed
323
 */
324
function locale_admin_manage_delete_form() {
325
  include_once './includes/locale.inc';
Dries's avatar
   
Dries committed
326
  $langcode = arg(4);
327

328
329
330
  // Do not allow deletion of English locale.
  if ($langcode == 'en') {
    drupal_set_message(t('The English locale cannot be deleted.'));
331
    drupal_goto('admin/settings/locale/language/overview');
332
  }
Dries's avatar
   
Dries committed
333

334
335
336
337
338
339
340
341
  // 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);
342
    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
343
  }
344
}
Dries's avatar
   
Dries committed
345

346
347
348
349
/**
 * Process language deletion submissions.
 */
function locale_admin_manage_delete_form_submit($form_id, $form_values) {
Dries's avatar
   
Dries committed
350
  $languages = locale_supported_languages(FALSE, TRUE);
351
352
353
  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']);
354
    $message = t('The language %locale has been removed.', array('%locale' => t($languages['name'][$form_values['langcode']])));
355
356
357
358
359
    drupal_set_message($message);
    watchdog('locale', $message);
  }

  // Changing the locale settings impacts the interface:
360
361
  cache_clear_all('*', 'cache_menu', TRUE);
  cache_clear_all('*', 'cache_page', TRUE);
362

363
  return 'admin/settings/locale/language/overview';
Dries's avatar
   
Dries committed
364
}
Dries's avatar
   
Dries committed
365

Dries's avatar
   
Dries committed
366
367
368
369
/**
 * Page handler for the language addition screen
 */
function locale_admin_manage_add() {
370
  include_once './includes/locale.inc';
Dries's avatar
   
Dries committed
371
  return _locale_admin_manage_add_screen();
Dries's avatar
   
Dries committed
372
}
373

Dries's avatar
   
Dries committed
374
// ---------------------------------------------------------------------------------
375
// Gettext Portable Object import functionality (administration only)
Dries's avatar
   
Dries committed
376

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

Dries's avatar
   
Dries committed
385
386
// ---------------------------------------------------------------------------------
// Gettext Portable Object export functionality (administration only)
Kjartan's avatar
Kjartan committed
387

Dries's avatar
   
Dries committed
388
389
390
391
/**
 * Page handler for the translation export screen
 */
function locale_admin_export() {
392
  include_once './includes/locale.inc';
Dries's avatar
   
Dries committed
393
  return _locale_admin_export_screen();
Kjartan's avatar
Kjartan committed
394
395
}

Dries's avatar
   
Dries committed
396
// ---------------------------------------------------------------------------------
397
// String search and editing functionality (administration only)
Dries's avatar
   
Dries committed
398
399

/**
400
 * Page handler for the string search.
Dries's avatar
   
Dries committed
401
 */
402
function locale_string_search() {
403
  include_once './includes/locale.inc';
404
  $output = _locale_string_seek();
405
  $output .= drupal_get_form('_locale_string_seek_form');
Dries's avatar
   
Dries committed
406
  return $output;
Dries's avatar
   
Dries committed
407
408
}

409
410
411
412
413
414
415
/**
 * Display the string edit form.
 */
function locale_admin_string_edit($lid) {
  include_once './includes/locale.inc';
  return _locale_string_edit($lid);
}
416

417
418
419
420
421
422
423
/**
 * Delete a string.
 */
function locale_admin_string_delete($lid) {
  include_once './includes/locale.inc';
  _locale_string_delete($lid);
}