locale.module 17.8 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
27
28
29
30
31
32
      $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>
<li>administer localization at <a href="%admin-locale">administer &gt;&gt; localization</a>.</li>
<li>manage strings for the localization: <a href="%admin-locale-string-search">administer &gt;&gt; localization &gt;&gt; manage strings</a>.</li>
<li>add a locale language: <a href="%admin-locale-language-add">administer &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>.
</li>
</ul>
33
', 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'));
34
      $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
40
41
42
43
    case 'admin/settings/locale':
    case 'admin/settings/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/settings/locale/string/search"), "%import" => url("admin/settings/locale/language/import"), "%add-language" => url("admin/settings/locale/language/add")));
    case 'admin/settings/locale/language/add':
      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")));
    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
48
    case 'admin/settings/locale/string/search':
      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();
Dries's avatar
   
Dries committed
57

Dries's avatar
   
Dries committed
58
59
60
61
  if ($may_cache) {
    $access = user_access('administer locales');

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

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

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

Dries's avatar
   
Dries committed
107
    // Language related callbacks
108
    $items[] = array('path' => 'admin/settings/locale/language/delete',
109
110
111
      'title' => t('confirm'),
      'callback' => 'locale_admin_manage_delete_form',
      'access' => $access,
Dries's avatar
   
Dries committed
112
      'type' => MENU_CALLBACK);
113
114
115
116
  }
  else {
    if (is_numeric(arg(4))) {
      // String related callbacks
117
      $items[] = array('path' => 'admin/settings/locale/string/edit/'. arg(4),
118
119
120
121
122
        'title' => t('edit string'),
        'callback' => 'locale_admin_string_edit',
        'callback arguments' => arg(4),
        'access' => $access,
        'type' => MENU_CALLBACK);
123
      $items[] = array('path' => 'admin/settings/locale/string/delete/'. arg(4),
124
125
126
127
128
129
        'title' => t('delete string'),
        'callback' => 'locale_admin_string_delete',
        'callback arguments' => arg(4),
        'access' => $access,
        'type' => MENU_CALLBACK);
    }
Dries's avatar
   
Dries committed
130
  }
Dries's avatar
   
Dries committed
131

Dries's avatar
   
Dries committed
132
  return $items;
Dries's avatar
   
Dries committed
133
134
}

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

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

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

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

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

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

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

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

Dries's avatar
   
Dries committed
228
229
  return $string;
}
Dries's avatar
   
Dries committed
230

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

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

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

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

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

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

Dries's avatar
   
Dries committed
306
// ---------------------------------------------------------------------------------
307
// Language management functionality (administration only)
Dries's avatar
   
Dries committed
308

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

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

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

330
331
332
333
334
335
336
337
  // 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);
338
    return confirm_form('locale_admin_manage_delete_form', $form, t('Are you sure you want to delete the language %name?', array('%name' => theme('placeholder', 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
339
  }
340
}
Dries's avatar
   
Dries committed
341

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

  // Changing the locale settings impacts the interface:
  cache_clear_all();
357

358
  return 'admin/settings/locale/language/overview';
Dries's avatar
   
Dries committed
359
}
Dries's avatar
   
Dries committed
360

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

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

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

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

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

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

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

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

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