Drupal HEAD(D7) Code Coverage - modules/locale/locale.module

1 <?php
2 // $Id: locale.module,v 1.234 2008/12/16 23:57:32 dries Exp $
3
4 /**
5 * @file
6 * Add language handling functionality and enables the translation of the
7 * user interface to languages other than English.
8 *
9 * When enabled, multiple languages can be set up. The site interface
10 * can be displayed in different languages, as well as nodes can have languages
11 * assigned. The setup of languages and translations is completely web based.
12 * Gettext portable object files are supported.
13 */
14
15 /**
16 * Language written left to right. Possible value of $language->direction.
17 */
18 define('LANGUAGE_LTR', 0);
19
20 /**
21 * Language written right to left. Possible value of $language->direction.
22 */
23 define('LANGUAGE_RTL', 1);
24
25
26 // ---------------------------------------------------------------------------------
27 // Hook implementations
28
29 /**
30 * Implementation of hook_help().
31 */
32 function locale_help($path, $arg) {
33 switch ($path) {
34 case 'admin/help#locale':
35 $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>';
36 $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>';
37 $output .= '<p>' . t('Translations may be provided by:') . '</p>';
38 $output .= '<ul><li>' . t("translating the original text via the locale module's integrated web interface, or") . '</li>';
39 $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>';
40 $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/build/translate/import'), '@export' => url('admin/build/translate/export'))) . '</p>';
41 $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>';
42 return $output;
43 case 'admin/settings/language':
44 $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>';
45 $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>';
46 $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/settings/language/add'), '@search' => url('admin/build/translate/search'), '@import' => url('admin/build/translate/import'), '@translations' => 'http://drupal.org/project/translations')) . '</p>';
47 $output .= '<p>' . t('To rearrange languages, grab a drag-and-drop handle under the <em>English name</em> column and drag the item to a new location in the list. (Grab a handle by clicking and holding the mouse while hovering over a handle icon.) Remember that your changes will not be saved until you click the <em>Save configuration</em> button at the bottom of the page.') . '</p>';
48 return $output;
49 case 'admin/settings/language/add':
50 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>';
51 case 'admin/settings/language/configure':
52 $output = '<p>' . t("Language negotiation settings determine the site's presentation language. Available options include:") . '</p>';
53 $output .= '<ul><li>' . t('<strong>None.</strong> The default language is used for site presentation, though users may (optionally) select a preferred language on the <em>My Account</em> page. (User language preferences will be used for site e-mails, if available.)') . '</li>';
54 $output .= '<li>' . t('<strong>Path prefix only.</strong> The presentation language is determined by examining the path for a language code or other custom string that matches the path prefix (if any) specified for each language. If a suitable prefix is not identified, the default language is used. <em>Example: "example.com/de/contact" sets presentation language to German based on the use of "de" within the path.</em>') . '</li>';
55 $output .= '<li>' . t("<strong>Path prefix with language fallback.</strong> The presentation language is determined by examining the path for a language code or other custom string that matches the path prefix (if any) specified for each language. If a suitable prefix is not identified, the display language is determined by the user's language preferences from the <em>My Account</em> page, or by the browser's language settings. If a presentation language cannot be determined, the default language is used.") . '</li>';
56 $output .= '<li>' . t('<strong>Domain name only.</strong> The presentation language is determined by examining the domain used to access the site, and comparing it to the language domain (if any) specified for each language. If a match is not identified, the default language is used. <em>Example: "http://de.example.com/contact" sets presentation language to German based on the use of "http://de.example.com" in the domain.</em>') . '</li></ul>';
57 $output .= '<p>' . t('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>.', array('@languages' => url('admin/settings/language'))) . '</p>';
58 return $output;
59 case 'admin/build/translate':
60 $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>';
61 $output .= '<p>' . t('Review the <a href="@languages">languages page</a> for more information on adding support for additional languages.', array('@languages' => url('admin/settings/language'))) . '</p>';
62 return $output;
63 case 'admin/build/translate/import':
64 $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>';
65 $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/settings/language/add'), '@translations' => 'http://drupal.org/project/translations')) . '</p>';
66 return $output;
67 case 'admin/build/translate/export':
68 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>';
69 case 'admin/build/translate/search':
70 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/build/translate/export'))) . '</p>';
71 case 'admin/build/block/configure':
72 if ($arg[4] == 'locale' && $arg[5] == 0) {
73 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/settings/language'), '@configuration' => url('admin/settings/language/configure'))) . '</p>';
74 }
75 break;
76 }
77 }
78
79 /**
80 * Implementation of hook_menu().
81 */
82 function locale_menu() {
83 // Manage languages
84 $items['admin/settings/language'] = array(
85 'title' => 'Languages',
86 'description' => 'Configure languages for content and the user interface.',
87 'page callback' => 'drupal_get_form',
88 'page arguments' => array('locale_languages_overview_form'),
89 'access arguments' => array('administer languages'),
90 );
91 $items['admin/settings/language/overview'] = array(
92 'title' => 'List',
93 'weight' => 0,
94 'type' => MENU_DEFAULT_LOCAL_TASK,
95 );
96 $items['admin/settings/language/add'] = array(
97 'title' => 'Add language',
98 'page callback' => 'locale_languages_add_screen', // two forms concatenated
99 'access arguments' => array('administer languages'),
100 'weight' => 5,
101 'type' => MENU_LOCAL_TASK,
102 );
103 $items['admin/settings/language/configure'] = array(
104 'title' => 'Configure',
105 'page callback' => 'drupal_get_form',
106 'page arguments' => array('locale_languages_configure_form'),
107 'access arguments' => array('administer languages'),
108 'weight' => 10,
109 'type' => MENU_LOCAL_TASK,
110 );
111 $items['admin/settings/language/edit/%'] = array(
112 'title' => 'Edit language',
113 'page callback' => 'drupal_get_form',
114 'page arguments' => array('locale_languages_edit_form', 4),
115 'access arguments' => array('administer languages'),
116 'type' => MENU_CALLBACK,
117 );
118 $items['admin/settings/language/delete/%'] = array(
119 'title' => 'Confirm',
120 'page callback' => 'drupal_get_form',
121 'page arguments' => array('locale_languages_delete_form', 4),
122 'access arguments' => array('administer languages'),
123 'type' => MENU_CALLBACK,
124 );
125
126 // Translation functionality
127 $items['admin/build/translate'] = array(
128 'title' => 'Translate interface',
129 'description' => 'Translate the built in interface and optionally other text.',
130 'page callback' => 'locale_translate_overview_screen', // not a form, just a table
131 'access arguments' => array('translate interface'),
132 );
133 $items['admin/build/translate/overview'] = array(
134 'title' => 'Overview',
135 'weight' => 0,
136 'type' => MENU_DEFAULT_LOCAL_TASK,
137 );
138 $items['admin/build/translate/search'] = array(
139 'title' => 'Search',
140 'weight' => 10,
141 'type' => MENU_LOCAL_TASK,
142 'page callback' => 'locale_translate_seek_screen', // search results and form concatenated
143 'access arguments' => array('translate interface'),
144 );
145 $items['admin/build/translate/import'] = array(
146 'title' => 'Import',
147 'page callback' => 'drupal_get_form',
148 'page arguments' => array('locale_translate_import_form'),
149 'access arguments' => array('translate interface'),
150 'weight' => 20,
151 'type' => MENU_LOCAL_TASK,
152 );
153 $items['admin/build/translate/export'] = array(
154 'title' => 'Export',
155 'page callback' => 'locale_translate_export_screen', // possibly multiple forms concatenated
156 'access arguments' => array('translate interface'),
157 'weight' => 30,
158 'type' => MENU_LOCAL_TASK,
159 );
160 $items['admin/build/translate/edit/%'] = array(
161 'title' => 'Edit string',
162 'page callback' => 'drupal_get_form',
163 'page arguments' => array('locale_translate_edit_form', 4),
164 'access arguments' => array('translate interface'),
165 'type' => MENU_CALLBACK,
166 );
167 $items['admin/build/translate/delete/%'] = array(
168 'title' => 'Delete string',
169 'page callback' => 'locale_translate_delete_page',
170 'page arguments' => array(4),
171 'access arguments' => array('translate interface'),
172 'type' => MENU_CALLBACK,
173 );
174
175 return $items;
176 }
177
178 /**
179 * Wrapper function to be able to set callbacks in locale.inc
180 */
181 function locale_inc_callback() {
182 $args = func_get_args();
183 $function = array_shift($args);
184 include_once DRUPAL_ROOT . '/includes/locale.inc';
185 return call_user_func_array($function, $args);
186 }
187
188 /**
189 * Implementation of hook_perm().
190 */
191 function locale_perm() {
192 return array(
193 'administer languages' => array(
194 'title' => t('Administer languages'),
195 'description' => t('Manage the languages in which the website content and interface text may be displayed.'),
196 ),
197 'translate interface' => array(
198 'title' => t('Translate the interface'),
199 'description' => t('Translate the text of the website interface.'),
200 ),
201 );
202 }
203
204 /**
205 * Implementation of hook_locale().
206 */
207 function locale_locale($op = 'groups') {
208 switch ($op) {
209 case 'groups':
210 return array('default' => t('Built-in interface'));
211 }
212 }
213
214 /**
215 * Implementation of hook_user_register().
216 */
217 function locale_user_register(&$edit, &$user, $category = NULL) {
218 // If we have more then one language and either creating a user on the
219 // admin interface or edit the user, show the language selector.
220 if (variable_get('language_count', 1) > 1 && user_access('administer users')) {
221 return locale_language_selector_form($user);
222 }
223 }
224
225 /**
226 * Implementation of hook_user_form().
227 */
228 function locale_user_form(&$edit, &$user, $category = NULL) {
229 // If we have more then one language and either creating a user on the
230 // admin interface or edit the user, show the language selector.
231 if (variable_get('language_count', 1) > 1 && $category == 'account') {
232 return locale_language_selector_form($user);
233 }
234 }
235
236 function locale_language_selector_form($user) {
237 global $language;
238 $languages = language_list('enabled');
239 $languages = $languages[1];
240
241 // If the user is being created, we set the user language to the page language.
242 $user_preferred_language = $user ? user_preferred_language($user) : $language;
243
244 $names = array();
245 foreach ($languages as $langcode => $item) {
246 $name = t($item->name);
247 $names[$langcode] = $name . ($item->native != $name ? ' (' . $item->native . ')' : '');
248 }
249 $form['locale'] = array(
250 '#type' => 'fieldset',
251 '#title' => t('Language settings'),
252 '#weight' => 1,
253 );
254
255 // Get language negotiation settings.
256 $mode = variable_get('language_negotiation', LANGUAGE_NEGOTIATION_NONE);
257 $form['locale']['language'] = array(
258 '#type' => (count($names) <= 5 ? 'radios' : 'select'),
259 '#title' => t('Language'),
260 '#default_value' => $user_preferred_language->language,
261 '#options' => $names,
262 '#description' => ($mode == LANGUAGE_NEGOTIATION_PATH) ? t("This account's default language for e-mails, and preferred language for site presentation.") : t("This account's default language for e-mails."),
263 );
264 return $form;
265 }
266
267 /**
268 * Implementation of hook_form_alter(). Adds language fields to forms.
269 */
270 function locale_form_alter(&$form, $form_state, $form_id) {
271 switch ($form_id) {
272
273 // Language field for paths
274 case 'path_admin_form':
275 $form['language'] = array(
276 '#type' => 'select',
277 '#title' => t('Language'),
278 '#options' => array('' => t('All languages')) + locale_language_list('name'),
279 '#default_value' => $form['language']['#value'],
280 '#weight' => -10,
281 '#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>.'),
282 );
283 break;
284
285 // Language setting for content types
286 case 'node_type_form':
287 if (isset($form['identity']['type'])) {
288 $form['workflow']['language_content_type'] = array(
289 '#type' => 'radios',
290 '#title' => t('Multilingual support'),
291 '#default_value' => variable_get('language_content_type_' . $form['#node_type']->type, 0),
292 '#options' => array(t('Disabled'), t('Enabled')),
293 '#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/settings/language'))),
294 );
295 }
296 break;
297
298 // Language field for nodes
299 default:
300 if (isset($form['#id']) && $form['#id'] == 'node-form') {
301 if (isset($form['#node']->type) && variable_get('language_content_type_' . $form['#node']->type, 0)) {
302 $form['language'] = array(
303 '#type' => 'select',
304 '#title' => t('Language'),
305 '#default_value' => (isset($form['#node']->language) ? $form['#node']->language : ''),
306 '#options' => array('' => t('Language neutral')) + locale_language_list('name'),
307 );
308 }
309 // Node type without language selector: assign the default for new nodes
310 elseif (!isset($form['#node']->nid)) {
311 $default = language_default();
312 $form['language'] = array(
313 '#type' => 'value',
314 '#value' => $default->language
315 );
316 }
317 }
318 }
319 }
320
321 /**
322 * Implementation of hook_theme().
323 */
324 function locale_theme() {
325 return array(
326 'locale_languages_overview_form' => array(
327 'arguments' => array('form' => array()),
328 ),
329 );
330 }
331
332 // ---------------------------------------------------------------------------------
333 // Locale core functionality
334
335 /**
336 * Provides interface translation services.
337 *
338 * This function is called from t() to translate a string if needed.
339 *
340 * @param $string
341 * A string to look up translation for. If omitted, all the
342 * cached strings will be returned in all languages already
343 * used on the page.
344 * @param $langcode
345 * Language code to use for the lookup.
346 * @param $reset
347 * Set to TRUE to reset the in-memory cache.
348 */
349 function locale($string = NULL, $langcode = NULL, $reset = FALSE) {
350 global $language;
351 static $locale_t;
352
353 if ($reset) {
354 // Reset in-memory cache.
355 $locale_t = NULL;
356 }
357
358 if (!isset($string)) {
359 // Return all cached strings if no string was specified
360 return $locale_t;
361 }
362
363 $langcode = isset($langcode) ? $langcode : $language->language;
364
365 // Store database cached translations in a static var.
366 if (!isset($locale_t[$langcode])) {
367 $locale_t[$langcode] = array();
368 // Disabling the usage of string caching allows a module to watch for
369 // the exact list of strings used on a page. From a performance
370 // perspective that is a really bad idea, so we have no user
371 // interface for this. Be careful when turning this option off!
372 if (variable_get('locale_cache_strings', 1) == 1) {
373 if ($cache = cache_get('locale:' . $langcode, 'cache')) {
374 $locale_t[$langcode] = $cache->data;
375 }
376 else {
377 // Refresh database stored cache of translations for given language.
378 // We only store short strings used in current version, to improve
379 // performance and consume less memory.
380 $result = db_query("SELECT s.source, t.translation, t.language FROM {locales_source} s LEFT JOIN {locales_target} t ON s.lid = t.lid AND t.language = '%s' WHERE s.textgroup = 'default' AND s.version = '%s' AND LENGTH(s.source) < 75", $langcode, VERSION);
381 while ($data = db_fetch_object($result)) {
382 $locale_t[$langcode][$data->source] = (empty($data->translation) ? TRUE : $data->translation);
383 }
384 cache_set('locale:' . $langcode, $locale_t[$langcode]);
385 }
386 }
387 }
388
389 // If we have the translation cached, skip checking the database
390 if (!isset($locale_t[$langcode][$string])) {
391
392 // We do not have this translation cached, so get it from the DB.
393 $translation = db_fetch_object(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 = '%s' WHERE s.source = '%s' AND s.textgroup = 'default'", $langcode, $string));
394 if ($translation) {
395 // We have the source string at least.
396 // Cache translation string or TRUE if no translation exists.
397 $locale_t[$langcode][$string] = (empty($translation->translation) ? TRUE : $translation->translation);
398
399 if ($translation->version != VERSION) {
400 // This is the first use of this string under current Drupal version. Save version
401 // and clear cache, to include the string into caching next time. Saved version is
402 // also a string-history information for later pruning of the tables.
403 db_query("UPDATE {locales_source} SET version = '%s' WHERE lid = %d", VERSION, $translation->lid);
404 cache_clear_all('locale:', 'cache', TRUE);
405 }
406 }
407 else {
408 // We don't have the source string, cache this as untranslated.
409 db_query("INSERT INTO {locales_source} (location, source, textgroup, version) VALUES ('%s', '%s', 'default', '%s')", request_uri(), $string, VERSION);
410 $locale_t[$langcode][$string] = TRUE;
411 // Clear locale cache so this string can be added in a later request.
412 cache_clear_all('locale:', 'cache', TRUE);
413 }
414 }
415
416 return ($locale_t[$langcode][$string] === TRUE ? $string : $locale_t[$langcode][$string]);
417 }
418
419 /**
420 * Returns plural form index for a specific number.
421 *
422 * The index is computed from the formula of this language.
423 *
424 * @param $count
425 * Number to return plural for.
426 * @param $langcode
427 * Optional language code to translate to a language other than
428 * what is used to display the page.
429 */
430 function locale_get_plural($count, $langcode = NULL) {
431 global $language;
432 static $locale_formula, $plurals = array();
433
434 $langcode = $langcode ? $langcode : $language->language;
435
436 if (!isset($plurals[$langcode][$count])) {
437 if (!isset($locale_formula)) {
438 $language_list = language_list();
439 $locale_formula[$langcode] = $language_list[$langcode]->formula;
440 }
441 if ($locale_formula[$langcode]) {
442 $n = $count;
443 $plurals[$langcode][$count] = @eval('return intval(' . $locale_formula[$langcode] . ');');
444 return $plurals[$langcode][$count];
445 }
446 else {
447 $plurals[$langcode][$count] = -1;
448 return -1;
449 }
450 }
451 return $plurals[$langcode][$count];
452 }
453
454
455 /**
456 * Returns a language name
457 */
458 function locale_language_name($lang) {
459 static $list = NULL;
460 if (!isset($list)) {
461 $list = locale_language_list();
462 }
463 return ($lang && isset($list[$lang])) ? $list[$lang] : t('All');
464 }
465
466 /**
467 * Returns array of language names
468 *
469 * @param $field
470 * 'name' => names in current language, localized
471 * 'native' => native names
472 * @param $all
473 * Boolean to return all languages or only enabled ones
474 */
475 function locale_language_list($field = 'name', $all = FALSE) {
476 if ($all) {
477 $languages = language_list();
478 }
479 else {
480 $languages = language_list('enabled');
481 $languages = $languages[1];
482 }
483 $list = array();
484 foreach ($languages as $language) {
485 $list[$language->language] = ($field == 'name') ? t($language->name) : $language->$field;
486 }
487 return $list;
488 }
489
490 /**
491 * Imports translations when new modules or themes are installed or enabled.
492 *
493 * This function will either import translation for the component change
494 * right away, or start a batch if more files need to be imported.
495 *
496 * @param $components
497 * An array of component (theme and/or module) names to import
498 * translations for.
499 */
500 function locale_system_update($components) {
501 include_once DRUPAL_ROOT . '/includes/locale.inc';
502 if ($batch = locale_batch_by_component($components)) {
503 batch_set($batch);
504 }
505 }
506
507 /**
508 * Implementation of hook_js_alter().
509 *
510 * This function checks all JavaScript files currently added via drupal_add_js()
511 * and invokes parsing if they have not yet been parsed for Drupal.t()
512 * and Drupal.formatPlural() calls. Also refreshes the JavaScript translation
513 * file if necessary, and adds it to the page.
514 */
515 function locale_js_alter(&$javascript) {
516 global $language;
517
518 $dir = file_create_path(variable_get('locale_js_directory', 'languages'));
519 $parsed = variable_get('javascript_parsed', array());
520 $files = $new_files = FALSE;
521
522 foreach ($javascript as $item) {
523 if ($item['type'] == 'file') {
524 $files = TRUE;
525 $filepath = $item['data'];
526 if (!in_array($filepath, $parsed)) {
527 // Don't parse our own translations files.
528 if (substr($filepath, 0, strlen($dir)) != $dir) {
529 locale_inc_callback('_locale_parse_js_file', $filepath);
530 watchdog('locale', 'Parsed JavaScript file %file.', array('%file' => $filepath));
531 $parsed[] = $filepath;
532 $new_files = TRUE;
533 }
534 }
535 }
536 }
537
538 // If there are any new source files we parsed, invalidate existing
539 // JavaScript translation files for all languages, adding the refresh
540 // flags into the existing array.
541 if ($new_files) {
542 $parsed += locale_inc_callback('_locale_invalidate_js');
543 }
544
545 // If necessary, rebuild the translation file for the current language.
546 if (!empty($parsed['refresh:' . $language->language])) {
547 // Don't clear the refresh flag on failure, so that another try will
548 // be performed later.
549 if (locale_inc_callback('_locale_rebuild_js')) {
550 unset($parsed['refresh:' . $language->language]);
551 }
552 // Store any changes after refresh was attempted.
553 variable_set('javascript_parsed', $parsed);
554 }
555 // If no refresh was attempted, but we have new source files, we need
556 // to store them too. This occurs if current page is in English.
557 elseif ($new_files) {
558 variable_set('javascript_parsed', $parsed);
559 }
560
561 // Add the translation JavaScript file to the page.
562 if ($files && !empty($language->javascript)) {
563 // Add the translation JavaScript file to the page.
564 $file = $dir . '/' . $language->language . '_' . $language->javascript . '.js';
565 $javascript[$file] = drupal_js_defaults($file);
566 }
567 }
568
569 // ---------------------------------------------------------------------------------
570 // Language switcher block
571
572 /**
573 * Implementation of hook_block_list().
574 */
575 function locale_block_list() {
576 $block['language-switcher']['info'] = t('Language switcher');
577 // Not worth caching.
578 $block['language-switcher']['cache'] = BLOCK_NO_CACHE;
579 return $block;
580 }
581
582 /**
583 * Implementation of hook_block_view().
584 *
585 * Displays a language switcher. Translation links may be provided by other modules.
586 * Only show if we have at least two languages and language dependent
587 * web addresses, so we can actually link to other language versions.
588 */
589 function locale_block_view($delta = '') {
590 if (variable_get('language_count', 1) > 1 && variable_get('language_negotiation', LANGUAGE_NEGOTIATION_NONE) != LANGUAGE_NEGOTIATION_NONE) {
591 $path = drupal_is_front_page() ? '<front>' : $_GET['q'];
592 $languages = language_list('enabled');
593 $links = array();
594 foreach ($languages[1] as $language) {
595 $links[$language->language] = array(
596 'href' => $path,
597 'title' => $language->native,
598 'language' => $language,
599 'attributes' => array('class' => 'language-link'),
600 );
601 }
602
603 // Allow modules to provide translations for specific links.
604 drupal_alter('translation_link', $links, $path);
605
606 $block['subject'] = t('Languages');
607 $block['content'] = theme('links', $links, array());
608 return $block;
609 }
610 }
611

Legend

Missed
lines code that were not excersized during program execution.
Covered
lines code were excersized during program execution.
Comment/non executable
Comment or non-executable line of code.
Dead
lines of code that according to xdebug could not be executed. This is counted as coverage code because in almost all cases it is code that runnable.