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