locale.module 45.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
/**
 * @file
6
7
 *   Add language handling functionality and enables the translation of the
 *   user interface to languages other than English.
Dries's avatar
   
Dries committed
8
 *
9
10
11
12
 *   When enabled, multiple languages can be set up. The site interface
 *   can be displayed in different languages, as well as nodes can have languages
 *   assigned. The setup of languages and translations is completely web based.
 *   Gettext portable object files are supported.
Dries's avatar
   
Dries committed
13
14
 */

15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
/**
 * The language is determined using a URL language indicator:
 * path prefix or domain according to the configuration.
 */
define('LOCALE_LANGUAGE_NEGOTIATION_URL', 'locale-url');

/**
 * The language is set based on the browser language settings.
 */
define('LOCALE_LANGUAGE_NEGOTIATION_BROWSER', 'locale-browser');

/**
 * The language is determined using the current content language.
 */
define('LOCALE_LANGUAGE_NEGOTIATION_CONTENT', 'locale-content');

/**
 * The language is set based on the user language settings.
 */
define('LOCALE_LANGUAGE_NEGOTIATION_USER', 'locale-user');

/**
 * The language is set based on the request/session parameters.
 */
define('LOCALE_LANGUAGE_NEGOTIATION_SESSION', 'locale-session');

Dries's avatar
   
Dries committed
41
// ---------------------------------------------------------------------------------
42
// Hook implementations
Dries's avatar
   
Dries committed
43

Dries's avatar
   
Dries committed
44
/**
45
 * Implement hook_help().
Dries's avatar
   
Dries committed
46
 */
