@ -11,155 +11,13 @@
* @param $key * @param $key
*/ */
use Drupal\Component\Utility\Xss;
use Drupal\Component\Utility\Html; 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 * Lookup the user via a simple verification endpoint and verify the surname matches.
* *
* @param $values * Makes an HTTP GET to the configured URL (e.g., https://ill.libraryupei.ca/verify_eg_user.php)
* A drupal form_state['values] array * with a `userid` query parameter, and compares the returned `family_name`.
*
* @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,
]);
}
/**
* Authenticate against Evergreen and return an auth token.
*
* @param string $base_url
* The base Evergreen URL.
* @param string $username
* The Evergreen staff username.
* @param string $password
* The Evergreen staff password.
*
* @return string|null
* The auth token, or NULL on failure.
*/
function upei_roblib_ill_evergreen_login($base_url, $username, $password) {
$gateway_url = rtrim($base_url, '/') . '/osrf-gateway-v1';
$client = \Drupal::httpClient();
// Step 1: Get the seed/nonce for the username.
$seed_response = $client->get($gateway_url, [
'timeout' => 10,
'query' => [
'service' => 'open-ils.auth',
'method' => 'open-ils.auth.authenticate.init',
'param' => '"' . $username . '"',
],
]);
$seed_data = json_decode((string) $seed_response->getBody(), TRUE);
$seed = $seed_data['payload'][0] ?? NULL;
if (empty($seed)) {
\Drupal::logger('upei_roblib_ill')->error('Evergreen auth init failed: no seed returned.');
return NULL;
}
// Step 2: Authenticate with the hashed password.
$hashed_password = md5($seed . md5($password));
$auth_response = $client->get($gateway_url, [
'timeout' => 10,
'query' => [
'service' => 'open-ils.auth',
'method' => 'open-ils.auth.authenticate.complete',
'param' => json_encode([
'username' => $username,
'password' => $hashed_password,
'type' => 'staff',
]),
],
]);
$auth_data = json_decode((string) $auth_response->getBody(), TRUE);
$auth_result = $auth_data['payload'][0] ?? NULL;
if (empty($auth_result) || ($auth_result['ilsevent'] ?? -1) != 0) {
$text_code = $auth_result['textcode'] ?? 'unknown';
\Drupal::logger('upei_roblib_ill')->error('Evergreen auth failed: @code', [
'@code' => $text_code,
]);
return NULL;
}
return $auth_result['payload']['authtoken'] ?? NULL;
}
/**
* Lookup the user in Evergreen via the REST API and verify the surname matches.
*
* Authenticates with Evergreen using staff credentials, then retrieves the
* patron by user ID and compares the family_name field against the provided
* surname.
* *
* @param string $user_id * @param string $user_id
* The Evergreen user ID. * The Evergreen user ID.
@ -176,46 +34,31 @@ function upei_roblib_ill_authenticate($user_id, $surname): bool
} }
$config = \Drupal::config('upei_roblib_ill.settings'); $config = \Drupal::config('upei_roblib_ill.settings');
// Use the configured URL, falling back to the custom one if not set accurately.
$evergreen_api_url = $config->get('evergreen_api_url'); $evergreen_api_url = $config->get('evergreen_api_url');
$eg_username = $config->get('evergreen_username'); if (empty($evergreen_api_url)) {
$eg_password = $config->get('evergreen_password'); $evergreen_api_url = 'https://ill.libraryupei.ca/verify_eg_user.php';
if (empty($evergreen_api_url) || empty($eg_username) || empty($eg_password)) {
\Drupal::logger('upei_roblib_ill')->error('Evergreen API URL or credentials are not configured.');
return FALSE;
} }
try { try {
// Authenticate to get an auth token. $response = \Drupal::httpClient()->get($evergreen_api_url, [
$auth_token = upei_roblib_ill_evergreen_login($evergreen_api_url, $eg_username, $eg_password);
if (empty($auth_token)) {
return FALSE;
}
// Retrieve the patron by user ID using the auth token.
$gateway_url = rtrim($evergreen_api_url, '/') . '/osrf-gateway-v1';
$response = \Drupal::httpClient()->get($gateway_url, [
'timeout' => 10, 'timeout' => 10,
'query' => [ 'query' => [
'service' => 'open-ils.actor', 'userid' => $user_id,
'method' => 'open-ils.actor.user.retrieve',
'param' => ['"' . $auth_token . '"', '"' . $user_id . '"'],
], ],
]); ]);
$data = json_decode((string) $response->getBody(), TRUE); $data = json_decode((string)$response->getBody(), TRUE);
$patron = $data['payload'][0] ?? NULL; if (!empty($data['error'])) {
if (empty($patron) || isset($patron['ilsevent'])) { \Drupal::logger('upei_roblib_ill')->warning('Evergreen REST API returned error for user ID @user_id: @error', [
$evt = $patron['textcode'] ?? 'no data';
\Drupal::logger('upei_roblib_ill')->warning('Evergreen REST API returned no patron for user ID @user_id: @evt', [
'@user_id' => $user_id, '@user_id' => $user_id,
'@evt' => $evt , '@error' => $data['error'],
]); ]);
return FALSE; return FALSE;
} }
$evergreen_surname = $patron ['family_name'] ?? ''; $evergreen_surname = $data ['family_name'] ?? '';
// Case-insensitive comparison of the Evergreen surname and provided surname. // Case-insensitive comparison of the Evergreen surname and provided surname.
if (strcasecmp(trim($evergreen_surname), trim($surname)) === 0) { if (strcasecmp(trim($evergreen_surname), trim($surname)) === 0) {
@ -283,33 +126,66 @@ function upei_roblib_ill_get_doi_from_id()
} }
/** /**
* Populates the requestInfo portion of a Relais request * Removes empty elements and drupal specific elements from an array
* *
* @param array $values * @param $values
* an array containing a 'Genre' element. * A drupal form_state['values] array
* *
* @return array * @return array
* The requestInfo portion of a Relais request * An array where the keys in the array that have empty values are removed and
* drupal specific elements are removed.
*/ */
function upei_roblib_ill_request_info_array($values, $not es) function upei_roblib_ill_clean_array($valu es)
{ {
$requestInfo = []; $arr = array_filter($values);
$genre = $values['Genre']; if (isset($arr['ISSN'])) {
$requestInfo['DateSubmitted'] = date('Y-m-d H:i:s'); $arr['ISSN'] = [$arr['ISSN']];
$requestInfo['Notes'] = $notes; }
if ($genre == 'book') { if (isset($arr['ISBN'])) {
$requestInfo['ServiceType'] = 'L'; $arr['ISBN'] = [$arr['ISBN']];
$requestInfo['ServiceLabel'] = "R"; }
//$requestInfo['RequestSource'] = "C"; // 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']);
} }
else { if (isset($arr['Genre']) & & $arr['Genre'] == 'book' & & isset($arr['ArticleAuthor'])) {
$requestInfo['ServiceType'] = 'X'; // We want Author
$requestInfo['ServiceLabel'] = "R"; unset($arr['ArticleAuthor']);
//$requestInfo['RequestSource'] = "C"; }
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'];
} }
return $requestInfo; 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_check_arr_item(& $value, $key) {
if (is_array($value)) {
array_walk($value, 'upei_roblib_ill_check_arr_item');
}
//else {
// $value = Xss::filter($value);
//}
}
/** /**
* Creates a summary Table based on the biblio information in the form_state * Creates a summary Table based on the biblio information in the form_state
* array for display * array for display
@ -320,7 +196,7 @@ function upei_roblib_ill_request_info_array($values, $notes)
*/ */
function upei_roblib_format_biblio_info($form_state) function upei_roblib_format_biblio_info($form_state)
{ {
$values = $form_state->getValues(); $values = $form_state->getValues();
$data = upei_roblib_ill_clean_array($values); $data = upei_roblib_ill_clean_array($values);
$rows = []; $rows = [];
foreach ($data as $key => $value) { foreach ($data as $key => $value) {
@ -337,4 +213,4 @@ function upei_roblib_format_biblio_info($form_state)
]; ];
$html_output = \Drupal::service('renderer')->render($output); $html_output = \Drupal::service('renderer')->render($output);
return $html_output; return $html_output;
} }
