apachesolr_nan.admin.inc in Apache Solr Not-A-Node 7.2

Administrative functions and form builders for Apache Solr NAN Search.

File

apachesolr_nan.admin.inc

<?php

/**
 * @file
 *
 * Administrative functions and form builders for Apache Solr NAN Search.
 */

/**
 * function apachesolr_nan_nan_settings_form().
 *
 * Builds the administration form for Apache Solr NAN search.
 */
function apachesolr_nan_nan_settings_form($form, &$form_state) {

  // We will have many fields with the same name, so we need to be able to
  // access the form hierarchically.
  $form['#tree'] = TRUE;
  $environments = apachesolr_load_all_environments();
  $env_options = array();
  foreach ($environments as $machine_name => $env) {
    $env_options[$machine_name] = $env['name'];
  }
  $form['environment'] = array(
    '#type' => 'select',
    '#options' => $env_options,
    '#description' => t('Choose the solr server with which to index the content.'),
    '#default_value' => apachesolr_default_environment(),
    '#required' => TRUE,
  );
  $form['description'] = array(
    '#type' => 'item',
    '#title' => t('Define the paths you would like indexed along with names and descriptions for them.'),
  );
  if (empty($form_state['items'])) {

    // load all NANs
    $nans = entity_load('apachesolr_nan', FALSE);
    $form_state['items'] = $nans;
  }
  if (!empty($form_state['all_removed']) || empty($form_state['items'])) {
    $form_state['items'] = NULL;

    //array(0 => array());
  }
  if (!empty($form_state['items'])) {

    // Build a fieldset for each item in the items array.
    foreach ($form_state['items'] as $i => $data) {
      $form['item'][$i] = array(
        '#type' => 'fieldset',
        '#title' => $data->id ? t('Item #@num', array(
          '@num' => $data->id,
        )) : t('New item'),
        '#collapsible' => TRUE,
        '#collapsed' => FALSE,
      );
      $form['item'][$i]['path'] = array(
        '#type' => 'textfield',
        '#title' => t('Path to Index'),
        '#description' => t('Enter a path to index.'),
        '#required' => TRUE,
        '#default_value' => !empty($data->path) ? $data->path : '',
      );
      $form['item'][$i]['title'] = array(
        '#type' => 'textfield',
        '#title' => t('Indexed Title'),
        '#description' => t('A title to show on the search results page. This can be the name of the page or something else but users will see this in search results and the text will be used to boost result order.'),
        '#default_value' => !empty($data->title) ? $data->title : '',
      );
      $form['item'][$i]['description'] = array(
        '#type' => 'textarea',
        '#title' => t('Page description'),
        '#description' => t('The description will show in search results only. It can be used to improve search results for certain pages.'),
        '#default_value' => !empty($data->description) ? $data->description : '',
      );
      $form['item'][$i]['frequency'] = array(
        '#type' => 'select',
        '#title' => t('Time between indexes'),
        '#options' => array(
          3600 => 'hourly',
          86400 => 'daily',
          604800 => 'weekly',
          2419200 => 'monthly',
        ),
        '#description' => t('The page will be reindexed at the set interval.'),
        '#default_value' => isset($data->frequency) ? $data->frequency : 86400,
        '#required' => TRUE,
      );
      $form['item'][$i]['delete'] = array(
        '#type' => 'submit',
        '#name' => $i,
        '#value' => 'Delete',
        '#submit' => array(
          'apachesolr_nan_remove_form_item',
        ),
        '#limit_validation_errors' => array(),
      );
    }
  }
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => 'Submit',
  );

  // Adds "Add another name" button
  $form['add_item'] = array(
    '#type' => 'submit',
    '#value' => t('Add another item'),
    '#submit' => array(
      'apachesolr_nan_add_form_item',
    ),
  );
  return $form;
}

/**
 * function apachesolr_nan_add_form_item().
 *
 * Handles adding an additional item to the admin form.
 *
 * @see apachesolr_nan_nan_settings_form().
 */
function apachesolr_nan_add_form_item($form, &$form_state) {

  // Add an element to the end of the array with the next available number.
  if (empty($form_state['items'])) {
    $form_state['items'][] = array();
  }
  else {
    $keys = array_keys($form_state['items']);
    $end = end($keys);
    $end++;
    $form_state['items'][$end] = array();
  }

  // Rebulid the form.
  $form_state['rebuild'] = TRUE;
  drupal_set_message(t('Your changes will not be saved until you press the submit button.'), 'warning');
}

/**
 * function apachesolr_nan_remove_form_item().
 *
 * Handles item removal from the admin page.
 *
 * @see apachesolr_nan_nan_settings_form().
 */
function apachesolr_nan_remove_form_item($form, &$form_state) {

  // Remove the item from the array that corresponds to the pressed delete
  // button.
  $keys = array_keys($form_state['values']['item']);
  $first = reset($keys);
  unset($form_state['items'][$first]);
  $form_state['rebuild'] = TRUE;
  if (empty($form_state['items'])) {
    $form_state['all_removed'] = TRUE;
  }
  drupal_set_message(t('If you are making changes to existing data, your changes will not be saved until you press the submit button.'), 'warning');
}

/**
 * function apachesolr_nan_nan_settings_form_validate().
 *
 * Validation for the admin page.
 *
 * @see apachesolr_nan_nan_settings_form().
 * @see apachesolr_nan_nan_settings_form_submit().
 */
