uw_lib_refshelf.module

<?php
/**
 * Purpose of this modules to display the data feeding from Textura in JSON to
 * WCMS Library site.Keyword search functionality for description and name is
 * also supported by this module.
 * Written by Lathangi Ganesh Dec 12, 2017
 */

/**
 * Implements hook_menu().
 */
function uw_lib_refshelf_menu() {
  $items['online-reference-shelf']=array(
    'title' => 'Online Reference Shelf',
    'page callback' => 'uw_lib_refshelf_render_data',
    'access callback' => TRUE,
  );
  return $items;
}

/**
* Implements hook_block_info().
*/
function uw_lib_refshelf_block_info() {
  $blocks = array();
  $blocks['online_ref_shelfVer'] = array(
  'info'  => t("Online Ref Shelf"),
  'status' => TRUE, // enable the block
  'region' => 'sidebar_second',
  'weight' => '-30',
  'cache' => DRUPAL_CACHE_GLOBAL,
  'visibility' => BLOCK_VISIBILITY_LISTED,
  'pages' => "online-reference-shelf\nonline-reference-shelf/*",
  );
  return $blocks;
}

/**
* Implements hook_block_info().
*/
function uw_lib_refshelf_block_view($delta = '') {
  $block = array();
  switch ($delta) {
    case 'online_ref_shelfVer':
    $block['content'] = t('Form is going to be here');
    $search_form = drupal_get_form('uw_lib_refshelf_form');
    $search_block = drupal_render($search_form );
    $block['content'] = $search_block;
    break;
  }
  return $block;
}

/**
 * Implements hook_form().
 */
function uw_lib_refshelf_form($form, &$form_state) {
  $txt = '<span style="font-size:0.8rem;">test</span>';
  $form = array(
    //Define a simple text field for the "search"
    'name' => array(
      '#type' => 'textfield',
      '#size' => 30,
      '#attributes' => array('placeholder' => t('Please enter a keyword')),
      //'#attributes' => array('placeholder' => t($txt)),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
      '#region' => 'content',
    ),
    //Define a simple submit button
    'submit' => array(
      '#type' => 'submit',
      '#value' => t('Search'),
    ),
  );
  return $form;
}

/**
 * Implements hook_form_validate().
 */
function uw_lib_refshelf_form_validate($form, &$form_state) {
  if (strlen($form_state['values']['name']) > 100) {
    form_set_error('', t('Word is too long'));
  }
  elseif (strlen($form_state['values']['name']) < 3) {
    form_set_error('', t('Please enter a word more than 2 characters'));
  }
}

/**
 * Implements hook_form_submit().
 */
function uw_lib_refshelf_form_submit($form, &$form_state) {
  $word = $form_state['values']['name'];
  drupal_goto('online-reference-shelf', array('query' => array('search' => $word)));
}

/**
 * Page callback calling from uw_lib_refshelf_menu()
 */
