upei_roblib_ill/includes/utilities.inc

<?php
/**
 * @file
 * Contains helper functions for working with Relais requests.
 */

/**
 * Clean the form content before sending it to relais or logging it.
 *
 * @param $value
 * @param $key
 */

use Drupal\Component\Utility\Xss;
use Drupal\Component\Utility\Html;

function upei_roblib_ill_check_arr_item(&$value, $key)
{
  if (is_array($value)) {
    array_walk($value, 'upei_roblib_ill_check_arr_item');
  }
  else {
    $value = Xss::filter($value);
  }
}

/**
 * Removes empty elements and drupal specific elements from an array
 *
 * @param $values
 *   A drupal form_state['values] array
 *
 * @return array
 *   An array where the keys in the array that have empty values are removed and
 * drupal specific elements are removed.
 */
function upei_roblib_ill_clean_array($values)
{
  $arr = array_filter($values);
  if (isset($arr['ISSN'])) {
    $arr['ISSN'] = [$arr['ISSN']];
  }
  if (isset($arr['ISBN'])) {
    $arr['ISBN'] = [$arr['ISBN']];
  }
  // The below checks are due to ebscos habit of sending sending the same info in both atitle and title etc.
  if (isset($arr['Genre']) && $arr['Genre'] == 'article' && isset($arr['Author'])) {
    // We want ArticleAuthor
    unset($arr['Author']);
  }
  if (isset($arr['Genre']) && $arr['Genre'] == 'book' && isset($arr['ArticleAuthor'])) {
    // We want Author
    unset($arr['ArticleAuthor']);
  }
  if (isset($arr['Genre']) && $arr['Genre'] == 'book' && isset($arr['ArticleTitle'])) {
    // We want Title only
    unset($arr['ArticleTitle']);
  }
  if (isset($arr['doi'])) {
    $arr['AdditionalNumbers'] = $arr['doi'];
  }
  unset($arr['form_build_id']);
  unset($arr['form_token']);
  unset($arr['form_id']);
  unset($arr['op']);
  unset($arr['submit']);
  unset($arr['next']);
  unset($arr['certify']);
  unset($arr['doi']);
  unset($arr['doi_button']);
  unset($arr['honeypot_time']);
  array_walk($arr, 'upei_roblib_ill_check_arr_item');
  return $arr;
}

function upei_roblib_ill_build_err_msg($msg_from_server)
{
  $campus_id = Link::fromTextAndUrl(t('Campus ID'), Url::fromUri('http://www.upei.ca/vpaf/campuscard'));
  //$campus_id = l(t('Campus ID'), 'http://www.upei.ca/vpaf/campuscard');
  $ill_email = Link::fromTextAndUrl('ill@upei.ca', Url::fromUri('mailto:ill@upei.ca'));
  //$ill_email = l(t('ill@upei.ca'), 'mailto:ill@upei.ca');
  $phone = Link::fromTextAndUrl('902-566-0583', Url::fromUri('tel:902-566-0353'));
  //$phone = l(t('902-566-0583'), 'tel:902-566-0353');
  $server_response = !empty($msg_from_server) ? 'Server Response: ' . $msg_from_server : '';
  return t('Oops. Something went wrong.<br />Check the "Your Last Name" and "Your Campus ID" fields - those two need to match what is on file
. (Your @campus_id appears as the NUMBER near the middle of your campus card).  If you do not have a @campus_id, please contact the Robertson Library Service Desk, or,
call @phone.  Note: if you are a student taking online courses only, please email @ill_email.<br />@msg_from_server',
  [
    '@campus_id' => $campus_id->toString(),
    '@ill_email' => $ill_email->toString(),
    '@phone' => $phone->toString(),
    '@msg_from_server' => $server_response,
  ]);
}

/**
 * Lookup the user in Evergreen and verify the surname matches.
 *
 * @param string $campus_id
 *   The user's campus ID / barcode.
 * @param string $surname
 *   The surname to check against.
 *
 * @return bool
 *   TRUE if the surname matches, FALSE otherwise.
 */
