<?php

/**

 * @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

/**

 * Implements hook_help().

 */

function locale_help($path, $arg) {

  switch ($path) {

    case 'admin/help#locale':

      $output = '';

      $output .= '<h3>' . t('About') . '</h3>';

      $output .= '<p>' . t('The Locale module allows your Drupal site to be presented in languages other than the default English, and to be multilingual. The Locale module works by maintaining a database of translations, and 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 review by a translator. For more information, see the online handbook entry for <a href="@locale">Locale module</a>.', array('@locale' => 'http://drupal.org/documentation/modules/locale/')) . '</p>';

      $output .= '<h3>' . t('Uses') . '</h3>';

      $output .= '<dl>';

      $output .= '<dt>' . t('Translating interface text') . '</dt>';

      $output .= '<dd>' . t('Translations of text in the Drupal interface may be provided by:');

      $output .= '<ul>';

      $output .= '<li>' . t("Translating within your site, using the Locale module's integrated <a href='@translate'>translation interface</a>.", array('@translate' => url('admin/config/regional/translate'))) . '</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 contains 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 translations page</a>.', array('@translations' => 'http://localize.drupal.org')) . '</li>';

      $output .= '<li>' . t("If an existing translation package does not meet your needs, the Gettext Portable Object (<em>.po</em>) files within a package may be modified, or new <em>.po</em> files may be created, using a desktop Gettext editor. The Locale module's <a href='@import'>import</a> feature allows the translated strings from a new or modified <em>.po</em> file to be added to your site. The Locale module's <a href='@export'>export</a> feature generates files from your site's translated strings, that can either be shared with others or edited offline by a Gettext translation editor.", array('@import' => url('admin/config/regional/translate/import'), '@export' => url('admin/config/regional/translate/export'))) . '</li>';

      $output .= '</ul></dd>';

      $output .= '<dt>' . t('Configuring a multilingual site') . '</dt>';

      $output .= '<dd>' . t("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. Site content can be translated using the <a href='@content-help'>Content translation module</a>.", array('@content-help' => url('admin/help/translation'))) . '</dd>';

      $output .= '</dl>';

      return $output;

    case 'admin/config/regional/language':

      $output = '<p>' . t('With multiple languages enabled, interface text can be translated, registered users may select their preferred language, and authors can assign a specific language to content. <a href="@translations">Download contributed translations</a> from Drupal.org.', array('@translations' => 'http://localize.drupal.org')) . '</p>';

      return $output;

    case 'admin/config/regional/language/add':

      return '<p>' . t('Add a language 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/config/regional/language/configure':

      $output = '<p>' . t("Define how to decide which language is used to display page elements (primarily text provided by Drupal and modules, such as field labels and help text). This decision is made by evaluating a series of detection methods for languages; the first detection method that gets a result will determine which language is used for that type of text. Define the order of evaluation of language detection methods on this page.") . '</p>';

      return $output;

    case 'admin/config/regional/language/configure/session':

      $output = '<p>' . t('Determine the language from a request/session parameter. Example: "http://example.com?language=de" sets language to German based on the use of "de" within the "language" parameter.') . '</p>';

      return $output;

    case 'admin/config/regional/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('See the <a href="@languages">Languages page</a> for more information on adding support for additional languages.', array('@languages' => url('admin/config/regional/language'))) . '</p>';

      return $output;

    case 'admin/config/regional/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 offline 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/config/regional/language/add'), '@translations' => 'http://localize.drupal.org')) . '</p>';

      return $output;

    case 'admin/config/regional/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/config/regional/translate/translate':

      return '<p>' . t('This page allows a translator to search for specific translated and untranslated strings, and is used when creating or editing translations. (Note: For translation tasks involving many strings, it may be more convenient to <a href="@export">export</a> strings for offline editing in a desktop Gettext translation editor.) Searches may be limited to strings found within a specific text group or in a specific language.', array('@export' => url('admin/config/regional/translate/export'))) . '</p>';

    case 'admin/structure/block/manage/%/%':

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

        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 <em>URL</em> or <em>Session</em>.', array('@languages' => url('admin/config/regional/language'), '@configuration' => url('admin/config/regional/language/configure'))) . '</p>';

      }

      break;

  }

}