function uw_lib_refshelf_render_data() {
  $content = "";
  $links = "";

  //Sanitize the data from URL
  $filter_cat_id = isset($_GET['cat_id']) ? filter_var($_GET['cat_id'], FILTER_SANITIZE_STRING) : NULL;
  $filter_toc_id = isset($_GET['toc_id']) && is_numeric($_GET['toc_id']) ? $_GET['toc_id'] : NULL;
  $filter_pagenum = isset($_GET['pagenum']) ? filter_var($_GET['pagenum'], FILTER_SANITIZE_STRING) : NULL;
  $filter_search = isset($_GET['search']) ? filter_var($_GET['search'], FILTER_SANITIZE_STRING) : NULL;

//Check for cat_id and toc_id in GET
  if (array_key_exists("cat_id", $_GET) || array_key_exists("toc_id", $_GET)) {
    if (isset($filter_cat_id) && !empty($filter_cat_id)) {
    //Displaying Subcategories

      $cat_id = $filter_cat_id;
      $url = "https://libtextura.uwaterloo.ca/api-auth/v1/refshelf/categories/";
      $parent_data = _getData($cat_id, $url);
      $element = $parent_data['data'];
      $tit = $element[0]['name'];
      _setBreadCrumbs("cat_id", $cat_id, $tit, 0);

      $txt = "<h2>" . $tit . "</h2><br />";
      $_SESSION['tit'] = $txt;
      $qparam = $_GET['cat_id'];
      $links = _getLinkAndDesc($qparam, "toc_id");
      if (empty($links)) {
        $txt = "<h2>Resources for " . $tit . "</h2><br />";
        $links .= _getLinkAndDesc($qparam, "resources");
      }

      $content .= $txt;
      $content .= $links;
    }
    elseif (isset($filter_toc_id) && !empty($filter_toc_id)) {
    //Displaying resources for the subcategories

      $toc_id = $filter_toc_id;
      $url = "https://libtextura.uwaterloo.ca/api-auth/v1/refshelf/categories/";
      $parent_data = _getData($toc_id, $url);
      $element = $parent_data['data'];
      $parent_id = $element[0]['parent_category'];
      $tit = $element[0]['name'];
      _setBreadCrumbs("toc_id", $toc_id, $tit, $parent_id);
      $content .= $_SESSION['tit'];
      $txt = "<h3>" . $tit . "</h3><br />";
      $content .= $txt;
      $qparam = $filter_toc_id;
      $content .= _getLinkAndDesc($qparam, "resources");
    }
  }
  else {
    if (isset($filter_pagenum)) {
    //Pagination view

      _setBreadCrumbs("none", 0, "Online Reference Shelf", 0);
      $search_res = "";
      $rec_limit = 0;
      $pagenum = $filter_pagenum + 1;
      $offset = $rec_limit * $pagenum;
      $stored_search_results = $_SESSION['search_results'];
      $word = $_SESSION['search_word'];
      $search_res .= _viewSearchResults($stored_search_results, $word, $pagenum, $offset);
      $content = $search_res;
    }
    elseif (isset($filter_search)) {
    //Search results

      _setBreadCrumbs("none", 0, "Online Reference Shelf", 0);
      $word = $filter_search;
      $word =  _filterSearchWord($word);
      $str_len = strlen($word);
      if ($str_len < 3) {
        $content = '<p><b>Please enter a valid keyword for search (not characters)</b></p>';
      }
      else {
        $content = _refshelfDataSearch($word);
      }
    }
    else {
    //Displaying the top level links

      _setBreadCrumbs("none", 0, "Online Reference Shelf", 0);
      $links = "";
      $txt = '<div><p>Find answers to quick factual questions in the online resources below.</p></div>';
      $txt .= '<div><h2>Browse by category</h2><br /></div>';
      $param = 0;
      $content .= $txt;
      $links .= _getLinkAndDesc($param, "cat_id");
      $content .= $links . '<br \>';
    }
  }
  return $content;
}

/**
 * Get the element as object
 * @param $uri the URI to get
 * @return object
 */
function _getData($param, $url) {
  $uri = $url . $param;
  $file_headers = @get_headers($uri);
  if (!$file_headers || $file_headers[0] == 'HTTP/1.1 404 Not Found') {
    drupal_set_message(t('<h3>URL is not available to collect the data</h3>'));
  }
  else{
    $response = file_get_contents($uri);
    if (!empty($response)) {
      return drupal_json_decode($response);
    }
    else{
      drupal_set_message(t('<h3> No Data is available</h3>'));
    }
  }
}

/**
 * get the data and manipulate the fields
 */
function _getLinkAndDesc($param, $str) {
  if ($str == 'resources') {
    $url = "https://libtextura.uwaterloo.ca/api-auth/v1/refshelf/resources/category/";
  }
  else {
    $url = "https://libtextura.uwaterloo.ca/api-auth/v1/refshelf/categories/parent/";
  }
  $param_data = _getData($param, $url);
  $content = "";
  $link = "";
  $desc = "";
  $elements = $param_data['data'];

  foreach ($elements as $element) {
    $link_name = $element['name'];
    $id = $element['id'];
    if (isset($element['url'])) {
      $link_url = $element['url'];
      if (isset($element['is_restricted_resource'])) {
        $restricted = $element['is_restricted_resource'];
        $link_url = _filterRestrictedResource($restricted, $link_url);
      }
    }
    else {
      $link_url = "?" . $str . "=" . $id;
    }
    if (isset($element['description'])) {
      $content .= '<div><a href="' . $link_url . '">' . $link_name . '</a></div>';
      $content .= "<div>" . $element['description'] . "</div><br />";
    }
    else {
      if (!empty($link_name) && !empty($link_url)) {
        $content .= '<p><a href="' . $link_url . '">' . $link_name . '</a></p>';
      }
    }
  }
  return $content;
}

