<?php

// $Id: locale.module,v 1.212.2.6 2009/02/25 11:47:37 goba Exp $

/**

 * @file

 *   Add language handling functionality and enables the translation of the

 *   user interface to languages other than English.

 *

 *   When enabled, multiple languages can be set up. The site interface

 *   can be displayed in different languages, as well as nodes can have languages

 *   assigned. The setup of languages and translations is completely web based.

 *   Gettext portable object files are supported.

 */

// ---------------------------------------------------------------------------------

// Hook implementations

/**

 * Implementation of hook_help().

 */

function locale_help($path, $arg) {

  switch ($path) {

    case 'admin/help#locale':

      $output = '<p>'. t('The locale module allows your Drupal site to be presented in languages other than the default English, a defining feature of multi-lingual websites. The locale module works by examining text as it is about to be displayed: when a translation of the text is available in the language to be displayed, the translation is displayed rather than the original text. When a translation is unavailable, the original text is displayed, and then stored for later review by a translator.') .'</p>';

      $output .= '<p>'. t('Beyond translation of the Drupal interface, the locale module provides a feature set tailored to the needs of a multi-lingual site. Language negotiation allows your site to automatically change language based on the domain or path used for each request. Users may (optionally) select their preferred language on their <em>My account</em> page, and your site can be configured to honor a web browser\'s preferred language settings. Your site content can be created in (and translated to) any enabled language, and each post may have a language-appropriate alias for each of its translations. The locale module works in concert with the <a href="@content-help">content translation module</a> to manage translated content.', array('@content-help' => url('admin/help/translation'))) .'</p>';

      $output .= '<p>'. t('Translations may be provided by:') .'</p>';

      $output .= '<ul><li>'. t("translating the original text via the locale module's integrated web interface, or") .'</li>';

      $output .= '<li>'. t('importing files from a set of existing translations, known as a translation package. A translation package enables the display of a specific version of Drupal in a specific language, and contain files in the Gettext Portable Object (<em>.po</em>) format. Although not all languages are available for every version of Drupal, translation packages for many languages are available for download from the <a href="@translations">Drupal translation page</a>.', array('@translations' => 'http://drupal.org/project/translations')) .'</li></ul>';

      $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>';

      $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>';

      return $output;

    case 'admin/settings/language':

      $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>';

      $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>';

      $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>';

      return $output;

    case 'admin/settings/language/add':

      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>';

    case 'admin/settings/language/configure':

      $output = '<p>'. t("Language negotiation settings determine the site's presentation language. Available options include:") .'</p>';

      $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>';

      $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>';

      $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>';

      $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>';

      $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>';

      return $output;

    case 'admin/build/translate':

      $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>';

      $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>';

      return $output;

    case 'admin/build/translate/import':

      $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>';

      $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>';

      return $output;

    case 'admin/build/translate/export':

      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>';

    case 'admin/build/translate/search':

      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>';

    case 'admin/build/block/configure':

      if ($arg[4] == 'locale' && $arg[5] == 0) {

        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>';

      }

      break;

  }

}

/**

 * Implementation of hook_menu().

 *

 * Locale module only provides administrative menu items, so all

 * menu items are invoked through locale_inc_callback().

 */