/**

 * Implements hook_menu().

 */

function locale_menu() {

  // Manage languages

  $items['admin/config/regional/language'] = array(

    'title' => 'Languages',

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

    'page callback' => 'drupal_get_form',

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

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

    'file' => 'locale.admin.inc',

    'weight' => -10,

  );

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

    'title' => 'List',

    'weight' => 0,

    'type' => MENU_DEFAULT_LOCAL_TASK,

  );

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

    'title' => 'Add language',

    'page callback' => 'locale_languages_add_screen', // two forms concatenated

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

    'weight' => 5,

    'type' => MENU_LOCAL_ACTION,

    'file' => 'locale.admin.inc',

  );

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

    'title' => 'Detection and selection',

    'page callback' => 'drupal_get_form',

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

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

    'weight' => 10,

    'file' => 'locale.admin.inc',

    'type' => MENU_LOCAL_TASK,

  );

  $items['admin/config/regional/language/configure/url'] = array(

    'title' => 'URL language detection configuration',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('locale_language_providers_url_form'),

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

    'file' => 'locale.admin.inc',

    'type' => MENU_VISIBLE_IN_BREADCRUMB,

  );

  $items['admin/config/regional/language/configure/session'] = array(

    'title' => 'Session language detection configuration',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('locale_language_providers_session_form'),

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

    'file' => 'locale.admin.inc',

    'type' => MENU_VISIBLE_IN_BREADCRUMB,

  );

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

    'title' => 'Edit language',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('locale_languages_edit_form', 5),

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

    'file' => 'locale.admin.inc',

  );

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

    'title' => 'Confirm',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('locale_languages_delete_form', 5),

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

    'file' => 'locale.admin.inc',

  );

  // Translation functionality

  $items['admin/config/regional/translate'] = array(

    'title' => 'Translate interface',

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

    'page callback' => 'locale_translate_overview_screen',

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

    'file' => 'locale.admin.inc',

    'weight' => -5,

  );

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

    'title' => 'Overview',

    'weight' => 0,

    'type' => MENU_DEFAULT_LOCAL_TASK,

  );

  $items['admin/config/regional/translate/translate'] = array(

    'title' => 'Translate',

    'weight' => 10,

    'type' => MENU_LOCAL_TASK,

    'page callback' => 'locale_translate_seek_screen', // search results and form concatenated

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

    'file' => 'locale.admin.inc',

  );

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

    'title' => 'Import',

    'page callback' => 'drupal_get_form',

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

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

    'weight' => 20,

    'type' => MENU_LOCAL_TASK,

    'file' => 'locale.admin.inc',

  );

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

    'title' => 'Export',

    'page callback' => 'locale_translate_export_screen',  // possibly multiple forms concatenated

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

    'weight' => 30,

    'type' => MENU_LOCAL_TASK,

    'file' => 'locale.admin.inc',

  );

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

    'title' => 'Edit string',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('locale_translate_edit_form', 5),

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

    'file' => 'locale.admin.inc',

  );

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

    'title' => 'Delete string',

    'page callback' => 'locale_translate_delete_page',

    'page arguments' => array(5),

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

    'file' => 'locale.admin.inc',

  );

  // Localize date formats.

  $items['admin/config/regional/date-time/locale'] = array(

    'title' => 'Localize',

    'description' => 'Configure date formats for each locale',

    'page callback' => 'locale_date_format_language_overview_page',

    'access arguments' => array('administer site configuration'),

    'type' => MENU_LOCAL_TASK,

    'weight' => -8,

    'file' => 'locale.admin.inc',

  );

  $items['admin/config/regional/date-time/locale/%/edit'] = array(

    'title' => 'Localize date formats',

    'description' => 'Configure date formats for each locale',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('locale_date_format_form', 5),

    'access arguments' => array('administer site configuration'),

    'file' => 'locale.admin.inc',

  );

  $items['admin/config/regional/date-time/locale/%/reset'] = array(

    'title' => 'Reset date formats',

    'description' => 'Reset localized date formats to global defaults',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('locale_date_format_reset_form', 5),

    'access arguments' => array('administer site configuration'),

    'file' => 'locale.admin.inc',

  );

  return $items;

}

