<?php
// $Id: i18n_variable.module,v 1.1.2.4 2011-02-19 17:50:43 jareyero Exp $
/**
 * @file
 * Internationalization (i18n) package. Multilingual variables API.
 */

// Which cache to use for multilingual variables
define('I18N_VARIABLE_CACHE', 'cache_bootstrap');

/**
 * Implements hook_boot()
 * 
 * Initialize variables, that will be used to decide on site_frontpage
 */
function i18n_variable_boot() {
  
}

/**
 * Implements hook_menu()
 */
function i18n_variable_menu() {
  $items['admin/config/regional/i18n/variable'] = array(
    'title' => 'Variables',
    'description' => 'Configure multilingual variables.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('i18n_variable_admin_settings'),
    'access arguments' => array('administer site configuration'),
    'file' => 'i18n_variable.admin.inc',
    'type' => MENU_LOCAL_TASK,
  );
  return $items;
}

/**
 * Implements hook_language_init()
 */
function i18n_variable_language_init() {
  if (drupal_multilingual()) {
    i18n_variable_initialize();
  }
}

/**
 * Initialization of multilingual variables.
 *
 * @param $langcode
 *   Language to retrieve variables. Defaults to current language.
 */
function i18n_variable_initialize($language = NULL) {
  $language = $language ? $language : i18n_variable_language();
  $GLOBALS['language_variable'] = $language;
  $variables = i18n_variable_load($language->language);
  variable_realm_switch('language', $language->language, $variables);
}

/**
 * Get variables language, make sure it is initialized
 */
function i18n_variable_language($initialize = TRUE) {
  if (isset($GLOBALS['language_variable'])) {
    // If we've got a variables language, it will be that one
    return $GLOBALS['language_variable'];
  }
  else {
    return i18n_language();
  }
}

/**
 * Get original value for global variable/s
 */
function i18n_variable_global($name = NULL, $default = NULL) {
  return variable_realm_global_get($name, $default);
}

/**
 * Implements hook_form_alter();
 *
 * This is the place to add language fields to all forms.
 */
function i18n_variable_form_alter(&$form, &$form_state, $form_id) {
  // Multilingual variables in settings form.
  if (isset($form['#theme']) && $form['#theme'] == 'system_settings_form' && $variables = i18n_variable_list()) {
    if ($form_id == 'system_theme_settings') {
      // Special treatment for theme settings
      if (!empty($form['var']) && !empty($form['var']['#value']) && in_array($form['var']['#value'], $variables)) {
        $variables = element_children($form['theme_settings']);
        $variables = array_merge($variables, array('default_logo', 'logo_path', 'default_favicon', 'favicon_path'));
        i18n_variable_form_alter_settings($form, $variables);
        // Replace variable (theme) name so we use a temporary storage variable
        $form['#i18n_variable'] = $form['var']['#value'];
        $form['var']['#value'] = 'i18n_variable_theme_settings';
        $form['#submit'][] = 'i18n_variable_theme_form_submit';
      }
    }
    elseif ($i18n_variables = i18n_variable_form_alter_settings($form, $variables)) {
      array_unshift($form['#submit'], 'i18n_variable_form_submit');
      $form['#i18n_variables'] = $i18n_variables;
    }
  }  
}

/**
 * Get list of multilingual variables or check whether a variable is multilingual
 */
function i18n_variable_list($name = NULL) {
  static $variables;
  if (!isset($variables)) {
    // Note that variables being a global static, any other module can initialize or alter it.
    $variables = &drupal_static(__FUNCTION__, variable_get('i18n_variable_list', array()));
  }
  return $name ? in_array($name, $variables) : $variables;
}

/**
* Load language variables into array.
* 
* Pull variables from the store but filter out the ones that are not multilingual.
*/
function i18n_variable_load($langcode) {
  $variables = array();
  foreach (variable_store('language', $langcode) as $name => $value) {
    if (i18n_variable_list($name)) {
      $variables[$name] = $value;
    }
  }
  return $variables;
}

/**
 * Check for multilingual variables in form.
 */
function i18n_variable_form_alter_settings(&$form, $variables) {
  $result = array();
  foreach (element_children($form) as $field) {
    $output = '';
    if (count(element_children($form[$field])) && empty($form[$field]['#tree'])) {
      $result += i18n_variable_form_alter_settings($form[$field], $variables);
    }
    elseif (in_array($field, $variables)) {
      // Add form field class (i18n-variable) and description text.
      $form[$field]['#attributes']['class'][] = 'i18n-variable';
      $form[$field]['#description'] = !empty($form[$field]['#description']) ? $form[$field]['#description'] : '';
      $path = $_GET['q'];
      $output .= t('Change this variable for other language:') . ' ';
      foreach (i18n_language_list() as $l => $lang) {
        if (i18n_langcode() == $l) {
          $output .= $lang . ' ';
        }
        else {
          $output .= l($lang, $path, array('language' => i18n_language($l))) . ' ';
        }
      }
      $form[$field]['#description'] .= ' <strong>' . t('This is a multilingual variable.') . '</strong> ' . $output;
      // Addd field => name to result
      $result[$field] = !empty($form[$field]['#title']) ? $form[$field]['#title'] : $field;
    }
  }
  return $result;
}

/**
 * Save multilingual variables and remove them from form.
 */
function i18n_variable_form_submit($form, &$form_state) {
  $op = isset($form_state['values']['op']) ? $form_state['values']['op'] : '';
  $language = i18n_variable_language();
  $variables = array_keys($form['#i18n_variables']);
  foreach ($variables as $name) {
    if (isset($form_state['values'][$name])) {
      if ($op == t('Reset to defaults')) {
        i18n_variable_del($name, $language->language);
      }
      else {
        $value = $form_state['values'][$name];
        if (is_array($value) && isset($form_state['values']['array_filter'])) {
          $value = array_keys(array_filter($value));
        }
        i18n_variable_set($name, $value, $language->language);
      }
      // If current is not default language, we don't set any global variable (without language)
      if ($language->language != language_default('language')) {
        unset($form_state['values'][$name]);
      }
    }
  }
  // The form will go now through system_settings_form_submit()
}

/**
 * Save multilingual variables and remove them from form.
 * 
 * Note the theme variable has already been set into 'i18n_variable_theme_settings'
 */
function i18n_variable_theme_form_submit($form, &$form_state) {
  $language = i18n_variable_language();
  $settings = variable_get('i18n_variable_theme_settings');
  $name = $form['#i18n_variable'];
  i18n_variable_set($name, $settings, $language->language);
  // If current is default language, we allow global (without language) variables to be set too
  if ($language->language == language_default('language')) {
    variable_set($name, $settings);
  }
  variable_del('i18n_variable_theme_settings');
}

/**
 * Set a persistent language dependent variable.
 *
 * @param $name
 *   The name of the variable to set.
 * @param $value
 *   The value to set. This can be any PHP data type; these functions take care
 *   of serialization as necessary.
 * @param $langcode
 *   Language code.
 */
function i18n_variable_set($name, $value, $langcode) {
  variable_store_set('language', $langcode, $name, $value);
}

/**
 * Get single multilingual variable
 */
function i18n_variable_get($name, $langcode, $default = NULL) {
  return variable_store_get('language', $langcode, $name, $default);
}

/**
 * Unset a persistent multilingual variable.
 *
 * @param $name
 *   The name of the variable to undefine.
 * @param $langcode
 *   Language code.
 */
function i18n_variable_del($name, $langcode) {
  variable_store_del('language', $langcode, $name);
}