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