function locale_menu() {

  // Manage languages

  $items['admin/settings/language'] = array(

    'title' => 'Languages',

    'description' => 'Configure languages for content and the user interface.',

    'page callback' => 'locale_inc_callback',

    'page arguments' => array('drupal_get_form', 'locale_languages_overview_form'),

    'access arguments' => array('administer languages'),

  );

  $items['admin/settings/language/overview'] = array(

    'title' => 'List',

    'weight' => 0,

    'type' => MENU_DEFAULT_LOCAL_TASK,

  );

  $items['admin/settings/language/add'] = array(

    'title' => 'Add language',

    'page callback' => 'locale_inc_callback',

    'page arguments' => array('locale_languages_add_screen'), // two forms concatenated

    'access arguments' => array('administer languages'),

    'weight' => 5,

    'type' => MENU_LOCAL_TASK,

  );

  $items['admin/settings/language/configure'] = array(

    'title' => 'Configure',

    'page callback' => 'locale_inc_callback',

    'page arguments' => array('drupal_get_form', 'locale_languages_configure_form'),

    'access arguments' => array('administer languages'),

    'weight' => 10,

    'type' => MENU_LOCAL_TASK,

  );

  $items['admin/settings/language/edit/%'] = array(

    'title' => 'Edit language',

    'page callback' => 'locale_inc_callback',

    'page arguments' => array('drupal_get_form', 'locale_languages_edit_form', 4),

    'access arguments' => array('administer languages'),

    'type' => MENU_CALLBACK,

  );

  $items['admin/settings/language/delete/%'] = array(

    'title' => 'Confirm',

    'page callback' => 'locale_inc_callback',

    'page arguments' => array('drupal_get_form', 'locale_languages_delete_form', 4),

    'access arguments' => array('administer languages'),

    'type' => MENU_CALLBACK,

  );

  // Translation functionality

  $items['admin/build/translate'] = array(

    'title' => 'Translate interface',

    'description' => 'Translate the built in interface and optionally other text.',

    'page callback' => 'locale_inc_callback',

    'page arguments' => array('locale_translate_overview_screen'), // not a form, just a table

    'access arguments' => array('translate interface'),

  );

  $items['admin/build/translate/overview'] = array(

    'title' => 'Overview',

    'weight' => 0,

    'type' => MENU_DEFAULT_LOCAL_TASK,

  );

  $items['admin/build/translate/search'] = array(

    'title' => 'Search',

    'weight' => 10,

    'type' => MENU_LOCAL_TASK,

    'page callback' => 'locale_inc_callback',

    'page arguments' => array('locale_translate_seek_screen'), // search results and form concatenated

    'access arguments' => array('translate interface'),

  );

  $items['admin/build/translate/import'] = array(

    'title' => 'Import',

    'page callback' => 'locale_inc_callback',

    'page arguments' => array('drupal_get_form', 'locale_translate_import_form'),

    'access arguments' => array('translate interface'),

    'weight' => 20,

    'type' => MENU_LOCAL_TASK,

  );

  $items['admin/build/translate/export'] = array(

    'title' => 'Export',

    'page callback' => 'locale_inc_callback',

    'page arguments' => array('locale_translate_export_screen'), // possibly multiple forms concatenated

    'access arguments' => array('translate interface'),

    'weight' => 30,

    'type' => MENU_LOCAL_TASK,

  );

  $items['admin/build/translate/edit/%'] = array(

    'title' => 'Edit string',

    'page callback' => 'locale_inc_callback',

    'page arguments' => array('drupal_get_form', 'locale_translate_edit_form', 4),

    'access arguments' => array('translate interface'),

    'type' => MENU_CALLBACK,

  );

  $items['admin/build/translate/delete/%'] = array(

    'title' => 'Delete string',

    'page callback' => 'locale_inc_callback',

    'page arguments' => array('locale_translate_delete_page', 4),

    'access arguments' => array('translate interface'),

    'type' => MENU_CALLBACK,

  );

  return $items;

}

/**

 * Wrapper function to be able to set callbacks in locale.inc

 */

function locale_inc_callback() {

  $args = func_get_args();

  $function = array_shift($args);

  include_once './includes/locale.inc';

  return call_user_func_array($function, $args);

}

/**

 * Implementation of hook_perm().

 */

function locale_perm() {

  return array('administer languages', 'translate interface');

}

/**

 * Implementation of hook_locale().

 */

function locale_locale($op = 'groups') {

  switch ($op) {

    case 'groups':

      return array('default' => t('Built-in interface'));

  }

}

/**

 * Implementation of hook_user().

 */

function locale_user($type, $edit, &$user, $category = NULL) {

  global $language;

  // If we have more then one language and either creating a user on the

  // admin interface or edit the user, show the language selector.

  if (variable_get('language_count', 1) > 1 && ($type == 'register' && user_access('administer users') || $type == 'form' && $category == 'account' )) {

    $languages = language_list('enabled');

    $languages = $languages[1];

    // If the user is being created, we set the user language to the page language.

    $user_preferred_language = $user ? user_preferred_language($user) : $language;

    $names = array();

    foreach ($languages as $langcode => $item) {

      $name = t($item->name);

      $names[$langcode] = $name . ($item->native != $name ? ' ('. $item->native .')' : '');

    }

    $form['locale'] = array(

      '#type' => 'fieldset',

      '#title' => t('Language settings'),

      '#weight' => 1,

    );

    // Get language negotiation settings.

    $mode = variable_get('language_negotiation', LANGUAGE_NEGOTIATION_NONE);

    $form['locale']['language'] = array(

      '#type' => (count($names) <= 5 ? 'radios' : 'select'),

      '#title' => t('Language'),

      '#default_value' => $user_preferred_language->language,

      '#options' => $names,

      '#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."),

    );

    return $form;

  }

}

