Make item_cancelled respect no_item_agency_holds
[sitka/iNCIPit.git] / iNCIPit.cgi
1 #! /usr/bin/perl 
2
3 #
4 # Copyleft 2014 Jon Scott <mr.jonathon.scott@gmail.com> 
5 # Copyleft 2014 Mark Cooper <mark.c.cooper@outlook.com> 
6 # Copyright 2012-2013 Midwest Consortium for Library Services
7 # Copyright 2013 Calvin College
8 #     contact Dan Wells <dbw2@calvin.edu>
9 # Copyright 2013 Traverse Area District Library,
10 #     contact Jeff Godin <jgodin@tadl.org>
11 #
12 #
13 # This code incorporates code (with modifications) from issa, "a small
14 # command-line client to OpenILS/Evergreen". issa is licensed GPLv2 or (at your
15 # option) any later version of the GPL.
16 #
17 # issa is copyright:
18 #
19 # Copyright 2011 Jason J.A. Stephenson <jason@sigio.com>
20 # Portions Copyright 2012 Merrimack Valley Library Consortium
21 # <jstephenson@mvlc.org>
22 #
23 #
24 # This file is part of iNCIPit
25 #
26 # iNCIPit is free software: you can redistribute it and/or modify it
27 # under the terms of the GNU General Public License as published by
28 # the Free Software Foundation, either version 2 of the License, or
29 # (at your option) any later version.
30 #
31 # iNCIPit is distributed in the hope that it will be useful, but WITHOUT
32 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
33 # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
34 # License for more details.
35 #
36 # You should have received a copy of the GNU General Public License
37 # along with iNCIPit. If not, see <http://www.gnu.org/licenses/>.
38
39 use warnings;
40 use strict;
41 use XML::LibXML;
42 use XML::LibXML::ErrNo;
43 use CGI;
44 use HTML::Entities;
45 use CGI::Carp;
46 use OpenSRF::System;
47 use OpenSRF::Utils::SettingsClient;
48 use Digest::MD5 qw/md5_hex/;
49 use OpenILS::Utils::Fieldmapper;
50 use OpenILS::Utils::CStoreEditor qw/:funcs/;
51 use OpenILS::Const qw/:const/;
52 use Scalar::Util qw(reftype blessed);
53 use MARC::Record;
54 use MARC::Field;
55 use MARC::File::XML;
56 use POSIX qw/strftime/;
57 use DateTime;
58 use Config::Tiny;
59
60 my $U = "OpenILS::Application::AppUtils";
61
62 my $cgi = CGI->new();
63 my $xml = $cgi->param('POSTDATA');# || $cgi->param('XForms:Model');
64 my $host = $cgi->url(-base=>1);
65 my $hostname = (split "/", $host)[2]; # base hostname i.e. www.example.org
66 my $conffile = "$hostname.ini"; # hostname specific ini file i.e. www.example.org.ini
67 my $conf;
68
69 # attempt to load configuration file using matching request hostname, fallback to default
70 if (-e $conffile) {
71         $conf = load_config($conffile);
72 } else {
73         $conffile = "iNCIPit.ini";
74         $conf = load_config($conffile);
75 }
76
77 # Set some variables from config (or defaults)
78
79 # Default patron_identifier type is barcode
80 my $patron_id_type = "barcode";
81
82 # if the config specifies a patron_identifier type
83 if (my $conf_patron_id_type = $conf->{behavior}->{patron_identifier}) {
84     # and that patron_identifier type is known
85     if ($conf_patron_id_type =~ m/(barcode|id)/) {
86         # override the default with the value from the config
87         $patron_id_type = $conf_patron_id_type;
88     }
89 }
90
91 # reject non-https access unless configured otherwise
92 unless ($conf->{access}->{permit_plaintext} =~ m/^yes$/i) {
93     unless (defined($ENV{HTTPS}) && $ENV{HTTPS} eq 'on') {
94         print "Content-type: text/plain\n\n";
95         print "Access denied.\n";
96         exit 0;
97     }
98 }
99
100 # TODO: support for multiple load balancer IPs
101 my $lb_ip = $conf->{access}->{load_balancer_ip};
102
103 # if we are behind a load balancer, check to see that the
104 # actual client IP is permitted
105 if ($lb_ip) {
106     my @allowed_ips = split(/ *, */, $conf->{access}->{allowed_client_ips});
107
108     my $forwarded = $ENV{HTTP_X_FORWARDED_FOR};
109     my $ok = 0;
110
111     foreach my $check_ip (@allowed_ips) {
112         $ok = 1 if ($check_ip eq $forwarded);
113     }
114
115     # if we have a load balancer IP and are relying on
116     # X-Forwarded-For, deny requests other than those
117     # from the load balancer
118     # TODO: support for chained X-Forwarded-For -- ignore all but last
119     unless ($ok && $ENV{REMOTE_ADDR} eq $lb_ip) {
120         print "Content-type: text/plain\n\n";
121         print "Access denied.\n";
122         exit 0;
123     }
124 }
125
126
127 # log request hostname, configuration file used and posted data
128 # XXX: posted ncip message log filename should be in config.
129 open (POST_DATA, ">>post_data.txt") or die "Cannot write post_data.txt";
130 print POST_DATA "INCOMING REQUEST\t$hostname\n";
131 print POST_DATA "CONFIGURATION FILE\t$conffile\n";
132 print POST_DATA "$xml\n";
133 close POST_DATA;
134
135 # initialize the parser
136 my $parser = new XML::LibXML;
137 my $doc;
138
139 # Attempt to parse XML without any modification
140 eval {
141     $doc = $parser->load_xml( string => $xml );
142 };
143
144 # Attempt to gracefully handle invalid XML, including mitigations for known common issues.
145 if ($@ && ref($@) ne 'XML::LibXML::Error') {
146     # We received an error, but it was not a LibXML error object
147     fail("Unknown error parsing XML: $@");
148 } elsif ($@) {
149     # We received an error in the form of a LibXML error object
150
151     my $warning = sprintf("Unable to parse XML on the first try. LibXML error code: %s, message: %s", $@->code(), $@->message());
152     warn $warning;
153
154     # If the error was ERR_INVALID_CHAR, attempt to modify XML and try again
155     if ($@->code() == XML::LibXML::ErrNo::ERR_INVALID_CHAR) {
156
157         warn "Attempting to de-mangle by removing known invalid character(s).\n";
158
159         # This is based on actual invalid XML encountered in the wild
160         # in an INN-REACH environment.
161         $xml =~ s/\x04//g; # Remove ^D from xml
162
163         # Attempt to re-parse after de-mangling
164         eval {
165             $doc = $parser->load_xml( string => $xml );
166         };
167
168         if ($@ && ref($@) ne 'XML::LibXML::Error') {
169             # We received an error, but it was not a LibXML error object
170             fail("Unknown error parsing XML on second attempt: $@");
171         } elsif ($@) {
172             # We received an error in the form of a LibXML error object
173             my $error = sprintf("Unable to parse XML even after de-mangling. LibXML error code: %s, message: %s", $@->code(), $@->message());
174             fail($error);
175         }
176         warn "Success parsing XML after de-mangling.\n";
177     } else {
178         # This is not an error that we know how to recover from
179         fail("No known workaround for this error. Giving up.") unless $doc;
180     }
181 }
182
183 fail("XML parsing did not result in a document.") unless $doc && ref($doc) eq 'XML::LibXML::Document';
184
185 my %session = login();
186
187 if ( defined( $session{authtoken} ) ) {
188     $doc->exists('/NCIPMessage/LookupUser')           ? lookupUser()       : (
189     $doc->exists('/NCIPMessage/ItemRequested')        ? item_request()     : (
190     $doc->exists('/NCIPMessage/ItemShipped')          ? item_shipped()     : (
191     $doc->exists('/NCIPMessage/ItemCheckedOut')       ? item_checked_out() : (
192     $doc->exists('/NCIPMessage/CheckOutItem')         ? check_out_item()   : (
193     $doc->exists('/NCIPMessage/ItemCheckedIn')        ? item_checked_in()  : (
194     $doc->exists('/NCIPMessage/CheckInItem')          ? check_in_item()    : (
195     $doc->exists('/NCIPMessage/ItemReceived')         ? item_received()    : (
196     $doc->exists('/NCIPMessage/AcceptItem')           ? accept_item()      : (
197     $doc->exists('/NCIPMessage/ItemRequestCancelled') ? item_cancelled()   : (
198     $doc->exists('/NCIPMessage/ItemRenewed')          ? item_renew()       : (
199     $doc->exists('/NCIPMessage/RenewItem')            ? renew_item()       :
200     fail("UNKNOWN NCIPMessage")
201     )))))))))));
202
203     logout();
204 } else {
205     fail("Unable to perform action : Unknown Service Request");
206 }
207
208 # load and parse config file
209 sub load_config {
210     my $file = shift;
211
212     my $Config = Config::Tiny->new;
213     $Config = Config::Tiny->read( $file ) ||
214         die( "Error reading config file ", $file, ": ", Config::Tiny->errstr, "\n" );
215     return $Config;
216 }
217
218 # load and parse userpriv_map file, returning a hashref
219 sub load_map_file {
220     my $filename = shift;
221     my $map = {};
222     if (open(my $fh, "<", $filename)) {
223         while (my $entry = <$fh>) {
224             chomp($entry);
225             my ($from, $to) = split(m/:/, $entry);
226             $map->{$from} = $to;
227         }
228         close $fh;
229     }
230     return $map;
231 }
232
233 sub lookup_userpriv {
234     my $input = shift;
235     my $map = shift;
236     if (defined($map->{$input})) { # if we have a mapping for this profile
237         return $map->{$input}; # return value from mapping hash
238     } else {
239         return $input; # return original value
240     }
241 }
242
243 sub lookup_pickup_lib {
244     my $input = shift;
245     my $map = shift;
246     if (defined($map->{$input})) { # if we found this pickup lib
247         return $map->{$input}; # return value from mapping hash
248     } else {
249         return undef; # the original value does us no good -- return undef
250     }
251 }
252
253 sub logit {
254     my ( $msg, $func, $more_info ) = @_;
255     open (RESP_DATA, ">>resp_data.txt") or die "Cannot write resp_data.txt";
256     print RESP_DATA $msg;
257     print RESP_DATA $more_info unless !$more_info;
258     close RESP_DATA;
259     print $msg || fail($func);
260 }
261
262 sub staff_log {
263     my ( $taiv, $faiv, $more_info ) = @_;
264     my $now = localtime();
265     open (STAFF_LOG, ">>staff_data.csv") or die "Cannot write staff_data.csv";
266     print STAFF_LOG "$now, $faiv, $taiv, $more_info\n";
267     close STAFF_LOG;
268 }
269
270 sub item_renew {
271     my $faidSchemeX = $doc->findvalue('/NCIPMessage/ItemRenewed/InitiationHeader/FromAgencyId/UniqueAgencyId/Scheme');
272     my $faidScheme = HTML::Entities::encode($faidSchemeX);
273     my $faidValue  = $doc->find('/NCIPMessage/ItemRenewed/InitiationHeader/FromAgencyId/UniqueAgencyId/Value');
274     my $taidSchemeX = $doc->findvalue('/NCIPMessage/ItemRenewed/InitiationHeader/ToAgencyId/UniqueAgencyId/Scheme');
275     my $taidScheme = HTML::Entities::encode($taidSchemeX);
276     my $taidValue  = $doc->find('/NCIPMessage/ItemRenewed/InitiationHeader/ToAgencyId/UniqueAgencyId/Value');
277
278     my $pid = $doc->findvalue('/NCIPMessage/ItemRenewed/UniqueUserId/UserIdentifierValue');
279     my $visid = $doc->findvalue('/NCIPMessage/ItemRenewed/ItemOptionalFields/ItemDescription/VisibleItemId/VisibleItemIdentifier') . $faidValue;
280     my $due_date = $doc->findvalue('/NCIPMessage/ItemRenewed/DateDue');
281
282     my $r = renewal( $visid, $due_date );
283
284     my $hd = <<ITEMRENEWAL;
285 Content-type: text/xml
286
287
288 <!DOCTYPE NCIPMessage PUBLIC "-//NISO//NCIP DTD Version 1.0//EN" "http://www.niso.org/ncip/v1_0/imp1/dtd/ncip_v1_0.dtd">
289 <NCIPMessage version="http://www.niso.org/ncip/v1_0/imp1/dtd/ncip_v1_0.dtd">
290     <ItemRenewedResponse>
291         <ResponseHeader>
292             <FromAgencyId>
293                 <UniqueAgencyId>
294                     <Scheme>$faidScheme</Scheme>
295                     <Value>$faidValue</Value>
296                 </UniqueAgencyId>
297             </FromAgencyId>
298             <ToAgencyId>
299                 <UniqueAgencyId>
300                     <Scheme>$taidScheme</Scheme>
301                     <Value>$taidValue</Value>
302                 </UniqueAgencyId>
303             </ToAgencyId>
304         </ResponseHeader>
305         <UniqueItemId>
306             <ItemIdentifierValue datatype="string">$visid</ItemIdentifierValue>
307         </UniqueItemId>
308     </ItemRenewedResponse>
309 </NCIPMessage> 
310
311 ITEMRENEWAL
312
313     my $more_info = <<MOREINFO;
314
315 VISID             = $visid
316 Desired Due Date     = $due_date
317
318 MOREINFO
319
320     logit( $hd, ( caller(0) )[3], $more_info );
321     staff_log( $taidValue, $faidValue,
322             "ItemRenewal -> Patronid : "
323           . $pid
324           . " | Visid : "
325           . $visid
326           . " | Due Date : "
327           . $due_date );
328 }
329
330 sub renew_item {
331     my $faidSchemeX = $doc->findvalue('/NCIPMessage/RenewItem/InitiationHeader/FromAgencyId/UniqueAgencyId/Scheme');
332     my $faidScheme = HTML::Entities::encode($faidSchemeX);
333     my $faidValue  = $doc->find('/NCIPMessage/RenewItem/InitiationHeader/FromAgencyId/UniqueAgencyId/Value');
334     my $taidSchemeX = $doc->findvalue('/NCIPMessage/RenewItem/InitiationHeader/ToAgencyId/UniqueAgencyId/Scheme');
335     my $taidScheme = HTML::Entities::encode($taidSchemeX);
336     my $taidValue  = $doc->find('/NCIPMessage/RenewItem/InitiationHeader/ToAgencyId/UniqueAgencyId/Value');
337
338     my $pid = $doc->findvalue('/NCIPMessage/RenewItem/UniqueUserId/UserIdentifierValue');
339     my $unique_item_id = $doc->findvalue('/NCIPMessage/RenewItem/UniqueItemId/ItemIdentifierValue');
340     my $due_date = $doc->findvalue('/NCIPMessage/RenewItem/DesiredDateDue');
341
342     # we are using the UniqueItemId value as a barcode here
343     my $r = renewal( $unique_item_id, $due_date );
344
345     my $hd = <<ITEMRENEWAL;
346 Content-type: text/xml
347
348
349 <!DOCTYPE NCIPMessage PUBLIC "-//NISO//NCIP DTD Version 1.0//EN" "http://www.niso.org/ncip/v1_0/imp1/dtd/ncip_v1_0.dtd">
350 <NCIPMessage version="http://www.niso.org/ncip/v1_0/imp1/dtd/ncip_v1_0.dtd">
351     <RenewItemResponse>
352         <ResponseHeader>
353             <FromAgencyId>
354                 <UniqueAgencyId>
355                     <Scheme>$faidScheme</Scheme>
356                     <Value>$faidValue</Value>
357                 </UniqueAgencyId>
358             </FromAgencyId>
359             <ToAgencyId>
360                 <UniqueAgencyId>
361                     <Scheme>$taidScheme</Scheme>
362                     <Value>$taidValue</Value>
363                 </UniqueAgencyId>
364             </ToAgencyId>
365         </ResponseHeader>
366         <UniqueItemId>
367             <ItemIdentifierValue datatype="string">$unique_item_id</ItemIdentifierValue>
368         </UniqueItemId>
369     </RenewItemResponse>
370 </NCIPMessage> 
371
372 ITEMRENEWAL
373
374     my $more_info = <<MOREINFO;
375
376 UNIQUEID             = $unique_item_id
377 Desired Due Date     = $due_date
378
379 MOREINFO
380
381     logit( $hd, ( caller(0) )[3], $more_info );
382     staff_log( $taidValue, $faidValue,
383             "RenewItem -> Patronid : "
384           . $pid
385           . " | Uniqueid: : "
386           . $unique_item_id
387           . " | Due Date : "
388           . $due_date );
389 }
390
391 sub accept_item {
392     my $faidSchemeX = $doc->findvalue('/NCIPMessage/AcceptItem/InitiationHeader/FromAgencyId/UniqueAgencyId/Scheme');
393     my $faidScheme = HTML::Entities::encode($faidSchemeX);
394     my $faidValue  = $doc->find('/NCIPMessage/AcceptItem/InitiationHeader/FromAgencyId/UniqueAgencyId/Value');
395     my $taidSchemeX = $doc->findvalue('/NCIPMessage/AcceptItem/InitiationHeader/ToAgencyId/UniqueAgencyId/Scheme');
396     my $taidScheme = HTML::Entities::encode($taidSchemeX);
397     my $taidValue  = $doc->find('/NCIPMessage/AcceptItem/InitiationHeader/ToAgencyId/UniqueAgencyId/Value');
398     my $visid = $doc->findvalue('/NCIPMessage/AcceptItem/ItemOptionalFields/ItemDescription/VisibleItemId/VisibleItemIdentifier') . $faidValue;
399     my $request_id = $doc->findvalue('/NCIPMessage/AcceptItem/UniqueRequestId/RequestIdentifierValue') || "unknown";
400     my $patron = $doc->findvalue('/NCIPMessage/AcceptItem/UserOptionalFields/VisibleUserId/VisibleUserIdentifier');
401     my $copy = copy_from_barcode($visid);
402     fail( "accept_item: " . $copy->{textcode} . " $visid" ) unless ( blessed $copy);
403     my $r2 = update_copy( $copy, $conf->{status}->{hold} ); # put into INN-Reach Hold status
404     # We need to find the hold to know the pickup location
405     my $hold = find_hold_on_copy($visid);
406     if (defined $hold && blessed($hold)) {
407         # Check the copy in to capture for hold -- do it at the pickup_lib
408         # so that the hold becomes Available
409         my $checkin_result = checkin_accept($copy->id, $hold->pickup_lib);
410     } else {
411         fail( "accept_item: no hold found for visid " . $visid );
412     }
413
414     my $hd = <<ACCEPTITEM;
415 Content-type: text/xml
416
417
418 <!DOCTYPE NCIPMessage PUBLIC "-//NISO//NCIP DTD Version 1.0//EN" "http://www.niso.org/ncip/v1_0/imp1/dtd/ncip_v1_0.dtd">
419 <NCIPMessage version="http://www.niso.org/ncip/v1_0/imp1/dtd/ncip_v1_0.dtd">
420     <AcceptItemResponse>
421         <ResponseHeader>
422             <FromAgencyId>
423                 <UniqueAgencyId>
424                     <Scheme>$faidScheme</Scheme>
425                     <Value>$faidValue</Value>
426                 </UniqueAgencyId>
427             </FromAgencyId>
428             <ToAgencyId>
429                 <UniqueAgencyId>
430                     <Scheme>$taidScheme</Scheme>
431                     <Value>$taidValue</Value>
432                 </UniqueAgencyId>
433             </ToAgencyId>
434         </ResponseHeader>
435     <UniqueRequestId>
436             <ItemIdentifierValue datatype="string">$request_id</ItemIdentifierValue>
437         </UniqueRequestId>
438         <UniqueItemId>
439             <ItemIdentifierValue datatype="string">$visid</ItemIdentifierValue>
440         </UniqueItemId>
441     </AcceptItemResponse>
442 </NCIPMessage> 
443
444 ACCEPTITEM
445
446     logit( $hd, ( caller(0) )[3] );
447     staff_log( $taidValue, $faidValue,
448         "AcceptItem -> Request Id : " . $request_id . " | Patron Id : " . $patron . " | Visible Id :" . $visid );
449 }
450
451 sub item_received {
452     my $faidSchemeX = $doc->findvalue('/NCIPMessage/ItemReceived/InitiationHeader/FromAgencyId/UniqueAgencyId/Scheme');
453     my $faidScheme = HTML::Entities::encode($faidSchemeX);
454     my $faidValue = $doc->find('/NCIPMessage/ItemReceived/InitiationHeader/FromAgencyId/UniqueAgencyId/Value');
455     my $taidSchemeX = $doc->findvalue('/NCIPMessage/ItemReceived/InitiationHeader/ToAgencyId/UniqueAgencyId/Scheme');
456     my $taidScheme = HTML::Entities::encode($taidSchemeX);
457     my $taidValue  = $doc->find('/NCIPMessage/ItemReceived/InitiationHeader/ToAgencyId/UniqueAgencyId/Value');
458     my $visid = $doc->findvalue('/NCIPMessage/ItemReceived/ItemOptionalFields/ItemDescription/VisibleItemId/VisibleItemIdentifier') . $faidValue;
459     my $copy = copy_from_barcode($visid);
460     fail( $copy->{textcode} . " $visid" ) unless ( blessed $copy);
461     my $r1 = checkin($visid) if ( $copy->status == OILS_COPY_STATUS_CHECKED_OUT ); # checkin the item before delete if ItemCheckedIn step was skipped
462     my $r2 = delete_copy($copy);
463
464     my $hd = <<ITEMRECEIVED;
465 Content-type: text/xml
466
467
468 <!DOCTYPE NCIPMessage PUBLIC "-//NISO//NCIP DTD Version 1.0//EN" "http://www.niso.org/ncip/v1_0/imp1/dtd/ncip_v1_0.dtd">
469 <NCIPMessage version="http://www.niso.org/ncip/v1_0/imp1/dtd/ncip_v1_0.dtd">
470     <ItemReceivedResponse>
471         <ResponseHeader>
472             <FromAgencyId>
473                 <UniqueAgencyId>
474                     <Scheme>$faidScheme</Scheme>
475                     <Value>$faidValue</Value>
476                 </UniqueAgencyId>
477             </FromAgencyId>
478             <ToAgencyId>
479                 <UniqueAgencyId>
480                     <Scheme>$taidScheme</Scheme>
481                     <Value>$taidValue</Value>
482                 </UniqueAgencyId>
483             </ToAgencyId>
484         </ResponseHeader>
485         <UniqueItemId>
486             <ItemIdentifierValue datatype="string">$visid</ItemIdentifierValue>
487         </UniqueItemId>
488     </ItemReceivedResponse>
489 </NCIPMessage> 
490
491 ITEMRECEIVED
492
493     logit( $hd, ( caller(0) )[3] );
494     staff_log( $taidValue, $faidValue, "ItemReceived -> Visible ID : " . $visid );
495 }
496
497 sub item_cancelled {
498     my $faidSchemeX = $doc->findvalue('/NCIPMessage/ItemRequestCancelled/InitiationHeader/FromAgencyId/UniqueAgencyId/Scheme');
499     my $faidScheme = HTML::Entities::encode($faidSchemeX);
500     my $faidValue  = $doc->find('/NCIPMessage/ItemRequestCancelled/InitiationHeader/FromAgencyId/UniqueAgencyId/Value');
501
502     my $taidSchemeX = $doc->findvalue('/NCIPMessage/ItemRequestCancelled/InitiationHeader/ToAgencyId/UniqueAgencyId/Scheme');
503     my $taidScheme = HTML::Entities::encode($taidSchemeX);
504     my $taidValue  = $doc->find('/NCIPMessage/ItemRequestCancelled/InitiationHeader/ToAgencyId/UniqueAgencyId/Value');
505     my $UniqueItemIdAgencyIdValue = $doc->findvalue('/NCIPMessage/ItemRequestCancelled/UniqueItemId/UniqueAgencyId/Value');
506
507     my $barcode = $doc->findvalue('/NCIPMessage/ItemRequestCancelled/UniqueItemId/ItemIdentifierValue');
508
509     if ( $barcode =~ /^i/ ) {    # delete copy only if barcode is an iNUMBER
510         # we are the user agency
511         $barcode .= $faidValue;
512         my $copy = copy_from_barcode($barcode);
513         fail( $copy->{textcode} . " $barcode" ) unless ( blessed $copy);
514         my $r = delete_copy($copy);
515     } else {
516         # we are the item agency
517         unless ( $conf->{behavior}->{no_item_agency_holds} =~ m/^y/i ) {
518             # remove hold!
519             my $r = cancel_hold($barcode);
520             # TODO: check for any errors or unexpected return values in $r
521             my $copy = copy_from_barcode($barcode);
522             fail( $copy->{textcode} . " $barcode" ) unless ( blessed $copy);
523             $r = update_copy( $copy, 7 ); # set to reshelving (for wiggle room)
524             # TODO: check for any errors or unexpected return values in $r
525             #
526             # XXX other options here could be:
527             # - Set to 'available' (it is probably still on the shelf, though it might be in the process of being retrieved)
528             # - Use checkin() here instead - This could trigger things we don't want to happen, though the 'noop' flag should catch at least some of that
529             #
530             # Also, presumably they cannot cancel once the item is in transit?  If they can, we'll need more logic to decide what to do here.
531         }
532     }
533
534     my $hd = <<ITEMREQUESTCANCELLED;
535 Content-type: text/xml
536
537
538 <!DOCTYPE NCIPMessage PUBLIC "-//NISO//NCIP DTD Version 1.0//EN" "http://www.niso.org/ncip/v1_0/imp1/dtd/ncip_v1_0.dtd">
539 <NCIPMessage version="http://www.niso.org/ncip/v1_0/imp1/dtd/ncip_v1_0.dtd">
540     <ItemRequestCancelledResponse>
541         <ResponseHeader>
542             <FromAgencyId>
543                 <UniqueAgencyId>
544                     <Scheme>$faidScheme</Scheme>
545                     <Value>$faidValue</Value>
546                 </UniqueAgencyId>
547             </FromAgencyId>
548             <ToAgencyId>
549                 <UniqueAgencyId>
550                     <Scheme>$taidScheme</Scheme>
551                     <Value>$taidValue</Value>
552                 </UniqueAgencyId>
553             </ToAgencyId>
554         </ResponseHeader>
555         <UniqueItemId>
556             <ItemIdentifierValue datatype="string">$barcode</ItemIdentifierValue>
557         </UniqueItemId>
558     </ItemRequestCancelledResponse>
559 </NCIPMessage> 
560
561 ITEMREQUESTCANCELLED
562
563     logit( $hd, ( caller(0) )[3] );
564     staff_log( $taidValue, $faidValue,
565         "ItemRequestCancelled -> Barcode : " . $barcode );
566 }
567
568 sub item_checked_in {
569     my $faidSchemeX = $doc->findvalue('/NCIPMessage/ItemCheckedIn/InitiationHeader/FromAgencyId/UniqueAgencyId/Scheme');
570     my $faidScheme = HTML::Entities::encode($faidSchemeX);
571     my $faidValue  = $doc->find('/NCIPMessage/ItemCheckedIn/InitiationHeader/FromAgencyId/UniqueAgencyId/Value');
572     my $taidSchemeX = $doc->findvalue('/NCIPMessage/ItemCheckedIn/InitiationHeader/ToAgencyId/UniqueAgencyId/Scheme');
573     my $taidScheme = HTML::Entities::encode($taidSchemeX);
574     my $taidValue  = $doc->find('/NCIPMessage/ItemCheckedIn/InitiationHeader/ToAgencyId/UniqueAgencyId/Value');
575
576     my $visid = $doc->findvalue('/NCIPMessage/ItemCheckedIn/ItemOptionalFields/ItemDescription/VisibleItemId/VisibleItemIdentifier') . $faidValue;
577     my $r = checkin($visid);
578     my $copy = copy_from_barcode($visid);
579     fail( $copy->{textcode} . " $visid" ) unless ( blessed $copy);
580     my $r2 = update_copy( $copy, $conf->{status}->{transit_return} ); # "INN-Reach Transit Return" status
581
582     my $hd = <<ITEMCHECKEDIN;
583 Content-type: text/xml
584
585
586 <!DOCTYPE NCIPMessage PUBLIC "-//NISO//NCIP DTD Version 1.0//EN" "http://www.niso.org/ncip/v1_0/imp1/dtd/ncip_v1_0.dtd">
587 <NCIPMessage version="http://www.niso.org/ncip/v1_0/imp1/dtd/ncip_v1_0.dtd">
588     <ItemCheckedInResponse>
589         <ResponseHeader>
590             <FromAgencyId>
591                 <UniqueAgencyId>
592                     <Scheme>$faidScheme</Scheme>
593                     <Value>$faidValue</Value>
594                 </UniqueAgencyId>
595             </FromAgencyId>
596             <ToAgencyId>
597                 <UniqueAgencyId>
598                     <Scheme>$taidScheme</Scheme>
599                     <Value>$taidValue</Value>
600                 </UniqueAgencyId>
601             </ToAgencyId>
602         </ResponseHeader>
603         <UniqueItemId>
604             <ItemIdentifierValue datatype="string">$visid</ItemIdentifierValue>
605         </UniqueItemId>
606     </ItemCheckedInResponse>
607 </NCIPMessage> 
608
609 ITEMCHECKEDIN
610
611     logit( $hd, ( caller(0) )[3] );
612     staff_log( $taidValue, $faidValue, "ItemCheckedIn -> Visible ID : " . $visid );
613 }
614
615 sub item_checked_out {
616     my $faidSchemeX = $doc->findvalue('/NCIPMessage/ItemCheckedOut/InitiationHeader/FromAgencyId/UniqueAgencyId/Scheme');
617     my $faidScheme = HTML::Entities::encode($faidSchemeX);
618     my $faidValue  = $doc->find('/NCIPMessage/ItemCheckedOut/InitiationHeader/FromAgencyId/UniqueAgencyId/Value');
619     my $taidSchemeX = $doc->findvalue('/NCIPMessage/ItemCheckedOut/InitiationHeader/ToAgencyId/UniqueAgencyId/Scheme');
620     my $taidScheme = HTML::Entities::encode($taidSchemeX);
621     my $taidValue  = $doc->find('/NCIPMessage/ItemCheckedOut/InitiationHeader/ToAgencyId/UniqueAgencyId/Value');
622
623     my $patron_barcode = $doc->findvalue('/NCIPMessage/ItemCheckedOut/UserOptionalFields/VisibleUserId/VisibleUserIdentifier');
624     my $due_date = $doc->findvalue('/NCIPMessage/ItemCheckedOut/DateDue');
625     my $visid = $doc->findvalue('/NCIPMessage/ItemCheckedOut/ItemOptionalFields/ItemDescription/VisibleItemId/VisibleItemIdentifier') . $faidValue;
626
627     my $copy = copy_from_barcode($visid);
628     fail( $copy->{textcode} . " $visid" ) unless ( blessed $copy);
629     my $r = update_copy( $copy, 0 ); # seemed like copy had to be available before it could be checked out, so ...
630     my $r1 = checkin($visid) if ( $copy->status == OILS_COPY_STATUS_CHECKED_OUT ); # double posted itemcheckedout messages cause error ... trying to simplify
631     my $r2 = checkout( $visid, $patron_barcode, $due_date );
632
633     my $hd = <<ITEMCHECKEDOUT;
634 Content-type: text/xml
635
636
637 <!DOCTYPE NCIPMessage PUBLIC "-//NISO//NCIP DTD Version 1.0//EN" "http://www.niso.org/ncip/v1_0/imp1/dtd/ncip_v1_0.dtd">
638 <NCIPMessage version="http://www.niso.org/ncip/v1_0/imp1/dtd/ncip_v1_0.dtd">
639     <ItemCheckedOutResponse>
640         <ResponseHeader>
641             <FromAgencyId>
642                 <UniqueAgencyId>
643                     <Scheme>$faidScheme</Scheme>
644                     <Value>$faidValue</Value>
645                 </UniqueAgencyId>
646             </FromAgencyId>
647             <ToAgencyId>
648                 <UniqueAgencyId>
649                     <Scheme>$taidScheme</Scheme>
650                     <Value>$taidValue</Value>
651                 </UniqueAgencyId>
652             </ToAgencyId>
653         </ResponseHeader>
654         <UniqueItemId>
655             <ItemIdentifierValue datatype="string">$visid</ItemIdentifierValue>
656         </UniqueItemId>
657     </ItemCheckedOutResponse>
658 </NCIPMessage> 
659
660 ITEMCHECKEDOUT
661
662     logit( $hd, ( caller(0) )[3] );
663     staff_log( $taidValue, $faidValue,
664         "ItemCheckedOut -> Visible Id : " . $visid . " | Patron Barcode : " . $patron_barcode . " | Due Date : " . $due_date );
665 }
666
667 sub check_out_item {
668     my $faidSchemeX = $doc->findvalue('/NCIPMessage/CheckOutItem/InitiationHeader/FromAgencyId/UniqueAgencyId/Scheme');
669     my $faidScheme = HTML::Entities::encode($faidSchemeX);
670     my $faidValue  = $doc->find('/NCIPMessage/CheckOutItem/InitiationHeader/FromAgencyId/UniqueAgencyId/Value');
671     my $taidSchemeX = $doc->findvalue('/NCIPMessage/CheckOutItem/InitiationHeader/ToAgencyId/UniqueAgencyId/Scheme');
672     my $taidScheme = HTML::Entities::encode($taidSchemeX);
673     my $taidValue  = $doc->find('/NCIPMessage/CheckOutItem/InitiationHeader/ToAgencyId/UniqueAgencyId/Value');
674
675     my $mdate = $doc->findvalue('/NCIPMessage/CheckOutItem/MandatedAction/DateEventOccurred');
676     # TODO: look up individual accounts for agencies based on barcode prefix + agency identifier
677     my $patron_barcode = $conf->{checkout}->{institutional_patron}; # patron id if patron_id_as_identifier = yes
678
679     # For CheckOutItem and INN-REACH, this value will correspond with our local barcode
680     my $barcode = $doc->findvalue('/NCIPMessage/CheckOutItem/UniqueItemId/ItemIdentifierValue');
681
682     # TODO: watch for possible real ids here?
683     my $due_date = $doc->findvalue('/NCIPMessage/CheckOutItem/DateDue');
684
685     my $copy = copy_from_barcode($barcode);
686     fail( $copy->{textcode} . " $barcode" ) unless ( blessed $copy);
687
688     my $r2 = checkout( $barcode, $patron_barcode, $due_date );
689
690     # TODO: check for checkout exception (like OPEN_CIRCULATION_EXISTS)
691
692     my $hd = <<CHECKOUTITEM;
693 Content-type: text/xml
694
695
696 <!DOCTYPE NCIPMessage PUBLIC "-//NISO//NCIP DTD Version 1.0//EN" "http://www.niso.org/ncip/v1_0/imp1/dtd/ncip_v1_0.dtd">
697 <NCIPMessage version="http://www.niso.org/ncip/v1_0/imp1/dtd/ncip_v1_0.dtd">
698     <CheckOutItemResponse>
699         <ResponseHeader>
700             <FromAgencyId>
701                 <UniqueAgencyId>
702                     <Scheme>$faidScheme</Scheme>
703                     <Value>$faidValue</Value>
704                 </UniqueAgencyId>
705             </FromAgencyId>
706             <ToAgencyId>
707                 <UniqueAgencyId>
708                     <Scheme>$taidScheme</Scheme>
709                     <Value>$taidValue</Value>
710                 </UniqueAgencyId>
711             </ToAgencyId>
712         </ResponseHeader>
713         <UniqueItemId>
714             <ItemIdentifierValue datatype="string">$barcode</ItemIdentifierValue>
715         </UniqueItemId>
716     </CheckOutItemResponse>
717 </NCIPMessage> 
718
719 CHECKOUTITEM
720
721     logit( $hd, ( caller(0) )[3] );
722     staff_log( $taidValue, $faidValue,
723         "CheckOutItem -> Barcode : " . $barcode . " | Patron Barcode : " . $patron_barcode . " | Due Date : " . $due_date );
724 }
725
726 sub check_in_item {
727     my $faidSchemeX = $doc->findvalue('/NCIPMessage/CheckInItem/InitiationHeader/FromAgencyId/UniqueAgencyId/Scheme');
728     my $faidScheme = HTML::Entities::encode($faidSchemeX);
729     my $faidValue  = $doc->find('/NCIPMessage/CheckInItem/InitiationHeader/FromAgencyId/UniqueAgencyId/Value');
730     my $taidSchemeX = $doc->findvalue('/NCIPMessage/CheckInItem/InitiationHeader/ToAgencyId/UniqueAgencyId/Scheme');
731     my $taidScheme = HTML::Entities::encode($taidSchemeX);
732     my $taidValue  = $doc->find('/NCIPMessage/CheckInItem/InitiationHeader/ToAgencyId/UniqueAgencyId/Value');
733
734     # For CheckInItem and INN-REACH, this value will correspond with our local barcode
735     my $barcode = $doc->findvalue('/NCIPMessage/CheckInItem/UniqueItemId/ItemIdentifierValue');
736     my $r = checkin($barcode, 1);
737     fail($r) if $r =~ /^COPY_NOT_CHECKED_OUT/;
738     # TODO: do we need to do these next steps?  checkin() should handle everything, and we want this to end up in 'reshelving'.  If we are worried about transits, we should handle (abort) them, not just change the status
739     ##my $copy = copy_from_barcode($barcode);
740     ##fail($copy->{textcode}." $barcode") unless (blessed $copy);
741     ##  my $r2 = update_copy($copy,0); # Available now 
742
743     my $hd = <<CHECKINITEM;
744 Content-type: text/xml
745
746
747 <!DOCTYPE NCIPMessage PUBLIC "-//NISO//NCIP DTD Version 1.0//EN" "http://www.niso.org/ncip/v1_0/imp1/dtd/ncip_v1_0.dtd">
748 <NCIPMessage version="http://www.niso.org/ncip/v1_0/imp1/dtd/ncip_v1_0.dtd">
749     <CheckInItemResponse>
750         <ResponseHeader>
751             <FromAgencyId>
752                 <UniqueAgencyId>
753                     <Scheme>$faidScheme</Scheme>
754                     <Value>$faidValue</Value>
755                 </UniqueAgencyId>
756             </FromAgencyId>
757             <ToAgencyId>
758                 <UniqueAgencyId>
759                     <Scheme>$taidScheme</Scheme>
760                     <Value>$taidValue</Value>
761                 </UniqueAgencyId>
762             </ToAgencyId>
763         </ResponseHeader>
764         <UniqueItemId>
765             <ItemIdentifierValue datatype="string">$barcode</ItemIdentifierValue>
766         </UniqueItemId>
767     </CheckInItemResponse>
768 </NCIPMessage> 
769
770 CHECKINITEM
771
772     logit( $hd, ( caller(0) )[3] );
773     staff_log( $taidValue, $faidValue, "CheckInItem -> Barcode : " . $barcode );
774 }
775
776 sub item_shipped {
777     my $faidSchemeX = $doc->findvalue('/NCIPMessage/ItemShipped/InitiationHeader/FromAgencyId/UniqueAgencyId/Scheme');
778     my $faidScheme = HTML::Entities::encode($faidSchemeX);
779     my $faidValue  = $doc->find('/NCIPMessage/ItemShipped/InitiationHeader/FromAgencyId/UniqueAgencyId/Value');
780     my $taidSchemeX = $doc->findvalue('/NCIPMessage/ItemShipped/InitiationHeader/ToAgencyId/UniqueAgencyId/Scheme');
781     my $taidScheme = HTML::Entities::encode($taidSchemeX);
782     my $taidValue  = $doc->find('/NCIPMessage/ItemShipped/InitiationHeader/ToAgencyId/UniqueAgencyId/Value');
783
784     my $address = $doc->findvalue('/NCIPMessage/ItemShipped/ShippingInformation/PhysicalAddress/UnstructuredAddress/UnstructuredAddressData');
785
786     my $visid = $doc->findvalue('/NCIPMessage/ItemShipped/ItemOptionalFields/ItemDescription/VisibleItemId/VisibleItemIdentifier') . $faidValue;
787     my $barcode = $doc->findvalue('/NCIPMessage/ItemShipped/UniqueItemId/ItemIdentifierValue') . $faidValue;
788     my $title = $doc->findvalue('/NCIPMessage/ItemShipped/ItemOptionalFields/BibliographicDescription/Title');
789     my $callnumber = $doc->findvalue('/NCIPMessage/ItemShipped/ItemOptionalFields/ItemDescription/CallNumber');
790
791     my $copy = copy_from_barcode($barcode);
792
793     fail( $copy->{textcode} . " $barcode" ) unless ( blessed $copy);
794
795     my $pickup_lib;
796
797     if ($address) {
798         my $pickup_lib_map = load_map_file( $conf->{path}->{pickup_lib_map} );
799
800         if ($pickup_lib_map) {
801             $pickup_lib = lookup_pickup_lib($address, $pickup_lib_map);
802         }
803     }
804
805     if ($pickup_lib) {
806         update_hold_pickup($barcode, $pickup_lib);
807     }
808
809     my $r = update_copy_shipped( $copy, $conf->{status}->{transit}, $visid ); # put copy into INN-Reach Transit status & modify barcode = Visid != tempIIIiNumber
810     if ($r ne 'SUCCESS') {
811         fail( $r->{textcode} . ", Barcode: $barcode, Visible ID: $visid" )
812     }
813
814     my $hd = <<ITEMSHIPPED;
815 Content-type: text/xml
816
817
818 <!DOCTYPE NCIPMessage PUBLIC "-//NISO//NCIP DTD Version 1.0//EN" "http://www.niso.org/ncip/v1_0/imp1/dtd/ncip_v1_0.dtd">
819 <NCIPMessage version="http://www.niso.org/ncip/v1_0/imp1/dtd/ncip_v1_0.dtd">
820     <ItemShippedResponse>
821         <ResponseHeader>
822             <FromAgencyId>
823                 <UniqueAgencyId>
824                     <Scheme>$faidScheme</Scheme>
825                     <Value>$faidValue</Value>
826                 </UniqueAgencyId>
827             </FromAgencyId>
828             <ToAgencyId>
829                 <UniqueAgencyId>
830                     <Scheme>$taidScheme</Scheme>
831                     <Value>$taidValue</Value>
832                 </UniqueAgencyId>
833             </ToAgencyId>
834         </ResponseHeader>
835         <UniqueItemId>
836             <ItemIdentifierValue datatype="string">$visid</ItemIdentifierValue>
837         </UniqueItemId>
838     </ItemShippedResponse>
839 </NCIPMessage> 
840
841 ITEMSHIPPED
842
843     logit( $hd, ( caller(0) )[3] );
844     staff_log( $taidValue, $faidValue,
845         "ItemShipped -> Visible Id : " . $visid . " | Barcode : " . $barcode . " | Title : " . $title . " | Call Number : " . $callnumber );
846 }
847
848 sub item_request {
849     my $faidSchemeX = $doc->findvalue('/NCIPMessage/ItemRequested/InitiationHeader/FromAgencyId/UniqueAgencyId/Scheme');
850     my $faidScheme = HTML::Entities::encode($faidSchemeX);
851     my $faidValue  = $doc->find('/NCIPMessage/ItemRequested/InitiationHeader/FromAgencyId/UniqueAgencyId/Value');
852
853     my $taidSchemeX = $doc->findvalue('/NCIPMessage/ItemRequested/InitiationHeader/ToAgencyId/UniqueAgencyId/Scheme');
854     my $taidScheme = HTML::Entities::encode($taidSchemeX);
855     my $taidValue  = $doc->find('/NCIPMessage/ItemRequested/InitiationHeader/ToAgencyId/UniqueAgencyId/Value');
856     my $UniqueItemIdAgencyIdValue = $doc->findvalue('/NCIPMessage/ItemRequested/UniqueItemId/UniqueAgencyId/Value');
857
858     # TODO: should we use the VisibleID for item agency variation of this method call
859
860     my $pid = $doc->findvalue('/NCIPMessage/ItemRequested/UniqueUserId/UserIdentifierValue');
861     my $barcode = $doc->findvalue('/NCIPMessage/ItemRequested/UniqueItemId/ItemIdentifierValue');
862     my $author = $doc->findvalue('/NCIPMessage/ItemRequested/ItemOptionalFields/BibliographicDescription/Author');
863     my $title = $doc->findvalue('/NCIPMessage/ItemRequested/ItemOptionalFields/BibliographicDescription/Title');
864     my $callnumber = $doc->findvalue('/NCIPMessage/ItemRequested/ItemOptionalFields/ItemDescription/CallNumber');
865     my $medium_type = $doc->find('/NCIPMessage/ItemRequested/ItemOptionalFields/BibliographicDescription/MediumType/Value');
866
867     my $r = "default error checking response";
868
869     if ( $barcode =~ /^i/ ) {    # XXX EG is User Agency # create copy only if barcode is an iNUMBER
870         my $copy_status_id = $conf->{status}->{loan_requested}; # INN-Reach Loan Requested - local configured status
871         $barcode .= $faidValue;
872         # we want our custom status to be then end result, so create the copy with status of "Available, then hold it, then update the status
873         $r = create_copy( $title, $callnumber, $barcode, 0, $medium_type );
874         my $copy = copy_from_barcode($barcode);
875         my $r2   = place_simple_hold( $copy->id, $pid );
876         my $r3   = update_copy( $copy, $copy_status_id );
877     } else {    # XXX EG is Item Agency
878         unless ( $conf->{behavior}->{no_item_agency_holds} =~ m/^y/i ) {
879             # place hold for user UniqueUserId/UniqueAgencyId/Value = institution account
880             my $copy = copy_from_barcode($barcode);
881             my $pid2 = 1013459; # XXX CUSTOMIZATION NEEDED XXX # this is the id of a user representing your DCB system, TODO: use agency information to create and link to individual accounts per agency, if needed
882             $r = place_simple_hold( $copy->id, $pid2 );
883             my $r2 = update_copy( $copy, $conf->{status}->{hold} ); # put into INN-Reach Hold status
884         }
885     }
886
887     # Avoid generating invalid XML responses by encoding title/author/callnumber
888     # TODO: Move away from heredocs for generating XML
889         $title      = _naive_encode_xml($title);
890         $author     = _naive_encode_xml($author);
891         $callnumber = _naive_encode_xml($callnumber);
892
893     my $hd = <<ITEMREQ;
894 Content-type: text/xml
895
896
897 <!DOCTYPE NCIPMessage PUBLIC "-//NISO//NCIP DTD Version 1.0//EN" "http://www.niso.org/ncip/v1_0/imp1/dtd/ncip_v1_0.dtd">
898 <NCIPMessage version="http://www.niso.org/ncip/v1_0/imp1/dtd/ncip_v1_0.dtd">
899     <ItemRequestedResponse>
900         <ResponseHeader>
901             <FromAgencyId>
902                 <UniqueAgencyId>
903                     <Scheme>$faidScheme</Scheme>
904                     <Value>$faidValue</Value>
905                 </UniqueAgencyId>
906             </FromAgencyId>
907             <ToAgencyId>
908                 <UniqueAgencyId>
909                     <Scheme>$taidScheme</Scheme>
910                     <Value>$taidValue</Value>
911                 </UniqueAgencyId>
912             </ToAgencyId>
913         </ResponseHeader>
914         <UniqueUserId>
915             <UniqueAgencyId>
916                 <Scheme datatype="string">$taidScheme</Scheme>
917                 <Value datatype="string">$taidValue</Value>
918             </UniqueAgencyId>
919             <UserIdentifierValue datatype="string">$pid</UserIdentifierValue>
920         </UniqueUserId>
921         <UniqueItemId>
922             <ItemIdentifierValue datatype="string">$barcode</ItemIdentifierValue>
923         </UniqueItemId>
924         <ItemOptionalFields>
925             <BibliographicDescription>
926         <Author datatype="string">$author</Author>
927         <Title datatype="string">$title</Title>
928             </BibliographicDescription>
929             <ItemDescription>
930                 <CallNumber datatype="string">$callnumber</CallNumber>
931             </ItemDescription>
932        </ItemOptionalFields>
933     </ItemRequestedResponse>
934 </NCIPMessage> 
935
936 ITEMREQ
937
938     logit( $hd, ( caller(0) )[3] );
939     staff_log( $taidValue, $faidValue,
940         "ItemRequested -> Barcode : " . $barcode . " | Title : " . $title . " | Call Number : " . $callnumber . " | Patronid :" . $pid );
941 }
942
943 sub lookupUser {
944
945     my $faidScheme = $doc->findvalue('/NCIPMessage/LookupUser/InitiationHeader/FromAgencyId/UniqueAgencyId/Scheme');
946     $faidScheme = HTML::Entities::encode($faidScheme);
947     my $faidValue = $doc->find('/NCIPMessage/LookupUser/InitiationHeader/FromAgencyId/UniqueAgencyId/Value');
948     my $taidScheme = $doc->findvalue('/NCIPMessage/LookupUser/InitiationHeader/ToAgencyId/UniqueAgencyId/Scheme');
949     $taidScheme = HTML::Entities::encode($taidScheme);
950
951     my $taidValue = $doc->find('/NCIPMessage/LookupUser/InitiationHeader/ToAgencyId/UniqueAgencyId/Value');
952     my $id = $doc->findvalue('/NCIPMessage/LookupUser/VisibleUserId/VisibleUserIdentifier');
953
954     my $uidValue;
955
956     if ($patron_id_type eq 'barcode') {
957         $uidValue = user_id_from_barcode($id);
958     } else {
959         $uidValue = $id;
960     }
961
962     if ( !defined($uidValue)
963         || ( ref($uidValue) && reftype($uidValue) eq 'HASH' ) )
964     {
965         do_lookup_user_error_stanza("PATRON_NOT_FOUND : $id");
966         die;
967     }
968
969     my ( $propername, $email, $good_until, $userpriv, $block_stanza ) =
970       ( "name here", "", "good until", "", "" );    # defaults
971
972     my $patron = flesh_user($uidValue);
973
974     #if (blessed($patron)) {
975     my $patron_ok = 1;
976     my @penalties = @{ $patron->standing_penalties };
977
978     if ( $patron->deleted eq 't' ) {
979         do_lookup_user_error_stanza("PATRON_DELETED : $uidValue");
980         die;
981     } elsif ( $patron->barred eq 't' ) {
982         do_lookup_user_error_stanza("PATRON_BARRED : $uidValue");
983         die;
984     } elsif ( $patron->active eq 'f' ) {
985         do_lookup_user_error_stanza("PATRON_INACTIVE : $uidValue");
986         die;
987     }
988
989     elsif ( $#penalties > -1 ) {
990
991 #                my $penalty;
992 #                   foreach $penalty (@penalties) {
993 #                    if (defined($penalty->standing_penalty->block_list)) {
994 #                            my @block_list = split(/\|/, $penalty->standing_penalty->block_list);
995 #                            foreach my $block (@block_list) {
996 #                                foreach my $block_on (@$block_types) {
997 #                                    if ($block eq $block_on) {
998 #                                        $block_stanza .= "\n".$penalty->standing_penalty->name;
999 #                                        $patron_ok = 0;
1000 #                                    }
1001 #                                    last unless ($patron_ok);
1002 #                            }
1003 #                                last unless ($patron_ok);
1004 #                          }
1005 #                     }
1006 #                }
1007         $block_stanza = qq(
1008             <BlockOrTrap>
1009                 <UniqueAgencyId>
1010                     <Scheme datatype="string">http://just.testing.now</Scheme>
1011                     <Value datatype="string">$faidValue</Value>
1012                 </UniqueAgencyId>
1013                 <BlockOrTrapType>
1014                     <Scheme datatype="string">http://just.testing.now</Scheme>
1015                     <Value datatype="string">Block Hold</Value>
1016                 </BlockOrTrapType>
1017             </BlockOrTrap>);
1018     }
1019
1020     if ( defined( $patron->email ) && $conf->{behavior}->{omit_patron_email} !~ m/^y/i ) {
1021         $email = qq(
1022             <UserAddressInformation>
1023                 <ElectronicAddress>
1024                     <ElectronicAddressType>
1025                         <Scheme datatype="string">http://testing.now</Scheme>
1026                         <Value datatype="string">mailto</Value>
1027                     </ElectronicAddressType>
1028                     <ElectronicAddressData datatype="string">)
1029           . HTML::Entities::encode( $patron->email )
1030           . qq(</ElectronicAddressData>
1031                 </ElectronicAddress>
1032             </UserAddressInformation>);
1033     }
1034
1035     $propername = $patron->first_given_name . " " . $patron->family_name;
1036     $good_until = $patron->expire_date || "unknown";
1037     $userpriv = $patron->profile->name;
1038
1039     my $userpriv_map = load_map_file( $conf->{path}->{userpriv_map} );
1040
1041     if ($userpriv_map) {
1042         $userpriv = lookup_userpriv($userpriv, $userpriv_map);
1043     }
1044
1045     #} else {
1046     #    do_lookup_user_error_stanza("PATRON_NOT_FOUND : $id");
1047     #    die;
1048     #}
1049     my $uniqid = $patron->id;
1050     my $visid;
1051     if ($patron_id_type eq 'barcode') {
1052         $visid = $patron->card->barcode;
1053     } else {
1054         $visid = $patron->id;
1055     }
1056     my $hd = <<LOOKUPUSERRESPONSE;
1057 Content-type: text/xml
1058
1059
1060 <!DOCTYPE NCIPMessage PUBLIC "-//NISO//NCIP DTD Version 1.0//EN" "http://www.niso.org/ncip/v1_0/imp1/dtd/ncip_v1_0.dtd">
1061 <NCIPMessage version="http://www.niso.org/ncip/v1_0/imp1/dtd/ncip_v1_0.dtd">
1062     <LookupUserResponse>
1063         <ResponseHeader>
1064             <FromAgencyId>
1065                 <UniqueAgencyId>
1066                     <Scheme>$taidScheme</Scheme>
1067                     <Value>$taidValue</Value>
1068                 </UniqueAgencyId>
1069             </FromAgencyId>
1070             <ToAgencyId>
1071                 <UniqueAgencyId>
1072                    <Scheme>$faidScheme</Scheme>
1073                    <Value>$faidValue</Value>
1074                 </UniqueAgencyId>
1075             </ToAgencyId>
1076         </ResponseHeader>
1077         <UniqueUserId>
1078             <UniqueAgencyId>
1079                 <Scheme>$taidScheme</Scheme>
1080                 <Value>$taidValue</Value>
1081             </UniqueAgencyId>
1082             <UserIdentifierValue>$uniqid</UserIdentifierValue>
1083         </UniqueUserId>
1084         <UserOptionalFields>
1085             <VisibleUserId>
1086                 <VisibleUserIdentifierType>
1087                     <Scheme datatype="string">http://blah.com</Scheme>
1088                     <Value datatype="string">Barcode</Value>
1089                 </VisibleUserIdentifierType>
1090                 <VisibleUserIdentifier datatype="string">$visid</VisibleUserIdentifier>
1091             </VisibleUserId>
1092             <NameInformation>
1093                 <PersonalNameInformation>
1094                     <UnstructuredPersonalUserName datatype="string">$propername</UnstructuredPersonalUserName>
1095                 </PersonalNameInformation>
1096             </NameInformation>
1097             <UserPrivilege>
1098                 <UniqueAgencyId>
1099                     <Scheme datatype="string">$faidScheme</Scheme>
1100                     <Value datatype="string">$faidValue</Value>
1101                 </UniqueAgencyId>
1102                 <AgencyUserPrivilegeType>
1103                     <Scheme datatype="string">http://testing.purposes.only</Scheme>
1104                     <Value datatype="string">$userpriv</Value>
1105                 </AgencyUserPrivilegeType>
1106                 <ValidToDate datatype="string">$good_until</ValidToDate>
1107             </UserPrivilege> $email $block_stanza
1108         </UserOptionalFields>
1109    </LookupUserResponse>
1110 </NCIPMessage>
1111
1112 LOOKUPUSERRESPONSE
1113
1114     logit( $hd, ( caller(0) )[3] );
1115     staff_log( $taidValue, $faidValue,
1116             "LookupUser -> Patron Barcode : "
1117           . $id
1118           . " | Patron Id : "
1119           . $uidValue
1120           . " | User Name : "
1121           . $propername
1122           . " | User Priv : "
1123           . $userpriv );
1124 }
1125
1126 sub fail {
1127     my $error_msg =
1128       shift || "THIS IS THE DEFAULT / DO NOT HANG III NCIP RESP MSG";
1129     print "Content-type: text/xml\n\n";
1130
1131     print <<ITEMREQ;
1132 <!DOCTYPE NCIPMessage PUBLIC "-//NISO//NCIP DTD Version 1.0//EN" "http://www.niso.org/ncip/v1_0/imp1/dtd/ncip_v1_0.dtd">
1133 <NCIPMessage version="http://www.niso.org/ncip/v1_0/imp1/dtd/ncip_v1_0.dtd">
1134     <ItemRequestedResponse>
1135         <ResponseHeader>
1136             <FromAgencyId>
1137                 <UniqueAgencyId>
1138                     <Scheme>http://136.181.125.166:6601/IRCIRCD?target=get_scheme_values&amp;scheme=UniqueAgencyId</Scheme>
1139                     <Value></Value>
1140                 </UniqueAgencyId>
1141             </FromAgencyId>
1142             <ToAgencyId>
1143                 <UniqueAgencyId>
1144                     <Scheme>http://136.181.125.166:6601/IRCIRCD?target=get_scheme_values&amp;scheme=UniqueAgencyId</Scheme>
1145                     <Value>$error_msg</Value>
1146                 </UniqueAgencyId>
1147             </ToAgencyId>
1148         </ResponseHeader>
1149     </ItemRequestedResponse>
1150 </NCIPMessage>
1151
1152 ITEMREQ
1153
1154     # XXX: we should log FromAgencyId and ToAgencyId values here, but they are not available to the code at this point
1155     staff_log( '', '',
1156         ( ( caller(0) )[3] . " -> " . $error_msg ) );
1157     die;
1158 }
1159
1160 sub do_lookup_user_error_stanza {
1161
1162     # XXX: we should include FromAgencyId and ToAgencyId values, but they are not available to the code at this point
1163     my $error = shift;
1164     my $hd    = <<LOOKUPPROB;
1165 Content-type: text/xml
1166
1167
1168 <!DOCTYPE NCIPMessage PUBLIC "-//NISO//NCIP DTD Version 1.0//EN" "http://www.niso.org/ncip/v1_0/imp1/dtd/ncip_v1_0.dtd">
1169 <NCIPMessage version="http://www.niso.org/ncip/v1_0/imp1/dtd/ncip_v1_0.dtd">
1170     <LookupUserResponse>
1171         <ResponseHeader>
1172             <FromAgencyId>
1173                 <UniqueAgencyId>
1174                     <Scheme></Scheme>
1175                     <Value></Value>
1176                 </UniqueAgencyId>
1177             </FromAgencyId>
1178             <ToAgencyId>
1179                 <UniqueAgencyId>
1180                     <Scheme></Scheme>
1181                     <Value></Value>
1182                 </UniqueAgencyId>
1183             </ToAgencyId>
1184         </ResponseHeader>
1185         <Problem>
1186             <ProcessingError>
1187                 <ProcessingErrorType>
1188                     <Scheme>http://www.niso.org/ncip/v1_0/schemes/processingerrortype/lookupuserprocessingerror.scm</Scheme>
1189                     <Value>$error</Value>
1190                 </ProcessingErrorType>
1191                 <ProcessingErrorElement>
1192                     <ElementName>AuthenticationInput</ElementName>
1193                 </ProcessingErrorElement>
1194             </ProcessingError>
1195         </Problem>
1196     </LookupUserResponse>
1197 </NCIPMessage>
1198
1199 LOOKUPPROB
1200
1201     logit( $hd, ( caller(0) )[3] );
1202     # XXX: we should log FromAgencyId and ToAgencyId values here, but they are not available to the code at this point
1203     staff_log( '', '', ( ( caller(0) )[3] . " -> " . $error ) );
1204     die;
1205 }
1206
1207 # Login to the OpenSRF system/Evergreen.
1208 #
1209 # Returns a hash with the authtoken, authtime, and expiration (time in
1210 # seconds since 1/1/1970).
1211 sub login {
1212
1213  # XXX: local opensrf core conf filename should be in config.
1214  # XXX: STAFF account with ncip service related permissions should be in config.
1215     my $bootstrap = '/openils/conf/opensrf_core.xml';
1216     my $uname     = $conf->{auth}->{username};
1217     my $password  = $conf->{auth}->{password};
1218
1219     # Bootstrap the client
1220     OpenSRF::System->bootstrap_client( config_file => $bootstrap );
1221     my $idl = OpenSRF::Utils::SettingsClient->new->config_value("IDL");
1222     Fieldmapper->import( IDL => $idl );
1223
1224     # Initialize CStoreEditor:
1225     OpenILS::Utils::CStoreEditor->init;
1226
1227     my $seed = OpenSRF::AppSession->create('open-ils.auth')
1228       ->request( 'open-ils.auth.authenticate.init', $uname )->gather(1);
1229
1230     return undef unless $seed;
1231
1232     my $response = OpenSRF::AppSession->create('open-ils.auth')->request(
1233         'open-ils.auth.authenticate.complete',
1234         {
1235             username => $uname,
1236             password => md5_hex( $seed . md5_hex($password) ),
1237             type     => 'staff'
1238         }
1239     )->gather(1);
1240
1241     return undef unless $response;
1242
1243     my %result;
1244     $result{'authtoken'}  = $response->{payload}->{authtoken};
1245     $result{'authtime'}   = $response->{payload}->{authtime};
1246     $result{'expiration'} = time() + $result{'authtime'}
1247       if ( defined( $result{'authtime'} ) );
1248     return %result;
1249 }
1250
1251 # Check the time versus the session expiration time and login again if
1252 # the session has expired, consequently resetting the session
1253 # paramters. We want to run this before doing anything that requires
1254 # us to have a current session in OpenSRF.
1255 #
1256 # Arguments
1257 # none
1258 #
1259 # Returns
1260 # Nothing
1261 sub check_session_time {
1262     if ( time() > $session{'expiration'} ) {
1263         %session = login();
1264         if ( !%session ) {
1265             die("Failed to reinitialize the session after expiration.");
1266         }
1267     }
1268 }
1269
1270 # Retrieve the logged in user.
1271 #
1272 sub get_session {
1273     my $response =
1274       OpenSRF::AppSession->create('open-ils.auth')
1275       ->request( 'open-ils.auth.session.retrieve', $session{authtoken} )
1276       ->gather(1);
1277     return $response;
1278 }
1279
1280 # Logout/destroy the OpenSRF session
1281 #
1282 # Argument is
1283 # none
1284 #
1285 # Returns
1286 # Does not return anything
1287 sub logout {
1288     if ( time() < $session{'expiration'} ) {
1289         my $response =
1290           OpenSRF::AppSession->create('open-ils.auth')
1291           ->request( 'open-ils.auth.session.delete', $session{authtoken} )
1292           ->gather(1);
1293         if ($response) {
1294
1295             # strong.silent.success
1296             exit(0);
1297         } else {
1298             fail("Logout unsuccessful. Good-bye, anyway.");
1299         }
1300     }
1301 }
1302
1303 sub update_copy {
1304     check_session_time();
1305     my ( $copy, $status_id ) = @_;
1306     my $e = new_editor( authtoken => $session{authtoken} );
1307     return $e->event->{textcode} unless ( $e->checkauth );
1308     $e->xact_begin;
1309     $copy->status($status_id);
1310     return $e->event unless $e->update_asset_copy($copy);
1311     $e->commit;
1312     return 'SUCCESS';
1313 }
1314
1315 # my paranoia re barcode on shipped items using visid for unique value
1316 sub update_copy_shipped {
1317     check_session_time();
1318     my ( $copy, $status_id, $barcode ) = @_;
1319     my $e = new_editor( authtoken => $session{authtoken} );
1320     return $e->event unless ( $e->checkauth );
1321     $e->xact_begin;
1322     $copy->status($status_id);
1323     $copy->barcode($barcode);
1324     return $e->event unless $e->update_asset_copy($copy);
1325     $e->commit;
1326     return 'SUCCESS';
1327 }
1328
1329 # Delete a copy
1330 #
1331 # Argument
1332 # Fieldmapper asset.copy object
1333 #
1334 # Returns
1335 # "SUCCESS" on success
1336 # Event textcode if an error occurs
1337 sub delete_copy {
1338     check_session_time();
1339     my ($copy) = @_;
1340
1341     my $e = new_editor( authtoken => $session{authtoken} );
1342     return $e->event->{textcode} unless ( $e->checkauth );
1343
1344     # Get the calnumber
1345     my $vol = $e->retrieve_asset_call_number( $copy->call_number );
1346     return $e->event->{textcode} unless ($vol);
1347
1348     # Get the biblio.record_entry
1349     my $bre = $e->retrieve_biblio_record_entry( $vol->record );
1350     return $e->event->{textcode} unless ($bre);
1351
1352     # Delete everything in a transaction and rollback if anything fails.
1353     # TODO: I think there is a utility function which handles all this
1354     $e->xact_begin;
1355     my $r;    # To hold results of editor calls
1356     $r = $e->delete_asset_copy($copy);
1357     unless ($r) {
1358         my $lval = $e->event->{textcode};
1359         $e->rollback;
1360         return $lval;
1361     }
1362     my $list =
1363       $e->search_asset_copy( { call_number => $vol->id, deleted => 'f' } );
1364     unless (@$list) {
1365         $r = $e->delete_asset_call_number($vol);
1366         unless ($r) {
1367             my $lval = $e->event->{textcode};
1368             $e->rollback;
1369             return $lval;
1370         }
1371         $list = $e->search_asset_call_number( { record => $bre->id, deleted => 'f' } );
1372         unless (@$list) {
1373             $r = $e->delete_biblio_record_entry($bre);
1374             unless ($r) {
1375                 my $lval = $e->event->{textcode};
1376                 $e->rollback;
1377                 return $lval;
1378             }
1379         }
1380     }
1381     $e->commit;
1382     return 'SUCCESS';
1383 }
1384
1385 # Get asset.copy from asset.copy.barcode.
1386 # Arguments
1387 # copy barcode
1388 #
1389 # Returns
1390 # asset.copy fieldmaper object
1391 # or hash on error
1392 sub copy_from_barcode {
1393     check_session_time();
1394     my ($barcode) = @_;
1395     my $response =
1396       OpenSRF::AppSession->create('open-ils.search')
1397       ->request( 'open-ils.search.asset.copy.find_by_barcode', $barcode )
1398       ->gather(1);
1399     return $response;
1400 }
1401
1402 sub locid_from_barcode {
1403     my ($barcode) = @_;
1404     my $response =
1405       OpenSRF::AppSession->create('open-ils.search')
1406       ->request( 'open-ils.search.biblio.find_by_barcode', $barcode )
1407       ->gather(1);
1408     return $response->{ids}[0];
1409 }
1410
1411 sub bre_id_from_barcode {
1412     check_session_time();
1413     my ($barcode) = @_;
1414     my $response =
1415       OpenSRF::AppSession->create('open-ils.search')
1416       ->request( 'open-ils.search.bib_id.by_barcode', $barcode )
1417       ->gather(1);
1418     return $response;
1419 }
1420
1421 sub holds_for_bre {
1422     check_session_time();
1423     my ($bre_id) = @_;
1424     my $response =
1425       OpenSRF::AppSession->create('open-ils.circ')
1426       ->request( 'open-ils.circ.holds.retrieve_all_from_title', $session{authtoken}, $bre_id )
1427       ->gather(1);
1428     return $response;
1429
1430 }
1431
1432 # Convert a MARC::Record to XML for Evergreen
1433 #
1434 # Copied from Dyrcona's issa framework which copied
1435 # it from MVLC's Safari Load program which copied it
1436 # from some code in the Open-ILS example import scripts.
1437 #
1438 # Argument
1439 # A MARC::Record object
1440 #
1441 # Returns
1442 # String with XML for the MARC::Record as Evergreen likes it
1443 sub convert2marcxml {
1444     my $input = shift;
1445     ( my $xml = $input->as_xml_record() ) =~ s/\n//sog;
1446     $xml =~ s/^<\?xml.+\?\s*>//go;
1447     $xml =~ s/>\s+</></go;
1448     $xml =~ s/\p{Cc}//go;
1449     $xml = $U->entityize($xml);
1450     $xml =~ s/[\x00-\x1f]//go;
1451     return $xml;
1452 }
1453
1454 # Create a copy and marc record
1455 #
1456 # Arguments
1457 # title
1458 # call number
1459 # copy barcode
1460 #
1461 # Returns
1462 # bib id on succes
1463 # event textcode on failure
1464 sub create_copy {
1465     check_session_time();
1466     my ( $title, $callnumber, $barcode, $copy_status_id, $medium_type ) = @_;
1467
1468     my $e = new_editor( authtoken => $session{authtoken} );
1469     return $e->event->{textcode} unless ( $e->checkauth );
1470
1471     my $r = $e->allowed( [ 'CREATE_COPY', 'CREATE_MARC', 'CREATE_VOLUME' ] );
1472     if ( ref($r) eq 'HASH' ) {
1473         return $r->{textcode} . ' ' . $r->{ilsperm};
1474     }
1475
1476     # Check if the barcode exists in asset.copy and bail if it does.
1477     my $list = $e->search_asset_copy( { deleted => 'f', barcode => $barcode } );
1478     if (@$list) {
1479 # in the future, can we update it, if it exists and only if it is an INN-Reach status item ?
1480         $e->finish;
1481         fail( 'BARCODE_EXISTS ! Barcode : ' . $barcode );
1482         die;
1483     }
1484
1485     # Create MARC record
1486     my $record = MARC::Record->new();
1487     $record->encoding('UTF-8');
1488     $record->leader('00881nam a2200193 4500');
1489     my $datespec = strftime( "%Y%m%d%H%M%S.0", localtime );
1490     my @fields = ();
1491     push( @fields, MARC::Field->new( '005', $datespec ) );
1492     push( @fields, MARC::Field->new( '082', '0', '4', 'a' => $callnumber ) );
1493     push( @fields, MARC::Field->new( '245', '0', '0', 'a' => $title ) );
1494     $record->append_fields(@fields);
1495
1496     # Convert the record to XML
1497     my $xml = convert2marcxml($record);
1498
1499     my $bre =
1500       OpenSRF::AppSession->create('open-ils.cat')
1501       ->request( 'open-ils.cat.biblio.record.xml.import',
1502         $session{authtoken}, $xml, 'System Local', 1 )->gather(1);
1503     return $bre->{textcode} if ( ref($bre) eq 'HASH' );
1504
1505     # Create volume record
1506     my $vol =
1507       OpenSRF::AppSession->create('open-ils.cat')
1508       ->request( 'open-ils.cat.call_number.find_or_create', $session{authtoken}, $callnumber, $bre->id, $conf->{volume}->{owning_lib} )
1509       ->gather(1);
1510     return $vol->{textcode} if ( $vol->{textcode} );
1511
1512     # Retrieve the user
1513     my $user = get_session;
1514
1515     # Create copy record
1516     my $copy = Fieldmapper::asset::copy->new();
1517     # XXX CUSTOMIZATION NEEDED XXX
1518     # You will need to either create a circ mod for every expected medium type,
1519     # OR you should create a single circ mod for all requests from the external
1520     # system.
1521     # Adjust these lines as needed.
1522     #    $copy->circ_modifier(qq($medium_type)); # XXX CUSTOMIZATION NEEDED XXX
1523     # OR
1524     $copy->circ_modifier($conf->{copy}->{circ_modifier});
1525     $copy->barcode($barcode);
1526     $copy->call_number( $vol->{acn_id} );
1527     $copy->circ_lib($conf->{copy}->{circ_lib});
1528     $copy->circulate('t');
1529     $copy->holdable('t');
1530     $copy->opac_visible('t');
1531     $copy->deleted('f');
1532     $copy->fine_level(2);
1533     $copy->loan_duration(2);
1534     $copy->location($conf->{copy}->{location});
1535     $copy->status($copy_status_id);
1536     $copy->editor('1');
1537     $copy->creator('1');
1538
1539     $e->xact_begin;
1540     $copy = $e->create_asset_copy($copy);
1541
1542     $e->commit;
1543     return $e->event->{textcode} unless ($r);
1544     return 'SUCCESS';
1545 }
1546
1547 # Checkout a copy to a patron
1548 #
1549 # Arguments
1550 # copy barcode
1551 # patron barcode
1552 #
1553 # Returns
1554 # textcode of the OSRF response.
1555 sub checkout {
1556     check_session_time();
1557     my ( $copy_barcode, $patron_barcode, $due_date ) = @_;
1558
1559     # Check for copy:
1560     my $copy = copy_from_barcode($copy_barcode);
1561     unless ( defined($copy) && blessed($copy) ) {
1562         return 'COPY_BARCODE_NOT_FOUND : ' . $copy_barcode;
1563     }
1564
1565     # Check for user
1566     my $uid;
1567     if ($patron_id_type eq 'barcode') {
1568         $uid = user_id_from_barcode($patron_barcode);
1569     } else {
1570         $uid = $patron_barcode;
1571     }
1572     return 'PATRON_BARCODE_NOT_FOUND : ' . $patron_barcode if ( ref($uid) );
1573
1574     my $response = OpenSRF::AppSession->create('open-ils.circ')->request(
1575         'open-ils.circ.checkout.full.override',
1576         $session{authtoken},
1577         {
1578             copy_barcode => $copy_barcode,
1579             patron_id    => $uid,
1580             due_date     => $due_date
1581         }
1582     )->gather(1);
1583     return $response->{textcode};
1584 }
1585
1586 sub renewal {
1587     check_session_time();
1588     my ( $copy_barcode, $due_date ) = @_;
1589
1590     # Check for copy:
1591     my $copy = copy_from_barcode($copy_barcode);
1592     unless ( defined($copy) && blessed($copy) ) {
1593         return 'COPY_BARCODE_NOT_FOUND : ' . $copy_barcode;
1594     }
1595
1596     my $response = OpenSRF::AppSession->create('open-ils.circ')->request(
1597         'open-ils.circ.renew.override',
1598         $session{authtoken},
1599         {
1600             copy_barcode => $copy_barcode,
1601             due_date     => $due_date
1602         }
1603     )->gather(1);
1604     return $response->{textcode};
1605 }
1606
1607 # Check a copy in
1608 #
1609 # Arguments
1610 # copy barcode
1611 #
1612 # Returns
1613 # "SUCCESS" on success
1614 # textcode of a failed OSRF request
1615 # 'COPY_NOT_CHECKED_OUT' when the copy is not checked out
1616
1617 sub checkin {
1618     check_session_time();
1619     my ($barcode, $noop) = @_;
1620     $noop ||= 0;
1621
1622     my $copy = copy_from_barcode($barcode);
1623     return $copy->{textcode} unless ( blessed $copy);
1624
1625     return ("COPY_NOT_CHECKED_OUT $barcode")
1626       unless ( $copy->status == OILS_COPY_STATUS_CHECKED_OUT );
1627
1628     my $e = new_editor( authtoken => $session{authtoken} );
1629     return $e->event->{textcode} unless ( $e->checkauth );
1630
1631     my $circ = $e->search_action_circulation(
1632         [ { target_copy => $copy->id, xact_finish => undef } ] )->[0];
1633     my $r =
1634       OpenSRF::AppSession->create('open-ils.circ')
1635       ->request( 'open-ils.circ.checkin.override',
1636         $session{authtoken}, { force => 1, copy_id => $copy->id, noop => $noop } )->gather(1);
1637     return 'SUCCESS' if ( $r->{textcode} eq 'ROUTE_ITEM' );
1638     return $r->{textcode};
1639 }
1640
1641 # Check in an copy as part of accept_item
1642 # Intent is for the copy to be captured for
1643 # a hold -- the only hold that should be
1644 # present on the copy
1645
1646 sub checkin_accept {
1647     check_session_time();
1648     my $copy_id = shift;
1649     my $circ_lib = shift;
1650
1651     my $r = OpenSRF::AppSession->create('open-ils.circ')->request(
1652         'open-ils.circ.checkin.override',
1653         $session{authtoken}, { force => 1, copy_id => $copy_id, circ_lib => $circ_lib }
1654     )->gather(1);
1655
1656     return $r->{textcode};
1657 }
1658
1659 # Get actor.usr.id from barcode.
1660 # Arguments
1661 # patron barcode
1662 #
1663 # Returns
1664 # actor.usr.id
1665 # or hash on error
1666 sub user_id_from_barcode {
1667     check_session_time();
1668     my ($barcode) = @_;
1669
1670     my $response;
1671
1672     my $e = new_editor( authtoken => $session{authtoken} );
1673     return $response unless ( $e->checkauth );
1674
1675     my $card = $e->search_actor_card( { barcode => $barcode, active => 't' } );
1676     return $e->event unless ($card);
1677
1678     $response = $card->[0]->usr if (@$card);
1679
1680     $e->finish;
1681
1682     return $response;
1683 }
1684
1685 # Place a simple hold for a patron.
1686 #
1687 # Arguments
1688 # Target object appropriate for type of hold
1689 # Patron for whom the hold is place
1690 #
1691 # Returns
1692 # "SUCCESS" on success
1693 # textcode of a failed OSRF request
1694 # "HOLD_TYPE_NOT_SUPPORTED" if the hold type is not supported
1695 # (Currently only support 'T' and 'C')
1696
1697 # simple hold should be removed and full holds sub should be used instead - pragmatic solution only
1698
1699 sub place_simple_hold {
1700     check_session_time();
1701
1702     #my ($type, $target, $patron, $pickup_ou) = @_;
1703     my ( $target, $patron_id ) = @_;
1704
1705     require $conf->{path}->{oils_header};
1706     use vars qw/ $apputils $memcache $user $authtoken $authtime /;
1707
1708     osrf_connect( $conf->{path}->{opensrf_core} );
1709     oils_login( $conf->{auth}->{username}, $conf->{auth}->{password} );
1710     my $ahr = Fieldmapper::action::hold_request->new();
1711     $ahr->hold_type('C');
1712     # The targeter doesn't like our special statuses, and changing the status after the targeter finishes is difficult because it runs asynchronously.  Our workaround is to create the hold frozen, unfreeze it, then run the targeter manually.
1713     $ahr->target($target);
1714     $ahr->usr($patron_id);
1715     $ahr->requestor($conf->{hold}->{requestor});
1716     # NOTE: When User Agency, we don't know the pickup location until ItemShipped time
1717     # TODO: When Item Agency and using holds, set this to requested copy's circ lib?
1718     $ahr->pickup_lib($conf->{hold}->{init_pickup_lib});
1719     $ahr->phone_notify(''); # TODO: set this based on usr prefs
1720     $ahr->email_notify(1); # TODO: set this based on usr prefs
1721     $ahr->frozen('t');
1722     my $resp = simplereq( CIRC(), 'open-ils.circ.holds.create', $authtoken, $ahr );
1723     my $e = new_editor( xact => 1, authtoken => $session{authtoken} );
1724     $ahr = $e->retrieve_action_hold_request($resp);    # refresh from db
1725     if (!ref $ahr) {
1726         $e->rollback;
1727         fail("place_simple_hold: hold request not placed!");
1728     }
1729     $ahr->frozen('f');
1730     $e->update_action_hold_request($ahr);
1731     $e->commit;
1732     $U->storagereq( 'open-ils.storage.action.hold_request.copy_targeter', undef, $ahr->id );
1733
1734     #oils_event_die($resp);
1735     my $errors = "";
1736     if ( ref($resp) eq 'ARRAY' ) {
1737         ( $errors .= "error : " . $_->{textcode} ) for @$resp;
1738         return $errors;
1739     } elsif ( ref($resp) ne 'HASH' ) {
1740         return "Hold placed! hold_id = " . $resp . "\n";
1741     }
1742 }
1743
1744 sub find_hold_on_copy {
1745     check_session_time();
1746
1747     my ( $copy_barcode ) = @_;
1748
1749     # start with barcode of item, find bib ID
1750     my $rec = bre_id_from_barcode($copy_barcode);
1751
1752     return undef unless $rec;
1753
1754     # call for holds on that bib
1755     my $holds = holds_for_bre($rec);
1756
1757     # There should only be a single copy hold
1758     my $hold_id = @{$holds->{copy_holds}}[0];
1759
1760     return undef unless $hold_id;
1761
1762     my $hold_details =
1763       OpenSRF::AppSession->create('open-ils.circ')
1764       ->request( 'open-ils.circ.hold.details.retrieve', $session{authtoken}, $hold_id )
1765       ->gather(1);
1766
1767     my $hold = $hold_details->{hold};
1768
1769     return undef unless blessed($hold);
1770
1771     return $hold;
1772 }
1773
1774 sub update_hold_pickup {
1775     check_session_time();
1776
1777     my ( $copy_barcode, $pickup_lib ) = @_;
1778
1779     my $hold = find_hold_on_copy($copy_barcode);
1780
1781     # return if hold was not found
1782     return undef unless defined($hold) && blessed($hold);
1783
1784     $hold->pickup_lib($pickup_lib);
1785
1786     # update the copy hold with the new pickup lib information
1787     my $result =
1788       OpenSRF::AppSession->create('open-ils.circ')
1789       ->request( 'open-ils.circ.hold.update', $session{authtoken}, $hold )
1790       ->gather(1);
1791
1792     return $result;
1793 }
1794
1795 sub cancel_hold {
1796     check_session_time();
1797
1798     my ( $copy_barcode ) = @_;
1799
1800     my $hold = find_hold_on_copy($copy_barcode);
1801
1802     # return if hold was not found
1803     return undef unless defined($hold) && blessed($hold);
1804
1805     $hold->cancel_time('now()');
1806     $hold->cancel_cause(5); # 5 = 'Staff forced' (perhaps it should be 'Patron via SIP'?) or OPAC? or add NCIP to the cause table?
1807     $hold->cancel_note('NCIP cancellation request');
1808
1809     # update the (now cancelled) copy hold
1810     my $result =
1811       OpenSRF::AppSession->create('open-ils.circ')
1812       ->request( 'open-ils.circ.hold.update', $session{authtoken}, $hold )
1813       ->gather(1);
1814
1815     return $result;
1816 }
1817
1818 # Flesh user information
1819 # Arguments
1820 # actor.usr.id
1821 #
1822 # Returns
1823 # fieldmapped, fleshed user or
1824 # event hash on error
1825 sub flesh_user {
1826     check_session_time();
1827     my ($id) = @_;
1828     my $response =
1829       OpenSRF::AppSession->create('open-ils.actor')
1830       ->request( 'open-ils.actor.user.fleshed.retrieve',
1831         $session{'authtoken'}, $id,
1832         [ 'card', 'cards', 'standing_penalties', 'home_ou', 'profile' ] )
1833       ->gather(1);
1834     return $response;
1835 }
1836
1837 sub _naive_encode_xml {
1838     my $val = shift;
1839
1840     $val =~ s/&/&amp;/g;
1841     $val =~ s/</&lt;/g;
1842     $val =~ s/>/&gt;/g;
1843
1844     return $val;
1845 }