locale.module 18.2 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
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
37
    case 'admin/settings/locale':
    case 'admin/settings/locale/language/overview':
38
      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")));
39
    case 'admin/settings/locale/language/add':
40
      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")));
41
    case 'admin/settings/locale/language/import':
42
      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'));
43
    case 'admin/settings/locale/language/export':
44
      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>");
45
    case 'admin/settings/locale/string/search':
46
      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
47
  }
Dries's avatar
   
Dries committed
48
49
}

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

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

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

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

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

117
    if (is_numeric(arg(5))) {
118
      // String related callbacks
119
      $items[] = array('path' => 'admin/settings/locale/string/edit/'. arg(5),
120
        'title' => t('Edit string'),
121
122
        'callback' => 'drupal_get_form',
        'callback arguments' => array('locale_admin_string_edit', arg(5)),
123
124
        'access' => $access,
        'type' => MENU_CALLBACK);
125
      $items[] = array('path' => 'admin/settings/locale/string/delete/'. arg(5),
126
        'title' => t('Delete string'),
127
        'callback' => 'locale_admin_string_delete',
128
        'callback arguments' => array(arg(5)),
129
130
131
        'access' => $access,
        'type' => MENU_CALLBACK);
    }
Dries's avatar
   
Dries committed
132
  }
Dries's avatar
   
Dries committed
133

Dries's avatar
   
Dries committed
134
  return $items;
Dries's avatar
   
Dries committed
135
136
}

Dries's avatar
   
Dries committed
137
/**
Dries's avatar
   
Dries committed
138
 * Implementation of hook_perm().
Dries's avatar
   
Dries committed
139
 */
Dries's avatar
   
Dries committed
140
141
142
143
144
145
146
147
148
149
150
151
152
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']);
    }
153
    $languages['name'] = array_map('check_plain', $languages['name']);
154
155
156
157
158
159
160
161
162
163
    $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.'),
    );
164
    return $form;
Dries's avatar
   
Dries committed
165
166
167
  }
}

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

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

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

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

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

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

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

Dries's avatar
   
Dries committed
230
231
  return $string;
}
Dries's avatar
   
Dries committed
232

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

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

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

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

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

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

Dries's avatar
   
Dries committed
308
// ---------------------------------------------------------------------------------
309
// Language management functionality (administration only)
Dries's avatar
   
Dries committed
310

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

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

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

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

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

  // Changing the locale settings impacts the interface:
357
358
  cache_clear_all('*', 'cache_menu', TRUE);
  cache_clear_all('*', 'cache_page', TRUE);
359

360
  return 'admin/settings/locale/language/overview';
Dries's avatar
   
Dries committed
361
}
Dries's avatar
   
Dries committed
362

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

Dries's avatar
   
Dries committed
371
// ---------------------------------------------------------------------------------
372
// Gettext Portable Object import functionality (administration only)
Dries's avatar
   
Dries committed
373

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

Dries's avatar
   
Dries committed
382
383
// ---------------------------------------------------------------------------------
// Gettext Portable Object export functionality (administration only)
Kjartan's avatar
Kjartan committed
384

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

Dries's avatar
   
Dries committed
393
// ---------------------------------------------------------------------------------
394
// String search and editing functionality (administration only)
Dries's avatar
   
Dries committed
395
396

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

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

414
415
416
417
418
419
420
421
/**
 * 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);
}

422
423
424
425
426
427
428
/**
 * Delete a string.
 */
function locale_admin_string_delete($lid) {
  include_once './includes/locale.inc';
  _locale_string_delete($lid);
}