Open-ILS/src/perlmods/lib/OpenILS/Application/Circ/Circulate.pm

   1 package OpenILS::Application::Circ::Circulate;
   2 use strict; use warnings;
   3 use base 'OpenILS::Application';
   4 use OpenSRF::EX qw(:try);
   5 use OpenSRF::AppSession;
   6 use OpenSRF::Utils::SettingsClient;
   7 use OpenSRF::Utils::Logger qw(:logger);
   8 use OpenSRF::Utils::Config;
   9 use OpenILS::Const qw/:const/;
  10 use OpenILS::Application::AppUtils;
  11 use DateTime;
  12 my $U = "OpenILS::Application::AppUtils";
  13
  14 my %scripts;
  15 my $booking_status;
  16 my $opac_renewal_use_circ_lib;
  17 my $desk_renewal_use_circ_lib;
  18
  19 sub determine_booking_status {
  20     unless (defined $booking_status) {
  21         my $ses = create OpenSRF::AppSession("router");
  22         $booking_status = grep {$_ eq "open-ils.booking"} @{
  23             $ses->request("opensrf.router.info.class.list")->gather(1)
  24         };
  25         $ses->disconnect;
  26         $logger->info("booking status: " . ($booking_status ? "on" : "off"));
  27     }
  28
  29     return $booking_status;
  30 }
  31
  32
  33 my $MK_ENV_FLESH = {
  34     flesh => 2,
  35     flesh_fields => {acp => ['call_number','parts','floating'], acn => ['record']}
  36 };
  37
  38 # table of cases where suppressing a system-generated copy alerts
  39 # should generate an override of an old-style event
  40 my %COPY_ALERT_OVERRIDES = (
  41     "CLAIMSRETURNED\tCHECKOUT" => ['CIRC_CLAIMS_RETURNED'],
  42     "CLAIMSRETURNED\tCHECKIN" => ['CIRC_CLAIMS_RETURNED'],
  43     "LOST\tCHECKOUT" => ['OPEN_CIRCULATION_EXISTS'],
  44     "LONGOVERDUE\tCHECKOUT" => ['OPEN_CIRCULATION_EXISTS'],
  45     "MISSING\tCHECKOUT" => ['COPY_NOT_AVAILABLE'],
  46     "DAMAGED\tCHECKOUT" => ['COPY_NOT_AVAILABLE'],
  47     "LOST_AND_PAID\tCHECKOUT" => ['COPY_NOT_AVAILABLE', 'OPEN_CIRCULATION_EXISTS']
  48 );
  49
  50 sub initialize {}
  51
  52 __PACKAGE__->register_method(
  53     method  => "run_method",
  54     api_name    => "open-ils.circ.checkout.permit",
  55     notes       => q/
  56         Determines if the given checkout can occur
  57         @param authtoken The login session key
  58         @param params A trailing hash of named params including
  59             barcode : The copy barcode,
  60             patron : The patron the checkout is occurring for,
  61             renew : true or false - whether or not this is a renewal
  62         @return The event that occurred during the permit check.
  63     /);
  64
  65
  66 __PACKAGE__->register_method (
  67     method      => 'run_method',
  68     api_name        => 'open-ils.circ.checkout.permit.override',
  69     signature   => q/@see open-ils.circ.checkout.permit/,
  70 );
  71
  72
  73 __PACKAGE__->register_method(
  74     method  => "run_method",
  75     api_name    => "open-ils.circ.checkout",
  76     notes => q/
  77         Checks out an item
  78         @param authtoken The login session key
  79         @param params A named hash of params including:
  80             copy            The copy object
  81             barcode     If no copy is provided, the copy is retrieved via barcode
  82             copyid      If no copy or barcode is provide, the copy id will be use
  83             patron      The patron's id
  84             noncat      True if this is a circulation for a non-cataloted item
  85             noncat_type The non-cataloged type id
  86             noncat_circ_lib The location for the noncat circ.
  87             precat      The item has yet to be cataloged
  88             dummy_title The temporary title of the pre-cataloded item
  89             dummy_author The temporary authr of the pre-cataloded item
  90                 Default is the home org of the staff member
  91         @return The SUCCESS event on success, any other event depending on the error
  92     /);
  93
  94 __PACKAGE__->register_method(
  95     method  => "run_method",
  96     api_name    => "open-ils.circ.checkin",
  97     argc        => 2,
  98     signature   => q/
  99         Generic super-method for handling all copies
 100         @param authtoken The login session key
 101         @param params Hash of named parameters including:
 102             barcode - The copy barcode
 103             force   - If true, copies in bad statuses will be checked in and give good statuses
 104             noop    - don't capture holds or put items into transit
 105             void_overdues - void all overdues for the circulation (aka amnesty)
 106             ...
 107     /
 108 );
 109
 110 __PACKAGE__->register_method(
 111     method    => "run_method",
 112     api_name  => "open-ils.circ.checkin.override",
 113     signature => q/@see open-ils.circ.checkin/
 114 );
 115
 116 __PACKAGE__->register_method(
 117     method    => "run_method",
 118     api_name  => "open-ils.circ.renew.override",
 119     signature => q/@see open-ils.circ.renew/,
 120 );
 121
 122 __PACKAGE__->register_method(
 123     method  => "run_method",
 124     api_name    => "open-ils.circ.renew",
 125     notes       => <<"    NOTES");
 126     PARAMS( authtoken, circ => circ_id );
 127     open-ils.circ.renew(login_session, circ_object);
 128     Renews the provided circulation.  login_session is the requestor of the
 129     renewal and if the logged in user is not the same as circ->usr, then
 130     the logged in user must have RENEW_CIRC permissions.
 131     NOTES
 132
 133 __PACKAGE__->register_method(
 134     method   => "run_method",
 135     api_name => "open-ils.circ.checkout.full"
 136 );
 137 __PACKAGE__->register_method(
 138     method   => "run_method",
 139     api_name => "open-ils.circ.checkout.full.override"
 140 );
 141 __PACKAGE__->register_method(
 142     method   => "run_method",
 143     api_name => "open-ils.circ.reservation.pickup"
 144 );
 145 __PACKAGE__->register_method(
 146     method   => "run_method",
 147     api_name => "open-ils.circ.reservation.return"
 148 );
 149 __PACKAGE__->register_method(
 150     method   => "run_method",
 151     api_name => "open-ils.circ.reservation.return.override"
 152 );
 153 __PACKAGE__->register_method(
 154     method   => "run_method",
 155     api_name => "open-ils.circ.checkout.inspect",
 156     desc     => q/Returns the circ matrix test result and, on success, the rule set and matrix test object/
 157 );
 158
 159
 160 sub run_method {
 161     my( $self, $conn, $auth, $args ) = @_;
 162     translate_legacy_args($args);
 163     $args->{override_args} = { all => 1 } unless defined $args->{override_args};
 164     $args->{new_copy_alerts} ||= $self->api_level > 1 ? 1 : 0;
 165     my $api = $self->api_name;
 166
 167     my $circulator =
 168         OpenILS::Application::Circ::Circulator->new($auth, %$args);
 169
 170     return circ_events($circulator) if $circulator->bail_out;
 171
 172     $circulator->use_booking(determine_booking_status());
 173
 174     # --------------------------------------------------------------------------
 175     # First, check for a booking transit, as the barcode may not be a copy
 176     # barcode, but a resource barcode, and nothing else in here will work
 177     # --------------------------------------------------------------------------
 178
 179     if ($circulator->use_booking && (my $bc = $circulator->copy_barcode) && $api !~ /checkout|inspect/) { # do we have a barcode?
 180         my $resources = $circulator->editor->search_booking_resource( { barcode => $bc } ); # any resources by this barcode?
 181         if (@$resources) { # yes!
 182
 183             my $res_id_list = [ map { $_->id } @$resources ];
 184             my $transit = $circulator->editor->search_action_reservation_transit_copy(
 185                 [
 186                     { target_copy => $res_id_list, dest => $circulator->circ_lib, dest_recv_time => undef, cancel_time => undef },
 187                     { order_by => { artc => 'source_send_time' }, limit => 1 }
 188                 ]
 189             )->[0]; # Any transit for this barcode?
 190
 191             if ($transit) { # yes! unwrap it.
 192
 193                 my $reservation = $circulator->editor->retrieve_booking_reservation( $transit->reservation );
 194                 my $res_type    = $circulator->editor->retrieve_booking_resource_type( $reservation->target_resource_type );
 195
 196                 my $success_event = new OpenILS::Event(
 197                     "SUCCESS", "payload" => {"reservation" => $reservation}
 198                 );
 199                 if ($U->is_true($res_type->catalog_item)) { # is there a copy to be had here?
 200                     if (my $copy = $circulator->editor->search_asset_copy([
 201                         { barcode => $bc, deleted => 'f' }, $MK_ENV_FLESH
 202                     ])->[0]) { # got a copy
 203                         $copy->status( $transit->copy_status );
 204                         $copy->editor($circulator->editor->requestor->id);
 205                         $copy->edit_date('now');
 206                         $circulator->editor->update_asset_copy($copy);
 207                         $success_event->{"payload"}->{"record"} =
 208                             $U->record_to_mvr($copy->call_number->record);
 209                         $success_event->{"payload"}->{"volume"} = $copy->call_number;
 210                         $copy->call_number($copy->call_number->id);
 211                         $success_event->{"payload"}->{"copy"} = $copy;
 212                     }
 213                 }
 214
 215                 $transit->dest_recv_time('now');
 216                 $circulator->editor->update_action_reservation_transit_copy( $transit );
 217
 218                 $circulator->editor->commit;
 219                 # Formerly this branch just stopped here. Argh!
 220                 $conn->respond_complete($success_event);
 221                 return;
 222             }
 223         }
 224     }
 225
 226     if ($circulator->use_booking) {
 227         $circulator->is_res_checkin($circulator->is_checkin(1))
 228             if $api =~ /reservation.return/ or (
 229                 $api =~ /checkin/ and $circulator->seems_like_reservation()
 230             );
 231
 232         $circulator->is_res_checkout(1) if $api =~ /reservation.pickup/;
 233     }
 234
 235     $circulator->is_renewal(1) if $api =~ /renew/;
 236     $circulator->is_checkin(1) if $api =~ /checkin/;
 237     $circulator->is_checkout(1) if $api =~ /checkout/;
 238     $circulator->override(1) if $api =~ /override/o;
 239
 240     $circulator->mk_env();
 241     $circulator->noop(1) if $circulator->claims_never_checked_out;
 242
 243     return circ_events($circulator) if $circulator->bail_out;
 244
 245     if( $api =~ /checkout\.permit/ ) {
 246         $circulator->do_permit();
 247
 248     } elsif( $api =~ /checkout.full/ ) {
 249
 250         # requesting a precat checkout implies that any required
 251         # overrides have been performed.  Go ahead and re-override.
 252         $circulator->skip_permit_key(1);
 253         $circulator->override(1) if ( $circulator->request_precat && $circulator->editor->allowed('CREATE_PRECAT') );
 254         $circulator->do_permit();
 255         $circulator->is_checkout(1);
 256         unless( $circulator->bail_out ) {
 257             $circulator->events([]);
 258             $circulator->do_checkout();
 259         }
 260
 261     } elsif( $circulator->is_res_checkout ) {
 262         $circulator->do_reservation_pickup();
 263
 264     } elsif( $api =~ /inspect/ ) {
 265         my $data = $circulator->do_inspect();
 266         $circulator->editor->rollback;
 267         return $data;
 268
 269     } elsif( $api =~ /checkout/ ) {
 270         $circulator->do_checkout();
 271
 272     } elsif( $circulator->is_res_checkin ) {
 273         $circulator->do_reservation_return();
 274         $circulator->do_checkin() if ($circulator->copy());
 275     } elsif( $api =~ /checkin/ ) {
 276         $circulator->do_checkin();
 277
 278     } elsif( $api =~ /renew/ ) {
 279         $circulator->do_renew($api);
 280     }
 281
 282     if( $circulator->bail_out ) {
 283
 284         my @ee;
 285         # make sure no success event accidentally slip in
 286         $circulator->events(
 287             [ grep { $_->{textcode} ne 'SUCCESS' } @{$circulator->events} ]);
 288
 289         # Log the events
 290         my @e = @{$circulator->events};
 291         push( @ee, $_->{textcode} ) for @e;
 292         $logger->info("circulator: bailing out with events: " . (join ", ", @ee));
 293
 294         $circulator->editor->rollback;
 295
 296     } else {
 297
 298         # checkin and reservation return can result in modifications to
 299         # actor.usr.claims_never_checked_out_count without also modifying
 300         # actor.last_xact_id.  Perform a no-op update on the patron to
 301         # force an update to last_xact_id.
 302         if ($circulator->claims_never_checked_out && $circulator->patron) {
 303             $circulator->editor->update_actor_user(
 304                 $circulator->editor->retrieve_actor_user($circulator->patron->id))
 305                 or return $circulator->editor->die_event;
 306         }
 307
 308         $circulator->editor->commit;
 309     }
 310
 311     $conn->respond_complete(circ_events($circulator));
 312
 313     return undef if $circulator->bail_out;
 314
 315     $circulator->do_hold_notify($circulator->notify_hold)
 316         if $circulator->notify_hold;
 317     $circulator->retarget_holds if $circulator->retarget;
 318     $circulator->append_reading_list;
 319     $circulator->make_trigger_events;
 320
 321     return undef;
 322 }
 323
 324 sub circ_events {
 325     my $circ = shift;
 326     my @e = @{$circ->events};
 327     # if we have multiple events, SUCCESS should not be one of them;
 328     @e = grep { $_->{textcode} ne 'SUCCESS' } @e if @e > 1;
 329     return (@e == 1) ? $e[0] : \@e;
 330 }
 331
 332
 333 sub translate_legacy_args {
 334     my $args = shift;
 335
 336     if( $$args{barcode} ) {
 337         $$args{copy_barcode} = $$args{barcode};
 338         delete $$args{barcode};
 339     }
 340
 341     if( $$args{copyid} ) {
 342         $$args{copy_id} = $$args{copyid};
 343         delete $$args{copyid};
 344     }
 345
 346     if( $$args{patronid} ) {
 347         $$args{patron_id} = $$args{patronid};
 348         delete $$args{patronid};
 349     }
 350
 351     if( $$args{patron} and !ref($$args{patron}) ) {
 352         $$args{patron_id} = $$args{patron};
 353         delete $$args{patron};
 354     }
 355
 356
 357     if( $$args{noncat} ) {
 358         $$args{is_noncat} = $$args{noncat};
 359         delete $$args{noncat};
 360     }
 361
 362     if( $$args{precat} ) {
 363         $$args{is_precat} = $$args{request_precat} = $$args{precat};
 364         delete $$args{precat};
 365     }
 366 }
 367
 368
 369
 370 # --------------------------------------------------------------------------
 371 # This package actually manages all of the circulation logic
 372 # --------------------------------------------------------------------------
 373 package OpenILS::Application::Circ::Circulator;
 374 use strict; use warnings;
 375 use vars q/$AUTOLOAD/;
 376 use DateTime;
 377 use OpenILS::Utils::Fieldmapper;
 378 use OpenSRF::Utils::Cache;
 379 use Digest::MD5 qw(md5_hex);
 380 use DateTime::Format::ISO8601;
 381 use OpenILS::Utils::PermitHold;
 382 use OpenILS::Utils::DateTime qw/:datetime/;
 383 use OpenSRF::Utils::SettingsClient;
 384 use OpenILS::Application::Circ::Holds;
 385 use OpenILS::Application::Circ::Transit;
 386 use OpenSRF::Utils::Logger qw(:logger);
 387 use OpenILS::Utils::CStoreEditor qw/:funcs/;
 388 use OpenILS::Const qw/:const/;
 389 use OpenILS::Utils::Penalty;
 390 use OpenILS::Application::Circ::CircCommon;
 391 use Time::Local;
 392
 393 my $CC = "OpenILS::Application::Circ::CircCommon";
 394 my $holdcode    = "OpenILS::Application::Circ::Holds";
 395 my $transcode   = "OpenILS::Application::Circ::Transit";
 396 my %user_groups;
 397
 398 sub DESTROY { }
 399
 400
 401 # --------------------------------------------------------------------------
 402 # Add a pile of automagic getter/setter methods
 403 # --------------------------------------------------------------------------
 404 my @AUTOLOAD_FIELDS = qw/
 405     notify_hold
 406     remote_hold
 407     backdate
 408     reservation
 409     do_inventory_update
 410     copy
 411     copy_id
 412     copy_barcode
 413     new_copy_alerts
 414     user_copy_alerts
 415     system_copy_alerts
 416     overrides_per_copy_alerts
 417     next_copy_status
 418     copy_state
 419     patron
 420     patron_id
 421     patron_barcode
 422     volume
 423     title
 424     is_renewal
 425     is_checkout
 426     is_res_checkout
 427     is_precat
 428     is_noncat
 429     request_precat
 430     is_checkin
 431     is_res_checkin
 432     noncat_type
 433     editor
 434     events
 435     cache_handle
 436     override
 437     circ_permit_patron
 438     circ_permit_copy
 439     circ_duration
 440     circ_recurring_fines
 441     circ_max_fines
 442     circ_permit_renew
 443     circ
 444     transit
 445     hold
 446     permit_key
 447     noncat_circ_lib
 448     noncat_count
 449     checkout_time
 450     dummy_title
 451     dummy_author
 452     dummy_isbn
 453     circ_modifier
 454     circ_lib
 455     barcode
 456     duration_level
 457     recurring_fines_level
 458     duration_rule
 459     recurring_fines_rule
 460     max_fine_rule
 461     renewal_remaining
 462     auto_renewal_remaining
 463     hard_due_date
 464     due_date
 465     fulfilled_holds
 466     transit
 467     checkin_changed
 468     force
 469     permit_override
 470     pending_checkouts
 471     cancelled_hold_transit
 472     opac_renewal
 473     phone_renewal
 474     desk_renewal
 475     sip_renewal
 476     auto_renewal
 477     retarget
 478     matrix_test_result
 479     circ_matrix_matchpoint
 480     circ_test_success
 481     is_deposit
 482     is_rental
 483     deposit_billing
 484     rental_billing
 485     capture
 486     noop
 487     void_overdues
 488     parent_circ
 489     return_patron
 490     claims_never_checked_out
 491     skip_permit_key
 492     skip_deposit_fee
 493     skip_rental_fee
 494     use_booking
 495     clear_expired
 496     retarget_mode
 497     hold_as_transit
 498     fake_hold_dest
 499     limit_groups
 500     override_args
 501     checkout_is_for_hold
 502     manual_float
 503     dont_change_lost_zero
 504     lost_bill_options
 505     needs_lost_bill_handling
 506 /;
 507
 508
 509 sub AUTOLOAD {
 510     my $self = shift;
 511     my $type = ref($self) or die "$self is not an object";
 512     my $data = shift;
 513     my $name = $AUTOLOAD;
 514     $name =~ s/.*://o;
 515
 516     unless (grep { $_ eq $name } @AUTOLOAD_FIELDS) {
 517         $logger->error("circulator: $type: invalid autoload field: $name");
 518         die "$type: invalid autoload field: $name\n"
 519     }
 520
 521     {
 522         no strict 'refs';
 523         *{"${type}::${name}"} = sub {
 524             my $s = shift;
 525             my $v = shift;
 526             $s->{$name} = $v if defined $v;
 527             return $s->{$name};
 528         }
 529     }
 530     return $self->$name($data);
 531 }
 532
 533
 534 sub new {
 535     my( $class, $auth, %args ) = @_;
 536     $class = ref($class) || $class;
 537     my $self = bless( {}, $class );
 538
 539     $self->events([]);
 540     $self->editor(new_editor(xact => 1, authtoken => $auth));
 541
 542     unless( $self->editor->checkauth ) {
 543         $self->bail_on_events($self->editor->event);
 544         return $self;
 545     }
 546
 547     $self->cache_handle(OpenSRF::Utils::Cache->new('global'));
 548
 549     $self->$_($args{$_}) for keys %args;
 550
 551     $self->circ_lib(
 552         ($self->circ_lib) ? $self->circ_lib : $self->editor->requestor->ws_ou);
 553
 554     # if this is a renewal, default to desk_renewal
 555     $self->desk_renewal(1) unless
 556         $self->opac_renewal or $self->phone_renewal or $self->sip_renewal
 557         or $self->auto_renewal;
 558
 559     $self->capture('') unless $self->capture;
 560
 561     unless(%user_groups) {
 562         my $gps = $self->editor->retrieve_all_permission_grp_tree;
 563         %user_groups = map { $_->id => $_ } @$gps;
 564     }
 565
 566     return $self;
 567 }
 568
 569
 570 # --------------------------------------------------------------------------
 571 # True if we should discontinue processing
 572 # --------------------------------------------------------------------------
 573 sub bail_out {
 574     my( $self, $bool ) = @_;
 575     if( defined $bool ) {
 576         $logger->info("circulator: BAILING OUT") if $bool;
 577         $self->{bail_out} = $bool;
 578     }
 579     return $self->{bail_out};
 580 }
 581
 582
 583 sub push_events {
 584     my( $self, @evts ) = @_;
 585     for my $e (@evts) {
 586         next unless $e;
 587         $e->{payload} = $self->copy if
 588               ($e->{textcode} eq 'COPY_NOT_AVAILABLE');
 589
 590         $logger->info("circulator: pushing event ".$e->{textcode});
 591         push( @{$self->events}, $e ) unless
 592             grep { $_->{textcode} eq $e->{textcode} } @{$self->events};
 593     }
 594 }
 595
 596 sub mk_permit_key {
 597     my $self = shift;
 598     return '' if $self->skip_permit_key;
 599     my $key = md5_hex( time() . rand() . "$$" );
 600     $self->cache_handle->put_cache( "oils_permit_key_$key", 1, 300 );
 601     return $self->permit_key($key);
 602 }
 603
 604 sub check_permit_key {
 605     my $self = shift;
 606     return 1 if $self->skip_permit_key;
 607     my $key = $self->permit_key;
 608     return 0 unless $key;
 609     my $k = "oils_permit_key_$key";
 610     my $one = $self->cache_handle->get_cache($k);
 611     $self->cache_handle->delete_cache($k);
 612     return ($one) ? 1 : 0;
 613 }
 614
 615 sub seems_like_reservation {
 616     my $self = shift;
 617
 618     # Some words about the following method:
 619     # 1) It requires the VIEW_USER permission, but that's not an
 620     # issue, right, since all staff should have that?
 621     # 2) It returns only one reservation at a time, even if an item can be
 622     # and is currently overbooked.  Hmmm....
 623     my $booking_ses = create OpenSRF::AppSession("open-ils.booking");
 624     my $result = $booking_ses->request(
 625         "open-ils.booking.reservations.by_returnable_resource_barcode",
 626         $self->editor->authtoken,
 627         $self->copy_barcode
 628     )->gather(1);
 629     $booking_ses->disconnect;
 630
 631     return $self->bail_on_events($result) if defined $U->event_code($result);
 632
 633     if (@$result > 0) {
 634         $self->reservation(shift @$result);
 635         return 1;
 636     } else {
 637         return 0;
 638     }
 639
 640 }
 641
 642 # save_trimmed_copy() used just to be a block in mk_env(), but was separated for re-use
 643 sub save_trimmed_copy {
 644     my ($self, $copy) = @_;
 645
 646     $self->copy($copy);
 647     $self->volume($copy->call_number);
 648     $self->title($self->volume->record);
 649     $self->copy->call_number($self->volume->id);
 650     $self->volume->record($self->title->id);
 651     $self->is_precat(1) if $self->volume->id == OILS_PRECAT_CALL_NUMBER;
 652     if($self->copy->deposit_amount and $self->copy->deposit_amount > 0) {
 653         $self->is_deposit(1) if $U->is_true($self->copy->deposit);
 654         $self->is_rental(1) unless $U->is_true($self->copy->deposit);
 655     }
 656 }
 657
 658 sub collect_user_copy_alerts {
 659     my $self = shift;
 660     my $e = $self->editor;
 661
 662     if($self->copy) {
 663         my $alerts = $e->search_asset_copy_alert([
 664             {copy => $self->copy->id, ack_time => undef},
 665             {flesh => 1, flesh_fields => { aca => [ qw/ alert_type / ] }}
 666         ]);
 667         if (ref $alerts eq "ARRAY") {
 668             $logger->info("circulator: found " . scalar(@$alerts) . " alerts for copy " .
 669                 $self->copy->id);
 670             $self->user_copy_alerts($alerts);
 671         }
 672     }
 673 }
 674
 675 sub filter_user_copy_alerts {
 676     my $self = shift;
 677
 678     my $e = $self->editor;
 679
 680     if(my $alerts = $self->user_copy_alerts) {
 681
 682         my $suppress_orgs = $U->get_org_full_path($self->circ_lib);
 683         my $suppressions = $e->search_actor_copy_alert_suppress(
 684             {org => $suppress_orgs}
 685         );
 686
 687         my @final_alerts;
 688         foreach my $a (@$alerts) {
 689             # filter on event type
 690             if (defined $a->alert_type) {
 691                 next if ($a->alert_type->event eq 'CHECKIN' && !$self->is_checkin && !$self->is_renewal);
 692                 next if ($a->alert_type->event eq 'CHECKOUT' && !$self->is_checkout && !$self->is_renewal);
 693                 next if (defined $a->alert_type->in_renew && $U->is_true($a->alert_type->in_renew) && !$self->is_renewal);
 694                 next if (defined $a->alert_type->in_renew && !$U->is_true($a->alert_type->in_renew) && $self->is_renewal);
 695             }
 696
 697             # filter on suppression
 698             next if (grep { $a->alert_type->id == $_->alert_type} @$suppressions);
 699
 700             # filter on "only at circ lib"
 701             if (defined $a->alert_type->at_circ) {
 702                 my $copy_circ_lib = (ref $self->copy->circ_lib) ?
 703                     $self->copy->circ_lib->id : $self->copy->circ_lib;
 704                 my $orgs = $U->get_org_descendants($copy_circ_lib);
 705
 706                 if ($U->is_true($a->alert_type->invert_location)) {
 707                     next if (grep {$_ == $self->circ_lib} @$orgs);
 708                 } else {
 709                     next unless (grep {$_ == $self->circ_lib} @$orgs);
 710                 }
 711             }
 712
 713             # filter on "only at owning lib"
 714             if (defined $a->alert_type->at_owning) {
 715                 my $copy_owning_lib = (ref $self->volume->owning_lib) ?
 716                     $self->volume->owning_lib->id : $self->volume->owning_lib;
 717                 my $orgs = $U->get_org_descendants($copy_owning_lib);
 718
 719                 if ($U->is_true($a->alert_type->invert_location)) {
 720                     next if (grep {$_ == $self->circ_lib} @$orgs);
 721                 } else {
 722                     next unless (grep {$_ == $self->circ_lib} @$orgs);
 723                 }
 724             }
 725
 726             $a->alert_type->next_status([$U->unique_unnested_numbers($a->alert_type->next_status)]);
 727
 728             push @final_alerts, $a;
 729         }
 730
 731         $self->user_copy_alerts(\@final_alerts);
 732     }
 733 }
 734
 735 sub generate_system_copy_alerts {
 736     my $self = shift;
 737     return unless($self->copy);
 738
 739     # don't create system copy alerts if the copy
 740     # is in a normal state; we're assuming that there's
 741     # never a need to generate a popup for each and every
 742     # checkin or checkout of normal items. If this assumption
 743     # proves false, then we'll need to add a way to explicitly specify
 744     # that a copy alert type should never generate a system copy alert
 745     return if $self->copy_state eq 'NORMAL';
 746
 747     my $e = $self->editor;
 748
 749     my $suppress_orgs = $U->get_org_full_path($self->circ_lib);
 750     my $suppressions = $e->search_actor_copy_alert_suppress(
 751         {org => $suppress_orgs}
 752     );
 753
 754     # events we care about ...
 755     my $event = [];
 756     push(@$event, 'CHECKIN') if $self->is_checkin;
 757     push(@$event, 'CHECKOUT') if $self->is_checkout;
 758     return unless scalar(@$event);
 759
 760     my $alert_orgs = $U->get_org_ancestors($self->circ_lib);
 761     my $alert_types = $e->search_config_copy_alert_type({
 762         active    => 't',
 763         scope_org => $alert_orgs,
 764         event     => $event,
 765         state => $self->copy_state,
 766         '-or' => [ { in_renew => $self->is_renewal }, { in_renew => undef } ],
 767     });
 768
 769     my @final_types;
 770     foreach my $a (@$alert_types) {
 771         # filter on "only at circ lib"
 772         if (defined $a->at_circ) {
 773             my $copy_circ_lib = (ref $self->copy->circ_lib) ?
 774                 $self->copy->circ_lib->id : $self->copy->circ_lib;
 775             my $orgs = $U->get_org_descendants($copy_circ_lib);
 776
 777             if ($U->is_true($a->invert_location)) {
 778                 next if (grep {$_ == $self->circ_lib} @$orgs);
 779             } else {
 780                 next unless (grep {$_ == $self->circ_lib} @$orgs);
 781             }
 782         }
 783
 784         # filter on "only at owning lib"
 785         if (defined $a->at_owning) {
 786             my $copy_owning_lib = (ref $self->volume->owning_lib) ?
 787                 $self->volume->owning_lib->id : $self->volume->owning_lib;
 788             my $orgs = $U->get_org_descendants($copy_owning_lib);
 789
 790             if ($U->is_true($a->invert_location)) {
 791                 next if (grep {$_ == $self->circ_lib} @$orgs);
 792             } else {
 793                 next unless (grep {$_ == $self->circ_lib} @$orgs);
 794             }
 795         }
 796
 797         push @final_types, $a;
 798     }
 799
 800     if (@final_types) {
 801         $logger->info("circulator: found " . scalar(@final_types) . " system alert types for copy" .
 802             $self->copy->id);
 803     }
 804
 805     my @alerts;
 806
 807     # keep track of conditions corresponding to suppressed
 808     # system alerts, as these may be used to overridee
 809     # certain old-style-events
 810     my %auto_override_conditions = ();
 811     foreach my $t (@final_types) {
 812         if ($t->next_status) {
 813             if (grep { $t->id == $_->alert_type } @$suppressions) {
 814                 $t->next_status([]);
 815             } else {
 816                 $t->next_status([$U->unique_unnested_numbers($t->next_status)]);
 817             }
 818         }
 819
 820         my $alert = new Fieldmapper::asset::copy_alert ();
 821         $alert->alert_type($t->id);
 822         $alert->copy($self->copy->id);
 823         $alert->temp(1);
 824         $alert->create_staff($e->requestor->id);
 825         $alert->create_time('now');
 826         $alert->ack_staff($e->requestor->id);
 827         $alert->ack_time('now');
 828
 829         $alert = $e->create_asset_copy_alert($alert);
 830
 831         next unless $alert;
 832
 833         $alert->alert_type($t->clone);
 834
 835         push(@{$self->next_copy_status}, @{$t->next_status}) if ($t->next_status);
 836         if (grep {$_->alert_type == $t->id} @$suppressions) {
 837             $auto_override_conditions{join("\t", $t->state, $t->event)} = 1;
 838         }
 839         push(@alerts, $alert) unless (grep {$_->alert_type == $t->id} @$suppressions);
 840     }
 841
 842     $self->system_copy_alerts(\@alerts);
 843     $self->overrides_per_copy_alerts(\%auto_override_conditions);
 844 }
 845
 846 sub add_overrides_from_system_copy_alerts {
 847     my $self = shift;
 848     my $e = $self->editor;
 849
 850     foreach my $condition (keys %{$self->overrides_per_copy_alerts()}) {
 851         if (exists $COPY_ALERT_OVERRIDES{$condition}) {
 852             $self->override(1);
 853             push @{$self->override_args->{events}}, @{ $COPY_ALERT_OVERRIDES{$condition} };
 854             # special handling for long-overdue and lost checkouts
 855             if (grep { $_ eq 'OPEN_CIRCULATION_EXISTS' } @{ $COPY_ALERT_OVERRIDES{$condition} }) {
 856                 my $state = (split /\t/, $condition, -1)[0];
 857                 my $setting;
 858                 if ($state eq 'LOST' or $state eq 'LOST_AND_PAID') {
 859                     $setting = 'circ.copy_alerts.forgive_fines_on_lost_checkin';
 860                 } elsif ($state eq 'LONGOVERDUE') {
 861                     $setting = 'circ.copy_alerts.forgive_fines_on_long_overdue_checkin';
 862                 } else {
 863                     next;
 864                 }
 865                 my $forgive = $U->ou_ancestor_setting_value(
 866                     $self->circ_lib, $setting, $e
 867                 );
 868                 if ($U->is_true($forgive)) {
 869                     $self->void_overdues(1);
 870                 }
 871                 $self->noop(1); # do not attempt transits, just check it in
 872                 $self->do_checkin();
 873             }
 874         }
 875     }
 876 }
 877
 878 sub mk_env {
 879     my $self = shift;
 880     my $e = $self->editor;
 881
 882     $self->next_copy_status([]) unless (defined $self->next_copy_status);
 883     $self->overrides_per_copy_alerts({}) unless (defined $self->overrides_per_copy_alerts);
 884
 885     # --------------------------------------------------------------------------
 886     # Grab the fleshed copy
 887     # --------------------------------------------------------------------------
 888     unless($self->is_noncat) {
 889         my $copy;
 890         if($self->copy_id) {
 891             $copy = $e->retrieve_asset_copy(
 892                 [$self->copy_id, $MK_ENV_FLESH ]) or return $e->event;
 893
 894         } elsif( $self->copy_barcode ) {
 895
 896             $copy = $e->search_asset_copy(
 897                 [{barcode => $self->copy_barcode, deleted => 'f'}, $MK_ENV_FLESH ])->[0];
 898         } elsif( $self->reservation ) {
 899             my $res = $e->json_query(
 900                 {
 901                     "select" => {"acp" => ["id"]},
 902                     "from" => {
 903                         "acp" => {
 904                             "brsrc" => {
 905                                 "fkey" => "barcode",
 906                                 "field" => "barcode",
 907                                 "join" => {
 908                                     "bresv" => {
 909                                         "fkey" => "id",
 910                                         "field" => "current_resource"
 911                                     }
 912                                 }
 913                             }
 914                         }
 915                     },
 916                     "where" => {
 917                         deleted => 'f',
 918                         "+bresv" => {
 919                             "id" => (ref $self->reservation) ?
 920                                 $self->reservation->id : $self->reservation
 921                         }
 922                     }
 923                 }
 924             );
 925             if (ref $res eq "ARRAY" and scalar @$res) {
 926                 $logger->info("circulator: mapped reservation " .
 927                     $self->reservation . " to copy " . $res->[0]->{"id"});
 928                 $copy = $e->retrieve_asset_copy([$res->[0]->{"id"}, $MK_ENV_FLESH]);
 929             }
 930         }
 931
 932         if($copy) {
 933             $self->save_trimmed_copy($copy);
 934
 935             # alerts!
 936             $self->copy_state(
 937                 $e->json_query(
 938                     {from => ['asset.copy_state', $copy->id]}
 939                 )->[0]{'asset.copy_state'}
 940             );
 941
 942             $self->generate_system_copy_alerts;
 943             $self->add_overrides_from_system_copy_alerts;
 944             $self->collect_user_copy_alerts;
 945             $self->filter_user_copy_alerts;
 946
 947         } else {
 948             # We can't renew if there is no copy
 949             return $self->bail_on_events(OpenILS::Event->new('ASSET_COPY_NOT_FOUND'))
 950                 if $self->is_renewal;
 951             $self->is_precat(1);
 952         }
 953     }
 954
 955     # --------------------------------------------------------------------------
 956     # Grab the patron
 957     # --------------------------------------------------------------------------
 958     my $patron;
 959     my $flesh = {
 960         flesh => 1,
 961         flesh_fields => {au => [ qw/ card / ]}
 962     };
 963
 964     if( $self->patron_id ) {
 965         $patron = $e->retrieve_actor_user([$self->patron_id, $flesh])
 966             or return $self->bail_on_events(OpenILS::Event->new('ACTOR_USER_NOT_FOUND'));
 967
 968     } elsif( $self->patron_barcode ) {
 969
 970         # note: throwing ACTOR_USER_NOT_FOUND instead of ACTOR_CARD_NOT_FOUND is intentional
 971         my $card = $e->search_actor_card({barcode => $self->patron_barcode})->[0]
 972             or return $self->bail_on_events(OpenILS::Event->new('ACTOR_USER_NOT_FOUND'));
 973
 974         $patron = $e->retrieve_actor_user($card->usr)
 975             or return $self->bail_on_events(OpenILS::Event->new('ACTOR_USER_NOT_FOUND'));
 976
 977         # Use the card we looked up, not the patron's primary, for card active checks
 978         $patron->card($card);
 979
 980     } else {
 981         if( my $copy = $self->copy ) {
 982
 983             $flesh->{flesh} = 2;
 984             $flesh->{flesh_fields}->{circ} = ['usr'];
 985
 986             my $circ = $e->search_action_circulation([
 987                 {target_copy => $copy->id, checkin_time => undef}, $flesh
 988             ])->[0];
 989
 990             if($circ) {
 991                 $patron = $circ->usr;
 992                 $circ->usr($patron->id); # de-flesh for consistency
 993                 $self->circ($circ);
 994             }
 995         }
 996     }
 997
 998     return $self->bail_on_events(OpenILS::Event->new('ACTOR_USER_NOT_FOUND'))
 999         unless $self->patron($patron) or $self->is_checkin;
1000
1001     unless($self->is_checkin) {
1002
1003         # Check for inactivity and patron reg. expiration
1004
1005         $self->bail_on_events(OpenILS::Event->new('PATRON_INACTIVE'))
1006             unless $U->is_true($patron->active);
1007
1008         $self->bail_on_events(OpenILS::Event->new('PATRON_CARD_INACTIVE'))
1009             unless $U->is_true($patron->card->active);
1010
1011         # Expired patrons cannot check out.  Renewals for expired
1012         # patrons depend on a setting and will be checked in the
1013         # do_renew subroutine.
1014         if ($self->is_checkout) {
1015             my $expire = DateTime::Format::ISO8601->new->parse_datetime(
1016                 clean_ISO8601($patron->expire_date));
1017
1018             if (CORE::time > $expire->epoch) {
1019                 $self->bail_on_events(OpenILS::Event->new('PATRON_ACCOUNT_EXPIRED'))
1020             }
1021         }
1022     }
1023 }
1024
1025
1026 # --------------------------------------------------------------------------
1027 # Does the circ permit work
1028 # --------------------------------------------------------------------------
1029 sub do_permit {
1030     my $self = shift;
1031
1032     $self->log_me("do_permit()");
1033
1034     unless( $self->editor->requestor->id == $self->patron->id ) {
1035         return $self->bail_on_events($self->editor->event)
1036             unless( $self->editor->allowed('VIEW_PERMIT_CHECKOUT') );
1037     }
1038
1039     $self->check_captured_holds();
1040     $self->do_copy_checks();
1041     return if $self->bail_out;
1042     $self->run_patron_permit_scripts();
1043     $self->run_copy_permit_scripts()
1044         unless $self->is_precat or $self->is_noncat;
1045     $self->check_item_deposit_events();
1046     $self->override_events();
1047     return if $self->bail_out;
1048
1049     if($self->is_precat and not $self->request_precat) {
1050         $self->push_events(
1051             OpenILS::Event->new(
1052                 'ITEM_NOT_CATALOGED', payload => $self->mk_permit_key));
1053         return $self->bail_out(1) unless $self->is_renewal;
1054     }
1055
1056     $self->push_events(
1057         OpenILS::Event->new('SUCCESS', payload => $self->mk_permit_key));
1058 }
1059
1060 sub check_item_deposit_events {
1061     my $self = shift;
1062     $self->push_events(OpenILS::Event->new('ITEM_DEPOSIT_REQUIRED', payload => $self->copy))
1063         if $self->is_deposit and not $self->is_deposit_exempt;
1064     $self->push_events(OpenILS::Event->new('ITEM_RENTAL_FEE_REQUIRED', payload => $self->copy))
1065         if $self->is_rental and not $self->is_rental_exempt;
1066 }
1067
1068 # returns true if the user is not required to pay deposits
1069 sub is_deposit_exempt {
1070     my $self = shift;
1071     my $pid = (ref $self->patron->profile) ?
1072         $self->patron->profile->id : $self->patron->profile;
1073     my $groups = $U->ou_ancestor_setting_value(
1074         $self->circ_lib, 'circ.deposit.exempt_groups', $self->editor);
1075     for my $grp (@$groups) {
1076         return 1 if $self->is_group_descendant($grp, $pid);
1077     }
1078     return 0;
1079 }
1080
1081 # returns true if the user is not required to pay rental fees
1082 sub is_rental_exempt {
1083     my $self = shift;
1084     my $pid = (ref $self->patron->profile) ?
1085         $self->patron->profile->id : $self->patron->profile;
1086     my $groups = $U->ou_ancestor_setting_value(
1087         $self->circ_lib, 'circ.rental.exempt_groups', $self->editor);
1088     for my $grp (@$groups) {
1089         return 1 if $self->is_group_descendant($grp, $pid);
1090     }
1091     return 0;
1092 }
1093
1094 sub is_group_descendant {
1095     my($self, $p_id, $c_id) = @_;
1096     return 0 unless defined $p_id and defined $c_id;
1097     return 1 if $c_id == $p_id;
1098     while(my $grp = $user_groups{$c_id}) {
1099         $c_id = $grp->parent;
1100         return 0 unless defined $c_id;
1101         return 1 if $c_id == $p_id;
1102     }
1103     return 0;
1104 }
1105
1106 sub check_captured_holds {
1107     my $self    = shift;
1108     my $copy    = $self->copy;
1109     my $patron  = $self->patron;
1110
1111     return undef unless $copy;
1112
1113     my $s = $U->copy_status($copy->status)->id;
1114     return unless $s == OILS_COPY_STATUS_ON_HOLDS_SHELF;
1115     $logger->info("circulator: copy is on holds shelf, searching for the correct hold");
1116
1117     # Item is on the holds shelf, make sure it's going to the right person
1118     my $hold = $self->editor->search_action_hold_request(
1119         [
1120             {
1121                 current_copy        => $copy->id ,
1122                 capture_time        => { '!=' => undef },
1123                 cancel_time         => undef,
1124                 fulfillment_time    => undef
1125             },
1126             { limit => 1,
1127               flesh => 1,
1128               flesh_fields => { ahr => ['usr'] }
1129             }
1130         ]
1131     )->[0];
1132
1133     if ($hold and $hold->usr->id == $patron->id) {
1134         $self->checkout_is_for_hold(1);
1135         return undef;
1136     } elsif ($hold) {
1137         my $payload;
1138         my $holdau = $hold->usr;
1139
1140         if ($holdau) {
1141             $payload->{patron_name} = $holdau->first_given_name . ' ' . $holdau->family_name;
1142             $payload->{patron_id} = $holdau->id;
1143         } else {
1144             $payload->{patron_name} = "???";
1145         }
1146         $payload->{hold_id}     = $hold->id;
1147         $self->push_events(OpenILS::Event->new('ITEM_ON_HOLDS_SHELF',
1148                                                payload => $payload));
1149     }
1150
1151     $logger->info("circulator: this copy is needed by a different patron to fulfill a hold");
1152
1153 }
1154
1155
1156 sub do_copy_checks {
1157     my $self = shift;
1158     my $copy = $self->copy;
1159     return unless $copy;
1160
1161     my $stat = $U->copy_status($copy->status)->id;
1162
1163     # We cannot check out a copy if it is in-transit
1164     if( $stat == OILS_COPY_STATUS_IN_TRANSIT ) {
1165         return $self->bail_on_events(OpenILS::Event->new('COPY_IN_TRANSIT'));
1166     }
1167
1168     $self->handle_claims_returned();
1169     return if $self->bail_out;
1170
1171     # no claims returned circ was found, check if there is any open circ
1172     unless( $self->is_renewal ) {
1173
1174         my $circs = $self->editor->search_action_circulation(
1175             { target_copy => $copy->id, checkin_time => undef }
1176         );
1177
1178         if(my $old_circ = $circs->[0]) { # an open circ was found
1179
1180             my $payload = {copy => $copy};
1181
1182             if($old_circ->usr == $self->patron->id) {
1183
1184                 $payload->{old_circ} = $old_circ;
1185
1186                 # If there is an open circulation on the checkout item and an auto-renew
1187                 # interval is defined, inform the caller that they should go
1188                 # ahead and renew the item instead of warning about open circulations.
1189
1190                 my $auto_renew_intvl = $U->ou_ancestor_setting_value(
1191                     $self->circ_lib,
1192                     'circ.checkout_auto_renew_age',
1193                     $self->editor
1194                 );
1195
1196                 if($auto_renew_intvl) {
1197                     my $intvl_seconds = OpenILS::Utils::DateTime->interval_to_seconds($auto_renew_intvl);
1198                     my $checkout_time = DateTime::Format::ISO8601->new->parse_datetime( clean_ISO8601($old_circ->xact_start) );
1199
1200                     if(DateTime->now > $checkout_time->add(seconds => $intvl_seconds)) {
1201                         $payload->{auto_renew} = 1;
1202                     }
1203                 }
1204             }
1205
1206             return $self->bail_on_events(
1207                 OpenILS::Event->new('OPEN_CIRCULATION_EXISTS', payload => $payload)
1208             );
1209         }
1210     }
1211 }
1212
1213 my $LEGACY_CIRC_EVENT_MAP = {
1214     'no_item' => 'ITEM_NOT_CATALOGED',
1215     'actor.usr.barred' => 'PATRON_BARRED',
1216     'asset.copy.circulate' =>  'COPY_CIRC_NOT_ALLOWED',
1217     'asset.copy.status' => 'COPY_NOT_AVAILABLE',
1218     'asset.copy_location.circulate' => 'COPY_CIRC_NOT_ALLOWED',
1219     'config.circ_matrix_test.circulate' => 'COPY_CIRC_NOT_ALLOWED',
1220     'config.circ_matrix_test.max_items_out' =>  'PATRON_EXCEEDS_CHECKOUT_COUNT',
1221     'config.circ_matrix_test.max_overdue' =>  'PATRON_EXCEEDS_OVERDUE_COUNT',
1222     'config.circ_matrix_test.max_fines' => 'PATRON_EXCEEDS_FINES',
1223     'config.circ_matrix_circ_mod_test' => 'PATRON_EXCEEDS_CHECKOUT_COUNT',
1224     'config.circ_matrix_test.total_copy_hold_ratio' =>
1225         'TOTAL_HOLD_COPY_RATIO_EXCEEDED',
1226     'config.circ_matrix_test.available_copy_hold_ratio' =>
1227         'AVAIL_HOLD_COPY_RATIO_EXCEEDED'
1228 };
1229
1230
1231 # ---------------------------------------------------------------------
1232 # This pushes any patron-related events into the list but does not
1233 # set bail_out for any events
1234 # ---------------------------------------------------------------------
1235 sub run_patron_permit_scripts {
1236     my $self        = shift;
1237     my $patronid    = $self->patron->id;
1238
1239     my @allevents;
1240
1241
1242     my $results = $self->run_indb_circ_test;
1243     unless($self->circ_test_success) {
1244         my @trimmed_results;
1245
1246         if ($self->is_noncat) {
1247             # no_item result is OK during noncat checkout
1248             @trimmed_results = grep { ($_->{fail_part} || '') ne 'no_item' } @$results;
1249
1250         } else {
1251
1252             if ($self->checkout_is_for_hold) {
1253                 # if this checkout will fulfill a hold, ignore CIRC blocks
1254                 # and rely instead on the (later-checked) FULFILL block
1255
1256                 my @pen_names = grep {$_} map {$_->{fail_part}} @$results;
1257                 my $fblock_pens = $self->editor->search_config_standing_penalty(
1258                     {name => [@pen_names], block_list => {like => '%CIRC%'}});
1259
1260                 for my $res (@$results) {
1261                     my $name = $res->{fail_part} || '';
1262                     next if grep {$_->name eq $name} @$fblock_pens;
1263                     push(@trimmed_results, $res);
1264                 }
1265
1266             } else {
1267                 # not for hold or noncat
1268                 @trimmed_results = @$results;
1269             }
1270         }
1271
1272         # update the final set of test results
1273         $self->matrix_test_result(\@trimmed_results);
1274
1275         push @allevents, $self->matrix_test_result_events;
1276     }
1277
1278     for (@allevents) {
1279        $_->{payload} = $self->copy if
1280              ($_->{textcode} eq 'COPY_NOT_AVAILABLE');
1281     }
1282
1283     $logger->info("circulator: permit_patron script returned events: @allevents") if @allevents;
1284
1285     $self->push_events(@allevents);
1286 }
1287
1288 sub matrix_test_result_codes {
1289     my $self = shift;
1290     map { $_->{"fail_part"} } @{$self->matrix_test_result};
1291 }
1292
1293 sub matrix_test_result_events {
1294     my $self = shift;
1295     map {
1296         my $event = new OpenILS::Event(
1297             $LEGACY_CIRC_EVENT_MAP->{$_->{"fail_part"}} || $_->{"fail_part"}
1298         );
1299         $event->{"payload"} = {"fail_part" => $_->{"fail_part"}};
1300         $event;
1301     } (@{$self->matrix_test_result});
1302 }
1303
1304 sub run_indb_circ_test {
1305     my $self = shift;
1306     return $self->matrix_test_result if $self->matrix_test_result;
1307
1308     my $dbfunc = ($self->is_renewal) ?
1309         'action.item_user_renew_test' : 'action.item_user_circ_test';
1310
1311     if( $self->is_precat && $self->request_precat) {
1312         $self->make_precat_copy;
1313         return if $self->bail_out;
1314     }
1315
1316     my $results = $self->editor->json_query(
1317         {   from => [
1318                 $dbfunc,
1319                 $self->circ_lib,
1320                 ($self->is_noncat or ($self->is_precat and !$self->override and !$self->is_renewal)) ? undef : $self->copy->id,
1321                 $self->patron->id,
1322             ]
1323         }
1324     );
1325
1326     $self->circ_test_success($U->is_true($results->[0]->{success}));
1327
1328     if(my $mp = $results->[0]->{matchpoint}) {
1329         $logger->info("circulator: circ policy test found matchpoint built via rows " . $results->[0]->{buildrows});
1330         $self->circ_matrix_matchpoint($self->editor->retrieve_config_circ_matrix_matchpoint($mp));
1331         $self->circ_matrix_matchpoint->duration_rule($self->editor->retrieve_config_rules_circ_duration($results->[0]->{duration_rule}));
1332         if(defined($results->[0]->{renewals})) {
1333             $self->circ_matrix_matchpoint->duration_rule->max_renewals($results->[0]->{renewals});
1334         }
1335         $self->circ_matrix_matchpoint->recurring_fine_rule($self->editor->retrieve_config_rules_recurring_fine($results->[0]->{recurring_fine_rule}));
1336         if(defined($results->[0]->{grace_period})) {
1337             $self->circ_matrix_matchpoint->recurring_fine_rule->grace_period($results->[0]->{grace_period});
1338         }
1339         $self->circ_matrix_matchpoint->max_fine_rule($self->editor->retrieve_config_rules_max_fine($results->[0]->{max_fine_rule}));
1340         if(defined($results->[0]->{hard_due_date})) {
1341             $self->circ_matrix_matchpoint->hard_due_date($self->editor->retrieve_config_hard_due_date($results->[0]->{hard_due_date}));
1342         }
1343         # Grab the *last* response for limit_groups, where it is more likely to be filled
1344         $self->limit_groups($results->[-1]->{limit_groups});
1345     }
1346
1347     return $self->matrix_test_result($results);
1348 }
1349
1350 # ---------------------------------------------------------------------
1351 # given a use and copy, this will calculate the circulation policy
1352 # parameters.  Only works with in-db circ.
1353 # ---------------------------------------------------------------------
1354 sub do_inspect {
1355     my $self = shift;
1356
1357     return OpenILS::Event->new('ASSET_COPY_NOT_FOUND') unless $self->copy;
1358
1359     $self->run_indb_circ_test;
1360
1361     my $results = {
1362         circ_test_success => $self->circ_test_success,
1363         failure_events => [],
1364         failure_codes => [],
1365         matchpoint => $self->circ_matrix_matchpoint
1366     };
1367
1368     unless($self->circ_test_success) {
1369         $results->{"failure_codes"} = [ $self->matrix_test_result_codes ];
1370         $results->{"failure_events"} = [ $self->matrix_test_result_events ];
1371     }
1372
1373     if($self->circ_matrix_matchpoint) {
1374         my $duration_rule = $self->circ_matrix_matchpoint->duration_rule;
1375         my $recurring_fine_rule = $self->circ_matrix_matchpoint->recurring_fine_rule;
1376         my $max_fine_rule = $self->circ_matrix_matchpoint->max_fine_rule;
1377         my $hard_due_date = $self->circ_matrix_matchpoint->hard_due_date;
1378
1379         my $policy = $self->get_circ_policy(
1380             $duration_rule, $recurring_fine_rule, $max_fine_rule, $hard_due_date);
1381
1382         $$results{$_} = $$policy{$_} for keys %$policy;
1383     }
1384
1385     return $results;
1386 }
1387
1388 # ---------------------------------------------------------------------
1389 # Loads the circ policy info for duration, recurring fine, and max
1390 # fine based on the current copy
1391 # ---------------------------------------------------------------------
1392 sub get_circ_policy {
1393     my($self, $duration_rule, $recurring_fine_rule, $max_fine_rule, $hard_due_date) = @_;
1394
1395     my $policy = {
1396         duration_rule => $duration_rule->name,
1397         recurring_fine_rule => $recurring_fine_rule->name,
1398         max_fine_rule => $max_fine_rule->name,
1399         max_fine => $self->get_max_fine_amount($max_fine_rule),
1400         fine_interval => $recurring_fine_rule->recurrence_interval,
1401         renewal_remaining => $duration_rule->max_renewals,
1402         auto_renewal_remaining => $duration_rule->max_auto_renewals,
1403         grace_period => $recurring_fine_rule->grace_period
1404     };
1405
1406     if($hard_due_date) {
1407         $policy->{duration_date_ceiling} = $hard_due_date->ceiling_date;
1408         $policy->{duration_date_ceiling_force} = $hard_due_date->forceto;
1409     }
1410     else {
1411         $policy->{duration_date_ceiling} = undef;
1412         $policy->{duration_date_ceiling_force} = undef;
1413     }
1414
1415     $policy->{duration} = $duration_rule->shrt
1416         if $self->copy->loan_duration == OILS_CIRC_DURATION_SHORT;
1417     $policy->{duration} = $duration_rule->normal
1418         if $self->copy->loan_duration == OILS_CIRC_DURATION_NORMAL;
1419     $policy->{duration} = $duration_rule->extended
1420         if $self->copy->loan_duration == OILS_CIRC_DURATION_EXTENDED;
1421
1422     $policy->{recurring_fine} = $recurring_fine_rule->low
1423         if $self->copy->fine_level == OILS_REC_FINE_LEVEL_LOW;
1424     $policy->{recurring_fine} = $recurring_fine_rule->normal
1425         if $self->copy->fine_level == OILS_REC_FINE_LEVEL_NORMAL;
1426     $policy->{recurring_fine} = $recurring_fine_rule->high
1427         if $self->copy->fine_level == OILS_REC_FINE_LEVEL_HIGH;
1428
1429     return $policy;
1430 }
1431
1432 sub get_max_fine_amount {
1433     my $self = shift;
1434     my $max_fine_rule = shift;
1435     my $max_amount = $max_fine_rule->amount;
1436
1437     # if is_percent is true then the max->amount is
1438     # use as a percentage of the copy price
1439     if ($U->is_true($max_fine_rule->is_percent)) {
1440         my $price = $U->get_copy_price($self->editor, $self->copy, $self->volume);
1441         $max_amount = $price * $max_fine_rule->amount / 100;
1442     } elsif (
1443         $U->ou_ancestor_setting_value(
1444             $self->circ_lib,
1445             'circ.max_fine.cap_at_price',
1446             $self->editor
1447         )
1448     ) {
1449         my $price = $U->get_copy_price($self->editor, $self->copy, $self->volume);
1450         $max_amount = ( $price && $max_amount > $price ) ? $price : $max_amount;
1451     }
1452
1453     return $max_amount;
1454 }
1455
1456
1457
1458 sub run_copy_permit_scripts {
1459     my $self = shift;
1460     my $copy = $self->copy || return;
1461
1462     my @allevents;
1463
1464     my $results = $self->run_indb_circ_test;
1465     push @allevents, $self->matrix_test_result_events
1466         unless $self->circ_test_success;
1467
1468     # See if this copy has an alert message
1469     my $ae = $self->check_copy_alert();
1470     push( @allevents, $ae ) if $ae;
1471
1472     # uniquify the events
1473     my %hash = map { ($_->{ilsevent} => $_) } @allevents;
1474     @allevents = values %hash;
1475
1476     $logger->info("circulator: permit_copy script returned events: @allevents") if @allevents;
1477
1478     $self->push_events(@allevents);
1479 }
1480
1481
1482 sub check_copy_alert {
1483     my $self = shift;
1484
1485     if ($self->new_copy_alerts) {
1486         my @alerts;
1487         push @alerts, @{$self->user_copy_alerts} # we have preexisting alerts
1488             if ($self->user_copy_alerts && @{$self->user_copy_alerts});
1489
1490         push @alerts, @{$self->system_copy_alerts} # we have new dynamic alerts
1491             if ($self->system_copy_alerts && @{$self->system_copy_alerts});
1492
1493         if (@alerts) {
1494             $self->bail_out(1) if (!$self->override);
1495             return OpenILS::Event->new( 'COPY_ALERT_MESSAGE', payload => \@alerts);
1496         }
1497     }
1498
1499     return undef if $self->is_renewal;
1500     return OpenILS::Event->new(
1501         'COPY_ALERT_MESSAGE', payload => $self->copy->alert_message)
1502         if $self->copy and $self->copy->alert_message;
1503     return undef;
1504 }
1505
1506
1507
1508 # --------------------------------------------------------------------------
1509 # If the call is overriding and has permissions to override every collected
1510 # event, the are cleared.  Any event that the caller does not have
1511 # permission to override, will be left in the event list and bail_out will
1512 # be set
1513 # XXX We need code in here to cancel any holds/transits on copies
1514 # that are being force-checked out
1515 # --------------------------------------------------------------------------
1516 sub override_events {
1517     my $self = shift;
1518     my @events = @{$self->events};
1519     return unless @events;
1520     my $oargs = $self->override_args;
1521
1522     if(!$self->override) {
1523         return $self->bail_out(1)
1524             if( @events > 1 or $events[0]->{textcode} ne 'SUCCESS' );
1525     }
1526
1527     $self->events([]);
1528
1529     for my $e (@events) {
1530         my $tc = $e->{textcode};
1531         next if $tc eq 'SUCCESS';
1532         if($oargs->{all} || grep { $_ eq $tc } @{$oargs->{events}}) {
1533             my $ov = "$tc.override";
1534             $logger->info("circulator: attempting to override event: $ov");
1535
1536             return $self->bail_on_events($self->editor->event)
1537                 unless( $self->editor->allowed($ov) );
1538         } else {
1539             return $self->bail_out(1);
1540         }
1541    }
1542 }
1543
1544
1545 # --------------------------------------------------------------------------
1546 # If there is an open claimsreturn circ on the requested copy, close the
1547 # circ if overriding, otherwise bail out
1548 # --------------------------------------------------------------------------
1549 sub handle_claims_returned {
1550     my $self = shift;
1551     my $copy = $self->copy;
1552
1553     my $CR = $self->editor->search_action_circulation(
1554         {
1555             target_copy     => $copy->id,
1556             stop_fines      => OILS_STOP_FINES_CLAIMSRETURNED,
1557             checkin_time    => undef,
1558         }
1559     );
1560
1561     return unless ($CR = $CR->[0]);
1562
1563     my $evt;
1564
1565     # - If the caller has set the override flag, we will check the item in
1566     if($self->override && ($self->override_args->{all} || grep { $_ eq 'CIRC_CLAIMS_RETURNED' } @{$self->override_args->{events}}) ) {
1567
1568         $CR->checkin_time('now');
1569         $CR->checkin_scan_time('now');
1570         $CR->checkin_lib($self->circ_lib);
1571         $CR->checkin_workstation($self->editor->requestor->wsid);
1572         $CR->checkin_staff($self->editor->requestor->id);
1573
1574         $evt = $self->editor->event
1575             unless $self->editor->update_action_circulation($CR);
1576
1577     } else {
1578         $evt = OpenILS::Event->new('CIRC_CLAIMS_RETURNED');
1579     }
1580
1581     $self->bail_on_events($evt) if $evt;
1582     return;
1583 }
1584
1585
1586 # --------------------------------------------------------------------------
1587 # This performs the checkout
1588 # --------------------------------------------------------------------------
1589 sub do_checkout {
1590     my $self = shift;
1591
1592     $self->log_me("do_checkout()");
1593
1594     # make sure perms are good if this isn't a renewal
1595     unless( $self->is_renewal ) {
1596         return $self->bail_on_events($self->editor->event)
1597             unless( $self->editor->allowed('COPY_CHECKOUT') );
1598     }
1599
1600     # verify the permit key
1601     unless( $self->check_permit_key ) {
1602         if( $self->permit_override ) {
1603             return $self->bail_on_events($self->editor->event)
1604                 unless $self->editor->allowed('CIRC_PERMIT_OVERRIDE');
1605         } else {
1606             return $self->bail_on_events(OpenILS::Event->new('CIRC_PERMIT_BAD_KEY'))
1607         }
1608     }
1609
1610     # if this is a non-cataloged circ, build the circ and finish
1611     if( $self->is_noncat ) {
1612         $self->checkout_noncat;
1613         $self->push_events(
1614             OpenILS::Event->new('SUCCESS',
1615             payload => { noncat_circ => $self->circ }));
1616         return;
1617     }
1618
1619     if( $self->is_precat ) {
1620         $self->make_precat_copy;
1621         return if $self->bail_out;
1622
1623     } elsif( $self->copy->call_number == OILS_PRECAT_CALL_NUMBER ) {
1624         return $self->bail_on_events(OpenILS::Event->new('ITEM_NOT_CATALOGED'));
1625     }
1626
1627     $self->do_copy_checks;
1628     return if $self->bail_out;
1629
1630     $self->run_checkout_scripts();
1631     return if $self->bail_out;
1632
1633     $self->build_checkout_circ_object();
1634     return if $self->bail_out;
1635
1636     my $modify_to_start = $self->booking_adjusted_due_date();
1637     return if $self->bail_out;
1638
1639     $self->apply_modified_due_date($modify_to_start);
1640     return if $self->bail_out;
1641
1642     return $self->bail_on_events($self->editor->event)
1643         unless $self->editor->create_action_circulation($self->circ);
1644
1645     # refresh the circ to force local time zone for now
1646     $self->circ($self->editor->retrieve_action_circulation($self->circ->id));
1647
1648     if($self->limit_groups) {
1649         $self->editor->json_query({ from => ['action.link_circ_limit_groups', $self->circ->id, $self->limit_groups] });
1650     }
1651
1652     $self->copy->status(OILS_COPY_STATUS_CHECKED_OUT);
1653     $self->update_copy;
1654     return if $self->bail_out;
1655
1656     $self->apply_deposit_fee();
1657     return if $self->bail_out;
1658
1659     $self->handle_checkout_holds();
1660     return if $self->bail_out;
1661
1662     # ------------------------------------------------------------------------------
1663     # Update the patron penalty info in the DB.  Run it for permit-overrides
1664     # since the penalties are not updated during the permit phase
1665     # ------------------------------------------------------------------------------
1666     OpenILS::Utils::Penalty->calculate_penalties($self->editor, $self->patron->id, $self->circ_lib);
1667
1668     my $record = $U->record_to_mvr($self->title) unless $self->is_precat;
1669
1670     my $pcirc;
1671     if($self->is_renewal) {
1672         # flesh the billing summary for the checked-in circ
1673         $pcirc = $self->editor->retrieve_action_circulation([
1674             $self->parent_circ,
1675             {flesh => 2, flesh_fields => {circ => ['billable_transaction'], mbt => ['summary']}}
1676         ]);
1677     }
1678
1679     $self->push_events(
1680         OpenILS::Event->new('SUCCESS',
1681             payload  => {
1682                 copy             => $U->unflesh_copy($self->copy),
1683                 volume           => $self->volume,
1684                 circ             => $self->circ,
1685                 record           => $record,
1686                 holds_fulfilled  => $self->fulfilled_holds,
1687                 deposit_billing  => $self->deposit_billing,
1688                 rental_billing   => $self->rental_billing,
1689                 parent_circ      => $pcirc,
1690                 patron           => ($self->return_patron) ? $self->patron : undef,
1691                 patron_money     => $self->editor->retrieve_money_user_summary($self->patron->id)
1692             }
1693         )
1694     );
1695 }
1696
1697 sub apply_deposit_fee {
1698     my $self = shift;
1699     my $copy = $self->copy;
1700     return unless
1701         ($self->is_deposit and not $self->is_deposit_exempt) or
1702         ($self->is_rental and not $self->is_rental_exempt);
1703
1704     return if $self->is_deposit and $self->skip_deposit_fee;
1705     return if $self->is_rental and $self->skip_rental_fee;
1706
1707     my $bill = Fieldmapper::money::billing->new;
1708     my $amount = $copy->deposit_amount;
1709     my $billing_type;
1710     my $btype;
1711
1712     if($self->is_deposit) {
1713         $billing_type = OILS_BILLING_TYPE_DEPOSIT;
1714         $btype = 5;
1715         $self->deposit_billing($bill);
1716     } else {
1717         $billing_type = OILS_BILLING_TYPE_RENTAL;
1718         $btype = 6;
1719         $self->rental_billing($bill);
1720     }
1721
1722     $bill->xact($self->circ->id);
1723     $bill->amount($amount);
1724     $bill->note(OILS_BILLING_NOTE_SYSTEM);
1725     $bill->billing_type($billing_type);
1726     $bill->btype($btype);
1727     $self->editor->create_money_billing($bill) or $self->bail_on_events($self->editor->event);
1728
1729     $logger->info("circulator: charged $amount on checkout with billing type $billing_type");
1730 }
1731
1732 sub update_copy {
1733     my $self = shift;
1734     my $copy = $self->copy;
1735
1736     my $stat = $copy->status if ref $copy->status;
1737     my $loc = $copy->location if ref $copy->location;
1738     my $circ_lib = $copy->circ_lib if ref $copy->circ_lib;
1739
1740     $copy->status($stat->id) if $stat;
1741     $copy->location($loc->id) if $loc;
1742     $copy->circ_lib($circ_lib->id) if $circ_lib;
1743     $copy->editor($self->editor->requestor->id);
1744     $copy->edit_date('now');
1745     $copy->age_protect($copy->age_protect->id) if ref $copy->age_protect;
1746
1747     return $self->bail_on_events($self->editor->event)
1748         unless $self->editor->update_asset_copy($self->copy);
1749
1750     $copy->status($U->copy_status($copy->status));
1751     $copy->location($loc) if $loc;
1752     $copy->circ_lib($circ_lib) if $circ_lib;
1753 }
1754
1755 sub update_reservation {
1756     my $self = shift;
1757     my $reservation = $self->reservation;
1758
1759     my $usr = $reservation->usr;
1760     my $target_rt = $reservation->target_resource_type;
1761     my $target_r = $reservation->target_resource;
1762     my $current_r = $reservation->current_resource;
1763
1764     $reservation->usr($usr->id) if ref $usr;
1765     $reservation->target_resource_type($target_rt->id) if ref $target_rt;
1766     $reservation->target_resource($target_r->id) if ref $target_r;
1767     $reservation->current_resource($current_r->id) if ref $current_r;
1768
1769     return $self->bail_on_events($self->editor->event)
1770         unless $self->editor->update_booking_reservation($self->reservation);
1771
1772     my $evt;
1773     ($reservation, $evt) = $U->fetch_booking_reservation($reservation->id);
1774     $self->reservation($reservation);
1775 }
1776
1777
1778 sub bail_on_events {
1779     my( $self, @evts ) = @_;
1780     $self->push_events(@evts);
1781     $self->bail_out(1);
1782 }
1783
1784 # ------------------------------------------------------------------------------
1785 # A hold FULFILL block is just like a CIRC block, except that FULFILL only
1786 # affects copies that will fulfill holds and CIRC affects all other copies.
1787 # If blocks exists, bail, push Events onto the event pile, and return true.
1788 # ------------------------------------------------------------------------------
1789 sub check_hold_fulfill_blocks {
1790     my $self = shift;
1791
1792     # With the addition of ignore_proximity in csp, we need to fetch
1793     # the proximity of both the circ_lib and the copy's circ_lib to
1794     # the patron's home_ou.
1795     my ($ou_prox, $copy_prox);
1796     my $home_ou = (ref($self->patron->home_ou)) ? $self->patron->home_ou->id : $self->patron->home_ou;
1797     $ou_prox = $U->get_org_unit_proximity($self->editor, $home_ou, $self->circ_lib);
1798     $ou_prox = -1 unless (defined($ou_prox));
1799     my $copy_ou = (ref($self->copy->circ_lib)) ? $self->copy->circ_lib->id : $self->copy->circ_lib;
1800     if ($copy_ou == $self->circ_lib) {
1801         # Save us the time of an extra query.
1802         $copy_prox = $ou_prox;
1803     } else {
1804         $copy_prox = $U->get_org_unit_proximity($self->editor, $home_ou, $copy_ou);
1805         $copy_prox = -1 unless (defined($copy_prox));
1806     }
1807
1808     # See if the user has any penalties applied that prevent hold fulfillment
1809     my $pens = $self->editor->json_query({
1810         select => {csp => ['name', 'label']},
1811         from => {ausp => {csp => {}}},
1812         where => {
1813             '+ausp' => {
1814                 usr => $self->patron->id,
1815                 org_unit => $U->get_org_full_path($self->circ_lib),
1816                 '-or' => [
1817                     {stop_date => undef},
1818                     {stop_date => {'>' => 'now'}}
1819                 ]
1820             },
1821             '+csp' => {
1822                 block_list => {'like' => '%FULFILL%'},
1823                 '-or' => [
1824                     {ignore_proximity => undef},
1825                     {ignore_proximity => {'<' => $ou_prox}},
1826                     {ignore_proximity => {'<' => $copy_prox}}
1827                 ]
1828             }
1829         }
1830     });
1831
1832     return 0 unless @$pens;
1833
1834     for my $pen (@$pens) {
1835         $logger->info("circulator: patron has hold FULFILL block " . $pen->{name});
1836         my $event = OpenILS::Event->new($pen->{name});
1837         $event->{desc} = $pen->{label};
1838         $self->push_events($event);
1839     }
1840
1841     $self->override_events;
1842     return $self->bail_out;
1843 }
1844
1845
1846 # ------------------------------------------------------------------------------
1847 # When an item is checked out, see if we can fulfill a hold for this patron
1848 # ------------------------------------------------------------------------------
1849 sub handle_checkout_holds {
1850    my $self    = shift;
1851    my $copy    = $self->copy;
1852    my $patron  = $self->patron;
1853
1854    my $e = $self->editor;
1855    $self->fulfilled_holds([]);
1856
1857    # non-cats can't fulfill a hold
1858    return if $self->is_noncat;
1859
1860     my $hold = $e->search_action_hold_request({
1861         current_copy        => $copy->id ,
1862         cancel_time         => undef,
1863         fulfillment_time    => undef
1864     })->[0];
1865
1866     if($hold and $hold->usr != $patron->id) {
1867         # reset the hold since the copy is now checked out
1868
1869         $logger->info("circulator: un-targeting hold ".$hold->id.
1870             " because copy ".$copy->id." is getting checked out");
1871
1872         $hold->clear_prev_check_time;
1873         $hold->clear_current_copy;
1874         $hold->clear_capture_time;
1875         $hold->clear_shelf_time;
1876         $hold->clear_shelf_expire_time;
1877         $hold->clear_current_shelf_lib;
1878
1879         return $self->bail_on_event($e->event)
1880             unless $e->update_action_hold_request($hold);
1881
1882         $hold = undef;
1883     }
1884
1885     unless($hold) {
1886         $hold = $self->find_related_user_hold($copy, $patron) or return;
1887         $logger->info("circulator: found related hold to fulfill in checkout");
1888     }
1889
1890     return if $self->check_hold_fulfill_blocks;
1891
1892     $logger->debug("circulator: checkout fulfilling hold " . $hold->id);
1893
1894     # if the hold was never officially captured, capture it.
1895     $hold->current_copy($copy->id);
1896     $hold->capture_time('now') unless $hold->capture_time;
1897     $hold->fulfillment_time('now');
1898     $hold->fulfillment_staff($e->requestor->id);
1899     $hold->fulfillment_lib($self->circ_lib);
1900
1901     return $self->bail_on_events($e->event)
1902         unless $e->update_action_hold_request($hold);
1903
1904     return $self->fulfilled_holds([$hold->id]);
1905 }
1906
1907
1908 # ------------------------------------------------------------------------------
1909 # If the circ.checkout_fill_related_hold setting is turned on and no hold for
1910 # the patron directly targets the checked out item, see if there is another hold
1911 # for the patron that could be fulfilled by the checked out item.  Fulfill the
1912 # oldest hold and only fulfill 1 of them.
1913 #
1914 # For "another hold":
1915 #
1916 # First, check for one that the copy matches via hold_copy_map, ensuring that
1917 # *any* hold type that this copy could fill may end up filled.
1918 #
1919 # Then, if circ.checkout_fill_related_hold_exact_match_only is not enabled, look
1920 # for a Title (T) or Volume (V) hold that matches the item. This allows items
1921 # that are non-requestable to count as capturing those hold types.
1922 # ------------------------------------------------------------------------------
1923 sub find_related_user_hold {
1924     my($self, $copy, $patron) = @_;
1925     my $e = $self->editor;
1926
1927     # holds on precat copies are always copy-level, so this call will
1928     # always return undef.  Exit early.
1929     return undef if $self->is_precat;
1930
1931     return undef unless $U->ou_ancestor_setting_value(
1932         $self->circ_lib, 'circ.checkout_fills_related_hold', $e);
1933
1934     # find the oldest unfulfilled hold that has not yet hit the holds shelf.
1935     my $args = {
1936         select => {ahr => ['id']},
1937         from => {
1938             ahr => {
1939                 ahcm => {
1940                     field => 'hold',
1941                     fkey => 'id'
1942                 },
1943                 acp => {
1944                     field => 'id',
1945                     fkey => 'current_copy',
1946                     type => 'left' # there may be no current_copy
1947                 }
1948             }
1949         },
1950         where => {
1951             '+ahr' => {
1952                 usr => $patron->id,
1953                 fulfillment_time => undef,
1954                 cancel_time => undef,
1955                '-or' => [
1956                     {expire_time => undef},
1957                     {expire_time => {'>' => 'now'}}
1958                 ]
1959             },
1960             '+ahcm' => {
1961                 target_copy => $self->copy->id
1962             },
1963             '+acp' => {
1964                 '-or' => [
1965                     {id => undef}, # left-join copy may be nonexistent
1966                     {status => {'!=' => OILS_COPY_STATUS_ON_HOLDS_SHELF}},
1967                 ]
1968             }
1969         },
1970         order_by => {ahr => {request_time => {direction => 'asc'}}},
1971         limit => 1
1972     };
1973
1974     my $hold_info = $e->json_query($args)->[0];
1975     return $e->retrieve_action_hold_request($hold_info->{id}) if $hold_info;
1976     return undef if $U->ou_ancestor_setting_value(
1977         $self->circ_lib, 'circ.checkout_fills_related_hold_exact_match_only', $e);
1978
1979     # find the oldest unfulfilled hold that has not yet hit the holds shelf.
1980     $args = {
1981         select => {ahr => ['id']},
1982         from => {
1983             ahr => {
1984                 acp => {
1985                     field => 'id',
1986                     fkey => 'current_copy',
1987                     type => 'left' # there may be no current_copy
1988                 }
1989             }
1990         },
1991         where => {
1992             '+ahr' => {
1993                 usr => $patron->id,
1994                 fulfillment_time => undef,
1995                 cancel_time => undef,
1996                '-or' => [
1997                     {expire_time => undef},
1998                     {expire_time => {'>' => 'now'}}
1999                 ]
2000             },
2001             '-or' => [
2002                 {
2003                     '+ahr' => {
2004                         hold_type => 'V',
2005                         target => $self->volume->id
2006                     }
2007                 },
2008                 {
2009                     '+ahr' => {
2010                         hold_type => 'T',
2011                         target => $self->title->id
2012                     }
2013                 },
2014             ],
2015             '+acp' => {
2016                 '-or' => [
2017                     {id => undef}, # left-join copy may be nonexistent
2018                     {status => {'!=' => OILS_COPY_STATUS_ON_HOLDS_SHELF}},
2019                 ]
2020             }
2021         },
2022         order_by => {ahr => {request_time => {direction => 'asc'}}},
2023         limit => 1
2024     };
2025
2026     $hold_info = $e->json_query($args)->[0];
2027     return $e->retrieve_action_hold_request($hold_info->{id}) if $hold_info;
2028     return undef;
2029 }
2030
2031
2032 sub run_checkout_scripts {
2033     my $self = shift;
2034     my $nobail = shift;
2035
2036     my $evt;
2037
2038     my $duration;
2039     my $recurring;
2040     my $max_fine;
2041     my $hard_due_date;
2042     my $duration_name;
2043     my $recurring_name;
2044     my $max_fine_name;
2045     my $hard_due_date_name;
2046
2047     $self->run_indb_circ_test();
2048     $duration = $self->circ_matrix_matchpoint->duration_rule;
2049     $recurring = $self->circ_matrix_matchpoint->recurring_fine_rule;
2050     $max_fine = $self->circ_matrix_matchpoint->max_fine_rule;
2051     $hard_due_date = $self->circ_matrix_matchpoint->hard_due_date;
2052
2053     $duration_name = $duration->name if $duration;
2054     if( $duration_name ne OILS_UNLIMITED_CIRC_DURATION ) {
2055
2056         unless($duration) {
2057             ($duration, $evt) = $U->fetch_circ_duration_by_name($duration_name);
2058             return $self->bail_on_events($evt) if ($evt && !$nobail);
2059
2060             ($recurring, $evt) = $U->fetch_recurring_fine_by_name($recurring_name);
2061             return $self->bail_on_events($evt) if ($evt && !$nobail);
2062
2063             ($max_fine, $evt) = $U->fetch_max_fine_by_name($max_fine_name);
2064             return $self->bail_on_events($evt) if ($evt && !$nobail);
2065
2066             if($hard_due_date_name) {
2067                 ($hard_due_date, $evt) = $U->fetch_hard_due_date_by_name($hard_due_date_name);
2068                 return $self->bail_on_events($evt) if ($evt && !$nobail);
2069             }
2070         }
2071
2072     } else {
2073
2074         # The item circulates with an unlimited duration
2075         $duration   = undef;
2076         $recurring  = undef;
2077         $max_fine   = undef;
2078         $hard_due_date = undef;
2079     }
2080
2081    $self->duration_rule($duration);
2082    $self->recurring_fines_rule($recurring);
2083    $self->max_fine_rule($max_fine);
2084    $self->hard_due_date($hard_due_date);
2085 }
2086
2087
2088 sub build_checkout_circ_object {
2089     my $self = shift;
2090
2091    my $circ       = Fieldmapper::action::circulation->new;
2092    my $duration   = $self->duration_rule;
2093    my $max        = $self->max_fine_rule;
2094    my $recurring  = $self->recurring_fines_rule;
2095    my $hard_due_date    = $self->hard_due_date;
2096    my $copy       = $self->copy;
2097    my $patron     = $self->patron;
2098    my $duration_date_ceiling;
2099    my $duration_date_ceiling_force;
2100
2101     if( $duration ) {
2102
2103         my $policy = $self->get_circ_policy($duration, $recurring, $max, $hard_due_date);
2104         $duration_date_ceiling = $policy->{duration_date_ceiling};
2105         $duration_date_ceiling_force = $policy->{duration_date_ceiling_force};
2106
2107         my $dname = $duration->name;
2108         my $mname = $max->name;
2109         my $rname = $recurring->name;
2110         my $hdname = '';
2111         if($hard_due_date) {
2112             $hdname = $hard_due_date->name;
2113         }
2114
2115         $logger->debug("circulator: building circulation ".
2116             "with duration=$dname, maxfine=$mname, recurring=$rname, hard due date=$hdname");
2117
2118         $circ->duration($policy->{duration});
2119         $circ->recurring_fine($policy->{recurring_fine});
2120         $circ->duration_rule($duration->name);
2121         $circ->recurring_fine_rule($recurring->name);
2122         $circ->max_fine_rule($max->name);
2123         $circ->max_fine($policy->{max_fine});
2124         $circ->fine_interval($recurring->recurrence_interval);
2125         $circ->renewal_remaining($duration->max_renewals);
2126         $circ->auto_renewal_remaining($duration->max_auto_renewals);
2127         $circ->grace_period($policy->{grace_period});
2128
2129     } else {
2130
2131         $logger->info("circulator: copy found with an unlimited circ duration");
2132         $circ->duration_rule(OILS_UNLIMITED_CIRC_DURATION);
2133         $circ->recurring_fine_rule(OILS_UNLIMITED_CIRC_DURATION);
2134         $circ->max_fine_rule(OILS_UNLIMITED_CIRC_DURATION);
2135         $circ->renewal_remaining(0);
2136         $circ->grace_period(0);
2137     }
2138
2139    $circ->target_copy( $copy->id );
2140    $circ->usr( $patron->id );
2141    $circ->circ_lib( $self->circ_lib );
2142    $circ->workstation($self->editor->requestor->wsid)
2143     if defined $self->editor->requestor->wsid;
2144
2145     # renewals maintain a link to the parent circulation
2146     $circ->parent_circ($self->parent_circ);
2147
2148    if( $self->is_renewal ) {
2149       $circ->opac_renewal('t') if $self->opac_renewal;
2150       $circ->phone_renewal('t') if $self->phone_renewal;
2151       $circ->desk_renewal('t') if $self->desk_renewal;
2152       $circ->auto_renewal('t') if $self->auto_renewal;
2153       $circ->renewal_remaining($self->renewal_remaining);
2154       $circ->auto_renewal_remaining($self->auto_renewal_remaining);
2155       $circ->circ_staff($self->editor->requestor->id);
2156    }
2157
2158     # if the user provided an overiding checkout time,
2159     # (e.g. the checkout really happened several hours ago), then
2160     # we apply that here.  Does this need a perm??
2161     $circ->xact_start(clean_ISO8601($self->checkout_time))
2162         if $self->checkout_time;
2163
2164     # if a patron is renewing, 'requestor' will be the patron
2165     $circ->circ_staff($self->editor->requestor->id);
2166     $circ->due_date( $self->create_due_date($circ->duration, $duration_date_ceiling, $duration_date_ceiling_force, $circ->xact_start) ) if $circ->duration;
2167
2168     $self->circ($circ);
2169 }
2170
2171 sub do_reservation_pickup {
2172     my $self = shift;
2173
2174     $self->log_me("do_reservation_pickup()");
2175
2176     $self->reservation->pickup_time('now');
2177
2178     if (
2179         $self->reservation->current_resource &&
2180         $U->is_true($self->reservation->target_resource_type->catalog_item)
2181     ) {
2182         # We used to try to set $self->copy and $self->patron here,
2183         # but that should already be done.
2184
2185         $self->run_checkout_scripts(1);
2186
2187         my $duration   = $self->duration_rule;
2188         my $max        = $self->max_fine_rule;
2189         my $recurring  = $self->recurring_fines_rule;
2190
2191         if ($duration && $max && $recurring) {
2192             my $policy = $self->get_circ_policy($duration, $recurring, $max);
2193
2194             my $dname = $duration->name;
2195             my $mname = $max->name;
2196             my $rname = $recurring->name;
2197
2198             $logger->debug("circulator: updating reservation ".
2199                 "with duration=$dname, maxfine=$mname, recurring=$rname");
2200
2201             $self->reservation->fine_amount($policy->{recurring_fine});
2202             $self->reservation->max_fine($policy->{max_fine});
2203             $self->reservation->fine_interval($recurring->recurrence_interval);
2204         }
2205
2206         $self->copy->status(OILS_COPY_STATUS_CHECKED_OUT);
2207         $self->update_copy();
2208
2209     } else {
2210         $self->reservation->fine_amount(
2211             $self->reservation->target_resource_type->fine_amount
2212         );
2213         $self->reservation->max_fine(
2214             $self->reservation->target_resource_type->max_fine
2215         );
2216         $self->reservation->fine_interval(
2217             $self->reservation->target_resource_type->fine_interval
2218         );
2219     }
2220
2221     $self->update_reservation();
2222 }
2223
2224 sub do_reservation_return {
2225     my $self = shift;
2226     my $request = shift;
2227
2228     $self->log_me("do_reservation_return()");
2229
2230     if (not ref $self->reservation) {
2231         my ($reservation, $evt) =
2232             $U->fetch_booking_reservation($self->reservation);
2233         return $self->bail_on_events($evt) if $evt;
2234         $self->reservation($reservation);
2235     }
2236
2237     $self->handle_fines(1);
2238     $self->reservation->return_time('now');
2239     $self->update_reservation();
2240     $self->reshelve_copy if $self->copy;
2241
2242     if ( $self->reservation->current_resource && $self->reservation->current_resource->catalog_item ) {
2243         $self->copy( $self->reservation->current_resource->catalog_item );
2244     }
2245 }
2246
2247 sub booking_adjusted_due_date {
2248     my $self = shift;
2249     my $circ = $self->circ;
2250     my $copy = $self->copy;
2251
2252     return undef unless $self->use_booking;
2253
2254     my $changed;
2255
2256     if( $self->due_date ) {
2257
2258         return $self->bail_on_events($self->editor->event)
2259             unless $self->editor->allowed('CIRC_OVERRIDE_DUE_DATE', $self->circ_lib);
2260
2261        $circ->due_date(clean_ISO8601($self->due_date));
2262
2263     } else {
2264
2265         return unless $copy and $circ->due_date;
2266     }
2267
2268     my $booking_items = $self->editor->search_booking_resource( { barcode => $copy->barcode } );
2269     if (@$booking_items) {
2270         my $booking_item = $booking_items->[0];
2271         my $resource_type = $self->editor->retrieve_booking_resource_type( $booking_item->type );
2272
2273         my $stop_circ_setting = $U->ou_ancestor_setting_value( $self->circ_lib, 'circ.booking_reservation.stop_circ', $self->editor );
2274         my $shorten_circ_setting = $resource_type->elbow_room ||
2275             $U->ou_ancestor_setting_value( $self->circ_lib, 'circ.booking_reservation.default_elbow_room', $self->editor ) ||
2276             '0 seconds';
2277
2278         my $booking_ses = OpenSRF::AppSession->create( 'open-ils.booking' );
2279         my $bookings = $booking_ses->request('open-ils.booking.reservations.filtered_id_list', $self->editor->authtoken, {
2280               resource     => $booking_item->id
2281             , search_start => 'now'
2282             , search_end   => $circ->due_date
2283             , fields       => { cancel_time => undef, return_time => undef }
2284         })->gather(1);
2285         $booking_ses->disconnect;
2286
2287         throw OpenSRF::EX::ERROR ("Improper input arguments") unless defined $bookings;
2288         return $self->bail_on_events($bookings) if ref($bookings) eq 'HASH';
2289
2290         my $dt_parser = DateTime::Format::ISO8601->new;
2291         my $due_date = $dt_parser->parse_datetime( clean_ISO8601($circ->due_date) );
2292
2293         for my $bid (@$bookings) {
2294
2295             my $booking = $self->editor->retrieve_booking_reservation( $bid );
2296
2297             my $booking_start = $dt_parser->parse_datetime( clean_ISO8601($booking->start_time) );
2298             my $booking_end = $dt_parser->parse_datetime( clean_ISO8601($booking->end_time) );
2299
2300             return $self->bail_on_events( OpenILS::Event->new('COPY_RESERVED') )
2301                 if ($booking_start < DateTime->now);
2302
2303
2304             if ($U->is_true($stop_circ_setting)) {
2305                 $self->bail_on_events( OpenILS::Event->new('COPY_RESERVED') );
2306             } else {
2307                 $due_date = $booking_start->subtract( seconds => interval_to_seconds($shorten_circ_setting) );
2308                 $self->bail_on_events( OpenILS::Event->new('COPY_RESERVED') ) if ($due_date < DateTime->now);
2309             }
2310
2311             # We set the circ duration here only to affect the logic that will
2312             # later (in a DB trigger) mangle the time part of the due date to
2313             # 11:59pm. Having any circ duration that is not a whole number of
2314             # days is enough to prevent the "correction."
2315             my $new_circ_duration = $due_date->epoch - time;
2316             $new_circ_duration++ if $new_circ_duration % 86400 == 0;
2317             $circ->duration("$new_circ_duration seconds");
2318
2319             $circ->due_date(clean_ISO8601($due_date->strftime('%FT%T%z')));
2320             $changed = 1;
2321         }
2322
2323         return $self->bail_on_events($self->editor->event)
2324             unless $self->editor->allowed('CIRC_OVERRIDE_DUE_DATE', $self->circ_lib);
2325     }
2326
2327     return $changed;
2328 }
2329
2330 sub apply_modified_due_date {
2331     my $self = shift;
2332     my $shift_earlier = shift;
2333     my $circ = $self->circ;
2334     my $copy = $self->copy;
2335
2336    if( $self->due_date ) {
2337
2338         return $self->bail_on_events($self->editor->event)
2339             unless $self->editor->allowed('CIRC_OVERRIDE_DUE_DATE', $self->circ_lib);
2340
2341       $circ->due_date(clean_ISO8601($self->due_date));
2342
2343    } else {
2344
2345       # if the due_date lands on a day when the location is closed
2346       return unless $copy and $circ->due_date;
2347
2348         #my $org = (ref $copy->circ_lib) ? $copy->circ_lib->id : $copy->circ_lib;
2349
2350         # due-date overlap should be determined by the location the item
2351         # is checked out from, not the owning or circ lib of the item
2352         my $org = $self->circ_lib;
2353
2354       $logger->info("circulator: circ searching for closed date overlap on lib $org".
2355             " with an item due date of ".$circ->due_date );
2356
2357       my $dateinfo = $U->storagereq(
2358          'open-ils.storage.actor.org_unit.closed_date.overlap',
2359             $org, $circ->due_date );
2360
2361       if($dateinfo) {
2362          $logger->info("circulator: $dateinfo : circ due data / close date overlap found : due_date=".
2363             $circ->due_date." start=". $dateinfo->{start}.", end=".$dateinfo->{end});
2364
2365             # XXX make the behavior more dynamic
2366             # for now, we just push the due date to after the close date
2367             if ($shift_earlier) {
2368                 $circ->due_date($dateinfo->{start});
2369             } else {
2370                 $circ->due_date($dateinfo->{end});
2371             }
2372       }
2373    }
2374 }
2375
2376
2377
2378 sub create_due_date {
2379     my( $self, $duration, $date_ceiling, $force_date, $start_time ) = @_;
2380
2381     # Look up circulating library's TZ, or else use client TZ, falling
2382     # back to server TZ
2383     my $tz = $U->ou_ancestor_setting_value(
2384         $self->circ_lib,
2385         'lib.timezone',
2386         $self->editor
2387     ) || 'local';
2388
2389     my $due_date = $start_time ?
2390         DateTime::Format::ISO8601
2391             ->new
2392             ->parse_datetime(clean_ISO8601($start_time))
2393             ->set_time_zone($tz) :
2394         DateTime->now(time_zone => $tz);
2395
2396     # add the circ duration
2397     $due_date->add(seconds => OpenILS::Utils::DateTime->interval_to_seconds($duration, $due_date));
2398
2399     if($date_ceiling) {
2400         my $cdate = DateTime::Format::ISO8601
2401             ->new
2402             ->parse_datetime(clean_ISO8601($date_ceiling))
2403             ->set_time_zone($tz);
2404
2405         if ($cdate > DateTime->now and ($cdate < $due_date or $U->is_true( $force_date ))) {
2406             $logger->info("circulator: overriding due date with date ceiling: $date_ceiling");
2407             $due_date = $cdate;
2408         }
2409     }
2410
2411     # return ISO8601 time with timezone
2412     return $due_date->strftime('%FT%T%z');
2413 }
2414
2415
2416
2417 sub make_precat_copy {
2418     my $self = shift;
2419     my $copy = $self->copy;
2420     return $self->bail_on_events(OpenILS::Event->new('PERM_FAILURE'))
2421        unless $self->editor->allowed('CREATE_PRECAT') || $self->is_renewal;
2422
2423    if($copy) {
2424         $logger->debug("circulator: Pre-cat copy already exists in checkout: ID=" . $copy->id);
2425
2426         $copy->editor($self->editor->requestor->id);
2427         $copy->edit_date('now');
2428         $copy->dummy_title($self->dummy_title || $copy->dummy_title || '');
2429         $copy->dummy_isbn($self->dummy_isbn || $copy->dummy_isbn || '');
2430         $copy->dummy_author($self->dummy_author || $copy->dummy_author || '');
2431         $copy->circ_modifier($self->circ_modifier || $copy->circ_modifier);
2432         $self->update_copy();
2433         return;
2434    }
2435
2436     $logger->info("circulator: Creating a new precataloged ".
2437         "copy in checkout with barcode " . $self->copy_barcode);
2438
2439     $copy = Fieldmapper::asset::copy->new;
2440     $copy->circ_lib($self->circ_lib);
2441     $copy->creator($self->editor->requestor->id);
2442     $copy->editor($self->editor->requestor->id);
2443     $copy->barcode($self->copy_barcode);
2444     $copy->call_number(OILS_PRECAT_CALL_NUMBER);
2445     $copy->loan_duration(OILS_PRECAT_COPY_LOAN_DURATION);
2446     $copy->fine_level(OILS_PRECAT_COPY_FINE_LEVEL);
2447
2448     $copy->dummy_title($self->dummy_title || "");
2449     $copy->dummy_author($self->dummy_author || "");
2450     $copy->dummy_isbn($self->dummy_isbn || "");
2451     $copy->circ_modifier($self->circ_modifier);
2452
2453
2454     # See if we need to override the circ_lib for the copy with a configured circ_lib
2455     # Setting is shortname of the org unit
2456     my $precat_circ_lib = $U->ou_ancestor_setting_value(
2457         $self->circ_lib, 'circ.pre_cat_copy_circ_lib', $self->editor);
2458
2459     if($precat_circ_lib) {
2460         my $org = $self->editor->search_actor_org_unit({shortname => $precat_circ_lib})->[0];
2461
2462         if(!$org) {
2463             $self->bail_on_events($self->editor->event);
2464             return;
2465         }
2466
2467         $copy->circ_lib($org->id);
2468     }
2469
2470
2471     unless( $self->copy($self->editor->create_asset_copy($copy)) ) {
2472         $self->bail_out(1);
2473         $self->push_events($self->editor->event);
2474         return;
2475     }
2476 }
2477
2478
2479 sub checkout_noncat {
2480     my $self = shift;
2481
2482     my $circ;
2483     my $evt;
2484
2485    my $lib      = $self->noncat_circ_lib || $self->circ_lib;
2486    my $count    = $self->noncat_count || 1;
2487    my $cotime   = clean_ISO8601($self->checkout_time) || "";
2488
2489    $logger->info("circulator: circ creating $count noncat circs with checkout time $cotime");
2490
2491    for(1..$count) {
2492
2493       ( $circ, $evt ) = OpenILS::Application::Circ::NonCat::create_non_cat_circ(
2494          $self->editor->requestor->id,
2495             $self->patron->id,
2496             $lib,
2497             $self->noncat_type,
2498             $cotime,
2499             $self->editor );
2500
2501         if( $evt ) {
2502             $self->push_events($evt);
2503             $self->bail_out(1);
2504             return;
2505         }
2506         $self->circ($circ);
2507    }
2508 }
2509
2510 # if an item is in transit but the status doesn't agree, then we need to fix things.
2511 # The next two subs will hopefully do that
2512 sub fix_broken_transit_status {
2513     my $self = shift;
2514
2515     # Capture the transit so we don't have to fetch it again later during checkin
2516     # This used to live in sub check_transit_checkin_interval and later again in
2517     # do_checkin
2518     $self->transit(
2519         $self->editor->search_action_transit_copy(
2520             {target_copy => $self->copy->id, dest_recv_time => undef, cancel_time => undef}
2521         )->[0]
2522     );
2523
2524     if ($self->transit && $U->copy_status($self->copy->status)->id != OILS_COPY_STATUS_IN_TRANSIT) {
2525         $logger->warn("circulator: we have a copy ".$self->copy->barcode.
2526             " that is in-transit but without the In Transit status... fixing");
2527         $self->copy->status(OILS_COPY_STATUS_IN_TRANSIT);
2528         # FIXME - do we want to make this permanent if the checkin bails?
2529         $self->update_copy;
2530     }
2531
2532 }
2533 sub cancel_transit_if_circ_exists {
2534     my $self = shift;
2535     if ($self->circ && $self->transit) {
2536         $logger->warn("circulator: we have a copy ".$self->copy->barcode.
2537             " that is in-transit AND circulating... aborting the transit");
2538         my $circ_ses = create OpenSRF::AppSession("open-ils.circ");
2539         my $result = $circ_ses->request(
2540             "open-ils.circ.transit.abort",
2541             $self->editor->authtoken,
2542             { 'transitid' => $self->transit->id }
2543         )->gather(1);
2544         $logger->warn("circulator: transit abort result: ".$result);
2545         $circ_ses->disconnect;
2546         $self->transit(undef);
2547     }
2548 }
2549
2550 # If a copy goes into transit and is then checked in before the transit checkin
2551 # interval has expired, push an event onto the overridable events list.
2552 sub check_transit_checkin_interval {
2553     my $self = shift;
2554
2555     # only concerned with in-transit items
2556     return unless $U->copy_status($self->copy->status)->id == OILS_COPY_STATUS_IN_TRANSIT;
2557
2558     # no interval, no problem
2559     my $interval = $U->ou_ancestor_setting_value($self->circ_lib, 'circ.transit.min_checkin_interval');
2560     return unless $interval;
2561
2562     # transit from X to X for whatever reason has no min interval
2563     return if $self->transit->source == $self->transit->dest;
2564
2565     my $seconds = OpenILS::Utils::DateTime->interval_to_seconds($interval);
2566     my $t_start = DateTime::Format::ISO8601->new->parse_datetime(clean_ISO8601($self->transit->source_send_time));
2567     my $horizon = $t_start->add(seconds => $seconds);
2568
2569     # See if we are still within the transit checkin forbidden range
2570     $self->push_events(OpenILS::Event->new('TRANSIT_CHECKIN_INTERVAL_BLOCK'))
2571         if $horizon > DateTime->now;
2572 }
2573
2574 # Retarget local holds at checkin
2575 sub checkin_retarget {
2576     my $self = shift;
2577     return unless $self->retarget_mode and $self->retarget_mode =~ m/retarget/; # Retargeting?
2578     return unless $self->is_checkin; # Renewals need not be checked
2579     return if $self->capture eq 'nocapture'; # Not capturing holds anyway? Move on.
2580     return if $self->is_precat; # No holds for precats
2581     return unless $self->circ_lib == $self->copy->circ_lib; # Item isn't "home"? Don't check.
2582     return unless $U->is_true($self->copy->holdable); # Not holdable, shouldn't capture holds.
2583     my $status = $U->copy_status($self->copy->status);
2584     return unless $U->is_true($status->holdable); # Current status not holdable means no hold will ever target the item
2585     # Specifically target items that are likely new (by status ID)
2586     return unless $status->id == OILS_COPY_STATUS_IN_PROCESS || $self->retarget_mode =~ m/\.all/;
2587     my $location = $self->copy->location;
2588     if(!ref($location)) {
2589         $location = $self->editor->retrieve_asset_copy_location($self->copy->location);
2590         $self->copy->location($location);
2591     }
2592     return unless $U->is_true($location->holdable); # Don't bother on non-holdable locations
2593
2594     # Fetch holds for the bib
2595     my ($result) = $holdcode->method_lookup('open-ils.circ.holds.retrieve_all_from_title')->run(
2596                     $self->editor->authtoken,
2597                     $self->title->id,
2598                     {
2599                         capture_time => undef, # No touching captured holds
2600                         frozen => 'f', # Don't bother with frozen holds
2601                         pickup_lib => $self->circ_lib # Only holds actually here
2602                     });
2603
2604     # Error? Skip the step.
2605     return if exists $result->{"ilsevent"};
2606
2607     # Assemble holds
2608     my $holds = [];
2609     foreach my $holdlist (keys %{$result}) {
2610         push @$holds, @{$result->{$holdlist}};
2611     }
2612
2613     return if scalar(@$holds) == 0; # No holds, no retargeting
2614
2615     # Check for parts on this copy
2616     my $parts = $self->editor->search_asset_copy_part_map({ target_copy => $self->copy->id });
2617     my %parts_hash = ();
2618     %parts_hash = map {$_->part, 1} @$parts if @$parts;
2619
2620     # Loop over holds in request-ish order
2621     # Stage 1: Get them into request-ish order
2622     # Also grab type and target for skipping low hanging ones
2623     $result = $self->editor->json_query({
2624         "select" => { "ahr" => ["id", "hold_type", "target"] },
2625         "from" => { "ahr" => { "au" => { "fkey" => "usr",  "join" => "pgt"} } },
2626         "where" => { "id" => $holds },
2627         "order_by" => [
2628             { "class" => "pgt", "field" => "hold_priority"},
2629             { "class" => "ahr", "field" => "cut_in_line", "direction" => "desc", "transform" => "coalesce", "params" => ['f']},
2630             { "class" => "ahr", "field" => "selection_depth", "direction" => "desc"},
2631             { "class" => "ahr", "field" => "request_time"}
2632         ]
2633     });
2634
2635     # Stage 2: Loop!
2636     if (ref $result eq "ARRAY" and scalar @$result) {
2637         foreach (@{$result}) {
2638             # Copy level, but not this copy?
2639             next if ($_->{hold_type} eq 'C' or $_->{hold_type} eq 'R' or $_->{hold_type} eq 'F'
2640                 and $_->{target} != $self->copy->id);
2641             # Volume level, but not this volume?
2642             next if ($_->{hold_type} eq 'V' and $_->{target} != $self->volume->id);
2643             if(@$parts) { # We have parts?
2644                 # Skip title holds
2645                 next if ($_->{hold_type} eq 'T');
2646                 # Skip part holds for parts not on this copy
2647                 next if ($_->{hold_type} eq 'P' and not $parts_hash{$_->{target}});
2648             } else {
2649                 # No parts, no part holds
2650                 next if ($_->{hold_type} eq 'P');
2651             }
2652             # So much for easy stuff, attempt a retarget!
2653             my $tresult = $U->simplereq(
2654                 'open-ils.hold-targeter',
2655                 'open-ils.hold-targeter.target',
2656                 {hold => $_->{id}, find_copy => $self->copy->id}
2657             );
2658             if(ref $tresult eq "ARRAY" and scalar @$tresult) {
2659                 last if(exists $tresult->[0]->{found_copy} and $tresult->[0]->{found_copy});
2660             }
2661         }
2662     }
2663 }
2664
2665 sub do_checkin {
2666     my $self = shift;
2667     $self->log_me("do_checkin()");
2668
2669     return $self->bail_on_events(
2670         OpenILS::Event->new('ASSET_COPY_NOT_FOUND'))
2671         unless $self->copy;
2672
2673     # Never capture a deleted copy for a hold.
2674     $self->capture('nocapture') if $U->is_true($self->copy->deleted);
2675
2676     $self->fix_broken_transit_status; # if applicable
2677     $self->check_transit_checkin_interval;
2678     $self->checkin_retarget;
2679
2680     # the renew code and mk_env should have already found our circulation object
2681     unless( $self->circ ) {
2682
2683         my $circs = $self->editor->search_action_circulation(
2684             { target_copy => $self->copy->id, checkin_time => undef });
2685
2686         $self->circ($$circs[0]);
2687
2688         # for now, just warn if there are multiple open circs on a copy
2689         $logger->warn("circulator: we have ".scalar(@$circs).
2690             " open circs for copy " .$self->copy->id."!!") if @$circs > 1;
2691     }
2692     $self->cancel_transit_if_circ_exists; # if applicable
2693
2694     my $stat = $U->copy_status($self->copy->status)->id;
2695
2696     # LOST (and to some extent, LONGOVERDUE) may optionally be handled
2697     # differently if they are already paid for.  We need to check for this
2698     # early since overdue generation is potentially affected.
2699     my $dont_change_lost_zero = 0;
2700     if ($stat == OILS_COPY_STATUS_LOST
2701         || $stat == OILS_COPY_STATUS_LOST_AND_PAID
2702         || $stat == OILS_COPY_STATUS_LONG_OVERDUE) {
2703
2704         # LOST fine settings are controlled by the copy's circ lib, not the the
2705         # circulation's
2706         my $copy_circ_lib = (ref $self->copy->circ_lib) ?
2707                 $self->copy->circ_lib->id : $self->copy->circ_lib;
2708         $dont_change_lost_zero = $U->ou_ancestor_setting_value(
2709             $copy_circ_lib, 'circ.checkin.lost_zero_balance.do_not_change',
2710             $self->editor) || 0;
2711
2712         # Don't assume there's always a circ based on copy status
2713         if ($dont_change_lost_zero && $self->circ) {
2714             my ($obt) = $U->fetch_mbts($self->circ->id, $self->editor);
2715             $dont_change_lost_zero = 0 if( $obt and $obt->balance_owed != 0 );
2716         }
2717
2718         $self->dont_change_lost_zero($dont_change_lost_zero);
2719     }
2720
2721     # Check if the copy can float to here. We need this for inventory
2722     # and to see if the copy needs to transit or stay here later.
2723     my $can_float = 0;
2724     if ($self->copy->floating) {
2725         my $res = $self->editor->json_query(
2726             {   from =>
2727                 [
2728                     'evergreen.can_float',
2729                     $self->copy->floating->id,
2730                     $self->copy->circ_lib,
2731                     $self->circ_lib
2732                 ]
2733             }
2734         );
2735         $can_float = $U->is_true($res->[0]->{'evergreen.can_float'}) if $res;
2736     }
2737
2738     # Do copy inventory if necessary.
2739     if ($self->do_inventory_update && ($self->circ_lib == $self->copy->circ_lib || $can_float)) {
2740         my $aci = Fieldmapper::asset::copy_inventory->new();
2741         $aci->inventory_date('now');
2742         $aci->inventory_workstation($self->editor->requestor->wsid);
2743         $aci->copy($self->copy->id());
2744         $self->editor->create_asset_copy_inventory($aci);
2745         $self->checkin_changed(1);
2746     }
2747
2748     if( $self->checkin_check_holds_shelf() ) {
2749         $self->bail_on_events(OpenILS::Event->new('NO_CHANGE'));
2750         $self->hold($U->fetch_open_hold_by_copy($self->copy->id));
2751         if($self->fake_hold_dest) {
2752             $self->hold->pickup_lib($self->circ_lib);
2753         }
2754         $self->checkin_flesh_events;
2755         return;
2756     }
2757
2758     unless( $self->is_renewal ) {
2759         return $self->bail_on_events($self->editor->event)
2760             unless $self->editor->allowed('COPY_CHECKIN');
2761     }
2762
2763     $self->push_events($self->check_copy_alert());
2764     $self->push_events($self->check_checkin_copy_status());
2765
2766     # if the circ is marked as 'claims returned', add the event to the list
2767     $self->push_events(OpenILS::Event->new('CIRC_CLAIMS_RETURNED'))
2768         if ($self->circ and $self->circ->stop_fines
2769                 and $self->circ->stop_fines eq OILS_STOP_FINES_CLAIMSRETURNED);
2770
2771     $self->check_circ_deposit();
2772
2773     # handle the overridable events
2774     $self->override_events unless $self->is_renewal;
2775     return if $self->bail_out;
2776
2777     if( $self->circ ) {
2778         $self->checkin_handle_circ_start;
2779         return if $self->bail_out;
2780
2781         if (!$dont_change_lost_zero) {
2782             # if this circ is LOST and we are configured to generate overdue
2783             # fines for lost items on checkin (to fill the gap between mark
2784             # lost time and when the fines would have naturally stopped), then
2785             # stop_fines is no longer valid and should be cleared.
2786             #
2787             # stop_fines will be set again during the handle_fines() stage.
2788             # XXX should this setting come from the copy circ lib (like other
2789             # LOST settings), instead of the circulation circ lib?
2790             if ($stat == OILS_COPY_STATUS_LOST) {
2791                 $self->circ->clear_stop_fines if
2792                     $U->ou_ancestor_setting_value(
2793                         $self->circ_lib,
2794                         OILS_SETTING_GENERATE_OVERDUE_ON_LOST_RETURN,
2795                         $self->editor
2796                     );
2797             }
2798
2799             # Set stop_fines when claimed never checked out
2800             $self->circ->stop_fines( OILS_STOP_FINES_CLAIMS_NEVERCHECKEDOUT ) if( $self->claims_never_checked_out );
2801
2802             # handle fines for this circ, including overdue gen if needed
2803             $self->handle_fines;
2804         }
2805
2806         # Void any item deposits if the library wants to
2807         $self->check_circ_deposit(1);
2808
2809         $self->checkin_handle_circ_finish;
2810         return if $self->bail_out;
2811         $self->checkin_changed(1);
2812
2813     } elsif( $self->transit ) {
2814         my $hold_transit = $self->process_received_transit;
2815         $self->checkin_changed(1);
2816
2817         if( $self->bail_out ) {
2818             $self->checkin_flesh_events;
2819             return;
2820         }
2821
2822         if( my $e = $self->check_checkin_copy_status() ) {
2823             # If the original copy status is special, alert the caller
2824             my $ev = $self->events;
2825             $self->events([$e]);
2826             $self->override_events;
2827             return if $self->bail_out;
2828             $self->events($ev);
2829         }
2830
2831         if( $hold_transit or
2832                 $U->copy_status($self->copy->status)->id
2833                     == OILS_COPY_STATUS_ON_HOLDS_SHELF ) {
2834
2835             my $hold;
2836             if( $hold_transit ) {
2837                $hold = $self->editor->retrieve_action_hold_request($hold_transit->hold);
2838             } else {
2839                    ($hold) = $U->fetch_open_hold_by_copy($self->copy->id);
2840             }
2841
2842             $self->hold($hold);
2843
2844             if( $hold and ( $hold->cancel_time or $hold->fulfillment_time ) ) { # this transited hold was cancelled or filled mid-transit
2845
2846                 $logger->info("circulator: we received a transit on a cancelled or filled hold " . $hold->id);
2847                 $self->reshelve_copy(1);
2848                 $self->cancelled_hold_transit(1);
2849                 $self->notify_hold(0); # don't notify for cancelled holds
2850                 $self->fake_hold_dest(0);
2851                 return if $self->bail_out;
2852
2853             } elsif ($hold and $hold->hold_type eq 'R') {
2854
2855                 $self->copy->status(OILS_COPY_STATUS_CATALOGING);
2856                 $self->notify_hold(0); # No need to notify
2857                 $self->fake_hold_dest(0);
2858                 $self->noop(1); # Don't try and capture for other holds/transits now
2859                 $self->update_copy();
2860                 $hold->fulfillment_time('now');
2861                 $self->bail_on_events($self->editor->event)
2862                     unless $self->editor->update_action_hold_request($hold);
2863
2864             } else {
2865
2866                 # hold transited to correct location
2867                 if($self->fake_hold_dest) {
2868                     $hold->pickup_lib($self->circ_lib);
2869                 }
2870                 $self->checkin_flesh_events;
2871                 return;
2872             }
2873         }
2874
2875     } elsif( $U->copy_status($self->copy->status)->id == OILS_COPY_STATUS_IN_TRANSIT ) {
2876
2877         $logger->warn("circulator: we have a copy ".$self->copy->barcode.
2878             " that is in-transit, but there is no transit.. repairing");
2879         $self->reshelve_copy(1);
2880         return if $self->bail_out;
2881     }
2882
2883     if( $self->is_renewal ) {
2884         $self->finish_fines_and_voiding;
2885         return if $self->bail_out;
2886         $self->push_events(OpenILS::Event->new('SUCCESS'));
2887         return;
2888     }
2889
2890    # ------------------------------------------------------------------------------
2891    # Circulations and transits are now closed where necessary.  Now go on to see if
2892    # this copy can fulfill a hold or needs to be routed to a different location
2893    # ------------------------------------------------------------------------------
2894
2895     my $needed_for_something = 0; # formerly "needed_for_hold"
2896
2897     if(!$self->noop) { # /not/ a no-op checkin, capture for hold or put item into transit
2898
2899         if (!$self->remote_hold) {
2900             if ($self->use_booking) {
2901                 my $potential_hold = $self->hold_capture_is_possible;
2902                 my $potential_reservation = $self->reservation_capture_is_possible;
2903
2904                 if ($potential_hold and $potential_reservation) {
2905                     $logger->info("circulator: item could fulfill either hold or reservation");
2906                     $self->push_events(new OpenILS::Event(
2907                         "HOLD_RESERVATION_CONFLICT",
2908                         "hold" => $potential_hold,
2909                         "reservation" => $potential_reservation
2910                     ));
2911                     return if $self->bail_out;
2912                 } elsif ($potential_hold) {
2913                     $needed_for_something =
2914                         $self->attempt_checkin_hold_capture;
2915                 } elsif ($potential_reservation) {
2916                     $needed_for_something =
2917                         $self->attempt_checkin_reservation_capture;
2918                 }
2919             } else {
2920                 $needed_for_something = $self->attempt_checkin_hold_capture;
2921             }
2922         }
2923         return if $self->bail_out;
2924
2925         unless($needed_for_something) {
2926             my $circ_lib = (ref $self->copy->circ_lib) ?
2927                     $self->copy->circ_lib->id : $self->copy->circ_lib;
2928
2929             if( $self->remote_hold ) {
2930                 $circ_lib = $self->remote_hold->pickup_lib;
2931                 $logger->warn("circulator: Copy ".$self->copy->barcode.
2932                     " is on a remote hold's shelf, sending to $circ_lib");
2933             }
2934
2935             $logger->debug("circulator: circlib=$circ_lib, workstation=".$self->circ_lib);
2936
2937             my $suppress_transit = 0;
2938
2939             if( $circ_lib != $self->circ_lib and not ($self->hold_as_transit and $self->remote_hold) ) {
2940                 my $suppress_transit_source = $U->ou_ancestor_setting($self->circ_lib, 'circ.transit.suppress_non_hold');
2941                 if($suppress_transit_source && $suppress_transit_source->{value}) {
2942                     my $suppress_transit_dest = $U->ou_ancestor_setting($circ_lib, 'circ.transit.suppress_non_hold');
2943                     if($suppress_transit_dest && $suppress_transit_source->{value} eq $suppress_transit_dest->{value}) {
2944                         $logger->info("circulator: copy is within transit suppress group: ".$self->copy->barcode." ".$suppress_transit_source->{value});
2945                         $suppress_transit = 1;
2946                     }
2947                 }
2948             }
2949
2950             if( $suppress_transit or ( $circ_lib == $self->circ_lib and not ($self->hold_as_transit and $self->remote_hold) ) ) {
2951                 # copy is where it needs to be, either for hold or reshelving
2952
2953                 $self->checkin_handle_precat();
2954                 return if $self->bail_out;
2955
2956             } else {
2957                 # copy needs to transit "home", or stick here if it's a floating copy
2958                 if ($can_float && ($self->manual_float || !$U->is_true($self->copy->floating->manual)) && !$self->remote_hold) { # Yep, floating, stick here
2959                     $self->checkin_changed(1);
2960                     $self->copy->circ_lib( $self->circ_lib );
2961                     $self->update_copy;
2962                 } else {
2963                     my $bc = $self->copy->barcode;
2964                     $logger->info("circulator: copy $bc at the wrong location, sending to $circ_lib");
2965                     $self->checkin_build_copy_transit($circ_lib);
2966                     return if $self->bail_out;
2967                     $self->push_events(OpenILS::Event->new('ROUTE_ITEM', org => $circ_lib));
2968                 }
2969             }
2970         }
2971     } else { # no-op checkin
2972         # XXX floating items still stick where they are even with no-op checkin?
2973         if ($self->copy->floating && $can_float) {
2974             $self->checkin_changed(1);
2975             $self->copy->circ_lib( $self->circ_lib );
2976             $self->update_copy;
2977         }
2978     }
2979
2980     if($self->claims_never_checked_out and
2981             $U->ou_ancestor_setting_value($self->circ->circ_lib, 'circ.claim_never_checked_out.mark_missing')) {
2982
2983         # the item was not supposed to be checked out to the user and should now be marked as missing
2984         my $next_status = $self->next_copy_status->[0] || OILS_COPY_STATUS_MISSING;
2985         $self->copy->status($next_status);
2986         $self->update_copy;
2987
2988     } else {
2989         $self->reshelve_copy unless $needed_for_something;
2990     }
2991
2992     return if $self->bail_out;
2993
2994     unless($self->checkin_changed) {
2995
2996         $self->push_events(OpenILS::Event->new('NO_CHANGE'));
2997         my $stat = $U->copy_status($self->copy->status)->id;
2998
2999         $self->hold($U->fetch_open_hold_by_copy($self->copy->id))
3000          if( $stat == OILS_COPY_STATUS_ON_HOLDS_SHELF );
3001         $self->bail_out(1); # no need to commit anything
3002
3003     } else {
3004
3005         $self->push_events(OpenILS::Event->new('SUCCESS'))
3006             unless @{$self->events};
3007     }
3008
3009     $self->finish_fines_and_voiding;
3010
3011     OpenILS::Utils::Penalty->calculate_penalties(
3012         $self->editor, $self->patron->id, $self->circ_lib) if $self->patron;
3013
3014     $self->checkin_flesh_events;
3015     return;
3016 }
3017
3018 sub finish_fines_and_voiding {
3019     my $self = shift;
3020     return unless $self->circ;
3021
3022     return unless $self->backdate or $self->void_overdues;
3023
3024     # void overdues after fine generation to prevent concurrent DB access to overdue billings
3025     my $note = 'System: Amnesty Checkin' if $self->void_overdues;
3026
3027     my $evt = $CC->void_or_zero_overdues(
3028         $self->editor, $self->circ, {backdate => $self->void_overdues ? undef : $self->backdate, note => $note});
3029
3030     return $self->bail_on_events($evt) if $evt;
3031
3032     # Make sure the circ is open or closed as necessary.
3033     $evt = $U->check_open_xact($self->editor, $self->circ->id);
3034     return $self->bail_on_events($evt) if $evt;
3035
3036     return undef;
3037 }
3038
3039
3040 # if a deposit was paid for this item, push the event
3041 # if called with a truthy param perform the void, depending on settings
3042 sub check_circ_deposit {
3043     my $self = shift;
3044     my $void = shift;
3045
3046     return unless $self->circ;
3047
3048     my $deposit = $self->editor->search_money_billing(
3049         {   btype => 5,
3050             xact => $self->circ->id,
3051             voided => 'f'
3052         }, {idlist => 1})->[0];
3053
3054     return unless $deposit;
3055
3056     if ($void) {
3057          my $void_on_checkin = $U->ou_ancestor_setting_value(
3058              $self->circ_lib,OILS_SETTING_VOID_ITEM_DEPOSIT_ON_CHECKIN,$self->editor);
3059          if ( $void_on_checkin ) {
3060             my $evt = $CC->void_bills($self->editor,[$deposit], "DEPOSIT ITEM RETURNED");
3061             return $evt if $evt;
3062         }
3063     } else { # if void is unset this is just a check, notify that there was a deposit billing
3064         $self->push_events(OpenILS::Event->new('ITEM_DEPOSIT_PAID', payload => $deposit));
3065     }
3066 }
3067
3068 sub reshelve_copy {
3069    my $self    = shift;
3070    my $force   = $self->force || shift;
3071    my $copy    = $self->copy;
3072
3073    my $stat = $U->copy_status($copy->status)->id;
3074
3075    my $next_status = $self->next_copy_status->[0] || OILS_COPY_STATUS_RESHELVING;
3076
3077    if($force || (
3078       $stat != OILS_COPY_STATUS_ON_HOLDS_SHELF and
3079       $stat != OILS_COPY_STATUS_CATALOGING and
3080       $stat != OILS_COPY_STATUS_IN_TRANSIT and
3081       $stat != $next_status  )) {
3082
3083         $copy->status( $next_status );
3084             $self->update_copy;
3085             $self->checkin_changed(1);
3086     }
3087 }
3088
3089
3090 # Returns true if the item is at the current location
3091 # because it was transited there for a hold and the
3092 # hold has not been fulfilled
3093 sub checkin_check_holds_shelf {
3094     my $self = shift;
3095     return 0 unless $self->copy;
3096
3097     return 0 unless
3098         $U->copy_status($self->copy->status)->id ==
3099             OILS_COPY_STATUS_ON_HOLDS_SHELF;
3100
3101     # Attempt to clear shelf expired holds for this copy
3102     $holdcode->method_lookup('open-ils.circ.hold.clear_shelf.process')->run($self->editor->authtoken, $self->circ_lib, $self->copy->id)
3103         if($self->clear_expired);
3104
3105     # find the hold that put us on the holds shelf
3106     my $holds = $self->editor->search_action_hold_request(
3107         {
3108             current_copy => $self->copy->id,
3109             capture_time => { '!=' => undef },
3110             fulfillment_time => undef,
3111             cancel_time => undef,
3112         }
3113     );
3114
3115     unless(@$holds) {
3116         $logger->warn("circulator: copy is on-holds-shelf, but there is no hold - reshelving");
3117         $self->reshelve_copy(1);
3118         return 0;
3119     }
3120
3121     my $hold = $$holds[0];
3122
3123     $logger->info("circulator: we found a captured, un-fulfilled hold [".
3124         $hold->id. "] for copy ".$self->copy->barcode);
3125
3126     if( $hold->pickup_lib != $self->circ_lib and not $self->hold_as_transit ) {
3127         my $suppress_transit_circ = $U->ou_ancestor_setting($self->circ_lib, 'circ.transit.suppress_hold');
3128         if($suppress_transit_circ && $suppress_transit_circ->{value}) {
3129             my $suppress_transit_pickup = $U->ou_ancestor_setting($hold->pickup_lib, 'circ.transit.suppress_hold');
3130             if($suppress_transit_pickup && $suppress_transit_circ->{value} eq $suppress_transit_pickup->{value}) {
3131                 $logger->info("circulator: hold is within hold transit suppress group .. we're done: ".$self->copy->barcode." ".$suppress_transit_circ->{value});
3132                 $self->fake_hold_dest(1);
3133                 return 1;
3134             }
3135         }
3136     }
3137
3138     if( $hold->pickup_lib == $self->circ_lib and not $self->hold_as_transit ) {
3139         $logger->info("circulator: hold is for here .. we're done: ".$self->copy->barcode);
3140         return 1;
3141     }
3142
3143     $logger->info("circulator: hold is not for here..");
3144     $self->remote_hold($hold);
3145     return 0;
3146 }
3147
3148
3149 sub checkin_handle_precat {
3150     my $self    = shift;
3151    my $copy    = $self->copy;
3152
3153    if( $self->is_precat and ($copy->status != OILS_COPY_STATUS_CATALOGING) ) {
3154         $copy->status(OILS_COPY_STATUS_CATALOGING);
3155         $self->update_copy();
3156         $self->checkin_changed(1);
3157         $self->push_events(OpenILS::Event->new('ITEM_NOT_CATALOGED'));
3158    }
3159 }
3160
3161
3162 sub checkin_build_copy_transit {
3163     my $self            = shift;
3164     my $dest            = shift;
3165     my $copy       = $self->copy;
3166     my $transit    = Fieldmapper::action::transit_copy->new;
3167
3168     # if we are transiting an item to the shelf shelf, it's a hold transit
3169     if (my $hold = $self->remote_hold) {
3170         $transit = Fieldmapper::action::hold_transit_copy->new;
3171         $transit->hold($hold->id);
3172
3173         # the item is going into transit, remove any shelf-iness
3174         if ($hold->current_shelf_lib or $hold->shelf_time) {
3175             $hold->clear_current_shelf_lib;
3176             $hold->clear_shelf_time;
3177             return $self->bail_on_events($self->editor->event)
3178                 unless $self->editor->update_action_hold_request($hold);
3179         }
3180     }
3181
3182     #$dest  ||= (ref($copy->circ_lib)) ? $copy->circ_lib->id : $copy->circ_lib;
3183     $logger->info("circulator: transiting copy to $dest");
3184
3185     $transit->source($self->circ_lib);
3186     $transit->dest($dest);
3187     $transit->target_copy($copy->id);
3188     $transit->source_send_time('now');
3189     $transit->copy_status( $U->copy_status($copy->status)->id );
3190
3191     $logger->debug("circulator: setting copy status on transit: ".$transit->copy_status);
3192
3193     if ($self->remote_hold) {
3194         return $self->bail_on_events($self->editor->event)
3195             unless $self->editor->create_action_hold_transit_copy($transit);
3196     } else {
3197         return $self->bail_on_events($self->editor->event)
3198             unless $self->editor->create_action_transit_copy($transit);
3199     }
3200
3201     # ensure the transit is returned to the caller
3202     $self->transit($transit);
3203
3204     $copy->status(OILS_COPY_STATUS_IN_TRANSIT);
3205     $self->update_copy;
3206     $self->checkin_changed(1);
3207 }
3208
3209
3210 sub hold_capture_is_possible {
3211     my $self = shift;
3212     my $copy = $self->copy;
3213
3214     # we've been explicitly told not to capture any holds
3215     return 0 if $self->capture eq 'nocapture';
3216
3217     # See if this copy can fulfill any holds
3218     my $hold = $holdcode->find_nearest_permitted_hold(
3219         $self->editor, $copy, $self->editor->requestor, 1 # check_only
3220     );
3221     return undef if ref $hold eq "HASH" and
3222         $hold->{"textcode"} eq "ACTION_HOLD_REQUEST_NOT_FOUND";
3223     return $hold;
3224 }
3225
3226 sub reservation_capture_is_possible {
3227     my $self = shift;
3228     my $copy = $self->copy;
3229
3230     # we've been explicitly told not to capture any holds
3231     return 0 if $self->capture eq 'nocapture';
3232
3233     my $booking_ses = OpenSRF::AppSession->connect("open-ils.booking");
3234     my $resv = $booking_ses->request(
3235         "open-ils.booking.reservations.could_capture",
3236         $self->editor->authtoken, $copy->barcode
3237     )->gather(1);
3238     $booking_ses->disconnect;
3239     if (ref($resv) eq "HASH" and exists $resv->{"textcode"}) {
3240         $self->push_events($resv);
3241     } else {
3242         return $resv;
3243     }
3244 }
3245
3246 # returns true if the item was used (or may potentially be used
3247 # in subsequent calls) to capture a hold.
3248 sub attempt_checkin_hold_capture {
3249     my $self = shift;
3250     my $copy = $self->copy;
3251
3252     # we've been explicitly told not to capture any holds
3253     return 0 if $self->capture eq 'nocapture';
3254
3255     # See if this copy can fulfill any holds
3256     my ($hold, undef, $retarget) = $holdcode->find_nearest_permitted_hold(
3257         $self->editor, $copy, $self->editor->requestor );
3258
3259     if(!$hold) {
3260         $logger->debug("circulator: no potential permitted".
3261             "holds found for copy ".$copy->barcode);
3262         return 0;
3263     }
3264
3265     if($self->capture ne 'capture') {
3266         # see if this item is in a hold-capture-delay location
3267         my $location = $self->copy->location;
3268         if(!ref($location)) {
3269             $location = $self->editor->retrieve_asset_copy_location($self->copy->location);
3270             $self->copy->location($location);
3271         }
3272         if($U->is_true($location->hold_verify)) {
3273             $self->bail_on_events(
3274                 OpenILS::Event->new('HOLD_CAPTURE_DELAYED', copy_location => $location));
3275             return 1;
3276         }
3277     }
3278
3279     $self->retarget($retarget);
3280
3281     my $suppress_transit = 0;
3282     if( $hold->pickup_lib != $self->circ_lib and not $self->hold_as_transit ) {
3283         my $suppress_transit_circ = $U->ou_ancestor_setting($self->circ_lib, 'circ.transit.suppress_hold');
3284         if($suppress_transit_circ && $suppress_transit_circ->{value}) {
3285             my $suppress_transit_pickup = $U->ou_ancestor_setting($hold->pickup_lib, 'circ.transit.suppress_hold');
3286             if($suppress_transit_pickup && $suppress_transit_circ->{value} eq $suppress_transit_pickup->{value}) {
3287                 $suppress_transit = 1;
3288                 $hold->pickup_lib($self->circ_lib);
3289             }
3290         }
3291     }
3292
3293     $logger->info("circulator: found permitted hold ".$hold->id." for copy, capturing...");
3294
3295     $hold->current_copy($copy->id);
3296     $hold->capture_time('now');
3297     $self->put_hold_on_shelf($hold)
3298         if ($suppress_transit || ($hold->pickup_lib == $self->circ_lib and not $self->hold_as_transit) );
3299
3300     # prevent DB errors caused by fetching
3301     # holds from storage, and updating through cstore
3302     $hold->clear_fulfillment_time;
3303     $hold->clear_fulfillment_staff;
3304     $hold->clear_fulfillment_lib;
3305     $hold->clear_expire_time;
3306     $hold->clear_cancel_time;
3307     $hold->clear_prev_check_time unless $hold->prev_check_time;
3308
3309     $self->bail_on_events($self->editor->event)
3310         unless $self->editor->update_action_hold_request($hold);
3311     $self->hold($hold);
3312     $self->checkin_changed(1);
3313
3314     return 0 if $self->bail_out;
3315
3316     if( $suppress_transit or ( $hold->pickup_lib == $self->circ_lib && not $self->hold_as_transit ) ) {
3317
3318         if ($hold->hold_type eq 'R') {
3319             $copy->status(OILS_COPY_STATUS_CATALOGING);
3320             $hold->fulfillment_time('now');
3321             $self->noop(1); # Block other transit/hold checks
3322             $self->bail_on_events($self->editor->event)
3323                 unless $self->editor->update_action_hold_request($hold);
3324         } else {
3325             # This hold was captured in the correct location
3326             $copy->status(OILS_COPY_STATUS_ON_HOLDS_SHELF);
3327             $self->push_events(OpenILS::Event->new('SUCCESS'));
3328
3329             #$self->do_hold_notify($hold->id);
3330             $self->notify_hold($hold->id);
3331         }
3332
3333     } else {
3334
3335         # Hold needs to be picked up elsewhere.  Build a hold
3336         # transit and route the item.
3337         $self->checkin_build_hold_transit();
3338         $copy->status(OILS_COPY_STATUS_IN_TRANSIT);
3339         return 0 if $self->bail_out;
3340         $self->push_events(OpenILS::Event->new('ROUTE_ITEM', org => $hold->pickup_lib));
3341     }
3342
3343     # make sure we save the copy status
3344     $self->update_copy;
3345     return 0 if $copy->status == OILS_COPY_STATUS_CATALOGING;
3346     return 1;
3347 }
3348
3349 sub attempt_checkin_reservation_capture {
3350     my $self = shift;
3351     my $copy = $self->copy;
3352
3353     # we've been explicitly told not to capture any holds
3354     return 0 if $self->capture eq 'nocapture';
3355
3356     my $booking_ses = OpenSRF::AppSession->connect("open-ils.booking");
3357     my $evt = $booking_ses->request(
3358         "open-ils.booking.resources.capture_for_reservation",
3359         $self->editor->authtoken,
3360         $copy->barcode,
3361         1 # don't update copy - we probably have it locked
3362     )->gather(1);
3363     $booking_ses->disconnect;
3364
3365     if (ref($evt) ne "HASH" or not exists $evt->{"textcode"}) {
3366         $logger->warn(
3367             "open-ils.booking.resources.capture_for_reservation " .
3368             "didn't return an event!"
3369         );
3370     } else {
3371         if (
3372             $evt->{"textcode"} eq "RESERVATION_NOT_FOUND" and
3373             $evt->{"payload"}->{"fail_cause"} eq "not-transferable"
3374         ) {
3375             # not-transferable is an error event we'll pass on the user
3376             $logger->warn("reservation capture attempted against non-transferable item");
3377             $self->push_events($evt);
3378             return 0;
3379         } elsif ($evt->{"textcode"} eq "SUCCESS") {
3380             # Re-retrieve copy as reservation capture may have changed
3381             # its status and whatnot.
3382             $logger->info(
3383                 "circulator: booking capture win on copy " . $self->copy->id
3384             );
3385             if (my $new_copy_status = $evt->{"payload"}->{"new_copy_status"}) {
3386                 $logger->info(
3387                     "circulator: changing copy " . $self->copy->id .
3388                     "'s status from " . $self->copy->status . " to " .
3389                     $new_copy_status
3390                 );
3391                 $self->copy->status($new_copy_status);
3392                 $self->update_copy;
3393             }
3394             $self->reservation($evt->{"payload"}->{"reservation"});
3395
3396             if (exists $evt->{"payload"}->{"transit"}) {
3397                 $self->push_events(
3398                     new OpenILS::Event(
3399                         "ROUTE_ITEM",
3400                         "org" => $evt->{"payload"}->{"transit"}->dest
3401                     )
3402                 );
3403             }
3404             $self->checkin_changed(1);
3405             return 1;
3406         }
3407     }
3408     # other results are treated as "nothing to capture"
3409     return 0;
3410 }
3411
3412 sub do_hold_notify {
3413     my( $self, $holdid ) = @_;
3414
3415     my $e = new_editor(xact => 1);
3416     my $hold = $e->retrieve_action_hold_request($holdid) or return $e->die_event;
3417     $e->rollback;
3418     my $ses = OpenSRF::AppSession->create('open-ils.trigger');
3419     $ses->request('open-ils.trigger.event.autocreate', 'hold.available', $hold, $hold->pickup_lib);
3420
3421     $logger->info("circulator: running delayed hold notify process");
3422
3423 #   my $notifier = OpenILS::Application::Circ::HoldNotify->new(
3424 #       hold_id => $holdid, editor => new_editor(requestor=>$self->editor->requestor));
3425
3426     my $notifier = OpenILS::Application::Circ::HoldNotify->new(
3427         hold_id => $holdid, requestor => $self->editor->requestor);
3428
3429     $logger->debug("circulator: built hold notifier");
3430
3431     if(!$notifier->event) {
3432
3433         $logger->info("circulator: attempt at sending hold notification for hold $holdid");
3434
3435         my $stat = $notifier->send_email_notify;
3436         if( $stat == '1' ) {
3437             $logger->info("circulator: hold notify succeeded for hold $holdid");
3438             return;
3439         }
3440
3441         $logger->debug("circulator:  * hold notify cancelled or failed for hold $holdid");
3442
3443     } else {
3444         $logger->info("circulator: Not sending hold notification since the patron has no email address");
3445     }
3446 }
3447
3448 sub retarget_holds {
3449     my $self = shift;
3450     $logger->info("circulator: retargeting holds @{$self->retarget} after opportunistic capture");
3451     my $ses = OpenSRF::AppSession->create('open-ils.hold-targeter');
3452     $ses->request('open-ils.hold-targeter.target', {hold => $self->retarget});
3453     # no reason to wait for the return value
3454     return;
3455 }
3456
3457 sub checkin_build_hold_transit {
3458     my $self = shift;
3459
3460    my $copy = $self->copy;
3461    my $hold = $self->hold;
3462    my $trans = Fieldmapper::action::hold_transit_copy->new;
3463
3464     $logger->debug("circulator: building hold transit for ".$copy->barcode);
3465
3466    $trans->hold($hold->id);
3467    $trans->source($self->circ_lib);
3468    $trans->dest($hold->pickup_lib);
3469    $trans->source_send_time("now");
3470    $trans->target_copy($copy->id);
3471
3472     # when the copy gets to its destination, it will recover
3473     # this status - put it onto the holds shelf
3474    $trans->copy_status(OILS_COPY_STATUS_ON_HOLDS_SHELF);
3475
3476     return $self->bail_on_events($self->editor->event)
3477         unless $self->editor->create_action_hold_transit_copy($trans);
3478 }
3479
3480
3481
3482 sub process_received_transit {
3483     my $self = shift;
3484     my $copy = $self->copy;
3485     my $copyid = $self->copy->id;
3486
3487     my $status_name = $U->copy_status($copy->status)->name;
3488     $logger->debug("circulator: attempting transit receive on ".
3489         "copy $copyid. Copy status is $status_name");
3490
3491     my $transit = $self->transit;
3492
3493     # Check if we are in a transit suppress range
3494     my $suppress_transit = 0;
3495     if ( $transit->dest != $self->circ_lib and not ( $self->hold_as_transit and $transit->copy_status == OILS_COPY_STATUS_ON_HOLDS_SHELF ) ) {
3496         my $suppress_setting = ($transit->copy_status == OILS_COPY_STATUS_ON_HOLDS_SHELF ?  'circ.transit.suppress_hold' : 'circ.transit.suppress_non_hold');
3497         my $suppress_transit_circ = $U->ou_ancestor_setting($self->circ_lib, $suppress_setting);
3498         if($suppress_transit_circ && $suppress_transit_circ->{value}) {
3499             my $suppress_transit_dest = $U->ou_ancestor_setting($transit->dest, $suppress_setting);
3500             if($suppress_transit_dest && $suppress_transit_dest->{value} eq $suppress_transit_circ->{value}) {
3501                 $suppress_transit = 1;
3502                 $self->fake_hold_dest(1) if $transit->copy_status == OILS_COPY_STATUS_ON_HOLDS_SHELF;
3503             }
3504         }
3505     }
3506     if( not $suppress_transit and ( $transit->dest != $self->circ_lib or ($self->hold_as_transit && $transit->copy_status == OILS_COPY_STATUS_ON_HOLDS_SHELF) ) ) {
3507         # - this item is in-transit to a different location
3508         # - Or we are capturing holds as transits, so why create a new transit?
3509
3510         my $tid = $transit->id;
3511         my $loc = $self->circ_lib;
3512         my $dest = $transit->dest;
3513
3514         $logger->info("circulator: Fowarding transit on copy which is destined ".
3515             "for a different location. transit=$tid, copy=$copyid, current ".
3516             "location=$loc, destination location=$dest");
3517
3518         my $evt = OpenILS::Event->new('ROUTE_ITEM', org => $dest, payload => {});
3519
3520         # grab the associated hold object if available
3521         my $ht = $self->editor->retrieve_action_hold_transit_copy($tid);
3522         $self->hold($self->editor->retrieve_action_hold_request($ht->hold)) if $ht;
3523
3524         return $self->bail_on_events($evt);
3525     }
3526
3527     # The transit is received, set the receive time
3528     $transit->dest_recv_time('now');
3529     $self->bail_on_events($self->editor->event)
3530         unless $self->editor->update_action_transit_copy($transit);
3531
3532     my $hold_transit = $self->editor->retrieve_action_hold_transit_copy($transit->id);
3533
3534     $logger->info("circulator: Recovering original copy status in transit: ".$transit->copy_status);
3535     $copy->status( $transit->copy_status );
3536     $self->update_copy();
3537     return if $self->bail_out;
3538
3539     my $ishold = 0;
3540     if($hold_transit) {
3541         my $hold = $self->editor->retrieve_action_hold_request($hold_transit->hold);
3542
3543         if ($hold) {
3544             # hold has arrived at destination, set shelf time
3545             $self->put_hold_on_shelf($hold);
3546             $self->bail_on_events($self->editor->event)
3547                 unless $self->editor->update_action_hold_request($hold);
3548             return if $self->bail_out;
3549
3550             $self->notify_hold($hold_transit->hold);
3551             $ishold = 1;
3552         } else {
3553             $hold_transit = undef;
3554             $self->cancelled_hold_transit(1);
3555             $self->reshelve_copy(1);
3556             $self->fake_hold_dest(0);
3557         }
3558     }
3559
3560     $self->push_events(
3561         OpenILS::Event->new(
3562         'SUCCESS',
3563         ishold => $ishold,
3564       payload => { transit => $transit, holdtransit => $hold_transit } ));
3565
3566     return $hold_transit;
3567 }
3568
3569
3570 # ------------------------------------------------------------------
3571 # Sets the shelf_time and shelf_expire_time for a newly shelved hold
3572 # ------------------------------------------------------------------
3573 sub put_hold_on_shelf {
3574     my($self, $hold) = @_;
3575     $hold->shelf_time('now');
3576     $hold->current_shelf_lib($self->circ_lib);
3577     $holdcode->set_hold_shelf_expire_time($hold, $self->editor);
3578     return undef;
3579 }
3580
3581 sub handle_fines {
3582    my $self = shift;
3583    my $reservation = shift;
3584    my $dt_parser = DateTime::Format::ISO8601->new;
3585
3586    my $obj = $reservation ? $self->reservation : $self->circ;
3587
3588     my $lost_bill_opts = $self->lost_bill_options;
3589     my $circ_lib = $lost_bill_opts->{circ_lib} if $lost_bill_opts;
3590     # first, restore any voided overdues for lost, if needed
3591     if ($self->needs_lost_bill_handling and !$self->void_overdues) {
3592         my $restore_od = $U->ou_ancestor_setting_value(
3593             $circ_lib, $lost_bill_opts->{ous_restore_overdue},
3594             $self->editor) || 0;
3595         $self->checkin_handle_lost_or_lo_now_found_restore_od($circ_lib)
3596             if $restore_od;
3597     }
3598
3599     # next, handle normal overdue generation and apply stop_fines
3600     # XXX reservations don't have stop_fines
3601     # TODO revisit booking_reservation re: stop_fines support
3602     if ($reservation or !$obj->stop_fines) {
3603         my $skip_for_grace;
3604
3605         # This is a crude check for whether we are in a grace period. The code
3606         # in generate_fines() does a more thorough job, so this exists solely
3607         # as a small optimization, and might be better off removed.
3608
3609         # If we have a grace period
3610         if($obj->can('grace_period')) {
3611             # Parse out the due date
3612             my $due_date = $dt_parser->parse_datetime( clean_ISO8601($obj->due_date) );
3613             # Add the grace period to the due date
3614             $due_date->add(seconds => OpenILS::Utils::DateTime->interval_to_seconds($obj->grace_period));
3615             # Don't generate fines on circs still in grace period
3616             $skip_for_grace = $due_date > DateTime->now;
3617         }
3618         $CC->generate_fines({circs => [$obj], editor => $self->editor})
3619             unless $skip_for_grace;
3620
3621         if (!$reservation and !$obj->stop_fines) {
3622             $obj->stop_fines(OILS_STOP_FINES_CHECKIN);
3623             $obj->stop_fines(OILS_STOP_FINES_RENEW) if $self->is_renewal;
3624             $obj->stop_fines(OILS_STOP_FINES_CLAIMS_NEVERCHECKEDOUT) if $self->claims_never_checked_out;
3625             $obj->stop_fines_time('now');
3626             $obj->stop_fines_time($self->backdate) if $self->backdate;
3627             $self->editor->update_action_circulation($obj);
3628         }
3629     }
3630
3631     # finally, handle voiding of lost item and processing fees
3632     if ($self->needs_lost_bill_handling) {
3633         my $void_cost = $U->ou_ancestor_setting_value(
3634             $circ_lib, $lost_bill_opts->{ous_void_item_cost},
3635             $self->editor) || 0;
3636         my $void_proc_fee = $U->ou_ancestor_setting_value(
3637             $circ_lib, $lost_bill_opts->{ous_void_proc_fee},
3638             $self->editor) || 0;
3639         $self->checkin_handle_lost_or_lo_now_found(
3640             $lost_bill_opts->{void_cost_btype},
3641             $lost_bill_opts->{is_longoverdue}) if $void_cost;
3642         $self->checkin_handle_lost_or_lo_now_found(
3643             $lost_bill_opts->{void_fee_btype},
3644             $lost_bill_opts->{is_longoverdue}) if $void_proc_fee;
3645     }
3646
3647    return undef;
3648 }
3649
3650 sub checkin_handle_circ_start {
3651    my $self = shift;
3652    my $circ = $self->circ;
3653    my $copy = $self->copy;
3654    my $evt;
3655    my $obt;
3656
3657    $self->backdate($circ->xact_start) if $self->claims_never_checked_out;
3658
3659    # backdate the circ if necessary
3660    if($self->backdate) {
3661         my $evt = $self->checkin_handle_backdate;
3662         return $self->bail_on_events($evt) if $evt;
3663    }
3664
3665     # Set the checkin vars since we have the item
3666     $circ->checkin_time( ($self->backdate) ? $self->backdate : 'now' );
3667
3668     # capture the true scan time for back-dated checkins
3669     $circ->checkin_scan_time('now');
3670
3671     $circ->checkin_staff($self->editor->requestor->id);
3672     $circ->checkin_lib($self->circ_lib);
3673     $circ->checkin_workstation($self->editor->requestor->wsid);
3674
3675     my $circ_lib = (ref $self->copy->circ_lib) ?
3676         $self->copy->circ_lib->id : $self->copy->circ_lib;
3677     my $stat = $U->copy_status($self->copy->status)->id;
3678
3679     if ($stat == OILS_COPY_STATUS_LOST || $stat == OILS_COPY_STATUS_LOST_AND_PAID) {
3680         # we will now handle lost fines, but the copy will retain its 'lost'
3681         # status if it needs to transit home unless lost_immediately_available
3682         # is true
3683         #
3684         # if we decide to also delay fine handling until the item arrives home,
3685         # we will need to call lost fine handling code both when checking items
3686         # in and also when receiving transits
3687         $self->checkin_handle_lost($circ_lib);
3688     } elsif ($stat == OILS_COPY_STATUS_LONG_OVERDUE) {
3689         # same process as above.
3690         $self->checkin_handle_long_overdue($circ_lib);
3691     } elsif ($circ_lib != $self->circ_lib and $stat == OILS_COPY_STATUS_MISSING) {
3692         $logger->info("circulator: not updating copy status on checkin because copy is missing");
3693     } else {
3694         my $next_status = $self->next_copy_status->[0] || OILS_COPY_STATUS_RESHELVING;
3695         $self->copy->status($U->copy_status($next_status));
3696         $self->update_copy;
3697     }
3698
3699     return undef;
3700 }
3701
3702 sub checkin_handle_circ_finish {
3703     my $self = shift;
3704     my $e = $self->editor;
3705     my $circ = $self->circ;
3706
3707     # Do one last check before the final circulation update to see
3708     # if the xact_finish value should be set or not.
3709     #
3710     # The underlying money.billable_xact may have been updated to
3711     # reflect a change in xact_finish during checkin bills handling,
3712     # however we can't simply refresh the circulation from the DB,
3713     # because other changes may be pending.  Instead, reproduce the
3714     # xact_finish check here.  It won't hurt to do it again.
3715
3716     my $sum = $e->retrieve_money_billable_transaction_summary($circ->id);
3717     if ($sum) { # is this test still needed?
3718
3719         my $balance = $sum->balance_owed;
3720
3721         if ($balance == 0) {
3722             $circ->xact_finish('now');
3723         } else {
3724             $circ->clear_xact_finish;
3725         }
3726
3727         $logger->info("circulator: $balance is owed on this circulation");
3728     }
3729
3730     return $self->bail_on_events($e->event)
3731         unless $e->update_action_circulation($circ);
3732
3733     return undef;
3734 }
3735
3736 # ------------------------------------------------------------------
3737 # See if we need to void billings, etc. for lost checkin
3738 # ------------------------------------------------------------------
3739 sub checkin_handle_lost {
3740     my $self = shift;
3741     my $circ_lib = shift;
3742
3743     my $max_return = $U->ou_ancestor_setting_value($circ_lib,
3744         OILS_SETTING_MAX_ACCEPT_RETURN_OF_LOST, $self->editor) || 0;
3745
3746     $self->lost_bill_options({
3747         circ_lib => $circ_lib,
3748         ous_void_item_cost => OILS_SETTING_VOID_LOST_ON_CHECKIN,
3749         ous_void_proc_fee => OILS_SETTING_VOID_LOST_PROCESS_FEE_ON_CHECKIN,
3750         ous_restore_overdue => OILS_SETTING_RESTORE_OVERDUE_ON_LOST_RETURN,
3751         void_cost_btype => 3,
3752         void_fee_btype => 4
3753     });
3754
3755     return $self->checkin_handle_lost_or_longoverdue(
3756         circ_lib => $circ_lib,
3757         max_return => $max_return,
3758         ous_immediately_available => OILS_SETTING_LOST_IMMEDIATELY_AVAILABLE,
3759         ous_use_last_activity => undef # not supported for LOST checkin
3760     );
3761 }
3762
3763 # ------------------------------------------------------------------
3764 # See if we need to void billings, etc. for long-overdue checkin
3765 # note: not using constants below since they serve little purpose
3766 # for single-use strings that are descriptive in their own right
3767 # and mostly just complicate debugging.
3768 # ------------------------------------------------------------------
3769 sub checkin_handle_long_overdue {
3770     my $self = shift;
3771     my $circ_lib = shift;
3772
3773     $logger->info("circulator: processing long-overdue checkin...");
3774
3775     my $max_return = $U->ou_ancestor_setting_value($circ_lib,
3776         'circ.max_accept_return_of_longoverdue', $self->editor) || 0;
3777
3778     $self->lost_bill_options({
3779         circ_lib => $circ_lib,
3780         ous_void_item_cost => 'circ.void_longoverdue_on_checkin',
3781         ous_void_proc_fee => 'circ.void_longoverdue_proc_fee_on_checkin',
3782         is_longoverdue => 1,
3783         ous_restore_overdue => 'circ.restore_overdue_on_longoverdue_return',
3784         void_cost_btype => 10,
3785         void_fee_btype => 11
3786     });
3787
3788     return $self->checkin_handle_lost_or_longoverdue(
3789         circ_lib => $circ_lib,
3790         max_return => $max_return,
3791         ous_immediately_available => 'circ.longoverdue_immediately_available',
3792         ous_use_last_activity =>
3793             'circ.longoverdue.use_last_activity_date_on_return'
3794     )
3795 }
3796
3797 # last billing activity is last payment time, last billing time, or the
3798 # circ due date.  If the relevant "use last activity" org unit setting is
3799 # false/unset, then last billing activity is always the due date.
3800 sub get_circ_last_billing_activity {
3801     my $self = shift;
3802     my $circ_lib = shift;
3803     my $setting = shift;
3804     my $date = $self->circ->due_date;
3805
3806     return $date unless $setting and
3807         $U->ou_ancestor_setting_value($circ_lib, $setting, $self->editor);
3808
3809     my $xact = $self->editor->retrieve_money_billable_transaction([
3810         $self->circ->id,
3811         {flesh => 1, flesh_fields => {mbt => ['summary']}}
3812     ]);
3813
3814     if ($xact->summary) {
3815         $date = $xact->summary->last_payment_ts ||
3816                 $xact->summary->last_billing_ts ||
3817                 $self->circ->due_date;
3818     }
3819
3820     return $date;
3821 }
3822
3823
3824 sub checkin_handle_lost_or_longoverdue {
3825     my ($self, %args) = @_;
3826
3827     my $circ = $self->circ;
3828     my $max_return = $args{max_return};
3829     my $circ_lib = $args{circ_lib};
3830
3831     if ($max_return) {
3832
3833         my $last_activity =
3834             $self->get_circ_last_billing_activity(
3835                 $circ_lib, $args{ous_use_last_activity});
3836
3837         my $today = time();
3838         my @tm = reverse($last_activity =~ /([\d\.]+)/og);
3839         $tm[5] -= 1 if $tm[5] > 0;
3840         my $due = timelocal(int($tm[1]), int($tm[2]),
3841             int($tm[3]), int($tm[4]), int($tm[5]), int($tm[6]));
3842
3843         my $last_chance =
3844             OpenILS::Utils::DateTime->interval_to_seconds($max_return) + int($due);
3845
3846         $logger->info("MAX OD: $max_return LAST ACTIVITY: ".
3847             "$last_activity DUEDATE: ".$circ->due_date." TODAY: $today ".
3848                 "DUE: $due LAST: $last_chance");
3849
3850         $max_return = 0 if $today < $last_chance;
3851     }
3852
3853
3854     if ($max_return) {
3855
3856         $logger->info("circulator: check-in of lost/lo item exceeds max ".
3857             "return interval.  skipping fine/fee voiding, etc.");
3858
3859     } elsif ($self->dont_change_lost_zero) { # we leave lost zero balance alone
3860
3861         $logger->info("circulator: check-in of lost/lo item having a balance ".
3862             "of zero, skipping fine/fee voiding and reinstatement.");
3863
3864     } else { # within max-return interval or no interval defined
3865
3866         $logger->info("circulator: check-in of lost/lo item is within the ".
3867             "max return interval (or no interval is defined).  Proceeding ".
3868             "with fine/fee voiding, etc.");
3869
3870         $self->needs_lost_bill_handling(1);
3871     }
3872
3873     if ($circ_lib != $self->circ_lib) {
3874         # if the item is not home, check to see if we want to retain the
3875         # lost/longoverdue status at this point in the process
3876
3877         my $immediately_available = $U->ou_ancestor_setting_value($circ_lib,
3878             $args{ous_immediately_available}, $self->editor) || 0;
3879
3880         if ($immediately_available) {
3881             # item status does not need to be retained, so give it a
3882             # reshelving status as if it were a normal checkin
3883             my $next_status = $self->next_copy_status->[0] || OILS_COPY_STATUS_RESHELVING;
3884             $self->copy->status($U->copy_status($next_status));
3885             $self->update_copy;
3886         } else {
3887             $logger->info("circulator: leaving lost/longoverdue copy".
3888                 " status in place on checkin");
3889         }
3890     } else {
3891         # lost/longoverdue item is home and processed, treat like a normal
3892         # checkin from this point on
3893         my $next_status = $self->next_copy_status->[0] || OILS_COPY_STATUS_RESHELVING;
3894         $self->copy->status($U->copy_status($next_status));
3895         $self->update_copy;
3896     }
3897 }
3898
3899
3900 sub checkin_handle_backdate {
3901     my $self = shift;
3902
3903     # ------------------------------------------------------------------
3904     # clean up the backdate for date comparison
3905     # XXX We are currently taking the due-time from the original due-date,
3906     # not the input.  Do we need to do this?  This certainly interferes with
3907     # backdating of hourly checkouts, but that is likely a very rare case.
3908     # ------------------------------------------------------------------
3909     my $bd = clean_ISO8601($self->backdate);
3910     my $original_date = DateTime::Format::ISO8601->new->parse_datetime(clean_ISO8601($self->circ->due_date));
3911     my $new_date = DateTime::Format::ISO8601->new->parse_datetime($bd);
3912     $new_date->set_hour($original_date->hour());
3913     $new_date->set_minute($original_date->minute());
3914     if ($new_date >= DateTime->now) {
3915         # We can't say that the item will be checked in later...so assume someone's clock is wrong instead.
3916         # $self->backdate() autoload handler ignores undef values.
3917         # Clear the backdate manually.
3918         $logger->info("circulator: ignoring future backdate: $new_date");
3919         delete $self->{backdate};
3920     } else {
3921         $self->backdate(clean_ISO8601($new_date->datetime()));
3922     }
3923
3924     return undef;
3925 }
3926
3927
3928 sub check_checkin_copy_status {
3929     my $self = shift;
3930    my $copy = $self->copy;
3931
3932    my $status = $U->copy_status($copy->status)->id;
3933
3934    return undef
3935       if(   $self->new_copy_alerts ||
3936             $status == OILS_COPY_STATUS_AVAILABLE   ||
3937             $status == OILS_COPY_STATUS_CHECKED_OUT ||
3938             $status == OILS_COPY_STATUS_IN_PROCESS  ||
3939             $status == OILS_COPY_STATUS_ON_HOLDS_SHELF  ||
3940             $status == OILS_COPY_STATUS_IN_TRANSIT  ||
3941             $status == OILS_COPY_STATUS_CATALOGING  ||
3942             $status == OILS_COPY_STATUS_ON_RESV_SHELF  ||
3943             $status == OILS_COPY_STATUS_CANCELED_TRANSIT ||
3944             $status == OILS_COPY_STATUS_RESHELVING );
3945
3946    return OpenILS::Event->new('COPY_STATUS_LOST', payload => $copy )
3947       if( $status == OILS_COPY_STATUS_LOST );
3948
3949     return OpenILS::Event->new('COPY_STATUS_LOST_AND_PAID', payload => $copy)
3950         if ($status == OILS_COPY_STATUS_LOST_AND_PAID);
3951
3952    return OpenILS::Event->new('COPY_STATUS_LONG_OVERDUE', payload => $copy )
3953       if( $status == OILS_COPY_STATUS_LONG_OVERDUE );
3954
3955    return OpenILS::Event->new('COPY_STATUS_MISSING', payload => $copy )
3956       if( $status == OILS_COPY_STATUS_MISSING );
3957
3958    return OpenILS::Event->new('COPY_BAD_STATUS', payload => $copy );
3959 }
3960
3961
3962
3963 # --------------------------------------------------------------------------
3964 # On checkin, we need to return as many relevant objects as we can
3965 # --------------------------------------------------------------------------
3966 sub checkin_flesh_events {
3967     my $self = shift;
3968
3969     if( grep { $_->{textcode} eq 'SUCCESS' } @{$self->events}
3970         and grep { $_->{textcode} eq 'ITEM_NOT_CATALOGED' } @{$self->events} ) {
3971             $self->events([grep { $_->{textcode} eq 'ITEM_NOT_CATALOGED' } @{$self->events}]);
3972     }
3973
3974     my $record = $U->record_to_mvr($self->title) if($self->title and !$self->is_precat);
3975
3976     my $hold;
3977     if($self->hold and !$self->hold->cancel_time) {
3978         $hold = $self->hold;
3979         $hold->notes($self->editor->search_action_hold_request_note({hold => $hold->id}));
3980     }
3981
3982     if($self->circ) {
3983         # update our copy of the circ object and
3984         # flesh the billing summary data
3985         $self->circ(
3986             $self->editor->retrieve_action_circulation([
3987                 $self->circ->id, {
3988                     flesh => 2,
3989                     flesh_fields => {
3990                         circ => ['billable_transaction'],
3991                         mbt => ['summary']
3992                     }
3993                 }
3994             ])
3995         );
3996     }
3997
3998     if($self->patron) {
3999         # flesh some patron fields before returning
4000         $self->patron(
4001             $self->editor->retrieve_actor_user([
4002                 $self->patron->id,
4003                 {
4004                     flesh => 1,
4005                     flesh_fields => {
4006                         au => ['card', 'billing_address', 'mailing_address']
4007                     }
4008                 }
4009             ])
4010         );
4011     }
4012
4013     # Flesh the latest inventory.
4014     # NB: This survives the unflesh_copy below. Let's keep it that way.
4015     my $alci = $self->editor->search_asset_latest_inventory([
4016         {copy=>$self->copy->id},
4017         {flesh => 1,
4018          flesh_fields => {
4019              alci => ['inventory_workstation']
4020          }}]);
4021     if ($alci && $alci->[0]) {
4022         $self->copy->latest_inventory($alci->[0]);
4023     }
4024
4025     for my $evt (@{$self->events}) {
4026
4027         my $payload         = {};
4028         $payload->{copy}    = $U->unflesh_copy($self->copy);
4029         $payload->{volume}  = $self->volume;
4030         $payload->{record}  = $record,
4031         $payload->{circ}    = $self->circ;
4032         $payload->{transit} = $self->transit;
4033         $payload->{cancelled_hold_transit} = 1 if $self->cancelled_hold_transit;
4034         $payload->{hold}    = $hold;
4035         $payload->{patron}  = $self->patron;
4036         $payload->{reservation} = $self->reservation
4037             unless (not $self->reservation or $self->reservation->cancel_time);
4038
4039         $evt->{payload}     = $payload;
4040     }
4041 }
4042
4043 sub log_me {
4044     my( $self, $msg ) = @_;
4045     my $bc = ($self->copy) ? $self->copy->barcode :
4046         $self->copy_barcode;
4047     $bc ||= "";
4048     my $usr = ($self->patron) ? $self->patron->id : "";
4049     $logger->info("circulator: $msg requestor=".$self->editor->requestor->id.
4050         ", recipient=$usr, copy=$bc");
4051 }
4052
4053
4054 sub do_renew {
4055     my $self = shift;
4056     my $api = shift;
4057     $self->log_me("do_renew()");
4058
4059     # Make sure there is an open circ to renew
4060     my $usrid = $self->patron->id if $self->patron;
4061     my $circ = $self->editor->search_action_circulation({
4062         target_copy => $self->copy->id,
4063         xact_finish => undef,
4064         checkin_time => undef,
4065         ($usrid ? (usr => $usrid) : ())
4066     })->[0];
4067
4068     return $self->bail_on_events($self->editor->event) unless $circ;
4069
4070     # A user is not allowed to renew another user's items without permission
4071     unless( $circ->usr eq $self->editor->requestor->id ) {
4072         return $self->bail_on_events($self->editor->events)
4073             unless $self->editor->allowed('RENEW_CIRC', $circ->circ_lib);
4074     }
4075
4076     $self->push_events(OpenILS::Event->new('MAX_RENEWALS_REACHED'))
4077         if $circ->renewal_remaining < 1;
4078
4079     $self->push_events(OpenILS::Event->new('MAX_AUTO_RENEWALS_REACHED'))
4080         if $self->auto_renewal and $circ->auto_renewal_remaining < 1;
4081     # -----------------------------------------------------------------
4082
4083     $self->parent_circ($circ->id);
4084     $self->renewal_remaining( $circ->renewal_remaining - 1 );
4085     $self->auto_renewal_remaining( $circ->auto_renewal_remaining - 1 ) if (defined($circ->auto_renewal_remaining));
4086     $self->circ($circ);
4087
4088     # Opac renewal - re-use circ library from original circ (unless told not to)
4089     if($self->opac_renewal or $self->auto_renewal) {
4090         unless(defined($opac_renewal_use_circ_lib)) {
4091             my $use_circ_lib = $self->editor->retrieve_config_global_flag('circ.opac_renewal.use_original_circ_lib');
4092             if($use_circ_lib and $U->is_true($use_circ_lib->enabled)) {
4093                 $opac_renewal_use_circ_lib = 1;
4094             }
4095             else {
4096                 $opac_renewal_use_circ_lib = 0;
4097             }
4098         }
4099         $self->circ_lib($circ->circ_lib) if($opac_renewal_use_circ_lib);
4100     }
4101
4102     # Desk renewal - re-use circ library from original circ (unless told not to)
4103     if($self->desk_renewal) {
4104         unless(defined($desk_renewal_use_circ_lib)) {
4105             my $use_circ_lib = $self->editor->retrieve_config_global_flag('circ.desk_renewal.use_original_circ_lib');
4106             if($use_circ_lib and $U->is_true($use_circ_lib->enabled)) {
4107                 $desk_renewal_use_circ_lib = 1;
4108             }
4109             else {
4110                 $desk_renewal_use_circ_lib = 0;
4111             }
4112         }
4113         $self->circ_lib($circ->circ_lib) if($desk_renewal_use_circ_lib);
4114     }
4115
4116     # Check if expired patron is allowed to renew, and bail if not.
4117     my $expire = DateTime::Format::ISO8601->new->parse_datetime(clean_ISO8601($self->patron->expire_date));
4118     if (CORE::time > $expire->epoch) {
4119         my $allow_renewal = $U->ou_ancestor_setting_value($self->circ_lib, OILS_SETTING_ALLOW_RENEW_FOR_EXPIRED_PATRON);
4120         unless ($U->is_true($allow_renewal)) {
4121             return $self->bail_on_events(OpenILS::Event->new('PATRON_ACCOUNT_EXPIRED'));
4122         }
4123     }
4124
4125     # Run the fine generator against the old circ
4126     # XXX This seems unnecessary, given that handle_fines runs in do_checkin
4127     # a few lines down.  Commenting out, for now.
4128     #$self->handle_fines;
4129
4130     $self->run_renew_permit;
4131
4132     # Check the item in
4133     $self->do_checkin();
4134     return if $self->bail_out;
4135
4136     unless( $self->permit_override ) {
4137         $self->do_permit();
4138         return if $self->bail_out;
4139         $self->is_precat(1) if $self->have_event('ITEM_NOT_CATALOGED');
4140         $self->remove_event('ITEM_NOT_CATALOGED');
4141     }
4142
4143     $self->override_events;
4144     return if $self->bail_out;
4145
4146     $self->events([]);
4147     $self->do_checkout();
4148 }
4149
4150
4151 sub remove_event {
4152     my( $self, $evt ) = @_;
4153     $evt = (ref $evt) ? $evt->{textcode} : $evt;
4154     $logger->debug("circulator: removing event from list: $evt");
4155     my @events = @{$self->events};
4156     $self->events( [ grep { $_->{textcode} ne $evt } @events ] );
4157 }
4158
4159
4160 sub have_event {
4161     my( $self, $evt ) = @_;
4162     $evt = (ref $evt) ? $evt->{textcode} : $evt;
4163     return grep { $_->{textcode} eq $evt } @{$self->events};
4164 }
4165
4166
4167 sub run_renew_permit {
4168     my $self = shift;
4169
4170     if ($U->ou_ancestor_setting_value($self->circ_lib, 'circ.block_renews_for_holds')) {
4171         my ($hold, undef, $retarget) = $holdcode->find_nearest_permitted_hold(
4172             $self->editor, $self->copy, $self->editor->requestor, 1
4173         );
4174         $self->push_events(new OpenILS::Event("COPY_NEEDED_FOR_HOLD")) if $hold;
4175     }
4176
4177     my $results = $self->run_indb_circ_test;
4178     $self->push_events($self->matrix_test_result_events)
4179         unless $self->circ_test_success;
4180 }
4181
4182
4183 # XXX: The primary mechanism for storing circ history is now handled
4184 # by tracking real circulation objects instead of bibs in a bucket.
4185 # However, this code is disabled by default and could be useful
4186 # some day, so may as well leave it for now.
4187 sub append_reading_list {
4188     my $self = shift;
4189
4190     return undef unless
4191         $self->is_checkout and
4192         $self->patron and
4193         $self->copy and
4194         !$self->is_noncat;
4195
4196
4197     # verify history is globally enabled and uses the bucket mechanism
4198     my $htype = OpenSRF::Utils::SettingsClient->new->config_value(
4199         apps => 'open-ils.circ' => app_settings => 'checkout_history_mechanism');
4200
4201     return undef unless $htype and $htype eq 'bucket';
4202
4203     my $e = new_editor(xact => 1, requestor => $self->editor->requestor);
4204
4205     # verify the patron wants to retain the hisory
4206     my $setting = $e->search_actor_user_setting(
4207         {usr => $self->patron->id, name => 'circ.keep_checkout_history'})->[0];
4208
4209     unless($setting and $setting->value) {
4210         $e->rollback;
4211         return undef;
4212     }
4213
4214     my $bkt = $e->search_container_copy_bucket(
4215         {owner => $self->patron->id, btype => 'circ_history'})->[0];
4216
4217     my $pos = 1;
4218
4219     if($bkt) {
4220         # find the next item position
4221         my $last_item = $e->search_container_copy_bucket_item(
4222             {bucket => $bkt->id}, {order_by => {ccbi => 'pos desc'}, limit => 1})->[0];
4223         $pos = $last_item->pos + 1 if $last_item;
4224
4225     } else {
4226         # create the history bucket if necessary
4227         $bkt = Fieldmapper::container::copy_bucket->new;
4228         $bkt->owner($self->patron->id);
4229         $bkt->name('');
4230         $bkt->btype('circ_history');
4231         $bkt->pub('f');
4232         $e->create_container_copy_bucket($bkt) or return $e->die_event;
4233     }
4234
4235     my $item = Fieldmapper::container::copy_bucket_item->new;
4236
4237     $item->bucket($bkt->id);
4238     $item->target_copy($self->copy->id);
4239     $item->pos($pos);
4240
4241     $e->create_container_copy_bucket_item($item) or return $e->die_event;
4242     $e->commit;
4243
4244     return undef;
4245 }
4246
4247
4248 sub make_trigger_events {
4249     my $self = shift;
4250     return unless $self->circ;
4251     $U->create_events_for_hook('checkout', $self->circ, $self->circ_lib) if $self->is_checkout;
4252     $U->create_events_for_hook('checkin',  $self->circ, $self->circ_lib) if $self->is_checkin;
4253     $U->create_events_for_hook('renewal',  $self->circ, $self->circ_lib) if $self->is_renewal;
4254 }
4255
4256
4257
4258 sub checkin_handle_lost_or_lo_now_found {
4259     my ($self, $bill_type, $is_longoverdue) = @_;
4260
4261     my $tag = $is_longoverdue ? "LONGOVERDUE" : "LOST";
4262
4263     $logger->debug("voiding $tag item billings");
4264     my $result = $CC->void_or_zero_bills_of_type($self->editor, $self->circ, $self->copy, $bill_type, "$tag ITEM RETURNED");
4265     $self->bail_on_events($self->editor->event) if ($result);
4266 }
4267
4268 sub checkin_handle_lost_or_lo_now_found_restore_od {
4269     my $self = shift;
4270     my $circ_lib = shift;
4271     my $is_longoverdue = shift;
4272     my $tag = $is_longoverdue ? "LONGOVERDUE" : "LOST";
4273
4274     # ------------------------------------------------------------------
4275     # restore those overdue charges voided when item was set to lost
4276     # ------------------------------------------------------------------
4277
4278     my $ods = $self->editor->search_money_billing([
4279         {
4280             xact => $self->circ->id,
4281             btype => 1
4282         },
4283         {
4284             order_by => {mb => 'billing_ts desc'}
4285         }
4286     ]);
4287
4288     $logger->debug("returning ".scalar(@$ods)." overdue charges pre-$tag");
4289     # Because actual users get up to all kinds of unexpectedness, we
4290     # only recreate up to $circ->max_fine in bills.  I know you think
4291     # it wouldn't happen that bills could get created, voided, and
4292     # recreated more than once, but I guaran-damn-tee you that it will
4293     # happen.
4294     if ($ods && @$ods) {
4295         my $void_amount = 0;
4296         my $void_max = $self->circ->max_fine();
4297         # search for overdues voided the new way (aka "adjusted")
4298         my @billings = map {$_->id()} @$ods;
4299         my $voids = $self->editor->search_money_account_adjustment(
4300             {
4301                 billing => \@billings
4302             }
4303         );
4304         if (@$voids) {
4305             map {$void_amount += $_->amount()} @$voids;
4306         } else {
4307             # if no adjustments found, assume they were voided the old way (aka "voided")
4308             for my $bill (@$ods) {
4309                 if( $U->is_true($bill->voided) ) {
4310                     $void_amount += $bill->amount();
4311                 }
4312             }
4313         }
4314         $CC->create_bill(
4315             $self->editor,
4316             ($void_amount < $void_max ? $void_amount : $void_max),
4317             $ods->[0]->btype(),
4318             $ods->[0]->billing_type(),
4319             $self->circ->id(),
4320             "System: $tag RETURNED - OVERDUES REINSTATED",
4321             $ods->[-1]->period_start(),
4322             $ods->[0]->period_end() # date this restoration the same as the last overdue (for possible subsequent fine generation)
4323         );
4324     }
4325 }
4326
4327 1;