/**

 * Implements hook_init().

 *

 * Initialize date formats according to the user's current locale.

 */

function locale_init() {

  global $conf, $language;

  include_once DRUPAL_ROOT . '/includes/locale.inc';

  // For each date type (e.g. long, short), get the localized date format

  // for the user's current language and override the default setting for it

  // in $conf. This should happen on all pages except the date and time formats

  // settings page, where we want to display the site default and not the

  // localized version.

  if (strpos($_GET['q'], 'admin/config/regional/date-time/formats') !== 0) {

    $languages = array($language->language);

    // Setup appropriate date formats for this locale.

    $formats = locale_get_localized_date_format($languages);

    foreach ($formats as $format_type => $format) {

      $conf[$format_type] = $format;

    }

  }

}

/**

 * Implements hook_permission().

 */

function locale_permission() {

  return array(

    'administer languages' => array(

      'title' => t('Administer languages'),

    ),

    'translate interface' => array(

      'title' => t('Translate interface texts'),

      'restrict access' => TRUE,

    ),

  );

}

/**

 * Implements hook_locale().

 */

function locale_locale($op = 'groups') {

  switch ($op) {

    case 'groups':

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

  }

}

/**

 * Form builder callback to display language selection widget.

 *

 * @ingroup forms

 * @see locale_form_alter()

 */

function locale_language_selector_form(&$form, &$form_state, $user) {

  global $language;

  $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->uid ? 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,

    '#access' => ($form['#user_category'] == 'account' || ($form['#user_category'] == 'register' && user_access('administer users'))),

  );

  // Get language negotiation settings.

  $mode = language_negotiation_get(LANGUAGE_TYPE_INTERFACE) != LANGUAGE_NEGOTIATION_DEFAULT;

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

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

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

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

    '#options' => $names,

    '#description' => $mode ? t("This account's default language for e-mails, and preferred language for site presentation.") : t("This account's default language for e-mails."),

  );

}

/**

 * Implements hook_form_FORM_ID_alter().

 */

function locale_form_path_admin_form_alter(&$form, &$form_state) {

  $form['language'] = array(

    '#type' => 'select',

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

    '#options' => array(LANGUAGE_NONE => 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>.'),

  );

}

/**

 * Implements hook_form_FORM_ID_alter().

 */

function locale_form_node_type_form_alter(&$form, &$form_state) {

  if (isset($form['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/config/regional/language'))),

    );

  }

}

/**

 * Return whether the given content type has multilingual support.

 *

 * @return

 *   True if multilingual support is enabled.

 */

function locale_multilingual_node_type($type_name) {

  return (bool) variable_get('language_content_type_' . $type_name, 0);

}

/**

 * Implements hook_form_alter().

 *

 * Adds language fields to user forms.

 */

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

  // Only alter user forms if there is more than one language.

  if (drupal_multilingual()) {

    // Display language selector when either creating a user on the admin

    // interface or editing a user account.

    if ($form_id == 'user_register_form' || ($form_id == 'user_profile_form' && $form['#user_category'] == 'account')) {

      locale_language_selector_form($form, $form_state, $form['#user']);

    }

  }

}

/**

 * Implements hook_form_BASE_FORM_ID_alter().

 */

function locale_form_node_form_alter(&$form, &$form_state) {

  if (isset($form['#node']->type) && locale_multilingual_node_type($form['#node']->type)) {

    $form['language'] = array(

      '#type' => 'select',

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

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

      '#options' => array(LANGUAGE_NONE => 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

    );

  }

  $form['#submit'][] = 'locale_field_node_form_submit';

}

/**

 * Form submit handler for node_form().

 *

 * This submit handler needs to run before entity_form_submit_build_entity()

 * is invoked by node_form_submit_build_node(), because it alters the values of

 * attached fields. Therefore, it cannot be a hook_node_submit() implementation.

 */

function locale_field_node_form_submit($form, &$form_state) {

  locale_field_entity_form_submit('node', $form, $form_state);

}

/**

 * Implements hook_form_FORM_ID_alter().

 */

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

  // If a content type has multilingual support we set the content language as

  // comment language.

  if ($form['language']['#value'] == LANGUAGE_NONE && locale_multilingual_node_type($form['#node']->type)) {

    global $language_content;

    $form['language']['#value'] = $language_content->language;

    $submit_callback = 'locale_field_comment_form_submit';

    array_unshift($form['actions']['preview']['#submit'], $submit_callback);

    array_unshift($form['#submit'], $submit_callback);

  }

}

