annotate modules/locale/locale.module @ 7:fff6d4c8c043 6.3

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