upei_roblib_search/modules/roblib_search_eds/roblib_search_eds.module

<?php

/**
 * @file
 * Implementation of Roblib search for searching several targets.
 */


/**
 * Implements hook_menu().
 */
function roblib_search_eds_menu() {
  $items = array();

  $items['admin/roblib_search/eds_search'] = array(
    'title' => 'EDS search Target configuration',
    'description' => 'Configuration for the Roblib eds search target',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('roblib_search_eds_config_form'),
    'access arguments' => array('access administration pages'),
    'type' => MENU_NORMAL_ITEM,
  );

  $items['roblib_search/eds/ajax/%'] = array(
    'title' => 'eds ajax',
    'page callback' => 'roblib_search_eds_ajax',
    'page arguments' => array(3),
    'type' => MENU_CALLBACK,
    'access arguments' => array('search roblib eds'),
  );
  $items['roblib_search/eds/articles/%'] = array(
    'title' => 'eds ajax',
    'page callback' => 'roblib_search_eds_articles',
    'page arguments' => array(3),
    'type' => MENU_CALLBACK,
    'access arguments' => array('search roblib eds'),
  );

  $items['roblib_search/eds/info/%'] = array(
    'title' => 'eds info',
    'page callback' => 'roblib_search_eds_info',
    'page arguments' => array(3),
    'type' => MENU_CALLBACK,
    'access arguments' => array('search roblib eds'),
  );

  return $items;
}

function roblib_search_eds_info($type = 'Articles') {
  $config = roblib_search_eds_build_config_arr($type);
  $eds_api = new EBSCOAPI($config);
  $output['type'] = $type;
  $output['profile'] = $eds_api->getInfo();
  print json_encode($output);

  exit();
}

/**
 * Implements hook_permission().
 */
/*function roblib_search_eds_permission() {
  return array(
    'search roblib eds' => array(
      'title' => t('Search the eds target'),
      'description' => t('Search Roblib eds target. This permission exposes the search blocks and allows you to see search results.'),
    ),
    'administer roblib search eds' => array(
      'title' => t('Administer Roblib Search EDS'),
      'description' => t('Administer settings for the Roblib eds search client.'),
    ),
  );
}*/


/**
 * Implements hook_theme().
 */
function roblib_search_eds_theme($existing, $type, $theme, $path) {
  return [
    'roblib_search_eds_books' => [
      'variables' => ['query' => NULL],
    ],
    'roblib_search_eds_articles' => [
      'variables' => ['query' => NULL],
    ],
  ];
}



/*function roblib_search_eds_block_info() {

  $blocks['roblib_search_eds_results'] = array(
    // info: The name of the block.
    'info' => t('EDS Search Results block'),
    // Block caching options (per role, per user, etc.)
    'cache' => DRUPAL_CACHE_PER_ROLE,
  );
  $blocks['roblib_search_eds_articles'] = array(
    'info' => t('EDS Search Results Articles'),
    'cache' => DRUPAL_CACHE_PER_ROLE,
  );
  return $blocks;
}*/

/*function roblib_search_eds_block_view($delta = '') {
  switch ($delta) {
    case 'roblib_search_eds_results':
      $block['subject'] = t('Books & Media');
      $block['content'] = theme('roblib_search_eds', array('results' => NULL));
      break;

    case 'roblib_search_eds_articles':
      $block['subject'] = t('Articles');
      $block['content'] = theme('roblib_search_eds_articles', array('results' => NULL));
      break;

  }
  return $block;
}*/

/*function roblib_search_eds_ajax($query) {
  print roblib_search_eds_get_results($query, 'Books');
  exit();
}

function roblib_search_eds_articles($query) {
  print roblib_search_eds_get_results($query, 'Articles');
  exit();
}*/

/**
 *
 * @param string $query
 * @return string
 *   json string
 */