/**
* breadcrumbs
*/
function _setBreadCrumbs($str, $id, $title, $parent_id) {
  $breadcrumb = drupal_get_breadcrumb();
  $main_title = drupal_get_title();
  $title_link = '<a href="online-reference-shelf">' . $main_title . '</a>';
  if ($str == "none") {
    $breadcrumb[] = $title_link;
  }
  elseif ($str == "cat_id") {
    $breadcrumb[] = $title_link;
    $breadcrumb[] = $title;
  }
  elseif ($str == "toc_id") {
    $breadcrumb[] = $title_link;
    $url = "https://libtextura.uwaterloo.ca/api-auth/v1/refshelf/categories/";
    $parent_data = _getData($parent_id, $url);
    $element = $parent_data['data'];
    $tit = $element[0]['name'];
    $link_url = "?" . "cat_id" . "=" . $parent_id;
    $parent_link = '<a href="' . $link_url . '">' . $tit . '</a>';
    $breadcrumb[] = $parent_link;
    $breadcrumb[] = $title;
  }
  else {
    $breadcrumb[] = $title_link;
  }
  drupal_set_breadcrumb($breadcrumb);
}

/**
 * To get the appropriate search results for different parameters
 * In this case searching in description and name fields
 */
function _refshelfDataSearch($word) {
  $content = "";
  $param = "";
  $all = array();
  $url = "https://libtextura.uwaterloo.ca/api-auth/v1/refshelf/resources/";
  $param_data = _getData($param, $url);
  $elements = $param_data['data'];

  foreach ($elements as $element) {
    $link_name = ($element['name']);
    $link_url = ($element['url']);
    $desc = $element['description'];
    $restricted = $element['is_restricted_resource'];

    //keyword search in description
    if (isset($element['description']) && !empty($element['description'])) {
      $status = _keywordSearch($word, $desc);
      $all[] =  _processingSearchResults($status, $desc, $link_name, $link_url, $word, $restricted);
    }

    //keyword search in name
    if (isset($element['name']) && !empty($element['name'])) {
      $status = _keywordSearch($word, $link_name);
      $all[] =  _processingSearchResults($status, $desc, $link_name, $link_url, $word, $restricted);
    }
  }
  //Eliminate duplicates
  $no_duplicates = array_unique($all);
  $records_cnt = count($no_duplicates);
  $actual_records = $records_cnt -1 ;

  if ($records_cnt < 25) {
    $msg = "<h3>The following result(s) found for the keyword <span style='background-color: #ffea30;'>" . $word . "</span></h3><br />";
    if (!empty($no_duplicates)) {
      foreach ($no_duplicates as $result) {
        $content .= $result;
      }
    }
    if (!empty($content)) {
      $results = $msg . $content;
      return $results;
    }
    else{
      return "<h3>No results found for the keyword <b>" . $word . "</b></h3>";
    }
  }
  else{
    $_SESSION['search_results'] =  $no_duplicates;
    $_SESSION['search_word'] = $word;
    $pagenum = 0;
    $offset = 0;
    $view = _viewSearchResults($no_duplicates, $word, $pagenum, $offset);
    return $view;
  }
}

/**
Resctriced URL is passed through the proxy
*/
function _filterRestrictedResource($restricted, $url) {
  $proxy_url = "http://proxy.lib.uwaterloo.ca/login?url=";
  if ($restricted == 1) {
    $link_addr = $proxy_url . $url;
  }
  else {
    $link_addr = $url;
  }
  return $link_addr;
}

/**
 * To highlight the search word in search results
 */
function _highlightSearchWord($word, $str) {
  //Replace exctly like search string
  //$word_style = "<span style='background-color: #ffea30;'>" . $word . "</span>";
  //$highlighted = str_ireplace($word, $word_style, $str);

  //Search results keyword lowercase
  $word_lc = strtolower($word);
  $word_style1 = "<span style='background-color: #ffea30;'>" . $word_lc . "</span>";
  $highlighted = str_replace($word_lc, $word_style1, $str);

  //Search results keyword -- First letter uppercase
  $word_ucf = ucfirst($word);
  $word_style2 = "<span style='background-color: #ffea30;'>" . $word_ucf . "</span>";
  $highlighted = str_replace($word_ucf, $word_style2, $highlighted);

  //Search results keyword uppercase
  $word_uc = strtoupper($word);
  $word_style4 = "<span style='background-color: #ffea30;'>" . $word_uc . "</span>";
  $highlighted = str_replace($word_uc, $word_style4, $highlighted);

  //Replacement for a search keyword -- all uppercase
  if (ctype_upper($word)) {
    //For search results keyword -- lowercase
    $word_uc = strtolower($word);
    $word_style3 = "<span style='background-color: #ffea30;'>" . $word_uc . "</span>";
    $highlighted = str_replace($word_uc, $word_style3, $highlighted);

    //For search results keyword -- First letter -- uppercase
    $word_ucf = ucfirst($word_uc);
    $word_style2 = "<span style='background-color: #ffea30;'>" . $word_ucf . "</span>";
    $highlighted = str_replace($word_ucf, $word_style2, $highlighted);
  }
  return $highlighted;
}

