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->ProblemValue($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         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 ($result->{textcode} eq 'SUCCESS') {
 590         # Delete the copy. Since delete_copy checks ownership
 591         # before attempting to delete the copy, we don't bother
 592         # checking who owns it.
 593         $self->delete_copy($copy);
 594     }
 595
 596     # We should check for errors here, but I'll leave that for
 597     # later.
 598
 599     # We need the circulation user for the information below, so we retrieve it.
 600     my $circ_user = $self->retrieve_user_by_id($circ->usr());
 601     my $data = {
 602         ItemId => NCIP::Item::Id->new(
 603             {
 604                 AgencyId => $request->{$message}->{ItemId}->{AgencyId},
 605                 ItemIdentifierType => $request->{$message}->{ItemId}->{ItemIdentifierType},
 606                 ItemIdentifierValue => $request->{$message}->{ItemId}->{ItemIdentifierValue}
 607             }
 608         ),
 609         UserId => NCIP::User::Id->new(
 610             {
 611                 UserIdentifierType => 'Barcode Id',
 612                 UserIdentifierValue => $circ_user->card->barcode()
 613             }
 614         )
 615     };
 616
 617     $response->data($data);
 618
 619     # At some point in the future, we should probably check if
 620     # they requested optional user or item elements and return
 621     # those. For the time being, we ignore those at the risk of
 622     # being considered non-compliant.
 623
 624     return $response
 625 }
 626
 627 =head1 METHODS USEFUL to SUBCLASSES
 628
 629 =head2 login
 630
 631     $ils->login();
 632
 633 Login to Evergreen via OpenSRF. It uses internal state from the
 634 configuration file to login.
 635
 636 =cut
 637
 638 # Login via OpenSRF to Evergreen.
 639 sub login {
 640     my $self = shift;
 641
 642     # Get the authentication seed.
 643     my $seed = $U->simplereq(
 644         'open-ils.auth',
 645         'open-ils.auth.authenticate.init',
 646         $self->{config}->{credentials}->{username}
 647     );
 648
 649     # Actually login.
 650     if ($seed) {
 651         my $response = $U->simplereq(
 652             'open-ils.auth',
 653             'open-ils.auth.authenticate.complete',
 654             {
 655                 username => $self->{config}->{credentials}->{username},
 656                 password => md5_hex(
 657                     $seed . md5_hex($self->{config}->{credentials}->{password})
 658                 ),
 659                 type => 'staff',
 660                 workstation => $self->{config}->{credentials}->{workstation}
 661             }
 662         );
 663         if ($response) {
 664             $self->{session}->{authtoken} = $response->{payload}->{authtoken};
 665             $self->{session}->{authtime} = $response->{payload}->{authtime};
 666
 667             # Set/reset the work_ou and user data in case something changed.
 668
 669             # Retrieve the work_ou as an object.
 670             $self->{session}->{work_ou} = $U->simplereq(
 671                 'open-ils.pcrud',
 672                 'open-ils.pcrud.search.aou',
 673                 $self->{session}->{authtoken},
 674                 {shortname => $self->{config}->{credentials}->{work_ou}}
 675             );
 676
 677             # We need the user information in order to do some things.
 678             $self->{session}->{user} = $U->check_user_session($self->{session}->{authtoken});
 679
 680         }
 681     }
 682 }
 683
 684 =head2 checkauth
 685
 686     $valid = $ils->checkauth();
 687
 688 Returns 1 if the object a 'valid' authtoken, 0 if not.
 689
 690 =cut
 691
 692 sub checkauth {
 693     my $self = shift;
 694
 695     # We use AppUtils to do the heavy lifting.
 696     if (defined($self->{session})) {
 697         if ($U->check_user_session($self->{session}->{authtoken})) {
 698             return 1;
 699         } else {
 700             return 0;
 701         }
 702     }
 703
 704     # If we reach here, we don't have a session, so we are definitely
 705     # not logged in.
 706     return 0;
 707 }
 708
 709 =head2 retrieve_user_by_barcode
 710
 711     $user = $ils->retrieve_user_by_barcode($user_barcode, $user_idfield);
 712
 713 Do a fleshed retrieve of a patron by barcode. Return the patron if
 714 found and valid. Return a NCIP::Problem of 'Unknown User' otherwise.
 715
 716 The id field argument is used for the ProblemElement field in the
 717 NCIP::Problem object.
 718
 719 An invalid patron is one where the barcode is not found in the
 720 database, the patron is deleted, or the barcode used to retrieve the
 721 patron is not active. The problem element is also returned if an error
 722 occurs during the retrieval.
 723
 724 =cut
 725
 726 sub retrieve_user_by_barcode {
 727     my ($self, $barcode, $idfield) = @_;
 728     my $result = $U->simplereq(
 729         'open-ils.actor',
 730         'open-ils.actor.user.fleshed.retrieve_by_barcode',
 731         $self->{session}->{authtoken},
 732         $barcode,
 733         1
 734     );
 735
 736     # Check for a failure, or a deleted, inactive, or expired user,
 737     # and if so, return empty userdata.
 738     if (!$result || $U->event_code($result) || $U->is_true($result->deleted())
 739             || !grep {$_->barcode() eq $barcode && $U->is_true($_->active())} @{$result->cards()}) {
 740
 741         my $problem = NCIP::Problem->new();
 742         $problem->ProblemType('Unknown User');
 743         $problem->ProblemDetail("User with barcode $barcode unknown");
 744         $problem->ProblemElement($idfield);
 745         $problem->ProblemValue($barcode);
 746         $result = $problem;
 747     }
 748
 749     return $result;
 750 }
 751
 752 =head2 retrieve_user_by_id
 753
 754     $user = $ils->retrieve_user_by_id($id);
 755
 756 Similar to C<retrieve_user_by_barcode> but takes the user's database
 757 id rather than barcode. This is useful when you have a circulation or
 758 hold and need to get information about the user's involved in the hold
 759 or circulaiton.
 760
 761 It returns a fleshed user on success or undef on failure.
 762
 763 =cut
 764
 765 sub retrieve_user_by_id {
 766     my ($self, $id) = @_;
 767
 768     # Do a fleshed retrieve of the patron, and flesh the fields that
 769     # we would normally use.
 770     my $result = $U->simplereq(
 771         'open-ils.actor',
 772         'open-ils.actor.user.fleshed.retrieve',
 773         $self->{session}->{authtoken},
 774         $id,
 775         [ 'card', 'cards', 'standing_penalties', 'addresses', 'home_ou' ]
 776     );
 777     # Check for an error.
 778     undef($result) if ($result && $U->event_code($result));
 779
 780     return $result;
 781 }
 782
 783 =head2 check_user_for_problems
 784
 785     $problem = $ils>check_user_for_problems($user, 'HOLD, 'CIRC', 'RENEW');
 786
 787 This function checks if a user has a blocked profile or any from a
 788 list of provided blocks. If it does, then a NCIP::Problem object is
 789 returned, otherwise an undefined value is returned.
 790
 791 The list of blocks appears as additional arguments after the user. You
 792 can provide any value(s) that might appear in a standing penalty block
 793 lit in Evergreen. The example above checks for HOLD, CIRC, and
 794 RENEW. Any number of such values can be provided. If none are
 795 provided, the function only checks if the patron's profiles appears in
 796 the object's blocked profiles list.
 797
 798 It stops on the first matching block, if any.
 799
 800 =cut
 801
 802 sub check_user_for_problems {
 803     my $self = shift;
 804     my $user = shift;
 805     my @blocks = @_;
 806
 807     # Fill this in if we have a problem, otherwise just return it.
 808     my $problem;
 809
 810     # First, check the user's profile.
 811     if (grep {$_->id() == $user->profile()} @{$self->{blocked_profiles}}) {
 812         $problem = NCIP::Problem->new(
 813             {
 814                 ProblemType => 'User Blocked',
 815                 ProblemDetail => 'User blocked from inter-library loan',
 816                 ProblemElement => 'NULL',
 817                 ProblemValue => 'NULL'
 818             }
 819         );
 820     }
 821
 822     # Next, check if the patron has one of the indicated blocks.
 823     unless ($problem) {
 824         foreach my $block (@blocks) {
 825             if (grep {$_->standing_penalty->block_list() =~ /$block/} @{$user->standing_penalties()}) {
 826                 $problem = NCIP::Problem->new(
 827                     {
 828                         ProblemType => 'User Blocked',
 829                         ProblemDetail => 'User blocked from ' .
 830                             ($block eq 'HOLD') ? 'holds' : (($block eq 'RENEW') ? 'renewals' :
 831                                                                 (($block eq 'CIRC') ? 'checkout' : lc($block))),
 832                         ProblemElement => 'NULL',
 833                         ProblemValue => 'NULL'
 834                     }
 835                 );
 836                 last;
 837             }
 838         }
 839     }
 840
 841     return $problem;
 842 }
 843
 844 =head2 check_circ_details
 845
 846     $problem = $ils->check_circ_details($circ, $copy, $user);
 847
 848 Checks if we can checkin or renew a circulation. That is, the
 849 circulation is still open (i.e. the copy is still checked out), if we
 850 either own the copy or are the circulation location, and if the
 851 circulation is for the optional $user argument. $circ and $copy are
 852 required. $user is optional.
 853
 854 Returns a problem if any of the above conditions fail. Returns undef
 855 if they pass and we can proceed with the checkin or renewal.
 856
 857 If the failure occurred on the copy-related checks, then the
 858 ProblemElement field will be undefined and needs to be filled in with
 859 the item id field name. If the check for the copy being checked out to
 860 the provided user fails, then both ProblemElement and ProblemValue
 861 fields will be empty and need to be filled in by the caller.
 862
 863 =cut
 864
 865 sub check_circ_details {
 866     my ($self, $circ, $copy, $user) = @_;
 867
 868     # Shortcut for the next check.
 869     my $ou_id = $self->{session}->{work_ou}->id();
 870
 871     if (!$circ || $circ->checkin_time() || ($circ->circ_lib() != $ou_id && $copy->circ_lib() != $ou_id)) {
 872         # Item isn't checked out.
 873         return NCIP::Problem->new(
 874             {
 875                 ProblemType => 'Item Not Checked Out',
 876                 ProblemDetail => 'Item with barcode ' . $copy->barcode() . ' is not checked out.',
 877                 ProblemValue => $copy->barcode()
 878             }
 879         );
 880     } else {
 881         # Get data on the patron who has it checked out.
 882         my $circ_user = $self->retrieve_user_by_id($circ->usr());
 883         if ($user && $circ_user && $user->id() != $circ_user->id()) {
 884             # The ProblemElement and ProblemValue field need to be
 885             # filled in by the caller.
 886             return NCIP::Problem->new(
 887                 {
 888                     ProblemType => 'Item Not Checked Out To This User',
 889                     ProblemDetail => 'Item with barcode ' . $copy->barcode() . ' is not checked out to this user.',
 890                 }
 891             );
 892         }
 893     }
 894     # If we get here, we're good to go.
 895     return undef;
 896 }
 897
 898 =head2 retrieve_copy_details_by_barcode
 899
 900     $copy = $ils->retrieve_copy_details_by_barcode($copy_barcode);
 901
 902 Look up and retrieve some copy details by the copy barcode. This
 903 method returns either a hashref with the copy details or undefined if
 904 no copy exists with that barcode or if some error occurs.
 905
 906 The hashref has the fields copy, hold, transit, circ, volume, and mvr.
 907
 908 This method differs from C<retrieve_user_by_barcode> in that a copy
 909 cannot be invalid if it exists and it is not always an error if no
 910 copy exists. In some cases, when handling AcceptItem, we might prefer
 911 there to be no copy.
 912
 913 =cut
 914
 915 sub retrieve_copy_details_by_barcode {
 916     my $self = shift;
 917     my $barcode = shift;
 918
 919     my $copy = $U->simplereq(
 920         'open-ils.circ',
 921         'open-ils.circ.copy_details.retrieve.barcode',
 922         $self->{session}->{authtoken},
 923         $barcode
 924     );
 925
 926     # If $copy is an event, return undefined.
 927     if ($copy && $U->event_code($copy)) {
 928         undef($copy);
 929     }
 930
 931     return $copy;
 932 }
 933
 934 =head2 retrieve_org_unit_by_shortname
 935
 936     $org_unit = $ils->retrieve_org_unit_by_shortname($shortname);
 937
 938 Retrieves an org. unit from the database by shortname. Returns the
 939 org. unit as a Fieldmapper object or undefined.
 940
 941 =cut
 942
 943 sub retrieve_org_unit_by_shortname {
 944     my $self = shift;
 945     my $shortname = shift;
 946
 947     my $aou = $U->simplereq(
 948         'open-ils.pcrud',
 949         'open-ils.pcrud.search.aou',
 950         $self->{session}->{authtoken},
 951         {shortname => {'=' => {transform => 'lower', value => ['lower', $shortname]}}}
 952     );
 953
 954     return $aou;
 955 }
 956
 957 =head2 create_precat_copy
 958
 959     $item_info->{
 960         barcode => '312340123456789',
 961         author => 'Public, John Q.',
 962         title => 'Magnum Opus',
 963         call_number => '005.82',
 964         publisher => 'Brick House',
 965         publication_date => '2014'
 966     };
 967
 968     $item = $ils->create_precat_copy($item_info);
 969
 970
 971 Create a "precat" copy to use for the incoming item using a hashref of
 972 item information. At a minimum, the barcode, author and title fields
 973 need to be filled in. The other fields are ignored if provided.
 974
 975 This method is called by the AcceptItem handler if the C<use_precats>
 976 configuration option is turned on.
 977
 978 =cut
 979
 980 sub create_precat_copy {
 981     my $self = shift;
 982     my $item_info = shift;
 983
 984     my $item = Fieldmapper::asset::copy->new();
 985     $item->barcode($item_info->{barcode});
 986     $item->call_number(OILS_PRECAT_CALL_NUMBER);
 987     $item->dummy_title($item_info->{title});
 988     $item->dummy_author($item_info->{author});
 989     $item->circ_lib($self->{session}->{work_ou}->id());
 990     $item->circulate('t');
 991     $item->holdable('t');
 992     $item->opac_visible('f');
 993     $item->deleted('f');
 994     $item->fine_level(OILS_PRECAT_COPY_FINE_LEVEL);
 995     $item->loan_duration(OILS_PRECAT_COPY_LOAN_DURATION);
 996     $item->location(1);
 997     $item->status(0);
 998     $item->editor($self->{session}->{user}->id());
 999     $item->creator($self->{session}->{user}->id());
1000     $item->isnew(1);
1001
1002     # Actually create it:
1003     my $xact;
1004     my $ses = OpenSRF::AppSession->create('open-ils.pcrud');
1005     $ses->connect();
1006     eval {
1007         $xact = $ses->request(
1008             'open-ils.pcrud.transaction.begin',
1009             $self->{session}->{authtoken}
1010         )->gather(1);
1011         $item = $ses->request(
1012             'open-ils.pcrud.create.acp',
1013             $self->{session}->{authtoken},
1014             $item
1015         )->gather(1);
1016         $xact = $ses->request(
1017             'open-ils.pcrud.transaction.commit',
1018             $self->{session}->{authtoken}
1019         )->gather(1);
1020     };
1021     if ($@) {
1022         undef($item);
1023         if ($xact) {
1024             eval {
1025                 $ses->request(
1026                     'open-ils.pcrud.transaction.rollback',
1027                     $self->{session}->{authtoken}
1028                 )->gather(1);
1029             };
1030         }
1031     }
1032     $ses->disconnect();
1033
1034     return $item;
1035 }
1036
1037 =head2 create_fuller_copy
1038
1039     $item_info->{
1040         barcode => '31234003456789',
1041         author => 'Public, John Q.',
1042         title => 'Magnum Opus',
1043         call_number => '005.82',
1044         publisher => 'Brick House',
1045         publication_date => '2014'
1046     };
1047
1048     $item = $ils->create_fuller_copy($item_info);
1049
1050 Creates a skeletal bibliographic record, call number, and copy for the
1051 incoming item using a hashref with item information in it. At a
1052 minimum, the barcode, author, title, and call_number fields must be
1053 filled in.
1054
1055 This method is used by the AcceptItem handler if the C<use_precats>
1056 configuration option is NOT set.
1057
1058 =cut
1059
1060 sub create_fuller_copy {
1061     my $self = shift;
1062     my $item_info = shift;
1063
1064     my $item;
1065
1066     # We do everything in one transaction, because it should be atomic.
1067     my $ses = OpenSRF::AppSession->create('open-ils.pcrud');
1068     $ses->connect();
1069     my $xact;
1070     eval {
1071         $xact = $ses->request(
1072             'open-ils.pcrud.transaction.begin',
1073             $self->{session}->{authtoken}
1074         )->gather(1);
1075     };
1076     if ($@) {
1077         undef($xact);
1078     }
1079
1080     # The rest depends on there being a transaction.
1081     if ($xact) {
1082
1083         # Create the MARC record.
1084         my $record = MARC::Record->new();
1085         $record->encoding('UTF-8');
1086         $record->leader('00881nam a2200193   4500');
1087         my $datespec = strftime("%Y%m%d%H%M%S.0", localtime);
1088         my @fields = ();
1089         push(@fields, MARC::Field->new('005', $datespec));
1090         push(@fields, MARC::Field->new('082', '0', '4', 'a' => $item_info->{call_number}));
1091         push(@fields, MARC::Field->new('245', '0', '0', 'a' => $item_info->{title}));
1092         # Publisher is a little trickier:
1093         if ($item_info->{publisher}) {
1094             my $pub = MARC::Field->new('260', ' ', ' ', 'a' => '[S.l.]', 'b' => $item_info->{publisher});
1095             $pub->add_subfields('c' => $item_info->{publication_date}) if ($item_info->{publication_date});
1096             push(@fields, $pub);
1097         }
1098         # We have no idea if the author is personal corporate or something else, so we use a 720.
1099         push(@fields, MARC::Field->new('720', ' ', ' ', 'a' => $item_info->{author}, '4' => 'aut'));
1100         $record->append_fields(@fields);
1101         my $marc = clean_marc($record);
1102
1103         # Create the bib object.
1104         my $bib = Fieldmapper::biblio::record_entry->new();
1105         $bib->creator($self->{session}->{user}->id());
1106         $bib->editor($self->{session}->{user}->id());
1107         $bib->source($self->{bib_source}->id());
1108         $bib->active('t');
1109         $bib->deleted('f');
1110         $bib->marc($marc);
1111         $bib->isnew(1);
1112
1113         eval {
1114             $bib = $ses->request(
1115                 'open-ils.pcrud.create.bre',
1116                 $self->{session}->{authtoken},
1117                 $bib
1118             )->gather(1);
1119         };
1120         if ($@) {
1121             undef($bib);
1122             eval {
1123                 $ses->request(
1124                     'open-ils.pcrud.transaction.rollback',
1125                     $self->{session}->{authtoken}
1126                 )->gather(1);
1127             };
1128         }
1129
1130         # Create the call number
1131         my $acn;
1132         if ($bib) {
1133             $acn = Fieldmapper::asset::call_number->new();
1134             $acn->creator($self->{session}->{user}->id());
1135             $acn->editor($self->{session}->{user}->id());
1136             $acn->label($item_info->{call_number});
1137             $acn->record($bib->id());
1138             $acn->owning_lib($self->{session}->{work_ou}->id());
1139             $acn->deleted('f');
1140             $acn->isnew(1);
1141
1142             eval {
1143                 $acn = $ses->request(
1144                     'open-ils.pcrud.create.acn',
1145                     $self->{session}->{authtoken},
1146                     $acn
1147                 )->gather(1);
1148             };
1149             if ($@) {
1150                 undef($acn);
1151                 eval {
1152                     $ses->request(
1153                         'open-ils.pcrud.transaction.rollback',
1154                         $self->{session}->{authtoken}
1155                     )->gather(1);
1156                 };
1157             }
1158         }
1159
1160         # create the copy
1161         if ($acn) {
1162             $item = Fieldmapper::asset::copy->new();
1163             $item->barcode($item_info->{barcode});
1164             $item->call_number($acn->id());
1165             $item->circ_lib($self->{session}->{work_ou}->id);
1166             $item->circulate('t');
1167             if ($self->{config}->{items}->{use_force_holds}) {
1168                 $item->holdable('f');
1169             } else {
1170                 $item->holdable('t');
1171             }
1172             $item->opac_visible('f');
1173             $item->deleted('f');
1174             $item->fine_level(OILS_PRECAT_COPY_FINE_LEVEL);
1175             $item->loan_duration(OILS_PRECAT_COPY_LOAN_DURATION);
1176             $item->location(1);
1177             $item->status(0);
1178             $item->editor($self->{session}->{user}->id);
1179             $item->creator($self->{session}->{user}->id);
1180             $item->isnew(1);
1181
1182             eval {
1183                 $item = $ses->request(
1184                     'open-ils.pcrud.create.acp',
1185                     $self->{session}->{authtoken},
1186                     $item
1187                 )->gather(1);
1188
1189                 # Cross our fingers and commit the work.
1190                 $xact = $ses->request(
1191                     'open-ils.pcrud.transaction.commit',
1192                     $self->{session}->{authtoken}
1193                 )->gather(1);
1194             };
1195             if ($@) {
1196                 undef($item);
1197                 eval {
1198                     $ses->request(
1199                         'open-ils.pcrud.transaction.rollback',
1200                         $self->{session}->{authtoken}
1201                     )->gather(1) if ($xact);
1202                 };
1203             }
1204         }
1205     }
1206
1207     # We need to disconnect our session.
1208     $ses->disconnect();
1209
1210     # Now, we handle our asset stat_cat entries.
1211     if ($item) {
1212         # It would be nice to do these in the above transaction, but
1213         # pcrud does not support the ascecm object, yet.
1214         foreach my $entry (@{$self->{stat_cat_entries}}) {
1215             my $map = Fieldmapper::asset::stat_cat_entry_copy_map->new();
1216             $map->isnew(1);
1217             $map->stat_cat($entry->stat_cat());
1218             $map->stat_cat_entry($entry->id());
1219             $map->owning_copy($item->id());
1220             # We don't really worry if it succeeds or not.
1221             $U->simplereq(
1222                 'open-ils.circ',
1223                 'open-ils.circ.stat_cat.asset.copy_map.create',
1224                 $self->{session}->{authtoken},
1225                 $map
1226             );
1227         }
1228     }
1229
1230     return $item;
1231 }
1232
1233 =head2 place_hold
1234
1235     $hold = $ils->place_hold($item, $user, $location);
1236
1237 This function places a hold on $item for $user for pickup at
1238 $location. If location is not provided or undefined, the user's home
1239 library is used as a fallback.
1240
1241 $item can be a copy (asset::copy), volume (asset::call_number), or bib
1242 (biblio::record_entry). The appropriate hold type will be placed
1243 depending on the object.
1244
1245 On success, the method returns the object representing the hold. On
1246 failure, a NCIP::Problem object, describing the failure, is returned.
1247
1248 =cut
1249
1250 sub place_hold {
1251     my $self = shift;
1252     my $item = shift;
1253     my $user = shift;
1254     my $location = shift;
1255
1256     # If $location is undefined, use the user's home_ou, which should
1257     # have been fleshed when the user was retrieved.
1258     $location = $user->home_ou() unless ($location);
1259
1260     # $hold is the hold. $params is for the is_possible check.
1261     my ($hold, $params);
1262
1263     # Prep the hold with fields common to all hold types:
1264     $hold = Fieldmapper::action::hold_request->new();
1265     $hold->isnew(1); # Just to make sure.
1266     $hold->target($item->id());
1267     $hold->usr($user->id());
1268     $hold->pickup_lib($location->id());
1269     if (!$user->email()) {
1270         $hold->email_notify('f');
1271         $hold->phone_notify($user->day_phone()) if ($user->day_phone());
1272     } else {
1273         $hold->email_notify('t');
1274     }
1275
1276     # Ditto the params:
1277     $params = { pickup_lib => $location->id(), patronid => $user->id() };
1278
1279     if (ref($item) eq 'Fieldmapper::asset::copy') {
1280         my $type = ($self->{config}->{items}->{use_force_holds}) ? 'F' : 'C';
1281         $hold->hold_type($type);
1282         $hold->current_copy($item->id());
1283         $params->{hold_type} = $type;
1284         $params->{copy_id} = $item->id();
1285     } elsif (ref($item) eq 'Fieldmapper::asset::call_number') {
1286         $hold->hold_type('V');
1287         $params->{hold_type} = 'V';
1288         $params->{volume_id} = $item->id();
1289     } elsif (ref($item) eq 'Fieldmapper::biblio::record_entry') {
1290         $hold->hold_type('T');
1291         $params->{hold_type} = 'T';
1292         $params->{titleid} = $item->id();
1293     }
1294
1295     # Check if the hold is possible:
1296     my $r = $U->simplereq(
1297         'open-ils.circ',
1298         'open-ils.circ.title_hold.is_possible',
1299         $self->{session}->{authtoken},
1300         $params
1301     );
1302
1303     if ($r->{success}) {
1304         $hold = $U->simplereq(
1305             'open-ils.circ',
1306             'open-ils.circ.holds.create.override',
1307             $self->{session}->{authtoken},
1308             $hold
1309         );
1310         if (ref($hold) eq 'HASH') {
1311             $hold = _problem_from_event('Request Not Possible', $hold);
1312         }
1313     } elsif ($r->{last_event}) {
1314         $hold = _problem_from_event('Request Not Possible', $r->{last_event});
1315     } elsif ($r->{text_code}) {
1316         $hold = _problem_from_event('Request Not Possible', $r);
1317     } else {
1318         $hold = _problem_from_event('Request Not Possible');
1319     }
1320
1321     return $hold;
1322 }
1323
1324 =head2 delete_copy
1325
1326     $ils->delete_copy($copy);
1327
1328 Deletes the copy, and if it is owned by our work_ou and not a precat,
1329 we also delete the volume and bib on which the copy depends.
1330
1331 =cut
1332
1333 sub delete_copy {
1334     my $self = shift;
1335     my $copy = shift;
1336
1337     # Shortcut for ownership checks below.
1338     my $ou_id = $self->{session}->{work_ou}->id();
1339
1340     # First, make sure the copy is not already deleted and we own it.
1341     return undef if ($U->is_true($copy->deleted()) || $copy->circ_lib() != $ou_id);
1342
1343     # If call_number was fleshed, deflesh it.
1344     if (ref($copy->call_number())) {
1345         my $cn = $copy->call_number();
1346         $copy->call_number($cn->id());
1347     }
1348
1349     # We need a transaction & connected session.
1350     my $xact;
1351     my $session = OpenSRF::AppSession->create('open-ils.pcrud');
1352     $session->connect();
1353     eval {
1354         $xact = $session->request(
1355             'open-ils.pcrud.transaction.begin',
1356             $self->{session}->{authtoken}
1357         )->gather(1);
1358     };
1359     if ($@) {
1360         undef($xact);
1361     }
1362
1363     if ($xact) {
1364         # Do the rest in one eval block.
1365         eval {
1366             # Delete the copy.
1367             my $r = $session->request(
1368                 'open-ils.pcrud.delete.acp',
1369                 $self->{session}->{authtoken},
1370                 $copy
1371             )->gather(1);
1372             # Check for volume.
1373             if ($copy->call_number() != -1) {
1374                 # Retrieve the acn object and flesh the bib.
1375                 my $acn = $session->request(
1376                     'open-ils.pcrud.retrieve.acn',
1377                     $self->{session}->{authtoken},
1378                     $copy->call_number(),
1379                     {flesh => 2, flesh_fields => {acn => ['record','copies'], bre => ['call_numbers']}}
1380                 )->gather(1);
1381                 if ($acn) {
1382                     # Check if we own the call_number.
1383                     if ($acn->owning_lib() == $ou_id) {
1384                         # check for additional copies on the acn.
1385                         my @copies = grep {$_->id() != $copy->id() && !$U->is_true($_->deleted())} @{$acn->copies()};
1386                         unless (@copies) {
1387                             # Get the bib
1388                             my $bib = $acn->record();
1389                             $r = $session->request(
1390                                 'open-ils.pcrud.delete.acn',
1391                                 $self->{session}->{authtoken},
1392                                 $acn
1393                             )->gather(1);
1394                             if ($r) {
1395                                 # Check if we created the bib.
1396                                 if ($bib->creator() == $self->{session}->{user}->id()) {
1397                                 # Check for other call numbers on the bib:
1398                                     my @vols = grep {$_->id() != $acn->id() && !$U->is_true($_->deleted())}
1399                                         @{$bib->call_numbers()};
1400                                     unless (@vols) {
1401                                         $r = $session->request(
1402                                             'open-ils.pcrud.delete.bre',
1403                                             $self->{session}->{authtoken},
1404                                             $bib
1405                                         )->gather(1);
1406                                     }
1407                                 }
1408                             }
1409                         }
1410                     }
1411                 }
1412             }
1413             $r = $session->request(
1414                 'open-ils.pcrud.transaction.commit',
1415                 $self->{session}->{authtoken}
1416             )->gather(1);
1417         };
1418         if ($@) {
1419             eval {
1420                 my $r = $session->request(
1421                     'open-ils.pcrud.transaction.rollback',
1422                     $self->{session}->{authtoken}
1423                 )->gather(1);
1424             }
1425         }
1426     }
1427
1428     $session->disconnect();
1429
1430     return undef;
1431 }
1432
1433 =head1 OVERRIDDEN PARENT METHODS
1434
1435 =head2 find_user_barcode
1436
1437 We dangerously override our parent's C<find_user_barcode> to return
1438 either the $barcode or a Problem object. In list context the barcode
1439 or problem will be the first argument and the id field, if any, will
1440 be the second. We also add a second, optional, argument to indicate a
1441 default value for the id field in the event of a failure to find
1442 anything at all. (Perl lets us get away with this.)
1443
1444 =cut
1445
1446 sub find_user_barcode {
1447     my $self = shift;
1448     my $request = shift;
1449     my $default = shift;
1450
1451     unless ($default) {
1452         my $message = $self->parse_request_type($request);
1453         if ($message eq 'LookupUser') {
1454             $default = 'AuthenticationInputData';
1455         } else {
1456             $default = 'UserIdentifierValue';
1457         }
1458     }
1459
1460     my ($value, $idfield) = $self->SUPER::find_user_barcode($request);
1461
1462     unless ($value) {
1463         $idfield = $default unless ($idfield);
1464         $value = NCIP::Problem->new();
1465         $value->ProblemType('Needed Data Missing');
1466         $value->ProblemDetail('Cannot find user barcode in message.');
1467         $value->ProblemElement($idfield);
1468         $value->ProblemValue('NULL');
1469     }
1470
1471     return (wantarray) ? ($value, $idfield) : $value;
1472 }
1473
1474 =head2 find_item_barcode
1475
1476 We do pretty much the same thing as with C<find_user_barcode> for
1477 C<find_item_barcode>.
1478
1479 =cut
1480
1481 sub find_item_barcode {
1482     my $self = shift;
1483     my $request = shift;
1484     my $default = shift || 'ItemIdentifierValue';
1485
1486     my ($value, $idfield) = $self->SUPER::find_item_barcode($request);
1487
1488     unless ($value) {
1489         $idfield = $default unless ($idfield);
1490         $value = NCIP::Problem->new();
1491         $value->ProblemType('Needed Data Missing');
1492         $value->ProblemDetail('Cannot find item barcode in message.');
1493         $value->ProblemElement($idfield);
1494         $value->ProblemValue('NULL');
1495     }
1496
1497     return (wantarray) ? ($value, $idfield) : $value;
1498 }
1499
1500 # private subroutines not meant to be used directly by subclasses.
1501 # Most have to do with setup and/or state checking of implementation
1502 # components.
1503
1504 # Find, load, and parse our configuration file:
1505 sub _configure {
1506     my $self = shift;
1507
1508     # Find the configuration file via variables:
1509     my $file = OILS_NCIP_CONFIG_DEFAULT;
1510     $file = $ENV{OILS_NCIP_CONFIG} if ($ENV{OILS_NCIP_CONFIG});
1511
1512     $self->{config} = XMLin($file, NormaliseSpace => 2,
1513                             ForceArray => ['block_profile', 'stat_cat_entry']);
1514 }
1515
1516 # Bootstrap OpenSRF::System and load the IDL.
1517 sub _bootstrap {
1518     my $self = shift;
1519
1520     my $bootstrap_config = $self->{config}->{bootstrap};
1521     OpenSRF::System->bootstrap_client(config_file => $bootstrap_config);
1522
1523     my $idl = OpenSRF::Utils::SettingsClient->new->config_value("IDL");
1524     Fieldmapper->import(IDL => $idl);
1525 }
1526
1527 # Login and then initialize some object data based on the
1528 # configuration.
1529 sub _init {
1530     my $self = shift;
1531
1532     # Login to Evergreen.
1533     $self->login();
1534
1535     # Load the barred groups as pgt objects into a blocked_profiles
1536     # list.
1537     $self->{blocked_profiles} = [];
1538     foreach (@{$self->{config}->{patrons}->{block_profile}}) {
1539         my $pgt;
1540         if (ref $_) {
1541             $pgt = $U->simplereq(
1542                 'open-ils.pcrud',
1543                 'open-ils.pcrud.retrieve.pgt',
1544                 $self->{session}->{authtoken},
1545                 $_->{grp}
1546             );
1547         } else {
1548             $pgt = $U->simplereq(
1549                 'open-ils.pcrud',
1550                 'open-ils.pcrud.search.pgt',
1551                 $self->{session}->{authtoken},
1552                 {name => $_}
1553             );
1554         }
1555         push(@{$self->{blocked_profiles}}, $pgt) if ($pgt);
1556     }
1557
1558     # Load the bib source if we're not using precats.
1559     unless ($self->{config}->{items}->{use_precats}) {
1560         # Retrieve the default
1561         $self->{bib_source} = $U->simplereq(
1562             'open-ils.pcrud',
1563             'open-ils.pcrud.retrieve.cbs',
1564             $self->{session}->{authtoken},
1565             BIB_SOURCE_DEFAULT);
1566         my $data = $self->{config}->{items}->{bib_source};
1567         if ($data) {
1568             $data = $data->[0] if (ref($data) eq 'ARRAY');
1569             my $result;
1570             if (ref $data) {
1571                 $result = $U->simplereq(
1572                     'open-ils.pcrud',
1573                     'open-ils.pcrud.retrieve.cbs',
1574                     $self->{session}->{authtoken},
1575                     $data->{cbs}
1576                 );
1577             } else {
1578                 $result = $U->simplereq(
1579                     'open-ils.pcrud',
1580                     'open-ils.pcrud.search.cbs',
1581                     $self->{session}->{authtoken},
1582                     {source => $data}
1583                 );
1584             }
1585             $self->{bib_source} = $result if ($result);
1586         }
1587     }
1588
1589     # Load the required asset.stat_cat_entries:
1590     $self->{stat_cat_entries} = [];
1591     # First, make a regex for our ou and ancestors:
1592     my $ancestors = join("|", @{$U->get_org_ancestors($self->{session}->{work_ou}->id())});
1593     my $re = qr/(?:$ancestors)/;
1594     # Get the uniq stat_cat ids from the configuration:
1595     my @cats = uniq map {$_->{stat_cat}} @{$self->{config}->{items}->{stat_cat_entry}};
1596     # Retrieve all of the fleshed stat_cats and entries for the above.
1597     my $stat_cats = $U->simplereq(
1598         'open-ils.circ',
1599         'open-ils.circ.stat_cat.asset.retrieve.batch',
1600         $self->{session}->{authtoken},
1601         @cats
1602     );
1603     foreach my $entry (@{$self->{config}->{items}->{stat_cat_entry}}) {
1604         # Must have the stat_cat attr and the name, so we must have a
1605         # reference.
1606         next unless(ref $entry);
1607         my ($stat) = grep {$_->id() == $entry->{stat_cat}} @$stat_cats;
1608         push(@{$self->{stat_cat_entries}}, grep {$_->owner() =~ $re && $_->value() eq $entry->{content}} @{$stat->entries()});
1609     }
1610 }
1611
1612 # Standalone, "helper" functions.  These do not take an object or
1613 # class reference.
1614
1615 # Check if a user is past their expiration date.
1616 sub _expired {
1617     my $user = shift;
1618     my $expired = 0;
1619
1620     # Users might not expire.  If so, they have no expire_date.
1621     if ($user->expire_date()) {
1622         my $expires = DateTime::Format::ISO8601->parse_datetime(
1623             cleanse_ISO8601($user->expire_date())
1624         )->epoch();
1625         my $now = DateTime->now()->epoch();
1626         $expired = $now > $expires;
1627     }
1628
1629     return $expired;
1630 }
1631
1632 # Creates a NCIP Problem from an event. Takes a string for the problem
1633 # type, the event hashref, and optional arguments for the
1634 # ProblemElement and ProblemValue fields.
1635 sub _problem_from_event {
1636     my ($type, $evt, $element, $value) = @_;
1637
1638     my $detail;
1639
1640     # This block will likely need to get smarter in the near future.
1641     if ($evt) {
1642         if ($evt->{text_code} eq 'PERM_FAILURE') {
1643             $detail = 'Permission Failure: ' . $evt->{ilsperm};
1644             $detail =~ s/\.override$//;
1645         } else {
1646             $detail = 'ILS returned ' . $evt->{text_code} . ' error.';
1647         }
1648     } else {
1649         $detail = 'Detail not available.';
1650     }
1651
1652     return NCIP::Problem->new(
1653         {
1654             ProblemType => $type,
1655             ProblemDetail => $detail,
1656             ProblemElement => ($element) ? $element : 'NULL',
1657             ProblemValue => ($value) ? $value : 'NULL'
1658         }
1659     );
1660 }
1661
1662 1;