/**

 * Form submit handler for comment_form().

 *

 * This submit handler needs to run before entity_form_submit_build_entity()

 * is invoked by comment_form_submit_build_comment(), because it alters the

 * values of attached fields.

 */

function locale_field_comment_form_submit($form, &$form_state) {

  locale_field_entity_form_submit('comment', $form, $form_state);

}

/**

 * Handles field language on submit for the given entity type.

 *

 * Checks if Locale is registered as a translation handler and handle possible

 * language changes.

 */

function locale_field_entity_form_submit($entity_type, $form, &$form_state ) {

  if (field_has_translation_handler($entity_type, 'locale')) {

    $entity = (object) $form_state['values'];

    $current_language = entity_language($entity_type, $entity);

    list(, , $bundle) = entity_extract_ids($entity_type, $entity);

    foreach (field_info_instances($entity_type, $bundle) as $instance) {

      $field_name = $instance['field_name'];

      $field = field_info_field($field_name);

      $previous_language = $form[$field_name]['#language'];

      // Handle a possible language change: new language values are inserted,

      // previous ones are deleted.

      if ($field['translatable'] && $previous_language != $current_language) {

        $form_state['values'][$field_name][$current_language] = $entity->{$field_name}[$previous_language];

        $form_state['values'][$field_name][$previous_language] = array();

      }

    }

  }

}

/**

 * Implements hook_theme().

 */

function locale_theme() {

  return array(

    'locale_languages_overview_form' => array(

      'render element' => 'form',

    ),

    'locale_languages_configure_form' => array(

      'render element' => 'form',

    ),

    'locale_date_format_form' => array(

      'render element' => 'form',

    ),

  );

}

/**

 * Implements hook_field_language_alter().

 */

function locale_field_language_alter(&$display_language, $context) {

  // Do not apply core language fallback rules if they are disabled or if Locale

  // is not registered as a translation handler.

  if (variable_get('locale_field_language_fallback', TRUE) && field_has_translation_handler($context['entity_type'], 'locale')) {

    locale_field_language_fallback($display_language, $context['entity'], $context['language']);

  }

}

/**

 * Applies language fallback rules to the fields attached to the given entity.

 *

 * Core language fallback rules simply check if fields have a field translation

 * for the requested language code. If so the requested language is returned,

 * otherwise all the fallback candidates are inspected to see if there is a

 * field translation available in another language.

 * By default this is called by locale_field_language_alter(), but this

 * behavior can be disabled by setting the 'locale_field_language_fallback'

 * variable to FALSE.

 *

 * @param $display_language

 *   A reference to an array of language codes keyed by field name.

 * @param $entity

 *   The entity to be displayed.

 * @param $langcode

 *   The language code $entity has to be displayed in.

 */

function locale_field_language_fallback(&$display_language, $entity, $langcode) {

  // Lazily init fallback candidates to avoid unnecessary calls.

  $fallback_candidates = NULL;

  $field_languages = array();

  foreach ($display_language as $field_name => $field_language) {

    // If the requested language is defined for the current field use it,

    // otherwise search for a fallback value among the fallback candidates.

    if (isset($entity->{$field_name}[$langcode])) {

      $display_language[$field_name] = $langcode;

    }

    elseif (!empty($entity->{$field_name})) {

      if (!isset($fallback_candidates)) {

        require_once DRUPAL_ROOT . '/includes/language.inc';

        $fallback_candidates = language_fallback_get_candidates();

      }

      foreach ($fallback_candidates as $fallback_language) {

        if (isset($entity->{$field_name}[$fallback_language])) {

          $display_language[$field_name] = $fallback_language;

          break;

        }

      }

    }

  }

}

/**

 * Implements hook_entity_info_alter().

 */

function locale_entity_info_alter(&$entity_info) {

  $entity_info['node']['translation']['locale'] = TRUE;

  if (isset($entity_info['comment'])) {

    $entity_info['comment']['translation']['locale'] = TRUE;

  }