locale.module 17.4 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
23
24
25
26
27
28
29
30
31
32
33
    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>';
      $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>';
      $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>
', array('%admin-locale' => url('admin/locale'), '%admin-locale-string-search' => url('admin/locale/string/search'), '%admin-locale-language-add' => url('admin/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;
Dries's avatar
   
Dries committed
36
37
38
39
    case 'admin/modules#description':
      return t('Enables the translation of the user interface to languages other than English.');
    case 'admin/locale':
    case 'admin/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/locale/string/search"), "%import" => url("admin/locale/language/import"), "%add-language" => url("admin/locale/language/add")));
Dries's avatar
   
Dries committed
41
    case 'admin/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/locale/language/import")));
Dries's avatar
   
Dries committed
43
    case 'admin/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'));
Dries's avatar
   
Dries committed
45
    case 'admin/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>");
Dries's avatar
   
Dries committed
47
    case 'admin/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/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
63
64
65
    $items[] = array('path' => 'admin/locale',
      'title' => t('localization'),
      'callback' => 'locale_admin_manage',
      'access' => $access);
Dries's avatar
   
Dries committed
66

Dries's avatar
   
Dries committed
67
    // Top level tabs
68
69
70
71
72
73
74
75
76
77
    $items[] = array('path' => 'admin/locale/language',
      'title' => t('manage languages'),
      'access' => $access,
      'weight' => -10,
      'type' => MENU_DEFAULT_LOCAL_TASK);
    $items[] = array('path' => 'admin/locale/string/search',
      '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
82
83
84
85
    $items[] = array('path' => 'admin/locale/language/overview',
      'title' => t('list'),
      'callback' => 'locale_admin_manage',
      'access' => $access,
      'weight' => 0,
Dries's avatar
   
Dries committed
86
      'type' => MENU_DEFAULT_LOCAL_TASK);
87
88
89
90
91
    $items[] = array('path' => 'admin/locale/language/add',
      'title' => t('add language'),
      'callback' => 'locale_admin_manage_add',
      'access' => $access,
      'weight' => 5,
Dries's avatar
   
Dries committed
92
      'type' => MENU_LOCAL_TASK);
93
94
95
96
97
    $items[] = array('path' => 'admin/locale/language/import',
      'title' => t('import'),
      'callback' => 'locale_admin_import',
      'access' => $access,
      'weight' => 10,
Dries's avatar
   
Dries committed
98
      'type' => MENU_LOCAL_TASK);
99
100
101
102
103
    $items[] = array('path' => 'admin/locale/language/export',
      '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
108
109
110
    $items[] = array('path' => 'admin/locale/language/delete',
      'title' => t('confirm'),
      'callback' => 'locale_admin_manage_delete_form',
      'access' => $access,
Dries's avatar
   
Dries committed
111
      'type' => MENU_CALLBACK);
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
  }
  else {
    if (is_numeric(arg(4))) {
      // String related callbacks
      $items[] = array('path' => 'admin/locale/string/edit/'. arg(4),
        'title' => t('edit string'),
        'callback' => 'locale_admin_string_edit',
        'callback arguments' => arg(4),
        'access' => $access,
        'type' => MENU_CALLBACK);
      $items[] = array('path' => 'admin/locale/string/delete/'. arg(4),
        'title' => t('delete string'),
        'callback' => 'locale_admin_string_delete',
        'callback arguments' => arg(4),
        'access' => $access,
        'type' => MENU_CALLBACK);
    }
Dries's avatar
   
Dries committed
129
  }
Dries's avatar
   
Dries committed
130

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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);
    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/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
338
  }
339
}
Dries's avatar
   
Dries committed
340

341
342
343
344
/**
 * Process language deletion submissions.
 */
function locale_admin_manage_delete_form_submit($form_id, $form_values) {
Dries's avatar
   
Dries committed
345
  $languages = locale_supported_languages(FALSE, TRUE);
346
347
348
349
350
351
352
353
354
355
  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();
356

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

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

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

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

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

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

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

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

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

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