<?php
// $Id: faceted_search.admin.inc,v 1.6 2009-05-04 23:08:03 davidlesieur Exp $

/**
 * @file
 * Administrative page callbacks for the Faceted Search module.
 */

/**
 * List all environments and provide links to operations on those.
 */
function faceted_search_list_page() {
  $items = array();
  foreach (faceted_search_get_env_ids() as $env_id) {
    $env = faceted_search_env_load($env_id);
    $links = array(
      array('title' => t('Edit'), 'href' => 'admin/settings/faceted_search/'. $env_id),
      array('title' => t('Delete'), 'href' => 'admin/settings/faceted_search/delete/'. $env_id),
    );
    // Check that the base_path is a valid setting, because it is a
    // faceted_search_ui thing that faceted_search, as the parent class,
    // should normally not know about.
    $display = isset($env->settings['base_path']) ? l($env->name, $env->settings['base_path']) : $name; 
    $items[$env->name] = array($display, filter_xss_admin($env->description), theme('links', $links));
  }
  if (count($items)) {
    ksort($items); // Sort items by name.
    $output = '<p>'. t('This page shows all of the faceted search environments that are currently defined.') .'</p>';
    $output .= theme('table', array(t('Environment'), t('Description'), t('Operations')), $items);
  }
  else {
    $output = '<p>'. t('No faceted search environments have currently been defined.') .'</p>';
  }
  return $output;
}

/**
 * Delete an environment.
 */
function faceted_search_delete_form($form_state, $env) {
  $form['env'] = array(
    '#type' => 'value',
    '#value' => $env,
  );
  $form = confirm_form(
    $form,
    t('Are you sure you want to delete %env?', array('%env' => $env->name)),
    'admin/settings/faceted_search',
    t('This action cannot be undone.'),
    t('Delete'),
    t('Cancel')
  );
  return $form;
}

/**
 * Handle the submit button to delete an environment.
 */
function faceted_search_delete_form_submit($form, &$form_state) {
  $name = $form_state['values']['env']->name;
  $env_id = $form_state['values']['env']->env_id;

  db_query('DELETE FROM {faceted_search_env} WHERE env_id = %d', $env_id);
  db_query('DELETE FROM {faceted_search_filters} WHERE env_id = %d', $env_id);
  
  _block_rehash();
  menu_rebuild();

  // Delete the localized strings of this environment.
  faceted_search_env_locale_delete($env_id);
  
  drupal_set_message(t('Faceted search environment %name deleted.', array('%name' => $name)));

  $form_state['redirect'] = 'admin/settings/faceted_search';
}

/**
 * Form for editing an environment.
 *
 * @param $env
 *   The environment to edit, or NULL if adding a new one.
 */