/**

 * Implementation of hook_form_alter(). Adds language fields to forms.

 */

function locale_form_alter(&$form, $form_state, $form_id) {

  switch ($form_id) {

    // Language field for paths

    case 'path_admin_form':

      $form['language'] = array(

        '#type' => 'select',

        '#title' => t('Language'),

        '#options' => array('' => t('All languages')) + locale_language_list('name'),

        '#default_value' => $form['language']['#value'],

        '#weight' => -10,

        '#description' => t('A path alias set for a specific language will always be used when displaying this page in that language, and takes precedence over path aliases set for <em>All languages</em>.'),

      );

      break;

    // Language setting for content types

    case 'node_type_form':

      if (isset($form['identity']['type'])) {

        $form['workflow']['language_content_type'] = array(

          '#type' => 'radios',

          '#title' => t('Multilingual support'),

          '#default_value' => variable_get('language_content_type_'. $form['#node_type']->type, 0),

          '#options' => array(t('Disabled'), t('Enabled')),

          '#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'))),

        );

      }

      break;

    // Language field for nodes

    default:

      if (isset($form['#id']) && $form['#id'] == 'node-form') {

        if (isset($form['#node']->type) && variable_get('language_content_type_'. $form['#node']->type, 0)) {

          $form['language'] = array(

            '#type' => 'select',

            '#title' => t('Language'),

            '#default_value' => (isset($form['#node']->language) ? $form['#node']->language : ''),

            '#options' => array('' => t('Language neutral')) + locale_language_list('name'),

          );

        }

        // Node type without language selector: assign the default for new nodes

        elseif (!isset($form['#node']->nid)) {

          $default = language_default();

          $form['language'] = array(

            '#type' => 'value',

            '#value' => $default->language

          );

        }

      }

  }

}

/**

 * Implementation of hook_theme()

 */

function locale_theme() {

  return array(

    'locale_languages_overview_form' => array(

      'arguments' => array('form' => array()),

    ),

  );

}

// ---------------------------------------------------------------------------------

// Locale core functionality

/**

 * Provides interface translation services.

 *

 * This function is called from t() to translate a string if needed.

 *

 * @param $string

 *   A string to look up translation for. If omitted, all the

 *   cached strings will be returned in all languages already

 *   used on the page.

 * @param $langcode

 *   Language code to use for the lookup.

 * @param $reset

 *   Set to TRUE to reset the in-memory cache.

 */

function locale($string = NULL, $langcode = NULL, $reset = FALSE) {

  global $language;

  static $locale_t;

  if ($reset) {

    // Reset in-memory cache.

    $locale_t = NULL;

  }

  if (!isset($string)) {

    // Return all cached strings if no string was specified

    return $locale_t;

  }

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

  // Store database cached translations in a static var.

  if (!isset($locale_t[$langcode])) {

    $locale_t[$langcode] = array();

    // Disabling the usage of string caching allows a module to watch for

    // the exact list of strings used on a page. From a performance

    // perspective that is a really bad idea, so we have no user

    // interface for this. Be careful when turning this option off!

    if (variable_get('locale_cache_strings', 1) == 1) {

      if ($cache = cache_get('locale:'. $langcode, 'cache')) {

        $locale_t[$langcode] = $cache->data;

      }

      else {

        // Refresh database stored cache of translations for given language.

        // We only store short strings used in current version, to improve

        // performance and consume less memory.

        $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);

        while ($data = db_fetch_object($result)) {

          $locale_t[$langcode][$data->source] = (empty($data->translation) ? TRUE : $data->translation);

        }

        cache_set('locale:'. $langcode, $locale_t[$langcode]);

      }

    }

  }

  // If we have the translation cached, skip checking the database

  if (!isset($locale_t[$langcode][$string])) {

    // We do not have this translation cached, so get it from the DB.

    $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));

    if ($translation) {

      // We have the source string at least.

      // Cache translation string or TRUE if no translation exists.

      $locale_t[$langcode][$string] = (empty($translation->translation) ? TRUE : $translation->translation);

      if ($translation->version != VERSION) {

        // This is the first use of this string under current Drupal version. Save version

        // and clear cache, to include the string into caching next time. Saved version is

        // also a string-history information for later pruning of the tables.

        db_query("UPDATE {locales_source} SET version = '%s' WHERE lid = %d", VERSION, $translation->lid);

        cache_clear_all('locale:', 'cache', TRUE);

      }

    }

    else {

      // We don't have the source string, cache this as untranslated.

      db_query("INSERT INTO {locales_source} (location, source, textgroup, version) VALUES ('%s', '%s', 'default', '%s')", request_uri(), $string, VERSION);

      $locale_t[$langcode][$string] = TRUE;

      // Clear locale cache so this string can be added in a later request.

      cache_clear_all('locale:', 'cache', TRUE);

    }

  }

  return ($locale_t[$langcode][$string] === TRUE ? $string : $locale_t[$langcode][$string]);

}

