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     } elsif (ref($item) eq 'NCIP::Problem') {
1079         $response->problem($item);
1080         return $response;
1081     }
1082
1083     # See if we were given a PickupLocation.
1084     my $location;
1085     if ($request->{$message}->{PickupLocation}) {
1086         my $loc = $request->{$message}->{PickupLocation};
1087         $loc =~ s/^.*://; # strip everything up to the last
1088                           # semi-colon, if any.
1089         $location = $self->retrieve_org_unit_by_shortname($loc);
1090     }
1091
1092     # Place the hold.
1093     my $hold = $self->place_hold($item, $user, $location);
1094     if (ref($hold) eq 'NCIP::Problem') {
1095         $response->problem($hold);
1096     } else {
1097         my $data = {
1098             RequestId => NCIP::RequestId->new(
1099                 RequestIdentifierType => 'SYSNUMBER',
1100                 RequestIdentifierValue => $hold->id()
1101             ),
1102             UserId => NCIP::User::Id->new(
1103                 {
1104                     UserIdentifierType => 'Barcode Id',
1105                     UserIdentifierValue => $user->card->barcode()
1106                 }
1107             ),
1108             RequestType => $request->{$message}->{RequestType},
1109             RequestScopeType => ($hold->hold_type() eq 'V') ? "item" : "bibliographic item"
1110         };
1111         $response->data($data);
1112     }
1113
1114     return $response;
1115 }
1116
1117 =head1 METHODS USEFUL to SUBCLASSES
1118
1119 =head2 login
1120
1121     $ils->login();
1122
1123 Login to Evergreen via OpenSRF. It uses internal state from the
1124 configuration file to login.
1125
1126 =cut
1127
1128 # Login via OpenSRF to Evergreen.
1129 sub login {
1130     my $self = shift;
1131
1132     # Get the authentication seed.
1133     my $seed = $U->simplereq(
1134         'open-ils.auth',
1135         'open-ils.auth.authenticate.init',
1136         $self->{config}->{credentials}->{username}
1137     );
1138
1139     # Actually login.
1140     if ($seed) {
1141         my $response = $U->simplereq(
1142             'open-ils.auth',
1143             'open-ils.auth.authenticate.complete',
1144             {
1145                 username => $self->{config}->{credentials}->{username},
1146                 password => md5_hex(
1147                     $seed . md5_hex($self->{config}->{credentials}->{password})
1148                 ),
1149                 type => 'staff',
1150                 workstation => $self->{config}->{credentials}->{workstation}
1151             }
1152         );
1153         if ($response) {
1154             $self->{session}->{authtoken} = $response->{payload}->{authtoken};
1155             $self->{session}->{authtime} = $response->{payload}->{authtime};
1156
1157             # Set/reset the work_ou and user data in case something changed.
1158
1159             # Retrieve the work_ou as an object.
1160             $self->{session}->{work_ou} = $U->simplereq(
1161                 'open-ils.pcrud',
1162                 'open-ils.pcrud.search.aou',
1163                 $self->{session}->{authtoken},
1164                 {shortname => $self->{config}->{credentials}->{work_ou}}
1165             );
1166
1167             # We need the user information in order to do some things.
1168             $self->{session}->{user} = $U->check_user_session($self->{session}->{authtoken});
1169
1170         }
1171     }
1172 }
1173
1174 =head2 checkauth
1175
1176     $valid = $ils->checkauth();
1177
1178 Returns 1 if the object a 'valid' authtoken, 0 if not.
1179
1180 =cut
1181
1182 sub checkauth {
1183     my $self = shift;
1184
1185     # We use AppUtils to do the heavy lifting.
1186     if (defined($self->{session})) {
1187         if ($U->check_user_session($self->{session}->{authtoken})) {
1188             return 1;
1189         } else {
1190             return 0;
1191         }
1192     }
1193
1194     # If we reach here, we don't have a session, so we are definitely
1195     # not logged in.
1196     return 0;
1197 }
1198
1199 =head2 retrieve_user_by_barcode
1200
1201     $user = $ils->retrieve_user_by_barcode($user_barcode, $user_idfield);
1202
1203 Do a fleshed retrieve of a patron by barcode. Return the patron if
1204 found and valid. Return a NCIP::Problem of 'Unknown User' otherwise.
1205
1206 The id field argument is used for the ProblemElement field in the
1207 NCIP::Problem object.
1208
1209 An invalid patron is one where the barcode is not found in the
1210 database, the patron is deleted, or the barcode used to retrieve the
1211 patron is not active. The problem element is also returned if an error
1212 occurs during the retrieval.
1213
1214 =cut
1215
1216 sub retrieve_user_by_barcode {
1217     my ($self, $barcode, $idfield) = @_;
1218     my $result = $U->simplereq(
1219         'open-ils.actor',
1220         'open-ils.actor.user.fleshed.retrieve_by_barcode',
1221         $self->{session}->{authtoken},
1222         $barcode,
1223         1
1224     );
1225
1226     # Check for a failure, or a deleted, inactive, or expired user,
1227     # and if so, return empty userdata.
1228     if (!$result || $U->event_code($result) || $U->is_true($result->deleted())
1229             || !grep {$_->barcode() eq $barcode && $U->is_true($_->active())} @{$result->cards()}) {
1230
1231         my $problem = NCIP::Problem->new();
1232         $problem->ProblemType('Unknown User');
1233         $problem->ProblemDetail("User with barcode $barcode unknown");
1234         $problem->ProblemElement($idfield);
1235         $problem->ProblemValue($barcode);
1236         $result = $problem;
1237     }
1238
1239     return $result;
1240 }
1241
1242 =head2 retrieve_user_by_id
1243
1244     $user = $ils->retrieve_user_by_id($id);
1245
1246 Similar to C<retrieve_user_by_barcode> but takes the user's database
1247 id rather than barcode. This is useful when you have a circulation or
1248 hold and need to get information about the user's involved in the hold
1249 or circulaiton.
1250
1251 It returns a fleshed user on success or undef on failure.
1252
1253 =cut
1254
1255 sub retrieve_user_by_id {
1256     my ($self, $id) = @_;
1257
1258     # Do a fleshed retrieve of the patron, and flesh the fields that
1259     # we would normally use.
1260     my $result = $U->simplereq(
1261         'open-ils.actor',
1262         'open-ils.actor.user.fleshed.retrieve',
1263         $self->{session}->{authtoken},
1264         $id,
1265         [ 'card', 'cards', 'standing_penalties', 'addresses', 'home_ou' ]
1266     );
1267     # Check for an error.
1268     undef($result) if ($result && $U->event_code($result));
1269
1270     return $result;
1271 }
1272
1273 =head2 check_user_for_problems
1274
1275     $problem = $ils>check_user_for_problems($user, 'HOLD, 'CIRC', 'RENEW');
1276
1277 This function checks if a user has a blocked profile or any from a
1278 list of provided blocks. If it does, then a NCIP::Problem object is
1279 returned, otherwise an undefined value is returned.
1280
1281 The list of blocks appears as additional arguments after the user. You
1282 can provide any value(s) that might appear in a standing penalty block
1283 lit in Evergreen. The example above checks for HOLD, CIRC, and
1284 RENEW. Any number of such values can be provided. If none are
1285 provided, the function only checks if the patron's profiles appears in
1286 the object's blocked profiles list.
1287
1288 It stops on the first matching block, if any.
1289
1290 =cut
1291
1292 sub check_user_for_problems {
1293     my $self = shift;
1294     my $user = shift;
1295     my @blocks = @_;
1296
1297     # Fill this in if we have a problem, otherwise just return it.
1298     my $problem;
1299
1300     # First, check the user's profile.
1301     if (grep {$_->id() == $user->profile()} @{$self->{blocked_profiles}}) {
1302         $problem = NCIP::Problem->new(
1303             {
1304                 ProblemType => 'User Blocked',
1305                 ProblemDetail => 'User blocked from inter-library loan',
1306                 ProblemElement => 'NULL',
1307                 ProblemValue => 'NULL'
1308             }
1309         );
1310     }
1311
1312     # Next, check if the patron has one of the indicated blocks.
1313     unless ($problem) {
1314         foreach my $block (@blocks) {
1315             if (grep {$_->standing_penalty->block_list() =~ /$block/} @{$user->standing_penalties()}) {
1316                 $problem = NCIP::Problem->new(
1317                     {
1318                         ProblemType => 'User Blocked',
1319                         ProblemDetail => 'User blocked from ' .
1320                             ($block eq 'HOLD') ? 'holds' : (($block eq 'RENEW') ? 'renewals' :
1321                                                                 (($block eq 'CIRC') ? 'checkout' : lc($block))),
1322                         ProblemElement => 'NULL',
1323                         ProblemValue => 'NULL'
1324                     }
1325                 );
1326                 last;
1327             }
1328         }
1329     }
1330
1331     return $problem;
1332 }
1333
1334 =head2 check_circ_details
1335
1336     $problem = $ils->check_circ_details($circ, $copy, $user);
1337
1338 Checks if we can checkin or renew a circulation. That is, the
1339 circulation is still open (i.e. the copy is still checked out), if we
1340 either own the copy or are the circulation location, and if the
1341 circulation is for the optional $user argument. $circ and $copy are
1342 required. $user is optional.
1343
1344 Returns a problem if any of the above conditions fail. Returns undef
1345 if they pass and we can proceed with the checkin or renewal.
1346
1347 If the failure occurred on the copy-related checks, then the
1348 ProblemElement field will be undefined and needs to be filled in with
1349 the item id field name. If the check for the copy being checked out to
1350 the provided user fails, then both ProblemElement and ProblemValue
1351 fields will be empty and need to be filled in by the caller.
1352
1353 =cut
1354
1355 sub check_circ_details {
1356     my ($self, $circ, $copy, $user) = @_;
1357
1358     # Shortcut for the next check.
1359     my $ou_id = $self->{session}->{work_ou}->id();
1360
1361     if (!$circ || $circ->checkin_time() || ($circ->circ_lib() != $ou_id && $copy->circ_lib() != $ou_id)) {
1362         # Item isn't checked out.
1363         return NCIP::Problem->new(
1364             {
1365                 ProblemType => 'Item Not Checked Out',
1366                 ProblemDetail => 'Item with barcode ' . $copy->barcode() . ' is not checked out.',
1367                 ProblemValue => $copy->barcode()
1368             }
1369         );
1370     } else {
1371         # Get data on the patron who has it checked out.
1372         my $circ_user = $self->retrieve_user_by_id($circ->usr());
1373         if ($user && $circ_user && $user->id() != $circ_user->id()) {
1374             # The ProblemElement and ProblemValue field need to be
1375             # filled in by the caller.
1376             return NCIP::Problem->new(
1377                 {
1378                     ProblemType => 'Item Not Checked Out To This User',
1379                     ProblemDetail => 'Item with barcode ' . $copy->barcode() . ' is not checked out to this user.',
1380                 }
1381             );
1382         }
1383     }
1384     # If we get here, we're good to go.
1385     return undef;
1386 }
1387
1388 =head2 retrieve_copy_details_by_barcode
1389
1390     $copy = $ils->retrieve_copy_details_by_barcode($copy_barcode);
1391
1392 Look up and retrieve some copy details by the copy barcode. This
1393 method returns either a hashref with the copy details or undefined if
1394 no copy exists with that barcode or if some error occurs.
1395
1396 The hashref has the fields copy, hold, transit, circ, volume, and mvr.
1397
1398 This method differs from C<retrieve_user_by_barcode> in that a copy
1399 cannot be invalid if it exists and it is not always an error if no
1400 copy exists. In some cases, when handling AcceptItem, we might prefer
1401 there to be no copy.
1402
1403 =cut
1404
1405 sub retrieve_copy_details_by_barcode {
1406     my $self = shift;
1407     my $barcode = shift;
1408
1409     my $copy = $U->simplereq(
1410         'open-ils.circ',
1411         'open-ils.circ.copy_details.retrieve.barcode',
1412         $self->{session}->{authtoken},
1413         $barcode
1414     );
1415
1416     # If $copy is an event, return undefined.
1417     if ($copy && $U->event_code($copy)) {
1418         undef($copy);
1419     }
1420
1421     return $copy;
1422 }
1423
1424 =head2 retrieve_org_unit_by_shortname
1425
1426     $org_unit = $ils->retrieve_org_unit_by_shortname($shortname);
1427
1428 Retrieves an org. unit from the database by shortname. Returns the
1429 org. unit as a Fieldmapper object or undefined.
1430
1431 =cut
1432
1433 sub retrieve_org_unit_by_shortname {
1434     my $self = shift;
1435     my $shortname = shift;
1436
1437     my $aou = $U->simplereq(
1438         'open-ils.actor',
1439         'open-ils.actor.org_unit.retrieve_by_shortname',
1440         $shortname
1441     );
1442
1443     return $aou;
1444 }
1445
1446 =head2 retrieve_copy_location
1447
1448     $location = $ils->retrieve_copy_location($location_id);
1449
1450 Retrieve a copy location based on id.
1451
1452 =cut
1453
1454 sub retrieve_copy_location {
1455     my $self = shift;
1456     my $id = shift;
1457
1458     my $location = $U->simplereq(
1459         'open-ils.pcrud',
1460         'open-ils.pcrud.retrieve.acpl',
1461         $self->{session}->{authtoken},
1462         $id
1463     );
1464
1465     return $location;
1466 }
1467
1468 =head2 retrieve_biblio_record_entry
1469
1470     $bre = $ils->retrieve_biblio_record_entry($bre_id);
1471
1472 Given a biblio.record_entry.id, this method retrieves a bre object.
1473
1474 =cut
1475
1476 sub retrieve_biblio_record_entry {
1477     my $self = shift;
1478     my $id = shift;
1479
1480     my $bre = $U->simplereq(
1481         'open-ils.pcrud',
1482         'open-ils.pcrud.retrieve.bre',
1483         $self->{session}->{authtoken},
1484         $id
1485     );
1486
1487     return $bre;
1488 }
1489
1490 =head2 create_precat_copy
1491
1492     $item_info->{
1493         barcode => '312340123456789',
1494         author => 'Public, John Q.',
1495         title => 'Magnum Opus',
1496         call_number => '005.82',
1497         publisher => 'Brick House',
1498         publication_date => '2014'
1499     };
1500
1501     $item = $ils->create_precat_copy($item_info);
1502
1503
1504 Create a "precat" copy to use for the incoming item using a hashref of
1505 item information. At a minimum, the barcode, author and title fields
1506 need to be filled in. The other fields are ignored if provided.
1507
1508 This method is called by the AcceptItem handler if the C<use_precats>
1509 configuration option is turned on.
1510
1511 =cut
1512
1513 sub create_precat_copy {
1514     my $self = shift;
1515     my $item_info = shift;
1516
1517     my $item = Fieldmapper::asset::copy->new();
1518     $item->barcode($item_info->{barcode});
1519     $item->call_number(OILS_PRECAT_CALL_NUMBER);
1520     $item->dummy_title($item_info->{title});
1521     $item->dummy_author($item_info->{author});
1522     $item->circ_lib($self->{session}->{work_ou}->id());
1523     $item->circulate('t');
1524     $item->holdable('t');
1525     $item->opac_visible('f');
1526     $item->deleted('f');
1527     $item->fine_level(OILS_PRECAT_COPY_FINE_LEVEL);
1528     $item->loan_duration(OILS_PRECAT_COPY_LOAN_DURATION);
1529     $item->location(1);
1530     $item->status(0);
1531     $item->editor($self->{session}->{user}->id());
1532     $item->creator($self->{session}->{user}->id());
1533     $item->isnew(1);
1534
1535     # Actually create it:
1536     my $xact;
1537     my $ses = OpenSRF::AppSession->create('open-ils.pcrud');
1538     $ses->connect();
1539     eval {
1540         $xact = $ses->request(
1541             'open-ils.pcrud.transaction.begin',
1542             $self->{session}->{authtoken}
1543         )->gather(1);
1544         $item = $ses->request(
1545             'open-ils.pcrud.create.acp',
1546             $self->{session}->{authtoken},
1547             $item
1548         )->gather(1);
1549         $xact = $ses->request(
1550             'open-ils.pcrud.transaction.commit',
1551             $self->{session}->{authtoken}
1552         )->gather(1);
1553     };
1554     if ($@) {
1555         undef($item);
1556         if ($xact) {
1557             eval {
1558                 $ses->request(
1559                     'open-ils.pcrud.transaction.rollback',
1560                     $self->{session}->{authtoken}
1561                 )->gather(1);
1562             };
1563         }
1564     }
1565     $ses->disconnect();
1566
1567     return $item;
1568 }
1569
1570 =head2 create_fuller_copy
1571
1572     $item_info->{
1573         barcode => '31234003456789',
1574         author => 'Public, John Q.',
1575         title => 'Magnum Opus',
1576         call_number => '005.82',
1577         publisher => 'Brick House',
1578         publication_date => '2014'
1579     };
1580
1581     $item = $ils->create_fuller_copy($item_info);
1582
1583 Creates a skeletal bibliographic record, call number, and copy for the
1584 incoming item using a hashref with item information in it. At a
1585 minimum, the barcode, author, title, and call_number fields must be
1586 filled in.
1587
1588 This method is used by the AcceptItem handler if the C<use_precats>
1589 configuration option is NOT set.
1590
1591 =cut
1592
1593 sub create_fuller_copy {
1594     my $self = shift;
1595     my $item_info = shift;
1596
1597     my $item;
1598
1599     # We do everything in one transaction, because it should be atomic.
1600     my $ses = OpenSRF::AppSession->create('open-ils.pcrud');
1601     $ses->connect();
1602     my $xact;
1603     eval {
1604         $xact = $ses->request(
1605             'open-ils.pcrud.transaction.begin',
1606             $self->{session}->{authtoken}
1607         )->gather(1);
1608     };
1609     if ($@) {
1610         undef($xact);
1611     }
1612
1613     # The rest depends on there being a transaction.
1614     if ($xact) {
1615
1616         # Create the MARC record.
1617         my $record = MARC::Record->new();
1618         $record->encoding('UTF-8');
1619         $record->leader('00881nam a2200193   4500');
1620         my $datespec = strftime("%Y%m%d%H%M%S.0", localtime);
1621         my @fields = ();
1622         push(@fields, MARC::Field->new('005', $datespec));
1623         push(@fields, MARC::Field->new('082', '0', '4', 'a' => $item_info->{call_number}));
1624         push(@fields, MARC::Field->new('245', '0', '0', 'a' => $item_info->{title}));
1625         # Publisher is a little trickier:
1626         if ($item_info->{publisher}) {
1627             my $pub = MARC::Field->new('260', ' ', ' ', 'a' => '[S.l.]', 'b' => $item_info->{publisher});
1628             $pub->add_subfields('c' => $item_info->{publication_date}) if ($item_info->{publication_date});
1629             push(@fields, $pub);
1630         }
1631         # We have no idea if the author is personal corporate or something else, so we use a 720.
1632         push(@fields, MARC::Field->new('720', ' ', ' ', 'a' => $item_info->{author}, '4' => 'aut'));
1633         $record->append_fields(@fields);
1634         my $marc = clean_marc($record);
1635
1636         # Create the bib object.
1637         my $bib = Fieldmapper::biblio::record_entry->new();
1638         $bib->creator($self->{session}->{user}->id());
1639         $bib->editor($self->{session}->{user}->id());
1640         $bib->source($self->{bib_source}->id());
1641         $bib->active('t');
1642         $bib->deleted('f');
1643         $bib->marc($marc);
1644         $bib->isnew(1);
1645
1646         eval {
1647             $bib = $ses->request(
1648                 'open-ils.pcrud.create.bre',
1649                 $self->{session}->{authtoken},
1650                 $bib
1651             )->gather(1);
1652         };
1653         if ($@) {
1654             undef($bib);
1655             eval {
1656                 $ses->request(
1657                     'open-ils.pcrud.transaction.rollback',
1658                     $self->{session}->{authtoken}
1659                 )->gather(1);
1660             };
1661         }
1662
1663         # Create the call number
1664         my $acn;
1665         if ($bib) {
1666             $acn = Fieldmapper::asset::call_number->new();
1667             $acn->creator($self->{session}->{user}->id());
1668             $acn->editor($self->{session}->{user}->id());
1669             $acn->label($item_info->{call_number});
1670             $acn->record($bib->id());
1671             $acn->owning_lib($self->{session}->{work_ou}->id());
1672             $acn->deleted('f');
1673             $acn->isnew(1);
1674
1675             eval {
1676                 $acn = $ses->request(
1677                     'open-ils.pcrud.create.acn',
1678                     $self->{session}->{authtoken},
1679                     $acn
1680                 )->gather(1);
1681             };
1682             if ($@) {
1683                 undef($acn);
1684                 eval {
1685                     $ses->request(
1686                         'open-ils.pcrud.transaction.rollback',
1687                         $self->{session}->{authtoken}
1688                     )->gather(1);
1689                 };
1690             }
1691         }
1692
1693         # create the copy
1694         if ($acn) {
1695             $item = Fieldmapper::asset::copy->new();
1696             $item->barcode($item_info->{barcode});
1697             $item->call_number($acn->id());
1698             $item->circ_lib($self->{session}->{work_ou}->id);
1699             $item->circulate('t');
1700             if ($self->{config}->{items}->{use_force_holds}) {
1701                 $item->holdable('f');
1702             } else {
1703                 $item->holdable('t');
1704             }
1705             $item->opac_visible('f');
1706             $item->deleted('f');
1707             $item->fine_level(OILS_PRECAT_COPY_FINE_LEVEL);
1708             $item->loan_duration(OILS_PRECAT_COPY_LOAN_DURATION);
1709             $item->location(1);
1710             $item->status(0);
1711             $item->editor($self->{session}->{user}->id);
1712             $item->creator($self->{session}->{user}->id);
1713             $item->isnew(1);
1714
1715             eval {
1716                 $item = $ses->request(
1717                     'open-ils.pcrud.create.acp',
1718                     $self->{session}->{authtoken},
1719                     $item
1720                 )->gather(1);
1721
1722                 # Cross our fingers and commit the work.
1723                 $xact = $ses->request(
1724                     'open-ils.pcrud.transaction.commit',
1725                     $self->{session}->{authtoken}
1726                 )->gather(1);
1727             };
1728             if ($@) {
1729                 undef($item);
1730                 eval {
1731                     $ses->request(
1732                         'open-ils.pcrud.transaction.rollback',
1733                         $self->{session}->{authtoken}
1734                     )->gather(1) if ($xact);
1735                 };
1736             }
1737         }
1738     }
1739
1740     # We need to disconnect our session.
1741     $ses->disconnect();
1742
1743     # Now, we handle our asset stat_cat entries.
1744     if ($item) {
1745         # It would be nice to do these in the above transaction, but
1746         # pcrud does not support the ascecm object, yet.
1747         foreach my $entry (@{$self->{stat_cat_entries}}) {
1748             my $map = Fieldmapper::asset::stat_cat_entry_copy_map->new();
1749             $map->isnew(1);
1750             $map->stat_cat($entry->stat_cat());
1751             $map->stat_cat_entry($entry->id());
1752             $map->owning_copy($item->id());
1753             # We don't really worry if it succeeds or not.
1754             $U->simplereq(
1755                 'open-ils.circ',
1756                 'open-ils.circ.stat_cat.asset.copy_map.create',
1757                 $self->{session}->{authtoken},
1758                 $map
1759             );
1760         }
1761     }
1762
1763     return $item;
1764 }
1765
1766 =head2 place_hold
1767
1768     $hold = $ils->place_hold($item, $user, $location);
1769
1770 This function places a hold on $item for $user for pickup at
1771 $location. If location is not provided or undefined, the user's home
1772 library is used as a fallback.
1773
1774 $item can be a copy (asset::copy), volume (asset::call_number), or bib
1775 (biblio::record_entry). The appropriate hold type will be placed
1776 depending on the object.
1777
1778 On success, the method returns the object representing the hold. On
1779 failure, a NCIP::Problem object, describing the failure, is returned.
1780
1781 =cut
1782
1783 sub place_hold {
1784     my $self = shift;
1785     my $item = shift;
1786     my $user = shift;
1787     my $location = shift;
1788
1789     # If $location is undefined, use the user's home_ou, which should
1790     # have been fleshed when the user was retrieved.
1791     $location = $user->home_ou() unless ($location);
1792
1793     # $hold is the hold. $params is for the is_possible check.
1794     my ($hold, $params);
1795
1796     # Prep the hold with fields common to all hold types:
1797     $hold = Fieldmapper::action::hold_request->new();
1798     $hold->isnew(1); # Just to make sure.
1799     $hold->target($item->id());
1800     $hold->usr($user->id());
1801     $hold->pickup_lib($location->id());
1802     if (!$user->email()) {
1803         $hold->email_notify('f');
1804         $hold->phone_notify($user->day_phone()) if ($user->day_phone());
1805     } else {
1806         $hold->email_notify('t');
1807     }
1808
1809     # Ditto the params:
1810     $params = { pickup_lib => $location->id(), patronid => $user->id() };
1811
1812     if (ref($item) eq 'Fieldmapper::asset::copy') {
1813         my $type = ($self->{config}->{items}->{use_force_holds}) ? 'F' : 'C';
1814         $hold->hold_type($type);
1815         $hold->current_copy($item->id());
1816         $params->{hold_type} = $type;
1817         $params->{copy_id} = $item->id();
1818     } elsif (ref($item) eq 'Fieldmapper::asset::call_number') {
1819         $hold->hold_type('V');
1820         $params->{hold_type} = 'V';
1821         $params->{volume_id} = $item->id();
1822     } elsif (ref($item) eq 'Fieldmapper::biblio::record_entry') {
1823         $hold->hold_type('T');
1824         $params->{hold_type} = 'T';
1825         $params->{titleid} = $item->id();
1826     }
1827
1828     # Check for a duplicate hold:
1829     my $duplicate = $U->simplereq(
1830         'open-ils.pcrud',
1831         'open-ils.pcrud.search.ahr',
1832         $self->{session}->{authtoken},
1833         {
1834             hold_type => $hold->hold_type(),
1835             target => $hold->target(),
1836             usr => $hold->usr(),
1837             expire_time => {'>' => 'now'},
1838             cancel_time => undef,
1839             fulfillment_time => undef
1840         }
1841     );
1842     if ($duplicate) {
1843         return NCIP::Problem->new(
1844             {
1845                 ProblemType => 'Duplicate Request',
1846                 ProblemDetail => 'A request for this item already exists for this patron.',
1847                 ProblemElement => 'NULL',
1848                 ProblemValue => 'NULL'
1849             }
1850         );
1851     }
1852
1853     # Check if the hold is possible:
1854     my $r = $U->simplereq(
1855         'open-ils.circ',
1856         'open-ils.circ.title_hold.is_possible',
1857         $self->{session}->{authtoken},
1858         $params
1859     );
1860
1861     if ($r->{success}) {
1862         $hold = $U->simplereq(
1863             'open-ils.circ',
1864             'open-ils.circ.holds.create.override',
1865             $self->{session}->{authtoken},
1866             $hold
1867         );
1868         if (ref($hold) eq 'HASH') {
1869             $hold = _problem_from_event('Request Not Possible', $hold);
1870         }
1871     } elsif ($r->{last_event}) {
1872         $hold = _problem_from_event('Request Not Possible', $r->{last_event});
1873     } elsif ($r->{textcode}) {
1874         $hold = _problem_from_event('Request Not Possible', $r);
1875     } else {
1876         $hold = _problem_from_event('Request Not Possible');
1877     }
1878
1879     return $hold;
1880 }
1881
1882 =head2 delete_copy
1883
1884     $ils->delete_copy($copy);
1885
1886 Deletes the copy, and if it is owned by our work_ou and not a precat,
1887 we also delete the volume and bib on which the copy depends.
1888
1889 =cut
1890
1891 sub delete_copy {
1892     my $self = shift;
1893     my $copy = shift;
1894
1895     # Shortcut for ownership checks below.
1896     my $ou_id = $self->{session}->{work_ou}->id();
1897
1898     # First, make sure the copy is not already deleted and we own it.
1899     return undef if ($U->is_true($copy->deleted()) || $copy->circ_lib() != $ou_id);
1900
1901     # Indicate we want to delete the copy.
1902     $copy->isdeleted(1);
1903
1904     # Delete the copy using a backend call that will delete the copy,
1905     # the call number, and bib when appropriate.
1906     my $result = $U->simplereq(
1907         'open-ils.cat',
1908         'open-ils.cat.asset.copy.fleshed.batch.update.override',
1909         $self->{session}->{authtoken},
1910         [$copy]
1911     );
1912
1913     # We are currently not checking for succes or failure of the
1914     # above. At some point, someone may want to.
1915
1916     return undef;
1917 }
1918
1919 =head2 copy_can_circulate
1920
1921     $can_circulate = $ils->copy_can_circulate($copy);
1922
1923 Check if the copy's location and the copy itself allow
1924 circulation. Return true if they do, and false if they do not.
1925
1926 =cut
1927
1928 sub copy_can_circulate {
1929     my $self = shift;
1930     my $copy = shift;
1931
1932     my $location = $copy->location();
1933     unless (ref($location)) {
1934         $location = $self->retrieve_copy_location($location);
1935     }
1936
1937     return ($U->is_true($copy->circulate()) && $U->is_true($location->circulate()));
1938 }
1939
1940 =head2 copy_can_fulfill
1941
1942     $can_fulfill = $ils->copy_can_fulfill($copy);
1943
1944 Check if the copy's location and the copy itself allow
1945 holds. Return true if they do, and false if they do not.
1946
1947 =cut
1948
1949 sub copy_can_fulfill {
1950     my $self = shift;
1951     my $copy = shift;
1952
1953     my $location = $copy->location();
1954     unless (ref($location)) {
1955         $location = $self->retrieve_copy_location($location);
1956     }
1957
1958     return ($U->is_true($copy->holdable()) && $U->is_true($location->holdable()));
1959 }
1960
1961 =head1 OVERRIDDEN PARENT METHODS
1962
1963 =head2 find_user_barcode
1964
1965 We dangerously override our parent's C<find_user_barcode> to return
1966 either the $barcode or a Problem object. In list context the barcode
1967 or problem will be the first argument and the id field, if any, will
1968 be the second. We also add a second, optional, argument to indicate a
1969 default value for the id field in the event of a failure to find
1970 anything at all. (Perl lets us get away with this.)
1971
1972 =cut
1973
1974 sub find_user_barcode {
1975     my $self = shift;
1976     my $request = shift;
1977     my $default = shift;
1978
1979     unless ($default) {
1980         my $message = $self->parse_request_type($request);
1981         if ($message eq 'LookupUser') {
1982             $default = 'AuthenticationInputData';
1983         } else {
1984             $default = 'UserIdentifierValue';
1985         }
1986     }
1987
1988     my ($value, $idfield) = $self->SUPER::find_user_barcode($request);
1989
1990     unless ($value) {
1991         $idfield = $default unless ($idfield);
1992         $value = NCIP::Problem->new();
1993         $value->ProblemType('Needed Data Missing');
1994         $value->ProblemDetail('Cannot find user barcode in message.');
1995         $value->ProblemElement($idfield);
1996         $value->ProblemValue('NULL');
1997     }
1998
1999     return (wantarray) ? ($value, $idfield) : $value;
2000 }
2001
2002 =head2 find_item_barcode
2003
2004 We do pretty much the same thing as with C<find_user_barcode> for
2005 C<find_item_barcode>.
2006
2007 =cut
2008
2009 sub find_item_barcode {
2010     my $self = shift;
2011     my $request = shift;
2012     my $default = shift || 'ItemIdentifierValue';
2013
2014     my ($value, $idfield) = $self->SUPER::find_item_barcode($request);
2015
2016     unless ($value) {
2017         $idfield = $default unless ($idfield);
2018         $value = NCIP::Problem->new();
2019         $value->ProblemType('Needed Data Missing');
2020         $value->ProblemDetail('Cannot find item barcode in message.');
2021         $value->ProblemElement($idfield);
2022         $value->ProblemValue('NULL');
2023     }
2024
2025     return (wantarray) ? ($value, $idfield) : $value;
2026 }
2027
2028 =head2 find_target_via_bibliographic_id
2029
2030     $item = $ils->find_target_via_bibliographic_id(@biblio_ids);
2031
2032 Searches for a bibliographic record to put on hold and returns an
2033 appropriate hold target item depending upon what it finds. If an
2034 appropriate, single target cannot be found, it returns an
2035 NCIP::Problem with the problem message.
2036
2037 Currently, we only look for SYSNUMBER, ISBN, and ISSN record
2038 identifiers. If nothing is found, this method can return undef. (Gotta
2039 love Perl and untyped/weakly typed languages in general!)
2040
2041 TODO: Figure out how to search OCLC numbers. We probably need to use
2042 "MARC Expert Search" if we don't want to do a JSON query on
2043 metabib.full_rec.
2044
2045 =cut
2046
2047 sub find_target_via_bibliographid_id {
2048     my $self = shift;
2049     my @biblio_ids = @_;
2050
2051     # The item that we find:
2052     my $item;
2053
2054     # Id for our bib in Evergreen:
2055     my $bibid;
2056
2057     # First, let's look for a SYSNUMBER:
2058     my ($idobj) = grep
2059         { $_->{BibligraphicRecordIdentifierCode} eq 'SYSNUMBER' || $_->{BibliographicItemIdentifierCode} eq 'SYSNUMBER'
2060               || $_->{AgencyId} }
2061             @biblio_ids;
2062     if ($idobj) {
2063         my $loc;
2064         # BibliographicRecordId can have an AgencyId field if the
2065         # BibliographicRecordIdentifierCode is absent.
2066         if ($idobj->{AgencyId}) {
2067             $bibid = $idobj->{BibliographicRecordIdentifier};
2068             my $locname = $idobj->{AgencyId};
2069             if ($locname) {
2070                 $locname =~ s/.*://;
2071                 $loc = $self->retrieve_org_unit_by_shortname($locname);
2072             }
2073         } elsif ($idobj->{BibliographicRecordIdentifierCode}) {
2074             $bibid = $idobj->{BibliographicRecordIdentifierCode}
2075         } else {
2076             $bibid = $idobj->{BibliographicItemIdentifierCode}
2077         }
2078         if ($bibid && $loc) {
2079             $item = $self->_call_number_search($bibid, $loc);
2080         } else {
2081             $item = $U->simplereq(
2082                 'open-ils.pcrud',
2083                 'open-ils.pcrud.retrieve.bre',
2084                 $self->{session}->{authtoken},
2085                 $bibid
2086             );
2087         }
2088         # Check if item is deleted so we'll look for more
2089         # possibilties.
2090         undef($item) if ($item && $U->is_true($item->deleted()));
2091     }
2092
2093     # Build an array of id objects based on the other identifier fields.
2094     my @idobjs = grep
2095         {
2096             $_->{BibliographicRecordIdentifierCode} eq 'ISBN' || $_->{BibliographicItemIdentifierCode} eq 'ISBN'
2097             ||
2098             $_->{BibliographicRecordIdentifierCode} eq 'ISSN' || $_->{BibliographicItemIdentifierCode} eq 'ISSN'
2099         } @biblio_ids;
2100
2101     if (@idobjs) {
2102         my $stashed_problem;
2103         # Reuse $idobj from above.
2104         foreach $idobj (@$idobjs) {
2105             my ($idvalue, $idtype, $idfield);
2106             if ($_->{BibliographicItemIdentifier}) {
2107                 $idvalue = $_->{BibliographicItemIdentifier};
2108                 $idtype = $_->{BibliographicItemIdentifierCode};
2109                 $idfield = 'BibliographicItemIdentifier';
2110             } else {
2111                 $idvalue = $_->{BibliographicRecordIdentifier};
2112                 $idtype = $_->{BibliographicRecordIdentifierCode};
2113                 $idfield = 'BibliographicRecordIdentifier';
2114             }
2115             $item = $self->_bib_search($idvalue, $idtype);
2116             if (ref($item) eq 'NCIP::Problem') {
2117                 $stashed_problem = $item unless($stashed_problem);
2118                 $stashed_problem->ProblemElement($idfield);
2119                 undef($item);
2120             }
2121             last if ($item);
2122         }
2123         $item = $stashed_problem if (!$tem && $stashed_problem);
2124     }
2125
2126     return $item;
2127 }
2128
2129 # private subroutines not meant to be used directly by subclasses.
2130 # Most have to do with setup and/or state checking of implementation
2131 # components.
2132
2133 # Find, load, and parse our configuration file:
2134 sub _configure {
2135     my $self = shift;
2136
2137     # Find the configuration file via variables:
2138     my $file = OILS_NCIP_CONFIG_DEFAULT;
2139     $file = $ENV{OILS_NCIP_CONFIG} if ($ENV{OILS_NCIP_CONFIG});
2140
2141     $self->{config} = XMLin($file, NormaliseSpace => 2,
2142                             ForceArray => ['block_profile', 'stat_cat_entry']);
2143 }
2144
2145 # Bootstrap OpenSRF::System and load the IDL.
2146 sub _bootstrap {
2147     my $self = shift;
2148
2149     my $bootstrap_config = $self->{config}->{bootstrap};
2150     OpenSRF::System->bootstrap_client(config_file => $bootstrap_config);
2151
2152     my $idl = OpenSRF::Utils::SettingsClient->new->config_value("IDL");
2153     Fieldmapper->import(IDL => $idl);
2154 }
2155
2156 # Login and then initialize some object data based on the
2157 # configuration.
2158 sub _init {
2159     my $self = shift;
2160
2161     # Login to Evergreen.
2162     $self->login();
2163
2164     # Load the barred groups as pgt objects into a blocked_profiles
2165     # list.
2166     $self->{blocked_profiles} = [];
2167     foreach (@{$self->{config}->{patrons}->{block_profile}}) {
2168         my $pgt;
2169         if (ref $_) {
2170             $pgt = $U->simplereq(
2171                 'open-ils.pcrud',
2172                 'open-ils.pcrud.retrieve.pgt',
2173                 $self->{session}->{authtoken},
2174                 $_->{grp}
2175             );
2176         } else {
2177             $pgt = $U->simplereq(
2178                 'open-ils.pcrud',
2179                 'open-ils.pcrud.search.pgt',
2180                 $self->{session}->{authtoken},
2181                 {name => $_}
2182             );
2183         }
2184         push(@{$self->{blocked_profiles}}, $pgt) if ($pgt);
2185     }
2186
2187     # Load the bib source if we're not using precats.
2188     unless ($self->{config}->{items}->{use_precats}) {
2189         # Retrieve the default
2190         $self->{bib_source} = $U->simplereq(
2191             'open-ils.pcrud',
2192             'open-ils.pcrud.retrieve.cbs',
2193             $self->{session}->{authtoken},
2194             BIB_SOURCE_DEFAULT);
2195         my $data = $self->{config}->{items}->{bib_source};
2196         if ($data) {
2197             $data = $data->[0] if (ref($data) eq 'ARRAY');
2198             my $result;
2199             if (ref $data) {
2200                 $result = $U->simplereq(
2201                     'open-ils.pcrud',
2202                     'open-ils.pcrud.retrieve.cbs',
2203                     $self->{session}->{authtoken},
2204                     $data->{cbs}
2205                 );
2206             } else {
2207                 $result = $U->simplereq(
2208                     'open-ils.pcrud',
2209                     'open-ils.pcrud.search.cbs',
2210                     $self->{session}->{authtoken},
2211                     {source => $data}
2212                 );
2213             }
2214             $self->{bib_source} = $result if ($result);
2215         }
2216     }
2217
2218     # Load the required asset.stat_cat_entries:
2219     $self->{stat_cat_entries} = [];
2220     # First, make a regex for our ou and ancestors:
2221     my $ancestors = join("|", @{$U->get_org_ancestors($self->{session}->{work_ou}->id())});
2222     my $re = qr/(?:$ancestors)/;
2223     # Get the uniq stat_cat ids from the configuration:
2224     my @cats = uniq map {$_->{stat_cat}} @{$self->{config}->{items}->{stat_cat_entry}};
2225     # Retrieve all of the fleshed stat_cats and entries for the above.
2226     my $stat_cats = $U->simplereq(
2227         'open-ils.circ',
2228         'open-ils.circ.stat_cat.asset.retrieve.batch',
2229         $self->{session}->{authtoken},
2230         @cats
2231     );
2232     foreach my $entry (@{$self->{config}->{items}->{stat_cat_entry}}) {
2233         # Must have the stat_cat attr and the name, so we must have a
2234         # reference.
2235         next unless(ref $entry);
2236         my ($stat) = grep {$_->id() == $entry->{stat_cat}} @$stat_cats;
2237         push(@{$self->{stat_cat_entries}}, grep {$_->owner() =~ $re && $_->value() eq $entry->{content}} @{$stat->entries()});
2238     }
2239 }
2240
2241 # Search asset.call_number by a bre.id and location object. Return the
2242 # "closest" call_number if found, undef otherwise.
2243 sub _call_number_search {
2244     my $self = shift;
2245     my $bibid = shift;
2246     my $location = shift;
2247
2248     # At some point, this should be smarter, and we should retrieve
2249     # ancestors and descendants and search with a JSON query or some
2250     # such with results ordered by proximity to the original location,
2251     # but I don't have time to implement that right now.
2252     my $acn = $U->simplereq(
2253         'open-ils.prcud',
2254         'open-ils.pcrud.search.acn',
2255         $self->{session}->{authtoken},
2256         {record => $bibid, owning_lib => $location->id()}
2257     );
2258
2259     return $acn;
2260 }
2261
2262 # Do a multiclass.query to search for items by isbn or issn.
2263 sub _bib_search {
2264     my $self = shift;
2265     my $idvalue = shift;
2266     my $idtype = shift;
2267     my $item;
2268
2269     my $result = $U->simplereq(
2270         'open-ils.search',
2271         'open-ils.search.biblio.multiclass',
2272         {searches => {lc($idtype) => $idvalue}}
2273     );
2274
2275     if ($result && $result->{count}) {
2276         if ($result->{count} > 1) {
2277             $item = NCIP::Problem->new(
2278                 {
2279                     ProblemType => 'Non-Unique Item',
2280                     ProblemDetail => 'More than one item matches the request.',
2281                     ProblemElement => '',
2282                     ProblemValue => $idvalue
2283                 }
2284             );
2285         }
2286         my $bibid = $result->{ids}->[0]->[0];
2287         $item = $U->simplereq(
2288             'open-ils.pcrud',
2289             'open-ils.pcrud.retrieve.bre',
2290             $self->{session}->{authtoken},
2291             $bibid
2292         );
2293     }
2294
2295     return $item;
2296 }
2297
2298 # Standalone, "helper" functions.  These do not take an object or
2299 # class reference.
2300
2301 # Check if a user is past their expiration date.
2302 sub _expired {
2303     my $user = shift;
2304     my $expired = 0;
2305
2306     # Users might not expire.  If so, they have no expire_date.
2307     if ($user->expire_date()) {
2308         my $expires = DateTime::Format::ISO8601->parse_datetime(
2309             cleanse_ISO8601($user->expire_date())
2310         )->epoch();
2311         my $now = DateTime->now()->epoch();
2312         $expired = $now > $expires;
2313     }
2314
2315     return $expired;
2316 }
2317
2318 # Creates a NCIP Problem from an event. Takes a string for the problem
2319 # type, the event hashref (or a string to use for the detail), and
2320 # optional arguments for the ProblemElement and ProblemValue fields.
2321 sub _problem_from_event {
2322     my ($type, $evt, $element, $value) = @_;
2323
2324     my $detail;
2325
2326     # Check the event.
2327     if (ref($evt)) {
2328         my ($textcode, $desc);
2329
2330         # Get the textcode, if available. We favor those defined in
2331         # ils_events.xml over those made up on the fly.
2332         if ($evt->{ilsevent} && $evt->{ilsevent}->{textcode}) {
2333             $textcode = $evt->{ilsevent}->{textcode};
2334         } elsif ($evt->{textcode}) {
2335             $textcode = $evt->{textcode};
2336         }
2337
2338         # Get the description. We favor translated descriptions over
2339         # the English in ils_events.xml.
2340         if ($evt->{desc}) {
2341             $desc = $evt->{desc};
2342         } elsif ($evt->{ilsevent} && $evt->{ilsevent}->{desc}) {
2343             $desc = $evt->{ilsevent}->{desc};
2344         }
2345
2346         # Check if $type was set. As an "undocumented" feature, you
2347         # can pass undef, and we'll use the textcode from the event.
2348         unless ($type) {
2349             if ($textcode) {
2350                 $type = $textcode;
2351             }
2352         }
2353
2354         # Set the detail from some combination of the above.
2355         if ($desc) {
2356             $detail = $desc;
2357         } elsif ($textcode eq 'PERM_FAILURE') {
2358             if ($evt->{ilsperm}) {
2359                 $detail = "Permission denied: " . $evt->{ilsperm};
2360                 $detail =~ s/\.override$//;
2361             }
2362         } elsif ($textcode) {
2363             $detail = "ILS returned $textcode error.";
2364         } else {
2365             $detail = 'Detail not available.';
2366         }
2367
2368     } else {
2369         $detail = $evt;
2370     }
2371
2372     return NCIP::Problem->new(
2373         {
2374             ProblemType => ($type) ? $type : 'Temporary Processing Failure',
2375             ProblemDetail => ($detail) ? $detail : 'Detail not available.',
2376             ProblemElement => ($element) ? $element : 'NULL',
2377             ProblemValue => ($value) ? $value : 'NULL'
2378         }
2379     );
2380 }
2381
2382 1;