function faceted_search_edit_form($form_state, $env = NULL) {
  if (isset($env)) {
    drupal_set_title(t('Faceted search environment: @name', array('@name' => $env->name)));
  }
  else {
    drupal_set_title(t('Add a faceted search environment'));
    $env = new faceted_search();
  }
  $form['env'] = array(
    '#type' => 'value',
    '#value' => $env,
  );

  // Basic information section.
  $form['info'] = array(
    '#type' => 'fieldset',
    '#title' => t('Basic information'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
  );
  $form['info']['name'] = array(
    '#type' => 'textfield',
    '#title' => t('Name'),
    '#maxlength' => 32,
    '#size' => 32,
    '#required' => TRUE,
    '#default_value' => $env->name,
    '#description' => t('A unique name to help site administrators identify the environment. Only alphanumeric and the underscore character are allowed here.'),
  );
  $form['info']['title'] = array(
    '#type' => 'textfield',
    '#title' => t('Title'),
    '#maxlength' => 128,
    '#size' => 32,
    '#required' => TRUE,
    '#default_value' => $env->settings['title'],
    '#description' => t("The title shown to users on the environment's pages."),
  );
  $form['info']['description'] = array(
    '#type' => 'textfield',
    '#title' => t('Description'),
    '#maxlength' => 255,
    '#size' => 60,
    '#default_value' => $env->description,
    '#description' => t('The description of the environment for site administrators.'),
  );
  $types = array();
  foreach (array_keys(node_get_types('names')) as $type) {
    $types[$type] = $type;
  }
  $names = node_get_types('names');
  faceted_search_localize_types($names);
  $form['info']['types'] = array(
    '#title' => t('Content types'),
    '#type' => 'checkboxes',
    '#options' => $names,
    '#description' => t('Only the checked types will appear in this search environment. If none is checked, all types will be allowed.'),
    '#default_value' => array_intersect($types, array_filter($env->settings['types'])),
  );
  $form['info']['ignore_status'] = array(
    '#type' => 'checkbox',
    '#title' => t('Let unpublished nodes appear in search results'),
    '#default_value' => $env->settings['ignore_status'],
    '#description' => t("When this is enabled, unpublished nodes are allowed to appear in search results to users with the 'administer nodes' permission. Note that unpublished nodes are never indexed by Drupal core, so they will never appear in keyword search results although they <em>will</em> appear in guided search results."),
    '#weight' => 1,
  );

  // Facets section.
  $form['facets'] = array(
    '#type' => 'fieldset',
    '#title' => t('Facets'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
    '#description' => t('<p>Facets provide categories for users to browse and refine their search.</p><p>Check the facets you wish to expose to users. In listings, the heavier facets will sink and the lighter facets will be positioned nearer the top.</p><p>The Sort criteria applies to categories listings only, and the Categories limit applies to category listings in the Guided search only. For performance reasons, it is advisable to select some limit (users will still be able to get the full listing of categories by following a <em>more</em> link).</p>'),
  );
  $form['facets']['facets'] = array(
    '#theme' => 'faceted_search_facets_settings',
    '#tree' => TRUE,
  );

  // Gather every possible facet.
  $all_filter_settings = faceted_search_load_filter_settings($env, TRUE);
  $facets = array();
  foreach (module_implements('faceted_search_collect') as $module) {
    $hook = $module .'_faceted_search_collect';
    $hook($facets, 'facets', $env, NULL);
  }

  // Prepare facets for use, assigning them their settings and sorting them.
  faceted_search_prepare_filters($facets, $all_filter_settings);

  // Add the facets section's content to the form.
  _faceted_search_facet_settings_form($form['facets']['facets'], $facets);

  // Keyword search section.
  $form['keyword'] = array(
    '#type' => 'fieldset',
    '#title' => t('Keyword search'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );
  $form['keyword']['fields'] = array(
    '#type' => 'fieldset',
    '#title' => t('Fields'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
    '#description' => t('<p>Users may restrict keyword search by field. <em>Anywhere</em> lets them search for keywords in the full nodes.</p><p>Check the fields you wish to expose to users for keyword search. In listings, the heavier fields will sink and the lighter fields will be positioned nearer the top.</p>'),
  );
  $form['keyword']['fields']['keyword_filters'] = array(
    '#theme' => 'faceted_search_keyword_filters_settings',
    '#tree' => TRUE,
  );

  // Gather keyword filters.
  $keyword_filters = array();
  foreach (module_implements('faceted_search_collect') as $module) {
    $hook = $module .'_faceted_search_collect';
    $hook($keyword_filters, 'keyword filters', $env, NULL);
  }
  // Gather the node keyword filter. This is the default, always-enabled keyword
  // filter that allows searching in the full node index.
  faceted_search_collect_node_keyword_filters($keyword_filters, 'keyword filters', $env);

  // Prepare facets for use, assigning them their settings and sorting them.
  faceted_search_prepare_filters($keyword_filters, $all_filter_settings);

  // Add the facets section's content to the form.
  _faceted_search_filter_settings_form($form['keyword']['fields']['keyword_filters'], $keyword_filters);

  // Buttons.
  $form['buttons']['#weight'] = 1000; // Ensure buttons remain at the bottom when form is altered.
  $form['buttons']['save'] = array(
    '#type' => 'submit',
    '#value' => t('Save'),
  );
  $form['buttons']['save_and_edit'] = array(
    '#type' => 'submit',
    '#value' => t('Save and edit'),
  );

  return $form;
}

/**
 * Validation callback for the environment edit form.
 */
function faceted_search_edit_form_validate($form, &$form_state) {
  // Name must be alphanumeric or underscores, no other punctuation.
  if (preg_match('/[^a-zA-Z0-9_]/', $form_state['values']['name'])) {
    form_set_error('name', t('Name must be alphanumeric or underscores only.'));
  }

  // Name must be unique.
  if (db_result(db_query("SELECT COUNT(*) FROM {faceted_search_env} WHERE name = '%s' AND env_id <> %d", $form_state['values']['name'], isset($form_state['values']['env']->env_id) ? $form_state['values']['env']->env_id : 0)) > 0) {
    form_set_error('name', t('Name %name already in use.', array('%name' => $form_state['values']['name'])));
  }

  // Weights must be numeric.
  if ($form_state['values']['facets']) {
    foreach ($form_state['values']['facets'] as $key => $settings) {
      if (!is_numeric($settings['weight'])) {
        form_set_error("facets][$key][weight", t('Weight must be a numeric value.'));
      }
    }
  }
  foreach ($form_state['values']['keyword_filters'] as $key => $settings) {
    if (!is_numeric($settings['weight'])) {
      form_set_error("keyword_filters][$key][weight", t('Weight must be a numeric value.'));
    }
  }
}

/**
 * Form callback for saving environment data.
 */
function faceted_search_edit_form_submit($form, &$form_state) {
  $env = $form_state['values']['env'];
  
  // Save search environment.
  $update = $env->env_id ? 'env_id' : NULL;
  $env->name = $form_state['values']['name'];
  $env->description = $form_state['values']['description'];

  // Settings are only saved if they have a value in the original environment
  // (we can rely on this since any setting always has at least a default
  // value).
  foreach ($form_state['values'] as $key => $value) {
    if (isset($env->settings[$key])) {
      $env->settings[$key] = $value;
    }
  }

  // Save to database, obtaining a new env_id if not updating an existing
  // environment.
  drupal_write_record('faceted_search_env', $env, $update);
  
  // Save filter settings.
  if ($form_state['values']['facets'] || $form_state['values']['keyword_filters']) {
    faceted_search_save_filter_settings(
      $env->env_id,
      array_merge(
        is_null($form_state['values']['facets']) ? array() : $form_state['values']['facets'],
        is_null($form_state['values']['keyword_filters']) ? array() : $form_state['values']['keyword_filters']));
  }

  // Rebuild the menus, if only for updating titles.
  menu_rebuild();

  // Refresh localizable strings.
  faceted_search_env_locale_refresh($env);
  
  drupal_set_message(t('The faceted search environment %name has been saved.', array('%name' => $form_state['values']['name'])));

  if ($form_state['values']['op'] == t('Save')) {
    $form_state['redirect'] = 'admin/settings/faceted_search';
  }
  else {
    $form_state['redirect'] = 'admin/settings/faceted_search/'. $env->env_id;
  }
}

function theme_faceted_search_facets_settings($form) {
  uasort($form, '_faceted_search_element_sort');

  $output = '';
  $header = array('', t('Facet'), t('Type'), t('Weight'), t('Sort criteria'), t('Categories limit'));
  $rows_enabled = array(array('', '<em>'. t('Enabled facets') .'</em>', '', '', '', ''));
  $rows_disabled = array(array('', '<em>'. t('Disabled facets') .'</em>', '', '', '', ''));
  foreach (element_children($form) as $key) {
    unset($form[$key]['status']['#title']);
    unset($form[$key]['weight']['#title']);
    unset($form[$key]['max_categories']['#title']);
    unset($form[$key]['sort']['#title']);
    $row = array(
      drupal_render($form[$key]['status']),
      $form[$key]['#title'] . ($form[$key]['help']['#value'] ? ' ('. check_plain($form[$key]['help']['#value']) .')' : ''),
      drupal_render($form[$key]['type']),
      drupal_render($form[$key]['weight']),
      drupal_render($form[$key]['sort']),
      drupal_render($form[$key]['max_categories']),
    );
    if ($form[$key]['status']['#value']) {
      $rows_enabled[] = $row;
    }
    else {
      $rows_disabled[] = $row;
    }
  }

  if (count($rows_enabled) > 1 && count($rows_disabled) > 1) {
    $rows = array_merge($rows_enabled, $rows_disabled);
  }
  elseif (count($rows_enabled) > 1) {
    $rows = $rows_enabled;
  }
  elseif (count($rows_disabled) > 1) {
    $rows = $rows_disabled;
  }
  else {
    $rows = array(array('', '<em>'. t('No facets available.') .'</em>', '', '', '', ''));
  }
  $output .= theme('table', $header, $rows);
  $output .= drupal_render($form);
  return $output;
}

function theme_faceted_search_keyword_filters_settings($form) {
  uasort($form, '_faceted_search_element_sort');

  $output = '';
  $header = array('', t('Field'), t('Weight'));
  $rows_enabled = array(array('', '<em>'. t('Enabled fields') .'</em>', ''));
  $rows_disabled = array(array('', '<em>'. t('Disabled fields') .'</em>', ''));
  foreach (element_children($form) as $key) {
    unset($form[$key]['status']['#title']);
    unset($form[$key]['weight']['#title']);
    unset($form[$key]['type']);
    $row = array(
      drupal_render($form[$key]['status']),
      $form[$key]['#title'] . ($form[$key]['help']['#value'] ? ' ('. check_plain($form[$key]['help']['#value']) .')' : ''),
      drupal_render($form[$key]['weight']),
    );
    if ($form[$key]['status']['#value']) {
      $rows_enabled[] = $row;
    }
    else {
      $rows_disabled[] = $row;
    }
  }

  if (count($rows_enabled) > 1 && count($rows_disabled) > 1) {
    $rows = array_merge($rows_enabled, $rows_disabled);
  }
  elseif (count($rows_enabled) > 1) {
    $rows = $rows_enabled;
  }
  elseif (count($rows_disabled) > 1) {
    $rows = $rows_disabled;
  }
  else {
    $rows = array(array('', '<em>'. t('No keyword filters available.') .'</em>', '', '', '', ''));
  }
  $output .= theme('table', $header, $rows);
  $output .= drupal_render($form);
  return $output;
}

/**
 * Build a form for a filter's settings.
 *
 * @param $form
 *   The form to modify.
 * @param $filters
 *   The filters whose settings are to be added.
 */
function _faceted_search_filter_settings_form(&$form, $filters) {
  foreach ($filters as $filter) {
    $key = $filter->get_key() .'_'. $filter->get_id();
    $form[$key] = array(
      '#title' => $filter->get_label(),
      '#weight' => $filter->get_weight(),
    );
    $form[$key]['filter_key'] = array(
      '#type' => 'value',
      '#value' => $filter->get_key(),
    );
    $form[$key]['filter_id'] = array(
      '#type' => 'value',
      '#value' => $filter->get_id(),
    );
    $form[$key]['help'] = array(
      '#type' => 'value',
      '#value' => $filter->get_help(),
    );
    $form[$key]['status'] = array(
      '#title' => t('Enabled'),
      '#type' => 'checkbox',
      '#default_value' => $filter->get_status(),
    );
    if ($filter->get_key() == 'node') {
      $form[$key]['status']['#value'] = TRUE;
      $form[$key]['status']['#disabled'] = TRUE;
    }
    $form[$key]['type'] = array(
      '#type' => 'markup',
      '#value' => check_plain($filter->get_key()),
    );
    $form[$key]['weight'] = array(
      '#title' => t('Weight'),
      '#type' => 'textfield',
      '#default_value' => $filter->get_weight(),
      '#maxlength' => 4,
      '#size' => 4,
      '#required' => TRUE,
    );
  }
  return $form;
}

/**
 * Build a form for a facet's settings.
 *
 * @param $form
 *   The form to modify.
 * @param $filters
 *   The filters whose settings are to be added.
 */
function _faceted_search_facet_settings_form(&$form, $filters) {
  $form = _faceted_search_filter_settings_form($form, $filters);
  foreach ($filters as $filter) {
    $key = $filter->get_key() .'_'. $filter->get_id();

    // Sort criteria.
    $sort_options = $filter->get_sort_options();
    if (count($sort_options)) {
      $form[$key]['sort'] = array(
        '#title' => t('Sort criteria for categories'),
        '#type' => 'select',
        '#default_value' => $filter->get_sort(),
        '#options' => $sort_options,
      );
    }
    else {
      $form[$key]['sort'] = array(
        '#type' => 'markup',
        '#value' => t('n/a'),
      );
    }

    // Number of categories to show.
    $form[$key]['max_categories'] = array(
      '#title' => t('Number of categories to show in guided search'),
      '#type' => 'select',
      '#options' => array(
        0 => t('All categories'),
        5 => t('Up to 5 categories'),
        10 => t('Up to 10 categories'),
        15 => t('Up to 15 categories'),
        20 => t('Up to 20 categories'),
        25 => t('Up to 25 categories'),
        30 => t('Up to 30 categories'),
        40 => t('Up to 40 categories'),
        50 => t('Up to 50 categories'),
        100 => t('Up to 100 categories'),
      ),
      '#default_value' => $filter->get_max_categories(),
    );
  }

  return $form;
}