forked from vufind-org/vufind
-
Notifications
You must be signed in to change notification settings - Fork 4
/
OLE.php
1507 lines (1308 loc) · 53.5 KB
/
OLE.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* OLE ILS Driver
*
* PHP version 5
*
* Copyright (C) Villanova University 2013.
*
* 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 VuFind2
* @package ILS_Drivers
* @author Demian Katz <demian.katz@villanova.edu>
* @author David Lacy <david.lacy@villanova.edu>
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
* @link http://vufind.org/wiki/vufind2:building_an_ils_driver Wiki
*/
namespace VuFind\ILS\Driver;
use File_MARC, PDO, PDOException, Exception,
VuFind\Exception\ILS as ILSException,
VuFindSearch\Backend\Exception\HttpErrorException,
Zend\Json\Json,
Zend\Http\Client,
Zend\Http\Request;
/**
* OLE ILS Driver
*
* @category VuFind2
* @package ILS_Drivers
* @author Demian Katz <demian.katz@villanova.edu>
* @author David Lacy <demian.katz@villanova.edu>
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
* @link http://vufind.org/wiki/vufind2:building_an_ils_driver Wiki
*/
class OLE extends AbstractBase implements \VuFindHttp\HttpServiceAwareInterface
{
/**
* HTTP service
*
* @var \VuFindHttp\HttpServiceInterface
*/
protected $httpService = null;
/**
* Database connection
*
* @var PDO
*/
protected $db;
/**
* Name of database
*
* @var string
*/
protected $dbName;
/**
* Location of OLE's circ service
*
* @var string
*/
protected $circService;
/**
* Location of OLE's docstore service
*
* @var string
*/
protected $docService;
/**
* Location of OLE's solr service
*
* @var string
*/
protected $solrService;
/**
* OLE operator for API calls
*/
protected $operatorId;
/**
* item_available_codes, the value from ole_dlvr_item_avail_stat_t that indicates that an item is available. All other codes are reflect as unavailable.
*/
protected $item_available_codes;
/**
* OLE's default sort for checked out items in user account section.
*/
protected $coiSort;
/**
* Set the HTTP service to be used for HTTP requests.
*
* @param HttpServiceInterface $service HTTP service
*
* @return void
*/
public function setHttpService(\VuFindHttp\HttpServiceInterface $service)
{
$this->httpService = $service;
}
/**
* Should we check renewal status before presenting a list of items or only
* after user requests renewal?
*
* @var bool
*/
protected $checkRenewalsUpFront;
/* TODO Delete
protected $record;
*/
//
/**
* Default pickup location
*
* @var string
*/
protected $defaultPickUpLocation;
/* */
protected $bibPrefix;
protected $holdingPrefix;
protected $itemPrefix;
/* */
protected $dbvendor;
/**
* Initialize the driver.
*
* Validate configuration and perform all resource-intensive tasks needed to
* make the driver active.
*
* @throws ILSException
* @return void
*/
public function init()
{
if (empty($this->config)) {
throw new ILSException('Configuration needs to be set.');
}
/* TODO: move these to the config */
$this->bibPrefix = "wbm-";
$this->holdingPrefix = "who-";
$this->itemPrefix = "wio-";
$this->dbvendor
= isset($this->config['Catalog']['dbvendor'])
? $this->config['Catalog']['dbvendor'] : "mysql";
$this->checkRenewalsUpFront
= isset($this->config['Renewals']['checkUpFront'])
? $this->config['Renewals']['checkUpFront'] : true;
$this->defaultPickUpLocation
= $this->config['Holds']['defaultPickUpLocation'];
// Define Database Name
$this->dbName = $this->config['Catalog']['database'];
// Define OLE's circualtion service
$this->circService = $this->config['Catalog']['circulation_service'];
// Define OLE's docstore service
$this->docService = $this->config['Catalog']['docstore_service'];
// Define OLE's solr service
$this->solrService = $this->config['Catalog']['solr_service'];
// Define OLE's Circ API operator
$this->operatorId = $this->config['Catalog']['operatorId'];
// Define OLE's available code status
$this->item_available_codes = explode(":", $this->config['Catalog']['item_available_code']);
// Define OLE's default sort for checked out items
$this->coiSort = $this->config['UserAccount']['checkedOutItemsSort'];
try {
if ($this->dbvendor == 'oracle') {
$tns = '(DESCRIPTION=' .
'(ADDRESS_LIST=' .
'(ADDRESS=' .
'(PROTOCOL=TCP)' .
'(HOST=' . $this->config['Catalog']['host'] . ')' .
'(PORT=' . $this->config['Catalog']['port'] . ')' .
')' .
')' .
')';
$this->db = new PDO(
"oci:dbname=$tns",
$this->config['Catalog']['user'],
$this->config['Catalog']['password']
);
} else {
$this->db = new PDO(
"mysql:host=" . $this->config['Catalog']['host'] . ";port=" . $this->config['Catalog']['port'] . ";dbname=" . $this->config['Catalog']['database']. ";charset=UTF8",
$this->config['Catalog']['user'],
$this->config['Catalog']['password']
);
}
$this->db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
} catch (PDOException $e) {
throw $e;
}
}
/**
* 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
*
* @return array An array with key-value pairs.
*/
public function getConfig($function)
{
if (isset($this->config[$function]) ) {
$functionConfig = $this->config[$function];
} else {
$functionConfig = false;
}
return $functionConfig;
}
/**
* Patron Login
*
* This is responsible for authenticating a patron against the catalog.
*
* @param string $barcode The patron barcode
* @param string $login The patron's last name or PIN (depending on config)
*
* @throws ILSException
* @return mixed Associative array of patron info on successful login,
* null on unsuccessful login.
*/
public function patronLogin($barcode, $login)
{
// Load the field used for verifying the login from the config file, and
// make sure there's nothing crazy in there:
$login_field = isset($this->config['Catalog']['login_field'])
? $this->config['Catalog']['login_field'] : 'LAST_NAME';
$login_field = preg_replace('/[^\w]/', '', $login_field);
$sql = "SELECT * " .
"FROM $this->dbName.ole_ptrn_t, $this->dbName.krim_entity_nm_t " .
"where ole_ptrn_t.OLE_PTRN_ID=krim_entity_nm_t.ENTITY_ID AND " .
"lower(krim_entity_nm_t.{$login_field}) = :login AND " .
"lower(ole_ptrn_t.BARCODE) = :barcode";
try {
$sqlStmt = $this->db->prepare($sql);
$sqlStmt->bindParam(
':login', strtolower(utf8_decode($login)), PDO::PARAM_STR
);
$sqlStmt->bindParam(
':barcode', strtolower(utf8_decode($barcode)), PDO::PARAM_STR
);
//var_dump($sqlStmt);
$sqlStmt->execute();
$row = $sqlStmt->fetch(PDO::FETCH_ASSOC);
if (isset($row['OLE_PTRN_ID']) && ($row['OLE_PTRN_ID'] != '')) {
return array(
'id' => utf8_encode($row['OLE_PTRN_ID']),
'firstname' => utf8_encode($row['FIRST_NM']),
'lastname' => utf8_encode($row['LAST_NM']),
'cat_username' => $barcode,
'cat_password' => $login,
'email' => null,
'major' => null,
'college' => null,
'barcode' => $barcode);
} else {
return null;
}
} catch (PDOException $e) {
throw new ILSException($e->getMessage());
}
}
/**
* 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)
{
$uri = $this->circService . '?service=lookupUser&patronBarcode=' . $patron['barcode'] . '&operatorId=' . $this->operatorId;
$request = new Request();
$request->setMethod(Request::METHOD_GET);
$request->setUri($uri);
$client = new Client();
$client->setOptions(array('timeout' => 240));
try {
$response = $client->dispatch($request);
} catch (Exception $e) {
throw new ILSException($e->getMessage());
}
// TODO: reimplement something like this when the API starts returning the proper http status code
/*
if (!$response->isSuccess()) {
throw HttpErrorException::createFromResponse($response);
}
*/
$content = $response->getBody();
$xml = simplexml_load_string($content);
$patron['email'] = '';
$patron['address1'] = '';
$patron['address2'] = null;
$patron['city'] = '';
$patron['state'] = '';
$patron['zip'] = '';
$patron['phone'] = '';
$patron['group'] = '';
if (!empty($xml->patronName->firstName)) {
$patron['firstname'] = $xml->patronName->firstName;
}
if (!empty($xml->patronName->lastName)) {
$patron['lastname'] = $xml->patronName->lastName;
}
if (!empty($xml->patronEmail->emailAddress)) {
$patron['email'] = $xml->patronEmail->emailAddress;
}
if (!empty($xml->patronAddress->line1)) {
$patron['address1'] = $xml->patronAddress->line1;
}
if (!empty($xml->patronAddress->line2)) {
$patron['address2'] = $xml->patronAddress->line2;
}
if (!empty($xml->patronAddress->city)) {
$patron['city'] = $xml->patronAddress->city;
}
if (!empty($xml->patronAddress->stateProvinceCode)) {
$patron['state'] = $xml->patronAddress->stateProvinceCode;
}
if (!empty($xml->patronAddress->postalCode)) {
$patron['zip'] = $xml->patronAddress->postalCode;
}
if (!empty($xml->patronPhone->phoneNumber)) {
$patron['phone'] = $xml->patronPhone->phoneNumber;
}
return (empty($patron) ? null : $patron);
}
/**
* 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 - TODO
* @throws ILSException
* @return array Array of the patron's transactions on success.
*/
public function getMyTransactions($patron) {
$holdList = array();
$uri = $this->circService . '?service=getCheckedOutItems&patronBarcode=' . $patron['barcode'] . '&operatorId=' . $this->operatorId;
$request = new Request();
$request->setMethod(Request::METHOD_GET);
$request->setUri($uri);
$client = new Client();
$client->setOptions(array('timeout' => 30));
try {
$response = $client->dispatch($request);
} catch (Exception $e) {
throw new ILSException($e->getMessage());
}
// TODO: reimplement something like this when the API starts returning the proper http status code
/*
if (!$response->isSuccess()) {
throw HttpErrorException::createFromResponse($response);
}
*/
$content = $response->getBody();
$xml = simplexml_load_string($content);
$code = $xml->xpath('//code');
$code = (string)$code[0][0];
//var_dump($code);
//var_dump($xml);
if ($code == '000') {
$holdItems = $xml->xpath('//checkOutItem');
$holdsList = array();
foreach($holdItems as $item) {
//var_dump($item);
$processRow = $this->processMyTransactions($item, $patron);
//var_dump($processRow);
$holdsList[] = $processRow;
}
}
return $holdsList;
}
/**
* Converts a date into a sortable date.
*
* @param string, $date a date string to be formatted.
*
* @returns, integer date in sortable fashion
* e.g. 20141023
*/
public function sortDate($date) {
return date('Ynj', strtotime($date));
}
/**
* Get Patron Fines
*
* This is responsible for retrieving all fines by a specific patron.
*
* @param array $patron The patron array from patronLogin
*
* @throws DateException - TODO
* @throws ILSException
* @return mixed Array of the patron's fines on success.
*/
/* TODO: this hasn't been fully implemented yet */
public function getMyFines($patron)
{
$fineList = array();
$transList = $this->getMyTransactions($patron);
$uri = $this->circService . '?service=fine&patronBarcode=' . $patron['barcode'] . '&operatorId=' . $this->operatorId;
$request = new Request();
$request->setMethod(Request::METHOD_GET);
$request->setUri($uri);
$client = new Client();
$client->setOptions(array('timeout' => 30));
try {
$response = $client->dispatch($request);
} catch (Exception $e) {
throw new ILSException($e->getMessage());
}
$content_str = $response->getBody();
$xml = simplexml_load_string($content_str);
$fines = $xml->xpath('//fineItem');
foreach($fines as $fine) {
//var_dump($fine);
$processRow = $this->processMyFinesData($fine, $patron);
//var_dump($processRow);
if($processRow['id']) {
foreach($transList as $trans) {
if ($this->bibPrefix . $trans['id'] == $processRow['id']) {
$processRow['checkout'] = $trans['loanedDate'];
$processRow['duedate'] = $trans['duedate'];
$processRow['title'] = $trans['title'];
break;
}
}
}
$fineList[] = $processRow;
}
return $fineList;
}
/**
* Protected support method for getMyHolds.
*
* @param array $itemXml simplexml object of item data
* @param array $patron array
*
* @throws DateException
* @return array Keyed data for display by template files
*/
protected function processMyFinesData($itemXml, $patron = false)
{
$recordId = (substr((string)$itemXml->catalogueId, 0, 4) == $this->bibPrefix ? substr((string)$itemXml->catalogueId, 4) : (string)$itemXml->catalogueId);
$record = $this->getRecord($recordId);
return array(
'amount' => (string)$itemXml->amount,
'fine' => (string)$itemXml->reason,
'balance' => (string)$itemXml->balance,
'createdate' => (string)$itemXml->dateCharged,
'title' => (string)$itemXml->title,
'checkout' => '',
'duedate' => '',
'id' => $recordId
);
}
/**
* Get Patron Holds
*
* This is responsible for retrieving all holds by a specific patron.
*
* @param array $patron The patron array from patronLogin
*
* @throws DateException - TODO
* @throws ILSException
* @return array Array of the patron's holds on success.
*/
public function getMyHolds($patron)
{
$holdList = array();
$uri = $this->circService . '?service=holds&patronBarcode=' . $patron['barcode'] . '&operatorId=' . $this->operatorId;
$request = new Request();
$request->setMethod(Request::METHOD_GET);
$request->setUri($uri);
$client = new Client();
$client->setOptions(array('timeout' => 30));
try {
$response = $client->dispatch($request);
} catch (Exception $e) {
throw new ILSException($e->getMessage());
}
// TODO: reimplement something like this when the API starts returning the proper http status code
/*
if (!$response->isSuccess()) {
throw HttpErrorException::createFromResponse($response);
}
*/
$content = $response->getBody();
$xml = simplexml_load_string($content);
$code = $xml->xpath('//code');
$code = (string)$code[0][0];
//var_dump($code);
//var_dump($xml);
if ($code == '000') {
$holdItems = $xml->xpath('//hold');
$holdsList = array();
foreach($holdItems as $item) {
//var_dump($item);
$processRow = $this->processMyHoldsData($item, $patron);
//var_dump($processRow);
$holdsList[] = $processRow;
}
}
return $holdsList;
}
/**
* Protected support method for getMyHolds.
*
* @param array $itemXml simplexml object of item data
* @param array $patron array
*
* @throws DateException - TODO
* @return array Keyed data for display by template files
*/
protected function processMyHoldsData($itemXml, $patron = false)
{
$availableDateTime = (string) $itemXml->availableDate;
$available = ($availableDateTime <= date('Y-m-d')) ? true:false;
// JEJ CHANGE
// Did the API change to return a string instead of date? (DL)
$available = ((string) $itemXml->availableStatus == 'ONHOLD') ? true:false;
return array(
'id' => substr((string) $itemXml->catalogueId, strpos((string) $itemXml->catalogueId, '-')+1),
'item_id' => (string) $itemXml->itemId,
'type' => (string) $itemXml->requestType,
'location' => '',
'expire' => (string) $itemXml->expiryDate,
'create' => (string) $itemXml->createDate,
'position' => (string) $itemXml->priority,
'available' => $available,
'reqnum' => (string) $itemXml->requestId,
'volume' => '',
'publication_year' => '',
'title' => strlen((string) $itemXml->title)
? (string) $itemXml->title : "unknown title"
);
}
protected function processMyTransactions($itemXml, $patron = false)
{
$availableDateTime = (string) $itemXml->availableDate;
$available = ($availableDateTime <= date('Y-m-d')) ? true:false;
// JEJ CHANGE
// Did the API change to return a string instead of date? (DL)
$available = ((string) $itemXml->availableStatus == 'ONHOLD') ? true:false;
return array(
'duedate' => (string) $itemXml->dueDate,
'id' => substr((string) $itemXml->catalogueId, strpos((string) $itemXml->catalogueId, '-')+1),
'item_id' => (string) $itemXml->itemId,
'create' => (string) $itemXml->createDate,
'title' => strlen((string) $itemXml->title)
? (string) $itemXml->title : "unknown title",
'renewable' => array('message' => 'renewable', 'renewable' => true)
);
}
/**
* Protected support method for getMyTransactions.
*
* @param array $row data from the database
* @param array $patron array
*
* @throws DateException - TODO
* @return array Keyed data for display by template files
*/
protected function processMyTransactionsData($row, $patron = false)
{
$dateFormat = 'n/j/Y';
$dueDate = substr((string) $row['duedate'], 0, 10);
$dueTime = substr((string) $row['duedate'], 11);
$loanedDate = substr((string) $row['loaned_date'], 0, 10);
$loanedTime = substr((string) $row['loaned_date'], 11);
$dueStatus = ($row['overdue_notices_count'] > 0) ? "overdue" : "";
$xml = simplexml_load_string($row['bib_data']);
$title = '';
foreach($xml->record->xpath('*') as $field) {
if ($field->attributes() == '245') {
$title = (string) $field->subfield;
}
}
/*See if item is on indefinite loan.*/
$isIndefiniteLoan = strlen($dueDate) < 1;
$transactions = array(
'id' => $row['bib_num'],
'item_id' => $row['item_id'],
'duedate' => ($isIndefiniteLoan == false ? date($dateFormat, strtotime($dueDate)) : null),
'dueTime' => ($isIndefiniteLoan == false ? $dueTime : null),
'loanedDate' => date($dateFormat, strtotime($loanedDate)),
'loanedTime' => $loanedTime,
'dueStatus' => $dueStatus,
'volume' => $row['enumeration'],
'copy' => $row['copy_number'],
'callNumber' => $row['call_number_prefix'] . ' ' . $row['call_number'],
'publication_year' => $row['imprint'],
'renew' => $row['number_of_renewals'],
'title' => $title != '' ? $title : "unknown title",
'barcode' => $row['barcode']
);
$renewData = $this->checkRenewalsUpFront
? $this->isRenewable($patron['id'], $transactions['item_id'])
: array('message' => 'renewable', 'renewable' => true);
$transactions['renewable'] = $renewData['renewable'];
$transactions['message'] = $isIndefiniteLoan == false ? $renewData['message'] : null;
return $transactions;
}
/* TODO: document this */
public function getRecord($id)
{
//$uri = $this->docService . '?docAction=instanceDetails&format=xml&bibIds=' . $id;
$uri = $this->solrService . "?q=bibIdentifier:" . $this->bibPrefix . $id . "&wt=xml&rows=100000";
/* TODO: use the zend http service and throw appropriate exception */
$xml = simplexml_load_string(file_get_contents($uri));
//$xml->registerXPathNamespace('ole', 'http://ole.kuali.org/standards/ole-instance');
//$xml->registerXPathNamespace('circ', 'http://ole.kuali.org/standards/ole-instance-circulation');
return $xml;
}
/**
* 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
*
* @throws ILSException
* @return mixed On success, an associative array with the following keys:
* id, availability (boolean), status, location, reserve, callnumber.
*/
public function getStatus($id)
{
$idole = intval(substr($id, 0, -1));
$sql = 'SELECT DISTINCT loc.LOCN_NAME AS locn_name,
h.LOCATION AS holdings_locn_code, h.call_number_prefix AS holding_call_number_prefix, h.call_number AS holding_call_number,
i.LOCATION AS item_locn_code, i.call_number_prefix AS item_call_number_prefix, i.call_number AS item_call_number, i.COPY_NUMBER AS item_copy_number,
status.ITEM_AVAIL_STAT_CD AS item_status_code, status.ITEM_AVAIL_STAT_NM AS item_status_name
FROM ole_ds_holdings_t h
JOIN ole_ds_item_t i ON h.HOLDINGS_ID = i.HOLDINGS_ID
JOIN ole_dlvr_item_avail_stat_t status ON i.ITEM_STATUS_ID=status.ITEM_AVAIL_STAT_ID
LEFT JOIN ole_locn_t loc ON loc.LOCN_CD = if(i.LOCATION is not NULL && length(i.LOCATION) > 0, SUBSTRING_INDEX(i.LOCATION, \'/\', -1), SUBSTRING_INDEX(h.LOCATION, \'/\', -1))
WHERE h.STAFF_ONLY = "N"
AND i.STAFF_ONLY = "N"
AND h.BIB_ID = :id';
try {
/*Query the database*/
$stmt = $this->db->prepare($sql);
$stmt->execute(array(':id' => $idole));
/*Build the return array*/
$items = array();
while ($row = $stmt->fetch()) {
$item = array();
/*Set convenience variables.*/
$status = $row['item_status_code'];
$available = (in_array($status, $this->item_available_codes) ? true:false);
$location = $row['locn_name'];
/*Build item array*/
$item['id'] = $id;
$item['status'] = $status;
$item['location'] = $row['locn_name'];
$item['reserve'] = 'N';
$item['callnumber'] = (string) $row[2] . ' ' . $row['holding_call_number'];
$item['availability'] = $available;
if ($item['status'] == 'ANAL') {
$item['availability'] = null;
}
$items[] = $item;
}
}
catch (Exception $e){
/*Do nothing*/
}
return $items;
}
/**
* TODO: document this
*
*/
public function getItemStatus($itemXML) {
$status = $itemXML->children('circ', true)->itemStatus->children()->codeValue;
// TODO: enable all item statuses
$available = (in_array($status, $this->item_available_codes)) ? true:false;
$item['status'] = $status;
$item['location'] = '';
$item['reserve'] = '';
$item['availability'] = $available;
return $item;
}
/**
* Get Statuses
*
* This is responsible for retrieving the status information for a
* collection of records.
*
* @param array $idList The array of record ids to retrieve the status for
*
* @throws ILSException
* @return array An array of getStatus() return values on success.
*/
public function getStatuses($idList)
{
$status = array();
foreach ($idList as $id) {
$status[] = $this->getStatus($id);
}
return $status;
}
/**
*
*/
protected function getItems($id, $holdingId, $holdingLocation, $holdingLocCodes, $holdingCallNum, $holdingCallNumDisplay) {
/*Bet items by holding id*/
$sql = 'SELECT i.ITEM_ID AS item_id, i.HOLDINGS_ID AS holdings_id, i.BARCODE AS barcode, i.URI AS uri,
i.ITEM_TYPE_ID AS item_type_id, i.TEMP_ITEM_TYPE_ID as temp_item_type_id,
itype.ITM_TYP_CD AS itype_code, itype.ITM_TYP_NM AS itype_name,
istat.ITEM_AVAIL_STAT_CD AS status_code, istat.ITEM_AVAIL_STAT_NM AS status_name,
i.LOCATION AS location, loc.LOCN_NAME AS locn_name,
i.CALL_NUMBER_TYPE_ID, i.CALL_NUMBER_PREFIX, i.CALL_NUMBER, i.ENUMERATION, i.CHRONOLOGY, i.COPY_NUMBER,
i.DUE_DATE_TIME, i.CHECK_OUT_DATE_TIME, i.CLAIMS_RETURNED,
CONCAT_WS(";", (SELECT inote.NOTE
FROM ole_ds_item_note_t inote
WHERE i.ITEM_ID = inote.ITEM_ID
AND inote.TYPE="public")
) AS note
FROM ole_ds_item_t i
LEFT JOIN ole_dlvr_item_avail_stat_t istat on i.ITEM_STATUS_ID = istat.ITEM_AVAIL_STAT_ID
LEFT JOIN ole_cat_itm_typ_t itype on if(i.TEMP_ITEM_TYPE_ID is not null, i.TEMP_ITEM_TYPE_ID, i.ITEM_TYPE_ID) = itype.ITM_TYP_CD_ID
LEFT JOIN ole_locn_t loc on loc.LOCN_CD = SUBSTRING_INDEX(i.LOCATION, \'/\', -1)
WHERE i.STAFF_ONLY = \'N\'
AND i.HOLDINGS_ID = :holdingId';
try {
/*Query the database*/
$stmt = $this->db->prepare($sql);
$stmt->execute(array(':holdingId' => $holdingId));
/*Return array*/
$items = array();
while ($row = $stmt->fetch()) {
$item = array();
//print_r($row);
/*Set convenience variables.*/
$status = $row['status_code'];
$available = (in_array($status, $this->item_available_codes) ? true:false);
$copyNum = $row['COPY_NUMBER'];
$enumeration = $row['ENUMERATION'];
$itemCallNumDisplay = (isset($row['CALL_NUMBER']) ? trim($row['CALL_NUMBER_PREFIX'] . ' ' .$row['CALL_NUMBER']) : null);
$itemCallNum = (isset($row['CALL_NUMBER']) ? trim($row['CALL_NUMBER']) : null);
$holdtype = ($available == true) ? "hold":"recall";
$itemTypeArray = ($row['itype_name'] ? explode('-', $row['itype_name']) : array());
$itemTypeName = trim($itemTypeArray[1]);
$itemLocation = $row['locn_name'];
$itemLocCodes = $row['location'];
/*Build the items*/
$item['id'] = $id;
$item['availability'] = $available;
$item['status'] = $status;
$item['location'] = (!empty($itemLocation) ? $itemLocation : $holdingLocation);
$item['reserve'] = '';
$item['callnumber'] = (!empty($itemCallNum) ? $itemCallNum : $holdingCallNum);
$item['duedate'] = (isset($row['DUE_DATE_TIME']) ? $row['DUE_DATE_TIME'] : 'Indefinite') ;
$item['returnDate'] = '';
$item['number'] = $copyNum . ' : ' . $enumeration;
$item['requests_placed'] = '';
$item['barcode'] = $row['barcode'];
$item['item_id'] = $row['item_id'];
$item['is_holdable'] = true;
$item['itemNotes'] = $row['note'];
$item['holdtype'] = $holdtype;
/*UChicago specific?*/
$item['claimsReturned'] = ($row['CLAIMS_RETURNED'] == 'Y' ? true : false);
$item['sort'] = preg_replace('/[^[:digit:]]/','', $copyNum) . preg_replace('/[^[:digit:]]/','', array_shift(preg_split('/[\s-]/', $enumeration)));
$item['itemTypeCode'] = $row['itype_code'];
$item['itemTypeName'] = $itemTypeName;
$item['callnumberDisplay'] = (!empty($itemCallNumDisplay) ? $itemCallNumDisplay : $holdingCallNumDisplay);
$item['locationCodes'] = (!empty($itemLocCodes) ? $itemLocCodes : $holdingLocCodes);
$items[] = $item;
}
}
catch (Exception $e){print_r($e);
/*Do nothing*/
}
/*Sort numerically by copy/volume number.*/
usort($items, function($a, $b) { return OLE::cmp($a['sort'], $b['sort']); });
return $items;
}
/**
* A trivial helper method used in getItems as a comparison
* callback for usort in ordering item lists by a definied
* sort key. This should be removed, along with usort and
* the $item['sort'] key in getItems once the DB is returning
* things in the proper order.
*
* @param $a string, formatted copy/volume numbers in the
* $item['sort'] key for each item in he items array.
* @param $b same as $a
*
* returns -1, 0, or 1
*/
public function cmp($a, $b) {
if ($a == $b) {
return 0;
}
return ($a < $b) ? -1 : 1;
}
/**
* Get Summary of Holdings
*
* Gets the extent of ownership information from OLE.
*
* @param string $id the record id.
* @param string $holdingId holding specific identifier.
* @param string $location the holding location.
*
* @return array of summary data for a specific holding.
*/
protected function getSummaryHoldings($id, $holdingId, $location) {
/*Get extent of ownership by bib id*/
$sql = 'SELECT own.EXT_OWNERSHIP_ID, own.HOLDINGS_ID,
ot.TYPE_OWNERSHIP_NM,
own.ORD, own.TEXT,
CONCAT_WS(\';\', (SELECT note.NOTE
from ole_ds_ext_ownership_note_t note
where note.EXT_OWNERSHIP_ID = own.EXT_OWNERSHIP_ID
and note.TYPE = \'public\'
)) AS note
FROM ole_ds_ext_ownership_t own
JOIN ole_ds_holdings_t h ON own.HOLDINGS_ID = h.HOLDINGS_ID
LEFT JOIN ole_cat_type_ownership_t ot ON own.EXT_OWNERSHIP_TYPE_ID = ot.TYPE_OWNERSHIP_ID
WHERE h.STAFF_ONLY = "N"
AND h.BIB_ID = :id ORDER BY own.HOLDINGS_ID, ot.TYPE_OWNERSHIP_ID, own.ORD';
try {
/*Query the database*/
$stmt = $this->db->prepare($sql);
$stmt->execute(array(':id' => $id));
/*Return array*/
$summaryHoldings = array();
while ($row = $stmt->fetch()) {
//print_r($row);
$summary = array();
if ($holdingId == $row['HOLDINGS_ID']) {
//Convienence variables
$summaryType = $row['TYPE_OWNERSHIP_NM'];
$summary['id'] = $id;
$summary['location'] = $location;
//$summary['notes'] = array($summary->note[0]->value);
//$summary['summary'] = array($summary->textualHoldings);
$summary['libraryHas'] = ($summaryType == 'Basic Bibliographic Unit' ? array($row['TEXT'], $row['note']) : null);
$summary['indexes'] = ($summaryType == 'Indexes' ? array($row['TEXT'], $row['note']) : null);
$summary['supplements'] = ($summaryType == 'Supplementary Material' ? array($row['TEXT'], $row['note']) : null);
$summary['availability'] = true;
$summary['status'] = '';
$summary['is_holdable'] = true;
}
if (!empty($summary)) {
$summaryHoldings[] = $summary;
}
}
}
catch (Exception $e){
/*Do nothing*/
}
//var_dump($summaryHoldings);