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::PhysicalAddress;
  54 use NCIP::RequestId;
  55 use NCIP::Item::Id;
  56 use NCIP::Item::OptionalFields;
  57 use NCIP::Item::BibliographicDescription;
  58 use NCIP::Item::BibliographicItemId;
  59 use NCIP::Item::BibliographicRecordId;
  60 use NCIP::Item::Description;
  61
  62 # Inherit from NCIP::ILS.
  63 use parent qw(NCIP::ILS);
  64
  65 =head1 NAME
  66
  67 Evergreen - Evergreen driver for NCIPServer
  68
  69 =head1 SYNOPSIS
  70
  71     my $ils = NCIP::ILS::Evergreen->new(name => $config->{NCIP.ils.value});
  72
  73 =head1 DESCRIPTION
  74
  75 NCIP::ILS::Evergreen is the default driver for Evergreen and
  76 NCIPServer. It was initially developed to work with Auto-Graphics'
  77 SHAREit software using a subset of an unspecified ILL/DCB profile.
  78
  79 =cut
  80
  81 # Default values we define for things that might be missing in our
  82 # runtime environment or configuration file that absolutely must have
  83 # values.
  84 #
  85 # OILS_NCIP_CONFIG_DEFAULT is the default location to find our
  86 # driver's configuration file.  This location can be overridden by
  87 # setting the path in the OILS_NCIP_CONFIG environment variable.
  88 #
  89 # BIB_SOURCE_DEFAULT is the config.bib_source.id to use when creating
  90 # "short" bibs.  It is used only if no entry is supplied in the
  91 # configuration file.  The provided default is 2, the id of the
  92 # "System Local" source that comes with a default Evergreen
  93 # installation.
  94 use constant {
  95     OILS_NCIP_CONFIG_DEFAULT => '/openils/conf/oils_ncip.xml',
  96     BIB_SOURCE_DEFAULT => 2
  97 };
  98
  99 # A common Evergreen code shortcut to use AppUtils:
 100 my $U = 'OpenILS::Application::AppUtils';
 101
 102 # The usual constructor:
 103 sub new {
 104     my $class = shift;
 105     $class = ref($class) if (ref $class);
 106
 107     # Instantiate our parent with the rest of the arguments.  It
 108     # creates a blessed hashref.
 109     my $self = $class->SUPER::new(@_);
 110
 111     # Look for our configuration file, load, and parse it:
 112     $self->_configure();
 113
 114     # Bootstrap OpenSRF and prepare some OpenILS components.
 115     $self->_bootstrap();
 116
 117     # Initialize the rest of our internal state.
 118     $self->_init();
 119
 120     return $self;
 121 }
 122
 123 =head1 HANDLER METHODS
 124
 125 =head2 lookupuser
 126
 127     $ils->lookupuser($request);
 128
 129 Processes a LookupUser request.
 130
 131 =cut
 132
 133 sub lookupuser {
 134     my $self = shift;
 135     my $request = shift;
 136
 137     # Check our session and login if necessary.
 138     $self->login() unless ($self->checkauth());
 139
 140     my $message_type = $self->parse_request_type($request);
 141
 142     # Let's go ahead and create our response object. We need this even
 143     # if there is a problem.
 144     my $response = NCIP::Response->new({type => $message_type . "Response"});
 145     $response->header($self->make_header($request));
 146
 147     # Need to parse the request object to get the user barcode.
 148     my ($barcode, $idfield) = $self->find_user_barcode($request);
 149
 150     # If we did not find a barcode, then report the problem.
 151     if (ref($barcode) eq 'NCIP::Problem') {
 152         $response->problem($barcode);
 153         return $response;
 154     }
 155
 156     # Look up our patron by barcode:
 157     my $user = $self->retrieve_user_by_barcode($barcode, $idfield);
 158     if (ref($user) eq 'NCIP::Problem') {
 159         $response->problem($user);
 160         return $response;
 161     }
 162
 163     # We got the information, so lets fill in our userdata.
 164     my $userdata = NCIP::User->new();
 165
 166     # Use the user's main card as the UserId.
 167     my $id = NCIP::User::Id->new({
 168         UserIdentifierType => 'Barcode',
 169         UserIdnetifierValue => $user->card->barcode()
 170     });
 171     $userdata->UserId($id);
 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 = $self->handle_user_elements($user, $elements);
 178         $userdata->UserOptionalFields($optionalfields);
 179     }
 180
 181     $response->data($userdata);
 182
 183     return $response;
 184 }
 185
 186 =head2 acceptitem
 187
 188     $ils->acceptitem($request);
 189
 190 Processes an AcceptItem request.
 191
 192 =cut
 193
 194 sub acceptitem {
 195     my $self = shift;
 196     my $request = shift;
 197
 198     # Check our session and login if necessary.
 199     $self->login() unless ($self->checkauth());
 200
 201     # Common preparation.
 202     my $message = $self->parse_request_type($request);
 203     my $response = NCIP::Response->new({type => $message . 'Response'});
 204     $response->header($self->make_header($request));
 205
 206     # We only accept holds for the time being.
 207     if ($request->{$message}->{RequestedActionType} =~ /^hold\W/i) {
 208         # We need the item id or we can't do anything at all.
 209         my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
 210         if (ref($item_barcode) eq 'NCIP::Problem') {
 211             $response->problem($item_barcode);
 212             return $response;
 213         }
 214
 215         # We need to find a patron barcode or we can't look anyone up
 216         # to place a hold.
 217         my ($user_barcode, $user_idfield) = $self->find_user_barcode($request, 'UserIdentifierValue');
 218         if (ref($user_barcode) eq 'NCIP::Problem') {
 219             $response->problem($user_barcode);
 220             return $response;
 221         }
 222         # Look up our patron by barcode:
 223         my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
 224         if (ref($user) eq 'NCIP::Problem') {
 225             $response->problem($user);
 226             return $response;
 227         }
 228         # We're doing patron checks before looking for bibliographic
 229         # information and creating the item because problems with the
 230         # patron are more likely to occur.
 231         my $problem = $self->check_user_for_problems($user, 'HOLD');
 232         if ($problem) {
 233             $response->problem($problem);
 234             return $response;
 235         }
 236
 237         # Check if the item barcode already exists:
 238         my $item = $self->retrieve_copy_details_by_barcode($item_barcode);
 239         if ($item) {
 240             # What to do here was not defined in the
 241             # specification. Since the copies that we create this way
 242             # should get deleted when checked in, it would be an error
 243             # if we try to create another one. It means that something
 244             # has gone wrong somewhere.
 245             $response->problem(
 246                 NCIP::Problem->new(
 247                     {
 248                         ProblemType => 'Duplicate Item',
 249                         ProblemDetail => "Item with barcode $item_barcode already exists.",
 250                         ProblemElement => $item_idfield,
 251                         ProblemValue => $item_barcode
 252                     }
 253                 )
 254             );
 255             return $response;
 256         }
 257
 258         # Now, we have to create our new copy and/or bib and call number.
 259
 260         # First, we have to gather the necessary information from the
 261         # request.  Store in a hashref for convenience. We may write a
 262         # method to get this information in the future if we find we
 263         # need it in other handlers. Such a function would be a
 264         # candidate to go into our parent, NCIP::ILS.
 265         my $item_info = {
 266             barcode => $item_barcode,
 267             call_number => $request->{$message}->{ItemOptionalFields}->{ItemDescription}->{CallNumber},
 268             title => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{Title},
 269             author => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{Author},
 270             publisher => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{Publisher},
 271             publication_date => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{PublicationDate},
 272             medium => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{MediumType},
 273             electronic => $request->{$message}->{ItemOptionalFields}->{BibliographicDescription}->{ElectronicResource}
 274         };
 275
 276         if ($self->{config}->{items}->{use_precats}) {
 277             # We only need to create a precat copy.
 278             $item = $self->create_precat_copy($item_info);
 279         } else {
 280             # We have to create a "partial" bib record, a call number and a copy.
 281             $item = $self->create_fuller_copy($item_info);
 282         }
 283
 284         # If we failed to create the copy, report a problem.
 285         unless ($item) {
 286             $response->problem(
 287                 {
 288                     ProblemType => 'Temporary Processing Failure',
 289                     ProblemDetail => 'Failed to create the item in the system',
 290                     ProblemElement => $item_idfield,
 291                     ProblemValue => $item_barcode
 292                 }
 293             );
 294             return $response;
 295         }
 296
 297         # We try to find the pickup location in our database. It's OK
 298         # if it does not exist, the user's home library will be used
 299         # instead.
 300         my $location = $self->find_location_failover($request->{$message}->{PickupLocation}, $request, $message);
 301
 302         # Now, we place the hold on the newly created copy on behalf
 303         # of the patron retrieved above.
 304         my $hold = $self->place_hold($item, $user, $location);
 305         if (ref($hold) eq 'NCIP::Problem') {
 306             $response->problem($hold);
 307             return $response;
 308         }
 309
 310         # We return the RequestId and optionally, the ItemID. We'll
 311         # just return what was sent to us, since we ignored all of it
 312         # but the barcode.
 313         my $data = {};
 314         $data->{RequestId} = NCIP::RequestId->new(
 315             {
 316                 AgencyId => $request->{$message}->{RequestId}->{AgencyId},
 317                 RequestIdentifierType => $request->{$message}->{RequestId}->{RequestIdentifierType},
 318                 RequestIdentifierValue => $request->{$message}->{RequestId}->{RequestIdentifierValue}
 319             }
 320         );
 321         $data->{ItemId} = NCIP::Item::Id->new(
 322             {
 323                 AgencyId => $request->{$message}->{ItemId}->{AgencyId},
 324                 ItemIdentifierType => $request->{$message}->{ItemId}->{ItemIdentifierType},
 325                 ItemIdentifierValue => $request->{$message}->{ItemId}->{ItemIdentifierValue}
 326             }
 327         );
 328         $response->data($data);
 329
 330     } else {
 331         my $problem = NCIP::Problem->new();
 332         $problem->ProblemType('Unauthorized Combination Of Element Values For System');
 333         $problem->ProblemDetail('We only support Hold For Pickup');
 334         $problem->ProblemElement('RequestedActionType');
 335         $problem->ProblemValue($request->{$message}->{RequestedActionType});
 336         $response->problem($problem);
 337     }
 338
 339     return $response;
 340 }
 341
 342 =head2 checkinitem
 343
 344     $response = $ils->checkinitem($request);
 345
 346 Checks the item in if we can find the barcode in the message. It
 347 returns problems if it cannot find the item in the system or if the
 348 item is not checked out.
 349
 350 It could definitely use some more brains at some point as it does not
 351 fully support everything that the standard allows. It also does not
 352 really check if the checkin succeeded or not.
 353
 354 =cut
 355
 356 sub checkinitem {
 357     my $self = shift;
 358     my $request = shift;
 359
 360     # Check our session and login if necessary:
 361     $self->login() unless ($self->checkauth());
 362
 363     # Common stuff:
 364     my $message = $self->parse_request_type($request);
 365     my $response = NCIP::Response->new({type => $message . 'Response'});
 366     $response->header($self->make_header($request));
 367
 368     # We need the copy barcode from the message.
 369     my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
 370     if (ref($item_barcode) eq 'NCIP::Problem') {
 371         $response->problem($item_barcode);
 372         return $response;
 373     }
 374
 375     # Retrieve the copy details.
 376     my $details = $self->retrieve_copy_details_by_barcode($item_barcode);
 377     unless ($details) {
 378         # Return an Unknown Item problem unless we find the copy.
 379         $response->problem(
 380             NCIP::Problem->new(
 381                 {
 382                     ProblemType => 'Unknown Item',
 383                     ProblemDetail => "Item with barcode $item_barcode is not known.",
 384                     ProblemElement => $item_idfield,
 385                     ProblemValue => $item_barcode
 386                 }
 387             )
 388         );
 389         return $response;
 390     }
 391
 392     # Check if a UserId was provided. If so, this is the patron to
 393     # whom the copy should be checked out.
 394     my $user;
 395     my ($user_barcode, $user_idfield) = $self->find_user_barcode($request);
 396     # We ignore the problem, because the UserId is optional.
 397     if (ref($user_barcode) ne 'NCIP::Problem') {
 398         $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
 399         # We don't ignore a problem here, however.
 400         if (ref($user) eq 'NCIP::Problem') {
 401             $response->problem($user);
 402             return $response;
 403         }
 404     }
 405
 406     # Isolate the copy.
 407     my $copy = $details->{copy};
 408
 409     # Look for a circulation and examine its information:
 410     my $circ = $details->{circ};
 411
 412     # Check the circ details to see if the copy is checked out and, if
 413     # the patron was provided, that it is checked out to the patron in
 414     # question. We also verify the copy ownership and circulation
 415     # location.
 416     my $problem = $self->check_circ_details($circ, $copy, $user);
 417     if ($problem) {
 418         # We need to fill in some information, however.
 419         if (!$problem->ProblemValue() && !$problem->ProblemElement()) {
 420             $problem->ProblemValue($user_barcode);
 421             $problem->ProblemElement($user_idfield);
 422         } elsif (!$problem->ProblemElement()) {
 423             $problem->ProblemElement($item_idfield);
 424         }
 425         $response->problem($problem);
 426         return $response;
 427     }
 428
 429     # Checkin parameters. We want to skip hold targeting or making
 430     # transits, to force the checkin despite the copy status, as
 431     # well as void overdues.
 432     my $params = {
 433         copy_barcode => $copy->barcode(),
 434         force => 1,
 435         noop => 1,
 436         void_overdues => 1
 437     };
 438     my $result = $U->simplereq(
 439         'open-ils.circ',
 440         'open-ils.circ.checkin.override',
 441         $self->{session}->{authtoken},
 442         $params
 443     );
 444     if (ref($result) eq 'ARRAY') {
 445         $result = $result->[0];
 446     }
 447     if ($result->{textcode} eq 'SUCCESS') {
 448         # Delete the copy. Since delete_copy checks ownership
 449         # before attempting to delete the copy, we don't bother
 450         # checking who owns it.
 451         $self->delete_copy($copy);
 452         # We need the circulation user for the information below, so we retrieve it.
 453         my $circ_user = $self->retrieve_user_by_id($circ->usr());
 454         my $data = {
 455             ItemId => NCIP::Item::Id->new(
 456                 {
 457                     AgencyId => $request->{$message}->{ItemId}->{AgencyId},
 458                     ItemIdentifierType => $request->{$message}->{ItemId}->{ItemIdentifierType},
 459                     ItemIdentifierValue => $request->{$message}->{ItemId}->{ItemIdentifierValue}
 460                 }
 461             ),
 462             UserId => NCIP::User::Id->new(
 463                 {
 464                     UserIdentifierType => 'Barcode Id',
 465                     UserIdentifierValue => $circ_user->card->barcode()
 466                 }
 467             )
 468         };
 469
 470         # Look for UserElements requested and add it to the response:
 471         my $elements = $request->{$message}->{UserElementType};
 472         if ($elements) {
 473             $elements = [$elements] unless (ref $elements eq 'ARRAY');
 474             my $optionalfields = $self->handle_user_elements($circ_user, $elements);
 475             $data->{UserOptionalFields} = $optionalfields;
 476         }
 477         $elements = $request->{$message}->{ItemElementType};
 478         if ($elements) {
 479             $elements = [$elements] unless (ref $elements eq 'ARRAY');
 480             my $optionalfields = $self->handle_item_elements($copy, $elements);
 481             $data->{ItemOptionalFields} = $optionalfields;
 482         }
 483
 484         $response->data($data);
 485
 486         # At some point in the future, we should probably check if
 487         # they requested optional user or item elements and return
 488         # those. For the time being, we ignore those at the risk of
 489         # being considered non-compliant.
 490     } else {
 491         $response->problem(_problem_from_event('Checkin Failed', $result));
 492     }
 493
 494     return $response
 495 }
 496
 497 =head2 renewitem
 498
 499     $response = $ils->renewitem($request);
 500
 501 Handle the RenewItem message.
 502
 503 =cut
 504
 505 sub renewitem {
 506     my $self = shift;
 507     my $request = shift;
 508
 509     # Check our session and login if necessary:
 510     $self->login() unless ($self->checkauth());
 511
 512     # Common stuff:
 513     my $message = $self->parse_request_type($request);
 514     my $response = NCIP::Response->new({type => $message . 'Response'});
 515     $response->header($self->make_header($request));
 516
 517     # We need the copy barcode from the message.
 518     my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
 519     if (ref($item_barcode) eq 'NCIP::Problem') {
 520         $response->problem($item_barcode);
 521         return $response;
 522     }
 523
 524     # Retrieve the copy details.
 525     my $details = $self->retrieve_copy_details_by_barcode($item_barcode);
 526     unless ($details) {
 527         # Return an Unknown Item problem unless we find the copy.
 528         $response->problem(
 529             NCIP::Problem->new(
 530                 {
 531                     ProblemType => 'Unknown Item',
 532                     ProblemDetail => "Item with barcode $item_barcode is not known.",
 533                     ProblemElement => $item_idfield,
 534                     ProblemValue => $item_barcode
 535                 }
 536             )
 537         );
 538         return $response;
 539     }
 540
 541     # User is required for RenewItem.
 542     my ($user_barcode, $user_idfield) = $self->find_user_barcode($request);
 543     if (ref($user_barcode) eq 'NCIP::Problem') {
 544         $response->problem($user_barcode);
 545         return $response;
 546     }
 547     my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
 548     if (ref($user) eq 'NCIP::Problem') {
 549         $response->problem($user);
 550         return $response;
 551     }
 552
 553     # Isolate the copy.
 554     my $copy = $details->{copy};
 555
 556     # Look for a circulation and examine its information:
 557     my $circ = $details->{circ};
 558
 559     # Check the circ details to see if the copy is checked out and, if
 560     # the patron was provided, that it is checked out to the patron in
 561     # question. We also verify the copy ownership and circulation
 562     # location.
 563     my $problem = $self->check_circ_details($circ, $copy, $user);
 564     if ($problem) {
 565         # We need to fill in some information, however.
 566         if (!$problem->ProblemValue() && !$problem->ProblemElement()) {
 567             $problem->ProblemValue($user_barcode);
 568             $problem->ProblemElement($user_idfield);
 569         } elsif (!$problem->ProblemElement()) {
 570             $problem->ProblemElement($item_idfield);
 571         }
 572         $response->problem($problem);
 573         return $response;
 574     }
 575
 576     # Check if user is blocked from renewals:
 577     $problem = $self->check_user_for_problems($user, 'RENEW');
 578     if ($problem) {
 579         # Replace the ProblemElement and ProblemValue fields.
 580         $problem->ProblemElement($user_idfield);
 581         $problem->ProblemValue($user_barcode);
 582         $response->problem($problem);
 583         return $response;
 584     }
 585
 586     # Check if the duration rule allows renewals. It should have been
 587     # fleshed during the copy details retrieve.
 588     my $rule = $circ->duration_rule();
 589     unless (ref($rule)) {
 590         $rule = $U->simplereq(
 591             'open-ils.pcrud',
 592             'open-ils.pcrud.retrieve.crcd',
 593             $self->{session}->{authtoken},
 594             $rule
 595         )->gather(1);
 596     }
 597     if ($rule->max_renewals() < 1) {
 598         $response->problem(
 599             NCIP::Problem->new(
 600                 {
 601                     ProblemType => 'Item Not Renewable',
 602                     ProblemDetail => 'Item may not be renewed.',
 603                     ProblemElement => $item_idfield,
 604                     ProblemValue => $item_barcode
 605                 }
 606             )
 607         );
 608         return $response;
 609     }
 610
 611     # Check if there are renewals remaining on the latest circ:
 612     if ($circ->renewal_remaining() < 1) {
 613         $response->problem(
 614             NCIP::Problem->new(
 615                 {
 616                     ProblemType => 'Maximum Renewals Exceeded',
 617                     ProblemDetail => 'Renewal cannot proceed because the User has already renewed the Item the maximum number of times permitted.',
 618                     ProblemElement => $item_idfield,
 619                     ProblemValue => $item_barcode
 620                 }
 621             )
 622         );
 623         return $response;
 624     }
 625
 626     # Now, we attempt the renewal. If it fails, we simply say that the
 627     # user is not allowed to renew this item, without getting into
 628     # details.
 629     my $params = {
 630         copy_id => $copy->id(),
 631         patron_id => $user->id(),
 632         sip_renewal => 1
 633     };
 634     my $r = $U->simplereq(
 635         'open-ils.circ',
 636         'open-ils.circ.renew.override',
 637         $self->{session}->{authtoken},
 638         $params
 639     )->gather(1);
 640
 641     # We only look at the first one, since more than one usually means
 642     # failure.
 643     if (ref($r) eq 'ARRAY') {
 644         $r = $r->[0];
 645     }
 646     if ($r->{textcode} ne 'SUCCESS') {
 647         $problem = _problem_from_event('Renewal Failed', $r);
 648         $response->problem($problem);
 649     } else {
 650         my $data = {
 651             ItemId => NCIP::Item::Id->new(
 652                 {
 653                     AgencyId => $request->{$message}->{ItemId}->{AgencyId},
 654                     ItemIdentifierType => $request->{$message}->{ItemId}->{ItemIdentifierType},
 655                     ItemIdentifierValue => $request->{$message}->{ItemId}->{ItemIdentifierValue}
 656                 }
 657             ),
 658             UserId => NCIP::User::Id->new(
 659                 {
 660                     UserIdentifierType => 'Barcode Id',
 661                     UserIdentifierValue => $user->card->barcode()
 662                 }
 663             )
 664         };
 665         # We need to retrieve the copy details again to refresh our
 666         # circ information to get the new due date.
 667         $details = $self->retrieve_copy_details_by_barcode($item_barcode);
 668         $circ = $details->{circ};
 669         $data->{DateDue} = _fix_date($circ->due_date());
 670
 671         # Look for UserElements requested and add it to the response:
 672         my $elements = $request->{$message}->{UserElementType};
 673         if ($elements) {
 674             $elements = [$elements] unless (ref $elements eq 'ARRAY');
 675             my $optionalfields = $self->handle_user_elements($user, $elements);
 676             $data->{UserOptionalFields} = $optionalfields;
 677         }
 678         $elements = $request->{$message}->{ItemElementType};
 679         if ($elements) {
 680             $elements = [$elements] unless (ref $elements eq 'ARRAY');
 681             my $optionalfields = $self->handle_item_elements($details->{copy}, $elements);
 682             $data->{ItemOptionalFields} = $optionalfields;
 683         }
 684
 685         $response->data($data);
 686     }
 687
 688     # At some point in the future, we should probably check if
 689     # they requested optional user or item elements and return
 690     # those. For the time being, we ignore those at the risk of
 691     # being considered non-compliant.
 692
 693     return $response;
 694 }
 695
 696 =head2 checkoutitem
 697
 698     $response = $ils->checkoutitem($request);
 699
 700 Handle the Checkoutitem message.
 701
 702 =cut
 703
 704 sub checkoutitem {
 705     my $self = shift;
 706     my $request = shift;
 707
 708     # Check our session and login if necessary:
 709     $self->login() unless ($self->checkauth());
 710
 711     # Common stuff:
 712     my $message = $self->parse_request_type($request);
 713     my $response = NCIP::Response->new({type => $message . 'Response'});
 714     $response->header($self->make_header($request));
 715
 716     # We need the copy barcode from the message.
 717     my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
 718     if (ref($item_barcode) eq 'NCIP::Problem') {
 719         $response->problem($item_barcode);
 720         return $response;
 721     }
 722
 723     # Retrieve the copy details.
 724     my $details = $self->retrieve_copy_details_by_barcode($item_barcode);
 725     unless ($details) {
 726         # Return an Unknown Item problem unless we find the copy.
 727         $response->problem(
 728             NCIP::Problem->new(
 729                 {
 730                     ProblemType => 'Unknown Item',
 731                     ProblemDetail => "Item with barcode $item_barcode is not known.",
 732                     ProblemElement => $item_idfield,
 733                     ProblemValue => $item_barcode
 734                 }
 735             )
 736         );
 737         return $response;
 738     }
 739
 740     # User is required for CheckOutItem.
 741     my ($user_barcode, $user_idfield) = $self->find_user_barcode($request);
 742     if (ref($user_barcode) eq 'NCIP::Problem') {
 743         $response->problem($user_barcode);
 744         return $response;
 745     }
 746     my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
 747     if (ref($user) eq 'NCIP::Problem') {
 748         $response->problem($user);
 749         return $response;
 750     }
 751
 752     # Isolate the copy.
 753     my $copy = $details->{copy};
 754
 755     # Check if the copy can circulate.
 756     unless ($self->copy_can_circulate($copy)) {
 757         $response->problem(
 758             NCIP::Problem->new(
 759                 {
 760                     ProblemType => 'Item Does Not Circulate',
 761                     ProblemDetail => "Item with barcode $item_barcode does not circulate.",
 762                     ProblemElement => $item_idfield,
 763                     ProblemValue => $item_barcode
 764                 }
 765             )
 766         );
 767         return $response;
 768     }
 769
 770     # Look for a circulation and examine its information:
 771     my $circ = $details->{circ};
 772
 773     # Check if the item is already checked out.
 774     if ($circ && !$circ->checkin_time()) {
 775         $response->problem(
 776             NCIP::Problem->new(
 777                 {
 778                     ProblemType => 'Item Already Checked Out',
 779                     ProblemDetail => "Item with barcode $item_barcode is already checked out.",
 780                     ProblemElement => $item_idfield,
 781                     ProblemValue => $item_barcode
 782                 }
 783             )
 784         );
 785         return $response;
 786     }
 787
 788     # Check if user is blocked from circulation:
 789     my $problem = $self->check_user_for_problems($user, 'CIRC');
 790     if ($problem) {
 791         # Replace the ProblemElement and ProblemValue fields.
 792         $problem->ProblemElement($user_idfield);
 793         $problem->ProblemValue($user_barcode);
 794         $response->problem($problem);
 795         return $response;
 796     }
 797
 798     # Check for the copy being in transit and receive or abort it.
 799     my $transit = $U->simplereq(
 800         'open-ils.circ',
 801         'open-ils.circ.open_copy_transit.retrieve',
 802         $self->{session}->{authtoken},
 803         $copy->id()
 804     );
 805     if (ref($transit) eq 'Fieldmapper::action::transit_copy') {
 806         if ($transit->dest() == $self->{session}->{work_ou}->id()) {
 807             my $r = $U->simplereq(
 808                 'open-ils.circ',
 809                 'open-ils.circ.copy_transit.receive',
 810                 $self->{session}->{authtoken},
 811                 {copyid => $copy->id()}
 812             );
 813         } elsif ($transit->source() == $self->{session}->{work_ou}->id()) {
 814             my $r = $U->simplereq(
 815                 'open-ils.circ',
 816                 'open-ils.circ.transit.abort',
 817                 $self->{session}->{authtoken},
 818                 {copyid => $copy->id()}
 819             );
 820         }
 821     }
 822
 823     # Now, we attempt the check out. If it fails, we simply say that
 824     # the user is not allowed to check out this item, without getting
 825     # into details.
 826     my $params = {
 827         copy_id => $copy->id(),
 828         patron_id => $user->id(),
 829     };
 830     my $r = $U->simplereq(
 831         'open-ils.circ',
 832         'open-ils.circ.checkout.full.override',
 833         $self->{session}->{authtoken},
 834         $params
 835     );
 836
 837     # We only look at the first one, since more than one usually means
 838     # failure.
 839     if (ref($r) eq 'ARRAY') {
 840         $r = $r->[0];
 841     }
 842     if ($r->{textcode} ne 'SUCCESS') {
 843         $problem = _problem_from_event('Check Out Failed', $r);
 844         $response->problem($problem);
 845     } else {
 846         my $data = {
 847             ItemId => NCIP::Item::Id->new(
 848                 {
 849                     AgencyId => $request->{$message}->{ItemId}->{AgencyId},
 850                     ItemIdentifierType => $request->{$message}->{ItemId}->{ItemIdentifierType},
 851                     ItemIdentifierValue => $request->{$message}->{ItemId}->{ItemIdentifierValue}
 852                 }
 853             ),
 854             UserId => NCIP::User::Id->new(
 855                 {
 856                     UserIdentifierType => 'Barcode Id',
 857                     UserIdentifierValue => $user->card->barcode()
 858                 }
 859             )
 860         };
 861         # We need to retrieve the copy details again to refresh our
 862         # circ information to get the due date.
 863         $details = $self->retrieve_copy_details_by_barcode($item_barcode);
 864         $circ = $details->{circ};
 865         $data->{DateDue} = _fix_date($circ->due_date());
 866
 867         # Look for UserElements requested and add it to the response:
 868         my $elements = $request->{$message}->{UserElementType};
 869         if ($elements) {
 870             $elements = [$elements] unless (ref $elements eq 'ARRAY');
 871             my $optionalfields = $self->handle_user_elements($user, $elements);
 872             $data->{UserOptionalFields} = $optionalfields;
 873         }
 874         $elements = $request->{$message}->{ItemElementType};
 875         if ($elements) {
 876             $elements = [$elements] unless (ref $elements eq 'ARRAY');
 877             my $optionalfields = $self->handle_item_elements($details->{copy}, $elements);
 878             $data->{ItemOptionalFields} = $optionalfields;
 879         }
 880
 881         $response->data($data);
 882     }
 883
 884     # At some point in the future, we should probably check if
 885     # they requested optional user or item elements and return
 886     # those. For the time being, we ignore those at the risk of
 887     # being considered non-compliant.
 888
 889     return $response;
 890 }
 891
 892 =head2 requestitem
 893
 894     $response = $ils->requestitem($request);
 895
 896 Handle the NCIP RequestItem message.
 897
 898 =cut
 899
 900 sub requestitem {
 901     my $self = shift;
 902     my $request = shift;
 903     # Check our session and login if necessary:
 904     $self->login() unless ($self->checkauth());
 905
 906     # Common stuff:
 907     my $message = $self->parse_request_type($request);
 908     my $response = NCIP::Response->new({type => $message . 'Response'});
 909     $response->header($self->make_header($request));
 910
 911     # Because we need to have a user to place a hold, because the user
 912     # is likely to have problems, and because getting the item
 913     # information for the hold is trickier than getting the user
 914     # information, we'll do the user first and short circuit out of
 915     # the function if there is a problem with the user.
 916     my ($user_barcode, $user_idfield) = $self->find_user_barcode($request);
 917     if (ref($user_barcode) eq 'NCIP::Problem') {
 918         $response->problem($user_barcode);
 919         return $response;
 920     }
 921     my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
 922     if (ref($user) eq 'NCIP::Problem') {
 923         $response->problem($user);
 924         return $response;
 925     }
 926     my $problem = $self->check_user_for_problems($user, 'HOLD');
 927     if ($problem) {
 928         $response->problem($problem);
 929         return $response;
 930     }
 931
 932     # RequestItem is a blast. We need to check if we have a copy
 933     # barcode and/or if we have BibliographicIds. If we have both or
 934     # either, we then need to figure out what we're placing the hold
 935     # on, a copy, a volume or a bib. We don't currently do part holds,
 936     # but maybe we should some day. We can also be sent more than 1
 937     # BibliographicId, so we look for certain identifiers first, and
 938     # then others in decreasing preference: SYSNUMBER, ISBN, and ISSN.
 939
 940     # Not to mention that there are two kinds of BibliographicId field
 941     # with different field names, and both can be intermixed in an
 942     # incoming message! (I just /love/ this nonsense.)
 943
 944     # This here is the thing we're going to put on hold:
 945     my $item;
 946
 947     # We need copy details if we find in a couple of places below.
 948     my $copy_details;
 949
 950     # We need the copy barcode from the message.
 951     my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
 952     if (ref($item_barcode) ne 'NCIP::Problem') {
 953         # Retrieve the copy details.
 954         $copy_details = $self->retrieve_copy_details_by_barcode($item_barcode);
 955         unless ($copy_details) {
 956             # Return an Unknown Item problem unless we find the copy.
 957             $response->problem(
 958                 NCIP::Problem->new(
 959                     {
 960                         ProblemType => 'Unknown Item',
 961                         ProblemDetail => "Item with barcode $item_barcode is not known.",
 962                         ProblemElement => $item_idfield,
 963                         ProblemValue => $item_barcode
 964                     }
 965                 )
 966             );
 967             return $response;
 968         }
 969         $item = $copy_details->{volume}; # We place a volume hold.
 970     }
 971
 972     # We weren't given copy information to target, or we can't find
 973     # it, so we need to look for a target via BibliographicId.
 974     unless ($item) {
 975         my @biblio_ids = $self->find_bibliographic_ids($request);
 976         if (@biblio_ids) {
 977             $item = $self->find_target_via_bibliographic_id(@biblio_ids);
 978         }
 979     }
 980
 981     # If we don't have an item, then blow up with a problem that may
 982     # have been set when we went looking for the ItemId.
 983     unless ($item) {
 984         if (ref($item_barcode) eq 'NCIP::Problem') {
 985             $response->problem($item_barcode);
 986         } else {
 987             $response->problem(
 988                 NCIP::Problem->new(
 989                     {
 990                         ProblemType => 'Request Item Not Found',
 991                         ProblemDetail => 'Unable to determine the item to request from input message.',
 992                         ProblemElement => 'NULL',
 993                         ProblemValue => 'NULL'
 994                     }
 995                 )
 996             );
 997         }
 998         return $response;
 999     } elsif (ref($item) eq 'NCIP::Problem') {
1000         $response->problem($item);
1001         return $response;
1002     }
1003
1004     # We have an item.  If we have a biblio.record_entry object,
1005     # Auto-Graphics expects us to place the hold such that it is
1006     # limited to the branch or system whose id they have given us.
1007     # We, therefore, look for an org_unit based on the ToAgencyId from
1008     # the InitiationHeader.
1009     my $ou;
1010     if (ref($item) eq 'Fieldmapper::biblio::record_entry') {
1011         $ou = $self->find_location_failover(undef, $request, $message);
1012     }
1013
1014     # See if we were given a PickupLocation.
1015     my $location;
1016     if ($request->{$message}->{PickupLocation}) {
1017         my $loc = $request->{$message}->{PickupLocation};
1018         $loc =~ s/^.*://; # strip everything up to the last
1019                           # semi-colon, if any.
1020         $location = $self->retrieve_org_unit_by_shortname($loc);
1021     }
1022
1023     # Look for a NeedBeforeDate to use as expiration...
1024     my $hold_expiration = $request->{$message}->{NeedBeforeDate};
1025
1026     # Place the hold.
1027     my $hold = $self->place_hold($item, $user, $location, $hold_expiration, $ou);
1028     if (ref($hold) eq 'NCIP::Problem') {
1029         $response->problem($hold);
1030     } else {
1031         my $data = {
1032             RequestId => NCIP::RequestId->new(
1033                 {
1034                     AgencyId => $request->{$message}->{RequestId}->{AgencyId},
1035                     RequestIdentifierType => $request->{$message}->{RequestId}->{RequestIdentifierType},
1036                     RequestIdentifierValue => $request->{$message}->{RequestId}->{RequestIdentifierValue}
1037                 }
1038             ),
1039             UserId => NCIP::User::Id->new(
1040                 {
1041                     UserIdentifierType => 'Barcode Id',
1042                     UserIdentifierValue => $user->card->barcode()
1043                 }
1044             ),
1045             RequestType => $request->{$message}->{RequestType},
1046             RequestScopeType => $request->{$message}->{RequestScopeType}
1047         };
1048         # Fill in the ItemId based on what we have.
1049         if ($item_barcode && ref($item_barcode) ne 'NCIP::Problem') {
1050             $data->{ItemId} = NCIP::Item::Id->new({
1051                 ItemIdentifierValue => $item_barcode,
1052                 ItemIdentifierType => 'Barcode'
1053             });
1054         } else {
1055             $data->{ItemId} = NCIP::Item::Id->new({
1056                 ItemIdentifierValue => $item->id(),
1057             });
1058             # if we have an $ou, we return the AgencyId, else set
1059             # ItemIdentifierType.
1060             if ($ou) {
1061                 $data->{ItemId}->AgencyId($ou->shortname());
1062             } else {
1063                 $data->{ItemId}->ItemIdentifierType('SYSNUMBER');
1064             }
1065         }
1066
1067         # Look for UserElements requested and add it to the response:
1068         my $elements = $request->{$message}->{UserElementType};
1069         if ($elements) {
1070             $elements = [$elements] unless (ref $elements eq 'ARRAY');
1071             my $optionalfields = $self->handle_user_elements($user, $elements);
1072             $data->{UserOptionalFields} = $optionalfields;
1073         }
1074         $elements = $request->{$message}->{ItemElementType};
1075         if ($elements) {
1076             $copy_details = $self->find_copy_details_by_item($item) unless ($copy_details);
1077             $elements = [$elements] unless (ref($elements) eq 'ARRAY');
1078             my $optionalfields = $self->handle_item_elements($copy_details->{copy}, $elements);
1079             $data->{ItemOptionalFields} = $optionalfields;
1080         }
1081
1082         $response->data($data);
1083     }
1084
1085     return $response;
1086 }
1087
1088 =head2 cancelrequestitem
1089
1090     $response = $ils->cancelrequestitem($request);
1091
1092 Handle the NCIP CancelRequestItem message.
1093
1094 =cut
1095
1096 sub cancelrequestitem {
1097     my $self = shift;
1098     my $request = shift;
1099     # Check our session and login if necessary:
1100     $self->login() unless ($self->checkauth());
1101
1102     # Common stuff:
1103     my $message = $self->parse_request_type($request);
1104     my $response = NCIP::Response->new({type => $message . 'Response'});
1105     $response->header($self->make_header($request));
1106
1107     # UserId is required by the standard, but we might not really need it.
1108     my ($user_barcode, $user_idfield) = $self->find_user_barcode($request);
1109     if (ref($user_barcode) eq 'NCIP::Problem') {
1110         $response->problem($user_barcode);
1111         return $response;
1112     }
1113     my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
1114     if (ref($user) eq 'NCIP::Problem') {
1115         $response->problem($user);
1116         return $response;
1117     }
1118
1119     # Auto-Graphics has agreed to return the ItemId that we sent them
1120     # in the RequestItemResponse when they attempt CancelRequestItem
1121     # for that same request.  For the sake of time, we're only going
1122     # to support that method of looking up the hold request in
1123     # Evergreen.  We leave it as future enhancement to make this
1124     # "portable" to other vendors.  (Frankly, that's a fool's errand.
1125     # NCIP is one of those "standards" where you neeed a separate
1126     # implementation for every vendor.)
1127     my $item_id = $request->{$message}->{ItemId};
1128     unless ($item_id) {
1129         # We'll throw a problem that we're missing needed information.
1130         my $problem = NCIP::Problem->new();
1131         $problem->ProblemType('Needed Data Missing');
1132         $problem->ProblemDetail('Cannot find ItemId in message.');
1133         $problem->ProblemElement('ItemId');
1134         $problem->ProblemValue('NULL');
1135         $response->problem($problem);
1136         return $response;
1137     }
1138     my $idvalue = $item_id->{ItemIdentifierValue};
1139     my $itemagy = $item_id->{AgencyId};
1140     my $selection_ou = $self->find_location_failover($itemagy, $request, $message);
1141     # We should support looking up holds by barcode, since we still
1142     # support placing them by barcode, but that is not how it is going
1143     # to work with Auto-Graphics, apparently.  I'll leave the
1144     # reimplementation of that for a future enhancement.
1145
1146     # See if we can find the hold:
1147     my $hold = $self->_hold_search($user, $idvalue, $selection_ou);
1148     if ($hold && $hold->transit()) {
1149         $response->problem(
1150             NCIP::Problem->new(
1151                 {
1152                     ProblemType => 'Request Already Processed',
1153                     ProblemDetail => 'Request has already been processed',
1154                     ProblemElement => 'RequestIdentifierValue',
1155                     ProblemValue => $request->{message}->{RequestId}->{RequestIdentifierValue}
1156                 }
1157             )
1158        );
1159     } elsif ($hold) {
1160         $self->cancel_hold($hold);
1161         my $data = {
1162             RequestId => NCIP::RequestId->new(
1163                 {
1164                     AgencyId => $request->{$message}->{RequestId}->{AgencyId},
1165                     RequestIdentifierType => $request->{$message}->{RequestId}->{RequestIdentifierType},
1166                     RequestIdentifierValue => $request->{$message}->{RequestId}->{RequestIdentifierValue}
1167                 }
1168             ),
1169             UserId => NCIP::User::Id->new(
1170                 {
1171                     UserIdentifierType => 'Barcode Id',
1172                     UserIdentifierValue => $user->card->barcode()
1173                 }
1174             ),
1175             ItemId => NCIP::Item::Id->new(
1176                 {
1177                     AgencyId => $request->{$message}->{ItemId}->{AgencyId},
1178                     ItemIdentifierType => $request->{$message}->{ItemId}->{ItemIdentifierType},
1179                     ItemIdentifierValue => $request->{$message}->{ItemId}->{ItemIdentifierValue}
1180                 }
1181             )
1182         };
1183         # Look for UserElements requested and add it to the response:
1184         my $elements = $request->{$message}->{UserElementType};
1185         if ($elements) {
1186             $elements = [$elements] unless (ref $elements eq 'ARRAY');
1187             my $optionalfields = $self->handle_user_elements($user, $elements);
1188             $data->{UserOptionalFields} = $optionalfields;
1189         }
1190         $elements = $request->{$message}->{ItemElementType};
1191         if ($elements && $hold->current_copy()) {
1192             $elements = [$elements] unless (ref $elements eq 'ARRAY');
1193             my $copy_details = $self->retrieve_copy_details_by_id($hold->current_copy());
1194             if ($copy_details) {
1195                 my $optionalfields = $self->handle_item_elements($copy_details->{copy}, $elements);
1196                 $data->{ItemOptionalFields} = $optionalfields;
1197             }
1198         }
1199         $response->data($data);
1200     } else {
1201         $response->problem(
1202             NCIP::Problem->new(
1203                 {
1204                     ProblemType => 'Unknown Request',
1205                     ProblemDetail => 'No request found for the item and user',
1206                     ProblemElement => 'NULL',
1207                     ProblemValue => 'NULL'
1208                 }
1209             )
1210         )
1211     }
1212
1213     return $response;
1214 }
1215
1216 =head1 METHODS USEFUL to SUBCLASSES
1217
1218 =head2 handle_user_elements
1219     $useroptionalfield = $ils->handle_user_elements($user, $elements);
1220
1221 Returns NCIP::User::OptionalFields for the given user and arrayref of
1222 UserElement.
1223
1224 =cut
1225
1226 sub handle_user_elements {
1227     my $self = shift;
1228     my $user = shift;
1229     my $elements = shift;
1230     my $optionalfields = NCIP::User::OptionalFields->new();
1231
1232     # First, we'll look for name information.
1233     if (grep {$_ eq 'Name Information'} @$elements) {
1234         my $name = NCIP::StructuredPersonalUserName->new();
1235         $name->Surname($user->family_name());
1236         $name->GivenName($user->first_given_name());
1237         $name->Prefix($user->prefix());
1238         $name->Suffix($user->suffix());
1239         $optionalfields->NameInformation($name);
1240     }
1241
1242     # Next, check for user address information.
1243     if (grep {$_ eq 'User Address Information'} @$elements) {
1244         my $addresses = [];
1245
1246         # See if the user has any valid, physcial addresses.
1247         foreach my $addr (@{$user->addresses()}) {
1248             next if ($U->is_true($addr->pending()));
1249             my $address = NCIP::User::AddressInformation->new({UserAddressRoleType=>$addr->address_type()});
1250             my $structured = NCIP::StructuredAddress->new();
1251             $structured->Line1($addr->street1());
1252             $structured->Line2($addr->street2());
1253             $structured->Locality($addr->city());
1254             $structured->Region($addr->state());
1255             $structured->PostalCode($addr->post_code());
1256             $structured->Country($addr->country());
1257             $address->PhysicalAddress(
1258                 NCIP::PhysicalAddress->new(
1259                     {
1260                         StructuredAddress => $structured,
1261                         Type => 'Postal Address'
1262                     }
1263                 )
1264             );
1265             push @$addresses, $address;
1266         }
1267
1268         # Right now, we're only sharing email address if the user
1269         # has it.
1270         if ($user->email()) {
1271             my $address = NCIP::User::AddressInformation->new({UserAddressRoleType=>'Email Address'});
1272             $address->ElectronicAddress(
1273                 NCIP::ElectronicAddress->new({
1274                     Type=>'mailto',
1275                     Data=>$user->email()
1276                 })
1277                 );
1278             push @$addresses, $address;
1279         }
1280         # Auto-graphics asked for the phone numbers.
1281         if ($user->day_phone()) {
1282             my $address = NCIP::User::AddressInformation->new({UserAddressRoleType=>'Day Phone'});
1283             $address->ElectronicAddress(
1284                 NCIP::ElectronicAddress->new(
1285                     {
1286                         Type=>'Day Phone',
1287                         Data=>$user->day_phone()
1288                     }
1289                 )
1290             );
1291             push @$addresses, $address;
1292         }
1293         if ($user->evening_phone()) {
1294             my $address = NCIP::User::AddressInformation->new({UserAddressRoleType=>'Evening Phone'});
1295             $address->ElectronicAddress(
1296                 NCIP::ElectronicAddress->new(
1297                     {
1298                         Type=>'Evening Phone',
1299                         Data=>$user->evening_phone()
1300                     }
1301                 )
1302             );
1303             push @$addresses, $address;
1304         }
1305         if ($user->other_phone()) {
1306             my $address = NCIP::User::AddressInformation->new({UserAddressRoleType=>'Other Phone'});
1307             $address->ElectronicAddress(
1308                 NCIP::ElectronicAddress->new(
1309                     {
1310                         Type=>'Other Phone',
1311                         Data=>$user->other_phone()
1312                     }
1313                 )
1314             );
1315             push @$addresses, $address;
1316         }
1317
1318         $optionalfields->UserAddressInformation($addresses);
1319     }
1320
1321     # Check for User Privilege.
1322     if (grep {$_ eq 'User Privilege'} @$elements) {
1323         # Get the user's group:
1324         my $pgt = $U->simplereq(
1325             'open-ils.pcrud',
1326             'open-ils.pcrud.retrieve.pgt',
1327             $self->{session}->{authtoken},
1328             $user->profile()
1329         );
1330         if ($pgt) {
1331             my $privilege = NCIP::User::Privilege->new();
1332             $privilege->AgencyId($user->home_ou->shortname());
1333             $privilege->AgencyUserPrivilegeType($pgt->name());
1334             $privilege->ValidToDate(_fix_date($user->expire_date()));
1335             $privilege->ValidFromDate(_fix_date($user->create_date()));
1336
1337             my $status = 'Active';
1338             if (_expired($user)) {
1339                 $status = 'Expired';
1340             } elsif ($U->is_true($user->barred())) {
1341                 $status = 'Barred';
1342             } elsif (!$U->is_true($user->active())) {
1343                 $status = 'Inactive';
1344             }
1345             if ($status) {
1346                 $privilege->UserPrivilegeStatus(
1347                     NCIP::User::PrivilegeStatus->new({
1348                         UserPrivilegeStatusType => $status
1349                     })
1350                 );
1351             }
1352
1353             $optionalfields->UserPrivilege([$privilege]);
1354         }
1355     }
1356
1357     # Check for Block Or Trap.
1358     if (grep {$_ eq 'Block Or Trap'} @$elements) {
1359         my $blocks = [];
1360
1361         # First, let's check if the profile is blocked from ILL.
1362         if (grep {$_->id() == $user->profile()} @{$self->{blocked_profiles}}) {
1363             my $block = NCIP::User::BlockOrTrap->new();
1364             $block->AgencyId($user->home_ou->shortname());
1365             $block->BlockOrTrapType('Block Interlibrary Loan');
1366             push @$blocks, $block;
1367         }
1368
1369         # Next, we loop through the user's standing penalties
1370         # looking for blocks on CIRC, HOLD, and RENEW.
1371         my ($have_circ, $have_renew, $have_hold) = (0,0,0);
1372         foreach my $penalty (@{$user->standing_penalties()}) {
1373             next unless($penalty->standing_penalty->block_list());
1374             my @block_list = split(/\|/, $penalty->standing_penalty->block_list());
1375             my $ou = $U->simplereq(
1376                 'open-ils.pcrud',
1377                 'open-ils.pcrud.retrieve.aou',
1378                 $self->{session}->{authtoken},
1379                 $penalty->org_unit()
1380             );
1381
1382             # Block checkout.
1383             if (!$have_circ && grep {$_ eq 'CIRC'} @block_list) {
1384                 my $bot = NCIP::User::BlockOrTrap->new();
1385                 $bot->AgencyId($ou->shortname());
1386                 $bot->BlockOrTrapType('Block Checkout');
1387                 push @$blocks, $bot;
1388                 $have_circ = 1;
1389             }
1390
1391             # Block holds.
1392             if (!$have_hold && grep {$_ eq 'HOLD' || $_ eq 'FULFILL'} @block_list) {
1393                 my $bot = NCIP::User::BlockOrTrap->new();
1394                 $bot->AgencyId($ou->shortname());
1395                 $bot->BlockOrTrapType('Block Holds');
1396                 push @$blocks, $bot;
1397                 $have_hold = 1;
1398             }
1399
1400             # Block renewals.
1401             if (!$have_renew && grep {$_ eq 'RENEW'} @block_list) {
1402                 my $bot = NCIP::User::BlockOrTrap->new();
1403                 $bot->AgencyId($ou->shortname());
1404                 $bot->BlockOrTrapType('Block Renewals');
1405                 push @$blocks, $bot;
1406                 $have_renew = 1;
1407             }
1408
1409             # Stop after we report one of each, even if more
1410             # blocks remain.
1411             last if ($have_circ && $have_renew && $have_hold);
1412         }
1413
1414         $optionalfields->BlockOrTrap($blocks);
1415     }
1416
1417     return $optionalfields;
1418 }
1419
1420 =head2 handle_item_elements
1421
1422 =cut
1423
1424 sub handle_item_elements {
1425     my $self = shift;
1426     my $copy = shift;
1427     my $elements = shift;
1428     my $optionalfields = NCIP::Item::OptionalFields->new();
1429
1430     my $details; # In case we need for more than one.
1431
1432     if (grep {$_ eq 'Bibliographic Description'} @$elements) {
1433         my $description;
1434         # Check for a precat copy, 'cause it is simple.
1435         if ($copy->dummy_title()) {
1436             $description = NCIP::Item::BibliographicDescription->new();
1437             $description->Title($copy->dummy_title());
1438             $description->Author($copy->dummy_author());
1439             if ($copy->dummy_isbn()) {
1440                 $description->BibliographicItemId(
1441                     NCIP::Item::BibliographicItemId->new(
1442                         {
1443                             BibliographicItemIdentifier => $copy->dummy_isbn(),
1444                             BibliographicItemIdentifierCode => 'ISBN'
1445                         }
1446                     )
1447                 );
1448             }
1449         } else {
1450             $details = $self->retrieve_copy_details_by_barcode($copy->barcode()) unless($details);
1451             $description = NCIP::Item::BibliographicDescription->new();
1452             $description->Title($details->{mvr}->title());
1453             $description->Author($details->{mvr}->author());
1454             $description->BibliographicRecordId(
1455                 NCIP::Item::BibliographicRecordId->new(
1456                     {
1457                         BibliographicRecordIdentifier => $details->{mvr}->doc_id(),
1458                         BibliographicRecordIdentifierCode => 'SYSNUMBER'
1459                     }
1460                 )
1461             );
1462             if ($details->{mvr}->publisher()) {
1463                 $description->Publisher($details->{mvr}->publisher());
1464             }
1465             if ($details->{mvr}->pubdate()) {
1466                 $description->PublicationDate($details->{mvr}->pubdate());
1467             }
1468             if ($details->{mvr}->edition()) {
1469                 $description->Edition($details->{mvr}->edition());
1470             }
1471         }
1472         $optionalfields->BibliographicDescription($description) if ($description);
1473     }
1474
1475     if (grep {$_ eq 'Item Description'} @$elements) {
1476         $details = $self->retrieve_copy_details_by_barcode($copy->barcode()) unless($details);
1477         # Call Number is the only field we currently return. We also
1478         # do not attempt to retun a prefix and suffix. Someone else
1479         # can deal with that if they want it.
1480         if ($details->{volume}) {
1481             $optionalfields->ItemDescription(
1482                 NCIP::Item::Description->new(
1483                     {CallNumber => $details->{volume}->label()}
1484                 )
1485             );
1486         }
1487     }
1488
1489     if (grep {$_ eq 'Circulation Status'} @$elements) {
1490         my $status = $copy->status();
1491         $status = $self->retrieve_copy_status($status) unless (ref($status));
1492         $optionalfields->CirculationStatus($status->name()) if ($status);
1493     }
1494
1495     if (grep {$_ eq 'Date Due'} @$elements) {
1496         $details = $self->retrieve_copy_details_by_barcode($copy->barcode()) unless($details);
1497         if ($details->{circ}) {
1498             if (!$details->{circ}->checkin_time()) {
1499                 $optionalfields->DateDue(_fix_date($details->{circ}->due_date()));
1500             }
1501         }
1502     }
1503
1504     if (grep {$_ eq 'Item Use Restriction Type'} @$elements) {
1505         $optionalfields->ItemUseRestrictionType('None');
1506     }
1507
1508     if (grep {$_ eq 'Physical Condition'} @$elements) {
1509         $optionalfields->PhysicalCondition(
1510             NCIP::Item::PhysicalCondition->new(
1511                 {PhysicalConditionType => 'Unknown'}
1512             )
1513         );
1514     }
1515
1516     return $optionalfields;
1517 }
1518
1519 =head2 login
1520
1521     $ils->login();
1522
1523 Login to Evergreen via OpenSRF. It uses internal state from the
1524 configuration file to login.
1525
1526 =cut
1527
1528 # Login via OpenSRF to Evergreen.
1529 sub login {
1530     my $self = shift;
1531
1532     # Get the authentication seed.
1533     my $seed = $U->simplereq(
1534         'open-ils.auth',
1535         'open-ils.auth.authenticate.init',
1536         $self->{config}->{credentials}->{username}
1537     );
1538
1539     # Actually login.
1540     if ($seed) {
1541         my $response = $U->simplereq(
1542             'open-ils.auth',
1543             'open-ils.auth.authenticate.complete',
1544             {
1545                 username => $self->{config}->{credentials}->{username},
1546                 password => md5_hex(
1547                     $seed . md5_hex($self->{config}->{credentials}->{password})
1548                 ),
1549                 type => 'staff',
1550                 workstation => $self->{config}->{credentials}->{workstation}
1551             }
1552         );
1553         if ($response) {
1554             $self->{session}->{authtoken} = $response->{payload}->{authtoken};
1555             $self->{session}->{authtime} = $response->{payload}->{authtime};
1556
1557             # Set/reset the work_ou and user data in case something changed.
1558
1559             # Retrieve the work_ou as an object.
1560             $self->{session}->{work_ou} = $U->simplereq(
1561                 'open-ils.pcrud',
1562                 'open-ils.pcrud.search.aou',
1563                 $self->{session}->{authtoken},
1564                 {shortname => $self->{config}->{credentials}->{work_ou}}
1565             );
1566
1567             # We need the user information in order to do some things.
1568             $self->{session}->{user} = $U->check_user_session($self->{session}->{authtoken});
1569
1570         }
1571     }
1572 }
1573
1574 =head2 checkauth
1575
1576     $valid = $ils->checkauth();
1577
1578 Returns 1 if the object a 'valid' authtoken, 0 if not.
1579
1580 =cut
1581
1582 sub checkauth {
1583     my $self = shift;
1584
1585     # We use AppUtils to do the heavy lifting.
1586     if (defined($self->{session})) {
1587         if ($U->check_user_session($self->{session}->{authtoken})) {
1588             return 1;
1589         } else {
1590             return 0;
1591         }
1592     }
1593
1594     # If we reach here, we don't have a session, so we are definitely
1595     # not logged in.
1596     return 0;
1597 }
1598
1599 =head2 retrieve_user_by_barcode
1600
1601     $user = $ils->retrieve_user_by_barcode($user_barcode, $user_idfield);
1602
1603 Do a fleshed retrieve of a patron by barcode. Return the patron if
1604 found and valid. Return a NCIP::Problem of 'Unknown User' otherwise.
1605
1606 The id field argument is used for the ProblemElement field in the
1607 NCIP::Problem object.
1608
1609 An invalid patron is one where the barcode is not found in the
1610 database, the patron is deleted, or the barcode used to retrieve the
1611 patron is not active. The problem element is also returned if an error
1612 occurs during the retrieval.
1613
1614 =cut
1615
1616 sub retrieve_user_by_barcode {
1617     my ($self, $barcode, $idfield) = @_;
1618     my $result = $U->simplereq(
1619         'open-ils.actor',
1620         'open-ils.actor.user.fleshed.retrieve_by_barcode',
1621         $self->{session}->{authtoken},
1622         $barcode,
1623         1
1624     );
1625
1626     # Check for a failure, or a deleted, inactive, or expired user,
1627     # and if so, return empty userdata.
1628     if (!$result || $U->event_code($result) || $U->is_true($result->deleted())
1629             || !grep {$_->barcode() eq $barcode && $U->is_true($_->active())} @{$result->cards()}) {
1630
1631         my $problem = NCIP::Problem->new();
1632         $problem->ProblemType('Unknown User');
1633         $problem->ProblemDetail("User with barcode $barcode unknown");
1634         $problem->ProblemElement($idfield);
1635         $problem->ProblemValue($barcode);
1636         $result = $problem;
1637     }
1638
1639     return $result;
1640 }
1641
1642 =head2 retrieve_user_by_id
1643
1644     $user = $ils->retrieve_user_by_id($id);
1645
1646 Similar to C<retrieve_user_by_barcode> but takes the user's database
1647 id rather than barcode. This is useful when you have a circulation or
1648 hold and need to get information about the user's involved in the hold
1649 or circulaiton.
1650
1651 It returns a fleshed user on success or undef on failure.
1652
1653 =cut
1654
1655 sub retrieve_user_by_id {
1656     my ($self, $id) = @_;
1657
1658     # Do a fleshed retrieve of the patron, and flesh the fields that
1659     # we would normally use.
1660     my $result = $U->simplereq(
1661         'open-ils.actor',
1662         'open-ils.actor.user.fleshed.retrieve',
1663         $self->{session}->{authtoken},
1664         $id,
1665         [ 'card', 'cards', 'standing_penalties', 'addresses', 'home_ou' ]
1666     );
1667     # Check for an error.
1668     undef($result) if ($result && $U->event_code($result));
1669
1670     return $result;
1671 }
1672
1673 =head2 check_user_for_problems
1674
1675     $problem = $ils>check_user_for_problems($user, 'HOLD, 'CIRC', 'RENEW');
1676
1677 This function checks if a user has a blocked profile or any from a
1678 list of provided blocks. If it does, then a NCIP::Problem object is
1679 returned, otherwise an undefined value is returned.
1680
1681 The list of blocks appears as additional arguments after the user. You
1682 can provide any value(s) that might appear in a standing penalty block
1683 lit in Evergreen. The example above checks for HOLD, CIRC, and
1684 RENEW. Any number of such values can be provided. If none are
1685 provided, the function only checks if the patron's profiles appears in
1686 the object's blocked profiles list.
1687
1688 It stops on the first matching block, if any.
1689
1690 =cut
1691
1692 sub check_user_for_problems {
1693     my $self = shift;
1694     my $user = shift;
1695     my @blocks = @_;
1696
1697     # Fill this in if we have a problem, otherwise just return it.
1698     my $problem;
1699
1700     # First, check the user's profile.
1701     if (grep {$_->id() == $user->profile()} @{$self->{blocked_profiles}}) {
1702         $problem = NCIP::Problem->new(
1703             {
1704                 ProblemType => 'User Blocked',
1705                 ProblemDetail => 'User blocked from inter-library loan',
1706                 ProblemElement => 'NULL',
1707                 ProblemValue => 'NULL'
1708             }
1709         );
1710     }
1711
1712     # Next, check if the patron has one of the indicated blocks.
1713     unless ($problem) {
1714         foreach my $penalty (@{$user->standing_penalties()}) {
1715             if ($penalty->standing_penalty->block_list()) {
1716                 my @pblocks = split(/\|/, $penalty->standing_penalty->block_list());
1717                 foreach my $block (@blocks) {
1718                     if (grep {$_ =~ /$block/} @pblocks) {
1719                         $problem = NCIP::Problem->new(
1720                             {
1721                                 ProblemType => 'User Blocked',
1722                                 ProblemDetail => 'User blocked from ' .
1723                                     ($block eq 'HOLD') ? 'holds' : (($block eq 'RENEW') ? 'renewals' :
1724                                                                         (($block eq 'CIRC') ? 'checkout' : lc($block))),
1725                                 ProblemElement => 'NULL',
1726                                 ProblemValue => 'NULL'
1727                             }
1728                         );
1729                         last;
1730                     }
1731                 }
1732                 last if ($problem);
1733             }
1734         }
1735     }
1736
1737     return $problem;
1738 }
1739
1740 =head2 check_circ_details
1741
1742     $problem = $ils->check_circ_details($circ, $copy, $user);
1743
1744 Checks if we can checkin or renew a circulation. That is, the
1745 circulation is still open (i.e. the copy is still checked out), if we
1746 either own the copy or are the circulation location, and if the
1747 circulation is for the optional $user argument. $circ and $copy are
1748 required. $user is optional.
1749
1750 Returns a problem if any of the above conditions fail. Returns undef
1751 if they pass and we can proceed with the checkin or renewal.
1752
1753 If the failure occurred on the copy-related checks, then the
1754 ProblemElement field will be undefined and needs to be filled in with
1755 the item id field name. If the check for the copy being checked out to
1756 the provided user fails, then both ProblemElement and ProblemValue
1757 fields will be empty and need to be filled in by the caller.
1758
1759 =cut
1760
1761 sub check_circ_details {
1762     my ($self, $circ, $copy, $user) = @_;
1763
1764     # Shortcut for the next check.
1765     my $ou_id = $self->{session}->{work_ou}->id();
1766
1767     if (!$circ || $circ->checkin_time() || ($circ->circ_lib() != $ou_id && $copy->circ_lib() != $ou_id)) {
1768         # Item isn't checked out.
1769         return NCIP::Problem->new(
1770             {
1771                 ProblemType => 'Item Not Checked Out',
1772                 ProblemDetail => 'Item with barcode ' . $copy->barcode() . ' is not checked out.',
1773                 ProblemValue => $copy->barcode()
1774             }
1775         );
1776     } else {
1777         # Get data on the patron who has it checked out.
1778         my $circ_user = $self->retrieve_user_by_id($circ->usr());
1779         if ($user && $circ_user && $user->id() != $circ_user->id()) {
1780             # The ProblemElement and ProblemValue field need to be
1781             # filled in by the caller.
1782             return NCIP::Problem->new(
1783                 {
1784                     ProblemType => 'Item Not Checked Out To This User',
1785                     ProblemDetail => 'Item with barcode ' . $copy->barcode() . ' is not checked out to this user.',
1786                 }
1787             );
1788         }
1789     }
1790     # If we get here, we're good to go.
1791     return undef;
1792 }
1793
1794 =head2 retrieve_copy_details_by_barcode
1795
1796     $copy = $ils->retrieve_copy_details_by_barcode($copy_barcode);
1797
1798 Look up and retrieve some copy details by the copy barcode. This
1799 method returns either a hashref with the copy details or undefined if
1800 no copy exists with that barcode or if some error occurs.
1801
1802 The hashref has the fields copy, hold, transit, circ, volume, and mvr.
1803
1804 This method differs from C<retrieve_user_by_barcode> in that a copy
1805 cannot be invalid if it exists and it is not always an error if no
1806 copy exists. In some cases, when handling AcceptItem, we might prefer
1807 there to be no copy.
1808
1809 =cut
1810
1811 sub retrieve_copy_details_by_barcode {
1812     my $self = shift;
1813     my $barcode = shift;
1814
1815     my $copy = $U->simplereq(
1816         'open-ils.circ',
1817         'open-ils.circ.copy_details.retrieve.barcode',
1818         $self->{session}->{authtoken},
1819         $barcode
1820     );
1821
1822     # If $copy is an event, return undefined.
1823     if ($copy && $U->event_code($copy)) {
1824         undef($copy);
1825     }
1826
1827     return $copy;
1828 }
1829
1830 =head2 retrieve_copy_details_by_id
1831
1832     $copy = $ils->retrieve_copy_details_by_id($copy_id);
1833
1834 Retrieve copy_details by copy id. Same as the above, but with a copy
1835 id instead of barcode.
1836
1837 =cut
1838
1839 sub retrieve_copy_details_by_id {
1840     my $self = shift;
1841     my $copy_id = shift;
1842
1843     my $copy = $U->simplereq(
1844         'open-ils.circ',
1845         'open-ils.circ.copy_details.retrieve',
1846         $self->{session}->{authtoken},
1847         $copy_id
1848     );
1849
1850     # If $copy is an event, return undefined.
1851     if ($copy && $U->event_code($copy)) {
1852         undef($copy);
1853     }
1854
1855     return $copy;
1856 }
1857
1858 =head2 find_copy_details_by_item
1859
1860     $copy_details = $ils->find_copy_details_by_item($item);
1861
1862 This routine returns a copy_details hashref (See:
1863 retrieve_copy_details_by_barcode) for a given item. It attempts to
1864 find the "first" copy for the given item. If item is a call number it
1865 looks for the first, not deleted copy. If item is a bib, it looks for
1866 the first not deleted copy on the first not deleted call number. If
1867 item is a copy, it simply returns the details for the copy.
1868
1869 =cut
1870
1871 sub find_copy_details_by_item {
1872     my $self = shift;
1873     my $item = shift;
1874
1875     my ($details);
1876
1877     if (ref($item) eq 'Fieldmapper::biblio::record_entry') {
1878         my $acns = $U->simplereq(
1879             'open-ils.pcrud',
1880             'open-ils.pcrud.search.acn.atomic',
1881             $self->{session}->{authtoken},
1882             {
1883                 record => $item->id(),
1884                 deleted => 'f'
1885             }
1886         );
1887         ($item) = sort {$a->id() <=> $b->id()} @{$acns};
1888     }
1889
1890     if (ref($item) eq 'Fieldmapper::asset::call_number') {
1891         my $copies = $U->simplereq(
1892             'open-ils.pcrud',
1893             'open-ils.pcrud.search.acp.atomic',
1894             $self->{session}->{authtoken},
1895             {
1896                 call_number => $item->id(),
1897                 deleted => 'f'
1898             }
1899         );
1900         ($item) = sort {$a->id() <=> $b->id()} @{$copies};
1901     }
1902
1903     if (ref($item) eq 'Fieldmapper::asset::copy') {
1904         $details = $self->retrieve_copy_details_by_barcode($item->barcode());
1905     }
1906
1907     return $details;
1908 }
1909
1910 =head2 retrieve_copy_status
1911
1912     $status = $ils->retrieve_copy_status($id);
1913
1914 Retrive a copy status object by database ID.
1915
1916 =cut
1917
1918 sub retrieve_copy_status {
1919     my $self = shift;
1920     my $id = shift;
1921
1922     my $status = $U->simplereq(
1923         'open-ils.pcrud',
1924         'open-ils.pcrud.retrieve.ccs',
1925         $self->{session}->{authtoken},
1926         $id
1927     );
1928
1929     return $status;
1930 }
1931
1932 =head2 retrieve_org_unit_by_shortname
1933
1934     $org_unit = $ils->retrieve_org_unit_by_shortname($shortname);
1935
1936 Retrieves an org. unit from the database by shortname, and fleshes the
1937 ou_type field. Returns the org. unit as a Fieldmapper object or
1938 undefined.
1939
1940 =cut
1941
1942 sub retrieve_org_unit_by_shortname {
1943     my $self = shift;
1944     my $shortname = shift;
1945
1946     my $aou = $U->simplereq(
1947         'open-ils.actor',
1948         'open-ils.actor.org_unit.retrieve_by_shortname',
1949         $shortname
1950     );
1951
1952     # We want to retrieve the type and manually "flesh" the object.
1953     if ($aou) {
1954         my $type = $U->simplereq(
1955             'open-ils.pcrud',
1956             'open-ils.pcrud.retrieve.aout',
1957             $self->{session}->{authtoken},
1958             $aou->ou_type()
1959         );
1960         $aou->ou_type($type) if ($type);
1961     }
1962
1963     return $aou;
1964 }
1965
1966 =head2 retrieve_copy_location
1967
1968     $location = $ils->retrieve_copy_location($location_id);
1969
1970 Retrieve a copy location based on id.
1971
1972 =cut
1973
1974 sub retrieve_copy_location {
1975     my $self = shift;
1976     my $id = shift;
1977
1978     my $location = $U->simplereq(
1979         'open-ils.pcrud',
1980         'open-ils.pcrud.retrieve.acpl',
1981         $self->{session}->{authtoken},
1982         $id
1983     );
1984
1985     return $location;
1986 }
1987
1988 =head2 retrieve_biblio_record_entry
1989
1990     $bre = $ils->retrieve_biblio_record_entry($bre_id);
1991
1992 Given a biblio.record_entry.id, this method retrieves a bre object.
1993
1994 =cut
1995
1996 sub retrieve_biblio_record_entry {
1997     my $self = shift;
1998     my $id = shift;
1999
2000     my $bre = $U->simplereq(
2001         'open-ils.pcrud',
2002         'open-ils.pcrud.retrieve.bre',
2003         $self->{session}->{authtoken},
2004         $id
2005     );
2006
2007     return $bre;
2008 }
2009
2010 =head2 create_precat_copy
2011
2012     $item_info->{
2013         barcode => '312340123456789',
2014         author => 'Public, John Q.',
2015         title => 'Magnum Opus',
2016         call_number => '005.82',
2017         publisher => 'Brick House',
2018         publication_date => '2014'
2019     };
2020
2021     $item = $ils->create_precat_copy($item_info);
2022
2023
2024 Create a "precat" copy to use for the incoming item using a hashref of
2025 item information. At a minimum, the barcode, author and title fields
2026 need to be filled in. The other fields are ignored if provided.
2027
2028 This method is called by the AcceptItem handler if the C<use_precats>
2029 configuration option is turned on.
2030
2031 =cut
2032
2033 sub create_precat_copy {
2034     my $self = shift;
2035     my $item_info = shift;
2036
2037     my $item = Fieldmapper::asset::copy->new();
2038     $item->barcode($item_info->{barcode});
2039     $item->call_number(OILS_PRECAT_CALL_NUMBER);
2040     $item->dummy_title($item_info->{title});
2041     $item->dummy_author($item_info->{author});
2042     $item->circ_lib($self->{session}->{work_ou}->id());
2043     $item->circulate('t');
2044     $item->holdable('t');
2045     $item->opac_visible('f');
2046     $item->deleted('f');
2047     $item->fine_level(OILS_PRECAT_COPY_FINE_LEVEL);
2048     $item->loan_duration(OILS_PRECAT_COPY_LOAN_DURATION);
2049     $item->location(1);
2050     $item->status(0);
2051     $item->editor($self->{session}->{user}->id());
2052     $item->creator($self->{session}->{user}->id());
2053     $item->isnew(1);
2054
2055     # Actually create it:
2056     my $xact;
2057     my $ses = OpenSRF::AppSession->create('open-ils.pcrud');
2058     $ses->connect();
2059     eval {
2060         $xact = $ses->request(
2061             'open-ils.pcrud.transaction.begin',
2062             $self->{session}->{authtoken}
2063         )->gather(1);
2064         $item = $ses->request(
2065             'open-ils.pcrud.create.acp',
2066             $self->{session}->{authtoken},
2067             $item
2068         )->gather(1);
2069         $xact = $ses->request(
2070             'open-ils.pcrud.transaction.commit',
2071             $self->{session}->{authtoken}
2072         )->gather(1);
2073     };
2074     if ($@) {
2075         undef($item);
2076         if ($xact) {
2077             eval {
2078                 $ses->request(
2079                     'open-ils.pcrud.transaction.rollback',
2080                     $self->{session}->{authtoken}
2081                 )->gather(1);
2082             };
2083         }
2084     }
2085     $ses->disconnect();
2086
2087     return $item;
2088 }
2089
2090 =head2 create_fuller_copy
2091
2092     $item_info->{
2093         barcode => '31234003456789',
2094         author => 'Public, John Q.',
2095         title => 'Magnum Opus',
2096         call_number => '005.82',
2097         publisher => 'Brick House',
2098         publication_date => '2014'
2099     };
2100
2101     $item = $ils->create_fuller_copy($item_info);
2102
2103 Creates a skeletal bibliographic record, call number, and copy for the
2104 incoming item using a hashref with item information in it. At a
2105 minimum, the barcode, author, title, and call_number fields must be
2106 filled in.
2107
2108 This method is used by the AcceptItem handler if the C<use_precats>
2109 configuration option is NOT set.
2110
2111 =cut
2112
2113 sub create_fuller_copy {
2114     my $self = shift;
2115     my $item_info = shift;
2116
2117     my $item;
2118
2119     # We do everything in one transaction, because it should be atomic.
2120     my $ses = OpenSRF::AppSession->create('open-ils.pcrud');
2121     $ses->connect();
2122     my $xact;
2123     eval {
2124         $xact = $ses->request(
2125             'open-ils.pcrud.transaction.begin',
2126             $self->{session}->{authtoken}
2127         )->gather(1);
2128     };
2129     if ($@) {
2130         undef($xact);
2131     }
2132
2133     # The rest depends on there being a transaction.
2134     if ($xact) {
2135
2136         # Create the MARC record.
2137         my $record = MARC::Record->new();
2138         $record->encoding('UTF-8');
2139         $record->leader('00881nam a2200193   4500');
2140         my $datespec = strftime("%Y%m%d%H%M%S.0", localtime);
2141         my @fields = ();
2142         push(@fields, MARC::Field->new('005', $datespec));
2143         push(@fields, MARC::Field->new('082', '0', '4', 'a' => $item_info->{call_number}));
2144         push(@fields, MARC::Field->new('245', '0', '0', 'a' => $item_info->{title}));
2145         # Publisher is a little trickier:
2146         if ($item_info->{publisher}) {
2147             my $pub = MARC::Field->new('260', ' ', ' ', 'a' => '[S.l.]', 'b' => $item_info->{publisher});
2148             $pub->add_subfields('c' => $item_info->{publication_date}) if ($item_info->{publication_date});
2149             push(@fields, $pub);
2150         }
2151         # We have no idea if the author is personal corporate or something else, so we use a 720.
2152         push(@fields, MARC::Field->new('720', ' ', ' ', 'a' => $item_info->{author}, '4' => 'aut'));
2153         $record->append_fields(@fields);
2154         my $marc = clean_marc($record);
2155
2156         # Create the bib object.
2157         my $bib = Fieldmapper::biblio::record_entry->new();
2158         $bib->creator($self->{session}->{user}->id());
2159         $bib->editor($self->{session}->{user}->id());
2160         $bib->source($self->{bib_source}->id());
2161         $bib->active('t');
2162         $bib->deleted('f');
2163         $bib->marc($marc);
2164         $bib->isnew(1);
2165
2166         eval {
2167             $bib = $ses->request(
2168                 'open-ils.pcrud.create.bre',
2169                 $self->{session}->{authtoken},
2170                 $bib
2171             )->gather(1);
2172         };
2173         if ($@) {
2174             undef($bib);
2175             eval {
2176                 $ses->request(
2177                     'open-ils.pcrud.transaction.rollback',
2178                     $self->{session}->{authtoken}
2179                 )->gather(1);
2180             };
2181         }
2182
2183         # Create the call number
2184         my $acn;
2185         if ($bib) {
2186             $acn = Fieldmapper::asset::call_number->new();
2187             $acn->creator($self->{session}->{user}->id());
2188             $acn->editor($self->{session}->{user}->id());
2189             $acn->label($item_info->{call_number});
2190             $acn->record($bib->id());
2191             $acn->owning_lib($self->{session}->{work_ou}->id());
2192             $acn->deleted('f');
2193             $acn->isnew(1);
2194
2195             eval {
2196                 $acn = $ses->request(
2197                     'open-ils.pcrud.create.acn',
2198                     $self->{session}->{authtoken},
2199                     $acn
2200                 )->gather(1);
2201             };
2202             if ($@) {
2203                 undef($acn);
2204                 eval {
2205                     $ses->request(
2206                         'open-ils.pcrud.transaction.rollback',
2207                         $self->{session}->{authtoken}
2208                     )->gather(1);
2209                 };
2210             }
2211         }
2212
2213         # create the copy
2214         if ($acn) {
2215             $item = Fieldmapper::asset::copy->new();
2216             $item->barcode($item_info->{barcode});
2217             $item->call_number($acn->id());
2218             $item->circ_lib($self->{session}->{work_ou}->id);
2219             $item->circulate('t');
2220             if ($self->{config}->{items}->{use_force_holds}) {
2221                 $item->holdable('f');
2222             } else {
2223                 $item->holdable('t');
2224             }
2225             $item->opac_visible('f');
2226             $item->deleted('f');
2227             $item->fine_level(OILS_PRECAT_COPY_FINE_LEVEL);
2228             $item->loan_duration(OILS_PRECAT_COPY_LOAN_DURATION);
2229             $item->location(1);
2230             $item->status(0);
2231             $item->editor($self->{session}->{user}->id);
2232             $item->creator($self->{session}->{user}->id);
2233             $item->isnew(1);
2234
2235             eval {
2236                 $item = $ses->request(
2237                     'open-ils.pcrud.create.acp',
2238                     $self->{session}->{authtoken},
2239                     $item
2240                 )->gather(1);
2241
2242                 # Cross our fingers and commit the work.
2243                 $xact = $ses->request(
2244                     'open-ils.pcrud.transaction.commit',
2245                     $self->{session}->{authtoken}
2246                 )->gather(1);
2247             };
2248             if ($@) {
2249                 undef($item);
2250                 eval {
2251                     $ses->request(
2252                         'open-ils.pcrud.transaction.rollback',
2253                         $self->{session}->{authtoken}
2254                     )->gather(1) if ($xact);
2255                 };
2256             }
2257         }
2258     }
2259
2260     # We need to disconnect our session.
2261     $ses->disconnect();
2262
2263     # Now, we handle our asset stat_cat entries.
2264     if ($item) {
2265         # It would be nice to do these in the above transaction, but
2266         # pcrud does not support the ascecm object, yet.
2267         foreach my $entry (@{$self->{stat_cat_entries}}) {
2268             my $map = Fieldmapper::asset::stat_cat_entry_copy_map->new();
2269             $map->isnew(1);
2270             $map->stat_cat($entry->stat_cat());
2271             $map->stat_cat_entry($entry->id());
2272             $map->owning_copy($item->id());
2273             # We don't really worry if it succeeds or not.
2274             $U->simplereq(
2275                 'open-ils.circ',
2276                 'open-ils.circ.stat_cat.asset.copy_map.create',
2277                 $self->{session}->{authtoken},
2278                 $map
2279             );
2280         }
2281     }
2282
2283     return $item;
2284 }
2285
2286 =head2 place_hold
2287
2288     $hold = $ils->place_hold($item, $user, $location, $expiration, $org_unit);
2289
2290 This function places a hold on $item for $user for pickup at
2291 $location. If location is not provided or undefined, the user's home
2292 library is used as a fallback.
2293
2294 The $expiration argument is optional and must be a properly formatted
2295 ISO date time. It will be used as the hold expire time, if
2296 provided. Otherwise the system default time will be used.
2297
2298 The $org_unit parameter is only consulted in the event of $item being
2299 a biblio::record_entry object.  In which case, it is expected to be
2300 undefined or an actor::org_unit object.  If it is present, then its id
2301 and ou_type depth (if the ou_type field is fleshed) will be used to
2302 control the selection ou and selection depth for the hold.  This
2303 essentially limits the hold to being filled by copies belonging to the
2304 specified org_unit or its children.
2305
2306 $item can be a copy (asset::copy), volume (asset::call_number), or bib
2307 (biblio::record_entry). The appropriate hold type will be placed
2308 depending on the object.
2309
2310 On success, the method returns the object representing the hold. On
2311 failure, a NCIP::Problem object, describing the failure, is returned.
2312
2313 =cut
2314
2315 sub place_hold {
2316     my $self = shift;
2317     my $item = shift;
2318     my $user = shift;
2319     my $location = shift;
2320     my $expiration = shift;
2321     my $org_unit = shift;
2322
2323     # If $location is undefined, use the user's home_ou, which should
2324     # have been fleshed when the user was retrieved.
2325     $location = $user->home_ou() unless ($location);
2326
2327     # $hold is the hold. $params is for the is_possible check.
2328     my ($hold, $params);
2329
2330     # Prep the hold with fields common to all hold types:
2331     $hold = Fieldmapper::action::hold_request->new();
2332     $hold->isnew(1); # Just to make sure.
2333     $hold->target($item->id());
2334     $hold->usr($user->id());
2335     $hold->pickup_lib($location->id());
2336     $hold->expire_time(cleanse_ISO8601($expiration)) if ($expiration);
2337     if (!$user->email()) {
2338         $hold->email_notify('f');
2339         $hold->phone_notify($user->day_phone()) if ($user->day_phone());
2340     } else {
2341         $hold->email_notify('t');
2342     }
2343
2344     # Ditto the params:
2345     $params = { pickup_lib => $location->id(), patronid => $user->id() };
2346
2347     if (ref($item) eq 'Fieldmapper::asset::copy') {
2348         my $type = ($self->{config}->{items}->{use_force_holds}) ? 'F' : 'C';
2349         $hold->hold_type($type);
2350         $hold->current_copy($item->id());
2351         $params->{hold_type} = $type;
2352         $params->{copy_id} = $item->id();
2353     } elsif (ref($item) eq 'Fieldmapper::asset::call_number') {
2354         $hold->hold_type('V');
2355         $params->{hold_type} = 'V';
2356         $params->{volume_id} = $item->id();
2357     } elsif (ref($item) eq 'Fieldmapper::biblio::record_entry') {
2358         $hold->hold_type('T');
2359         $params->{hold_type} = 'T';
2360         $params->{titleid} = $item->id();
2361         if ($org_unit && ref($org_unit) eq 'Fieldmapper::actor::org_unit') {
2362             $hold->selection_ou($org_unit->id());
2363             $hold->selection_depth($org_unit->ou_type->depth()) if (ref($org_unit->ou_type()));
2364         }
2365     }
2366
2367     # Check for a duplicate hold:
2368     my $duplicate = $U->simplereq(
2369         'open-ils.pcrud',
2370         'open-ils.pcrud.search.ahr',
2371         $self->{session}->{authtoken},
2372         {
2373             hold_type => $hold->hold_type(),
2374             target => $hold->target(),
2375             usr => $hold->usr(),
2376             expire_time => {'>' => 'now'},
2377             cancel_time => undef,
2378             fulfillment_time => undef
2379         }
2380     );
2381     if ($duplicate) {
2382         return NCIP::Problem->new(
2383             {
2384                 ProblemType => 'Duplicate Request',
2385                 ProblemDetail => 'A request for this item already exists for this patron.',
2386                 ProblemElement => 'NULL',
2387                 ProblemValue => 'NULL'
2388             }
2389         );
2390     }
2391
2392     # Check if the hold is possible:
2393     my $r = $U->simplereq(
2394         'open-ils.circ',
2395         'open-ils.circ.title_hold.is_possible',
2396         $self->{session}->{authtoken},
2397         $params
2398     );
2399
2400     if ($r->{success}) {
2401         $hold = $U->simplereq(
2402             'open-ils.circ',
2403             'open-ils.circ.holds.create.override',
2404             $self->{session}->{authtoken},
2405             $hold
2406         );
2407         if (ref($hold)) {
2408             $hold = $hold->[0] if (ref($hold) eq 'ARRAY');
2409             $hold = _problem_from_event('Request Not Possible', $hold);
2410         } else {
2411             # open-ils.circ.holds.create.override returns the id on
2412             # success, so we retrieve the full hold object from the
2413             # database to return it.
2414             $hold = $U->simplereq(
2415                 'open-ils.pcrud',
2416                 'open-ils.pcrud.retrieve.ahr',
2417                 $self->{session}->{authtoken},
2418                 $hold
2419             );
2420         }
2421     } elsif ($r->{last_event}) {
2422         $hold = _problem_from_event('Request Not Possible', $r->{last_event});
2423     } elsif ($r->{textcode}) {
2424         $hold = _problem_from_event('Request Not Possible', $r);
2425     } else {
2426         $hold = _problem_from_event('Request Not Possible');
2427     }
2428
2429     return $hold;
2430 }
2431
2432 =head2 cancel_hold
2433
2434     $ils->cancel_hold($hold);
2435
2436 This method cancels the hold argument. It makes no checks on the hold,
2437 so if there are certain conditions that need to be fulfilled before
2438 the hold is canceled, then you must check them before calling this
2439 method.
2440
2441 It returns undef on success or failure. If it fails, you've usually
2442 got bigger problems.
2443
2444 =cut
2445
2446 sub cancel_hold {
2447     my $self = shift;
2448     my $hold = shift;
2449
2450     my $r = $U->simplereq(
2451         'open-ils.circ',
2452         'open-ils.circ.hold.cancel',
2453         $self->{session}->{authtoken},
2454         $hold->id(),
2455         '5',
2456         'Canceled via NCIPServer'
2457     );
2458
2459     return undef;
2460 }
2461
2462 =head2 delete_copy
2463
2464     $ils->delete_copy($copy);
2465
2466 Deletes the copy, and if it is owned by our work_ou and not a precat,
2467 we also delete the volume and bib on which the copy depends.
2468
2469 =cut
2470
2471 sub delete_copy {
2472     my $self = shift;
2473     my $copy = shift;
2474
2475     # Shortcut for ownership checks below.
2476     my $ou_id = $self->{session}->{work_ou}->id();
2477
2478     # First, make sure the copy is not already deleted and we own it.
2479     return undef if ($U->is_true($copy->deleted()) || $copy->circ_lib() != $ou_id);
2480
2481     # Indicate we want to delete the copy.
2482     $copy->isdeleted(1);
2483
2484     # Delete the copy using a backend call that will delete the copy,
2485     # the call number, and bib when appropriate.
2486     my $result = $U->simplereq(
2487         'open-ils.cat',
2488         'open-ils.cat.asset.copy.fleshed.batch.update.override',
2489         $self->{session}->{authtoken},
2490         [$copy]
2491     );
2492
2493     # We are currently not checking for succes or failure of the
2494     # above. At some point, someone may want to.
2495
2496     return undef;
2497 }
2498
2499 =head2 copy_can_circulate
2500
2501     $can_circulate = $ils->copy_can_circulate($copy);
2502
2503 Check if the copy's location and the copy itself allow
2504 circulation. Return true if they do, and false if they do not.
2505
2506 =cut
2507
2508 sub copy_can_circulate {
2509     my $self = shift;
2510     my $copy = shift;
2511
2512     my $location = $copy->location();
2513     unless (ref($location)) {
2514         $location = $self->retrieve_copy_location($location);
2515     }
2516
2517     return ($U->is_true($copy->circulate()) && $U->is_true($location->circulate()));
2518 }
2519
2520 =head2 copy_can_fulfill
2521
2522     $can_fulfill = $ils->copy_can_fulfill($copy);
2523
2524 Check if the copy's location and the copy itself allow
2525 holds. Return true if they do, and false if they do not.
2526
2527 =cut
2528
2529 sub copy_can_fulfill {
2530     my $self = shift;
2531     my $copy = shift;
2532
2533     my $location = $copy->location();
2534     unless (ref($location)) {
2535         $location = $self->retrieve_copy_location($location);
2536     }
2537
2538     return ($U->is_true($copy->holdable()) && $U->is_true($location->holdable()));
2539 }
2540
2541 =head1 OVERRIDDEN PARENT METHODS
2542
2543 =head2 find_user_barcode
2544
2545 We dangerously override our parent's C<find_user_barcode> to return
2546 either the $barcode or a Problem object. In list context the barcode
2547 or problem will be the first argument and the id field, if any, will
2548 be the second. We also add a second, optional, argument to indicate a
2549 default value for the id field in the event of a failure to find
2550 anything at all. (Perl lets us get away with this.)
2551
2552 =cut
2553
2554 sub find_user_barcode {
2555     my $self = shift;
2556     my $request = shift;
2557     my $default = shift;
2558
2559     unless ($default) {
2560         my $message = $self->parse_request_type($request);
2561         if ($message eq 'LookupUser') {
2562             $default = 'AuthenticationInputData';
2563         } else {
2564             $default = 'UserIdentifierValue';
2565         }
2566     }
2567
2568     my ($value, $idfield) = $self->SUPER::find_user_barcode($request);
2569
2570     unless ($value) {
2571         $idfield = $default unless ($idfield);
2572         $value = NCIP::Problem->new();
2573         $value->ProblemType('Needed Data Missing');
2574         $value->ProblemDetail('Cannot find user barcode in message.');
2575         $value->ProblemElement($idfield);
2576         $value->ProblemValue('NULL');
2577     }
2578
2579     return (wantarray) ? ($value, $idfield) : $value;
2580 }
2581
2582 =head2 find_item_barcode
2583
2584 We do pretty much the same thing as with C<find_user_barcode> for
2585 C<find_item_barcode>.
2586
2587 =cut
2588
2589 sub find_item_barcode {
2590     my $self = shift;
2591     my $request = shift;
2592     my $default = shift || 'ItemIdentifierValue';
2593
2594     my ($value, $idfield) = $self->SUPER::find_item_barcode($request);
2595
2596     unless ($value) {
2597         $idfield = $default unless ($idfield);
2598         $value = NCIP::Problem->new();
2599         $value->ProblemType('Needed Data Missing');
2600         $value->ProblemDetail('Cannot find item barcode in message.');
2601         $value->ProblemElement($idfield);
2602         $value->ProblemValue('NULL');
2603     }
2604
2605     return (wantarray) ? ($value, $idfield) : $value;
2606 }
2607
2608 =head2 find_target_via_bibliographic_id
2609
2610     $item = $ils->find_target_via_bibliographic_id(@biblio_ids);
2611
2612 Searches for a bibliographic record to put on hold and returns an
2613 appropriate hold target item depending upon what it finds. If an
2614 appropriate, single target cannot be found, it returns an
2615 NCIP::Problem with the problem message.
2616
2617 Currently, we only look for SYSNUMBER, ISBN, and ISSN record
2618 identifiers. If nothing is found, this method can return undef. (Gotta
2619 love Perl and untyped/weakly typed languages in general!)
2620
2621 TODO: Figure out how to search OCLC numbers. We probably need to use
2622 "MARC Expert Search" if we don't want to do a JSON query on
2623 metabib.full_rec.
2624
2625 =cut
2626
2627 sub find_target_via_bibliographic_id {
2628     my $self = shift;
2629     my @biblio_ids = @_;
2630
2631     # The item that we find:
2632     my $item;
2633
2634     # Id for our bib in Evergreen:
2635     my $bibid;
2636
2637     # First, let's look for a SYSNUMBER:
2638     my ($idobj) = grep
2639         { ($_->{BibliographicRecordIdentifierCode} && $_->{BibliographicRecordIdentifierCode} eq 'SYSNUMBER')
2640               || ($_->{BibliographicItemIdentifierCode} && $_->{BibliographicItemIdentifierCode} eq 'SYSNUMBER')
2641               || $_->{AgencyId} }
2642             @biblio_ids;
2643     if ($idobj) {
2644         my $loc;
2645         # BibliographicRecordId can have an AgencyId field if the
2646         # BibliographicRecordIdentifierCode is absent.
2647         if ($idobj->{AgencyId}) {
2648             $bibid = $idobj->{BibliographicRecordIdentifier};
2649             my $locname = $idobj->{AgencyId};
2650             if ($locname) {
2651                 $locname =~ s/^.*://;
2652                 $loc = $self->retrieve_org_unit_by_shortname($locname);
2653             }
2654         } elsif ($idobj->{BibliographicRecordIdentifierCode}) {
2655             $bibid = $idobj->{BibliographicRecordIdentifier};
2656         } else {
2657             $bibid = $idobj->{BibliographicItemIdentifier};
2658         }
2659         if ($bibid && $loc) {
2660             $item = $self->_call_number_search($bibid, $loc);
2661         } else {
2662             $item = $U->simplereq(
2663                 'open-ils.pcrud',
2664                 'open-ils.pcrud.retrieve.bre',
2665                 $self->{session}->{authtoken},
2666                 $bibid
2667             );
2668         }
2669         # Check if item is deleted so we'll look for more
2670         # possibilties.
2671         undef($item) if ($item && $U->is_true($item->deleted()));
2672     }
2673
2674     # Build an array of id objects based on the other identifier fields.
2675     my @idobjs = grep
2676         {
2677             ($_->{BibliographicRecordIdentifierCode} && $_->{BibliographicRecordIdentifierCode} eq 'ISBN')
2678                 || ($_->{BibliographicItemIdentifierCode} && $_->{BibliographicItemIdentifierCode} eq 'ISBN')
2679                 || ($_->{BibliographicRecordIdentifierCode} && $_->{BibliographicRecordIdentifierCode} eq 'ISSN')
2680                 || ($_->{BibliographicItemIdentifierCode} && $_->{BibliographicItemIdentifierCode} eq 'ISSN')
2681         } @biblio_ids;
2682
2683     if (@idobjs) {
2684         my $stashed_problem;
2685         # Reuse $idobj from above.
2686         foreach $idobj (@idobjs) {
2687             my ($idvalue, $idtype, $idfield);
2688             if ($_->{BibliographicItemIdentifier}) {
2689                 $idvalue = $_->{BibliographicItemIdentifier};
2690                 $idtype = $_->{BibliographicItemIdentifierCode};
2691                 $idfield = 'BibliographicItemIdentifier';
2692             } else {
2693                 $idvalue = $_->{BibliographicRecordIdentifier};
2694                 $idtype = $_->{BibliographicRecordIdentifierCode};
2695                 $idfield = 'BibliographicRecordIdentifier';
2696             }
2697             $item = $self->_bib_search($idvalue, $idtype);
2698             if (ref($item) eq 'NCIP::Problem') {
2699                 $stashed_problem = $item unless($stashed_problem);
2700                 $stashed_problem->ProblemElement($idfield);
2701                 undef($item);
2702             }
2703             last if ($item);
2704         }
2705         $item = $stashed_problem if (!$item && $stashed_problem);
2706     }
2707
2708     return $item;
2709 }
2710
2711 =head2 find_location_failover
2712
2713     $location = $ils->find_location_failover($location, $request, $message);
2714
2715 Attempts to retrieve an org_unit by shortname from the passed in
2716 $location.  If that fails, $request and $message are used to lookup
2717 the ToAgencyId/AgencyId field and that is used.  Returns an org_unit
2718 as retrieved by retrieve_org_unit_by_shortname if successful and undef
2719 on failure.
2720
2721 =cut
2722
2723 sub find_location_failover {
2724     my ($self, $location, $request, $message) = @_;
2725     if ($request && !$message) {
2726         $message = $self->parse_request_type($request);
2727     }
2728     my $org_unit;
2729     if ($location) {
2730         # Because Auto-Graphics. (This should be configured somehow.)
2731         $location =~ s/^[^-]+-//;
2732         $org_unit = $self->retrieve_org_unit_by_shortname($location);
2733     }
2734     if ($request && $message && !$org_unit) {
2735         $location = $request->{$message}->{InitiationHeader}->{ToAgencyId}->{AgencyId};
2736         if ($location) {
2737             # Because Auto-Graphics. (This should be configured somehow.)
2738             $location =~ s/^[^-]+-//;
2739             $org_unit = $self->retrieve_org_unit_by_shortname($location);
2740         }
2741     }
2742
2743     return $org_unit;
2744 }
2745
2746 # private subroutines not meant to be used directly by subclasses.
2747 # Most have to do with setup and/or state checking of implementation
2748 # components.
2749
2750 # Find, load, and parse our configuration file:
2751 sub _configure {
2752     my $self = shift;
2753
2754     # Find the configuration file via variables:
2755     my $file = OILS_NCIP_CONFIG_DEFAULT;
2756     $file = $ENV{OILS_NCIP_CONFIG} if ($ENV{OILS_NCIP_CONFIG});
2757
2758     $self->{config} = XMLin($file, NormaliseSpace => 2,
2759                             ForceArray => ['block_profile', 'stat_cat_entry']);
2760 }
2761
2762 # Bootstrap OpenSRF::System and load the IDL.
2763 sub _bootstrap {
2764     my $self = shift;
2765
2766     my $bootstrap_config = $self->{config}->{bootstrap};
2767     OpenSRF::System->bootstrap_client(config_file => $bootstrap_config);
2768
2769     my $idl = OpenSRF::Utils::SettingsClient->new->config_value("IDL");
2770     Fieldmapper->import(IDL => $idl);
2771 }
2772
2773 # Login and then initialize some object data based on the
2774 # configuration.
2775 sub _init {
2776     my $self = shift;
2777
2778     # Login to Evergreen.
2779     $self->login();
2780
2781     # Load the barred groups as pgt objects into a blocked_profiles
2782     # list.
2783     $self->{blocked_profiles} = [];
2784     foreach (@{$self->{config}->{patrons}->{block_profile}}) {
2785         my $pgt;
2786         if (ref $_) {
2787             $pgt = $U->simplereq(
2788                 'open-ils.pcrud',
2789                 'open-ils.pcrud.retrieve.pgt',
2790                 $self->{session}->{authtoken},
2791                 $_->{grp}
2792             );
2793         } else {
2794             $pgt = $U->simplereq(
2795                 'open-ils.pcrud',
2796                 'open-ils.pcrud.search.pgt',
2797                 $self->{session}->{authtoken},
2798                 {name => $_}
2799             );
2800         }
2801         push(@{$self->{blocked_profiles}}, $pgt) if ($pgt);
2802     }
2803
2804     # Load the bib source if we're not using precats.
2805     unless ($self->{config}->{items}->{use_precats}) {
2806         # Retrieve the default
2807         $self->{bib_source} = $U->simplereq(
2808             'open-ils.pcrud',
2809             'open-ils.pcrud.retrieve.cbs',
2810             $self->{session}->{authtoken},
2811             BIB_SOURCE_DEFAULT);
2812         my $data = $self->{config}->{items}->{bib_source};
2813         if ($data) {
2814             $data = $data->[0] if (ref($data) eq 'ARRAY');
2815             my $result;
2816             if (ref $data) {
2817                 $result = $U->simplereq(
2818                     'open-ils.pcrud',
2819                     'open-ils.pcrud.retrieve.cbs',
2820                     $self->{session}->{authtoken},
2821                     $data->{cbs}
2822                 );
2823             } else {
2824                 $result = $U->simplereq(
2825                     'open-ils.pcrud',
2826                     'open-ils.pcrud.search.cbs',
2827                     $self->{session}->{authtoken},
2828                     {source => $data}
2829                 );
2830             }
2831             $self->{bib_source} = $result if ($result);
2832         }
2833     }
2834
2835     # Load the required asset.stat_cat_entries:
2836     $self->{stat_cat_entries} = [];
2837     # First, make a regex for our ou and ancestors:
2838     my $ancestors = join("|", @{$U->get_org_ancestors($self->{session}->{work_ou}->id())});
2839     my $re = qr/(?:$ancestors)/;
2840     # Get the uniq stat_cat ids from the configuration:
2841     my @cats = uniq map {$_->{stat_cat}} @{$self->{config}->{items}->{stat_cat_entry}};
2842     # Retrieve all of the fleshed stat_cats and entries for the above.
2843     my $stat_cats = $U->simplereq(
2844         'open-ils.circ',
2845         'open-ils.circ.stat_cat.asset.retrieve.batch',
2846         $self->{session}->{authtoken},
2847         @cats
2848     );
2849     foreach my $entry (@{$self->{config}->{items}->{stat_cat_entry}}) {
2850         # Must have the stat_cat attr and the name, so we must have a
2851         # reference.
2852         next unless(ref $entry);
2853         my ($stat) = grep {$_->id() == $entry->{stat_cat}} @$stat_cats;
2854         push(@{$self->{stat_cat_entries}}, grep {$_->owner() =~ $re && $_->value() eq $entry->{content}} @{$stat->entries()});
2855     }
2856 }
2857
2858 # Search asset.call_number by a bre.id and location object. Return the
2859 # "closest" call_number if found, undef otherwise.
2860 sub _call_number_search {
2861     my $self = shift;
2862     my $bibid = shift;
2863     my $location = shift;
2864
2865     # At some point, this should be smarter, and we should retrieve
2866     # ancestors and descendants and search with a JSON query or some
2867     # such with results ordered by proximity to the original location,
2868     # but I don't have time to implement that right now.
2869     my $acn = $U->simplereq(
2870         'open-ils.pcrud',
2871         'open-ils.pcrud.search.acn',
2872         $self->{session}->{authtoken},
2873         {record => $bibid, owning_lib => $location->id()}
2874     );
2875
2876     return $acn;
2877 }
2878
2879 # Do a multiclass.query to search for items by isbn or issn.
2880 sub _bib_search {
2881     my $self = shift;
2882     my $idvalue = shift;
2883     my $idtype = shift;
2884     my $item;
2885
2886     my $result = $U->simplereq(
2887         'open-ils.search',
2888         'open-ils.search.biblio.multiclass',
2889         {searches => {lc($idtype) => $idvalue}}
2890     );
2891
2892     if ($result && $result->{count}) {
2893         if ($result->{count} > 1) {
2894             $item = NCIP::Problem->new(
2895                 {
2896                     ProblemType => 'Non-Unique Item',
2897                     ProblemDetail => 'More than one item matches the request.',
2898                     ProblemElement => '',
2899                     ProblemValue => $idvalue
2900                 }
2901             );
2902         }
2903         my $bibid = $result->{ids}->[0]->[0];
2904         $item = $U->simplereq(
2905             'open-ils.pcrud',
2906             'open-ils.pcrud.retrieve.bre',
2907             $self->{session}->{authtoken},
2908             $bibid
2909         );
2910     }
2911
2912     return $item;
2913 }
2914
2915 # Search for holds using the user, idvalue and selection_ou.
2916 sub _hold_search {
2917     my $self = shift;
2918     my $user = shift;
2919     my $target = shift;
2920     my $selection_ou = shift;
2921
2922     my $hold;
2923
2924     # Retrieve all of the user's active holds, and then search them in Perl.
2925     my $holds_list = $U->simplereq(
2926         'open-ils.circ',
2927         'open-ils.circ.holds.retrieve',
2928         $self->{session}->{authtoken},
2929         $user->id(),
2930         0
2931     );
2932
2933     if ($holds_list && @$holds_list) {
2934         my @holds = grep {$_->target == $target && $_->selection_ou == $selection_ou->id()} @{$holds_list};
2935         # There should only be 1, at this point, if there are any.
2936         if (@holds) {
2937             $hold = $holds[0];
2938         }
2939     }
2940
2941     return $hold;
2942 }
2943
2944 # Standalone, "helper" functions.  These do not take an object or
2945 # class reference.
2946
2947 # Check if a user is past their expiration date.
2948 sub _expired {
2949     my $user = shift;
2950     my $expired = 0;
2951
2952     # Users might not expire.  If so, they have no expire_date.
2953     if ($user->expire_date()) {
2954         my $expires = DateTime::Format::ISO8601->parse_datetime(
2955             cleanse_ISO8601($user->expire_date())
2956         )->epoch();
2957         my $now = DateTime->now()->epoch();
2958         $expired = $now > $expires;
2959     }
2960
2961     return $expired;
2962 }
2963
2964 # Creates a NCIP Problem from an event. Takes a string for the problem
2965 # type, the event hashref (or a string to use for the detail), and
2966 # optional arguments for the ProblemElement and ProblemValue fields.
2967 sub _problem_from_event {
2968     my ($type, $evt, $element, $value) = @_;
2969
2970     my $detail;
2971
2972     # Check the event.
2973     if (ref($evt)) {
2974         my ($textcode, $desc);
2975
2976         # Get the textcode, if available. Otherwise, use the ilsevent
2977         # "id," if available.
2978         if ($evt->{textcode}) {
2979             $textcode = $evt->{textcode};
2980         } elsif ($evt->{ilsevent}) {
2981             $textcode = $evt->{ilsevent};
2982         }
2983
2984         # Get the description. We favor translated descriptions over
2985         # the English in ils_events.xml.
2986         if ($evt->{desc}) {
2987             $desc = $evt->{desc};
2988         }
2989
2990         # Check if $type was set. As an "undocumented" feature, you
2991         # can pass undef, and we'll use the textcode from the event.
2992         unless ($type) {
2993             if ($textcode) {
2994                 $type = $textcode;
2995             }
2996         }
2997
2998         # Set the detail from some combination of the above.
2999         if ($desc) {
3000             $detail = $desc;
3001         } elsif ($textcode eq 'PERM_FAILURE') {
3002             if ($evt->{ilsperm}) {
3003                 $detail = "Permission denied: " . $evt->{ilsperm};
3004                 $detail =~ s/\.override$//;
3005             }
3006         } elsif ($textcode) {
3007             $detail = "ILS returned $textcode error.";
3008         } else {
3009             $detail = 'Detail not available.';
3010         }
3011
3012     } else {
3013         $detail = $evt;
3014     }
3015
3016     return NCIP::Problem->new(
3017         {
3018             ProblemType => ($type) ? $type : 'Temporary Processing Failure',
3019             ProblemDetail => ($detail) ? $detail : 'Detail not available.',
3020             ProblemElement => ($element) ? $element : 'NULL',
3021             ProblemValue => ($value) ? $value : 'NULL'
3022         }
3023     );
3024 }
3025
3026 # "Fix" dates for output so they validate against the schema
3027 sub _fix_date {
3028     my $date = shift;
3029     my $out = DateTime::Format::ISO8601->parse_datetime(cleanse_ISO8601($date));
3030     $out->set_time_zone('UTC');
3031     return $out->iso8601();
3032 }
3033
3034 1;