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                 {
1011                     RequestIdentifierType => 'SYSNUMBER',
1012                     RequestIdentifierValue => $hold->id()
1013                 }
1014             ),
1015             UserId => NCIP::User::Id->new(
1016                 {
1017                     UserIdentifierType => 'Barcode Id',
1018                     UserIdentifierValue => $user->card->barcode()
1019                 }
1020             ),
1021             RequestType => $request->{$message}->{RequestType},
1022             RequestScopeType => ($hold->hold_type() eq 'V') ? "item" : "bibliographic item"
1023         };
1024         # Look for UserElements requested and add it to the response:
1025         my $elements = $request->{$message}->{UserElementType};
1026         if ($elements) {
1027             $elements = [$elements] unless (ref $elements eq 'ARRAY');
1028             my $optionalfields = $self->handle_user_elements($user, $elements);
1029             $data->{UserOptionalFields} = $optionalfields;
1030         }
1031         $elements = $request->{$message}->{ItemElementType};
1032         if ($elements && $copy_details) {
1033             $elements = [$elements] unless (ref($elements) eq 'ARRAY');
1034             my $optionalfields = $self->handle_item_elements($copy_details->{copy}, $elements);
1035             $data->{ItemOptionalFields} = $optionalfields;
1036         }
1037
1038         $response->data($data);
1039     }
1040
1041     return $response;
1042 }
1043
1044 =head2 cancelrequestitem
1045
1046     $response = $ils->cancelrequestitem($request);
1047
1048 Handle the NCIP CancelRequestItem message.
1049
1050 =cut
1051
1052 sub cancelrequestitem {
1053     my $self = shift;
1054     my $request = shift;
1055     # Check our session and login if necessary:
1056     $self->login() unless ($self->checkauth());
1057
1058     # Common stuff:
1059     my $message = $self->parse_request_type($request);
1060     my $response = NCIP::Response->new({type => $message . 'Response'});
1061     $response->header($self->make_header($request));
1062
1063     # UserId is required by the standard, but we might not really need it.
1064     my ($user_barcode, $user_idfield) = $self->find_user_barcode($request);
1065     if (ref($user_barcode) eq 'NCIP::Problem') {
1066         $response->problem($user_barcode);
1067         return $response;
1068     }
1069     my $user = $self->retrieve_user_by_barcode($user_barcode, $user_idfield);
1070     if (ref($user) eq 'NCIP::Problem') {
1071         $response->problem($user);
1072         return $response;
1073     }
1074
1075     # See if we got a ItemId and a barcode:
1076     my $copy_details;
1077     my ($item_barcode, $item_idfield) = $self->find_item_barcode($request);
1078     if (ref($item_barcode) ne 'NCIP::Problem') {
1079         # Retrieve the copy details.
1080         $copy_details = $self->retrieve_copy_details_by_barcode($item_barcode);
1081         unless ($copy_details) {
1082             # Return an Unknown Item problem unless we find the copy.
1083             $response->problem(
1084                 NCIP::Problem->new(
1085                     {
1086                         ProblemType => 'Unknown Item',
1087                         ProblemDetail => "Item with barcode $item_barcode is not known.",
1088                         ProblemElement => $item_idfield,
1089                         ProblemValue => $item_barcode
1090                     }
1091                 )
1092             );
1093             return $response;
1094         }
1095     }
1096
1097     # See if we got a RequestId:
1098     my $requestid;
1099     if ($request->{$message}->{RequestId}) {
1100         $requestid = NCIP::RequestId->new(
1101             {
1102                 AgencyId => $request->{$message}->{RequestId}->{AgencyId},
1103                 RequestIdentifierType => $request->{$message}->{RequestId}->{RequestIdentifierType},
1104                 RequestIdentifierValue => $request->{$message}->{RequestId}->{RequestIdentifierValue}
1105             }
1106         )
1107     }
1108
1109     # Just a note: In the below, we cannot rely on the hold or transit
1110     # fields of the copy_details, even if we have retrieved it. This
1111     # is because that hold and transit may not be the ones that we're
1112     # looking for, i.e. they could be for another patron, etc.
1113
1114     # See if we can find the hold:
1115     my $hold;
1116     if ($requestid) {
1117         $hold = $U->simplereq(
1118             'open-ils.pcrud',
1119             'open-ils.pcrud.retrieve.ahr',
1120             $self->{session}->{authtoken},
1121             $requestid->{RequestIdentifierValue},
1122             {flesh => 1, flesh_fields => {ahr => ['transit']}}
1123         );
1124         unless ($hold) {
1125             # Report a problem that we couldn't find a hold by that id.
1126             $response->problem(
1127                 NCIP::Problem->new(
1128                     {
1129                         ProblemType => 'Unknown Request',
1130                         ProblemDetail => 'No request with this identifier found',
1131                         ProblemElement => 'RequestIdentifierValue',
1132                         ProblemValue => $requestid->{RequestIdentifierValue}
1133                     }
1134                 )
1135             )
1136         } elsif ($hold->cancel_time()) {
1137             $response->problem(
1138                 NCIP::Problem->new(
1139                     {
1140                         ProblemType => 'Request Already Canceled',
1141                         ProblemDetail => 'Request has already been canceled',
1142                         ProblemElement => 'RequestIdentifierValue',
1143                         ProblemValue => $requestid->{RequestIdentifierValue}
1144                     }
1145                 )
1146             )
1147         } elsif ($hold->transit()) {
1148             $response->problem(
1149                 NCIP::Problem->new(
1150                     {
1151                         ProblemType => 'Request Already Processed',
1152                         ProblemDetail => 'Request has already been processed',
1153                         ProblemElement => 'RequestIdentifierValue',
1154                         ProblemValue => $requestid->{RequestIdentifierValue}
1155                     }
1156                 )
1157             )
1158         } elsif ($hold->usr() == $user->id()) {
1159             # Check the target matches the copy information, if any,
1160             # that we were given.
1161             my $obj_id;
1162             if ($copy_details) {
1163                 if ($hold->hold_type() eq 'V') {
1164                     $obj_id = $copy_details->{volume}->id();
1165                 } elsif ($hold->hold_type() eq 'T') {
1166                     $obj_id = $copy_details->{mvr}->doc_id();
1167                 } elsif ($hold->hold_type() eq 'C' || $hold->hold_type() eq 'F') {
1168                     $obj_id = $copy_details->{copy}->id();
1169                 }
1170             }
1171             if ($obj_id && $hold->target() != $obj_id) {
1172                 $response->problem(
1173                     NCIP::Problem->new(
1174                         {
1175                             ProblemType => 'Request Not For This Item',
1176                             ProblemDetail => "Request is not for this item",
1177                             ProblemElement => $item_idfield,
1178                             ProblemElement => $item_barcode
1179                         }
1180                     )
1181                 )
1182             } else {
1183                 $self->cancel_hold($hold);
1184                 my $data = {
1185                     RequestId => $requestid,
1186                     UserId => NCIP::User::Id->new(
1187                         {
1188                             UserIdentifierType => 'Barcode Id',
1189                             UserIdentifierValue => $user->card->barcode()
1190                         }
1191                     )
1192                 };
1193                 # Look for UserElements requested and add it to the response:
1194                 my $elements = $request->{$message}->{UserElementType};
1195                 if ($elements) {
1196                     $elements = [$elements] unless (ref $elements eq 'ARRAY');
1197                     my $optionalfields = $self->handle_user_elements($user, $elements);
1198                     $data->{UserOptionalFields} = $optionalfields;
1199                 }
1200                 $elements = $request->{$message}->{ItemElementType};
1201                 if ($elements && $copy_details) {
1202                     $elements = [$elements] unless (ref $elements eq 'ARRAY');
1203                     my $optionalfields = $self->handle_item_elements($copy_details->{copy}, $elements);
1204                     $data->{ItemOptionalFields} = $optionalfields;
1205                 }
1206                 $response->data($data);
1207             }
1208         } else {
1209             # Report a problem that the hold is not for this user.
1210             $response->problem(
1211                 NCIP::Problem->new(
1212                     {
1213                         ProblemType => 'Request Not For This User',
1214                         ProblemDetail => 'Request is not for this user.',
1215                         ProblemElement => $user_idfield,
1216                         ProblemValue => $user_barcode
1217                     }
1218                 )
1219             )
1220         }
1221     } else {
1222         # At this point, we *must have* an ItemId and therefore
1223         # $copy_details, so return the problem from looking up the
1224         # barcode if we don't have $copy_details.
1225         if (!$copy_details) {
1226             $response->problem($item_barcode);
1227         } else {
1228             # We have to search for the hold based on the copy details and
1229             # the user.  We'll need to search for copy (or force) holds, a
1230             # volume hold, or a title hold.
1231             $hold = $self->_hold_search($user, $copy_details);
1232             if ($hold && $hold->transit()) {
1233                 $response->problem(
1234                     NCIP::Problem->new(
1235                         {
1236                             ProblemType => 'Request Already Processed',
1237                             ProblemDetail => 'Request has already been processed',
1238                             ProblemElement => 'RequestIdentifierValue',
1239                             ProblemValue => $requestid->{RequestIdentifierValue}
1240                         }
1241                     )
1242                 )
1243             } elsif ($hold) {
1244                 $self->cancel_hold($hold);
1245                 my $data = {
1246                     RequestId => NCIP::RequestId->new(
1247                         {
1248                             RequestIdentifierType => 'SYSNUMBER',
1249                             RequestIdentifierValue => $hold->id()
1250                         }
1251                     ),
1252                     UserId => NCIP::User::Id->new(
1253                         {
1254                             UserIdentifierType => 'Barcode Id',
1255                             UserIdentifierValue => $user->card->barcode()
1256                         }
1257                     )
1258                 };
1259                 # Look for UserElements requested and add it to the response:
1260                 my $elements = $request->{$message}->{UserElementType};
1261                 if ($elements) {
1262                     $elements = [$elements] unless (ref $elements eq 'ARRAY');
1263                     my $optionalfields = $self->handle_user_elements($user, $elements);
1264                     $data->{UserOptionalFields} = $optionalfields;
1265                 }
1266                 $elements = $request->{$message}->{ItemElementType};
1267                 if ($elements && $copy_details) {
1268                     $elements = [$elements] unless (ref $elements eq 'ARRAY');
1269                     my $optionalfields = $self->handle_item_elements($copy_details->{copy}, $elements);
1270                     $data->{ItemOptionalFields} = $optionalfields;
1271                 }
1272                 $response->data($data);
1273             } else {
1274                 $response->problem(
1275                     NCIP::Problem->new(
1276                         {
1277                             ProblemType => 'Unknown Request',
1278                             ProblemDetail => 'No request found for the item and user',
1279                             ProblemElement => 'NULL',
1280                             ProblemValue => 'NULL'
1281                         }
1282                     )
1283                 )
1284             }
1285         }
1286     }
1287
1288     return $response;
1289 }
1290
1291 =head1 METHODS USEFUL to SUBCLASSES
1292
1293 =head2 handle_user_elements
1294     $useroptionalfield = $ils->handle_user_elements($user, $elements);
1295
1296 Returns NCIP::User::OptionalFields for the given user and arrayref of
1297 UserElement.
1298
1299 =cut
1300
1301 sub handle_user_elements {
1302     my $self = shift;
1303     my $user = shift;
1304     my $elements = shift;
1305     my $optionalfields = NCIP::User::OptionalFields->new();
1306
1307     # First, we'll look for name information.
1308     if (grep {$_ eq 'Name Information'} @$elements) {
1309         my $name = NCIP::StructuredPersonalUserName->new();
1310         $name->Surname($user->family_name());
1311         $name->GivenName($user->first_given_name());
1312         $name->Prefix($user->prefix());
1313         $name->Suffix($user->suffix());
1314         $optionalfields->NameInformation($name);
1315     }
1316
1317     # Next, check for user address information.
1318     if (grep {$_ eq 'User Address Information'} @$elements) {
1319         my $addresses = [];
1320
1321         # See if the user has any valid, physcial addresses.
1322         foreach my $addr (@{$user->addresses()}) {
1323             next if ($U->is_true($addr->pending()));
1324             my $address = NCIP::User::AddressInformation->new({UserAddressRoleType=>$addr->address_type()});
1325             my $physical = NCIP::StructuredAddress->new();
1326             $physical->Line1($addr->street1());
1327             $physical->Line2($addr->street2());
1328             $physical->Locality($addr->city());
1329             $physical->Region($addr->state());
1330             $physical->PostalCode($addr->post_code());
1331             $physical->Country($addr->country());
1332             $address->PhysicalAddress($physical);
1333             push @$addresses, $address;
1334         }
1335
1336         # Right now, we're only sharing email address if the user
1337         # has it. We don't share phone numbers.
1338         if ($user->email()) {
1339             my $address = NCIP::User::AddressInformation->new({UserAddressRoleType=>'Email Address'});
1340             $address->ElectronicAddress(
1341                 NCIP::ElectronicAddress->new({
1342                     Type=>'Email Address',
1343                     Data=>$user->email()
1344                 })
1345                 );
1346             push @$addresses, $address;
1347         }
1348
1349         $optionalfields->UserAddressInformation($addresses);
1350     }
1351
1352     # Check for User Privilege.
1353     if (grep {$_ eq 'User Privilege'} @$elements) {
1354         # Get the user's group:
1355         my $pgt = $U->simplereq(
1356             'open-ils.pcrud',
1357             'open-ils.pcrud.retrieve.pgt',
1358             $self->{session}->{authtoken},
1359             $user->profile()
1360         );
1361         if ($pgt) {
1362             my $privilege = NCIP::User::Privilege->new();
1363             $privilege->AgencyId($user->home_ou->shortname());
1364             $privilege->AgencyUserPrivilegeType($pgt->name());
1365             $privilege->ValidToDate($user->expire_date());
1366             $privilege->ValidFromDate($user->create_date());
1367
1368             my $status = 'Active';
1369             if (_expired($user)) {
1370                 $status = 'Expired';
1371             } elsif ($U->is_true($user->barred())) {
1372                 $status = 'Barred';
1373             } elsif (!$U->is_true($user->active())) {
1374                 $status = 'Inactive';
1375             }
1376             if ($status) {
1377                 $privilege->UserPrivilegeStatus(
1378                     NCIP::User::PrivilegeStatus->new({
1379                         UserPrivilegeStatusType => $status
1380                     })
1381                 );
1382             }
1383
1384             $optionalfields->UserPrivilege([$privilege]);
1385         }
1386     }
1387
1388     # Check for Block Or Trap.
1389     if (grep {$_ eq 'Block Or Trap'} @$elements) {
1390         my $blocks = [];
1391
1392         # First, let's check if the profile is blocked from ILL.
1393         if (grep {$_->id() == $user->profile()} @{$self->{blocked_profiles}}) {
1394             my $block = NCIP::User::BlockOrTrap->new();
1395             $block->AgencyId($user->home_ou->shortname());
1396             $block->BlockOrTrapType('Block Interlibrary Loan');
1397             push @$blocks, $block;
1398         }
1399
1400         # Next, we loop through the user's standing penalties
1401         # looking for blocks on CIRC, HOLD, and RENEW.
1402         my ($have_circ, $have_renew, $have_hold) = (0,0,0);
1403         foreach my $penalty (@{$user->standing_penalties()}) {
1404             next unless($penalty->standing_penalty->block_list());
1405             my @block_list = split(/\|/, $penalty->standing_penalty->block_list());
1406             my $ou = $U->simplereq(
1407                 'open-ils.pcrud',
1408                 'open-ils.pcrud.retrieve.aou',
1409                 $self->{session}->{authtoken},
1410                 $penalty->org_unit()
1411             );
1412
1413             # Block checkout.
1414             if (!$have_circ && grep {$_ eq 'CIRC'} @block_list) {
1415                 my $bot = NCIP::User::BlockOrTrap->new();
1416                 $bot->AgencyId($ou->shortname());
1417                 $bot->BlockOrTrapType('Block Checkout');
1418                 push @$blocks, $bot;
1419                 $have_circ = 1;
1420             }
1421
1422             # Block holds.
1423             if (!$have_hold && grep {$_ eq 'HOLD' || $_ eq 'FULFILL'} @block_list) {
1424                 my $bot = NCIP::User::BlockOrTrap->new();
1425                 $bot->AgencyId($ou->shortname());
1426                 $bot->BlockOrTrapType('Block Holds');
1427                 push @$blocks, $bot;
1428                 $have_hold = 1;
1429             }
1430
1431             # Block renewals.
1432             if (!$have_renew && grep {$_ eq 'RENEW'} @block_list) {
1433                 my $bot = NCIP::User::BlockOrTrap->new();
1434                 $bot->AgencyId($ou->shortname());
1435                 $bot->BlockOrTrapType('Block Renewals');
1436                 push @$blocks, $bot;
1437                 $have_renew = 1;
1438             }
1439
1440             # Stop after we report one of each, even if more
1441             # blocks remain.
1442             last if ($have_circ && $have_renew && $have_hold);
1443         }
1444
1445         $optionalfields->BlockOrTrap($blocks);
1446     }
1447
1448     return $optionalfields;
1449 }
1450
1451 =head2 handle_item_elements
1452
1453 =cut
1454
1455 sub handle_item_elements {
1456     my $self = shift;
1457     my $copy = shift;
1458     my $elements = shift;
1459     my $optionalfields = NCIP::Item::OptionalFields->new();
1460
1461     my $details; # In case we need for more than one.
1462
1463     if (grep {$_ eq 'Bibliographic Description'} @$elements) {
1464         my $description;
1465         # Check for a precat copy, 'cause it is simple.
1466         if ($copy->dummy_title()) {
1467             $description = NCIP::Item::BibliographicDescription->new();
1468             $description->Title($copy->dummy_title());
1469             $description->Author($copy->dummy_author());
1470             if ($copy->dummy_isbn()) {
1471                 $description->BibliographicItemId(
1472                     NCIP::Item::BibliographicItemId->new(
1473                         {
1474                             BibliographicItemIdentifier => $copy->dummy_isbn(),
1475                             BibliographicItemIdentifierCode => 'ISBN'
1476                         }
1477                     )
1478                 );
1479             }
1480         } else {
1481             $details = $self->retrieve_copy_details_by_barcode($copy->barcode()) unless($details);
1482             $description = NCIP::Item::BibliographicDescription->new();
1483             $description->Title($details->{mvr}->title());
1484             $description->Authort($details->{mvr}->author());
1485             $description->BibliographicRecordId(
1486                 NCIP::Item::BibliographicRecordId->new(
1487                     {
1488                         BibliographicRecordIdentifier => $details->{mvr}->doc_id(),
1489                         BibliographicRecordIdentifierCode => 'SYSNUMBER'
1490                     }
1491                 )
1492             );
1493             if ($details->{mvr}->publisher()) {
1494                 $description->Publisher($details->{mvr}->publisher());
1495             }
1496             if ($details->{mvr}->pubdate()) {
1497                 $description->PublicationDate($details->{mvr}->pubdate());
1498             }
1499             if ($details->{mvr}->edition()) {
1500                 $description->Edition($details->{mvr}->edition());
1501             }
1502         }
1503         $optionalfields->BibliographicDescription($description) if ($description);
1504     }
1505
1506     if (grep {$_ eq 'Item Description'} @$elements) {
1507         $details = $self->retrieve_copy_details_by_barcode($copy->barcode()) unless($details);
1508         # Call Number is the only field we currently return. We also
1509         # do not attempt to retun a prefix and suffix. Someone else
1510         # can deal with that if they want it.
1511         if ($details->{volume}) {
1512             $optionalfields->ItemDescription(
1513                 NCIP::Item::Description->new(
1514                     {CallNumber => $details->{volume}->label()}
1515                 )
1516             );
1517         }
1518     }
1519
1520     if (grep {$_ eq 'Circulation Status'} @$elements) {
1521         my $status = $copy->status();
1522         $status = $self->retrieve_copy_status($status) unless (ref($status));
1523         $optionalfields->CirculationStatus($status->name()) if ($status);
1524     }
1525
1526     if (grep {$_ eq 'Date Due'} @$elements) {
1527         $details = $self->retrieve_copy_details_by_barcode($copy->barcode()) unless($details);
1528         if ($details->{circ}) {
1529             if (!$details->{circ}->checkin_time()) {
1530                 my $due = DateTime::Format::ISO8601->parse_datetime(cleanse_ISO8601($details->{circ}->due_date()));
1531                 $due->set_time_zone('UTC');
1532                 $optionalfields->DateDue($due->iso8601());
1533             }
1534         }
1535     }
1536
1537     if (grep {$_ eq 'Item Use Restriction Type'} @$elements) {
1538         $optionalfields->ItemUseRestrictionType('None');
1539     }
1540
1541     if (grep {$_ eq 'Physical Condition'} @$elements) {
1542         $optionalfields->PhysicalCondition(
1543             NCIP::Item::PhysicalCondition->new(
1544                 {PhysicalConditionType => 'Unknown'}
1545             )
1546         );
1547     }
1548
1549     return $optionalfields;
1550 }
1551
1552 =head2 login
1553
1554     $ils->login();
1555
1556 Login to Evergreen via OpenSRF. It uses internal state from the
1557 configuration file to login.
1558
1559 =cut
1560
1561 # Login via OpenSRF to Evergreen.
1562 sub login {
1563     my $self = shift;
1564
1565     # Get the authentication seed.
1566     my $seed = $U->simplereq(
1567         'open-ils.auth',
1568         'open-ils.auth.authenticate.init',
1569         $self->{config}->{credentials}->{username}
1570     );
1571
1572     # Actually login.
1573     if ($seed) {
1574         my $response = $U->simplereq(
1575             'open-ils.auth',
1576             'open-ils.auth.authenticate.complete',
1577             {
1578                 username => $self->{config}->{credentials}->{username},
1579                 password => md5_hex(
1580                     $seed . md5_hex($self->{config}->{credentials}->{password})
1581                 ),
1582                 type => 'staff',
1583                 workstation => $self->{config}->{credentials}->{workstation}
1584             }
1585         );
1586         if ($response) {
1587             $self->{session}->{authtoken} = $response->{payload}->{authtoken};
1588             $self->{session}->{authtime} = $response->{payload}->{authtime};
1589
1590             # Set/reset the work_ou and user data in case something changed.
1591
1592             # Retrieve the work_ou as an object.
1593             $self->{session}->{work_ou} = $U->simplereq(
1594                 'open-ils.pcrud',
1595                 'open-ils.pcrud.search.aou',
1596                 $self->{session}->{authtoken},
1597                 {shortname => $self->{config}->{credentials}->{work_ou}}
1598             );
1599
1600             # We need the user information in order to do some things.
1601             $self->{session}->{user} = $U->check_user_session($self->{session}->{authtoken});
1602
1603         }
1604     }
1605 }
1606
1607 =head2 checkauth
1608
1609     $valid = $ils->checkauth();
1610
1611 Returns 1 if the object a 'valid' authtoken, 0 if not.
1612
1613 =cut
1614
1615 sub checkauth {
1616     my $self = shift;
1617
1618     # We use AppUtils to do the heavy lifting.
1619     if (defined($self->{session})) {
1620         if ($U->check_user_session($self->{session}->{authtoken})) {
1621             return 1;
1622         } else {
1623             return 0;
1624         }
1625     }
1626
1627     # If we reach here, we don't have a session, so we are definitely
1628     # not logged in.
1629     return 0;
1630 }
1631
1632 =head2 retrieve_user_by_barcode
1633
1634     $user = $ils->retrieve_user_by_barcode($user_barcode, $user_idfield);
1635
1636 Do a fleshed retrieve of a patron by barcode. Return the patron if
1637 found and valid. Return a NCIP::Problem of 'Unknown User' otherwise.
1638
1639 The id field argument is used for the ProblemElement field in the
1640 NCIP::Problem object.
1641
1642 An invalid patron is one where the barcode is not found in the
1643 database, the patron is deleted, or the barcode used to retrieve the
1644 patron is not active. The problem element is also returned if an error
1645 occurs during the retrieval.
1646
1647 =cut
1648
1649 sub retrieve_user_by_barcode {
1650     my ($self, $barcode, $idfield) = @_;
1651     my $result = $U->simplereq(
1652         'open-ils.actor',
1653         'open-ils.actor.user.fleshed.retrieve_by_barcode',
1654         $self->{session}->{authtoken},
1655         $barcode,
1656         1
1657     );
1658
1659     # Check for a failure, or a deleted, inactive, or expired user,
1660     # and if so, return empty userdata.
1661     if (!$result || $U->event_code($result) || $U->is_true($result->deleted())
1662             || !grep {$_->barcode() eq $barcode && $U->is_true($_->active())} @{$result->cards()}) {
1663
1664         my $problem = NCIP::Problem->new();
1665         $problem->ProblemType('Unknown User');
1666         $problem->ProblemDetail("User with barcode $barcode unknown");
1667         $problem->ProblemElement($idfield);
1668         $problem->ProblemValue($barcode);
1669         $result = $problem;
1670     }
1671
1672     return $result;
1673 }
1674
1675 =head2 retrieve_user_by_id
1676
1677     $user = $ils->retrieve_user_by_id($id);
1678
1679 Similar to C<retrieve_user_by_barcode> but takes the user's database
1680 id rather than barcode. This is useful when you have a circulation or
1681 hold and need to get information about the user's involved in the hold
1682 or circulaiton.
1683
1684 It returns a fleshed user on success or undef on failure.
1685
1686 =cut
1687
1688 sub retrieve_user_by_id {
1689     my ($self, $id) = @_;
1690
1691     # Do a fleshed retrieve of the patron, and flesh the fields that
1692     # we would normally use.
1693     my $result = $U->simplereq(
1694         'open-ils.actor',
1695         'open-ils.actor.user.fleshed.retrieve',
1696         $self->{session}->{authtoken},
1697         $id,
1698         [ 'card', 'cards', 'standing_penalties', 'addresses', 'home_ou' ]
1699     );
1700     # Check for an error.
1701     undef($result) if ($result && $U->event_code($result));
1702
1703     return $result;
1704 }
1705
1706 =head2 check_user_for_problems
1707
1708     $problem = $ils>check_user_for_problems($user, 'HOLD, 'CIRC', 'RENEW');
1709
1710 This function checks if a user has a blocked profile or any from a
1711 list of provided blocks. If it does, then a NCIP::Problem object is
1712 returned, otherwise an undefined value is returned.
1713
1714 The list of blocks appears as additional arguments after the user. You
1715 can provide any value(s) that might appear in a standing penalty block
1716 lit in Evergreen. The example above checks for HOLD, CIRC, and
1717 RENEW. Any number of such values can be provided. If none are
1718 provided, the function only checks if the patron's profiles appears in
1719 the object's blocked profiles list.
1720
1721 It stops on the first matching block, if any.
1722
1723 =cut
1724
1725 sub check_user_for_problems {
1726     my $self = shift;
1727     my $user = shift;
1728     my @blocks = @_;
1729
1730     # Fill this in if we have a problem, otherwise just return it.
1731     my $problem;
1732
1733     # First, check the user's profile.
1734     if (grep {$_->id() == $user->profile()} @{$self->{blocked_profiles}}) {
1735         $problem = NCIP::Problem->new(
1736             {
1737                 ProblemType => 'User Blocked',
1738                 ProblemDetail => 'User blocked from inter-library loan',
1739                 ProblemElement => 'NULL',
1740                 ProblemValue => 'NULL'
1741             }
1742         );
1743     }
1744
1745     # Next, check if the patron has one of the indicated blocks.
1746     unless ($problem) {
1747         foreach my $penalty (@{$user->standing_penalties()}) {
1748             if ($penalty->standing_penalty->block_list()) {
1749                 my @pblocks = split(/\|/, $penalty->standing_penalty->block_list());
1750                 foreach my $block (@blocks) {
1751                     if (grep {$_ =~ /$block/} @pblocks) {
1752                         $problem = NCIP::Problem->new(
1753                             {
1754                                 ProblemType => 'User Blocked',
1755                                 ProblemDetail => 'User blocked from ' .
1756                                     ($block eq 'HOLD') ? 'holds' : (($block eq 'RENEW') ? 'renewals' :
1757                                                                         (($block eq 'CIRC') ? 'checkout' : lc($block))),
1758                                 ProblemElement => 'NULL',
1759                                 ProblemValue => 'NULL'
1760                             }
1761                         );
1762                         last;
1763                     }
1764                 }
1765                 last if ($problem);
1766             }
1767         }
1768     }
1769
1770     return $problem;
1771 }
1772
1773 =head2 check_circ_details
1774
1775     $problem = $ils->check_circ_details($circ, $copy, $user);
1776
1777 Checks if we can checkin or renew a circulation. That is, the
1778 circulation is still open (i.e. the copy is still checked out), if we
1779 either own the copy or are the circulation location, and if the
1780 circulation is for the optional $user argument. $circ and $copy are
1781 required. $user is optional.
1782
1783 Returns a problem if any of the above conditions fail. Returns undef
1784 if they pass and we can proceed with the checkin or renewal.
1785
1786 If the failure occurred on the copy-related checks, then the
1787 ProblemElement field will be undefined and needs to be filled in with
1788 the item id field name. If the check for the copy being checked out to
1789 the provided user fails, then both ProblemElement and ProblemValue
1790 fields will be empty and need to be filled in by the caller.
1791
1792 =cut
1793
1794 sub check_circ_details {
1795     my ($self, $circ, $copy, $user) = @_;
1796
1797     # Shortcut for the next check.
1798     my $ou_id = $self->{session}->{work_ou}->id();
1799
1800     if (!$circ || $circ->checkin_time() || ($circ->circ_lib() != $ou_id && $copy->circ_lib() != $ou_id)) {
1801         # Item isn't checked out.
1802         return NCIP::Problem->new(
1803             {
1804                 ProblemType => 'Item Not Checked Out',
1805                 ProblemDetail => 'Item with barcode ' . $copy->barcode() . ' is not checked out.',
1806                 ProblemValue => $copy->barcode()
1807             }
1808         );
1809     } else {
1810         # Get data on the patron who has it checked out.
1811         my $circ_user = $self->retrieve_user_by_id($circ->usr());
1812         if ($user && $circ_user && $user->id() != $circ_user->id()) {
1813             # The ProblemElement and ProblemValue field need to be
1814             # filled in by the caller.
1815             return NCIP::Problem->new(
1816                 {
1817                     ProblemType => 'Item Not Checked Out To This User',
1818                     ProblemDetail => 'Item with barcode ' . $copy->barcode() . ' is not checked out to this user.',
1819                 }
1820             );
1821         }
1822     }
1823     # If we get here, we're good to go.
1824     return undef;
1825 }
1826
1827 =head2 retrieve_copy_details_by_barcode
1828
1829     $copy = $ils->retrieve_copy_details_by_barcode($copy_barcode);
1830
1831 Look up and retrieve some copy details by the copy barcode. This
1832 method returns either a hashref with the copy details or undefined if
1833 no copy exists with that barcode or if some error occurs.
1834
1835 The hashref has the fields copy, hold, transit, circ, volume, and mvr.
1836
1837 This method differs from C<retrieve_user_by_barcode> in that a copy
1838 cannot be invalid if it exists and it is not always an error if no
1839 copy exists. In some cases, when handling AcceptItem, we might prefer
1840 there to be no copy.
1841
1842 =cut
1843
1844 sub retrieve_copy_details_by_barcode {
1845     my $self = shift;
1846     my $barcode = shift;
1847
1848     my $copy = $U->simplereq(
1849         'open-ils.circ',
1850         'open-ils.circ.copy_details.retrieve.barcode',
1851         $self->{session}->{authtoken},
1852         $barcode
1853     );
1854
1855     # If $copy is an event, return undefined.
1856     if ($copy && $U->event_code($copy)) {
1857         undef($copy);
1858     }
1859
1860     return $copy;
1861 }
1862
1863 =head2 retrieve_copy_status
1864
1865     $status = $ils->retrieve_copy_status($id);
1866
1867 Retrive a copy status object by database ID.
1868
1869 =cut
1870
1871 sub retrieve_copy_status {
1872     my $self = shift;
1873     my $id = shift;
1874
1875     my $status = $U->simplereq(
1876         'open-ils.pcrud',
1877         'open-ils.pcrud.retrieve.ccs',
1878         $self->{session}->{authtoken},
1879         $id
1880     );
1881
1882     return $status;
1883 }
1884
1885 =head2 retrieve_org_unit_by_shortname
1886
1887     $org_unit = $ils->retrieve_org_unit_by_shortname($shortname);
1888
1889 Retrieves an org. unit from the database by shortname. Returns the
1890 org. unit as a Fieldmapper object or undefined.
1891
1892 =cut
1893
1894 sub retrieve_org_unit_by_shortname {
1895     my $self = shift;
1896     my $shortname = shift;
1897
1898     my $aou = $U->simplereq(
1899         'open-ils.actor',
1900         'open-ils.actor.org_unit.retrieve_by_shortname',
1901         $shortname
1902     );
1903
1904     return $aou;
1905 }
1906
1907 =head2 retrieve_copy_location
1908
1909     $location = $ils->retrieve_copy_location($location_id);
1910
1911 Retrieve a copy location based on id.
1912
1913 =cut
1914
1915 sub retrieve_copy_location {
1916     my $self = shift;
1917     my $id = shift;
1918
1919     my $location = $U->simplereq(
1920         'open-ils.pcrud',
1921         'open-ils.pcrud.retrieve.acpl',
1922         $self->{session}->{authtoken},
1923         $id
1924     );
1925
1926     return $location;
1927 }
1928
1929 =head2 retrieve_biblio_record_entry
1930
1931     $bre = $ils->retrieve_biblio_record_entry($bre_id);
1932
1933 Given a biblio.record_entry.id, this method retrieves a bre object.
1934
1935 =cut
1936
1937 sub retrieve_biblio_record_entry {
1938     my $self = shift;
1939     my $id = shift;
1940
1941     my $bre = $U->simplereq(
1942         'open-ils.pcrud',
1943         'open-ils.pcrud.retrieve.bre',
1944         $self->{session}->{authtoken},
1945         $id
1946     );
1947
1948     return $bre;
1949 }
1950
1951 =head2 create_precat_copy
1952
1953     $item_info->{
1954         barcode => '312340123456789',
1955         author => 'Public, John Q.',
1956         title => 'Magnum Opus',
1957         call_number => '005.82',
1958         publisher => 'Brick House',
1959         publication_date => '2014'
1960     };
1961
1962     $item = $ils->create_precat_copy($item_info);
1963
1964
1965 Create a "precat" copy to use for the incoming item using a hashref of
1966 item information. At a minimum, the barcode, author and title fields
1967 need to be filled in. The other fields are ignored if provided.
1968
1969 This method is called by the AcceptItem handler if the C<use_precats>
1970 configuration option is turned on.
1971
1972 =cut
1973
1974 sub create_precat_copy {
1975     my $self = shift;
1976     my $item_info = shift;
1977
1978     my $item = Fieldmapper::asset::copy->new();
1979     $item->barcode($item_info->{barcode});
1980     $item->call_number(OILS_PRECAT_CALL_NUMBER);
1981     $item->dummy_title($item_info->{title});
1982     $item->dummy_author($item_info->{author});
1983     $item->circ_lib($self->{session}->{work_ou}->id());
1984     $item->circulate('t');
1985     $item->holdable('t');
1986     $item->opac_visible('f');
1987     $item->deleted('f');
1988     $item->fine_level(OILS_PRECAT_COPY_FINE_LEVEL);
1989     $item->loan_duration(OILS_PRECAT_COPY_LOAN_DURATION);
1990     $item->location(1);
1991     $item->status(0);
1992     $item->editor($self->{session}->{user}->id());
1993     $item->creator($self->{session}->{user}->id());
1994     $item->isnew(1);
1995
1996     # Actually create it:
1997     my $xact;
1998     my $ses = OpenSRF::AppSession->create('open-ils.pcrud');
1999     $ses->connect();
2000     eval {
2001         $xact = $ses->request(
2002             'open-ils.pcrud.transaction.begin',
2003             $self->{session}->{authtoken}
2004         )->gather(1);
2005         $item = $ses->request(
2006             'open-ils.pcrud.create.acp',
2007             $self->{session}->{authtoken},
2008             $item
2009         )->gather(1);
2010         $xact = $ses->request(
2011             'open-ils.pcrud.transaction.commit',
2012             $self->{session}->{authtoken}
2013         )->gather(1);
2014     };
2015     if ($@) {
2016         undef($item);
2017         if ($xact) {
2018             eval {
2019                 $ses->request(
2020                     'open-ils.pcrud.transaction.rollback',
2021                     $self->{session}->{authtoken}
2022                 )->gather(1);
2023             };
2024         }
2025     }
2026     $ses->disconnect();
2027
2028     return $item;
2029 }
2030
2031 =head2 create_fuller_copy
2032
2033     $item_info->{
2034         barcode => '31234003456789',
2035         author => 'Public, John Q.',
2036         title => 'Magnum Opus',
2037         call_number => '005.82',
2038         publisher => 'Brick House',
2039         publication_date => '2014'
2040     };
2041
2042     $item = $ils->create_fuller_copy($item_info);
2043
2044 Creates a skeletal bibliographic record, call number, and copy for the
2045 incoming item using a hashref with item information in it. At a
2046 minimum, the barcode, author, title, and call_number fields must be
2047 filled in.
2048
2049 This method is used by the AcceptItem handler if the C<use_precats>
2050 configuration option is NOT set.
2051
2052 =cut
2053
2054 sub create_fuller_copy {
2055     my $self = shift;
2056     my $item_info = shift;
2057
2058     my $item;
2059
2060     # We do everything in one transaction, because it should be atomic.
2061     my $ses = OpenSRF::AppSession->create('open-ils.pcrud');
2062     $ses->connect();
2063     my $xact;
2064     eval {
2065         $xact = $ses->request(
2066             'open-ils.pcrud.transaction.begin',
2067             $self->{session}->{authtoken}
2068         )->gather(1);
2069     };
2070     if ($@) {
2071         undef($xact);
2072     }
2073
2074     # The rest depends on there being a transaction.
2075     if ($xact) {
2076
2077         # Create the MARC record.
2078         my $record = MARC::Record->new();
2079         $record->encoding('UTF-8');
2080         $record->leader('00881nam a2200193   4500');
2081         my $datespec = strftime("%Y%m%d%H%M%S.0", localtime);
2082         my @fields = ();
2083         push(@fields, MARC::Field->new('005', $datespec));
2084         push(@fields, MARC::Field->new('082', '0', '4', 'a' => $item_info->{call_number}));
2085         push(@fields, MARC::Field->new('245', '0', '0', 'a' => $item_info->{title}));
2086         # Publisher is a little trickier:
2087         if ($item_info->{publisher}) {
2088             my $pub = MARC::Field->new('260', ' ', ' ', 'a' => '[S.l.]', 'b' => $item_info->{publisher});
2089             $pub->add_subfields('c' => $item_info->{publication_date}) if ($item_info->{publication_date});
2090             push(@fields, $pub);
2091         }
2092         # We have no idea if the author is personal corporate or something else, so we use a 720.
2093         push(@fields, MARC::Field->new('720', ' ', ' ', 'a' => $item_info->{author}, '4' => 'aut'));
2094         $record->append_fields(@fields);
2095         my $marc = clean_marc($record);
2096
2097         # Create the bib object.
2098         my $bib = Fieldmapper::biblio::record_entry->new();
2099         $bib->creator($self->{session}->{user}->id());
2100         $bib->editor($self->{session}->{user}->id());
2101         $bib->source($self->{bib_source}->id());
2102         $bib->active('t');
2103         $bib->deleted('f');
2104         $bib->marc($marc);
2105         $bib->isnew(1);
2106
2107         eval {
2108             $bib = $ses->request(
2109                 'open-ils.pcrud.create.bre',
2110                 $self->{session}->{authtoken},
2111                 $bib
2112             )->gather(1);
2113         };
2114         if ($@) {
2115             undef($bib);
2116             eval {
2117                 $ses->request(
2118                     'open-ils.pcrud.transaction.rollback',
2119                     $self->{session}->{authtoken}
2120                 )->gather(1);
2121             };
2122         }
2123
2124         # Create the call number
2125         my $acn;
2126         if ($bib) {
2127             $acn = Fieldmapper::asset::call_number->new();
2128             $acn->creator($self->{session}->{user}->id());
2129             $acn->editor($self->{session}->{user}->id());
2130             $acn->label($item_info->{call_number});
2131             $acn->record($bib->id());
2132             $acn->owning_lib($self->{session}->{work_ou}->id());
2133             $acn->deleted('f');
2134             $acn->isnew(1);
2135
2136             eval {
2137                 $acn = $ses->request(
2138                     'open-ils.pcrud.create.acn',
2139                     $self->{session}->{authtoken},
2140                     $acn
2141                 )->gather(1);
2142             };
2143             if ($@) {
2144                 undef($acn);
2145                 eval {
2146                     $ses->request(
2147                         'open-ils.pcrud.transaction.rollback',
2148                         $self->{session}->{authtoken}
2149                     )->gather(1);
2150                 };
2151             }
2152         }
2153
2154         # create the copy
2155         if ($acn) {
2156             $item = Fieldmapper::asset::copy->new();
2157             $item->barcode($item_info->{barcode});
2158             $item->call_number($acn->id());
2159             $item->circ_lib($self->{session}->{work_ou}->id);
2160             $item->circulate('t');
2161             if ($self->{config}->{items}->{use_force_holds}) {
2162                 $item->holdable('f');
2163             } else {
2164                 $item->holdable('t');
2165             }
2166             $item->opac_visible('f');
2167             $item->deleted('f');
2168             $item->fine_level(OILS_PRECAT_COPY_FINE_LEVEL);
2169             $item->loan_duration(OILS_PRECAT_COPY_LOAN_DURATION);
2170             $item->location(1);
2171             $item->status(0);
2172             $item->editor($self->{session}->{user}->id);
2173             $item->creator($self->{session}->{user}->id);
2174             $item->isnew(1);
2175
2176             eval {
2177                 $item = $ses->request(
2178                     'open-ils.pcrud.create.acp',
2179                     $self->{session}->{authtoken},
2180                     $item
2181                 )->gather(1);
2182
2183                 # Cross our fingers and commit the work.
2184                 $xact = $ses->request(
2185                     'open-ils.pcrud.transaction.commit',
2186                     $self->{session}->{authtoken}
2187                 )->gather(1);
2188             };
2189             if ($@) {
2190                 undef($item);
2191                 eval {
2192                     $ses->request(
2193                         'open-ils.pcrud.transaction.rollback',
2194                         $self->{session}->{authtoken}
2195                     )->gather(1) if ($xact);
2196                 };
2197             }
2198         }
2199     }
2200
2201     # We need to disconnect our session.
2202     $ses->disconnect();
2203
2204     # Now, we handle our asset stat_cat entries.
2205     if ($item) {
2206         # It would be nice to do these in the above transaction, but
2207         # pcrud does not support the ascecm object, yet.
2208         foreach my $entry (@{$self->{stat_cat_entries}}) {
2209             my $map = Fieldmapper::asset::stat_cat_entry_copy_map->new();
2210             $map->isnew(1);
2211             $map->stat_cat($entry->stat_cat());
2212             $map->stat_cat_entry($entry->id());
2213             $map->owning_copy($item->id());
2214             # We don't really worry if it succeeds or not.
2215             $U->simplereq(
2216                 'open-ils.circ',
2217                 'open-ils.circ.stat_cat.asset.copy_map.create',
2218                 $self->{session}->{authtoken},
2219                 $map
2220             );
2221         }
2222     }
2223
2224     return $item;
2225 }
2226
2227 =head2 place_hold
2228
2229     $hold = $ils->place_hold($item, $user, $location, $expiration);
2230
2231 This function places a hold on $item for $user for pickup at
2232 $location. If location is not provided or undefined, the user's home
2233 library is used as a fallback.
2234
2235 The $expiration argument is optional and must be a properly formatted
2236 ISO date time. It will be used as the hold expire time, if
2237 provided. Otherwise the system default time will be used.
2238
2239 $item can be a copy (asset::copy), volume (asset::call_number), or bib
2240 (biblio::record_entry). The appropriate hold type will be placed
2241 depending on the object.
2242
2243 On success, the method returns the object representing the hold. On
2244 failure, a NCIP::Problem object, describing the failure, is returned.
2245
2246 =cut
2247
2248 sub place_hold {
2249     my $self = shift;
2250     my $item = shift;
2251     my $user = shift;
2252     my $location = shift;
2253     my $expiration = shift;
2254
2255     # If $location is undefined, use the user's home_ou, which should
2256     # have been fleshed when the user was retrieved.
2257     $location = $user->home_ou() unless ($location);
2258
2259     # $hold is the hold. $params is for the is_possible check.
2260     my ($hold, $params);
2261
2262     # Prep the hold with fields common to all hold types:
2263     $hold = Fieldmapper::action::hold_request->new();
2264     $hold->isnew(1); # Just to make sure.
2265     $hold->target($item->id());
2266     $hold->usr($user->id());
2267     $hold->pickup_lib($location->id());
2268     $hold->expire_time(cleanse_ISO8601($expiration)) if ($expiration);
2269     if (!$user->email()) {
2270         $hold->email_notify('f');
2271         $hold->phone_notify($user->day_phone()) if ($user->day_phone());
2272     } else {
2273         $hold->email_notify('t');
2274     }
2275
2276     # Ditto the params:
2277     $params = { pickup_lib => $location->id(), patronid => $user->id() };
2278
2279     if (ref($item) eq 'Fieldmapper::asset::copy') {
2280         my $type = ($self->{config}->{items}->{use_force_holds}) ? 'F' : 'C';
2281         $hold->hold_type($type);
2282         $hold->current_copy($item->id());
2283         $params->{hold_type} = $type;
2284         $params->{copy_id} = $item->id();
2285     } elsif (ref($item) eq 'Fieldmapper::asset::call_number') {
2286         $hold->hold_type('V');
2287         $params->{hold_type} = 'V';
2288         $params->{volume_id} = $item->id();
2289     } elsif (ref($item) eq 'Fieldmapper::biblio::record_entry') {
2290         $hold->hold_type('T');
2291         $params->{hold_type} = 'T';
2292         $params->{titleid} = $item->id();
2293     }
2294
2295     # Check for a duplicate hold:
2296     my $duplicate = $U->simplereq(
2297         'open-ils.pcrud',
2298         'open-ils.pcrud.search.ahr',
2299         $self->{session}->{authtoken},
2300         {
2301             hold_type => $hold->hold_type(),
2302             target => $hold->target(),
2303             usr => $hold->usr(),
2304             expire_time => {'>' => 'now'},
2305             cancel_time => undef,
2306             fulfillment_time => undef
2307         }
2308     );
2309     if ($duplicate) {
2310         return NCIP::Problem->new(
2311             {
2312                 ProblemType => 'Duplicate Request',
2313                 ProblemDetail => 'A request for this item already exists for this patron.',
2314                 ProblemElement => 'NULL',
2315                 ProblemValue => 'NULL'
2316             }
2317         );
2318     }
2319
2320     # Check if the hold is possible:
2321     my $r = $U->simplereq(
2322         'open-ils.circ',
2323         'open-ils.circ.title_hold.is_possible',
2324         $self->{session}->{authtoken},
2325         $params
2326     );
2327
2328     if ($r->{success}) {
2329         $hold = $U->simplereq(
2330             'open-ils.circ',
2331             'open-ils.circ.holds.create.override',
2332             $self->{session}->{authtoken},
2333             $hold
2334         );
2335         if (ref($hold)) {
2336             $hold = $hold->[0] if (ref($hold) eq 'ARRAY');
2337             $hold = _problem_from_event('Request Not Possible', $hold);
2338         } else {
2339             # open-ils.circ.holds.create.override returns the id on
2340             # success, so we retrieve the full hold object from the
2341             # database to return it.
2342             $hold = $U->simplereq(
2343                 'open-ils.pcrud',
2344                 'open-ils.pcrud.retrieve.ahr',
2345                 $self->{session}->{authtoken},
2346                 $hold
2347             );
2348         }
2349     } elsif ($r->{last_event}) {
2350         $hold = _problem_from_event('Request Not Possible', $r->{last_event});
2351     } elsif ($r->{textcode}) {
2352         $hold = _problem_from_event('Request Not Possible', $r);
2353     } else {
2354         $hold = _problem_from_event('Request Not Possible');
2355     }
2356
2357     return $hold;
2358 }
2359
2360 =head2 cancel_hold
2361
2362     $ils->cancel_hold($hold);
2363
2364 This method cancels the hold argument. It makes no checks on the hold,
2365 so if there are certain conditions that need to be fulfilled before
2366 the hold is canceled, then you must check them before calling this
2367 method.
2368
2369 It returns undef on success or failure. If it fails, you've usually
2370 got bigger problems.
2371
2372 =cut
2373
2374 sub cancel_hold {
2375     my $self = shift;
2376     my $hold = shift;
2377
2378     my $r = $U->simplereq(
2379         'open-ils.circ',
2380         'open-ils.circ.hold.cancel',
2381         $self->{session}->{authtoken},
2382         $hold->id(),
2383         '5',
2384         'Canceled via NCIPServer'
2385     );
2386
2387     return undef;
2388 }
2389
2390 =head2 delete_copy
2391
2392     $ils->delete_copy($copy);
2393
2394 Deletes the copy, and if it is owned by our work_ou and not a precat,
2395 we also delete the volume and bib on which the copy depends.
2396
2397 =cut
2398
2399 sub delete_copy {
2400     my $self = shift;
2401     my $copy = shift;
2402
2403     # Shortcut for ownership checks below.
2404     my $ou_id = $self->{session}->{work_ou}->id();
2405
2406     # First, make sure the copy is not already deleted and we own it.
2407     return undef if ($U->is_true($copy->deleted()) || $copy->circ_lib() != $ou_id);
2408
2409     # Indicate we want to delete the copy.
2410     $copy->isdeleted(1);
2411
2412     # Delete the copy using a backend call that will delete the copy,
2413     # the call number, and bib when appropriate.
2414     my $result = $U->simplereq(
2415         'open-ils.cat',
2416         'open-ils.cat.asset.copy.fleshed.batch.update.override',
2417         $self->{session}->{authtoken},
2418         [$copy]
2419     );
2420
2421     # We are currently not checking for succes or failure of the
2422     # above. At some point, someone may want to.
2423
2424     return undef;
2425 }
2426
2427 =head2 copy_can_circulate
2428
2429     $can_circulate = $ils->copy_can_circulate($copy);
2430
2431 Check if the copy's location and the copy itself allow
2432 circulation. Return true if they do, and false if they do not.
2433
2434 =cut
2435
2436 sub copy_can_circulate {
2437     my $self = shift;
2438     my $copy = shift;
2439
2440     my $location = $copy->location();
2441     unless (ref($location)) {
2442         $location = $self->retrieve_copy_location($location);
2443     }
2444
2445     return ($U->is_true($copy->circulate()) && $U->is_true($location->circulate()));
2446 }
2447
2448 =head2 copy_can_fulfill
2449
2450     $can_fulfill = $ils->copy_can_fulfill($copy);
2451
2452 Check if the copy's location and the copy itself allow
2453 holds. Return true if they do, and false if they do not.
2454
2455 =cut
2456
2457 sub copy_can_fulfill {
2458     my $self = shift;
2459     my $copy = shift;
2460
2461     my $location = $copy->location();
2462     unless (ref($location)) {
2463         $location = $self->retrieve_copy_location($location);
2464     }
2465
2466     return ($U->is_true($copy->holdable()) && $U->is_true($location->holdable()));
2467 }
2468
2469 =head1 OVERRIDDEN PARENT METHODS
2470
2471 =head2 find_user_barcode
2472
2473 We dangerously override our parent's C<find_user_barcode> to return
2474 either the $barcode or a Problem object. In list context the barcode
2475 or problem will be the first argument and the id field, if any, will
2476 be the second. We also add a second, optional, argument to indicate a
2477 default value for the id field in the event of a failure to find
2478 anything at all. (Perl lets us get away with this.)
2479
2480 =cut
2481
2482 sub find_user_barcode {
2483     my $self = shift;
2484     my $request = shift;
2485     my $default = shift;
2486
2487     unless ($default) {
2488         my $message = $self->parse_request_type($request);
2489         if ($message eq 'LookupUser') {
2490             $default = 'AuthenticationInputData';
2491         } else {
2492             $default = 'UserIdentifierValue';
2493         }
2494     }
2495
2496     my ($value, $idfield) = $self->SUPER::find_user_barcode($request);
2497
2498     unless ($value) {
2499         $idfield = $default unless ($idfield);
2500         $value = NCIP::Problem->new();
2501         $value->ProblemType('Needed Data Missing');
2502         $value->ProblemDetail('Cannot find user barcode in message.');
2503         $value->ProblemElement($idfield);
2504         $value->ProblemValue('NULL');
2505     }
2506
2507     return (wantarray) ? ($value, $idfield) : $value;
2508 }
2509
2510 =head2 find_item_barcode
2511
2512 We do pretty much the same thing as with C<find_user_barcode> for
2513 C<find_item_barcode>.
2514
2515 =cut
2516
2517 sub find_item_barcode {
2518     my $self = shift;
2519     my $request = shift;
2520     my $default = shift || 'ItemIdentifierValue';
2521
2522     my ($value, $idfield) = $self->SUPER::find_item_barcode($request);
2523
2524     unless ($value) {
2525         $idfield = $default unless ($idfield);
2526         $value = NCIP::Problem->new();
2527         $value->ProblemType('Needed Data Missing');
2528         $value->ProblemDetail('Cannot find item barcode in message.');
2529         $value->ProblemElement($idfield);
2530         $value->ProblemValue('NULL');
2531     }
2532
2533     return (wantarray) ? ($value, $idfield) : $value;
2534 }
2535
2536 =head2 find_target_via_bibliographic_id
2537
2538     $item = $ils->find_target_via_bibliographic_id(@biblio_ids);
2539
2540 Searches for a bibliographic record to put on hold and returns an
2541 appropriate hold target item depending upon what it finds. If an
2542 appropriate, single target cannot be found, it returns an
2543 NCIP::Problem with the problem message.
2544
2545 Currently, we only look for SYSNUMBER, ISBN, and ISSN record
2546 identifiers. If nothing is found, this method can return undef. (Gotta
2547 love Perl and untyped/weakly typed languages in general!)
2548
2549 TODO: Figure out how to search OCLC numbers. We probably need to use
2550 "MARC Expert Search" if we don't want to do a JSON query on
2551 metabib.full_rec.
2552
2553 =cut
2554
2555 sub find_target_via_bibliographic_id {
2556     my $self = shift;
2557     my @biblio_ids = @_;
2558
2559     # The item that we find:
2560     my $item;
2561
2562     # Id for our bib in Evergreen:
2563     my $bibid;
2564
2565     # First, let's look for a SYSNUMBER:
2566     my ($idobj) = grep
2567         { ($_->{BibliographicRecordIdentifierCode} && $_->{BibliographicRecordIdentifierCode} eq 'SYSNUMBER')
2568               || ($_->{BibliographicItemIdentifierCode} && $_->{BibliographicItemIdentifierCode} eq 'SYSNUMBER')
2569               || $_->{AgencyId} }
2570             @biblio_ids;
2571     if ($idobj) {
2572         my $loc;
2573         # BibliographicRecordId can have an AgencyId field if the
2574         # BibliographicRecordIdentifierCode is absent.
2575         if ($idobj->{AgencyId}) {
2576             $bibid = $idobj->{BibliographicRecordIdentifier};
2577             my $locname = $idobj->{AgencyId};
2578             if ($locname) {
2579                 $locname =~ s/.*://;
2580                 $loc = $self->retrieve_org_unit_by_shortname($locname);
2581             }
2582         } elsif ($idobj->{BibliographicRecordIdentifierCode}) {
2583             $bibid = $idobj->{BibliographicRecordIdentifierCode}
2584         } else {
2585             $bibid = $idobj->{BibliographicItemIdentifierCode}
2586         }
2587         if ($bibid && $loc) {
2588             $item = $self->_call_number_search($bibid, $loc);
2589         } else {
2590             $item = $U->simplereq(
2591                 'open-ils.pcrud',
2592                 'open-ils.pcrud.retrieve.bre',
2593                 $self->{session}->{authtoken},
2594                 $bibid
2595             );
2596         }
2597         # Check if item is deleted so we'll look for more
2598         # possibilties.
2599         undef($item) if ($item && $U->is_true($item->deleted()));
2600     }
2601
2602     # Build an array of id objects based on the other identifier fields.
2603     my @idobjs = grep
2604         {
2605             ($_->{BibliographicRecordIdentifierCode} && $_->{BibliographicRecordIdentifierCode} eq 'ISBN')
2606                 || ($_->{BibliographicItemIdentifierCode} && $_->{BibliographicItemIdentifierCode} eq 'ISBN')
2607                 || ($_->{BibliographicRecordIdentifierCode} && $_->{BibliographicRecordIdentifierCode} eq 'ISSN')
2608                 || ($_->{BibliographicItemIdentifierCode} && $_->{BibliographicItemIdentifierCode} eq 'ISSN')
2609         } @biblio_ids;
2610
2611     if (@idobjs) {
2612         my $stashed_problem;
2613         # Reuse $idobj from above.
2614         foreach $idobj (@idobjs) {
2615             my ($idvalue, $idtype, $idfield);
2616             if ($_->{BibliographicItemIdentifier}) {
2617                 $idvalue = $_->{BibliographicItemIdentifier};
2618                 $idtype = $_->{BibliographicItemIdentifierCode};
2619                 $idfield = 'BibliographicItemIdentifier';
2620             } else {
2621                 $idvalue = $_->{BibliographicRecordIdentifier};
2622                 $idtype = $_->{BibliographicRecordIdentifierCode};
2623                 $idfield = 'BibliographicRecordIdentifier';
2624             }
2625             $item = $self->_bib_search($idvalue, $idtype);
2626             if (ref($item) eq 'NCIP::Problem') {
2627                 $stashed_problem = $item unless($stashed_problem);
2628                 $stashed_problem->ProblemElement($idfield);
2629                 undef($item);
2630             }
2631             last if ($item);
2632         }
2633         $item = $stashed_problem if (!$item && $stashed_problem);
2634     }
2635
2636     return $item;
2637 }
2638
2639 # private subroutines not meant to be used directly by subclasses.
2640 # Most have to do with setup and/or state checking of implementation
2641 # components.
2642
2643 # Find, load, and parse our configuration file:
2644 sub _configure {
2645     my $self = shift;
2646
2647     # Find the configuration file via variables:
2648     my $file = OILS_NCIP_CONFIG_DEFAULT;
2649     $file = $ENV{OILS_NCIP_CONFIG} if ($ENV{OILS_NCIP_CONFIG});
2650
2651     $self->{config} = XMLin($file, NormaliseSpace => 2,
2652                             ForceArray => ['block_profile', 'stat_cat_entry']);
2653 }
2654
2655 # Bootstrap OpenSRF::System and load the IDL.
2656 sub _bootstrap {
2657     my $self = shift;
2658
2659     my $bootstrap_config = $self->{config}->{bootstrap};
2660     OpenSRF::System->bootstrap_client(config_file => $bootstrap_config);
2661
2662     my $idl = OpenSRF::Utils::SettingsClient->new->config_value("IDL");
2663     Fieldmapper->import(IDL => $idl);
2664 }
2665
2666 # Login and then initialize some object data based on the
2667 # configuration.
2668 sub _init {
2669     my $self = shift;
2670
2671     # Login to Evergreen.
2672     $self->login();
2673
2674     # Load the barred groups as pgt objects into a blocked_profiles
2675     # list.
2676     $self->{blocked_profiles} = [];
2677     foreach (@{$self->{config}->{patrons}->{block_profile}}) {
2678         my $pgt;
2679         if (ref $_) {
2680             $pgt = $U->simplereq(
2681                 'open-ils.pcrud',
2682                 'open-ils.pcrud.retrieve.pgt',
2683                 $self->{session}->{authtoken},
2684                 $_->{grp}
2685             );
2686         } else {
2687             $pgt = $U->simplereq(
2688                 'open-ils.pcrud',
2689                 'open-ils.pcrud.search.pgt',
2690                 $self->{session}->{authtoken},
2691                 {name => $_}
2692             );
2693         }
2694         push(@{$self->{blocked_profiles}}, $pgt) if ($pgt);
2695     }
2696
2697     # Load the bib source if we're not using precats.
2698     unless ($self->{config}->{items}->{use_precats}) {
2699         # Retrieve the default
2700         $self->{bib_source} = $U->simplereq(
2701             'open-ils.pcrud',
2702             'open-ils.pcrud.retrieve.cbs',
2703             $self->{session}->{authtoken},
2704             BIB_SOURCE_DEFAULT);
2705         my $data = $self->{config}->{items}->{bib_source};
2706         if ($data) {
2707             $data = $data->[0] if (ref($data) eq 'ARRAY');
2708             my $result;
2709             if (ref $data) {
2710                 $result = $U->simplereq(
2711                     'open-ils.pcrud',
2712                     'open-ils.pcrud.retrieve.cbs',
2713                     $self->{session}->{authtoken},
2714                     $data->{cbs}
2715                 );
2716             } else {
2717                 $result = $U->simplereq(
2718                     'open-ils.pcrud',
2719                     'open-ils.pcrud.search.cbs',
2720                     $self->{session}->{authtoken},
2721                     {source => $data}
2722                 );
2723             }
2724             $self->{bib_source} = $result if ($result);
2725         }
2726     }
2727
2728     # Load the required asset.stat_cat_entries:
2729     $self->{stat_cat_entries} = [];
2730     # First, make a regex for our ou and ancestors:
2731     my $ancestors = join("|", @{$U->get_org_ancestors($self->{session}->{work_ou}->id())});
2732     my $re = qr/(?:$ancestors)/;
2733     # Get the uniq stat_cat ids from the configuration:
2734     my @cats = uniq map {$_->{stat_cat}} @{$self->{config}->{items}->{stat_cat_entry}};
2735     # Retrieve all of the fleshed stat_cats and entries for the above.
2736     my $stat_cats = $U->simplereq(
2737         'open-ils.circ',
2738         'open-ils.circ.stat_cat.asset.retrieve.batch',
2739         $self->{session}->{authtoken},
2740         @cats
2741     );
2742     foreach my $entry (@{$self->{config}->{items}->{stat_cat_entry}}) {
2743         # Must have the stat_cat attr and the name, so we must have a
2744         # reference.
2745         next unless(ref $entry);
2746         my ($stat) = grep {$_->id() == $entry->{stat_cat}} @$stat_cats;
2747         push(@{$self->{stat_cat_entries}}, grep {$_->owner() =~ $re && $_->value() eq $entry->{content}} @{$stat->entries()});
2748     }
2749 }
2750
2751 # Search asset.call_number by a bre.id and location object. Return the
2752 # "closest" call_number if found, undef otherwise.
2753 sub _call_number_search {
2754     my $self = shift;
2755     my $bibid = shift;
2756     my $location = shift;
2757
2758     # At some point, this should be smarter, and we should retrieve
2759     # ancestors and descendants and search with a JSON query or some
2760     # such with results ordered by proximity to the original location,
2761     # but I don't have time to implement that right now.
2762     my $acn = $U->simplereq(
2763         'open-ils.pcrud',
2764         'open-ils.pcrud.search.acn',
2765         $self->{session}->{authtoken},
2766         {record => $bibid, owning_lib => $location->id()}
2767     );
2768
2769     return $acn;
2770 }
2771
2772 # Do a multiclass.query to search for items by isbn or issn.
2773 sub _bib_search {
2774     my $self = shift;
2775     my $idvalue = shift;
2776     my $idtype = shift;
2777     my $item;
2778
2779     my $result = $U->simplereq(
2780         'open-ils.search',
2781         'open-ils.search.biblio.multiclass',
2782         {searches => {lc($idtype) => $idvalue}}
2783     );
2784
2785     if ($result && $result->{count}) {
2786         if ($result->{count} > 1) {
2787             $item = NCIP::Problem->new(
2788                 {
2789                     ProblemType => 'Non-Unique Item',
2790                     ProblemDetail => 'More than one item matches the request.',
2791                     ProblemElement => '',
2792                     ProblemValue => $idvalue
2793                 }
2794             );
2795         }
2796         my $bibid = $result->{ids}->[0]->[0];
2797         $item = $U->simplereq(
2798             'open-ils.pcrud',
2799             'open-ils.pcrud.retrieve.bre',
2800             $self->{session}->{authtoken},
2801             $bibid
2802         );
2803     }
2804
2805     return $item;
2806 }
2807
2808 # Search for holds using the user and copy_details information:
2809 sub _hold_search {
2810     my $self = shift;
2811     my $user = shift;
2812     my $copy_details = shift;
2813
2814     my $hold;
2815
2816     # Retrieve all of the user's active holds, and then search them in Perl.
2817     my $holds_list = $U->simplereq(
2818         'open-ils.circ',
2819         'open-ils.circ.holds.retrieve',
2820         $self->{session}->{authtoken},
2821         $user->id(),
2822         0
2823     );
2824
2825     if ($holds_list && @$holds_list) {
2826         my @holds;
2827         # Look for title holds (the most common), first:
2828         my $targetid = $copy_details->{mvr}->doc_id();
2829         @holds = grep {$_->hold_type eq 'T' && $_->target == $targetid} @{$holds_list};
2830         unless (@holds) {
2831             # Look for volume holds, the next most common:
2832             $targetid = $copy_details->{volume}->id();
2833             @holds = grep {$_->hold_type eq 'V' && $_->target == $targetid} @{$holds_list};
2834         }
2835         unless (@holds) {
2836             # Look for copy and force holds, the least likely.
2837             $targetid = $copy_details->{copy}->id();
2838             @holds = grep {($_->hold_type eq 'C' || $_->hold_type eq 'F') && $_->target == $targetid} @{$holds_list};
2839         }
2840         # There should only be 1, at this point, if there are any.
2841         if (@holds) {
2842             $hold = $holds[0];
2843         }
2844     }
2845
2846     return $hold;
2847 }
2848
2849 # Standalone, "helper" functions.  These do not take an object or
2850 # class reference.
2851
2852 # Check if a user is past their expiration date.
2853 sub _expired {
2854     my $user = shift;
2855     my $expired = 0;
2856
2857     # Users might not expire.  If so, they have no expire_date.
2858     if ($user->expire_date()) {
2859         my $expires = DateTime::Format::ISO8601->parse_datetime(
2860             cleanse_ISO8601($user->expire_date())
2861         )->epoch();
2862         my $now = DateTime->now()->epoch();
2863         $expired = $now > $expires;
2864     }
2865
2866     return $expired;
2867 }
2868
2869 # Creates a NCIP Problem from an event. Takes a string for the problem
2870 # type, the event hashref (or a string to use for the detail), and
2871 # optional arguments for the ProblemElement and ProblemValue fields.
2872 sub _problem_from_event {
2873     my ($type, $evt, $element, $value) = @_;
2874
2875     my $detail;
2876
2877     # Check the event.
2878     if (ref($evt)) {
2879         my ($textcode, $desc);
2880
2881         # Get the textcode, if available. Otherwise, use the ilsevent
2882         # "id," if available.
2883         if ($evt->{textcode}) {
2884             $textcode = $evt->{textcode};
2885         } elsif ($evt->{ilsevent}) {
2886             $textcode = $evt->{ilsevent};
2887         }
2888
2889         # Get the description. We favor translated descriptions over
2890         # the English in ils_events.xml.
2891         if ($evt->{desc}) {
2892             $desc = $evt->{desc};
2893         }
2894
2895         # Check if $type was set. As an "undocumented" feature, you
2896         # can pass undef, and we'll use the textcode from the event.
2897         unless ($type) {
2898             if ($textcode) {
2899                 $type = $textcode;
2900             }
2901         }
2902
2903         # Set the detail from some combination of the above.
2904         if ($desc) {
2905             $detail = $desc;
2906         } elsif ($textcode eq 'PERM_FAILURE') {
2907             if ($evt->{ilsperm}) {
2908                 $detail = "Permission denied: " . $evt->{ilsperm};
2909                 $detail =~ s/\.override$//;
2910             }
2911         } elsif ($textcode) {
2912             $detail = "ILS returned $textcode error.";
2913         } else {
2914             $detail = 'Detail not available.';
2915         }
2916
2917     } else {
2918         $detail = $evt;
2919     }
2920
2921     return NCIP::Problem->new(
2922         {
2923             ProblemType => ($type) ? $type : 'Temporary Processing Failure',
2924             ProblemDetail => ($detail) ? $detail : 'Detail not available.',
2925             ProblemElement => ($element) ? $element : 'NULL',
2926             ProblemValue => ($value) ? $value : 'NULL'
2927         }
2928     );
2929 }
2930
2931 1;