/**
 * To display the search results with pagination
 */
function _viewSearchResults($no_duplicates, $word, $pagenum, $offset) {
  $page = "";
  $content = "";
  $results = "";
  $rec_count = count($no_duplicates);
  $rec_limit = 25;
  $left_rec = $rec_count - ($pagenum * $rec_limit) - 2 ;
  $offset = $rec_limit * $pagenum ;
  $limit = $rec_limit * $pagenum;

  if (!empty($no_duplicates)) {
    if ($rec_count > $offset) {
      $msg = "<h3>The following result[s] found for the keyword <span style='background-color: #ffea30;'>" . $word . "</span></h3><br />";
      $cnt = 0;
      $c = 0;
      foreach ($no_duplicates as $result) {
        if ($cnt > $offset) {
          if ($c < $rec_limit) {
        $page .= $result;
            }
          $c++;
        }
        $cnt++;
      }
      if (!empty($page)) {
        $results = $msg . $page;
      }
      else {
        $results = "<h3>No results found for the keyword <b>" . $word . "</b></h3>";
      }
    }
  }
  $pagination = _pagination($pagenum, $left_rec, $rec_limit);
  $content = $results . $pagination;
  return $content;
}

/**
 * Formatting the search results to display
 */
//function _processingSearchResults($status, $desc, $link_name, $link_url, $word) {
function _processingSearchResults($status, $desc, $link_name, $link_url, $word, $restricted) {
  $content = "";
  $link_url = _filterRestrictedResource($restricted, $link_url);
  $desc = _highlightSearchWord($word, $desc);
  $link_name = _highlightSearchWord($word, $link_name);

  if ($status) {
    if (!empty($desc)) {
      $link = '<span class="ref_links"><a href="' . $link_url . '">' . $link_name . '</a></span>';
      $content .= $link . "<p>" . $desc . "</p>";
    }
    else {
      $content .= "<p>No results found for the word</p>";
    }
  }
  return $content;
}

/**
 * Keyword search in the data array or data string
 */
function _keywordSearch($word, $data) {
  //For array
  if (is_array($data) && !empty($data)) {
    $data = array_map('strtolower', $data);
    if (in_array ($word, $data)) {
      return TRUE;
    }
    else{
      return FALSE;
    }
  }
  else{ //For String
    $str = trim($data);
    $str = strtolower($data);
    if (!empty($word) && !empty($str)) {
      if (strlen($str) >= strlen($word)) {
        $s_word = "/" . $word . "/i";
        if (preg_match($s_word, $str)) {
          return TRUE;
        }
        else {
          return FALSE;
       }
      }
    }
  }
}

/**
 * Filter the search word for bad characters
 */
function _filterSearchWord($word) {
  $word = trim($word);
  //$chars = array('/', '\\', '[', ']', "<", "*", ">", "}", "{", "^");
  $chars = array('/', '\\', '[', ']', "<", "*", ">", "}", "{", "^", "(", ")", "+", "?");
  $search_str = str_replace($chars, '', $word);
  return $search_str;
}

/**
 * Pagination at the bottom for search results - custom
 */
function _pagination($pagenum, $left_rec, $rec_limit) {
  $content = "";
  if ( $left_rec < $rec_limit ) {
    $last = $pagenum - 2;
    $content = "<a href = \"?pagenum={$last}\">Previous</a>";
  }
  elseif ($pagenum == 0 ) {
    $content =  "<a href = \"?pagenum={$pagenum}\">Next</a>";
  }
  elseif ($pagenum > 0 ) {
    $last = $pagenum - 2;
    $content .=  "<a href = \"?pagenum={$last}\">Previous</a> |";
    $content .=  "<a href = \"?pagenum={$pagenum}\">Next</a>";
  }
  $content = "<table align='center'><tr><td align='center'>" . $content . "</td></tr></table>";
  return $content;
}