diff --git a/config/vufind/SierraRest.ini b/config/vufind/SierraRest.ini
new file mode 100644
index 0000000000000000000000000000000000000000..cd98c2e9f3bd9a70d55c2a124e82719f77e73cd5
--- /dev/null
+++ b/config/vufind/SierraRest.ini
@@ -0,0 +1,87 @@
+[Catalog]
+; An optional catalog id that is used in the translation string when translating
+; location names and opac messages. E.g. setting the id to "sierra" would make the
+; translation key for location code h01a "location_sierra_h01a" while leaving it
+; commented out would use "location_h01a". Translation is optional, and if a
+; translation for the location code cannot be found, the location name from Sierra
+; is used.
+;id = "sierra"
+; URL of the Sierra API without the version (such as /v3)
+host = "https://sandbox.iii.com/iii/sierra-api"
+; Sierra API client key
+client_key = "something"
+; Sierra API client secret
+client_secret = "very_secret"
+; Timeout for HTTP requests
+http_timeout = 30
+; Redirect URL entered in Sierra for the patron-specific authentication (does not
+; need to be a properly working url since the login process is handled completely in
+; the driver without user interaction)
+redirect_uri = "http://localhost/vufind/MyResearch/SierraAuth"
+
+; This section is used to define library codes and named values which are used by the
+; system to indicate the location at which a hold is to be collected. Sierra REST API
+; does not currently support retrieval of pickup locations, so filling this section
+; is mandatory for holds to work.
+[pickUpLocations]
+m01 = "Main Library"
+m02 = "Branch Library"
+
+; This section controls hold behavior; note that you must also ensure that Holds are
+; enabled in the [Catalog] section of config.ini in order to take advantage of these
+; settings.
+[Holds]
+; If a colon separated list of item statuses is provided here, only matching items
+; will show hold links. Skip this setting to allow all statuses.
+; Note that VuFind-style statuses are used here.
+;valid_hold_statuses = 'On Shelf:Charged'
+
+; HMACKeys - A list of hold form element names that will be analyzed for consistency
+; during hold form processing. Most users should not need to change this setting.
+HMACKeys = item_id:holdtype:level
+
+; defaultRequiredDate - A colon-separated list used to set the default "not required
+; after" date for holds in the format days:months:years
+; e.g. 0:1:0 will set a "not required after" date of 1 month from the current date
+defaultRequiredDate = 0:1:0
+
+; extraHoldFields - A colon-separated list used to display extra visible fields in the
+; place holds form. Supported values are "requiredByDate" and "pickUpLocation"
+extraHoldFields = requiredByDate:pickUpLocation
+
+; A Pick Up Location Code used to pre-select the pick up location drop down list and
+; provide a default option if others are not available. Must be one of the following:
+; 1) empty string to indicate that the first location is default (default setting)
+; 2) "user-selected" to indicate that the user always has to choose the location
+; 3) a value within the Location IDs returned by getPickUpLocations()
+defaultPickUpLocation = ""
+
+; By default item holds are enabled. Uncomment this setting to disable item holds.
+;enableItemHolds = false
+
+; This setting specifies which item codes disable item level holds
+item_hold_excluded_item_codes = e
+
+; This setting specifies which bib levels allow title level holds
+title_hold_bib_levels = a:b:m:d
+
+; By default a title hold can be placed even when there are no items. Uncomment this
+; to prevent holds if no items exist. If request groups are enabled, item existence
+; is checked only in the selected request group.
+;checkItemsExist = true
+
+; This section allows modification of the default mapping from item status codes to
+; VuFind item statuses
+[ItemStatusMappings]
+;d = "In Processing"
+
+; Uncomment the following lines to enable password (PIN) change
+;[changePassword]
+; PIN change parameters. The default limits are taken from the interface documentation.
+;minLength = 4
+;maxLength = 4
+; See the password_pattern/password_hint settings in the [Authentication] section
+; of config.ini for notes on these settings. When set here, these will override the
+; config.ini defaults when Voyager is used for authentication.
+;pattern = "numeric"
+;hint = "Your optional custom hint can go here."
diff --git a/config/vufind/config.ini b/config/vufind/config.ini
index 0afdc2c2e21badebf653dc736669bab981cc8006..004ddd7609394984282fa6fdce98bb3899d59d00 100644
--- a/config/vufind/config.ini
+++ b/config/vufind/config.ini
@@ -195,6 +195,7 @@ session_name = VUFIND_SESSION
; - Polaris
; - Sample (fake ILS driver returning bare-minimum data)
; - Sierra (basic database access only)
+; - SierraRest (more features via API)
; - Symphony (uses native SirsiDynix APIs)
; - Unicorn (also applies to Symphony; requires installation of connector found at:
; http://code.google.com/p/vufind-unicorn/)
diff --git a/module/VuFind/config/module.config.php b/module/VuFind/config/module.config.php
index 3391b5d612994655c09cca6ef9a14d9f7c26c2ef..77cebd0da92c901d4e3d4eb2235250e648836265 100644
--- a/module/VuFind/config/module.config.php
+++ b/module/VuFind/config/module.config.php
@@ -468,6 +468,7 @@ $config = [
'noils' => 'VuFind\ILS\Driver\Factory::getNoILS',
'paia' => 'VuFind\ILS\Driver\Factory::getPAIA',
'kohailsdi' => 'VuFind\ILS\Driver\Factory::getKohaILSDI',
+ 'sierrarest' => 'VuFind\ILS\Driver\Factory::getSierraRest',
'symphony' => 'VuFind\ILS\Driver\Factory::getSymphony',
'unicorn' => 'VuFind\ILS\Driver\Factory::getUnicorn',
'voyager' => 'VuFind\ILS\Driver\Factory::getVoyager',
diff --git a/module/VuFind/src/VuFind/ILS/Driver/Factory.php b/module/VuFind/src/VuFind/ILS/Driver/Factory.php
index fbc4bde0ac8023372a5e10b7d75364a78a5b4d2f..a8c97ee0282d0bf945cc195cacb5c245a3d7ce81 100644
--- a/module/VuFind/src/VuFind/ILS/Driver/Factory.php
+++ b/module/VuFind/src/VuFind/ILS/Driver/Factory.php
@@ -200,6 +200,30 @@ class Factory
return $koha;
}
+ /**
+ * Factory for Sierra REST driver.
+ *
+ * @param ServiceManager $sm Service manager.
+ *
+ * @return SierraRest
+ */
+ public static function getSierraRest(ServiceManager $sm)
+ {
+ $sessionFactory = function ($namespace) use ($sm) {
+ $manager = $sm->getServiceLocator()->get('VuFind\SessionManager');
+ return new \Zend\Session\Container("SierraRest_$namespace", $manager);
+ };
+
+ $driver = new SierraRest(
+ $sm->getServiceLocator()->get('VuFind\DateConverter'),
+ $sessionFactory
+ );
+ $driver->setCacheStorage(
+ $sm->getServiceLocator()->get('VuFind\CacheManager')->getCache('object')
+ );
+ return $driver;
+ }
+
/**
* Factory for Symphony driver.
*
diff --git a/module/VuFind/src/VuFind/ILS/Driver/SierraRest.php b/module/VuFind/src/VuFind/ILS/Driver/SierraRest.php
new file mode 100644
index 0000000000000000000000000000000000000000..cd9c9fcc7fb97041361cf27664cf3342c677ee35
--- /dev/null
+++ b/module/VuFind/src/VuFind/ILS/Driver/SierraRest.php
@@ -0,0 +1,1786 @@
+<?php
+/**
+ * III Sierra REST API driver
+ *
+ * PHP version 5
+ *
+ * Copyright (C) The National Library of Finland 2016-2017.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ *
+ * @category VuFind
+ * @package ILS_Drivers
+ * @author Ere Maijala <ere.maijala@helsinki.fi>
+ * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link https://vufind.org/wiki/development:plugins:ils_drivers Wiki
+ */
+namespace VuFind\ILS\Driver;
+use VuFind\Exception\ILS as ILSException;
+use VuFind\I18n\Translator\TranslatorAwareInterface;
+use VuFindHttp\HttpServiceAwareInterface;
+use Zend\Log\LoggerAwareInterface;
+use VuFind\Exception\VuFind\Exception;
+
+/**
+ * III Sierra REST API driver
+ *
+ * @category VuFind
+ * @package ILS_Drivers
+ * @author Ere Maijala <ere.maijala@helsinki.fi>
+ * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link https://vufind.org/wiki/development:plugins:ils_drivers Wiki
+ */
+class SierraRest extends AbstractBase implements TranslatorAwareInterface,
+ HttpServiceAwareInterface, LoggerAwareInterface
+{
+ use \VuFind\Log\LoggerAwareTrait {
+ logError as error;
+ }
+ use \VuFindHttp\HttpServiceAwareTrait;
+ use \VuFind\I18n\Translator\TranslatorAwareTrait;
+
+ /**
+ * Driver configuration
+ *
+ * @var array
+ */
+ protected $config;
+
+ /**
+ * Date converter
+ *
+ * @var \VuFind\Date\Converter
+ */
+ protected $dateConverter;
+
+ /**
+ * Factory function for constructing the SessionContainer.
+ *
+ * @var Callable
+ */
+ protected $sessionFactory;
+
+ /**
+ * Session cache
+ *
+ * @var \Zend\Session\Container
+ */
+ protected $sessionCache;
+
+ /**
+ * Whether item holds are enabled
+ *
+ * @var bool
+ */
+ protected $itemHoldsEnabled;
+
+ /**
+ * Item codes for which item level hold is not allowed
+ *
+ * @var array
+ */
+ protected $itemHoldExcludedItemCodes;
+
+ /**
+ * Bib levels for which title level hold is allowed
+ *
+ * @var array
+ */
+ protected $titleHoldBibLevels;
+
+ /**
+ * Default pickup location
+ *
+ * @var string
+ */
+ protected $defaultPickUpLocation;
+
+ /**
+ * Whether to check that items exist when placing a hold
+ *
+ * @var bool
+ */
+ protected $checkItemsExist;
+
+ /**
+ * Item statuses that allow placing a hold
+ *
+ * @var unknown
+ */
+ protected $validHoldStatuses;
+
+ /**
+ * Mappings from item status codes to VuFind strings
+ *
+ * @var array
+ */
+ protected $itemStatusMappings = [
+ '!' => 'On Holdshelf',
+ 't' => 'In Transit',
+ 'o' => 'On Reference Desk',
+ 'k' => 'In Repair',
+ 'm' => 'Missing',
+ 'n' => 'Long Overdue',
+ '$' => 'Lost--Library Applied',
+ 'p' => '',
+ 'z' => 'Claims Returned',
+ 's' => 'On Search',
+ 'd' => 'In Process'
+ ];
+
+ /**
+ * Constructor
+ *
+ * @param \VuFind\Date\Converter $dateConverter Date converter object
+ * @param Callable $sessionFactory Factory function returning
+ * SessionContainer object
+ */
+ public function __construct(\VuFind\Date\Converter $dateConverter,
+ $sessionFactory
+ ) {
+ $this->dateConverter = $dateConverter;
+ $this->sessionFactory = $sessionFactory;
+ }
+
+ /**
+ * Set configuration.
+ *
+ * Set the configuration for the driver.
+ *
+ * @param array $config Configuration array (usually loaded from a VuFind .ini
+ * file whose name corresponds with the driver class name).
+ *
+ * @return void
+ */
+ public function setConfig($config)
+ {
+ $this->config = $config;
+ }
+
+ /**
+ * Initialize the driver.
+ *
+ * Validate configuration and perform all resource-intensive tasks needed to
+ * make the driver active.
+ *
+ * @throws ILSException
+ * @return void
+ */
+ public function init()
+ {
+ // Validate config
+ $required = ['host', 'client_key', 'client_secret'];
+ foreach ($required as $current) {
+ if (!isset($this->config['Catalog'][$current])) {
+ throw new ILSException("Missing Catalog/{$current} config setting.");
+ }
+ }
+
+ $this->validHoldStatuses
+ = !empty($this->config['Holds']['valid_hold_statuses'])
+ ? explode(':', $this->config['Holds']['valid_hold_statuses'])
+ : [];
+
+ $this->itemHoldsEnabled
+ = isset($this->config['Holds']['enableItemHolds'])
+ ? $this->config['Holds']['enableItemHolds'] : true;
+
+ $this->itemHoldExcludedItemCodes
+ = !empty($this->config['Holds']['item_hold_excluded_item_codes'])
+ ? explode(':', $this->config['Holds']['item_hold_excluded_item_codes'])
+ : [];
+
+ $this->titleHoldBibLevels
+ = !empty($this->config['Holds']['title_hold_bib_levels'])
+ ? explode(':', $this->config['Holds']['title_hold_bib_levels'])
+ : ['a', 'b', 'm', 'd'];
+
+ $this->defaultPickUpLocation
+ = isset($this->config['Holds']['defaultPickUpLocation'])
+ ? $this->config['Holds']['defaultPickUpLocation']
+ : '';
+ if ($this->defaultPickUpLocation === 'user-selected') {
+ $this->defaultPickUpLocation = false;
+ }
+
+ if (!empty($this->config['ItemStatusMappings'])) {
+ $this->itemStatusMappings = array_merge(
+ $this->itemStatusMappings, $this->config['ItemStatusMappings']
+ );
+ }
+
+ // Init session cache for session-specific data
+ $namespace = md5(
+ $this->config['Catalog']['host'] . '|'
+ . $this->config['Catalog']['client_key']
+ );
+ $factory = $this->sessionFactory;
+ $this->sessionCache = $factory($namespace);
+ }
+
+ /**
+ * Get Status
+ *
+ * This is responsible for retrieving the status information of a certain
+ * record.
+ *
+ * @param string $id The record id to retrieve the holdings for
+ *
+ * @return array An associative array with the following keys:
+ * id, availability (boolean), status, location, reserve, callnumber.
+ */
+ public function getStatus($id)
+ {
+ return $this->getItemStatusesForBib($id);
+ }
+
+ /**
+ * Get Statuses
+ *
+ * This is responsible for retrieving the status information for a
+ * collection of records.
+ *
+ * @param array $ids The array of record ids to retrieve the status for
+ *
+ * @return mixed An array of getStatus() return values on success.
+ */
+ public function getStatuses($ids)
+ {
+ $items = [];
+ foreach ($ids as $id) {
+ $items[] = $this->getItemStatusesForBib($id);
+ }
+ return $items;
+ }
+
+ /**
+ * Get Holding
+ *
+ * This is responsible for retrieving the holding information of a certain
+ * record.
+ *
+ * @param string $id The record id to retrieve the holdings for
+ * @param array $patron Patron data
+ *
+ * @return mixed On success, an associative array with the following keys:
+ * id, availability (boolean), status, location, reserve, callnumber, duedate,
+ * number, barcode.
+ *
+ * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+ */
+ public function getHolding($id, array $patron = null)
+ {
+ return $this->getItemStatusesForBib($id, true);
+ }
+
+ /**
+ * Get Purchase History
+ *
+ * This is responsible for retrieving the acquisitions history data for the
+ * specific record (usually recently received issues of a serial).
+ *
+ * @param string $id The record id to retrieve the info for
+ *
+ * @return mixed An array with the acquisitions data on success.
+ *
+ * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+ */
+ public function getPurchaseHistory($id)
+ {
+ return [];
+ }
+
+ /**
+ * Get New Items
+ *
+ * Retrieve the IDs of items recently added to the catalog.
+ *
+ * @param int $page Page number of results to retrieve (counting starts at 1)
+ * @param int $limit The size of each page of results to retrieve
+ * @param int $daysOld The maximum age of records to retrieve in days (max. 30)
+ * @param int $fundId optional fund ID to use for limiting results (use a value
+ * returned by getFunds, or exclude for no limit); note that "fund" may be a
+ * misnomer - if funds are not an appropriate way to limit your new item
+ * results, you can return a different set of values from getFunds. The
+ * important thing is that this parameter supports an ID returned by getFunds,
+ * whatever that may mean.
+ *
+ * @return array Associative array with 'count' and 'results' keys
+ *
+ * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+ */
+ public function getNewItems($page, $limit, $daysOld, $fundId = null)
+ {
+ return ['count' => 0, 'results' => []];
+ }
+
+ /**
+ * Find Reserves
+ *
+ * Obtain information on course reserves.
+ *
+ * @param string $course ID from getCourses (empty string to match all)
+ * @param string $inst ID from getInstructors (empty string to match all)
+ * @param string $dept ID from getDepartments (empty string to match all)
+ *
+ * @return mixed An array of associative arrays representing reserve items.
+ *
+ * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+ */
+ public function findReserves($course, $inst, $dept)
+ {
+ return [];
+ }
+
+ /**
+ * Patron Login
+ *
+ * This is responsible for authenticating a patron against the catalog.
+ *
+ * @param string $username The patron username
+ * @param string $password The patron password
+ *
+ * @return mixed Associative array of patron info on successful login,
+ * null on unsuccessful login.
+ *
+ * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+ */
+ public function patronLogin($username, $password)
+ {
+ // We could get the access token and use the token info API, but since we
+ // already know the barcode, we can avoid one API call and get the patron
+ // information right away (makeRequest renews the access token as necessary
+ // which verifies the PIN code).
+
+ $result = $this->makeRequest(
+ ['v3', 'info', 'token'],
+ [],
+ 'GET',
+ ['cat_username' => $username, 'cat_password' => $password]
+ );
+ if (null === $result) {
+ return null;
+ }
+ if (empty($result['patronId'])) {
+ throw new ILSException('No patronId in token response');
+ }
+ $patronId = $result['patronId'];
+
+ $result = $this->makeRequest(
+ ['v3', 'patrons', $patronId],
+ [],
+ 'GET',
+ ['cat_username' => $username, 'cat_password' => $password]
+ );
+
+ if (null === $result || !empty($result['code'])) {
+ return null;
+ }
+ $firstname = '';
+ $lastname = '';
+ if (!empty($result['names'])) {
+ $name = $result['names'][0];
+ list($lastname, $firstname) = explode(', ', $name, 2);
+ }
+ return [
+ 'id' => $result['id'],
+ 'firstname' => $firstname,
+ 'lastname' => $lastname,
+ 'cat_username' => $username,
+ 'cat_password' => $password,
+ 'email' => '',
+ 'major' => null,
+ 'college' => null
+ ];
+ }
+
+ /**
+ * Check whether the patron is blocked from placing requests (holds/ILL/SRR).
+ *
+ * @param array $patron Patron data from patronLogin().
+ *
+ * @return mixed A boolean false if no blocks are in place and an array
+ * of block reasons if blocks are in place
+ */
+ public function getRequestBlocks($patron)
+ {
+ return $this->getPatronBlocks($patron);
+ }
+
+ /**
+ * Check whether the patron has any blocks on their account.
+ *
+ * @param array $patron Patron data from patronLogin().
+ *
+ * @return mixed A boolean false if no blocks are in place and an array
+ * of block reasons if blocks are in place
+ */
+ public function getAccountBlocks($patron)
+ {
+ return $this->getPatronBlocks($patron);
+ }
+
+ /**
+ * Get Patron Profile
+ *
+ * This is responsible for retrieving the profile for a specific patron.
+ *
+ * @param array $patron The patron array
+ *
+ * @throws ILSException
+ * @return array Array of the patron's profile data on success.
+ */
+ public function getMyProfile($patron)
+ {
+ $result = $this->makeRequest(
+ ['v3', 'patrons', $patron['id']],
+ [
+ 'fields' => 'names,emails,phones,addresses,expirationDate'
+ ],
+ 'GET',
+ $patron
+ );
+
+ if (empty($result)) {
+ return [];
+ }
+ $firstname = '';
+ $lastname = '';
+ $address = '';
+ $zip = '';
+ $city = '';
+ if (!empty($result['names'])) {
+ $name = $result['names'][0];
+ list($lastname, $firstname) = explode(', ', $name, 2);
+ }
+ if (!empty($result['addresses'][0]['lines'][1])) {
+ $address = $result['addresses'][0]['lines'][0];
+ list($zip, $city) = explode(' ', $result['addresses'][0]['lines'][1], 2);
+ }
+ $expirationDate = !empty($result['expirationDate'])
+ ? $this->dateConverter->convertToDisplayDate(
+ 'Y-m-d', $result['expirationDate']
+ ) : '';
+ return [
+ 'firstname' => $firstname,
+ 'lastname' => $lastname,
+ 'phone' => !empty($result['phones'][0]['number'])
+ ? $result['phones'][0]['number'] : '',
+ 'email' => !empty($result['emails']) ? $result['emails'][0] : '',
+ 'address1' => $address,
+ 'zip' => $zip,
+ 'city' => $city,
+ 'expiration_date' => $expirationDate
+ ];
+ }
+
+ /**
+ * Get Patron Transactions
+ *
+ * This is responsible for retrieving all transactions (i.e. checked out items)
+ * by a specific patron.
+ *
+ * @param array $patron The patron array from patronLogin
+ *
+ * @throws DateException
+ * @throws ILSException
+ * @return array Array of the patron's transactions on success.
+ */
+ public function getMyTransactions($patron)
+ {
+ $result = $this->makeRequest(
+ ['v3', 'patrons', $patron['id'], 'checkouts'],
+ [
+ 'limit' => 10000,
+ 'offset' => 0,
+ 'fields' => 'item,dueDate,numberOfRenewals,outDate,recallDate'
+ . ',callNumber'
+ ],
+ 'GET',
+ $patron
+ );
+ if (empty($result['entries'])) {
+ return [];
+ }
+ $transactions = [];
+ foreach ($result['entries'] as $entry) {
+ $transaction = [
+ 'id' => '',
+ 'checkout_id' => $this->extractId($entry['id']),
+ 'item_id' => $this->extractId($entry['item']),
+ 'duedate' => $this->dateConverter->convertToDisplayDate(
+ 'Y-m-d', $entry['dueDate']
+ ),
+ 'renew' => $entry['numberOfRenewals'],
+ 'renewable' => true // assumption, who knows?
+ ];
+ if (!empty($entry['recallDate'])) {
+ $date = $this->dateConverter->convertToDisplayDate(
+ 'Y-m-d', $entry['recallDate']
+ );
+ $transaction['message']
+ = $this->translate('item_recalled', ['%%date%%' => $date]);
+ }
+ // Fetch item information
+ $item = $this->makeRequest(
+ ['v3', 'items', $transaction['item_id']],
+ ['fields' => 'bibIds,varFields'],
+ 'GET',
+ $patron
+ );
+ $transaction['volume'] = $this->extractVolume($item);
+ if (!empty($item['bibIds'])) {
+ $transaction['id'] = $item['bibIds'][0];
+
+ // Fetch bib information
+ $bib = $this->getBibRecord(
+ $transaction['id'], 'title,publishYear', $patron
+ );
+ if (!empty($bib['title'])) {
+ $transaction['title'] = $bib['title'];
+ }
+ if (!empty($bib['publishYear'])) {
+ $transaction['publication_year'] = $bib['publishYear'];
+ }
+ }
+ $transactions[] = $transaction;
+ }
+
+ return $transactions;
+ }
+
+ /**
+ * Get Renew Details
+ *
+ * @param array $checkOutDetails An array of item data
+ *
+ * @return string Data for use in a form field
+ */
+ public function getRenewDetails($checkOutDetails)
+ {
+ return $checkOutDetails['checkout_id'] . '|' . $checkOutDetails['item_id'];
+ }
+
+ /**
+ * Renew My Items
+ *
+ * Function for attempting to renew a patron's items. The data in
+ * $renewDetails['details'] is determined by getRenewDetails().
+ *
+ * @param array $renewDetails An array of data required for renewing items
+ * including the Patron ID and an array of renewal IDS
+ *
+ * @return array An array of renewal information keyed by item ID
+ */
+ public function renewMyItems($renewDetails)
+ {
+ $patron = $renewDetails['patron'];
+ $finalResult = ['details' => []];
+
+ foreach ($renewDetails['details'] as $details) {
+ list($checkoutId, $itemId) = explode('|', $details);
+ $result = $this->makeRequest(
+ ['v3', 'patrons', 'checkouts', $checkoutId, 'renewal'], [], 'POST',
+ $patron
+ );
+ if (!empty($result['code'])) {
+ $msg = $this->formatErrorMessage($result['description']);
+ $finalResult['details'][$itemId] = [
+ 'item_id' => $itemId,
+ 'success' => false,
+ 'sysMessage' => $msg
+ ];
+ } else {
+ $newDate = $this->dateConverter->convertToDisplayDate(
+ 'Y-m-d', $result['dueDate']
+ );
+ $finalResult['details'][$itemId] = [
+ 'item_id' => $itemId,
+ 'success' => true,
+ 'new_date' => $newDate
+ ];
+ }
+ }
+ return $finalResult;
+ }
+
+ /**
+ * Get Patron Holds
+ *
+ * This is responsible for retrieving all holds by a specific patron.
+ *
+ * @param array $patron The patron array from patronLogin
+ *
+ * @throws DateException
+ * @throws ILSException
+ * @return array Array of the patron's holds on success.
+ * @todo Support for handling frozen and pickup location change
+ */
+ public function getMyHolds($patron)
+ {
+ $result = $this->makeRequest(
+ ['v3', 'patrons', $patron['id'], 'holds'],
+ [
+ 'limit' => 10000,
+ 'fields' => 'id,record,frozen,placed,location,pickupLocation'
+ . ',status,recordType,priority,priorityQueueLength'
+ ],
+ 'GET',
+ $patron
+ );
+ if (!isset($result['entries'])) {
+ return [];
+ }
+ $holds = [];
+ foreach ($result['entries'] as $entry) {
+ $bibId = null;
+ $itemId = null;
+ $title = '';
+ $volume = '';
+ $publicationYear = '';
+ if ($entry['recordType'] == 'i') {
+ $itemId = $this->extractId($entry['record']);
+ // Fetch bib ID from item
+ $item = $this->makeRequest(
+ ['v3', 'items', $itemId],
+ ['fields' => 'bibIds,varFields'],
+ 'GET',
+ $patron
+ );
+ if (!empty($item['bibIds'])) {
+ $bibId = $item['bibIds'][0];
+ }
+ $volume = $this->extractVolume($item);
+ } elseif ($entry['recordType'] == 'b') {
+ $bibId = $this->extractId($entry['record']);
+ }
+ if (!empty($bibId)) {
+ // Fetch bib information
+ $bib = $this->getBibRecord($bibId, 'title,publishYear', $patron);
+ $title = isset($bib['title']) ? $bib['title'] : '';
+ $publicationYear = isset($bib['publishYear']) ? $bib['publishYear']
+ : '';
+ }
+ $available = in_array($entry['status']['code'], ['b', 'j', 'i']);
+ if ($entry['priority'] >= $entry['priorityQueueLength']) {
+ // This can happen, no idea why
+ $position = $entry['priorityQueueLength'] . ' / '
+ . $entry['priorityQueueLength'];
+ } else {
+ $position = ($entry['priority'] + 1) . ' / '
+ . $entry['priorityQueueLength'];
+ }
+ $holds[] = [
+ 'id' => $bibId,
+ 'requestId' => $this->extractId($entry['id']),
+ 'item_id' => $itemId ? $itemId : $this->extractId($entry['id']),
+ 'location' => $entry['pickupLocation']['name'],
+ 'create' => $this->dateConverter->convertToDisplayDate(
+ 'Y-m-d', $entry['placed']
+ ),
+ 'position' => $position,
+ 'available' => $available,
+ 'in_transit' => $entry['status']['code'] == 't',
+ 'volume' => $volume,
+ 'publication_year' => $publicationYear,
+ 'title' => $title,
+ 'frozen' => !empty($entry['frozen'])
+ ];
+ }
+ return $holds;
+ }
+
+ /**
+ * Get Cancel Hold Details
+ *
+ * Get required data for canceling a hold. This value is used by relayed to the
+ * cancelHolds function when the user attempts to cancel a hold.
+ *
+ * @param array $holdDetails An array of hold data
+ *
+ * @return string Data for use in a form field
+ */
+ public function getCancelHoldDetails($holdDetails)
+ {
+ return $holdDetails['available'] || $holdDetails['in_transit'] ? ''
+ : $holdDetails['item_id'];
+ }
+
+ /**
+ * Cancel Holds
+ *
+ * Attempts to Cancel a hold. The data in $cancelDetails['details'] is determined
+ * by getCancelHoldDetails().
+ *
+ * @param array $cancelDetails An array of item and patron data
+ *
+ * @return array An array of data on each request including
+ * whether or not it was successful and a system message (if available)
+ */
+ public function cancelHolds($cancelDetails)
+ {
+ $details = $cancelDetails['details'];
+ $patron = $cancelDetails['patron'];
+ $count = 0;
+ $response = [];
+
+ foreach ($details as $holdId) {
+ $result = $this->makeRequest(
+ ['v3', 'patrons', 'holds', $holdId], [], 'DELETE', $patron
+ );
+
+ if (!empty($result['code'])) {
+ $msg = $this->formatErrorMessage($result['description']);
+ $response[$holdId] = [
+ 'item_id' => $holdId,
+ 'success' => false,
+ 'status' => 'hold_cancel_fail',
+ 'sysMessage' => $msg
+ ];
+ } else {
+ $response[$holdId] = [
+ 'item_id' => $holdId,
+ 'success' => true,
+ 'status' => 'hold_cancel_success'
+ ];
+ ++$count;
+ }
+ }
+ return ['count' => $count, 'items' => $response];
+ }
+
+ /**
+ * Get Pick Up Locations
+ *
+ * This is responsible for gettting a list of valid library locations for
+ * holds / recall retrieval
+ *
+ * @param array $patron Patron information returned by the patronLogin
+ * method.
+ * @param array $holdDetails Optional array, only passed in when getting a list
+ * in the context of placing a hold; contains most of the same values passed to
+ * placeHold, minus the patron data. May be used to limit the pickup options
+ * or may be ignored. The driver must not add new options to the return array
+ * based on this data or other areas of VuFind may behave incorrectly.
+ *
+ * @throws ILSException
+ * @return array An array of associative arrays with locationID and
+ * locationDisplay keys
+ *
+ * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+ */
+ public function getPickUpLocations($patron = false, $holdDetails = null)
+ {
+ if (!empty($this->config['pickUpLocations'])) {
+ $locations = [];
+ foreach ($this->config['pickUpLocations'] as $id => $location) {
+ $locations[] = [
+ 'locationID' => $id,
+ 'locationDisplay' => $this->translateLocation(
+ ['code' => $id, 'name' => $location]
+ )
+ ];
+ }
+ return $locations;
+ }
+
+ return [];
+ }
+
+ /**
+ * Get Default Pick Up Location
+ *
+ * Returns the default pick up location
+ *
+ * @param array $patron Patron information returned by the patronLogin
+ * method.
+ * @param array $holdDetails Optional array, only passed in when getting a list
+ * in the context of placing a hold; contains most of the same values passed to
+ * placeHold, minus the patron data. May be used to limit the pickup options
+ * or may be ignored.
+ *
+ * @return false|string The default pickup location for the patron or false
+ * if the user has to choose.
+ *
+ * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+ */
+ public function getDefaultPickUpLocation($patron = false, $holdDetails = null)
+ {
+ return $this->defaultPickUpLocation;
+ }
+
+ /**
+ * Check if request is valid
+ *
+ * This is responsible for determining if an item is requestable
+ *
+ * @param string $id The Bib ID
+ * @param array $data An Array of item data
+ * @param patron $patron An array of patron data
+ *
+ * @return bool True if request is valid, false if not
+ */
+ public function checkRequestIsValid($id, $data, $patron)
+ {
+ if ($this->getPatronBlocks($patron)) {
+ return false;
+ }
+ $level = isset($data['level']) ? $data['level'] : 'copy';
+ if ('title' == $data['level']) {
+ $bib = $this->getBibRecord($id, 'bibLevel', $patron);
+ if (!isset($bib['bibLevel']['code'])
+ || !in_array($bib['bibLevel']['code'], $this->titleHoldBibLevels)
+ ) {
+ return false;
+ }
+ }
+ return true;
+ }
+
+ /**
+ * Place Hold
+ *
+ * Attempts to place a hold or recall on a particular item and returns
+ * an array with result details or throws an exception on failure of support
+ * classes
+ *
+ * @param array $holdDetails An array of item and patron data
+ *
+ * @throws ILSException
+ * @return mixed An array of data on the request including
+ * whether or not it was successful and a system message (if available)
+ */
+ public function placeHold($holdDetails)
+ {
+ $patron = $holdDetails['patron'];
+ $level = isset($holdDetails['level']) && !empty($holdDetails['level'])
+ ? $holdDetails['level'] : 'copy';
+ $pickUpLocation = !empty($holdDetails['pickUpLocation'])
+ ? $holdDetails['pickUpLocation'] : $this->defaultPickUpLocation;
+ $itemId = isset($holdDetails['item_id']) ? $holdDetails['item_id'] : false;
+ $comment = isset($holdDetails['comment']) ? $holdDetails['comment'] : '';
+ $bibId = $holdDetails['id'];
+
+ // Convert last interest date from Display Format to Sierra's required format
+ try {
+ $lastInterestDate = $this->dateConverter->convertFromDisplayDate(
+ 'Y-m-d', $holdDetails['requiredBy']
+ );
+ } catch (DateException $e) {
+ // Hold Date is invalid
+ return $this->holdError('hold_date_invalid');
+ }
+
+ if ($level == 'copy' && empty($itemId)) {
+ throw new ILSException("Hold level is 'copy', but item ID is empty");
+ }
+
+ try {
+ $checkTime = $this->dateConverter->convertFromDisplayDate(
+ 'U', $holdDetails['requiredBy']
+ );
+ if (!is_numeric($checkTime)) {
+ throw new DateException('Result should be numeric');
+ }
+ } catch (DateException $e) {
+ throw new ILSException('Problem parsing required by date.');
+ }
+
+ if (time() > $checkTime) {
+ // Hold Date is in the past
+ return $this->holdError('hold_date_past');
+ }
+
+ // Make sure pickup location is valid
+ if (!$this->pickUpLocationIsValid($pickUpLocation, $patron, $holdDetails)) {
+ return $this->holdError('hold_invalid_pickup');
+ }
+
+ $request = [
+ 'recordType' => $level == 'copy' ? 'i' : 'b',
+ 'recordNumber' => (int)($level == 'copy' ? $itemId : $bibId),
+ 'pickupLocation' => $pickUpLocation,
+ 'neededBy' => $this->dateConverter->convertFromDisplayDate(
+ 'Y-m-d', $holdDetails['requiredBy']
+ )
+ ];
+
+ $result = $this->makeRequest(
+ ['v3', 'patrons', $patron['id'], 'holds', 'requests'],
+ json_encode($request),
+ 'POST',
+ $patron
+ );
+
+ if (!empty($result['code'])) {
+ return $this->holdError($result['description']);
+ }
+ return ['success' => true];
+ }
+
+ /**
+ * Get Patron Fines
+ *
+ * This is responsible for retrieving all fines by a specific patron.
+ *
+ * @param array $patron The patron array from patronLogin
+ *
+ * @throws DateException
+ * @throws ILSException
+ * @return array Array of the patron's fines on success.
+ */
+ public function getMyFines($patron)
+ {
+ $result = $this->makeRequest(
+ ['v3', 'patrons', $patron['id'], 'fines'],
+ [
+ 'fields' => 'item,assessedDate,description,chargeType,itemCharge'
+ . ',processingFee,billingFee,paidAmount'
+ ],
+ 'GET',
+ $patron
+ );
+
+ if (!isset($result['entries'])) {
+ return [];
+ }
+ $fines = [];
+ foreach ($result['entries'] as $entry) {
+ $amount = $entry['itemCharge'] + $entry['processingFee']
+ + $entry['billingFee'];
+ $balance = $amount - $entry['paidAmount'];
+ $description = '';
+ // Display charge type if it's not manual (code=1)
+ if (!empty($entry['chargeType'])
+ && $entry['chargeType']['code'] != '1'
+ ) {
+ $description = $entry['chargeType']['display'];
+ }
+ if (!empty($entry['description'])) {
+ if ($description) {
+ $description .= ' - ';
+ }
+ $description .= $entry['description'];
+ }
+ switch ($description) {
+ case 'Overdue Renewal':
+ $description = 'Overdue';
+ break;
+ }
+ $bibId = null;
+ $title = null;
+ if (!empty($entry['item'])) {
+ $itemId = $this->extractId($entry['item']);
+ // Fetch bib ID from item
+ $item = $this->makeRequest(
+ ['v3', 'items', $itemId],
+ ['fields' => 'bibIds'],
+ 'GET',
+ $patron
+ );
+ if (!empty($item['bibIds'])) {
+ $bibId = $item['bibIds'][0];
+ // Fetch bib information
+ $bib = $this->getBibRecord($bibId, 'title,publishYear', $patron);
+ $title = isset($bib['title']) ? $bib['title'] : '';
+ }
+ }
+
+ $fines[] = [
+ 'amount' => $amount * 100,
+ 'fine' => $description,
+ 'balance' => $balance * 100,
+ 'createdate' => $this->dateConverter->convertToDisplayDate(
+ 'Y-m-d', $entry['assessedDate']
+ ),
+ 'checkout' => '',
+ 'id' => $bibId,
+ 'title' => $title
+ ];
+ }
+ return $fines;
+ }
+
+ /**
+ * Change Password
+ *
+ * Attempts to change patron password (PIN code)
+ *
+ * @param array $details An array of patron id and old and new password:
+ *
+ * 'patron' The patron array from patronLogin
+ * 'oldPassword' Old password
+ * 'newPassword' New password
+ *
+ * @return array An array of data on the request including
+ * whether or not it was successful and a system message (if available)
+ */
+ public function changePassword($details)
+ {
+ // Force new login
+ $this->sessionCache->accessTokenPatron = '';
+ $patron = $this->patronLogin(
+ $details['patron']['cat_username'], $details['oldPassword']
+ );
+ if (null === $patron) {
+ return [
+ 'success' => false, 'status' => 'authentication_error_invalid'
+ ];
+ }
+
+ $newPIN = preg_replace('/[^\d]/', '', trim($details['newPassword']));
+ if (strlen($newPIN) != 4) {
+ return [
+ 'success' => false, 'status' => 'password_error_invalid'
+ ];
+ }
+
+ $request = ['pin' => $newPIN];
+
+ $result = $this->makeRequest(
+ ['v3', 'patrons', $patron['id']],
+ json_encode($request),
+ 'PUT',
+ $patron
+ );
+
+ if (isset($result['code']) && $result['code'] != 0) {
+ return [
+ 'success' => false,
+ 'status' => $this->formatErrorMessage($result['description'])
+ ];
+ }
+ return ['success' => true, 'status' => 'change_password_ok'];
+ }
+
+ /**
+ * Public Function which retrieves renew, hold and cancel settings from the
+ * driver ini file.
+ *
+ * @param string $function The name of the feature to be checked
+ * @param array $params Optional feature-specific parameters (array)
+ *
+ * @return array An array with key-value pairs.
+ *
+ * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+ */
+ public function getConfig($function, $params = null)
+ {
+ return isset($this->config[$function])
+ ? $this->config[$function] : false;
+ }
+
+ /**
+ * Helper method to determine whether or not a certain method can be
+ * called on this driver. Required method for any smart drivers.
+ *
+ * @param string $method The name of the called method.
+ * @param array $params Array of passed parameters
+ *
+ * @return bool True if the method can be called with the given parameters,
+ * false otherwise.
+ *
+ * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+ */
+ public function supportsMethod($method, $params)
+ {
+ // Special case: change password is only available if properly configured.
+ if ($method == 'changePassword') {
+ return isset($this->config['changePassword']);
+ }
+ return is_callable([$this, $method]);
+ }
+
+ /**
+ * Extract an ID from a URL (last number)
+ *
+ * @param string $url URL containing the ID
+ *
+ * @return string ID
+ */
+ protected function extractId($url)
+ {
+ $parts = explode('/', $url);
+ return end($parts);
+ }
+
+ /**
+ * Extract volume from item record's varFields
+ *
+ * @param array $item Item record from Sierra
+ *
+ * @return string
+ */
+ protected function extractVolume($item)
+ {
+ foreach ($item['varFields'] as $varField) {
+ if ($varField['fieldTag'] == 'v') {
+ return trim($varField['content']);
+ }
+ }
+ return '';
+ }
+
+ /**
+ * Make Request
+ *
+ * Makes a request to the Sierra REST API
+ *
+ * @param array $hierarchy Array of values to embed in the URL path of
+ * the request
+ * @param array $params A keyed array of query data
+ * @param string $method The http request method to use (Default is GET)
+ * @param array $patron Patron information, if available
+ *
+ * @throws ILSException
+ * @return mixed JSON response decoded to an associative array or null on
+ * authentication error
+ */
+ protected function makeRequest($hierarchy, $params = false, $method = 'GET',
+ $patron = false
+ ) {
+ // Clear current access token if it's not specific to the given patron
+ if ($patron
+ && $this->sessionCache->accessTokenPatron != $patron['cat_username']
+ ) {
+ $this->sessionCache->accessToken = null;
+ }
+
+ // Renew authentication token as necessary
+ if (null === $this->sessionCache->accessToken) {
+ if (!$this->renewAccessToken($patron)) {
+ return null;
+ }
+ }
+
+ // Set up the request
+ $apiUrl = $this->config['Catalog']['host'];
+
+ // Add hierarchy
+ foreach ($hierarchy as $value) {
+ $apiUrl .= '/' . urlencode($value);
+ }
+
+ // Create proxy request
+ $client = $this->createHttpClient($apiUrl);
+
+ // Add params
+ if ($method == 'GET') {
+ $client->setParameterGet($params);
+ } else {
+ if (is_string($params)) {
+ $client->getRequest()->setContent($params);
+ } else {
+ $client->setParameterPost($params);
+ }
+ }
+
+ // Set authorization header
+ $headers = $client->getRequest()->getHeaders();
+ $headers->addHeaderLine(
+ 'Authorization', "Bearer {$this->sessionCache->accessToken}"
+ );
+ if (is_string($params)) {
+ $headers->addHeaderLine('Content-Type', 'application/json');
+ }
+
+ $locale = $this->getTranslatorLocale();
+ if ($locale != 'en') {
+ $locale .= ', en;q=0.8';
+ }
+ $headers->addHeaderLine('Accept-Language', $locale);
+
+ // Send request and retrieve response
+ $startTime = microtime(true);
+ $response = $client->setMethod($method)->send();
+ // If we get a 401, we need to renew the access token and try again
+ if ($response->getStatusCode() == 401) {
+ if (!$this->renewAccessToken($patron)) {
+ return null;
+ }
+ $client->getRequest()->getHeaders()->addHeaderLine(
+ 'Authorization', "Bearer {$this->sessionCache->accessToken}"
+ );
+ $response = $client->send();
+ }
+ $result = $response->getBody();
+
+ $this->debug(
+ '[' . round(microtime(true) - $startTime, 4) . 's]'
+ . " $method request $apiUrl" . PHP_EOL . 'response: ' . PHP_EOL
+ . $result
+ );
+
+ // Handle errors as complete failures only if the API call didn't return
+ // valid JSON that the caller can handle
+ $decodedResult = json_decode($result, true);
+ if (!$response->isSuccess() && null === $decodedResult) {
+ $params = $method == 'GET'
+ ? $client->getRequest()->getQuery()->toString()
+ : $client->getRequest()->getPost()->toString();
+ $this->error(
+ "$method request for '$apiUrl' with params '$params' and contents '"
+ . $client->getRequest()->getContent() . "' failed: "
+ . $response->getStatusCode() . ': ' . $response->getReasonPhrase()
+ . ', response content: ' . $response->getBody()
+ );
+ throw new ILSException('Problem with Sierra REST API.');
+ }
+
+ return $decodedResult;
+ }
+
+ /**
+ * Renew the API access token and store it in the cache.
+ * Throw an exception if there is an error.
+ *
+ * @param array $patron Patron information, if available
+ *
+ * @return bool True on success, false on patron login failure
+ * @throws ILSException
+ */
+ protected function renewAccessToken($patron = false)
+ {
+ $patronCode = false;
+ if ($patron) {
+ // Do a patron login and then perform an authorization grant request
+ if (empty($this->config['Catalog']['redirect_uri'])) {
+ $this->error(
+ 'Catalog/redirect_uri is required for patron authentication'
+ );
+ throw new ILSException('Problem with Sierra REST driver config.');
+ }
+ $params = [
+ 'client_id' => $this->config['Catalog']['client_key'],
+ 'redirect_uri' => $this->config['Catalog']['redirect_uri'],
+ 'state' => 'auth',
+ 'response_type' => 'code'
+ ];
+ $apiUrl = $this->config['Catalog']['host'] . '/authorize'
+ . '?' . http_build_query($params);
+
+ // First request the login form to get the hidden fields and cookies
+ $client = $this->createHttpClient($apiUrl);
+ $response = $client->send();
+ $doc = new \DOMDocument();
+ if (!@$doc->loadHTML($response->getBody())) {
+ $this->error('Could not parse the III CAS login form');
+ throw new ILSException('Problem with Sierra login.');
+ }
+ $postParams = [
+ 'code' => $patron['cat_username'],
+ 'pin' => $patron['cat_password'],
+ ];
+ foreach ($doc->getElementsByTagName('input') as $input) {
+ if ($input->getAttribute('type') == 'hidden') {
+ $postParams[$input->getAttribute('name')]
+ = $input->getAttribute('value');
+ }
+ }
+
+ $postUrl = $client->getUri();
+ $cookies = $client->getCookies();
+
+ // Reset client
+ $client = $this->createHttpClient($postUrl);
+ $client->addCookie($cookies);
+
+ // Allow two redirects so that we get back from CAS token verification
+ // to the authorize API address.
+ $client->setOptions(['maxredirects' => 2]);
+ $client->setParameterPost($postParams);
+ $response = $client->setMethod('POST')->send();
+ if (!$response->isSuccess() && !$response->isRedirect()) {
+ $this->error(
+ "POST request for '" . $client->getRequest()->getUriString()
+ . "' did not return 302 redirect: "
+ . $response->getStatusCode() . ': '
+ . $response->getReasonPhrase()
+ . ', response content: ' . $response->getBody()
+ );
+ throw new ILSException('Problem with Sierra login.');
+ }
+ if ($response->isRedirect()) {
+ $location = $response->getHeaders()->get('Location')->getUri();
+ // Don't try to parse the URI since Sierra creates it wrong if the
+ // redirect_uri sent to it already contains a question mark.
+ if (!preg_match('/code=([^&\?]+)/', $location, $matches)) {
+ $this->error(
+ "Could not parse patron authentication code from '$location'"
+ );
+ throw new ILSException('Problem with Sierra login.');
+ }
+ $patronCode = $matches[1];
+ } else {
+ // Did not get a redirect, assume the login failed
+ return false;
+ }
+ }
+
+ // Set up the request
+ $apiUrl = $this->config['Catalog']['host'] . '/token';
+
+ // Create proxy request
+ $client = $this->createHttpClient($apiUrl);
+
+ // Set headers
+ $headers = $client->getRequest()->getHeaders();
+ $authorization = $this->config['Catalog']['client_key'] . ':' .
+ $this->config['Catalog']['client_secret'];
+ $headers->addHeaderLine(
+ 'Authorization',
+ 'Basic ' . base64_encode($authorization)
+ );
+ $params = [];
+ if ($patronCode) {
+ $params['grant_type'] = 'authorization_code';
+ $params['code'] = $patronCode;
+ $params['redirect_uri'] = $this->config['Catalog']['redirect_uri'];
+ } else {
+ $params['grant_type'] = 'client_credentials';
+ }
+ $client->setParameterPost($params);
+
+ // Send request and retrieve response
+ $startTime = microtime(true);
+ $response = $client->setMethod('POST')->send();
+ if (!$response->isSuccess()) {
+ $this->error(
+ "POST request for '$apiUrl' with contents '"
+ . $client->getRequest()->getContent() . "' failed: "
+ . $response->getStatusCode() . ': ' . $response->getReasonPhrase()
+ . ', response content: ' . $response->getBody()
+ );
+ throw new ILSException('Problem with Sierra REST API.');
+ }
+ $result = $response->getBody();
+
+ $this->debug(
+ '[' . round(microtime(true) - $startTime, 4) . 's]'
+ . " GET request $apiUrl" . PHP_EOL . 'response: ' . PHP_EOL
+ . $result
+ );
+
+ $json = json_decode($result, true);
+ $this->sessionCache->accessToken = $json['access_token'];
+ $this->sessionCache->accessTokenPatron = $patronCode
+ ? $patron['cat_username'] : null;
+ return true;
+ }
+
+ /**
+ * Create a HTTP client
+ *
+ * @param string $url Request URL
+ *
+ * @return \Zend\Http\Client
+ */
+ protected function createHttpClient($url)
+ {
+ $client = $this->httpService->createClient($url);
+
+ // Set timeout value
+ $timeout = isset($this->config['Catalog']['http_timeout'])
+ ? $this->config['Catalog']['http_timeout'] : 30;
+ $client->setOptions(
+ ['timeout' => $timeout, 'useragent' => 'VuFind', 'keepalive' => true]
+ );
+
+ // Set Accept header
+ $client->getRequest()->getHeaders()->addHeaderLine(
+ 'Accept', 'application/json'
+ );
+
+ return $client;
+ }
+
+ /**
+ * Add instance-specific context to a cache key suffix to ensure that
+ * multiple drivers don't accidentally share values in the cache.
+ *
+ * @param string $key Cache key suffix
+ *
+ * @return string
+ */
+ protected function formatCacheKey($key)
+ {
+ return 'SierraRest-' . md5($this->config['Catalog']['host'] . "|$key");
+ }
+
+ /**
+ * Get Item Statuses
+ *
+ * This is responsible for retrieving the status information of a certain
+ * record.
+ *
+ * @param string $id The record id to retrieve the holdings for
+ *
+ * @return array An associative array with the following keys:
+ * id, availability (boolean), status, location, reserve, callnumber.
+ */
+ protected function getItemStatusesForBib($id)
+ {
+ $bib = $this->getBibRecord($id, 'bibLevel');
+ $offset = 0;
+ $limit = 50;
+ $fields = 'location,status,barcode,callNumber,fixedFields';
+ if ('m' !== $bib['bibLevel']['code']) {
+ // Fetch varFields for volume information
+ $fields .= ',varFields';
+ }
+ $statuses = [];
+ while (!isset($result) || $limit === $result['total']) {
+ $result = $this->makeRequest(
+ ['v3', 'items'],
+ [
+ 'bibIds' => $id,
+ 'deleted' => 'false',
+ 'suppressed' => 'false',
+ 'fields' => $fields,
+ 'limit' => $limit,
+ 'offset' => $offset
+ ],
+ 'GET'
+ );
+ if (empty($result['entries'])) {
+ if (!empty($result['httpStatus']) && 404 !== $result['httpStatus']) {
+ $msg = "Item status request failed: {$result['httpStatus']}";
+ if (!empty($result['description'])) {
+ $msg .= " ({$result['description']})";
+ }
+ throw new ILSException($msg);
+ }
+ return $statuses;
+ }
+
+ foreach ($result['entries'] as $i => $item) {
+ $location = $this->translateLocation($item['location']);
+ list($status, $duedate, $notes) = $this->getItemStatus($item);
+ $available = $status == 'On Shelf';
+ // OPAC message
+ if (isset($item['fixedFields']['108'])) {
+ $opacMsg = $item['fixedFields']['108'];
+ if (trim($opacMsg['value']) != '-') {
+ $notes[] = $this->translateOpacMessage(
+ trim($opacMsg['value'])
+ );
+ }
+ }
+ $volume = isset($item['varFields']) ? $this->extractVolume($item)
+ : '';
+
+ $entry = [
+ 'id' => $id,
+ 'item_id' => $item['id'],
+ 'location' => $location,
+ 'availability' => $available,
+ 'status' => $status,
+ 'reserve' => 'N',
+ 'callnumber' => isset($item['callNumber'])
+ ? preg_replace('/^\|a/', '', $item['callNumber']) : '',
+ 'duedate' => $duedate,
+ 'number' => $volume,
+ 'barcode' => $item['barcode'],
+ 'sort' => $i
+ ];
+ if ($notes) {
+ $entry['item_notes'] = $notes;
+ }
+
+ if ($this->isHoldable($item) && $this->itemHoldAllowed($item, $bib)
+ ) {
+ $entry['is_holdable'] = true;
+ $entry['level'] = 'copy';
+ $entry['addLink'] = true;
+ } else {
+ $entry['is_holdable'] = false;
+ }
+
+ $statuses[] = $entry;
+ }
+ $offset += $limit;
+ }
+
+ usort($statuses, [$this, 'statusSortFunction']);
+ return $statuses;
+ }
+
+ /**
+ * Translate location name
+ *
+ * @param array $location Location
+ *
+ * @return string
+ */
+ protected function translateLocation($location)
+ {
+ $prefix = 'location_';
+ if (!empty($this->config['Catalog']['id'])) {
+ $prefix .= $this->config['Catalog']['id'] . '_';
+ }
+ return $this->translate(
+ $prefix . trim($location['code']),
+ null,
+ $location['name']
+ );
+ }
+
+ /**
+ * Translate OPAC message
+ *
+ * @param string $code OPAC message code
+ *
+ * @return string
+ */
+ protected function translateOpacMessage($code)
+ {
+ $prefix = 'opacmsg_';
+ if (!empty($this->config['Catalog']['id'])) {
+ $prefix .= $this->config['Catalog']['id'] . '_';
+ }
+ return $this->translate("$prefix$code", null, $code);
+ }
+
+ /**
+ * Get status for an item
+ *
+ * @param array $item Item from Sierra
+ *
+ * @return array Status string, possible due date and any notes
+ */
+ protected function getItemStatus($item)
+ {
+ $duedate = '';
+ $notes = [];
+ $statusCode = trim($item['status']['code']);
+ if (isset($this->itemStatusMappings[$statusCode])) {
+ $status = $this->itemStatusMappings[$statusCode];
+ } else {
+ $status = isset($item['status']['display'])
+ ? ucwords(strtolower($item['status']['display']))
+ : '-';
+ }
+ $status = trim($status);
+ // For some reason at least API v2.0 returns "ON SHELF" even when the
+ // item is out. Use duedate to check if it's actually checked out.
+ if (isset($item['status']['duedate'])) {
+ $duedate = $this->dateConverter->convertToDisplayDate(
+ \DateTime::ISO8601,
+ $item['status']['duedate']
+ );
+ $status = 'Charged';
+ } else {
+ switch ($status) {
+ case '-':
+ $status = 'On Shelf';
+ break;
+ case 'Lib Use Only':
+ $status = 'On Reference Desk';
+ break;
+ }
+ }
+ if ($status == 'On Shelf') {
+ // Check for checkin date
+ $today = $this->dateConverter->convertToDisplayDate('U', time());
+ if (isset($item['fixedFields']['68'])) {
+ $checkedIn = $this->dateConverter->convertToDisplayDate(
+ \DateTime::ISO8601, $item['fixedFields']['68']['value']
+ );
+ if ($checkedIn == $today) {
+ $notes[] = $this->translate('Returned today');
+ }
+ }
+ }
+ return [$status, $duedate, $notes];
+ }
+
+ /**
+ * Determine whether an item is holdable
+ *
+ * @param array $item Item from Sierra
+ *
+ * @return bool
+ */
+ protected function isHoldable($item)
+ {
+ if (!empty($this->validHoldStatuses)) {
+ list($status, $duedate, $notes) = $this->getItemStatus($item);
+ if (!in_array($status, $this->validHoldStatuses)) {
+ return false;
+ }
+ }
+ return true;
+ }
+
+ /**
+ * Check if an item is holdable
+ *
+ * @param array $item Item from Sierra
+ * @param array $bib Bib record from Sierra
+ *
+ * @return bool
+ */
+ protected function itemHoldAllowed($item, $bib)
+ {
+ if (!$this->itemHoldsEnabled) {
+ return false;
+ }
+ if (!empty($this->itemHoldExcludedItemCodes)
+ && isset($item['fixedFields']['60'])
+ ) {
+ $code = $item['fixedFields']['60']['value'];
+ if (in_array($code, $this->itemHoldExcludedItemCodes)) {
+ return false;
+ }
+ }
+ if (!empty($this->titleHoldBibLevels)) {
+ if (in_array($bib['bibLevel']['code'], $this->titleHoldBibLevels)) {
+ return false;
+ }
+ }
+ return true;
+ }
+
+ /**
+ * Get patron's blocks, if any
+ *
+ * @param array $patron Patron
+ *
+ * @return mixed A boolean false if no blocks are in place and an array
+ * of block reasons if blocks are in place
+ */
+ protected function getPatronBlocks($patron)
+ {
+ $patronId = $patron['id'];
+ $cacheId = "blocks|$patronId";
+ $blockReason = $this->getCachedData($cacheId);
+ if (null === $blockReason) {
+ $result = $this->makeRequest(
+ ['v3', 'patrons', $patronId],
+ ['fields' => 'blockInfo'],
+ 'GET',
+ $patron
+ );
+ if (!empty($result['blockInfo'])
+ && trim($result['blockInfo']['code']) != '-'
+ ) {
+ $blockReason = [trim($result['blockInfo']['code'])];
+ } else {
+ $blockReason = [];
+ }
+ $this->putCachedData($cacheId, $blockReason);
+ }
+ return empty($blockReason) ? false : $blockReason;
+ }
+
+ /**
+ * Status item sort function
+ *
+ * @param array $a First status record to compare
+ * @param array $b Second status record to compare
+ *
+ * @return int
+ */
+ protected function statusSortFunction($a, $b)
+ {
+ $result = strcmp($a['location'], $b['location']);
+ if ($result == 0) {
+ $result = $a['sort'] - $b['sort'];
+ }
+ return $result;
+ }
+
+ /**
+ * Is the selected pickup location valid for the hold?
+ *
+ * @param string $pickUpLocation Selected pickup location
+ * @param array $patron Patron information returned by the patronLogin
+ * method.
+ * @param array $holdDetails Details of hold being placed
+ *
+ * @return bool
+ */
+ protected function pickUpLocationIsValid($pickUpLocation, $patron, $holdDetails)
+ {
+ $pickUpLibs = $this->getPickUpLocations($patron, $holdDetails);
+ foreach ($pickUpLibs as $location) {
+ if ($location['locationID'] == $pickUpLocation) {
+ return true;
+ }
+ }
+ return false;
+ }
+
+ /**
+ * Hold Error
+ *
+ * Returns a Hold Error Message
+ *
+ * @param string $msg An error message string
+ *
+ * @return array An array with a success (boolean) and sysMessage key
+ */
+ protected function holdError($msg)
+ {
+ $msg = $this->formatErrorMessage($msg);
+ return [
+ 'success' => false,
+ 'sysMessage' => $msg
+ ];
+ }
+
+ /**
+ * Format an error message received from Sierra
+ *
+ * @param string $msg An error message string
+ *
+ * @return string
+ */
+ protected function formatErrorMessage($msg)
+ {
+ // Remove prefix like "WebPAC Error" or "XCirc error"
+ $msg = preg_replace('/.* [eE]rror\s*:\s*/', '', $msg);
+ // Handle non-ascii characters that are returned in a wrongly encoded format
+ // (e.g. {u00E4} instead of \u00E4)
+ $msg = preg_replace_callback(
+ '/\{u([0-9a-fA-F]{4})\}/',
+ function ($matches) {
+ return mb_convert_encoding(
+ pack('H*', $matches[1]), 'UTF-8', 'UCS-2BE'
+ );
+ },
+ $msg
+ );
+ return $msg;
+ }
+
+ /**
+ * Fetch a bib record from Sierra
+ *
+ * @param int $id Bib record id
+ * @param string $fields Fields to request
+ * @param array $patron Patron information, if available
+ *
+ * @return array|null
+ */
+ protected function getBibRecord($id, $fields, $patron = false)
+ {
+ return $this->makeRequest(
+ ['v3', 'bibs', $id],
+ ['fields' => $fields],
+ 'GET',
+ $patron
+ );
+ }
+}