/**

 * Returns plural form index for a specific number.

 *

 * The index is computed from the formula of this language.

 *

 * @param $count

 *   Number to return plural for.

 * @param $langcode

 *   Optional language code to translate to a language other than

 *   what is used to display the page.

 */

function locale_get_plural($count, $langcode = NULL) {

  global $language;

  static $locale_formula, $plurals = array();

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

  if (!isset($plurals[$langcode][$count])) {

    if (!isset($locale_formula)) {

      $language_list = language_list();

      $locale_formula[$langcode] = $language_list[$langcode]->formula;

    }

    if ($locale_formula[$langcode]) {

      $n = $count;

      $plurals[$langcode][$count] = @eval('return intval('. $locale_formula[$langcode] .');');

      return $plurals[$langcode][$count];

    }

    else {

      $plurals[$langcode][$count] = -1;

      return -1;

    }

  }

  return $plurals[$langcode][$count];

}

/**

 * Returns a language name

 */

function locale_language_name($lang) {

  static $list = NULL;

  if (!isset($list)) {

    $list = locale_language_list();

  }

  return ($lang && isset($list[$lang])) ? $list[$lang] : t('All');

}

/**

 * Returns array of language names

 *

 * @param $field

 *   'name' => names in current language, localized

 *   'native' => native names

 * @param $all

 *   Boolean to return all languages or only enabled ones

 */

function locale_language_list($field = 'name', $all = FALSE) {

  if ($all) {

    $languages = language_list();

  }

  else {

    $languages = language_list('enabled');

    $languages = $languages[1];

  }

  $list = array();

  foreach ($languages as $language) {

    $list[$language->language] = ($field == 'name') ? t($language->name) : $language->$field;

  }

  return $list;

}

/**

 * Imports translations when new modules or themes are installed or enabled.

 *

 * This function will either import translation for the component change

 * right away, or start a batch if more files need to be imported.

 *

 * @param $components

 *   An array of component (theme and/or module) names to import

 *   translations for.

 */

function locale_system_update($components) {

  include_once 'includes/locale.inc';

  if ($batch = locale_batch_by_component($components)) {

    batch_set($batch);

  }

}

/**

 * Update JavaScript translation file, if required, and add it to the page.

 *

 * This function checks all JavaScript files currently added via drupal_add_js()

 * and invokes parsing if they have not yet been parsed for Drupal.t()

 * and Drupal.formatPlural() calls. Also refreshes the JavaScript translation

 * file if necessary, and adds it to the page.

 */

function locale_update_js_files() {

  global $language;

  $dir = file_create_path(variable_get('locale_js_directory', 'languages'));

  $parsed = variable_get('javascript_parsed', array());

  // The first three parameters are NULL in order to get an array with all

  // scopes. This is necessary to prevent recreation of JS translation files

  // when new files are added for example in the footer.

  $javascript = drupal_add_js(NULL, NULL, NULL);

  $files = $new_files = FALSE;

  foreach ($javascript as $scope) {

    foreach ($scope as $type => $data) {

      if ($type != 'setting' && $type != 'inline') {

        foreach ($data as $filepath => $info) {

          $files = TRUE;

          if (!in_array($filepath, $parsed)) {

            // Don't parse our own translations files.

            if (substr($filepath, 0, strlen($dir)) != $dir) {

              locale_inc_callback('_locale_parse_js_file', $filepath);

              watchdog('locale', 'Parsed JavaScript file %file.', array('%file' => $filepath));

              $parsed[] = $filepath;

              $new_files = TRUE;

            }

          }

        }

      }

    }

  }

  // If there are any new source files we parsed, invalidate existing

  // JavaScript translation files for all languages, adding the refresh

  // flags into the existing array.

  if ($new_files) {

    $parsed += locale_inc_callback('_locale_invalidate_js');

  }

  // If necessary, rebuild the translation file for the current language.

  if (!empty($parsed['refresh:'. $language->language])) {

    // Don't clear the refresh flag on failure, so that another try will

    // be performed later.

    if (locale_inc_callback('_locale_rebuild_js')) {