lib/NCIP/ILS/Evergreen.pm

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