function upei_roblib_ill_authenticate($campus_id, $surname): bool
{
  if (empty($campus_id) || empty($surname)) {
    return FALSE;
  }

  $config = \Drupal::config('upei_roblib_ill.settings');
  $evergreen_api_url = $config->get('evergreen_api_url');
  if (empty($evergreen_api_url)) {
    \Drupal::logger('upei_roblib_ill')->error('Evergreen API URL is not configured.');
    return FALSE;
  }

  // Construct the PatronAPI dump URL.
  // Format: {evergreen_api_url}/api/patronapi/{campus_id}/dump
  $url = rtrim($evergreen_api_url, '/') . '/api/patronapi/' . urlencode($campus_id) . '/dump';

  try {
    $response = \Drupal::httpClient()->get($url, [
      'timeout' => 10,
    ]);

    $data = (string)$response->getBody();

    // The PatronAPI dump endpoint returns data in a plain text/HTML format
    // looking like `PATRN NAME[p]=Smith, John`.
    if (preg_match('/PATRN NAME\[p\]=([^\[<]+)/i', $data, $matches)) {
      $patron_name = trim($matches[1]);

      // Usually "Lastname, Firstname"
      $name_parts = explode(',', $patron_name);
      if (count($name_parts) > 0) {
        $evergreen_surname = trim($name_parts[0]);

        // Case-insensitive comparison of the extracted surname and provided surname.
        if (strcasecmp($evergreen_surname, trim($surname)) === 0) {
          return TRUE;
        }
      }
    }

    // Log failure for debugging.
    \Drupal::logger('upei_roblib_ill')->warning('Evergreen authentication failed for @campus_id. Expected surname: @surname', [
      '@campus_id' => $campus_id,
      '@surname' => $surname,
    ]);

    return FALSE;

  }
  catch (\Exception $e) {
    \Drupal::logger('upei_roblib_ill')->error('Failed to connect to Evergreen API: @message', [
      '@message' => $e->getMessage(),
    ]);
    return FALSE;
  }
}

/**
 * Allows us to ask for _REQUEST variables that may or may not exist without
 * generating a php warning. Also does some formatting for certain variables.
 *
 * @param string $variable
 *   The name of the $_REQUEST variable to check
 *
 * @return string
 *   The value of the $_REQUEST variable or an empty string.
 */
function upei_roblib_ill_get_request_variable($variable)
{
  if ($variable == 'author' && empty($_REQUEST[$variable])) {
    //google scholar usually sends auinit aulast instead of author
    $initial = isset($_REQUEST['auinit']) ?Html::escape($_REQUEST['auinit']) : NULL;
    $last_name = isset($_REQUEST['aulast']) ?Html::escape($_REQUEST['aulast']) : NULL;
    return !empty($last_name) ? $last_name . ',' . $initial : '';
  }
  if ($variable == 'issn' && !empty($_REQUEST[$variable])) {
    // ebsco sometimes sends garbage as issns verify this is a valid issn before displaying the value in the form.
    return preg_match('/^\d{4}-?\d{3}[\dxX]$/', $_REQUEST[$variable]) ?Html::escape($_REQUEST[$variable]) : '';
  }
  // ebsco sometimes returns bookitem we only understand chapter
  if (($variable == 'genre' && !empty($_REQUEST[$variable])) && $_REQUEST[$variable] == 'bookitem') {
    return 'chapter';
  }
  return isset($_REQUEST[$variable]) ?Html::escape($_REQUEST[$variable]) : '';
}


function upei_roblib_ill_get_doi_from_request()
{
  return (!empty($_REQUEST['doi'])) ? $_REQUEST['doi'] : upei_roblib_ill_get_doi_from_id();
}

function upei_roblib_ill_get_doi_from_id()
{
  if (!empty($_REQUEST['ID'])) {
    return (strpos($_REQUEST['ID'], 'doi:') !== 0) ? '' : $_REQUEST['ID'];
  }
  return '';
}

/**
 * Populates the requestInfo portion of a Relais request
 *
 * @param array $values
 *   an array containing a 'Genre' element.
 *
 * @return array
 *   The requestInfo portion of a Relais request
 */
function upei_roblib_ill_request_info_array($values, $notes)
{
  $requestInfo = [];
  $genre = $values['Genre'];
  $requestInfo['DateSubmitted'] = date('Y-m-d H:i:s');
  $requestInfo['Notes'] = $notes;
  if ($genre == 'book') {
    $requestInfo['ServiceType'] = 'L';
    $requestInfo['ServiceLabel'] = "R";
  //$requestInfo['RequestSource'] = "C";
  }
  else {
    $requestInfo['ServiceType'] = 'X';
    $requestInfo['ServiceLabel'] = "R";
  //$requestInfo['RequestSource'] = "C";
  }
  return $requestInfo;
}

/**
 * Creates a summary Table based on the biblio information in the form_state
 * array for display
 *
 * @param $form_state
 *
 * @return string
 */
function upei_roblib_format_biblio_info($form_state)
{
  $values = $form_state->getValues();
  $data = upei_roblib_ill_clean_array($values);
  $rows = [];
  foreach ($data as $key => $value) {
    if ($key == 'ISSN' || $key == 'ISBN') {
      $value = reset($value);
    }
    array_push($rows, [$key, $value]);
  }
  $output = [
    '#theme' => 'table',
    '#rows' => $rows,
    '#prefix' => '<div class=upei-roblib-ill-biblio-info>',
    '#suffix' => '</div>',
  ];
  $html_output = \Drupal::service('renderer')->render($output);
  return $html_output;
}