function apachesolr_nan_nan_settings_form_validate($form, &$form_state) {

  // Validate the paths.
  if (!empty($form_state['items'])) {
    foreach ($form_state['items'] as $i => $data) {
      $path = $form_state['values']['item'][$i]['path'];
      if (!drupal_valid_path($path)) {
        if (empty($form_state['all_removed']) && $path != '') {
          form_set_error("item][{$i}][path", t('The path is not valid or you do not have access to it.'));
        }
      }
    }
  }
}

/**
 * function apachesolr_nan_nan_settings_form_submit().
 *
 * Submit form for admin page.
 *
 * @see apachesolr_nan_nan_settings_form().
 * @see apachesolr_nan_nan_settings_form_validate().
 */
function apachesolr_nan_nan_settings_form_submit($form, &$form_state) {
  $current_nans = entity_load('apachesolr_nan', FALSE);
  $old_env = variable_get('apachesolr_nan_nan_env', apachesolr_default_environment());
  if ($form_state['values']['environment'] != $old_env) {

    // We switched environments so clean everything out of the other one.
    if (!empty($current_nans)) {
      foreach ($current_nans as $nan) {
        apachesolr_index_delete_entity_from_index($old_env, 'apachesolr_nan', $nan);
      }
    }
  }

  // Set the new environment.
  $env = $form_state['values']['environment'];
  variable_set('apachesolr_nan_nan_env', $env);
  if (!empty($form_state['items'])) {
    foreach ($form_state['values']['item'] as $key => $item) {
      unset($form_state['values']['item'][$key]['delete']);
    }
    $items = array_values($form_state['values']['item']);
  }
  else {
    $items = array();
  }

  // Keep list of previous paths in the DB.
  $old_paths = array();
  foreach ($current_nans as $nan) {
    $old_paths[] = $nan->path;
  }

  // Save adds/changes into the database.
  $new_paths = array();
  $saved = FALSE;
  foreach ($items as $item) {
    $new_paths[] = $item['path'];
    apachesolr_nan_write_entity($item);
    $saved = TRUE;
  }
  if ($saved) {
    drupal_set_message(t('Your paths have been updated or added.'));
  }

  // Find any removed elements and delete them.
  $delete_paths = array_diff($old_paths, $new_paths);
  if (!empty($delete_paths)) {
    module_load_include('inc', 'apachesolr', 'apachesolr.index');
    $deleted = array();
    foreach ($delete_paths as $path) {
      if (apachesolr_nan_delete_entity($env, $path)) {
        watchdog('ApacheSolr NAN search', 'The Apachesolr NAN path %path was deleted', array(
          '%path' => $path,
        ));
      }
      else {
        drupal_set_message(t('There was a problem removing the page from the index.'), 'error');
        watchdog('ApacheSolr NAN search', 'The Apachesolr NAN path %path could not be deleted', array(
          '%path' => $path,
        ), WATCHDOG_ERROR);
      }
      $deleted[] = $path;
    }
  }
  if ($deleted > 0) {
    drupal_set_message(t('The following paths were deleted:'));
    foreach ($deleted as $removed_path) {
      drupal_set_message($removed_path);
    }
  }
}

/**
 * function apachesor_nan_get_nan_by_path().
 *
 * EntityFieldQuery wrapper to get a single nan by path.
 *
 * @param $path
 * @return bool|mixed
 */
function apachesolr_nan_get_nan_by_path($path) {
  $query = new EntityFieldQuery();
  $entities = $query
    ->entityCondition('entity_type', 'apachesolr_nan')
    ->propertyCondition('path', $path)
    ->execute();
  if ($entities['apachesolr_nan']) {
    return reset(entity_load('apachesolr_nan', array_keys($entities['apachesolr_nan'])));
  }
  return FALSE;
}

/**
 * function apachesolr_nan_write_entity().
 *
 * Helper function to update/save data for Apachesolr NAN entities.
 *
 * @param $item - Array containing submitted values for NANs
 */
function apachesolr_nan_write_entity($item) {

  // Fetch existing record.
  $nan = apachesolr_nan_get_nan_by_path($item['path']);
  if (!$nan) {

    // Else write a new record.
    $nan = entity_create('apachesolr_nan', array());
  }
  $nan->path = $item['path'];
  $nan->title = $item['title'];
  $nan->description = $item['description'];
  $nan->frequency = $item['frequency'];
  $nan
    ->save();
}

/**
 * function apachesolr_nan_delete_entity().
 *
 * Helper function to delete a nan entity.
 *
 * @param $env
 * @param $delete_path
 * @return bool
 */
function apachesolr_nan_delete_entity($env, $delete_path) {
  if ($nan = apachesolr_nan_get_nan_by_path($delete_path)) {
    $nan
      ->delete();
    apachesolr_index_delete_entity_from_index($env, 'apachesolr_nan', $nan->id);
    return TRUE;
  }
  return FALSE;
}

Functions

Name	Description
apachesolr_nan_add_form_item	function apachesolr_nan_add_form_item().
apachesolr_nan_delete_entity	function apachesolr_nan_delete_entity().
apachesolr_nan_get_nan_by_path	function apachesor_nan_get_nan_by_path().
apachesolr_nan_nan_settings_form	function apachesolr_nan_nan_settings_form().
apachesolr_nan_nan_settings_form_submit	function apachesolr_nan_nan_settings_form_submit().
apachesolr_nan_nan_settings_form_validate	function apachesolr_nan_nan_settings_form_validate().
apachesolr_nan_remove_form_item	function apachesolr_nan_remove_form_item().
apachesolr_nan_write_entity	function apachesolr_nan_write_entity().