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