function roblib_search_eds_get_results($query = NULL, $type = 'Articles') {
  drupal_add_css(drupal_get_path('module', 'roblib_search_eds') . '/css/roblib_search_eds.theme.css');
  module_load_include('php', 'ebsco', 'lib/EBSCOAPI');
  module_load_include('php', 'ebsco', 'lib/EBSCOAPIConnector');
  module_load_include('php', 'ebsco', 'lib/EBSCOAPIResponse');
  // Url parameters.
  if (!isset($query)) {
    if (isset($_GET['roblib_query'])) {
      $query = $_GET['roblib_query'];
    }
    else {
      return '';
    }
  }
  $limiters = '';
  if ($type != NULL) {
    $limiters = urldecode(roblib_search_eds_get_query_limiters($type));
  }
  // hardcoding "available in library collection" limiter as we can't pass it the
  // same way we passed other limiters
  $filters = ($type === 'Books') ? array("addlimiter(FT1:y)") : array();
  $config = roblib_search_eds_build_config_arr($type);

  $number_per_page = variable_get('roblib_search_eds_num_results', '5');
  $query = '(' . $query . ') ' . $limiters;
  $search = array('lookfor' => $query, 'type' => 'ALLFields', 'index' => 'AllFields', 'q' => 'ebsco/results', 'op' => 'Search');
  $eds_api = new EBSCOAPI($config);
  $is_local_ip = $eds_api->connector()->isGuestIPAddress($_SERVER["REMOTE_ADDR"]);
  //$eds_api->isGuest(boolval(variable_get('roblib_search_eds_guest','y')));
  $eds_api->isGuest(!$is_local_ip);

  $output = $eds_api->apiSearch($search, $filters, 1, $number_per_page);
  $output['is_local_ip'] = $is_local_ip;
  return json_encode($output);
}

/**
 * For each result query ebsco again to get the detailed record.
 *
 * and insert a new DetailedRecord element in each record.
 *
 * @param array $output
 *   The orginal search results array
 * @param string $query
 *   The orginal query
 * @param object $eds_api
 *   an ebco API PHP object
 */
function roblib_search_eds_get_detailed_result(&$output, $query, &$eds_api) {
  foreach ($output['records'] as &$record) {
    $db = $record['DbId'];
    $an = $record['An'];
    $arr = $eds_api->apiRetrieve($an, $db, $query);
    $record['DetailedRecord'] = $arr['Items'];
  }
}

/**
 * Creates the limiter string to append to the end of a query.
 *
 * @param string $type
 *   The type of search we want (Articles or Books)
 *
 * @return string
 *   The limiters to append to the query.
 */
function roblib_search_eds_get_query_limiters($type) {
  $limiters = 'n';
  switch ($type) {
    case 'Articles':
      //$limiters = 'facetfilter=1,SourceType:Magazines,SourceType:News,SourceType:Academic+Journals,SourceType:Conference+Materials';
      $limiters = ' ' . variable_get('roblib_search_eds_article_limiters',
      'AND (PT Article OR PT Magazines OR PT News OR PT Academic Journals OR PT Conference Materials)');
      break;

    case 'Books':
      // $limiters = '+AND+(PT+book)';
      //$limiters = 'facetfilter=1,PublicationType:Books,PublicationType:Audio,PublicationType:Videos';
      $limiters = ' ' . variable_get('roblib_search_eds_book_limiters',
      'AND (PT Book OR PT Video OR PT Audio)');
      break;


  }
  return urlencode($limiters);
}

function roblib_search_eds_build_config_arr($type) {
  $config = array();
  $config['user'] = variable_get('roblib_search_eds_user', 'edsusername');
  $config['password'] = variable_get('roblib_search_eds_pass', 'edspassword');
  //get the local ips allowed from ebsco
  $config['local_ip_address'] = variable_get('ebsco_local_ips');
  $config['profile'] = ($type === 'Books') ? variable_get('roblib_search_eds_book_profile', 'apilite') :
    variable_get('roblib_search_eds_profile', 'edsapi');
  $config['auth_url'] = variable_get('roblib_search_eds_auth_url', 'https://eds-api.ebscohost.com/Authservice/rest');
  $config['rest_url'] = variable_get('roblib_search_eds_rest_url', 'https://eds-api.ebscohost.com/edsapi/rest');
  $config['guest'] = variable_get('roblib_search_eds_guest','y');
  return $config;
}

/**
 * Implements hook_help().
 *
 * @param type $path
 * @param type $arg
 * @return type
 */
function roblib_search_eds_help($path, $arg) {
  switch ($path) {
    case 'admin/help#roblib_search_eds':
      return t(
        '<p>
   provides a target for the Roblib search module.  This target uses javascript
   to render the results.
   </p>'
      );
  }
}