lib/NCIP/ILS/Evergreen.pm

   1 # ---------------------------------------------------------------
   2 # Copyright © 2014 Jason J.A. Stephenson <jason@sigio.com>
   3 #
   4 # This file is part of NCIPServer.
   5 #
   6 # NCIPServer is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 2 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # NCIPServer is distributed in the hope that it will be useful, but
  12 # WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 # General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with NCIPServer.  If not, see <http://www.gnu.org/licenses/>.
  18 # ---------------------------------------------------------------
  19 package NCIP::ILS::Evergreen;
  20
  21 use Modern::Perl;
  22 use XML::LibXML::Simple qw(XMLin);
  23 use DateTime;
  24 use DateTime::Format::ISO8601;
  25 use Digest::MD5 qw/md5_hex/;
  26 use OpenSRF::System;
  27 use OpenSRF::AppSession;
  28 use OpenSRF::Utils qw/:datetime/;
  29 use OpenSRF::Utils::SettingsClient;
  30 use OpenILS::Utils::Fieldmapper;
  31 use OpenILS::Utils::Normalize qw(clean_marc);
  32 use OpenILS::Application::AppUtils;
  33 use OpenILS::Const qw/:const/;
  34 use MARC::Record;
  35 use MARC::Field;
  36 use MARC::File::XML;
  37 use List::MoreUtils qw/uniq/;
  38 use POSIX qw/strftime/;
  39
  40 # We need a bunch of NCIP::* objects.
  41 use NCIP::Response;
  42 use NCIP::Problem;
  43 use NCIP::User;
  44 use NCIP::User::OptionalFields;
  45 use NCIP::User::AddressInformation;
  46 use NCIP::User::Id;
  47 use NCIP::User::BlockOrTrap;
  48 use NCIP::User::Privilege;
  49 use NCIP::User::PrivilegeStatus;
  50 use NCIP::StructuredPersonalUserName;
  51 use NCIP::StructuredAddress;
  52 use NCIP::ElectronicAddress;
  53 use NCIP::RequestId;
  54 use NCIP::Item::Id;
  55
  56 # Inherit from NCIP::ILS.
  57 use parent qw(NCIP::ILS);
  58
  59 =head1 NAME
  60
  61 Evergreen - Evergreen driver for NCIPServer
  62
  63 =head1 SYNOPSIS
  64
  65     my $ils = NCIP::ILS::Evergreen->new(name => $config->{NCIP.ils.value});
  66
  67 =head1 DESCRIPTION
  68
  69 NCIP::ILS::Evergreen is the default driver for Evergreen and
  70 NCIPServer. It was initially developed to work with Auto-Graphics'
  71 SHAREit software using a subset of an unspecified ILL/DCB profile.
  72
  73 =cut
  74
  75 # Default values we define for things that might be missing in our
  76 # runtime environment or configuration file that absolutely must have
  77 # values.
  78 #
  79 # OILS_NCIP_CONFIG_DEFAULT is the default location to find our
  80 # driver's configuration file.  This location can be overridden by
  81 # setting the path in the OILS_NCIP_CONFIG environment variable.
  82 #
  83 # BIB_SOURCE_DEFAULT is the config.bib_source.id to use when creating
  84 # "short" bibs.  It is used only if no entry is supplied in the
  85 # configuration file.  The provided default is 2, the id of the
  86 # "System Local" source that comes with a default Evergreen
  87 # installation.
  88 use constant {
  89     OILS_NCIP_CONFIG_DEFAULT => '/openils/conf/oils_ncip.xml',
  90     BIB_SOURCE_DEFAULT => 2
  91 };
  92
  93 # A common Evergreen code shortcut to use AppUtils:
  94 my $U = 'OpenILS::Application::AppUtils';
  95
  96 # The usual constructor:
  97 sub new {
  98     my $class = shift;
  99     $class = ref($class) if (ref $class);
 100
 101     # Instantiate our parent with the rest of the arguments.  It
 102     # creates a blessed hashref.
 103     my $self = $class->SUPER::new(@_);
 104
 105     # Look for our configuration file, load, and parse it:
 106     $self->_configure();
 107
 108     # Bootstrap OpenSRF and prepare some OpenILS components.
 109     $self->_bootstrap();
 110
 111     # Initialize the rest of our internal state.
 112     $self->_init();
 113
 114     return $self;
 115 }
 116
 117 =head1 HANDLER METHODS
 118
 119 =head2 lookupuser
 120
 121     $ils->lookupuser($request);
 122
 123 Processes a LookupUser request.
 124
 125 =cut
 126
 127 sub lookupuser {
 128     my $self = shift;
 129     my $request = shift;
 130
 131     # Check our session and login if necessary.
 132     $self->login() unless ($self->checkauth());
 133
 134     my $message_type = $self->parse_request_type($request);
 135
 136     # Let's go ahead and create our response object. We need this even
 137     # if there is a problem.
 138     my $response = NCIP::Response->new({type => $message_type . "Response"});
 139     $response->header($self->make_header($request));
 140
 141     # Need to parse the request object to get the user barcode.
 142     my ($barcode, $idfield) = $self->find_user_barcode($request);
 143
 144     # If we did not find a barcode, then report the problem.
 145     if (ref($barcode) eq 'NCIP::Problem') {
 146         $response->problem($barcode);
 147         return $response;
 148     }
 149
 150     # Look up our patron by barcode:
 151     my $user = $self->retrieve_user_by_barcode($barcode, $idfield);
 152     if (ref($user) eq 'NCIP::Problem') {
 153         $response->problem($user);
 154         return $response;
 155     }
 156
 157     # We got the information, so lets fill in our userdata.
 158     my $userdata = NCIP::User->new();
 159
 160     # Make an array of the user's active barcodes.
 161     my $ids = [];
 162     foreach my $card (@{$user->cards()}) {
 163         if ($U->is_true($card->active())) {
 164             my $id = NCIP::User::Id->new({
 165                 UserIdentifierType => 'Barcode',
 166                 UserIdentifierValue => $card->barcode()
 167             });
 168             push(@$ids, $id);
 169         }
 170     }
 171     $userdata->UserId($ids);
 172
 173     # Check if they requested any optional fields and return those.
 174     my $elements = $request->{$message_type}->{UserElementType};
 175     if ($elements) {
 176         $elements = [$elements] unless (ref $elements eq 'ARRAY');
 177         my $optionalfields = NCIP::User::OptionalFields->new();
 178
 179         # First, we'll look for name information.
 180         if (grep {$_ eq 'Name Information'} @$elements) {
 181             my $name = NCIP::StructuredPersonalUserName->new();
 182             $name->Surname($user->family_name());
 183             $name->GivenName($user->first_given_name());
 184             $name->Prefix($user->prefix());
 185             $name->Suffix($user->suffix());
 186             $optionalfields->NameInformation($name);
 187         }
 188
 189         # Next, check for user address information.
 190         if (grep {$_ eq 'User Address Information'} @$elements) {
 191             my $addresses = [];
 192
 193             # See if the user has any valid, physcial addresses.
 194             foreach my $addr (@{$user->addresses()}) {
 195                 next if ($U->is_true($addr->pending()));
 196                 my $address = NCIP::User::AddressInformation->new({UserAddressRoleType=>$addr->address_type()});
 197                 my $physical = NCIP::StructuredAddress->new();
 198                 $physical->Line1($addr->street1());
 199                 $physical->Line2($addr->street2());
 200                 $physical->Locality($addr->city());
 201                 $physical->Region($addr->state());
 202                 $physical->PostalCode($addr->post_code());
 203                 $physical->Country($addr->country());
 204                 $address->PhysicalAddress($physical);
 205                 push @$addresses, $address;
 206             }
 207
 208             # Right now, we're only sharing email address if the user
 209             # has it. We don't share phone numbers.
 210             if ($user->email()) {
 211                 my $address = NCIP::User::AddressInformation->new({UserAddressRoleType=>'Email Address'});
 212                 $address->ElectronicAddress(
 213                     NCIP::ElectronicAddress->new({
 214                         Type=>'Email Address',
 215                         Data=>$user->email()
 216                     })
 217                 );
 218                 push @$addresses, $address;
 219             }
 220
 221             $optionalfields->UserAddressInformation($addresses);
 222         }
 223
 224         # Check for User Privilege.
 225         if (grep {$_ eq 'User Privilege'} @$elements) {
 226             # Get the user's group:
 227             my $pgt = $U->simplereq(
 228                 'open-ils.pcrud',
 229                 'open-ils.pcrud.retrieve.pgt',
 230                 $self->{session}->{authtoken},
 231                 $user->profile()
 232             );
 233             if ($pgt) {
 234                 my $privilege = NCIP::User::Privilege->new();
 235                 $privilege->AgencyId($user->home_ou->shortname());
 236                 $privilege->AgencyUserPrivilegeType($pgt->name());
 237                 $privilege->ValidToDate($user->expire_date());
 238                 $privilege->ValidFromDate($user->create_date());
 239
 240                 my $status = 'Active';
 241                 if (_expired($user)) {
 242                     $status = 'Expired';
 243                 } elsif ($U->is_true($user->barred())) {
 244                     $status = 'Barred';
 245                 } elsif (!$U->is_true($user->active())) {
 246                     $status = 'Inactive';
 247                 }
 248                 if ($status) {
 249                     $privilege->UserPrivilegeStatus(
 250                         NCIP::User::PrivilegeStatus->new({
 251                             UserPrivilegeStatusType => $status
 252                         })
 253                     );
 254                 }
 255
 256                 $optionalfields->UserPrivilege([$privilege]);
 257             }
 258         }
 259
 260         # Check for Block Or Trap.
 261         if (grep {$_ eq 'Block Or Trap'} @$elements) {
 262             my $blocks = [];
 263
 264             # First, let's check if the profile is blocked from ILL.
 265             if (grep {$_->id() == $user->profile()} @{$self->{blocked_profiles}}) {
 266                 my $block = NCIP::User::BlockOrTrap->new();
 267                 $block->AgencyId($user->home_ou->shortname());
 268                 $block->BlockOrTrapType('Block Interlibrary Loan');
 269                 push @$blocks, $block;
 270             }
 271
 272             # Next, we loop through the user's standing penalties
 273             # looking for blocks on CIRC, HOLD, and RENEW.
 274             my ($have_circ, $have_renew, $have_hold) = (0,0,0);
 275             foreach my $penalty (@{$user->standing_penalties()}) {
 276                 next unless($penalty->standing_penalty->block_list());
 277                 my @block_list = split(/\|/, $penalty->standing_penalty->block_list());
 278                 my $ou = $U->simplereq(
 279                     'open-ils.pcrud',
 280                     'open-ils.pcrud.retrieve.aou',
 281                     $self->{session}->{authtoken},
 282                     $penalty->org_unit()
 283                 );
 284
 285                 # Block checkout.
 286                 if (!$have_circ && grep {$_ eq 'CIRC'} @block_list) {
 287                     my $bot = NCIP::User::BlockOrTrap->new();
 288                     $bot->AgencyId($ou->shortname());
 289                     $bot->BlockOrTrapType('Block Checkout');
 290                     push @$blocks, $bot;
 291                     $have_circ = 1;
 292                 }
 293
 294                 # Block holds.
 295                 if (!$have_hold && grep {$_ eq 'HOLD' || $_ eq 'FULFILL'} @block_list) {
 296                     my $bot = NCIP::User::BlockOrTrap->new();
 297                     $bot->AgencyId($ou->shortname());
 298                     $bot->BlockOrTrapType('Block Holds');
 299                     push @$blocks, $bot;
 300                     $have_hold = 1;
 301                 }
 302
 303                 # Block renewals.
 304                 if (!$have_renew && grep {$_ eq 'RENEW'} @block_list) {
 305                     my $bot = NCIP::User::BlockOrTrap->new();
 306                     $bot->AgencyId($ou->shortname());
 307                     $bot->BlockOrTrapType('Block Renewals');
 308                     push @$blocks, $bot;
 309                     $have_renew = 1;
 310                 }
 311
 312                 # Stop after we report one of each, even if more
 313                 # blocks remain.
 314                 last if ($have_circ && $have_renew && $have_hold);
 315             }
 316
 317             $optionalfields->BlockOrTrap($blocks);
 318         }
 319
 320         $userdata->UserOptionalFields($optionalfields);
 321     }
 322
 323     $response->data($userdata);
 324
 325     return $response;
 326 }
 327
 328 =head2 acceptitem
 329
 330     $ils->acceptitem($request);
 331
 332 Processes an AcceptItem request.
 333
 334 =cut
 335
 336 sub acceptitem {
 337     my $self = shift;
 338     my $request = shift;
 339
 340     # Check our session and login if necessary.
 341     $self->login() unless ($self->checkauth());
 342
 343     # Common preparation.
 344     my $message = $self->parse_request_type($request);
 345     my $response = NCIP::Response->new({type => $message . 'Response'});
 346     $response->header($self->make_header($request));
 347
 348     # We only accept holds for the time being.
 349     if ($request->{$message}->{RequestedActionType} !~ /^hold\w/i) {
 350         # We need the item id or we can't do anything at all.
 351         my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
 352         if (ref($item_barcode) eq 'NCIP::Problem') {
 353             $response->problem($item_barcode);
 354             return $response;
 355         }
 356
 357         # We need to find a patron barcode or we can't look anyone up
 358         # to place a hold.
 359         my ($user_barcode, $user_idfield) = $self->find_user_barcode($request, 'UserIdentifierValue');
 360         if (ref($user_barcode) eq 'NCIP::Problem') {
 361             $response->problem($user_barcode);
 362             return $response;
 363         }
 364         # Look up our patron by barcode:
 365         my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
 366         if (ref($user) eq 'NCIP::Problem') {
 367             $response->problem($user);
 368             return $response;
 369         }
 370         # We're doing patron checks before looking for bibliographic
 371         # information and creating the item because problems with the
 372         # patron are more likely to occur.
 373         my $problem = $self->check_user_for_problems($user, 'HOLD');
 374         if ($problem) {
 375             $response->problem($problem);
 376             return $response;
 377         }
 378
 379         # Check if the item barcode already exists:
 380         my $item = $self->retrieve_copy_details_by_barcode($item_barcode);
 381         if ($item) {
 382             # What to do here was not defined in the
 383             # specification. Since the copies that we create this way
 384             # should get deleted when checked in, it would be an error
 385             # if we try to create another one. It means that something
 386             # has gone wrong somewhere.
 387             $response->problem(
 388                 NCIP::Problem->new(
 389                     {
 390                         ProblemType => 'Duplicate Item',
 391                         ProblemDetail => "Item with barcode $item_barcode already exists.",
 392                         ProblemElement => $item_idfield,
 393                         ProblemValue => $item_barcode
 394                     }
 395                 )
 396             );
 397             return $response;
 398         }
 399
 400         # Now, we have to create our new copy and/or bib and call number.
 401
 402         # First, we have to gather the necessary information from the
 403         # request.  Store in a hashref for convenience. We may write a
 404         # method to get this information in the future if we find we
 405         # need it in other handlers. Such a function would be a
 406         # candidate to go into our parent, NCIP::ILS.
 407         my $item_info = {
 408             barcode => $item_barcode,
 409             call_number => $request->{$message}->{ItemOptionalFields}->{ItemDescription}->{CallNumber},
 410             title => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{Author},
 411             author => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{Title},
 412             publisher => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{Publisher},
 413             publication_date => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{PublicationDate},
 414             medium => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{MediumType},
 415             electronic => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{ElectronicResource}
 416         };
 417
 418         if ($self->{config}->{items}->{use_precats}) {
 419             # We only need to create a precat copy.
 420             $item = $self->create_precat_copy($item_info);
 421         } else {
 422             # We have to create a "partial" bib record, a call number and a copy.
 423             $item = $self->create_fuller_copy($item_info);
 424         }
 425
 426         # If we failed to create the copy, report a problem.
 427         unless ($item) {
 428             $response->problem(
 429                 {
 430                     ProblemType => 'Temporary Processing Failure',
 431                     ProblemDetail => 'Failed to create the item in the system',
 432                     ProblemElement => $item_idfield,
 433                     ProblemValue => $item_barcode
 434                 }
 435             );
 436             return $response;
 437         }
 438
 439         # We try to find the pickup location in our database. It's OK
 440         # if it does not exist, the user's home library will be used
 441         # instead.
 442         my $location = $request->{$message}->{PickupLocation};
 443         if ($location) {
 444             $location = $self->retrieve_org_unit_by_shortname($location);
 445         }
 446
 447         # Now, we place the hold on the newly created copy on behalf
 448         # of the patron retrieved above.
 449         my $hold = $self->place_hold($item, $user, $location);
 450         if (ref($hold) eq 'NCIP::Problem') {
 451             $response->problem($hold);
 452             return $response;
 453         }
 454
 455         # We return the RequestId and optionally, the ItemID. We'll
 456         # just return what was sent to us, since we ignored all of it
 457         # but the barcode.
 458         my $data = {};
 459         $data->{RequestId} = NCIP::RequestId->new(
 460             {
 461                 AgencyId => $request->{$message}->{RequestId}->{AgencyId},
 462                 RequestIdentifierType => $request->{$message}->{RequestId}->{RequestIdentifierType},
 463                 RequestIdentifierValue => $request->{$message}->{RequestId}->{RequestIdentifierValue}
 464             }
 465         );
 466         $data->{ItemId} = NCIP::Item::Id->new(
 467             {
 468                 AgencyId => $request->{$message}->{ItemId}->{AgencyId},
 469                 ItemIdentifierType => $request->{$message}->{ItemId}->{ItemIdentifierType},
 470                 ItemIdentifierValue => $request->{$message}->{ItemId}->{ItemIdentifierValue}
 471             }
 472         );
 473         $response->data($data);
 474
 475     } else {
 476         my $problem = NCIP::Problem->new();
 477         $problem->ProblemType('Unauthorized Combination Of Element Values For System');
 478         $problem->ProblemDetail('We only support Hold For Pickup');
 479         $problem->ProblemElement('RequestedActionType');
 480         $problem->ProblemValue($request->{$message}->{RequestedActionType});
 481         $response->problem($problem);
 482     }
 483
 484     return $response;
 485 }
 486
 487 =head2 checkinitem
 488
 489     $response = $ils->checkinitem($request);
 490
 491 Checks the item in if we can find the barcode in the message. It
 492 returns problems if it cannot find the item in the system or if the
 493 item is not checked out.
 494
 495 It could definitely use some more brains at some point as it does not
 496 fully support everything that the standard allows. It also does not
 497 really check if the checkin succeeded or not.
 498
 499 =cut
 500
 501 sub checkinitem {
 502     my $self = shift;
 503     my $request = shift;
 504
 505     # Check our session and login if necessary:
 506     $self->login() unless ($self->checkauth());
 507
 508     # Common stuff:
 509     my $message = $self->parse_request_type($request);
 510     my $response = NCIP::Response->new({type => $message . 'Response'});
 511     $response->header($self->make_header($request));
 512
 513     # We need the copy barcode from the message.
 514     my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
 515     if (ref($item_barcode) eq 'NCIP::Problem') {
 516         $response->problem($item_barcode);
 517         return $response;
 518     }
 519
 520     # Retrieve the copy details.
 521     my $details = $self->retrieve_copy_details_by_barcode($item_barcode);
 522     unless ($details) {
 523         # Return an Unkown Item problem unless we find the copy.
 524         $response->problem(
 525             NCIP::Problem->new(
 526                 {
 527                     ProblemType => 'Unknown Item',
 528                     ProblemDetail => "Item with barcode $item_barcode is not known.",
 529                     ProblemElement => $item_idfield,
 530                     ProblemValue => $item_barcode
 531                 }
 532             )
 533         );
 534         return $response;
 535     }
 536
 537     # Check if a UserId was provided. If so, this is the patron to
 538     # whom the copy should be checked out.
 539     my $user;
 540     my ($user_barcode, $user_idfield) = $self->find_user_barcode($request);
 541     # We ignore the problem, because the UserId is optional.
 542     if (ref($user_barcode) ne 'NCIP::Problem') {
 543         $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
 544         # We don't ignore a problem here, however.
 545         if (ref($user) eq 'NCIP::Problem') {
 546             $response->problem($user);
 547             return $response;
 548         }
 549     }
 550
 551     # Isolate the copy.
 552     my $copy = $details->{copy};
 553
 554     # Look for a circulation and examine its information:
 555     my $circ = $details->{circ};
 556
 557     # Check the circ details to see if the copy is checked out and, if
 558     # the patron was provided, that it is checked out to the patron in
 559     # question. We also verify the copy ownership and circulation
 560     # location.
 561     my $problem = $self->check_circ_details($circ, $copy, $user);
 562     if ($problem) {
 563         # We need to fill in some information, however.
 564         if (!$problem->ProblemValue() && !$problem->ProblemElement()) {
 565             $problem->ProblemValue($user_barcode);
 566             $problem->ProblemElement($user_idfield);
 567         } elsif (!$problem->ProblemElement()) {
 568             $problem->ProblemElement($item_idfield);
 569         }
 570         $response->problem($problem);
 571         return $response;
 572     }
 573
 574     # Checkin parameters. We want to skip hold targeting or making
 575     # transits, to force the checkin despite the copy status, as
 576     # well as void overdues.
 577     my $params = {
 578         copy_barcode => $copy->barcode(),
 579         force => 1,
 580         noop => 1,
 581         void_overdues => 1
 582     };
 583     my $result = $U->simplereq(
 584         'open-ils.circ',
 585         'open-ils.circ.checkin.override',
 586         $self->{session}->{authtoken},
 587         $params
 588     );
 589     if (ref($result) eq 'ARRAY') {
 590         $result = $result->[0];
 591     }
 592     if ($result->{textcode} eq 'SUCCESS') {
 593         # Delete the copy. Since delete_copy checks ownership
 594         # before attempting to delete the copy, we don't bother
 595         # checking who owns it.
 596         $self->delete_copy($copy);
 597         # We need the circulation user for the information below, so we retrieve it.
 598         my $circ_user = $self->retrieve_user_by_id($circ->usr());
 599         my $data = {
 600             ItemId => NCIP::Item::Id->new(
 601                 {
 602                     AgencyId => $request->{$message}->{ItemId}->{AgencyId},
 603                     ItemIdentifierType => $request->{$message}->{ItemId}->{ItemIdentifierType},
 604                     ItemIdentifierValue => $request->{$message}->{ItemId}->{ItemIdentifierValue}
 605                 }
 606             ),
 607             UserId => NCIP::User::Id->new(
 608                 {
 609                     UserIdentifierType => 'Barcode Id',
 610                     UserIdentifierValue => $circ_user->card->barcode()
 611                 }
 612             )
 613         };
 614
 615         $response->data($data);
 616
 617         # At some point in the future, we should probably check if
 618         # they requested optional user or item elements and return
 619         # those. For the time being, we ignore those at the risk of
 620         # being considered non-compliant.
 621     } else {
 622         $response->problem(_problem_from_event('Checkin Failed', $result));
 623     }
 624
 625     return $response
 626 }
 627
 628 =head2 renewitem
 629
 630     $response = $ils->renewitem($request);
 631
 632 Handle the RenewItem message.
 633
 634 =cut
 635
 636 sub renewitem {
 637     my $self = shift;
 638     my $request = shift;
 639
 640     # Check our session and login if necessary:
 641     $self->login() unless ($self->checkauth());
 642
 643     # Common stuff:
 644     my $message = $self->parse_request_type($request);
 645     my $response = NCIP::Response->new({type => $message . 'Response'});
 646     $response->header($self->make_header($request));
 647
 648     # We need the copy barcode from the message.
 649     my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
 650     if (ref($item_barcode) eq 'NCIP::Problem') {
 651         $response->problem($item_barcode);
 652         return $response;
 653     }
 654
 655     # Retrieve the copy details.
 656     my $details = $self->retrieve_copy_details_by_barcode($item_barcode);
 657     unless ($details) {
 658         # Return an Unkown Item problem unless we find the copy.
 659         $response->problem(
 660             NCIP::Problem->new(
 661                 {
 662                     ProblemType => 'Unknown Item',
 663                     ProblemDetail => "Item with barcode $item_barcode is not known.",
 664                     ProblemElement => $item_idfield,
 665                     ProblemValue => $item_barcode
 666                 }
 667             )
 668         );
 669         return $response;
 670     }
 671
 672     # User is required for RenewItem.
 673     my ($user_barcode, $user_idfield) = $self->find_user_barcode($request);
 674     if (ref($user_barcode) eq 'NCIP::Problem') {
 675         $response->problem($user_barcode);
 676         return $response;
 677     }
 678     my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
 679     if (ref($user) eq 'NCIP::Problem') {
 680         $response->problem($user);
 681         return $response;
 682     }
 683
 684     # Isolate the copy.
 685     my $copy = $details->{copy};
 686
 687     # Look for a circulation and examine its information:
 688     my $circ = $details->{circ};
 689
 690     # Check the circ details to see if the copy is checked out and, if
 691     # the patron was provided, that it is checked out to the patron in
 692     # question. We also verify the copy ownership and circulation
 693     # location.
 694     my $problem = $self->check_circ_details($circ, $copy, $user);
 695     if ($problem) {
 696         # We need to fill in some information, however.
 697         if (!$problem->ProblemValue() && !$problem->ProblemElement()) {
 698             $problem->ProblemValue($user_barcode);
 699             $problem->ProblemElement($user_idfield);
 700         } elsif (!$problem->ProblemElement()) {
 701             $problem->ProblemElement($item_idfield);
 702         }
 703         $response->problem($problem);
 704         return $response;
 705     }
 706
 707     # Check if user is blocked from renewals:
 708     $problem = $self->check_user_for_problems($user, 'RENEW');
 709     if ($problem) {
 710         # Replace the ProblemElement and ProblemValue fields.
 711         $problem->ProblemElement($user_idfield);
 712         $problem->ProblemValue($user_barcode);
 713         $response->problem($problem);
 714         return $response;
 715     }
 716
 717     # Check if the duration rule allows renewals. It should have been
 718     # fleshed during the copy details retrieve.
 719     my $rule = $circ->duration_rule();
 720     unless (ref($rule)) {
 721         $rule = $U->simplereq(
 722             'open-ils.pcrud',
 723             'open-ils.pcrud.retrieve.crcd',
 724             $self->{session}->{authtoken},
 725             $rule
 726         )->gather(1);
 727     }
 728     if ($rule->max_renewals() < 1) {
 729         $response->problem(
 730             NCIP::Problem->new(
 731                 {
 732                     ProblemType => 'Item Not Renewable',
 733                     ProblemDetail => 'Item may not be renewed.',
 734                     ProblemElement => $item_idfield,
 735                     ProblemValue => $item_barcode
 736                 }
 737             )
 738         );
 739         return $response;
 740     }
 741
 742     # Check if there are renewals remaining on the latest circ:
 743     if ($circ->renewal_remaining() < 1) {
 744         $response->problem(
 745             NCIP::Problem->new(
 746                 {
 747                     ProblemType => 'Maximum Renewals Exceeded',
 748                     ProblemDetail => 'Renewal cannot proceed because the User has already renewed the Item the maximum number of times permitted.',
 749                     ProblemElement => $item_idfield,
 750                     ProblemValue => $item_barcode
 751                 }
 752             )
 753         );
 754         return $response;
 755     }
 756
 757     # Now, we attempt the renewal. If it fails, we simply say that the
 758     # user is not allowed to renew this item, without getting into
 759     # details.
 760     my $params = {
 761         copy => $copy,
 762         patron_id => $user->id(),
 763         sip_renewal => 1
 764     };
 765     my $r = $U->simplereq(
 766         'open-ils.circ',
 767         'open-ils.circ.renew.override',
 768         $self->{session}->{authtoken},
 769         $params
 770     )->gather(1);
 771
 772     # We only look at the first one, since more than one usually means
 773     # failure.
 774     if (ref($r) eq 'ARRAY') {
 775         $r = $r->[0];
 776     }
 777     if ($r->{textcode} ne 'SUCCESS') {
 778         $problem = _problem_from_event('Renewal Failed', $r);
 779         $response->problem($problem);
 780     } else {
 781         my $data = {
 782             ItemId => NCIP::Item::Id->new(
 783                 {
 784                     AgencyId => $request->{$message}->{ItemId}->{AgencyId},
 785                     ItemIdentifierType => $request->{$message}->{ItemId}->{ItemIdentifierType},
 786                     ItemIdentifierValue => $request->{$message}->{ItemId}->{ItemIdentifierValue}
 787                 }
 788             ),
 789             UserId => NCIP::User::Id->new(
 790                 {
 791                     UserIdentifierType => 'Barcode Id',
 792                     UserIdentifierValue => $user->card->barcode()
 793                 }
 794             )
 795         };
 796         # We need to retrieve the copy details again to refresh our
 797         # circ information to get the new due date.
 798         $details = $self->retrieve_copy_details_by_barcode($item_barcode);
 799         $circ = $details->{circ};
 800         my $due = DateTime::Format::ISO8601->parse_datetime(cleanse_ISO8601($circ->due_date()));
 801         $due->set_time_zone('UTC');
 802         $data->{DateDue} = $due->iso8601();
 803
 804         $response->data($data);
 805     }
 806
 807     # At some point in the future, we should probably check if
 808     # they requested optional user or item elements and return
 809     # those. For the time being, we ignore those at the risk of
 810     # being considered non-compliant.
 811
 812     return $response;
 813 }
 814
 815 =head2 checkoutitem
 816
 817     $response = $ils->checkoutitem($request);
 818
 819 Handle the Checkoutitem message.
 820
 821 =cut
 822
 823 sub checkoutitem {
 824     my $self = shift;
 825     my $request = shift;
 826
 827     # Check our session and login if necessary:
 828     $self->login() unless ($self->checkauth());
 829
 830     # Common stuff:
 831     my $message = $self->parse_request_type($request);
 832     my $response = NCIP::Response->new({type => $message . 'Response'});
 833     $response->header($self->make_header($request));
 834
 835     # We need the copy barcode from the message.
 836     my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
 837     if (ref($item_barcode) eq 'NCIP::Problem') {
 838         $response->problem($item_barcode);
 839         return $response;
 840     }
 841
 842     # Retrieve the copy details.
 843     my $details = $self->retrieve_copy_details_by_barcode($item_barcode);
 844     unless ($details) {
 845         # Return an Unkown Item problem unless we find the copy.
 846         $response->problem(
 847             NCIP::Problem->new(
 848                 {
 849                     ProblemType => 'Unknown Item',
 850                     ProblemDetail => "Item with barcode $item_barcode is not known.",
 851                     ProblemElement => $item_idfield,
 852                     ProblemValue => $item_barcode
 853                 }
 854             )
 855         );
 856         return $response;
 857     }
 858
 859     # User is required for CheckOutItem.
 860     my ($user_barcode, $user_idfield) = $self->find_user_barcode($request);
 861     if (ref($user_barcode) eq 'NCIP::Problem') {
 862         $response->problem($user_barcode);
 863         return $response;
 864     }
 865     my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
 866     if (ref($user) eq 'NCIP::Problem') {
 867         $response->problem($user);
 868         return $response;
 869     }
 870
 871     # Isolate the copy.
 872     my $copy = $details->{copy};
 873
 874     # Check if the copy can circulate.
 875     unless ($self->copy_can_circulate($copy)) {
 876         $response->problem(
 877             NCIP::Problem->new(
 878                 {
 879                     ProblemType => 'Item Does Not Circulate',
 880                     ProblemDetail => "Item with barcode $item_barcode does not circulate.",
 881                     ProblemElement => $item_idfield,
 882                     ProblemValue => $item_barcode
 883                 }
 884             )
 885         );
 886         return $response;
 887     }
 888
 889     # Look for a circulation and examine its information:
 890     my $circ = $details->{circ};
 891
 892     # Check if the item is already checked out.
 893     if ($circ && !$circ->checkin_time()) {
 894         $response->problem(
 895             NCIP::Problem->new(
 896                 {
 897                     ProblemType => 'Item Already Checked Out',
 898                     ProblemDetail => "Item with barcode $item_barcode is already checked out.",
 899                     ProblemElement => $item_idfield,
 900                     ProblemValue => $item_barcode
 901                 }
 902             )
 903         );
 904         return $response;
 905     }
 906
 907     # Check if user is blocked from circulation:
 908     my $problem = $self->check_user_for_problems($user, 'CIRC');
 909     if ($problem) {
 910         # Replace the ProblemElement and ProblemValue fields.
 911         $problem->ProblemElement($user_idfield);
 912         $problem->ProblemValue($user_barcode);
 913         $response->problem($problem);
 914         return $response;
 915     }
 916
 917     # Now, we attempt the check out. If it fails, we simply say that
 918     # the user is not allowed to check out this item, without getting
 919     # into details.
 920     my $params = {
 921         copy => $copy,
 922         patron_id => $user->id(),
 923     };
 924     my $r = $U->simplereq(
 925         'open-ils.circ',
 926         'open-ils.circ.checkout.full.override',
 927         $self->{session}->{authtoken},
 928         $params
 929     )->gather(1);
 930
 931     # We only look at the first one, since more than one usually means
 932     # failure.
 933     if (ref($r) eq 'ARRAY') {
 934         $r = $r->[0];
 935     }
 936     if ($r->{textcode} ne 'SUCCESS') {
 937         $problem = _problem_from_event('Check Out Failed', $r);
 938         $response->problem($problem);
 939     } else {
 940         my $data = {
 941             ItemId => NCIP::Item::Id->new(
 942                 {
 943                     AgencyId => $request->{$message}->{ItemId}->{AgencyId},
 944                     ItemIdentifierType => $request->{$message}->{ItemId}->{ItemIdentifierType},
 945                     ItemIdentifierValue => $request->{$message}->{ItemId}->{ItemIdentifierValue}
 946                 }
 947             ),
 948             UserId => NCIP::User::Id->new(
 949                 {
 950                     UserIdentifierType => 'Barcode Id',
 951                     UserIdentifierValue => $user->card->barcode()
 952                 }
 953             )
 954         };
 955         # We need to retrieve the copy details again to refresh our
 956         # circ information to get the due date.
 957         $details = $self->retrieve_copy_details_by_barcode($item_barcode);
 958         $circ = $details->{circ};
 959         my $due = DateTime::Format::ISO8601->parse_datetime(cleanse_ISO8601($circ->due_date()));
 960         $due->set_time_zone('UTC');
 961         $data->{DateDue} = $due->iso8601();
 962
 963         $response->data($data);
 964     }
 965
 966     # At some point in the future, we should probably check if
 967     # they requested optional user or item elements and return
 968     # those. For the time being, we ignore those at the risk of
 969     # being considered non-compliant.
 970
 971     return $response;
 972 }
 973
 974 =head2 requestitem
 975
 976     $response = $ils->requestitem($request);
 977
 978 Handle the NCIP RequestItem message.
 979
 980 =cut
 981
 982 sub requestitem {
 983     my $self = shift;
 984     my $request = shift;
 985     # Check our session and login if necessary:
 986     $self->login() unless ($self->checkauth());
 987
 988     # Common stuff:
 989     my $message = $self->parse_request_type($request);
 990     my $response = NCIP::Response->new({type => $message . 'Response'});
 991     $response->header($self->make_header($request));
 992
 993     # Because we need to have a user to place a hold, because the user
 994     # is likely to have problems, and because getting the item
 995     # information for the hold is trickier than getting the user
 996     # information, we'll do the user first and short circuit out of
 997     # the function if there is a problem with the user.
 998     my ($user_barcode, $user_idfield) = $self->find_user_barcode($request);
 999     if (ref($user_barcode) eq 'NCIP::Problem') {
1000         $response->problem($user_barcode);
1001         return $response;
1002     }
1003     my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
1004     if (ref($user) eq 'NCIP::Problem') {
1005         $response->problem($user);
1006         return $response;
1007     }
1008     my $problem = $self->check_user_for_problems($user, 'HOLD');
1009     if ($problem) {
1010         $response->problem($problem);
1011         return $response;
1012     }
1013
1014     # RequestItem is a blast. We need to check if we have a copy
1015     # barcode and/or if we have BibliographicIds. If we have both or
1016     # either, we then need to figure out what we're placing the hold
1017     # on, a copy, a volume or a bib. We don't currently do part holds,
1018     # but maybe we should some day. We can also be sent more than 1
1019     # BibliographicId, so we look for certain identifiers first, and
1020     # then others in decreasing preference: SYSNUMBER, ISBN, and ISSN.
1021
1022     # Not to mention that there are two kinds of BibliographicId field
1023     # with different field names, and both can be intermixed in an
1024     # incoming message! (I just /love/ this nonsense.)
1025
1026     # This here is the thing we're going to put on hold:
1027     my $item;
1028
1029     # We need the copy barcode from the message.
1030     my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
1031     if (ref($item_barcode) ne 'NCIP::Problem') {
1032         # Retrieve the copy details.
1033         my $copy_details = $self->retrieve_copy_details_by_barcode($item_barcode);
1034         unless ($copy_details) {
1035             # Return an Unkown Item problem unless we find the copy.
1036             $response->problem(
1037                 NCIP::Problem->new(
1038                     {
1039                         ProblemType => 'Unknown Item',
1040                         ProblemDetail => "Item with barcode $item_barcode is not known.",
1041                         ProblemElement => $item_idfield,
1042                         ProblemValue => $item_barcode
1043                     }
1044                 )
1045             );
1046             return $response;
1047         }
1048         $item = $copy_details->{volume}; # We place a volume hold.
1049     }
1050
1051     # We weren't given copy information to target, or we can't find
1052     # it, so we need to look for a target via BibliographicId.
1053     unless ($item) {
1054         my @biblio_ids = $self->find_bibliographic_ids($request);
1055         if (@biblio_ids) {
1056             $item = $self->find_target_via_bibliographic_id(@biblio_ids);
1057         }
1058     }
1059
1060     # If we don't have an item, then blow up with a problem that may
1061     # have been set when we went looking for the ItemId.
1062     unless ($item) {
1063         if (ref($item_barcode) eq 'NCIP::Problem') {
1064             $response->problem($item_barcode);
1065         } else {
1066             $response->problem(
1067                 NCIP::Problem->new(
1068                     {
1069                         ProblemType => 'Request Item Not Found',
1070                         ProblemDetail => 'Unable to determine the item to request from input message.',
1071                         ProblemElement => 'NULL',
1072                         ProblemValue => 'NULL'
1073                     }
1074                 )
1075             );
1076         }
1077         return $response;
1078     }
1079
1080     # See if we were given a PickupLocation.
1081     my $location;
1082     if ($request->{$message}->{PickupLocation}) {
1083         my $loc = $request->{$message}->{PickupLocation};
1084         $loc =~ s/^.*://; # strip everything up to the last
1085                           # semi-colon, if any.
1086         $location = $self->retrieve_org_unit_by_shortname($loc);
1087     }
1088
1089     # Place the hold.
1090     my $hold = $self->place_hold($item, $user, $location);
1091     if (ref($hold) eq 'NCIP::Problem') {
1092         $response->problem($hold);
1093     } else {
1094         my $data = {
1095             RequestId => NCIP::RequestId->new(
1096                 RequestIdentifierType => 'SYSNUMBER',
1097                 RequestIdentifierValue => $hold->id()
1098             ),
1099             UserId => NCIP::User::Id->new(
1100                 {
1101                     UserIdentifierType => 'Barcode Id',
1102                     UserIdentifierValue => $user->card->barcode()
1103                 }
1104             ),
1105             RequestType => $request->{$message}->{RequestType},
1106             RequestScopeType => ($hold->hold_type() eq 'V') ? "item" : "bibliographic item"
1107         };
1108         $response->data($data);
1109     }
1110
1111     return $response;
1112 }
1113
1114 =head1 METHODS USEFUL to SUBCLASSES
1115
1116 =head2 login
1117
1118     $ils->login();
1119
1120 Login to Evergreen via OpenSRF. It uses internal state from the
1121 configuration file to login.
1122
1123 =cut
1124
1125 # Login via OpenSRF to Evergreen.
1126 sub login {
1127     my $self = shift;
1128
1129     # Get the authentication seed.
1130     my $seed = $U->simplereq(
1131         'open-ils.auth',
1132         'open-ils.auth.authenticate.init',
1133         $self->{config}->{credentials}->{username}
1134     );
1135
1136     # Actually login.
1137     if ($seed) {
1138         my $response = $U->simplereq(
1139             'open-ils.auth',
1140             'open-ils.auth.authenticate.complete',
1141             {
1142                 username => $self->{config}->{credentials}->{username},
1143                 password => md5_hex(
1144                     $seed . md5_hex($self->{config}->{credentials}->{password})
1145                 ),
1146                 type => 'staff',
1147                 workstation => $self->{config}->{credentials}->{workstation}
1148             }
1149         );
1150         if ($response) {
1151             $self->{session}->{authtoken} = $response->{payload}->{authtoken};
1152             $self->{session}->{authtime} = $response->{payload}->{authtime};
1153
1154             # Set/reset the work_ou and user data in case something changed.
1155
1156             # Retrieve the work_ou as an object.
1157             $self->{session}->{work_ou} = $U->simplereq(
1158                 'open-ils.pcrud',
1159                 'open-ils.pcrud.search.aou',
1160                 $self->{session}->{authtoken},
1161                 {shortname => $self->{config}->{credentials}->{work_ou}}
1162             );
1163
1164             # We need the user information in order to do some things.
1165             $self->{session}->{user} = $U->check_user_session($self->{session}->{authtoken});
1166
1167         }
1168     }
1169 }
1170
1171 =head2 checkauth
1172
1173     $valid = $ils->checkauth();
1174
1175 Returns 1 if the object a 'valid' authtoken, 0 if not.
1176
1177 =cut
1178
1179 sub checkauth {
1180     my $self = shift;
1181
1182     # We use AppUtils to do the heavy lifting.
1183     if (defined($self->{session})) {
1184         if ($U->check_user_session($self->{session}->{authtoken})) {
1185             return 1;
1186         } else {
1187             return 0;
1188         }
1189     }
1190
1191     # If we reach here, we don't have a session, so we are definitely
1192     # not logged in.
1193     return 0;
1194 }
1195
1196 =head2 retrieve_user_by_barcode
1197
1198     $user = $ils->retrieve_user_by_barcode($user_barcode, $user_idfield);
1199
1200 Do a fleshed retrieve of a patron by barcode. Return the patron if
1201 found and valid. Return a NCIP::Problem of 'Unknown User' otherwise.
1202
1203 The id field argument is used for the ProblemElement field in the
1204 NCIP::Problem object.
1205
1206 An invalid patron is one where the barcode is not found in the
1207 database, the patron is deleted, or the barcode used to retrieve the
1208 patron is not active. The problem element is also returned if an error
1209 occurs during the retrieval.
1210
1211 =cut
1212
1213 sub retrieve_user_by_barcode {
1214     my ($self, $barcode, $idfield) = @_;
1215     my $result = $U->simplereq(
1216         'open-ils.actor',
1217         'open-ils.actor.user.fleshed.retrieve_by_barcode',
1218         $self->{session}->{authtoken},
1219         $barcode,
1220         1
1221     );
1222
1223     # Check for a failure, or a deleted, inactive, or expired user,
1224     # and if so, return empty userdata.
1225     if (!$result || $U->event_code($result) || $U->is_true($result->deleted())
1226             || !grep {$_->barcode() eq $barcode && $U->is_true($_->active())} @{$result->cards()}) {
1227
1228         my $problem = NCIP::Problem->new();
1229         $problem->ProblemType('Unknown User');
1230         $problem->ProblemDetail("User with barcode $barcode unknown");
1231         $problem->ProblemElement($idfield);
1232         $problem->ProblemValue($barcode);
1233         $result = $problem;
1234     }
1235
1236     return $result;
1237 }
1238
1239 =head2 retrieve_user_by_id
1240
1241     $user = $ils->retrieve_user_by_id($id);
1242
1243 Similar to C<retrieve_user_by_barcode> but takes the user's database
1244 id rather than barcode. This is useful when you have a circulation or
1245 hold and need to get information about the user's involved in the hold
1246 or circulaiton.
1247
1248 It returns a fleshed user on success or undef on failure.
1249
1250 =cut
1251
1252 sub retrieve_user_by_id {
1253     my ($self, $id) = @_;
1254
1255     # Do a fleshed retrieve of the patron, and flesh the fields that
1256     # we would normally use.
1257     my $result = $U->simplereq(
1258         'open-ils.actor',
1259         'open-ils.actor.user.fleshed.retrieve',
1260         $self->{session}->{authtoken},
1261         $id,
1262         [ 'card', 'cards', 'standing_penalties', 'addresses', 'home_ou' ]
1263     );
1264     # Check for an error.
1265     undef($result) if ($result && $U->event_code($result));
1266
1267     return $result;
1268 }
1269
1270 =head2 check_user_for_problems
1271
1272     $problem = $ils>check_user_for_problems($user, 'HOLD, 'CIRC', 'RENEW');
1273
1274 This function checks if a user has a blocked profile or any from a
1275 list of provided blocks. If it does, then a NCIP::Problem object is
1276 returned, otherwise an undefined value is returned.
1277
1278 The list of blocks appears as additional arguments after the user. You
1279 can provide any value(s) that might appear in a standing penalty block
1280 lit in Evergreen. The example above checks for HOLD, CIRC, and
1281 RENEW. Any number of such values can be provided. If none are
1282 provided, the function only checks if the patron's profiles appears in
1283 the object's blocked profiles list.
1284
1285 It stops on the first matching block, if any.
1286
1287 =cut
1288
1289 sub check_user_for_problems {
1290     my $self = shift;
1291     my $user = shift;
1292     my @blocks = @_;
1293
1294     # Fill this in if we have a problem, otherwise just return it.
1295     my $problem;
1296
1297     # First, check the user's profile.
1298     if (grep {$_->id() == $user->profile()} @{$self->{blocked_profiles}}) {
1299         $problem = NCIP::Problem->new(
1300             {
1301                 ProblemType => 'User Blocked',
1302                 ProblemDetail => 'User blocked from inter-library loan',
1303                 ProblemElement => 'NULL',
1304                 ProblemValue => 'NULL'
1305             }
1306         );
1307     }
1308
1309     # Next, check if the patron has one of the indicated blocks.
1310     unless ($problem) {
1311         foreach my $block (@blocks) {
1312             if (grep {$_->standing_penalty->block_list() =~ /$block/} @{$user->standing_penalties()}) {
1313                 $problem = NCIP::Problem->new(
1314                     {
1315                         ProblemType => 'User Blocked',
1316                         ProblemDetail => 'User blocked from ' .
1317                             ($block eq 'HOLD') ? 'holds' : (($block eq 'RENEW') ? 'renewals' :
1318                                                                 (($block eq 'CIRC') ? 'checkout' : lc($block))),
1319                         ProblemElement => 'NULL',
1320                         ProblemValue => 'NULL'
1321                     }
1322                 );
1323                 last;
1324             }
1325         }
1326     }
1327
1328     return $problem;
1329 }
1330
1331 =head2 check_circ_details
1332
1333     $problem = $ils->check_circ_details($circ, $copy, $user);
1334
1335 Checks if we can checkin or renew a circulation. That is, the
1336 circulation is still open (i.e. the copy is still checked out), if we
1337 either own the copy or are the circulation location, and if the
1338 circulation is for the optional $user argument. $circ and $copy are
1339 required. $user is optional.
1340
1341 Returns a problem if any of the above conditions fail. Returns undef
1342 if they pass and we can proceed with the checkin or renewal.
1343
1344 If the failure occurred on the copy-related checks, then the
1345 ProblemElement field will be undefined and needs to be filled in with
1346 the item id field name. If the check for the copy being checked out to
1347 the provided user fails, then both ProblemElement and ProblemValue
1348 fields will be empty and need to be filled in by the caller.
1349
1350 =cut
1351
1352 sub check_circ_details {
1353     my ($self, $circ, $copy, $user) = @_;
1354
1355     # Shortcut for the next check.
1356     my $ou_id = $self->{session}->{work_ou}->id();
1357
1358     if (!$circ || $circ->checkin_time() || ($circ->circ_lib() != $ou_id && $copy->circ_lib() != $ou_id)) {
1359         # Item isn't checked out.
1360         return NCIP::Problem->new(
1361             {
1362                 ProblemType => 'Item Not Checked Out',
1363                 ProblemDetail => 'Item with barcode ' . $copy->barcode() . ' is not checked out.',
1364                 ProblemValue => $copy->barcode()
1365             }
1366         );
1367     } else {
1368         # Get data on the patron who has it checked out.
1369         my $circ_user = $self->retrieve_user_by_id($circ->usr());
1370         if ($user && $circ_user && $user->id() != $circ_user->id()) {
1371             # The ProblemElement and ProblemValue field need to be
1372             # filled in by the caller.
1373             return NCIP::Problem->new(
1374                 {
1375                     ProblemType => 'Item Not Checked Out To This User',
1376                     ProblemDetail => 'Item with barcode ' . $copy->barcode() . ' is not checked out to this user.',
1377                 }
1378             );
1379         }
1380     }
1381     # If we get here, we're good to go.
1382     return undef;
1383 }
1384
1385 =head2 retrieve_copy_details_by_barcode
1386
1387     $copy = $ils->retrieve_copy_details_by_barcode($copy_barcode);
1388
1389 Look up and retrieve some copy details by the copy barcode. This
1390 method returns either a hashref with the copy details or undefined if
1391 no copy exists with that barcode or if some error occurs.
1392
1393 The hashref has the fields copy, hold, transit, circ, volume, and mvr.
1394
1395 This method differs from C<retrieve_user_by_barcode> in that a copy
1396 cannot be invalid if it exists and it is not always an error if no
1397 copy exists. In some cases, when handling AcceptItem, we might prefer
1398 there to be no copy.
1399
1400 =cut
1401
1402 sub retrieve_copy_details_by_barcode {
1403     my $self = shift;
1404     my $barcode = shift;
1405
1406     my $copy = $U->simplereq(
1407         'open-ils.circ',
1408         'open-ils.circ.copy_details.retrieve.barcode',
1409         $self->{session}->{authtoken},
1410         $barcode
1411     );
1412
1413     # If $copy is an event, return undefined.
1414     if ($copy && $U->event_code($copy)) {
1415         undef($copy);
1416     }
1417
1418     return $copy;
1419 }
1420
1421 =head2 retrieve_org_unit_by_shortname
1422
1423     $org_unit = $ils->retrieve_org_unit_by_shortname($shortname);
1424
1425 Retrieves an org. unit from the database by shortname. Returns the
1426 org. unit as a Fieldmapper object or undefined.
1427
1428 =cut
1429
1430 sub retrieve_org_unit_by_shortname {
1431     my $self = shift;
1432     my $shortname = shift;
1433
1434     my $aou = $U->simplereq(
1435         'open-ils.actor',
1436         'open-ils.actor.org_unit.retrieve_by_shortname',
1437         $shortname
1438     );
1439
1440     return $aou;
1441 }
1442
1443 =head2 retrieve_copy_location
1444
1445     $location = $ils->retrieve_copy_location($location_id);
1446
1447 Retrieve a copy location based on id.
1448
1449 =cut
1450
1451 sub retrieve_copy_location {
1452     my $self = shift;
1453     my $id = shift;
1454
1455     my $location = $U->simplereq(
1456         'open-ils.pcrud',
1457         'open-ils.pcrud.retrieve.acpl',
1458         $self->{session}->{authtoken},
1459         $id
1460     );
1461
1462     return $location;
1463 }
1464
1465 =head2 retrieve_biblio_record_entry
1466
1467     $bre = $ils->retrieve_biblio_record_entry($bre_id);
1468
1469 Given a biblio.record_entry.id, this method retrieves a bre object.
1470
1471 =cut
1472
1473 sub retrieve_biblio_record_entry {
1474     my $self = shift;
1475     my $id = shift;
1476
1477     my $bre = $U->simplereq(
1478         'open-ils.pcrud',
1479         'open-ils.pcrud.retrieve.bre',
1480         $self->{session}->{authtoken},
1481         $id
1482     );
1483
1484     return $bre;
1485 }
1486
1487 =head2 create_precat_copy
1488
1489     $item_info->{
1490         barcode => '312340123456789',
1491         author => 'Public, John Q.',
1492         title => 'Magnum Opus',
1493         call_number => '005.82',
1494         publisher => 'Brick House',
1495         publication_date => '2014'
1496     };
1497
1498     $item = $ils->create_precat_copy($item_info);
1499
1500
1501 Create a "precat" copy to use for the incoming item using a hashref of
1502 item information. At a minimum, the barcode, author and title fields
1503 need to be filled in. The other fields are ignored if provided.
1504
1505 This method is called by the AcceptItem handler if the C<use_precats>
1506 configuration option is turned on.
1507
1508 =cut
1509
1510 sub create_precat_copy {
1511     my $self = shift;
1512     my $item_info = shift;
1513
1514     my $item = Fieldmapper::asset::copy->new();
1515     $item->barcode($item_info->{barcode});
1516     $item->call_number(OILS_PRECAT_CALL_NUMBER);
1517     $item->dummy_title($item_info->{title});
1518     $item->dummy_author($item_info->{author});
1519     $item->circ_lib($self->{session}->{work_ou}->id());
1520     $item->circulate('t');
1521     $item->holdable('t');
1522     $item->opac_visible('f');
1523     $item->deleted('f');
1524     $item->fine_level(OILS_PRECAT_COPY_FINE_LEVEL);
1525     $item->loan_duration(OILS_PRECAT_COPY_LOAN_DURATION);
1526     $item->location(1);
1527     $item->status(0);
1528     $item->editor($self->{session}->{user}->id());
1529     $item->creator($self->{session}->{user}->id());
1530     $item->isnew(1);
1531
1532     # Actually create it:
1533     my $xact;
1534     my $ses = OpenSRF::AppSession->create('open-ils.pcrud');
1535     $ses->connect();
1536     eval {
1537         $xact = $ses->request(
1538             'open-ils.pcrud.transaction.begin',
1539             $self->{session}->{authtoken}
1540         )->gather(1);
1541         $item = $ses->request(
1542             'open-ils.pcrud.create.acp',
1543             $self->{session}->{authtoken},
1544             $item
1545         )->gather(1);
1546         $xact = $ses->request(
1547             'open-ils.pcrud.transaction.commit',
1548             $self->{session}->{authtoken}
1549         )->gather(1);
1550     };
1551     if ($@) {
1552         undef($item);
1553         if ($xact) {
1554             eval {
1555                 $ses->request(
1556                     'open-ils.pcrud.transaction.rollback',
1557                     $self->{session}->{authtoken}
1558                 )->gather(1);
1559             };
1560         }
1561     }
1562     $ses->disconnect();
1563
1564     return $item;
1565 }
1566
1567 =head2 create_fuller_copy
1568
1569     $item_info->{
1570         barcode => '31234003456789',
1571         author => 'Public, John Q.',
1572         title => 'Magnum Opus',
1573         call_number => '005.82',
1574         publisher => 'Brick House',
1575         publication_date => '2014'
1576     };
1577
1578     $item = $ils->create_fuller_copy($item_info);
1579
1580 Creates a skeletal bibliographic record, call number, and copy for the
1581 incoming item using a hashref with item information in it. At a
1582 minimum, the barcode, author, title, and call_number fields must be
1583 filled in.
1584
1585 This method is used by the AcceptItem handler if the C<use_precats>
1586 configuration option is NOT set.
1587
1588 =cut
1589
1590 sub create_fuller_copy {
1591     my $self = shift;
1592     my $item_info = shift;
1593
1594     my $item;
1595
1596     # We do everything in one transaction, because it should be atomic.
1597     my $ses = OpenSRF::AppSession->create('open-ils.pcrud');
1598     $ses->connect();
1599     my $xact;
1600     eval {
1601         $xact = $ses->request(
1602             'open-ils.pcrud.transaction.begin',
1603             $self->{session}->{authtoken}
1604         )->gather(1);
1605     };
1606     if ($@) {
1607         undef($xact);
1608     }
1609
1610     # The rest depends on there being a transaction.
1611     if ($xact) {
1612
1613         # Create the MARC record.
1614         my $record = MARC::Record->new();
1615         $record->encoding('UTF-8');
1616         $record->leader('00881nam a2200193   4500');
1617         my $datespec = strftime("%Y%m%d%H%M%S.0", localtime);
1618         my @fields = ();
1619         push(@fields, MARC::Field->new('005', $datespec));
1620         push(@fields, MARC::Field->new('082', '0', '4', 'a' => $item_info->{call_number}));
1621         push(@fields, MARC::Field->new('245', '0', '0', 'a' => $item_info->{title}));
1622         # Publisher is a little trickier:
1623         if ($item_info->{publisher}) {
1624             my $pub = MARC::Field->new('260', ' ', ' ', 'a' => '[S.l.]', 'b' => $item_info->{publisher});
1625             $pub->add_subfields('c' => $item_info->{publication_date}) if ($item_info->{publication_date});
1626             push(@fields, $pub);
1627         }
1628         # We have no idea if the author is personal corporate or something else, so we use a 720.
1629         push(@fields, MARC::Field->new('720', ' ', ' ', 'a' => $item_info->{author}, '4' => 'aut'));
1630         $record->append_fields(@fields);
1631         my $marc = clean_marc($record);
1632
1633         # Create the bib object.
1634         my $bib = Fieldmapper::biblio::record_entry->new();
1635         $bib->creator($self->{session}->{user}->id());
1636         $bib->editor($self->{session}->{user}->id());
1637         $bib->source($self->{bib_source}->id());
1638         $bib->active('t');
1639         $bib->deleted('f');
1640         $bib->marc($marc);
1641         $bib->isnew(1);
1642
1643         eval {
1644             $bib = $ses->request(
1645                 'open-ils.pcrud.create.bre',
1646                 $self->{session}->{authtoken},
1647                 $bib
1648             )->gather(1);
1649         };
1650         if ($@) {
1651             undef($bib);
1652             eval {
1653                 $ses->request(
1654                     'open-ils.pcrud.transaction.rollback',
1655                     $self->{session}->{authtoken}
1656                 )->gather(1);
1657             };
1658         }
1659
1660         # Create the call number
1661         my $acn;
1662         if ($bib) {
1663             $acn = Fieldmapper::asset::call_number->new();
1664             $acn->creator($self->{session}->{user}->id());
1665             $acn->editor($self->{session}->{user}->id());
1666             $acn->label($item_info->{call_number});
1667             $acn->record($bib->id());
1668             $acn->owning_lib($self->{session}->{work_ou}->id());
1669             $acn->deleted('f');
1670             $acn->isnew(1);
1671
1672             eval {
1673                 $acn = $ses->request(
1674                     'open-ils.pcrud.create.acn',
1675                     $self->{session}->{authtoken},
1676                     $acn
1677                 )->gather(1);
1678             };
1679             if ($@) {
1680                 undef($acn);
1681                 eval {
1682                     $ses->request(
1683                         'open-ils.pcrud.transaction.rollback',
1684                         $self->{session}->{authtoken}
1685                     )->gather(1);
1686                 };
1687             }
1688         }
1689
1690         # create the copy
1691         if ($acn) {
1692             $item = Fieldmapper::asset::copy->new();
1693             $item->barcode($item_info->{barcode});
1694             $item->call_number($acn->id());
1695             $item->circ_lib($self->{session}->{work_ou}->id);
1696             $item->circulate('t');
1697             if ($self->{config}->{items}->{use_force_holds}) {
1698                 $item->holdable('f');
1699             } else {
1700                 $item->holdable('t');
1701             }
1702             $item->opac_visible('f');
1703             $item->deleted('f');
1704             $item->fine_level(OILS_PRECAT_COPY_FINE_LEVEL);
1705             $item->loan_duration(OILS_PRECAT_COPY_LOAN_DURATION);
1706             $item->location(1);
1707             $item->status(0);
1708             $item->editor($self->{session}->{user}->id);
1709             $item->creator($self->{session}->{user}->id);
1710             $item->isnew(1);
1711
1712             eval {
1713                 $item = $ses->request(
1714                     'open-ils.pcrud.create.acp',
1715                     $self->{session}->{authtoken},
1716                     $item
1717                 )->gather(1);
1718
1719                 # Cross our fingers and commit the work.
1720                 $xact = $ses->request(
1721                     'open-ils.pcrud.transaction.commit',
1722                     $self->{session}->{authtoken}
1723                 )->gather(1);
1724             };
1725             if ($@) {
1726                 undef($item);
1727                 eval {
1728                     $ses->request(
1729                         'open-ils.pcrud.transaction.rollback',
1730                         $self->{session}->{authtoken}
1731                     )->gather(1) if ($xact);
1732                 };
1733             }
1734         }
1735     }
1736
1737     # We need to disconnect our session.
1738     $ses->disconnect();
1739
1740     # Now, we handle our asset stat_cat entries.
1741     if ($item) {
1742         # It would be nice to do these in the above transaction, but
1743         # pcrud does not support the ascecm object, yet.
1744         foreach my $entry (@{$self->{stat_cat_entries}}) {
1745             my $map = Fieldmapper::asset::stat_cat_entry_copy_map->new();
1746             $map->isnew(1);
1747             $map->stat_cat($entry->stat_cat());
1748             $map->stat_cat_entry($entry->id());
1749             $map->owning_copy($item->id());
1750             # We don't really worry if it succeeds or not.
1751             $U->simplereq(
1752                 'open-ils.circ',
1753                 'open-ils.circ.stat_cat.asset.copy_map.create',
1754                 $self->{session}->{authtoken},
1755                 $map
1756             );
1757         }
1758     }
1759
1760     return $item;
1761 }
1762
1763 =head2 place_hold
1764
1765     $hold = $ils->place_hold($item, $user, $location);
1766
1767 This function places a hold on $item for $user for pickup at
1768 $location. If location is not provided or undefined, the user's home
1769 library is used as a fallback.
1770
1771 $item can be a copy (asset::copy), volume (asset::call_number), or bib
1772 (biblio::record_entry). The appropriate hold type will be placed
1773 depending on the object.
1774
1775 On success, the method returns the object representing the hold. On
1776 failure, a NCIP::Problem object, describing the failure, is returned.
1777
1778 =cut
1779
1780 sub place_hold {
1781     my $self = shift;
1782     my $item = shift;
1783     my $user = shift;
1784     my $location = shift;
1785
1786     # If $location is undefined, use the user's home_ou, which should
1787     # have been fleshed when the user was retrieved.
1788     $location = $user->home_ou() unless ($location);
1789
1790     # $hold is the hold. $params is for the is_possible check.
1791     my ($hold, $params);
1792
1793     # Prep the hold with fields common to all hold types:
1794     $hold = Fieldmapper::action::hold_request->new();
1795     $hold->isnew(1); # Just to make sure.
1796     $hold->target($item->id());
1797     $hold->usr($user->id());
1798     $hold->pickup_lib($location->id());
1799     if (!$user->email()) {
1800         $hold->email_notify('f');
1801         $hold->phone_notify($user->day_phone()) if ($user->day_phone());
1802     } else {
1803         $hold->email_notify('t');
1804     }
1805
1806     # Ditto the params:
1807     $params = { pickup_lib => $location->id(), patronid => $user->id() };
1808
1809     if (ref($item) eq 'Fieldmapper::asset::copy') {
1810         my $type = ($self->{config}->{items}->{use_force_holds}) ? 'F' : 'C';
1811         $hold->hold_type($type);
1812         $hold->current_copy($item->id());
1813         $params->{hold_type} = $type;
1814         $params->{copy_id} = $item->id();
1815     } elsif (ref($item) eq 'Fieldmapper::asset::call_number') {
1816         $hold->hold_type('V');
1817         $params->{hold_type} = 'V';
1818         $params->{volume_id} = $item->id();
1819     } elsif (ref($item) eq 'Fieldmapper::biblio::record_entry') {
1820         $hold->hold_type('T');
1821         $params->{hold_type} = 'T';
1822         $params->{titleid} = $item->id();
1823     }
1824
1825     # Check for a duplicate hold:
1826     my $duplicate = $U->simplereq(
1827         'open-ils.pcrud',
1828         'open-ils.pcrud.search.ahr',
1829         $self->{session}->{authtoken},
1830         {
1831             hold_type => $hold->hold_type(),
1832             target => $hold->target(),
1833             usr => $hold->usr(),
1834             expire_time => {'>' => 'now'},
1835             cancel_time => undef,
1836             fulfillment_time => undef
1837         }
1838     );
1839     if ($duplicate) {
1840         return NCIP::Problem->new(
1841             {
1842                 ProblemType => 'Duplicate Request',
1843                 ProblemDetail => 'A request for this item already exists for this patron.',
1844                 ProblemElement => 'NULL',
1845                 ProblemValue => 'NULL'
1846             }
1847         );
1848     }
1849
1850     # Check if the hold is possible:
1851     my $r = $U->simplereq(
1852         'open-ils.circ',
1853         'open-ils.circ.title_hold.is_possible',
1854         $self->{session}->{authtoken},
1855         $params
1856     );
1857
1858     if ($r->{success}) {
1859         $hold = $U->simplereq(
1860             'open-ils.circ',
1861             'open-ils.circ.holds.create.override',
1862             $self->{session}->{authtoken},
1863             $hold
1864         );
1865         if (ref($hold) eq 'HASH') {
1866             $hold = _problem_from_event('Request Not Possible', $hold);
1867         }
1868     } elsif ($r->{last_event}) {
1869         $hold = _problem_from_event('Request Not Possible', $r->{last_event});
1870     } elsif ($r->{textcode}) {
1871         $hold = _problem_from_event('Request Not Possible', $r);
1872     } else {
1873         $hold = _problem_from_event('Request Not Possible');
1874     }
1875
1876     return $hold;
1877 }
1878
1879 =head2 delete_copy
1880
1881     $ils->delete_copy($copy);
1882
1883 Deletes the copy, and if it is owned by our work_ou and not a precat,
1884 we also delete the volume and bib on which the copy depends.
1885
1886 =cut
1887
1888 sub delete_copy {
1889     my $self = shift;
1890     my $copy = shift;
1891
1892     # Shortcut for ownership checks below.
1893     my $ou_id = $self->{session}->{work_ou}->id();
1894
1895     # First, make sure the copy is not already deleted and we own it.
1896     return undef if ($U->is_true($copy->deleted()) || $copy->circ_lib() != $ou_id);
1897
1898     # Indicate we want to delete the copy.
1899     $copy->isdeleted(1);
1900
1901     # Delete the copy using a backend call that will delete the copy,
1902     # the call number, and bib when appropriate.
1903     my $result = $U->simplereq(
1904         'open-ils.cat',
1905         'open-ils.cat.asset.copy.fleshed.batch.update.override',
1906         $self->{session}->{authtoken},
1907         [$copy]
1908     );
1909
1910     # We are currently not checking for succes or failure of the
1911     # above. At some point, someone may want to.
1912
1913     return undef;
1914 }
1915
1916 =head2 copy_can_circulate
1917
1918     $can_circulate = $ils->copy_can_circulate($copy);
1919
1920 Check if the copy's location and the copy itself allow
1921 circulation. Return true if they do, and false if they do not.
1922
1923 =cut
1924
1925 sub copy_can_circulate {
1926     my $self = shift;
1927     my $copy = shift;
1928
1929     my $location = $copy->location();
1930     unless (ref($location)) {
1931         $location = $self->retrieve_copy_location($location);
1932     }
1933
1934     return ($U->is_true($copy->circulate()) && $U->is_true($location->circulate()));
1935 }
1936
1937 =head2 copy_can_fulfill
1938
1939     $can_fulfill = $ils->copy_can_fulfill($copy);
1940
1941 Check if the copy's location and the copy itself allow
1942 holds. Return true if they do, and false if they do not.
1943
1944 =cut
1945
1946 sub copy_can_fulfill {
1947     my $self = shift;
1948     my $copy = shift;
1949
1950     my $location = $copy->location();
1951     unless (ref($location)) {
1952         $location = $self->retrieve_copy_location($location);
1953     }
1954
1955     return ($U->is_true($copy->holdable()) && $U->is_true($location->holdable()));
1956 }
1957
1958 =head1 OVERRIDDEN PARENT METHODS
1959
1960 =head2 find_user_barcode
1961
1962 We dangerously override our parent's C<find_user_barcode> to return
1963 either the $barcode or a Problem object. In list context the barcode
1964 or problem will be the first argument and the id field, if any, will
1965 be the second. We also add a second, optional, argument to indicate a
1966 default value for the id field in the event of a failure to find
1967 anything at all. (Perl lets us get away with this.)
1968
1969 =cut
1970
1971 sub find_user_barcode {
1972     my $self = shift;
1973     my $request = shift;
1974     my $default = shift;
1975
1976     unless ($default) {
1977         my $message = $self->parse_request_type($request);
1978         if ($message eq 'LookupUser') {
1979             $default = 'AuthenticationInputData';
1980         } else {
1981             $default = 'UserIdentifierValue';
1982         }
1983     }
1984
1985     my ($value, $idfield) = $self->SUPER::find_user_barcode($request);
1986
1987     unless ($value) {
1988         $idfield = $default unless ($idfield);
1989         $value = NCIP::Problem->new();
1990         $value->ProblemType('Needed Data Missing');
1991         $value->ProblemDetail('Cannot find user barcode in message.');
1992         $value->ProblemElement($idfield);
1993         $value->ProblemValue('NULL');
1994     }
1995
1996     return (wantarray) ? ($value, $idfield) : $value;
1997 }
1998
1999 =head2 find_item_barcode
2000
2001 We do pretty much the same thing as with C<find_user_barcode> for
2002 C<find_item_barcode>.
2003
2004 =cut
2005
2006 sub find_item_barcode {
2007     my $self = shift;
2008     my $request = shift;
2009     my $default = shift || 'ItemIdentifierValue';
2010
2011     my ($value, $idfield) = $self->SUPER::find_item_barcode($request);
2012
2013     unless ($value) {
2014         $idfield = $default unless ($idfield);
2015         $value = NCIP::Problem->new();
2016         $value->ProblemType('Needed Data Missing');
2017         $value->ProblemDetail('Cannot find item barcode in message.');
2018         $value->ProblemElement($idfield);
2019         $value->ProblemValue('NULL');
2020     }
2021
2022     return (wantarray) ? ($value, $idfield) : $value;
2023 }
2024
2025 =head2 find_target_via_bibliographic_id
2026
2027     $item = $ils->find_target_via_bibliographic_id(@biblio_ids);
2028
2029 Searches for a bibliographic record to put on hold and returns an
2030 appropriate hold target item depending upon what it finds. If an
2031 appropriate, single target cannot be found, it returns an
2032 NCIP::Problem with the problem message.
2033
2034 Currently, we only look for SYSNUMBER, ISBN, and ISSN record
2035 identifiers. If nothing is found, this method can return undef. (Gotta
2036 love Perl and untyped/weakly typed languages in general!)
2037
2038 TODO: Figure out how to search OCLC numbers. We probably need to use
2039 "MARC Expert Search" if we don't want to do a JSON query on
2040 metabib.full_rec.
2041
2042 =cut
2043
2044 sub find_target_via_bibliographid_id {
2045     my $self = shift;
2046     my @biblio_ids = @_;
2047
2048     # The item that we find:
2049     my $item;
2050
2051     # Id for our bib in Evergreen:
2052     my $bibid;
2053
2054     # First, let's look for a SYSNUMBER:
2055     my ($idobj) = grep
2056         { $_->{BibligraphicRecordIdentifierCode} eq 'SYSNUMBER' || $_->{BibliographicItemIdentifierCode} eq 'SYSNUMBER'
2057               || $_->{AgencyId} }
2058             @biblio_ids;
2059     if ($idobj) {
2060         my $loc;
2061         # BibliographicRecordId can have an AgencyId field if the
2062         # BibliographicRecordIdentifierCode is absent.
2063         if ($idobj->{AgencyId}) {
2064             $bibid = $idobj->{BibliographicRecordIdentifier};
2065             my $locname = $idobj->{AgencyId};
2066             if ($locname) {
2067                 $locname =~ s/.*://;
2068                 $loc = $self->retrieve_org_unit_by_shortname($locname);
2069             }
2070         } elsif ($idobj->{BibliographicRecordIdentifierCode}) {
2071             $bibid = $idobj->{BibliographicRecordIdentifierCode}
2072         } else {
2073             $bibid = $idobj->{BibliographicItemIdentifierCode}
2074         }
2075         if ($bibid && $loc) {
2076             $item = $self->_call_number_search($bibid, $loc);
2077         } else {
2078             $item = $U->simplereq(
2079                 'open-ils.pcrud',
2080                 'open-ils.pcrud.retrieve.bre',
2081                 $self->{session}->{authtoken},
2082                 $bibid
2083             );
2084         }
2085         # Check if item is deleted so we'll look for more
2086         # possibilties.
2087         undef($item) if ($item && $U->is_true($item->deleted()));
2088     }
2089
2090     # Build an array of id objects based on the other identifier fields.
2091     my @idobjs = grep
2092         {
2093             $_->{BibliographicRecordIdentifierCode} eq 'ISBN' || $_->{BibliographicItemIdentifierCode} eq 'ISBN'
2094             ||
2095             $_->{BibliographicRecordIdentifierCode} eq 'ISSN' || $_->{BibliographicItemIdentifierCode} eq 'ISSN'
2096         } @biblio_ids;
2097
2098     if (@idobjs) {
2099         my $stashed_problem;
2100         # Reuse $idobj from above.
2101         foreach $idobj (@$idobjs) {
2102             my ($idvalue, $idtype, $idfield);
2103             if ($_->{BibliographicItemIdentifier}) {
2104                 $idvalue = $_->{BibliographicItemIdentifier};
2105                 $idtype = $_->{BibliographicItemIdentifierCode};
2106                 $idfield = 'BibliographicItemIdentifier';
2107             } else {
2108                 $idvalue = $_->{BibliographicRecordIdentifier};
2109                 $idtype = $_->{BibliographicRecordIdentifierCode};
2110                 $idfield = 'BibliographicRecordIdentifier';
2111             }
2112             $item = $self->_bib_search($idvalue, $idtype);
2113             if (ref($item) eq 'NCIP::Problem') {
2114                 $stashed_problem = $item unless($stashed_problem);
2115                 $stashed_problem->ProblemElement($idfield);
2116                 undef($item);
2117             }
2118             last if ($item);
2119         }
2120         $item = $stashed_problem if (!$tem && $stashed_problem);
2121     }
2122
2123     return $item;
2124 }
2125
2126 # private subroutines not meant to be used directly by subclasses.
2127 # Most have to do with setup and/or state checking of implementation
2128 # components.
2129
2130 # Find, load, and parse our configuration file:
2131 sub _configure {
2132     my $self = shift;
2133
2134     # Find the configuration file via variables:
2135     my $file = OILS_NCIP_CONFIG_DEFAULT;
2136     $file = $ENV{OILS_NCIP_CONFIG} if ($ENV{OILS_NCIP_CONFIG});
2137
2138     $self->{config} = XMLin($file, NormaliseSpace => 2,
2139                             ForceArray => ['block_profile', 'stat_cat_entry']);
2140 }
2141
2142 # Bootstrap OpenSRF::System and load the IDL.
2143 sub _bootstrap {
2144     my $self = shift;
2145
2146     my $bootstrap_config = $self->{config}->{bootstrap};
2147     OpenSRF::System->bootstrap_client(config_file => $bootstrap_config);
2148
2149     my $idl = OpenSRF::Utils::SettingsClient->new->config_value("IDL");
2150     Fieldmapper->import(IDL => $idl);
2151 }
2152
2153 # Login and then initialize some object data based on the
2154 # configuration.
2155 sub _init {
2156     my $self = shift;
2157
2158     # Login to Evergreen.
2159     $self->login();
2160
2161     # Load the barred groups as pgt objects into a blocked_profiles
2162     # list.
2163     $self->{blocked_profiles} = [];
2164     foreach (@{$self->{config}->{patrons}->{block_profile}}) {
2165         my $pgt;
2166         if (ref $_) {
2167             $pgt = $U->simplereq(
2168                 'open-ils.pcrud',
2169                 'open-ils.pcrud.retrieve.pgt',
2170                 $self->{session}->{authtoken},
2171                 $_->{grp}
2172             );
2173         } else {
2174             $pgt = $U->simplereq(
2175                 'open-ils.pcrud',
2176                 'open-ils.pcrud.search.pgt',
2177                 $self->{session}->{authtoken},
2178                 {name => $_}
2179             );
2180         }
2181         push(@{$self->{blocked_profiles}}, $pgt) if ($pgt);
2182     }
2183
2184     # Load the bib source if we're not using precats.
2185     unless ($self->{config}->{items}->{use_precats}) {
2186         # Retrieve the default
2187         $self->{bib_source} = $U->simplereq(
2188             'open-ils.pcrud',
2189             'open-ils.pcrud.retrieve.cbs',
2190             $self->{session}->{authtoken},
2191             BIB_SOURCE_DEFAULT);
2192         my $data = $self->{config}->{items}->{bib_source};
2193         if ($data) {
2194             $data = $data->[0] if (ref($data) eq 'ARRAY');
2195             my $result;
2196             if (ref $data) {
2197                 $result = $U->simplereq(
2198                     'open-ils.pcrud',
2199                     'open-ils.pcrud.retrieve.cbs',
2200                     $self->{session}->{authtoken},
2201                     $data->{cbs}
2202                 );
2203             } else {
2204                 $result = $U->simplereq(
2205                     'open-ils.pcrud',
2206                     'open-ils.pcrud.search.cbs',
2207                     $self->{session}->{authtoken},
2208                     {source => $data}
2209                 );
2210             }
2211             $self->{bib_source} = $result if ($result);
2212         }
2213     }
2214
2215     # Load the required asset.stat_cat_entries:
2216     $self->{stat_cat_entries} = [];
2217     # First, make a regex for our ou and ancestors:
2218     my $ancestors = join("|", @{$U->get_org_ancestors($self->{session}->{work_ou}->id())});
2219     my $re = qr/(?:$ancestors)/;
2220     # Get the uniq stat_cat ids from the configuration:
2221     my @cats = uniq map {$_->{stat_cat}} @{$self->{config}->{items}->{stat_cat_entry}};
2222     # Retrieve all of the fleshed stat_cats and entries for the above.
2223     my $stat_cats = $U->simplereq(
2224         'open-ils.circ',
2225         'open-ils.circ.stat_cat.asset.retrieve.batch',
2226         $self->{session}->{authtoken},
2227         @cats
2228     );
2229     foreach my $entry (@{$self->{config}->{items}->{stat_cat_entry}}) {
2230         # Must have the stat_cat attr and the name, so we must have a
2231         # reference.
2232         next unless(ref $entry);
2233         my ($stat) = grep {$_->id() == $entry->{stat_cat}} @$stat_cats;
2234         push(@{$self->{stat_cat_entries}}, grep {$_->owner() =~ $re && $_->value() eq $entry->{content}} @{$stat->entries()});
2235     }
2236 }
2237
2238 # Search asst.call_number by a bre.id and location object. Return the
2239 # "closest" call_number if found, undef otherwise.
2240 sub _call_number_search {
2241     my $self = shift;
2242     my $bibid = shift;
2243     my $location = shift;
2244
2245     # At some point, this should be smarter, and we should retrieve
2246     # ancestors and descendants and search with a JSON query or some
2247     # such with results ordered by proximity to the original location,
2248     # but I don't have time to implement that right now.
2249     my $acn = $U->simplereq(
2250         'open-ils.prcud',
2251         'open-ils.pcrud.search.acn',
2252         $self->{session}->{authtoken},
2253         {record => $bibid, owning_lib => $location->id()}
2254     );
2255
2256     return $acn;
2257 }
2258
2259 # Do a multiclass.query to search for items by isbn or issn.
2260 sub _bib_search {
2261     my $self = shift;
2262     my $idvalue = shift;
2263     my $idtype = shift;
2264     my $item;
2265
2266     my $result = $U->simplereq(
2267         'open-ils.search',
2268         'open-ils.search.biblio.multiclass',
2269         {searches => {lc($idtype) => $idvalue}}
2270     );
2271
2272     if ($result && $result->{count}) {
2273         if ($result->{count} > 1) {
2274             $item = NCIP::Problem->new(
2275                 {
2276                     ProblemType => 'Non-Unique Item',
2277                     ProblemDetail => 'More than one item matches the request.',
2278                     ProblemElement => '',
2279                     ProblemValue => $idvalue
2280                 }
2281             );
2282         }
2283         my $bibid = $result->{ids}->[0]->[0];
2284         $item = $U->simplereq(
2285             'open-ils.pcrud',
2286             'open-ils.pcrud.retrieve.bre',
2287             $self->{session}->{authtoken},
2288             $bibid
2289         );
2290     }
2291
2292     return $item;
2293 }
2294
2295 # Standalone, "helper" functions.  These do not take an object or
2296 # class reference.
2297
2298 # Check if a user is past their expiration date.
2299 sub _expired {
2300     my $user = shift;
2301     my $expired = 0;
2302
2303     # Users might not expire.  If so, they have no expire_date.
2304     if ($user->expire_date()) {
2305         my $expires = DateTime::Format::ISO8601->parse_datetime(
2306             cleanse_ISO8601($user->expire_date())
2307         )->epoch();
2308         my $now = DateTime->now()->epoch();
2309         $expired = $now > $expires;
2310     }
2311
2312     return $expired;
2313 }
2314
2315 # Creates a NCIP Problem from an event. Takes a string for the problem
2316 # type, the event hashref (or a string to use for the detail), and
2317 # optional arguments for the ProblemElement and ProblemValue fields.
2318 sub _problem_from_event {
2319     my ($type, $evt, $element, $value) = @_;
2320
2321     my $detail;
2322
2323     # Check the event.
2324     if (ref($evt)) {
2325         my ($textcode, $desc);
2326
2327         # Get the textcode, if available. We favor those defined in
2328         # ils_events.xml over those made up on the fly.
2329         if ($evt->{ilsevent} && $evt->{ilsevent}->{textcode}) {
2330             $textcode = $evt->{ilsevent}->{textcode};
2331         } elsif ($evt->{textcode}) {
2332             $textcode = $evt->{textcode};
2333         }
2334
2335         # Get the description. We favor translated descriptions over
2336         # the English in ils_events.xml.
2337         if ($evt->{desc}) {
2338             $desc = $evt->{desc};
2339         } elsif ($evt->{ilsevent} && $evt->{ilsevent}->{desc}) {
2340             $desc = $evt->{ilsevent}->{desc};
2341         }
2342
2343         # Check if $type was set. As an "undocumented" feature, you
2344         # can pass undef, and we'll use the textcode from the event.
2345         unless ($type) {
2346             if ($textcode) {
2347                 $type = $textcode;
2348             }
2349         }
2350
2351         # Set the detail from some combination of the above.
2352         if ($desc) {
2353             $detail = $desc;
2354         } elsif ($textcode eq 'PERM_FAILURE') {
2355             if ($evt->{ilsperm}) {
2356                 $detail = "Permission denied: " . $evt->{ilsperm};
2357                 $detail =~ s/\.override$//;
2358             }
2359         } elsif ($textcode) {
2360             $detail = "ILS returned $textcode error.";
2361         } else {
2362             $detail = 'Detail not available.';
2363         }
2364
2365     } else {
2366         $detail = $evt;
2367     }
2368
2369     return NCIP::Problem->new(
2370         {
2371             ProblemType => ($type) ? $type : 'Temporary Processing Failure',
2372             ProblemDetail => ($detail) ? $detail : 'Detail not available.',
2373             ProblemElement => ($element) ? $element : 'NULL',
2374             ProblemValue => ($value) ? $value : 'NULL'
2375         }
2376     );
2377 }
2378
2379 1;