47
48
function locale_help($path, $arg) {
  switch ($path) {
49
    case 'admin/help#locale':
50
51
52
53
54
      $output = '<p>' . t('The locale module allows your Drupal site to be presented in languages other than the default English, a defining feature of multi-lingual websites. The locale module works by examining text as it is about to be displayed: when a translation of the text is available in the language to be displayed, the translation is displayed rather than the original text. When a translation is unavailable, the original text is displayed, and then stored for later review by a translator.') . '</p>';
      $output .= '<p>' . t('Beyond translation of the Drupal interface, the locale module provides a feature set tailored to the needs of a multi-lingual site. Language negotiation allows your site to automatically change language based on the domain or path used for each request. Users may (optionally) select their preferred language on their <em>My account</em> page, and your site can be configured to honor a web browser\'s preferred language settings. Your site content can be created in (and translated to) any enabled language, and each post may have a language-appropriate alias for each of its translations. The locale module works in concert with the <a href="@content-help">content translation module</a> to manage translated content.', array('@content-help' => url('admin/help/translation'))) . '</p>';
      $output .= '<p>' . t('Translations may be provided by:') . '</p>';
      $output .= '<ul><li>' . t("translating the original text via the locale module's integrated web interface, or") . '</li>';
      $output .= '<li>' . t('importing files from a set of existing translations, known as a translation package. A translation package enables the display of a specific version of Drupal in a specific language, and contain files in the Gettext Portable Object (<em>.po</em>) format. Although not all languages are available for every version of Drupal, translation packages for many languages are available for download from the <a href="@translations">Drupal translation page</a>.', array('@translations' => 'http://drupal.org/project/translations')) . '</li></ul>';
55
      $output .= '<p>' . t('If an existing translation package does not meet your needs, the Gettext Portable Object (<em>.po</em>) files within a package may be modified, or new <em>.po</em> files may be created, using a desktop Gettext editor. The locale module\'s <a href="@import">import</a> feature allows the translated strings from a new or modified <em>.po</em> file to be added to your site. The locale module\'s <a href="@export">export</a> feature generates files from your site\'s translated strings, that can either be shared with others or edited offline by a Gettext translation editor.', array('@import' => url('admin/config/regional/translate/import'), '@export' => url('admin/config/regional/translate/export'))) . '</p>';
56
      $output .= '<p>' . t('For more information, see the online handbook entry for <a href="@locale">Locale module</a>.', array('@locale' => 'http://drupal.org/handbook/modules/locale/')) . '</p>';
57
      return $output;
58
    case 'admin/config/regional/language':
59
      $output = '<p>' . t("This page provides an overview of your site's enabled languages. If multiple languages are available and enabled, the text on your site interface may be translated, registered users may select their preferred language on the <em>My account</em> page, and site authors may indicate a specific language when creating posts. Languages will be displayed in the order you specify in places such as the language switcher block, or the language dropdown when creating or editing posts. The site's default language is used for anonymous visitors and for users who have not selected a preferred language.") . '</p>';
60
      $output .= '<p>' . t('For each language available on the site, use the <em>edit</em> link to configure language details, including name, an optional language-specific path or domain, and whether the language is natively presented either left-to-right or right-to-left. These languages also appear in the <em>Language</em> selection when creating a post of a content type with multilingual support.') . '</p>';
61
      $output .= '<p>' . t('Use the <a href="@add-language">add language page</a> to enable additional languages (and automatically import files from a translation package, if available), the <a href="@search">translate interface page</a> to locate strings for manual translation, or the <a href="@import">import page</a> to add translations from individual <em>.po</em> files. A number of contributed translation packages containing <em>.po</em> files are available on the <a href="@translations">Drupal.org translations page</a>.', array('@add-language' => url('admin/config/regional/language/add'), '@search' => url('admin/config/regional/translate/translate'), '@import' => url('admin/config/regional/translate/import'), '@translations' => 'http://drupal.org/project/translations')) . '</p>';
62
      $output .= '<p>' . t('Remember that your changes will not be saved until you click the <em>Save configuration</em> button at the bottom of the page.') . '</p>';
63
      return $output;
64
    case 'admin/config/regional/language/add':
65
      return '<p>' . t('Add all languages to be supported by your site. If your desired language is not available in the <em>Language name</em> drop-down, click <em>Custom language</em> and provide a language code and other details manually. When providing a language code manually, be sure to enter a standardized language code, since this code may be used by browsers to determine an appropriate display language.') . '</p>';
66
    case 'admin/config/regional/language/configure':
67
68
69
70
      $output = '<p>' . t("Language negotiation settings determine the site's content and presentation languages. For both <em>language types</em> there is a list of <em>language detection methods</em> which can be used to configure the desired language negotiation logic. Each detection method can be <em>dragged</em> to gain a higher priority, but it must be <em>enabled</em> to affect the language negotiation process. If a language detection method is applied then all the lower ones are <em>ignored</em>, otherwise the following one will be taken into account. Some lanaguage detection methods provide a configuration page to further specify their behavior. The <em>default</em> detection method is always applied, so anything below it is always ignored. <strong>Modifying this setting may break all incoming URLs and should be used with caution in a production environment.</strong>") . '</p>';
      $output .= '<p>' . t('Available options include:') .'</p>';
      $output .= '<ul><li>' . t('<strong>URL.</strong> The language is determined by examining the URL for a language code, a custom string, or a domain, that matches the ones (if any) specified for each language. The path prefix or domain name for a language may be set by editing the <a href="@languages">available languages</a>. In the absence of an appropriate match, the site is displayed in the <a href="@languages">default language</a>. A configuration is available to choose whether use the path prefix or the domain. <em>Example: "example.com/de/contact" sets language to German based on the use of "de" within the path. "http://de.example.com/contact" sets presentation language to German based on the use of "http://de.example.com" in the domain.</em>', array('@languages' => url('admin/config/regional/language'))) . '</li>';
      $output .= '<li>' . t('<strong>Session.</strong> The language is determined from a request/session parameter. A configuration is available to choose the URL parameter name to be used. <em>Example: "example.com?language=de" sets language to German based on the use of "de" within the "language" parameter.</em>') . '</li></ul>';
71
      return $output;
72
    case 'admin/config/regional/translate':
73
      $output = '<p>' . t('This page provides an overview of available translatable strings. Drupal displays translatable strings in text groups; modules may define additional text groups containing other translatable strings. Because text groups provide a method of grouping related strings, they are often used to focus translation efforts on specific areas of the Drupal interface.') . '</p>';
74
      $output .= '<p>' . t('Review the <a href="@languages">languages page</a> for more information on adding support for additional languages.', array('@languages' => url('admin/config/regional/language'))) . '</p>';
75
      return $output;
76
    case 'admin/config/regional/translate/import':
77
      $output = '<p>' . t('This page imports the translated strings contained in an individual Gettext Portable Object (<em>.po</em>) file. Normally distributed as part of a translation package (each translation package may contain several <em>.po</em> files), a <em>.po</em> file may need to be imported after offline editing in a Gettext translation editor. Importing an individual <em>.po</em> file may be a lengthy process.') . '</p>';
78
      $output .= '<p>' . t('Note that the <em>.po</em> files within a translation package are imported automatically (if available) when new modules or themes are enabled, or as new languages are added. Since this page only allows the import of one <em>.po</em> file at a time, it may be simpler to download and extract a translation package into your Drupal installation directory and <a href="@language-add">add the language</a> (which automatically imports all <em>.po</em> files within the package). Translation packages are available for download on the <a href="@translations">Drupal translation page</a>.', array('@language-add' => url('admin/config/regional/language/add'), '@translations' => 'http://drupal.org/project/translations')) . '</p>';
79
      return $output;
80
    case 'admin/config/regional/translate/export':
81
      return '<p>' . t('This page exports the translated strings used by your site. An export file may be in Gettext Portable Object (<em>.po</em>) form, which includes both the original string and the translation (used to share translations with others), or in Gettext Portable Object Template (<em>.pot</em>) form, which includes the original strings only (used to create new translations with a Gettext translation editor).') . '</p>';
82
83
    case 'admin/config/regional/translate/translate':
      return '<p>' . t('This page allows a translator to search for specific translated and untranslated strings, and is used when creating or editing translations. (Note: For translation tasks involving many strings, it may be more convenient to <a href="@export">export</a> strings for offline editing in a desktop Gettext translation editor.) Searches may be limited to strings found within a specific text group or in a specific language.', array('@export' => url('admin/config/regional/translate/export'))) . '</p>';
84
    case 'admin/structure/block/manage':
85
      if ($arg[4] == 'locale' && $arg[5] == 0) {
86
        return '<p>' . t('This block is only shown if <a href="@languages">at least two languages are enabled</a> and <a href="@configuration">language negotiation</a> is set to something other than <em>None</em>.', array('@languages' => url('admin/config/regional/language'), '@configuration' => url('admin/config/regional/language/configure'))) . '</p>';
87
88
      }
      break;
Dries's avatar
   
Dries committed
89
  }
Dries's avatar
   
Dries committed
90
91
}

Dries's avatar
   
Dries committed
92
/**
93
 * Implement hook_menu().
Dries's avatar
   
Dries committed
94
 */
95
function locale_menu() {
96
  // Manage languages
97
  $items['admin/config/regional/language'] = array(
98
    'title' => 'Languages',
99
    'description' => 'Configure languages for content and the user interface.',
100
101
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_languages_overview_form'),
102
    'access arguments' => array('administer languages'),
103
104
    'file' => 'locale.inc',
    'file path' => 'includes',
105
  );
106
  $items['admin/config/regional/language/overview'] = array(
107
    'title' => 'List',
108
109
110
    'weight' => 0,
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
111
  $items['admin/config/regional/language/add'] = array(
112
    'title' => 'Add language',
113
    'page callback' => 'locale_languages_add_screen', // two forms concatenated
114
    'access arguments' => array('administer languages'),
115
    'weight' => 5,
116
    'type' => MENU_LOCAL_ACTION,
117
118
    'file' => 'locale.inc',
    'file path' => 'includes',
119
  );
120
  $items['admin/config/regional/language/configure'] = array(
121
    'title' => 'Configure',
122
123
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_languages_configure_form'),
124
    'access arguments' => array('administer languages'),
125
    'weight' => 10,
126
127
    'file' => 'locale.inc',
    'file path' => 'includes',
128
129
    'type' => MENU_LOCAL_TASK,
  );
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
  $items['admin/config/regional/language/configure/url'] = array(
    'title' => 'URL language provider configuration',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_language_providers_url_form'),
    'access arguments' => array('administer languages'),
    'file' => 'locale.inc',
    'file path' => 'includes',
  );
  $items['admin/config/regional/language/configure/session'] = array(
    'title' => 'Session language provider configuration',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_language_providers_session_form'),
    'access arguments' => array('administer languages'),
    'file' => 'locale.inc',
    'file path' => 'includes',
  );
146
  $items['admin/config/regional/language/edit/%'] = array(
147
    'title' => 'Edit language',
148
    'page callback' => 'drupal_get_form',
149
    'page arguments' => array('locale_languages_edit_form', 5),
150
    'access arguments' => array('administer languages'),
151
152
    'file' => 'locale.inc',
    'file path' => 'includes',
153
154
    'type' => MENU_CALLBACK,
  );
155
  $items['admin/config/regional/language/delete/%'] = array(
156
    'title' => 'Confirm',
157
    'page callback' => 'drupal_get_form',
158
    'page arguments' => array('locale_languages_delete_form', 5),
159
    'access arguments' => array('administer languages'),
160
161
    'file' => 'locale.inc',
    'file path' => 'includes',
162
163
164
    'type' => MENU_CALLBACK,
  );

165
  // Translation functionality
166
  $items['admin/config/regional/translate'] = array(
167
    'title' => 'Translate interface',
168
    'description' => 'Translate the built in interface and optionally other text.',
169
170
    'page callback' => 'locale_inc_callback',
    'page arguments' => array('locale_translate_overview_screen'), // not a form, just a table
171
    'access arguments' => array('translate interface'),
172
173
    'file' => 'locale.inc',
    'file path' => 'includes',
174
  );
175
  $items['admin/config/regional/translate/overview'] = array(
176
    'title' => 'Overview',
177
178
179
    'weight' => 0,
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
180
  $items['admin/config/regional/translate/translate'] = array(
181
    'title' => 'Translate',
182
183
    'weight' => 10,
    'type' => MENU_LOCAL_TASK,
184
    'page callback' => 'locale_translate_seek_screen', // search results and form concatenated
185
    'access arguments' => array('translate interface'),
186
187
    'file' => 'locale.inc',
    'file path' => 'includes',
188
  );
189
  $items['admin/config/regional/translate/import'] = array(
190
    'title' => 'Import',
191
192
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_translate_import_form'),
193
    'access arguments' => array('translate interface'),
194
195
    'weight' => 20,
    'type' => MENU_LOCAL_TASK,
196
197
    'file' => 'locale.inc',
    'file path' => 'includes',
198
  );
199
  $items['admin/config/regional/translate/export'] = array(
200
    'title' => 'Export',
201
    'page callback' => 'locale_translate_export_screen',  // possibly multiple forms concatenated
202
    'access arguments' => array('translate interface'),
203
204
    'weight' => 30,
    'type' => MENU_LOCAL_TASK,
205
206
    'file' => 'locale.inc',
    'file path' => 'includes',
207
  );
208
  $items['admin/config/regional/translate/edit/%'] = array(
209
    'title' => 'Edit string',
210
    'page callback' => 'drupal_get_form',
211
    'page arguments' => array('locale_translate_edit_form', 5),
212
    'access arguments' => array('translate interface'),
213
    'type' => MENU_CALLBACK,
214
215
    'file' => 'locale.inc',
    'file path' => 'includes',
216
  );
217
  $items['admin/config/regional/translate/delete/%'] = array(
218
    'title' => 'Delete string',
219
    'page callback' => 'locale_translate_delete_page',
220
    'page arguments' => array(5),
221
    'access arguments' => array('translate interface'),
222
    'type' => MENU_CALLBACK,
223
224
    'file' => 'locale.inc',
    'file path' => 'includes',
225
  );
Dries's avatar
   
Dries committed
226

227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
  // Localize date formats.
  $items['admin/config/regional/date-time/locale'] = array(
    'title' => 'Localize',
    'description' => 'Configure date formats for each locale',
    'page callback' => 'locale_date_format_language_overview_page',
    'access arguments' => array('administer site configuration'),
    'type' => MENU_LOCAL_TASK,
    'weight' => -8,
    'file' => 'locale.inc',
    'file path' => 'includes',
  );
  $items['admin/config/regional/date-time/locale/%/edit'] = array(
    'title' => 'Localize date formats',
    'description' => 'Configure date formats for each locale',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_date_format_form', 5),
    'access arguments' => array('administer site configuration'),
    'type' => MENU_CALLBACK,
    'file' => 'locale.inc',
    'file path' => 'includes',
  );
  $items['admin/config/regional/date-time/locale/%/reset'] = array(
    'title' => 'Reset date formats',
    'description' => 'Reset localized date formats to global defaults',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('locale_date_format_reset_form', 5),
    'access arguments' => array('administer site configuration'),
    'type' => MENU_CALLBACK,
    'file' => 'locale.inc',
    'file path' => 'includes',
  );

Dries's avatar
   
Dries committed
259
  return $items;
Dries's avatar
   
Dries committed
260
261
}

262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
/**
 * Implements hook_init().
 *
 * Initialize date formats according to the user's current locale.
 */
function locale_init() {
  global $conf, $language;
  include_once DRUPAL_ROOT . '/includes/locale.inc';

  // For each date type (e.g. long, short), get the localized date format
  // for the user's current language and override the default setting for it
  // in $conf. This should happen on all pages except the date and time formats
  // settings page, where we want to display the site default and not the
  // localized version.
  if (strpos($_GET['q'], 'admin/config/regional/date-time/formats') !== 0) {
    $languages = array($language->language);

    // Setup appropriate date formats for this locale.
    $formats = locale_get_localized_date_format($languages);
    foreach ($formats as $format_type => $format) {
      $conf[$format_type] = $format;
    }
  }
}

287
288
289
290
291
292
/**
 * Wrapper function to be able to set callbacks in locale.inc
 */
function locale_inc_callback() {
  $args = func_get_args();
  $function = array_shift($args);
293
  include_once DRUPAL_ROOT . '/includes/locale.inc';
294
295
296
  return call_user_func_array($function, $args);
}

Dries's avatar
   
Dries committed
297
/**
298
 * Implement hook_permission().
Dries's avatar
   
Dries committed
299
 */
300
function locale_permission() {
301
  return array(
302
303
304
305
306
307
308
309
    'administer languages' => array(
      'title' => t('Administer languages'),
      'description' => t('Manage the languages in which the website content and interface text may be displayed.'),
    ),
    'translate interface' => array(
      'title' => t('Translate the interface'),
      'description' => t('Translate the text of the website interface.'),
    ),
310
  );
311
312
313
}

/**
314
 * Implement hook_locale().
315
316
317
318
319
320
 */
function locale_locale($op = 'groups') {
  switch ($op) {
    case 'groups':
      return array('default' => t('Built-in interface'));
  }
Dries's avatar
   
Dries committed
321
322
323
}

/**
324
325
326
327
 * Form builder callback to display language selection widget.
 *
 * @ingroup forms
 * @see locale_form_alter()
328
 */
329
function locale_language_selector_form(&$form, &$form_state, $user) {
330
331
332
  global $language;
  $languages = language_list('enabled');
  $languages = $languages[1];
333

334
  // If the user is being created, we set the user language to the page language.
335
  $user_preferred_language = $user->uid ? user_preferred_language($user) : $language;
Dries's avatar
Dries committed
336

337
338
339
340
  $names = array();
  foreach ($languages as $langcode => $item) {
    $name = t($item->name);
    $names[$langcode] = $name . ($item->native != $name ? ' (' . $item->native . ')' : '');
Dries's avatar
   
Dries committed
341
  }
342
343
344
345
346
347
348
  $form['locale'] = array(
    '#type' => 'fieldset',
    '#title' => t('Language settings'),
    '#weight' => 1,
  );

  // Get language negotiation settings.
349
  $mode = language_negotiation_get(LANGUAGE_TYPE_INTERFACE) != LANGUAGE_NEGOTIATION_DEFAULT;
350
351
352
353
354
  $form['locale']['language'] = array(
    '#type' => (count($names) <= 5 ? 'radios' : 'select'),
    '#title' => t('Language'),
    '#default_value' => $user_preferred_language->language,
    '#options' => $names,
355
    '#description' => $mode ? t("This account's default language for e-mails, and preferred language for site presentation.") : t("This account's default language for e-mails."),
356
  );
Dries's avatar
   
Dries committed
357
358
}

359
/**
360
 * Implement hook_form_FORM_ID_alter().
361
362
363
364
365
366
367
368
369
370
371
372
373
 */
function locale_form_path_admin_form_alter(&$form, &$form_state) {
  $form['language'] = array(
    '#type' => 'select',
    '#title' => t('Language'),
    '#options' => array('' => t('All languages')) + locale_language_list('name'),
    '#default_value' => $form['language']['#value'],
    '#weight' => -10,
    '#description' => t('A path alias set for a specific language will always be used when displaying this page in that language, and takes precedence over path aliases set for <em>All languages</em>.'),
  );
}

/**
374
 * Implement hook_form_FORM_ID_alter().
375
 */
376
377
378
379
380
381
382
function locale_form_node_type_form_alter(&$form, &$form_state) {
  if (isset($form['identity']['type'])) {
    $form['workflow']['language_content_type'] = array(
      '#type' => 'radios',
      '#title' => t('Multilingual support'),
      '#default_value' => variable_get('language_content_type_' . $form['#node_type']->type, 0),
      '#options' => array(t('Disabled'), t('Enabled')),
383
      '#description' => t('Enable multilingual support for this content type. If enabled, a language selection field will be added to the editing form, allowing you to select from one of the <a href="!languages">enabled languages</a>. If disabled, new posts are saved with the default language. Existing content will not be affected by changing this option.', array('!languages' => url('admin/config/regional/language'))),
384
385
386
    );
  }
}
387

388
389
390
391
392
393
394
395
396
397
/**
 * Return whether the given content type has multilingual support.
 *
 * @return
 *   True if multilingual support is enabled.
 */
function locale_multilingual_node_type($type_name) {
  return (bool) variable_get('language_content_type_' . $type_name, 0);
}

398
/**
399
400
401
 * Implement hook_form_alter().
 *
 * Adds language fields to forms.
402
403
 */
function locale_form_alter(&$form, &$form_state, $form_id) {
404
  // Only alter user forms if there is more than one language.
405
  if (drupal_multilingual()) {
406
407
    // Display language selector when either creating a user on the admin
    // interface or editing a user account.
408
    if (($form_id == 'user_register_form' && user_access('administer users')) || ($form_id == 'user_profile_form' && $form['#user_category'] == 'account')) {
409
410
411
      locale_language_selector_form($form, $form_state, $form['#user']);
    }
  }
412
  if (isset($form['#id']) && $form['#id'] == 'node-form') {
413
    if (isset($form['#node']->type) && locale_multilingual_node_type($form['#node']->type)) {
414
      $form['language'] = array(
415
        '#type' => 'select',
416
        '#title' => t('Language'),
417
418
        '#default_value' => (isset($form['#node']->language) ? $form['#node']->language : ''),
        '#options' => array('' => t('Language neutral')) + locale_language_list('name'),
419
      );
420
421
422
423
424
425
426
427
428
    }
    // Node type without language selector: assign the default for new nodes
    elseif (!isset($form['#node']->nid)) {
      $default = language_default();
      $form['language'] = array(
        '#type' => 'value',
        '#value' => $default->language
      );
    }
429
430
431
432
433
434
435
436
437
438
439
440
441
442
    $form['#submit'][] = 'locale_field_node_form_submit';
  }
}

/**
 * Form submit handler for node_form().
 *
 * Check if Locale is registered as a translation handler and handle possible
 * node language changes.
 */
function locale_field_node_form_submit($form, &$form_state) {
  if (field_multilingual_check_translation_handlers('node', 'locale')) {
    module_load_include('inc', 'locale', 'locale.field');
    locale_field_node_form_update_field_language($form, $form_state);
443
444
445
  }
}

446
/**
447
 * Implement hook_theme().
448
449
450
451
452
453
 */
function locale_theme() {
  return array(
    'locale_languages_overview_form' => array(
      'arguments' => array('form' => array()),
    ),
454
455
456
    'locale_languages_configure_form' => array(
      'arguments' => array('form' => array()),
    ),
457
458
459
    'locale_translation_filters' => array(
      'arguments' => array('form' => array()),
    ),
460
461
462
    'locale_date_format_form' => array(
      'arguments' => array('form' => array()),
    ),
463
464
  );
}
465

466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
/**
 * Implement hook_field_attach_view_alter().
 */
function locale_field_attach_view_alter(&$output, $context) {
  // In locale_field_fallback_view() we might call field_attach_view(). The
  // static variable avoids unnecessary recursion. 
  static $recursion;

  // Do not apply fallback rules if disabled or if Locale is not registered as a
  // translation handler.
  if (!$recursion && variable_get('locale_field_fallback_view', TRUE) && field_multilingual_check_translation_handlers($context['obj_type'], 'locale')) {
    $recursion = TRUE;
    module_load_include('inc', 'locale', 'locale.field');
    locale_field_fallback_view($output, $context);
    $recursion = FALSE;
  }
}

/**
 * Implement hook_entity_info_alter().
 */
function locale_entity_info_alter(&$entity_info) {
  $enabled = drupal_multilingual();
  foreach ($entity_info as $type => $info) {
    $entity_info[$type]['translation']['locale'] = $enabled;
  }
}

494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
/**
 * Implement hook_language_types_info().
 */
function locale_language_types_info() {
  return array(
    LANGUAGE_TYPE_CONTENT => array(
      'name' => t('Content'),
      'description' => t('If a piece of content is available in multiple languages, the one matching the <em>content</em> language will be used.'),
    ),
    LANGUAGE_TYPE_INTERFACE => array(
      'name' => t('Interface'),
      'description' => t('The interface labels will be displayed in the <em>interface</em> language.'),
    ),
    LANGUAGE_TYPE_URL => array(
      'fixed' => array(LOCALE_LANGUAGE_NEGOTIATION_URL),
    ),
  );
}

/**
 * Implement hook_language_negotiation_info().
 */
function locale_language_negotiation_info() {
  $file = 'includes/locale.inc';
  $providers = array();

  $providers[LOCALE_LANGUAGE_NEGOTIATION_URL] = array(
    'types' => array(LANGUAGE_TYPE_CONTENT, LANGUAGE_TYPE_INTERFACE, LANGUAGE_TYPE_URL),
    'callbacks' => array(
      'language' => 'locale_language_from_url',
      'switcher' => 'locale_language_switcher_url',
      'url_rewrite' => 'locale_language_url_rewrite_url',
    ),
    'file' => $file,
    'weight' => -8,
    'name' => t('URL'),
    'description' => t('The language is determined from the URL (Path prefix or domain).'),
    'config' => 'admin/config/regional/language/configure/url',
  );

  $providers[LOCALE_LANGUAGE_NEGOTIATION_SESSION] = array(
    'callbacks' => array(
      'language' => 'locale_language_from_session',
      'switcher' => 'locale_language_switcher_session',
      'url_rewrite' => 'locale_language_url_rewrite_session',
    ),
    'file' => $file,
    'weight' => -6,
    'name' => t('Session'),
    'description' => t('The language is determined from a request/session parameter.'),
    'config' => 'admin/config/regional/language/configure/session',
  );

  $providers[LOCALE_LANGUAGE_NEGOTIATION_USER] = array(
    'callbacks' => array('language' => 'locale_language_from_user'),
    'file' => $file,
    'weight' => -4,
    'name' => t('User'),
    'description' => t('The language is determined from the language preference set in the user account.'),
  );

  $providers[LOCALE_LANGUAGE_NEGOTIATION_BROWSER] = array(
    'callbacks' => array('language' => 'locale_language_from_browser'),
    'name' => $file,
    'weight' => -2,
    'cache' => CACHE_DISABLED,
    'name' => t('Browser'),
    'description' => t('The language is determined from the browser\'s language settings.'),
  );

  $providers[LOCALE_LANGUAGE_NEGOTIATION_CONTENT] = array(
    'types' => array(LANGUAGE_TYPE_INTERFACE),
    'callbacks' => array('language' => 'locale_language_from_content'),
    'file' => $file,
    'weight' => 8,
    'name' => t('Content'),
    'description' => t('The interface language is the same as the negotiated content language.'),
  );

  return $providers;
}

Dries's avatar
   
Dries committed
576
// ---------------------------------------------------------------------------------
577
// Locale core functionality
Dries's avatar
   
Dries committed
578

Dries's avatar
   
Dries committed
579
/**
580
 * Provides interface translation services.
Dries's avatar
   
Dries committed
581
582
 *
 * This function is called from t() to translate a string if needed.
583
584
585
 *
 * @param $string
 *   A string to look up translation for. If omitted, all the
586
 *   cached strings will be returned in all languages already
587
 *   used on the page.
588
589
 * @param $context
 *   The context of this string.
590
591
 * @param $langcode
 *   Language code to use for the lookup.
592
593
 * @param $reset
 *   Set to TRUE to reset the in-memory cache.
Dries's avatar
   
Dries committed
594
 */
595
function locale($string = NULL, $context = NULL, $langcode = NULL, $reset = FALSE) {
596
  global $language;
Dries's avatar
   
Dries committed
597
  static $locale_t;
Dries's avatar
   
Dries committed
598

599
600
  if ($reset) {
    // Reset in-memory cache.
601
    $locale_t = NULL;
602
  }
603

604
  if (!isset($string)) {
605
    // Return all cached strings if no string was specified
606
607
608
    return $locale_t;
  }

609
610
  $langcode = isset($langcode) ? $langcode : $language->language;

611
  // Store database cached translations in a static var.
612
613
  if (!isset($locale_t[$langcode])) {
    $locale_t[$langcode] = array();
614
615
616
    // Disabling the usage of string caching allows a module to watch for
    // the exact list of strings used on a page. From a performance
    // perspective that is a really bad idea, so we have no user
617
618
    // interface for this. Be careful when turning this option off!
    if (variable_get('locale_cache_strings', 1) == 1) {
619
      if ($cache = cache_get('locale:' . $langcode, 'cache')) {
620
621
        $locale_t[$langcode] = $cache->data;
      }
622
      elseif (lock_acquire('locale_cache_' . $langcode)) {
623
624
625
        // Refresh database stored cache of translations for given language.
        // We only store short strings used in current version, to improve
        // performance and consume less memory.
626
        $result = db_query("SELECT s.source, s.context, t.translation, t.language FROM {locales_source} s LEFT JOIN {locales_target} t ON s.lid = t.lid AND t.language = :language WHERE s.textgroup = 'default' AND s.version = :version AND LENGTH(s.source) < 75", array(':language' => $langcode, ':version' => VERSION));
627
        foreach ($result as $data) {
628
          $locale_t[$langcode][$data->context][$data->source] = (empty($data->translation) ? TRUE : $data->translation);
629
        }
630
        cache_set('locale:' . $langcode, $locale_t[$langcode]);
631
        lock_release('locale_cache_' . $langcode);
632
      }
633
    }
Dries's avatar
   
Dries committed
634
635
  }

636
  // If we have the translation cached, skip checking the database
637
  if (!isset($locale_t[$langcode][$context][$string])) {
Dries's avatar
   
Dries committed
638

639
    // We do not have this translation cached, so get it from the DB.
640
    $translation = db_query("SELECT s.lid, t.translation, s.version FROM {locales_source} s LEFT JOIN {locales_target} t ON s.lid = t.lid AND t.language = :language WHERE s.source = :source AND s.context = :context AND s.textgroup = 'default'", array(
641
642
      ':language' => $langcode,
      ':source' => $string,
643
      ':context' => (string) $context,
644
    ))->fetchObject();
645
646
    if ($translation) {
      // We have the source string at least.
647
      // Cache translation string or TRUE if no translation exists.
648
      $locale_t[$langcode][$context][$string] = (empty($translation->translation) ? TRUE : $translation->translation);
649
650
651
652
653

      if ($translation->version != VERSION) {
        // This is the first use of this string under current Drupal version. Save version
        // and clear cache, to include the string into caching next time. Saved version is
        // also a string-history information for later pruning of the tables.
654
655
656
657
        db_update('locales_source')
          ->fields(array('version' => VERSION))
          ->condition('lid', $translation->lid)
          ->execute();
658
        cache_clear_all('locale:', 'cache', TRUE);
659
      }
Dries's avatar
   
Dries committed
660
661
    }
    else {
662
      // We don't have the source string, cache this as untranslated.
663
664
665
666
      db_insert('locales_source')
        ->fields(array(
          'location' => request_uri(),
          'source' => $string,
667
          'context' => (string) $context,
668
669
670
671
          'textgroup' => 'default',
          'version' => VERSION,
        ))
        ->execute();
672
      $locale_t[$langcode][$context][$string] = TRUE;
673
      // Clear locale cache so this string can be added in a later request.
674
      cache_clear_all('locale:', 'cache', TRUE);
Dries's avatar
   
Dries committed
675
    }
Dries's avatar
   
Dries committed
676
677
  }

678
  return ($locale_t[$langcode][$context][$string] === TRUE ? $string : $locale_t[$langcode][$context][$string]);
Dries's avatar
   
Dries committed
679
}
Dries's avatar
   
Dries committed
680

Dries's avatar
   
Dries committed
681
/**
682
 * Returns plural form index for a specific number.
Dries's avatar
   
Dries committed
683
 *
684
 * The index is computed from the formula of this language.
685
 *
686
687
688
689
690
 * @param $count
 *   Number to return plural for.
 * @param $langcode
 *   Optional language code to translate to a language other than
 *   what is used to display the page.
Dries's avatar
   
Dries committed
691
 */
692
function locale_get_plural($count, $langcode = NULL) {
693
  global $language;
Dries's avatar
   
Dries committed
694
695
  static $locale_formula, $plurals = array();

696
  $langcode = $langcode ? $langcode : $language->language;
697

698
  if (!isset($plurals[$langcode][$count])) {
Dries's avatar
   
Dries committed
699
    if (!isset($locale_formula)) {
700
701
      $language_list = language_list();
      $locale_formula[$langcode] = $language_list[$langcode]->formula;
Dries's avatar
   
Dries committed
702
    }
703
    if ($locale_formula[$langcode]) {
Dries's avatar
   
Dries committed
704
      $n = $count;
705
      $plurals[$langcode][$count] = @eval('return intval(' . $locale_formula[$langcode] . ');');
706
      return $plurals[$langcode][$count];
Dries's avatar
   
Dries committed
707
708
    }
    else {
709
      $plurals[$langcode][$count] = -1;
Dries's avatar
   
Dries committed
710
      return -1;
711
    }
Dries's avatar
   
Dries committed
712
  }
713
  return $plurals[$langcode][$count];
714
}
Dries's avatar
   
Dries committed
715

716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733

/**
 * Returns a language name
 */
function locale_language_name($lang) {
  static $list = NULL;
  if (!isset($list)) {
    $list = locale_language_list();
  }
  return ($lang && isset($list[$lang])) ? $list[$lang] : t('All');
}

/**
 * Returns array of language names
 *
 * @param $field
 *   'name' => names in current language, localized
 *   'native' => native names
734
735
 * @param $all
 *   Boolean to return all languages or only enabled ones
736
 */
737
738
739
740
741
742
743
744
function locale_language_list($field = 'name', $all = FALSE) {
  if ($all) {
    $languages = language_list();
  }
  else {
    $languages = language_list('enabled');
    $languages = $languages[1];
  }
745
  $list = array();
746
  foreach ($languages as $language) {
747
748
749
750
    $list[$language->language] = ($field == 'name') ? t($language->name) : $language->$field;
  }
  return $list;
}
751
752
753
754
755
756
757
758
759
760
761
762

/**
 * Imports translations when new modules or themes are installed or enabled.
 *
 * This function will either import translation for the component change
 * right away, or start a batch if more files need to be imported.
 *
 * @param $components
 *   An array of component (theme and/or module) names to import
 *   translations for.
 */
function locale_system_update($components) {
763
  include_once DRUPAL_ROOT . '/includes/locale.inc';
764
  if ($batch = locale_batch_by_component($components)) {
765
766
767
768
    batch_set($batch);
  }
}

769
/**
770
 * Implement hook_js_alter().
771
772
773
774
775
776
 *
 * This function checks all JavaScript files currently added via drupal_add_js()
 * and invokes parsing if they have not yet been parsed for Drupal.t()
 * and Drupal.formatPlural() calls. Also refreshes the JavaScript translation
 * file if necessary, and adds it to the page.
 */
777
function locale_js_alter(&$javascript) {
778
779
  global $language;

780
  $dir = 'public://' . variable_get('locale_js_directory', 'languages');
781
782
783
  $parsed = variable_get('javascript_parsed', array());
  $files = $new_files = FALSE;

784
785
786
787
788
789
790
791
792
793
794
  foreach ($javascript as $item) {
    if ($item['type'] == 'file') {
      $files = TRUE;
      $filepath = $item['data'];
      if (!in_array($filepath, $parsed)) {
        // Don't parse our own translations files.
        if (substr($filepath, 0, strlen($dir)) != $dir) {
          locale_inc_callback('_locale_parse_js_file', $filepath);
          watchdog('locale', 'Parsed JavaScript file %file.', array('%file' => $filepath));
          $parsed[] = $filepath;
          $new_files = TRUE;
795
796
797
798
799
800
801
802
803
804
805
806
807
        }
      }
    }
  }

  // If there are any new source files we parsed, invalidate existing
  // JavaScript translation files for all languages, adding the refresh
  // flags into the existing array.
  if ($new_files) {
    $parsed += locale_inc_callback('_locale_invalidate_js');
  }

  // If necessary, rebuild the translation file for the current language.
808
  if (!empty($parsed['refresh:' . $language->language])) {
809
810
811
    // Don't clear the refresh flag on failure, so that another try will
    // be performed later.
    if (locale_inc_callback('_locale_rebuild_js')) {
812
      unset($parsed['refresh:' . $language->language]);
813
814
815
816
817
818
    }
    // Store any changes after refresh was attempted.
    variable_set('javascript_parsed', $parsed);
  }
  // If no refresh was attempted, but we have new source files, we need
  // to store them too. This occurs if current page is in English.
819
  elseif ($new_files) {
820
821
822
823
824
    variable_set('javascript_parsed', $parsed);
  }

  // Add the translation JavaScript file to the page.
  if ($files && !empty($language->javascript)) {
825
826
827
    // Add the translation JavaScript file to the page.
    $file = $dir . '/' . $language->language . '_' . $language->javascript . '.js';
    $javascript[$file] = drupal_js_defaults($file);
828
829
830
  }
}

831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
/*
 * Implement hook_css_alter().
 *
 * This function checks all CSS files currently added via drupal_add_css() and
 * and checks to see if a related right to left CSS file should be included.
 */
function locale_css_alter(&$css) {
  global $language;

  // If the current language is RTL, add the CSS file with the RTL overrides.
  if ($language->direction == LANGUAGE_RTL) {
    foreach ($css as $data => $item) {
      // Only provide RTL overrides for files.
      if ($item['type'] == 'file') {
        $rtl_path = str_replace('.css', '-rtl.css', $item['data']);
        if (file_exists($rtl_path) && !isset($css[$rtl_path])) {
          // Replicate the same item, but with the RTL path and a little larger
          // weight so that it appears directly after the original CSS file.
          $item['data'] = $rtl_path;
          $item['weight'] += 0.01;
          $css[$rtl_path] = $item;
        }
      }
    }
  }
}

858
859
860
861
// ---------------------------------------------------------------------------------
// Language switcher block

/**
862
 * Implement hook_block_info().
863
 */
864
function locale_block_info() {
865
866
867
868
869
870
871
872
873
874
  include_once DRUPAL_ROOT . '/includes/language.inc';
  $block = array();
  $info = language_types_info();
  foreach (language_types_configurable() as $type) {
    $block[$type] = array(
      'info' => t('Language switcher (@type)', array('@type' => $info[$type]['name'])),
      // Not worth caching.
      'cache' => DRUPAL_NO_CACHE,
    );
  }
875
876
  return $block;
}
877

878
/**
879
 * Implement hook_block_view().
880
 *
881
 * Displays a language switcher. Only show if we have at least two languages.
882
 */
883
function locale_block_view($type) {
884
  if (drupal_multilingual()) {
885
    $path = drupal_is_front_page() ? '<front>' : $_GET['q'];
886
887
888
889
890
891
892
893
    $links = language_negotiation_get_switch_links($type, $path);

    if (isset($links->links) && count($links->links > 1)) {
      $class = "language-switcher-{$links->provider}";
      $variables = array('links' => $links->links, 'attributes' => array('class' => array($class)));
      $block['content'] = theme('links', $variables);
      $block['subject'] = t('Languages');
      return $block;
894
895
896
    }
  }
}
897
898
899
900
901
902

/**
 * Theme locale translation filter selector.
 *
 * @ingroup themeable
 */
903
904
function theme_locale_translation_filters($variables) {
  $form = $variables['form'];
905
  $output = '';
906

907
908
909
910
911
912
  foreach (element_children($form['status']) as $key) {
    $output .= drupal_render($form['status'][$key]);
  }
  $output .= '<div id="locale-translation-buttons">' . drupal_render($form['buttons']) . '</div>';
  return $output;
}
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069

/**
 * Theme locale date format form.
 *
 * @ingroup themeable
 */
function theme_locale_date_format_form($variables) {
  $form = $variables['form'];
  $header = array(
    t('Date type'),
    t('Format'),
  );

  foreach (element_children($form['date_formats']) as $key) {
    $row = array();
    $row[] = $form['date_formats'][$key]['#title'];
    unset($form['date_formats'][$key]['#title']);
    $row[] = array('data' => drupal_render($form['date_formats'][$key]));
    $rows[] = $row;
  }

  $output = drupal_render($form['language']);
  $output .= theme('table', array('header' => $header, 'rows' => $rows));
  $output .= drupal_render_children($form);

  return $output;
}

/**
 * Display edit date format links for each language.
 */
function locale_date_format_language_overview_page() {
  $header = array(
    t('Language'),
    array('data' => t('Operations'), 'colspan' => '2'),
  );

  // Get list of languages.
  $languages = locale_language_list('native');

  foreach ($languages as $langcode => $info) {
    $row = array();
    $row[] = $languages[$langcode];
    $row[] = l(t('edit'), 'admin/config/regional/date-time/locale/' . $langcode . '/edit');
    $row[] = l(t('reset'), 'admin/config/regional/date-time/locale/' . $langcode . '/reset');
    $rows[] = $row;
  }

  return theme('table', array('header' => $header, 'rows' => $rows));
}

/**
 * Provide date localization configuration options to users.
 */
function locale_date_format_form($form, &$form_state, $langcode) {
  $languages = locale_language_list('native');
  $language_name = $languages[$langcode];

  // Display the current language name.
  $form['language'] = array(
    '#type' => 'item',
    '#title' => t('Language'),
    '#markup' => check_plain($language_name),
    '#weight' => -10,
  );
  $form['langcode'] = array(
    '#type' => 'value',
    '#value' => $langcode,
  );

  // Get list of date format types.
  $types = system_get_date_types();

  // Get list of available formats.
  $formats = system_get_date_formats();
  $choices = array();
  foreach ($formats as $type => $list) {
    foreach ($list as $f => $format) {
      $choices[$f] = format_date(REQUEST_TIME, 'custom', $f);
    }
  }

  // Get configured formats for each language.
  $locale_formats = system_date_format_locale($langcode);
  // Display a form field for each format type.
  foreach ($types as $type => $type_info) {
    if (!empty($locale_formats) && in_array($type, array_keys($locale_formats))) {
      $default = $locale_formats[$type];
    }
    else {
      $default = variable_get('date_format_' . $type, array_shift(array_keys($formats)));
    }

    // Show date format select list.
    $form['date_formats']['date_format_' . $type] = array(
      '#type' => 'select',
      '#title' => check_plain($type_info['title']),
      '#attributes' => array('class' => array('date-format')),
      '#default_value' => (isset($choices[$default]) ? $default : 'custom'),
      '#options' => $choices,
    );
  }

  $form['buttons']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save configuration'),
  );

  return $form;
}

/**
 * Submit handler for configuring localized date formats on the locale_date_format_form.
 */
function locale_date_format_form_submit($form, &$form_state) {
  include_once DRUPAL_ROOT . '/includes/locale.inc';
  $langcode = $form_state['values']['langcode'];

  // Get list of date format types.
  $types = system_get_date_types();
  foreach ($types as $type => $type_info) {
    $format = $form_state['values']['date_format_' . $type];
    if ($format == 'custom') {
      $format = $form_state['values']['date_format_' . $type . '_custom'];
    }
    locale_date_format_save($langcode, $type, $format);
  }
  drupal_set_message(t('Configuration saved.'));
  $form_state['redirect'] = 'admin/config/regional/date-time/locale';
}

/**
 * Reset locale specific date formats to the global defaults.
 *
 * @param $langcode
 *   Language code, e.g. 'en'.
 */
function locale_date_format_reset_form($form, &$form_state, $langcode) {
  $form['langcode'] = array('#type' => 'value', '#value' => $langcode);
  $languages = language_list();
  return confirm_form($form,
    t('Are you sure you want to reset the date formats for %language to the global defaults?', array('%language' => $languages[$langcode]->name)),
    'admin/config/regional/date-time/locale',
    t('Resetting will remove all localized date formats for this language. This action cannot be undone.'),
    t('Reset'), t('Cancel'));
}

/**
 * Reset date formats for a specific language to global defaults.
 */
function locale_date_format_reset_form_submit($form, &$form_state) {
  db_delete('date_format_locale')
    ->condition('language', $form_state['values']['langcode'])
    ->execute();
  $form_state['redirect'] = 'admin/config/regional/date-time/locale';
}