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         $self->extend_renewal_due_date if $self->is_renewal;
2349
2350         #my $org = (ref $copy->circ_lib) ? $copy->circ_lib->id : $copy->circ_lib;
2351
2352         # due-date overlap should be determined by the location the item
2353         # is checked out from, not the owning or circ lib of the item
2354         my $org = $self->circ_lib;
2355
2356       $logger->info("circulator: circ searching for closed date overlap on lib $org".
2357             " with an item due date of ".$circ->due_date );
2358
2359       my $dateinfo = $U->storagereq(
2360          'open-ils.storage.actor.org_unit.closed_date.overlap',
2361             $org, $circ->due_date );
2362
2363       if($dateinfo) {
2364          $logger->info("circulator: $dateinfo : circ due data / close date overlap found : due_date=".
2365             $circ->due_date." start=". $dateinfo->{start}.", end=".$dateinfo->{end});
2366
2367             # XXX make the behavior more dynamic
2368             # for now, we just push the due date to after the close date
2369             if ($shift_earlier) {
2370                 $circ->due_date($dateinfo->{start});
2371             } else {
2372                 $circ->due_date($dateinfo->{end});
2373             }
2374       }
2375    }
2376 }
2377
2378 sub extend_renewal_due_date {
2379     my $self = shift;
2380     my $circ = $self->circ;
2381     my $matchpoint = $self->circ_matrix_matchpoint;
2382
2383     return unless $U->is_true($matchpoint->renew_extends_due_date);
2384
2385     my $prev_circ = $self->editor->retrieve_action_circulation($self->parent_circ);
2386
2387     my $start_time = DateTime::Format::ISO8601->new
2388         ->parse_datetime(clean_ISO8601($prev_circ->xact_start))->epoch;
2389
2390     my $end_time = DateTime::Format::ISO8601->new
2391         ->parse_datetime(clean_ISO8601($prev_circ->due_date))->epoch;
2392
2393     my $now_time = DateTime->now->epoch;
2394
2395     if (my $interval = $matchpoint->renew_extend_min_interval) {
2396
2397         my $min_duration = OpenILS::Utils::DateTime->interval_to_seconds($interval);
2398         my $checkout_duration = $now_time - $start_time;
2399
2400         return if $checkout_duration < $min_duration;
2401     }
2402
2403     my $remaining_duration = $end_time - $now_time;
2404
2405     my $due_date = DateTime::Format::ISO8601->new
2406         ->parse_datetime(clean_ISO8601($circ->due_date));
2407
2408     $due_date->add(seconds => $remaining_duration);
2409
2410     $logger->info("circulator: extended renewal due date to $due_date");
2411
2412     # $circ->due_date is already in the needed timezone.
2413     $circ->due_date($due_date->strftime('%FT%T%z'));
2414 }
2415
2416
2417 sub create_due_date {
2418     my( $self, $duration, $date_ceiling, $force_date, $start_time ) = @_;
2419
2420     # Look up circulating library's TZ, or else use client TZ, falling
2421     # back to server TZ
2422     my $tz = $U->ou_ancestor_setting_value(
2423         $self->circ_lib,
2424         'lib.timezone',
2425         $self->editor
2426     ) || 'local';
2427
2428     my $due_date = $start_time ?
2429         DateTime::Format::ISO8601
2430             ->new
2431             ->parse_datetime(clean_ISO8601($start_time))
2432             ->set_time_zone($tz) :
2433         DateTime->now(time_zone => $tz);
2434
2435     # add the circ duration
2436     $due_date->add(seconds => OpenILS::Utils::DateTime->interval_to_seconds($duration, $due_date));
2437
2438     if($date_ceiling) {
2439         my $cdate = DateTime::Format::ISO8601
2440             ->new
2441             ->parse_datetime(clean_ISO8601($date_ceiling))
2442             ->set_time_zone($tz);
2443
2444         if ($cdate > DateTime->now and ($cdate < $due_date or $U->is_true( $force_date ))) {
2445             $logger->info("circulator: overriding due date with date ceiling: $date_ceiling");
2446             $due_date = $cdate;
2447         }
2448     }
2449
2450     # return ISO8601 time with timezone
2451     return $due_date->strftime('%FT%T%z');
2452 }
2453
2454
2455
2456 sub make_precat_copy {
2457     my $self = shift;
2458     my $copy = $self->copy;
2459     return $self->bail_on_events(OpenILS::Event->new('PERM_FAILURE'))
2460        unless $self->editor->allowed('CREATE_PRECAT') || $self->is_renewal;
2461
2462    if($copy) {
2463         $logger->debug("circulator: Pre-cat copy already exists in checkout: ID=" . $copy->id);
2464
2465         $copy->editor($self->editor->requestor->id);
2466         $copy->edit_date('now');
2467         $copy->dummy_title($self->dummy_title || $copy->dummy_title || '');
2468         $copy->dummy_isbn($self->dummy_isbn || $copy->dummy_isbn || '');
2469         $copy->dummy_author($self->dummy_author || $copy->dummy_author || '');
2470         $copy->circ_modifier($self->circ_modifier || $copy->circ_modifier);
2471         $self->update_copy();
2472         return;
2473    }
2474
2475     $logger->info("circulator: Creating a new precataloged ".
2476         "copy in checkout with barcode " . $self->copy_barcode);
2477
2478     $copy = Fieldmapper::asset::copy->new;
2479     $copy->circ_lib($self->circ_lib);
2480     $copy->creator($self->editor->requestor->id);
2481     $copy->editor($self->editor->requestor->id);
2482     $copy->barcode($self->copy_barcode);
2483     $copy->call_number(OILS_PRECAT_CALL_NUMBER);
2484     $copy->loan_duration(OILS_PRECAT_COPY_LOAN_DURATION);
2485     $copy->fine_level(OILS_PRECAT_COPY_FINE_LEVEL);
2486
2487     $copy->dummy_title($self->dummy_title || "");
2488     $copy->dummy_author($self->dummy_author || "");
2489     $copy->dummy_isbn($self->dummy_isbn || "");
2490     $copy->circ_modifier($self->circ_modifier);
2491
2492
2493     # See if we need to override the circ_lib for the copy with a configured circ_lib
2494     # Setting is shortname of the org unit
2495     my $precat_circ_lib = $U->ou_ancestor_setting_value(
2496         $self->circ_lib, 'circ.pre_cat_copy_circ_lib', $self->editor);
2497
2498     if($precat_circ_lib) {
2499         my $org = $self->editor->search_actor_org_unit({shortname => $precat_circ_lib})->[0];
2500
2501         if(!$org) {
2502             $self->bail_on_events($self->editor->event);
2503             return;
2504         }
2505
2506         $copy->circ_lib($org->id);
2507     }
2508
2509
2510     unless( $self->copy($self->editor->create_asset_copy($copy)) ) {
2511         $self->bail_out(1);
2512         $self->push_events($self->editor->event);
2513         return;
2514     }
2515 }
2516
2517
2518 sub checkout_noncat {
2519     my $self = shift;
2520
2521     my $circ;
2522     my $evt;
2523
2524    my $lib      = $self->noncat_circ_lib || $self->circ_lib;
2525    my $count    = $self->noncat_count || 1;
2526    my $cotime   = clean_ISO8601($self->checkout_time) || "";
2527
2528    $logger->info("circulator: circ creating $count noncat circs with checkout time $cotime");
2529
2530    for(1..$count) {
2531
2532       ( $circ, $evt ) = OpenILS::Application::Circ::NonCat::create_non_cat_circ(
2533          $self->editor->requestor->id,
2534             $self->patron->id,
2535             $lib,
2536             $self->noncat_type,
2537             $cotime,
2538             $self->editor );
2539
2540         if( $evt ) {
2541             $self->push_events($evt);
2542             $self->bail_out(1);
2543             return;
2544         }
2545         $self->circ($circ);
2546    }
2547 }
2548
2549 # if an item is in transit but the status doesn't agree, then we need to fix things.
2550 # The next two subs will hopefully do that
2551 sub fix_broken_transit_status {
2552     my $self = shift;
2553
2554     # Capture the transit so we don't have to fetch it again later during checkin
2555     # This used to live in sub check_transit_checkin_interval and later again in
2556     # do_checkin
2557     $self->transit(
2558         $self->editor->search_action_transit_copy(
2559             {target_copy => $self->copy->id, dest_recv_time => undef, cancel_time => undef}
2560         )->[0]
2561     );
2562
2563     if ($self->transit && $U->copy_status($self->copy->status)->id != OILS_COPY_STATUS_IN_TRANSIT) {
2564         $logger->warn("circulator: we have a copy ".$self->copy->barcode.
2565             " that is in-transit but without the In Transit status... fixing");
2566         $self->copy->status(OILS_COPY_STATUS_IN_TRANSIT);
2567         # FIXME - do we want to make this permanent if the checkin bails?
2568         $self->update_copy;
2569     }
2570
2571 }
2572 sub cancel_transit_if_circ_exists {
2573     my $self = shift;
2574     if ($self->circ && $self->transit) {
2575         $logger->warn("circulator: we have a copy ".$self->copy->barcode.
2576             " that is in-transit AND circulating... aborting the transit");
2577         my $circ_ses = create OpenSRF::AppSession("open-ils.circ");
2578         my $result = $circ_ses->request(
2579             "open-ils.circ.transit.abort",
2580             $self->editor->authtoken,
2581             { 'transitid' => $self->transit->id }
2582         )->gather(1);
2583         $logger->warn("circulator: transit abort result: ".$result);
2584         $circ_ses->disconnect;
2585         $self->transit(undef);
2586     }
2587 }
2588
2589 # If a copy goes into transit and is then checked in before the transit checkin
2590 # interval has expired, push an event onto the overridable events list.
2591 sub check_transit_checkin_interval {
2592     my $self = shift;
2593
2594     # only concerned with in-transit items
2595     return unless $U->copy_status($self->copy->status)->id == OILS_COPY_STATUS_IN_TRANSIT;
2596
2597     # no interval, no problem
2598     my $interval = $U->ou_ancestor_setting_value($self->circ_lib, 'circ.transit.min_checkin_interval');
2599     return unless $interval;
2600
2601     # transit from X to X for whatever reason has no min interval
2602     return if $self->transit->source == $self->transit->dest;
2603
2604     my $seconds = OpenILS::Utils::DateTime->interval_to_seconds($interval);
2605     my $t_start = DateTime::Format::ISO8601->new->parse_datetime(clean_ISO8601($self->transit->source_send_time));
2606     my $horizon = $t_start->add(seconds => $seconds);
2607
2608     # See if we are still within the transit checkin forbidden range
2609     $self->push_events(OpenILS::Event->new('TRANSIT_CHECKIN_INTERVAL_BLOCK'))
2610         if $horizon > DateTime->now;
2611 }
2612
2613 # Retarget local holds at checkin
2614 sub checkin_retarget {
2615     my $self = shift;
2616     return unless $self->retarget_mode and $self->retarget_mode =~ m/retarget/; # Retargeting?
2617     return unless $self->is_checkin; # Renewals need not be checked
2618     return if $self->capture eq 'nocapture'; # Not capturing holds anyway? Move on.
2619     return if $self->is_precat; # No holds for precats
2620     return unless $self->circ_lib == $self->copy->circ_lib; # Item isn't "home"? Don't check.
2621     return unless $U->is_true($self->copy->holdable); # Not holdable, shouldn't capture holds.
2622     my $status = $U->copy_status($self->copy->status);
2623     return unless $U->is_true($status->holdable); # Current status not holdable means no hold will ever target the item
2624     # Specifically target items that are likely new (by status ID)
2625     return unless $status->id == OILS_COPY_STATUS_IN_PROCESS || $self->retarget_mode =~ m/\.all/;
2626     my $location = $self->copy->location;
2627     if(!ref($location)) {
2628         $location = $self->editor->retrieve_asset_copy_location($self->copy->location);
2629         $self->copy->location($location);
2630     }
2631     return unless $U->is_true($location->holdable); # Don't bother on non-holdable locations
2632
2633     # Fetch holds for the bib
2634     my ($result) = $holdcode->method_lookup('open-ils.circ.holds.retrieve_all_from_title')->run(
2635                     $self->editor->authtoken,
2636                     $self->title->id,
2637                     {
2638                         capture_time => undef, # No touching captured holds
2639                         frozen => 'f', # Don't bother with frozen holds
2640                         pickup_lib => $self->circ_lib # Only holds actually here
2641                     });
2642
2643     # Error? Skip the step.
2644     return if exists $result->{"ilsevent"};
2645
2646     # Assemble holds
2647     my $holds = [];
2648     foreach my $holdlist (keys %{$result}) {
2649         push @$holds, @{$result->{$holdlist}};
2650     }
2651
2652     return if scalar(@$holds) == 0; # No holds, no retargeting
2653
2654     # Check for parts on this copy
2655     my $parts = $self->editor->search_asset_copy_part_map({ target_copy => $self->copy->id });
2656     my %parts_hash = ();
2657     %parts_hash = map {$_->part, 1} @$parts if @$parts;
2658
2659     # Loop over holds in request-ish order
2660     # Stage 1: Get them into request-ish order
2661     # Also grab type and target for skipping low hanging ones
2662     $result = $self->editor->json_query({
2663         "select" => { "ahr" => ["id", "hold_type", "target"] },
2664         "from" => { "ahr" => { "au" => { "fkey" => "usr",  "join" => "pgt"} } },
2665         "where" => { "id" => $holds },
2666         "order_by" => [
2667             { "class" => "pgt", "field" => "hold_priority"},
2668             { "class" => "ahr", "field" => "cut_in_line", "direction" => "desc", "transform" => "coalesce", "params" => ['f']},
2669             { "class" => "ahr", "field" => "selection_depth", "direction" => "desc"},
2670             { "class" => "ahr", "field" => "request_time"}
2671         ]
2672     });
2673
2674     # Stage 2: Loop!
2675     if (ref $result eq "ARRAY" and scalar @$result) {
2676         foreach (@{$result}) {
2677             # Copy level, but not this copy?
2678             next if ($_->{hold_type} eq 'C' or $_->{hold_type} eq 'R' or $_->{hold_type} eq 'F'
2679                 and $_->{target} != $self->copy->id);
2680             # Volume level, but not this volume?
2681             next if ($_->{hold_type} eq 'V' and $_->{target} != $self->volume->id);
2682             if(@$parts) { # We have parts?
2683                 # Skip title holds
2684                 next if ($_->{hold_type} eq 'T');
2685                 # Skip part holds for parts not on this copy
2686                 next if ($_->{hold_type} eq 'P' and not $parts_hash{$_->{target}});
2687             } else {
2688                 # No parts, no part holds
2689                 next if ($_->{hold_type} eq 'P');
2690             }
2691             # So much for easy stuff, attempt a retarget!
2692             my $tresult = $U->simplereq(
2693                 'open-ils.hold-targeter',
2694                 'open-ils.hold-targeter.target',
2695                 {hold => $_->{id}, find_copy => $self->copy->id}
2696             );
2697             if(ref $tresult eq "ARRAY" and scalar @$tresult) {
2698                 last if(exists $tresult->[0]->{found_copy} and $tresult->[0]->{found_copy});
2699             }
2700         }
2701     }
2702 }
2703
2704 sub do_checkin {
2705     my $self = shift;
2706     $self->log_me("do_checkin()");
2707
2708     return $self->bail_on_events(
2709         OpenILS::Event->new('ASSET_COPY_NOT_FOUND'))
2710         unless $self->copy;
2711
2712     # Never capture a deleted copy for a hold.
2713     $self->capture('nocapture') if $U->is_true($self->copy->deleted);
2714
2715     $self->fix_broken_transit_status; # if applicable
2716     $self->check_transit_checkin_interval;
2717     $self->checkin_retarget;
2718
2719     # the renew code and mk_env should have already found our circulation object
2720     unless( $self->circ ) {
2721
2722         my $circs = $self->editor->search_action_circulation(
2723             { target_copy => $self->copy->id, checkin_time => undef });
2724
2725         $self->circ($$circs[0]);
2726
2727         # for now, just warn if there are multiple open circs on a copy
2728         $logger->warn("circulator: we have ".scalar(@$circs).
2729             " open circs for copy " .$self->copy->id."!!") if @$circs > 1;
2730     }
2731     $self->cancel_transit_if_circ_exists; # if applicable
2732
2733     my $stat = $U->copy_status($self->copy->status)->id;
2734
2735     # LOST (and to some extent, LONGOVERDUE) may optionally be handled
2736     # differently if they are already paid for.  We need to check for this
2737     # early since overdue generation is potentially affected.
2738     my $dont_change_lost_zero = 0;
2739     if ($stat == OILS_COPY_STATUS_LOST
2740         || $stat == OILS_COPY_STATUS_LOST_AND_PAID
2741         || $stat == OILS_COPY_STATUS_LONG_OVERDUE) {
2742
2743         # LOST fine settings are controlled by the copy's circ lib, not the the
2744         # circulation's
2745         my $copy_circ_lib = (ref $self->copy->circ_lib) ?
2746                 $self->copy->circ_lib->id : $self->copy->circ_lib;
2747         $dont_change_lost_zero = $U->ou_ancestor_setting_value(
2748             $copy_circ_lib, 'circ.checkin.lost_zero_balance.do_not_change',
2749             $self->editor) || 0;
2750
2751         # Don't assume there's always a circ based on copy status
2752         if ($dont_change_lost_zero && $self->circ) {
2753             my ($obt) = $U->fetch_mbts($self->circ->id, $self->editor);
2754             $dont_change_lost_zero = 0 if( $obt and $obt->balance_owed != 0 );
2755         }
2756
2757         $self->dont_change_lost_zero($dont_change_lost_zero);
2758     }
2759
2760     # Check if the copy can float to here. We need this for inventory
2761     # and to see if the copy needs to transit or stay here later.
2762     my $can_float = 0;
2763     if ($self->copy->floating) {
2764         my $res = $self->editor->json_query(
2765             {   from =>
2766                 [
2767                     'evergreen.can_float',
2768                     $self->copy->floating->id,
2769                     $self->copy->circ_lib,
2770                     $self->circ_lib
2771                 ]
2772             }
2773         );
2774         $can_float = $U->is_true($res->[0]->{'evergreen.can_float'}) if $res;
2775     }
2776
2777     # Do copy inventory if necessary.
2778     if ($self->do_inventory_update && ($self->circ_lib == $self->copy->circ_lib || $can_float)) {
2779         my $aci = Fieldmapper::asset::copy_inventory->new();
2780         $aci->inventory_date('now');
2781         $aci->inventory_workstation($self->editor->requestor->wsid);
2782         $aci->copy($self->copy->id());
2783         $self->editor->create_asset_copy_inventory($aci);
2784         $self->checkin_changed(1);
2785     }
2786
2787     if( $self->checkin_check_holds_shelf() ) {
2788         $self->bail_on_events(OpenILS::Event->new('NO_CHANGE'));
2789         $self->hold($U->fetch_open_hold_by_copy($self->copy->id));
2790         if($self->fake_hold_dest) {
2791             $self->hold->pickup_lib($self->circ_lib);
2792         }
2793         $self->checkin_flesh_events;
2794         return;
2795     }
2796
2797     unless( $self->is_renewal ) {
2798         return $self->bail_on_events($self->editor->event)
2799             unless $self->editor->allowed('COPY_CHECKIN');
2800     }
2801
2802     $self->push_events($self->check_copy_alert());
2803     $self->push_events($self->check_checkin_copy_status());
2804
2805     # if the circ is marked as 'claims returned', add the event to the list
2806     $self->push_events(OpenILS::Event->new('CIRC_CLAIMS_RETURNED'))
2807         if ($self->circ and $self->circ->stop_fines
2808                 and $self->circ->stop_fines eq OILS_STOP_FINES_CLAIMSRETURNED);
2809
2810     $self->check_circ_deposit();
2811
2812     # handle the overridable events
2813     $self->override_events unless $self->is_renewal;
2814     return if $self->bail_out;
2815
2816     if( $self->circ ) {
2817         $self->checkin_handle_circ_start;
2818         return if $self->bail_out;
2819
2820         if (!$dont_change_lost_zero) {
2821             # if this circ is LOST and we are configured to generate overdue
2822             # fines for lost items on checkin (to fill the gap between mark
2823             # lost time and when the fines would have naturally stopped), then
2824             # stop_fines is no longer valid and should be cleared.
2825             #
2826             # stop_fines will be set again during the handle_fines() stage.
2827             # XXX should this setting come from the copy circ lib (like other
2828             # LOST settings), instead of the circulation circ lib?
2829             if ($stat == OILS_COPY_STATUS_LOST) {
2830                 $self->circ->clear_stop_fines if
2831                     $U->ou_ancestor_setting_value(
2832                         $self->circ_lib,
2833                         OILS_SETTING_GENERATE_OVERDUE_ON_LOST_RETURN,
2834                         $self->editor
2835                     );
2836             }
2837
2838             # Set stop_fines when claimed never checked out
2839             $self->circ->stop_fines( OILS_STOP_FINES_CLAIMS_NEVERCHECKEDOUT ) if( $self->claims_never_checked_out );
2840
2841             # handle fines for this circ, including overdue gen if needed
2842             $self->handle_fines;
2843         }
2844
2845         # Void any item deposits if the library wants to
2846         $self->check_circ_deposit(1);
2847
2848         $self->checkin_handle_circ_finish;
2849         return if $self->bail_out;
2850         $self->checkin_changed(1);
2851
2852     } elsif( $self->transit ) {
2853         my $hold_transit = $self->process_received_transit;
2854         $self->checkin_changed(1);
2855
2856         if( $self->bail_out ) {
2857             $self->checkin_flesh_events;
2858             return;
2859         }
2860
2861         if( my $e = $self->check_checkin_copy_status() ) {
2862             # If the original copy status is special, alert the caller
2863             my $ev = $self->events;
2864             $self->events([$e]);
2865             $self->override_events;
2866             return if $self->bail_out;
2867             $self->events($ev);
2868         }
2869
2870         if( $hold_transit or
2871                 $U->copy_status($self->copy->status)->id
2872                     == OILS_COPY_STATUS_ON_HOLDS_SHELF ) {
2873
2874             my $hold;
2875             if( $hold_transit ) {
2876                $hold = $self->editor->retrieve_action_hold_request($hold_transit->hold);
2877             } else {
2878                    ($hold) = $U->fetch_open_hold_by_copy($self->copy->id);
2879             }
2880
2881             $self->hold($hold);
2882
2883             if( $hold and ( $hold->cancel_time or $hold->fulfillment_time ) ) { # this transited hold was cancelled or filled mid-transit
2884
2885                 $logger->info("circulator: we received a transit on a cancelled or filled hold " . $hold->id);
2886                 $self->reshelve_copy(1);
2887                 $self->cancelled_hold_transit(1);
2888                 $self->notify_hold(0); # don't notify for cancelled holds
2889                 $self->fake_hold_dest(0);
2890                 return if $self->bail_out;
2891
2892             } elsif ($hold and $hold->hold_type eq 'R') {
2893
2894                 $self->copy->status(OILS_COPY_STATUS_CATALOGING);
2895                 $self->notify_hold(0); # No need to notify
2896                 $self->fake_hold_dest(0);
2897                 $self->noop(1); # Don't try and capture for other holds/transits now
2898                 $self->update_copy();
2899                 $hold->fulfillment_time('now');
2900                 $self->bail_on_events($self->editor->event)
2901                     unless $self->editor->update_action_hold_request($hold);
2902
2903             } else {
2904
2905                 # hold transited to correct location
2906                 if($self->fake_hold_dest) {
2907                     $hold->pickup_lib($self->circ_lib);
2908                 }
2909                 $self->checkin_flesh_events;
2910                 return;
2911             }
2912         }
2913
2914     } elsif( $U->copy_status($self->copy->status)->id == OILS_COPY_STATUS_IN_TRANSIT ) {
2915
2916         $logger->warn("circulator: we have a copy ".$self->copy->barcode.
2917             " that is in-transit, but there is no transit.. repairing");
2918         $self->reshelve_copy(1);
2919         return if $self->bail_out;
2920     }
2921
2922     if( $self->is_renewal ) {
2923         $self->finish_fines_and_voiding;
2924         return if $self->bail_out;
2925         $self->push_events(OpenILS::Event->new('SUCCESS'));
2926         return;
2927     }
2928
2929    # ------------------------------------------------------------------------------
2930    # Circulations and transits are now closed where necessary.  Now go on to see if
2931    # this copy can fulfill a hold or needs to be routed to a different location
2932    # ------------------------------------------------------------------------------
2933
2934     my $needed_for_something = 0; # formerly "needed_for_hold"
2935
2936     if(!$self->noop) { # /not/ a no-op checkin, capture for hold or put item into transit
2937
2938         if (!$self->remote_hold) {
2939             if ($self->use_booking) {
2940                 my $potential_hold = $self->hold_capture_is_possible;
2941                 my $potential_reservation = $self->reservation_capture_is_possible;
2942
2943                 if ($potential_hold and $potential_reservation) {
2944                     $logger->info("circulator: item could fulfill either hold or reservation");
2945                     $self->push_events(new OpenILS::Event(
2946                         "HOLD_RESERVATION_CONFLICT",
2947                         "hold" => $potential_hold,
2948                         "reservation" => $potential_reservation
2949                     ));
2950                     return if $self->bail_out;
2951                 } elsif ($potential_hold) {
2952                     $needed_for_something =
2953                         $self->attempt_checkin_hold_capture;
2954                 } elsif ($potential_reservation) {
2955                     $needed_for_something =
2956                         $self->attempt_checkin_reservation_capture;
2957                 }
2958             } else {
2959                 $needed_for_something = $self->attempt_checkin_hold_capture;
2960             }
2961         }
2962         return if $self->bail_out;
2963
2964         unless($needed_for_something) {
2965             my $circ_lib = (ref $self->copy->circ_lib) ?
2966                     $self->copy->circ_lib->id : $self->copy->circ_lib;
2967
2968             if( $self->remote_hold ) {
2969                 $circ_lib = $self->remote_hold->pickup_lib;
2970                 $logger->warn("circulator: Copy ".$self->copy->barcode.
2971                     " is on a remote hold's shelf, sending to $circ_lib");
2972             }
2973
2974             $logger->debug("circulator: circlib=$circ_lib, workstation=".$self->circ_lib);
2975
2976             my $suppress_transit = 0;
2977
2978             if( $circ_lib != $self->circ_lib and not ($self->hold_as_transit and $self->remote_hold) ) {
2979                 my $suppress_transit_source = $U->ou_ancestor_setting($self->circ_lib, 'circ.transit.suppress_non_hold');
2980                 if($suppress_transit_source && $suppress_transit_source->{value}) {
2981                     my $suppress_transit_dest = $U->ou_ancestor_setting($circ_lib, 'circ.transit.suppress_non_hold');
2982                     if($suppress_transit_dest && $suppress_transit_source->{value} eq $suppress_transit_dest->{value}) {
2983                         $logger->info("circulator: copy is within transit suppress group: ".$self->copy->barcode." ".$suppress_transit_source->{value});
2984                         $suppress_transit = 1;
2985                     }
2986                 }
2987             }
2988
2989             if( $suppress_transit or ( $circ_lib == $self->circ_lib and not ($self->hold_as_transit and $self->remote_hold) ) ) {
2990                 # copy is where it needs to be, either for hold or reshelving
2991
2992                 $self->checkin_handle_precat();
2993                 return if $self->bail_out;
2994
2995             } else {
2996                 # copy needs to transit "home", or stick here if it's a floating copy
2997                 if ($can_float && ($self->manual_float || !$U->is_true($self->copy->floating->manual)) && !$self->remote_hold) { # Yep, floating, stick here
2998                     $self->checkin_changed(1);
2999                     $self->copy->circ_lib( $self->circ_lib );
3000                     $self->update_copy;
3001                 } else {
3002                     my $bc = $self->copy->barcode;
3003                     $logger->info("circulator: copy $bc at the wrong location, sending to $circ_lib");
3004                     $self->checkin_build_copy_transit($circ_lib);
3005                     return if $self->bail_out;
3006                     $self->push_events(OpenILS::Event->new('ROUTE_ITEM', org => $circ_lib));
3007                 }
3008             }
3009         }
3010     } else { # no-op checkin
3011         # XXX floating items still stick where they are even with no-op checkin?
3012         if ($self->copy->floating && $can_float) {
3013             $self->checkin_changed(1);
3014             $self->copy->circ_lib( $self->circ_lib );
3015             $self->update_copy;
3016         }
3017     }
3018
3019     if($self->claims_never_checked_out and
3020             $U->ou_ancestor_setting_value($self->circ->circ_lib, 'circ.claim_never_checked_out.mark_missing')) {
3021
3022         # the item was not supposed to be checked out to the user and should now be marked as missing
3023         my $next_status = $self->next_copy_status->[0] || OILS_COPY_STATUS_MISSING;
3024         $self->copy->status($next_status);
3025         $self->update_copy;
3026
3027     } else {
3028         $self->reshelve_copy unless $needed_for_something;
3029     }
3030
3031     return if $self->bail_out;
3032
3033     unless($self->checkin_changed) {
3034
3035         $self->push_events(OpenILS::Event->new('NO_CHANGE'));
3036         my $stat = $U->copy_status($self->copy->status)->id;
3037
3038         $self->hold($U->fetch_open_hold_by_copy($self->copy->id))
3039          if( $stat == OILS_COPY_STATUS_ON_HOLDS_SHELF );
3040         $self->bail_out(1); # no need to commit anything
3041
3042     } else {
3043
3044         $self->push_events(OpenILS::Event->new('SUCCESS'))
3045             unless @{$self->events};
3046     }
3047
3048     $self->finish_fines_and_voiding;
3049
3050     OpenILS::Utils::Penalty->calculate_penalties(
3051         $self->editor, $self->patron->id, $self->circ_lib) if $self->patron;
3052
3053     $self->checkin_flesh_events;
3054     return;
3055 }
3056
3057 sub finish_fines_and_voiding {
3058     my $self = shift;
3059     return unless $self->circ;
3060
3061     return unless $self->backdate or $self->void_overdues;
3062
3063     # void overdues after fine generation to prevent concurrent DB access to overdue billings
3064     my $note = 'System: Amnesty Checkin' if $self->void_overdues;
3065
3066     my $evt = $CC->void_or_zero_overdues(
3067         $self->editor, $self->circ, {backdate => $self->void_overdues ? undef : $self->backdate, note => $note});
3068
3069     return $self->bail_on_events($evt) if $evt;
3070
3071     # Make sure the circ is open or closed as necessary.
3072     $evt = $U->check_open_xact($self->editor, $self->circ->id);
3073     return $self->bail_on_events($evt) if $evt;
3074
3075     return undef;
3076 }
3077
3078
3079 # if a deposit was paid for this item, push the event
3080 # if called with a truthy param perform the void, depending on settings
3081 sub check_circ_deposit {
3082     my $self = shift;
3083     my $void = shift;
3084
3085     return unless $self->circ;
3086
3087     my $deposit = $self->editor->search_money_billing(
3088         {   btype => 5,
3089             xact => $self->circ->id,
3090             voided => 'f'
3091         }, {idlist => 1})->[0];
3092
3093     return unless $deposit;
3094
3095     if ($void) {
3096          my $void_on_checkin = $U->ou_ancestor_setting_value(
3097              $self->circ_lib,OILS_SETTING_VOID_ITEM_DEPOSIT_ON_CHECKIN,$self->editor);
3098          if ( $void_on_checkin ) {
3099             my $evt = $CC->void_bills($self->editor,[$deposit], "DEPOSIT ITEM RETURNED");
3100             return $evt if $evt;
3101         }
3102     } else { # if void is unset this is just a check, notify that there was a deposit billing
3103         $self->push_events(OpenILS::Event->new('ITEM_DEPOSIT_PAID', payload => $deposit));
3104     }
3105 }
3106
3107 sub reshelve_copy {
3108    my $self    = shift;
3109    my $force   = $self->force || shift;
3110    my $copy    = $self->copy;
3111
3112    my $stat = $U->copy_status($copy->status)->id;
3113
3114    my $next_status = $self->next_copy_status->[0] || OILS_COPY_STATUS_RESHELVING;
3115
3116    if($force || (
3117       $stat != OILS_COPY_STATUS_ON_HOLDS_SHELF and
3118       $stat != OILS_COPY_STATUS_CATALOGING and
3119       $stat != OILS_COPY_STATUS_IN_TRANSIT and
3120       $stat != $next_status  )) {
3121
3122         $copy->status( $next_status );
3123             $self->update_copy;
3124             $self->checkin_changed(1);
3125     }
3126 }
3127
3128
3129 # Returns true if the item is at the current location
3130 # because it was transited there for a hold and the
3131 # hold has not been fulfilled
3132 sub checkin_check_holds_shelf {
3133     my $self = shift;
3134     return 0 unless $self->copy;
3135
3136     return 0 unless
3137         $U->copy_status($self->copy->status)->id ==
3138             OILS_COPY_STATUS_ON_HOLDS_SHELF;
3139
3140     # Attempt to clear shelf expired holds for this copy
3141     $holdcode->method_lookup('open-ils.circ.hold.clear_shelf.process')->run($self->editor->authtoken, $self->circ_lib, $self->copy->id)
3142         if($self->clear_expired);
3143
3144     # find the hold that put us on the holds shelf
3145     my $holds = $self->editor->search_action_hold_request(
3146         {
3147             current_copy => $self->copy->id,
3148             capture_time => { '!=' => undef },
3149             fulfillment_time => undef,
3150             cancel_time => undef,
3151         }
3152     );
3153
3154     unless(@$holds) {
3155         $logger->warn("circulator: copy is on-holds-shelf, but there is no hold - reshelving");
3156         $self->reshelve_copy(1);
3157         return 0;
3158     }
3159
3160     my $hold = $$holds[0];
3161
3162     $logger->info("circulator: we found a captured, un-fulfilled hold [".
3163         $hold->id. "] for copy ".$self->copy->barcode);
3164
3165     if( $hold->pickup_lib != $self->circ_lib and not $self->hold_as_transit ) {
3166         my $suppress_transit_circ = $U->ou_ancestor_setting($self->circ_lib, 'circ.transit.suppress_hold');
3167         if($suppress_transit_circ && $suppress_transit_circ->{value}) {
3168             my $suppress_transit_pickup = $U->ou_ancestor_setting($hold->pickup_lib, 'circ.transit.suppress_hold');
3169             if($suppress_transit_pickup && $suppress_transit_circ->{value} eq $suppress_transit_pickup->{value}) {
3170                 $logger->info("circulator: hold is within hold transit suppress group .. we're done: ".$self->copy->barcode." ".$suppress_transit_circ->{value});
3171                 $self->fake_hold_dest(1);
3172                 return 1;
3173             }
3174         }
3175     }
3176
3177     if( $hold->pickup_lib == $self->circ_lib and not $self->hold_as_transit ) {
3178         $logger->info("circulator: hold is for here .. we're done: ".$self->copy->barcode);
3179         return 1;
3180     }
3181
3182     $logger->info("circulator: hold is not for here..");
3183     $self->remote_hold($hold);
3184     return 0;
3185 }
3186
3187
3188 sub checkin_handle_precat {
3189     my $self    = shift;
3190    my $copy    = $self->copy;
3191
3192    if( $self->is_precat and ($copy->status != OILS_COPY_STATUS_CATALOGING) ) {
3193         $copy->status(OILS_COPY_STATUS_CATALOGING);
3194         $self->update_copy();
3195         $self->checkin_changed(1);
3196         $self->push_events(OpenILS::Event->new('ITEM_NOT_CATALOGED'));
3197    }
3198 }
3199
3200
3201 sub checkin_build_copy_transit {
3202     my $self            = shift;
3203     my $dest            = shift;
3204     my $copy       = $self->copy;
3205     my $transit    = Fieldmapper::action::transit_copy->new;
3206
3207     # if we are transiting an item to the shelf shelf, it's a hold transit
3208     if (my $hold = $self->remote_hold) {
3209         $transit = Fieldmapper::action::hold_transit_copy->new;
3210         $transit->hold($hold->id);
3211
3212         # the item is going into transit, remove any shelf-iness
3213         if ($hold->current_shelf_lib or $hold->shelf_time) {
3214             $hold->clear_current_shelf_lib;
3215             $hold->clear_shelf_time;
3216             return $self->bail_on_events($self->editor->event)
3217                 unless $self->editor->update_action_hold_request($hold);
3218         }
3219     }
3220
3221     #$dest  ||= (ref($copy->circ_lib)) ? $copy->circ_lib->id : $copy->circ_lib;
3222     $logger->info("circulator: transiting copy to $dest");
3223
3224     $transit->source($self->circ_lib);
3225     $transit->dest($dest);
3226     $transit->target_copy($copy->id);
3227     $transit->source_send_time('now');
3228     $transit->copy_status( $U->copy_status($copy->status)->id );
3229
3230     $logger->debug("circulator: setting copy status on transit: ".$transit->copy_status);
3231
3232     if ($self->remote_hold) {
3233         return $self->bail_on_events($self->editor->event)
3234             unless $self->editor->create_action_hold_transit_copy($transit);
3235     } else {
3236         return $self->bail_on_events($self->editor->event)
3237             unless $self->editor->create_action_transit_copy($transit);
3238     }
3239
3240     # ensure the transit is returned to the caller
3241     $self->transit($transit);
3242
3243     $copy->status(OILS_COPY_STATUS_IN_TRANSIT);
3244     $self->update_copy;
3245     $self->checkin_changed(1);
3246 }
3247
3248
3249 sub hold_capture_is_possible {
3250     my $self = shift;
3251     my $copy = $self->copy;
3252
3253     # we've been explicitly told not to capture any holds
3254     return 0 if $self->capture eq 'nocapture';
3255
3256     # See if this copy can fulfill any holds
3257     my $hold = $holdcode->find_nearest_permitted_hold(
3258         $self->editor, $copy, $self->editor->requestor, 1 # check_only
3259     );
3260     return undef if ref $hold eq "HASH" and
3261         $hold->{"textcode"} eq "ACTION_HOLD_REQUEST_NOT_FOUND";
3262     return $hold;
3263 }
3264
3265 sub reservation_capture_is_possible {
3266     my $self = shift;
3267     my $copy = $self->copy;
3268
3269     # we've been explicitly told not to capture any holds
3270     return 0 if $self->capture eq 'nocapture';
3271
3272     my $booking_ses = OpenSRF::AppSession->connect("open-ils.booking");
3273     my $resv = $booking_ses->request(
3274         "open-ils.booking.reservations.could_capture",
3275         $self->editor->authtoken, $copy->barcode
3276     )->gather(1);
3277     $booking_ses->disconnect;
3278     if (ref($resv) eq "HASH" and exists $resv->{"textcode"}) {
3279         $self->push_events($resv);
3280     } else {
3281         return $resv;
3282     }
3283 }
3284
3285 # returns true if the item was used (or may potentially be used
3286 # in subsequent calls) to capture a hold.
3287 sub attempt_checkin_hold_capture {
3288     my $self = shift;
3289     my $copy = $self->copy;
3290
3291     # we've been explicitly told not to capture any holds
3292     return 0 if $self->capture eq 'nocapture';
3293
3294     # See if this copy can fulfill any holds
3295     my ($hold, undef, $retarget) = $holdcode->find_nearest_permitted_hold(
3296         $self->editor, $copy, $self->editor->requestor );
3297
3298     if(!$hold) {
3299         $logger->debug("circulator: no potential permitted".
3300             "holds found for copy ".$copy->barcode);
3301         return 0;
3302     }
3303
3304     if($self->capture ne 'capture') {
3305         # see if this item is in a hold-capture-delay location
3306         my $location = $self->copy->location;
3307         if(!ref($location)) {
3308             $location = $self->editor->retrieve_asset_copy_location($self->copy->location);
3309             $self->copy->location($location);
3310         }
3311         if($U->is_true($location->hold_verify)) {
3312             $self->bail_on_events(
3313                 OpenILS::Event->new('HOLD_CAPTURE_DELAYED', copy_location => $location));
3314             return 1;
3315         }
3316     }
3317
3318     $self->retarget($retarget);
3319
3320     my $suppress_transit = 0;
3321     if( $hold->pickup_lib != $self->circ_lib and not $self->hold_as_transit ) {
3322         my $suppress_transit_circ = $U->ou_ancestor_setting($self->circ_lib, 'circ.transit.suppress_hold');
3323         if($suppress_transit_circ && $suppress_transit_circ->{value}) {
3324             my $suppress_transit_pickup = $U->ou_ancestor_setting($hold->pickup_lib, 'circ.transit.suppress_hold');
3325             if($suppress_transit_pickup && $suppress_transit_circ->{value} eq $suppress_transit_pickup->{value}) {
3326                 $suppress_transit = 1;
3327                 $hold->pickup_lib($self->circ_lib);
3328             }
3329         }
3330     }
3331
3332     $logger->info("circulator: found permitted hold ".$hold->id." for copy, capturing...");
3333
3334     $hold->current_copy($copy->id);
3335     $hold->capture_time('now');
3336     $self->put_hold_on_shelf($hold)
3337         if ($suppress_transit || ($hold->pickup_lib == $self->circ_lib and not $self->hold_as_transit) );
3338
3339     # prevent DB errors caused by fetching
3340     # holds from storage, and updating through cstore
3341     $hold->clear_fulfillment_time;
3342     $hold->clear_fulfillment_staff;
3343     $hold->clear_fulfillment_lib;
3344     $hold->clear_expire_time;
3345     $hold->clear_cancel_time;
3346     $hold->clear_prev_check_time unless $hold->prev_check_time;
3347
3348     $self->bail_on_events($self->editor->event)
3349         unless $self->editor->update_action_hold_request($hold);
3350     $self->hold($hold);
3351     $self->checkin_changed(1);
3352
3353     return 0 if $self->bail_out;
3354
3355     if( $suppress_transit or ( $hold->pickup_lib == $self->circ_lib && not $self->hold_as_transit ) ) {
3356
3357         if ($hold->hold_type eq 'R') {
3358             $copy->status(OILS_COPY_STATUS_CATALOGING);
3359             $hold->fulfillment_time('now');
3360             $self->noop(1); # Block other transit/hold checks
3361             $self->bail_on_events($self->editor->event)
3362                 unless $self->editor->update_action_hold_request($hold);
3363         } else {
3364             # This hold was captured in the correct location
3365             $copy->status(OILS_COPY_STATUS_ON_HOLDS_SHELF);
3366             $self->push_events(OpenILS::Event->new('SUCCESS'));
3367
3368             #$self->do_hold_notify($hold->id);
3369             $self->notify_hold($hold->id);
3370         }
3371
3372     } else {
3373
3374         # Hold needs to be picked up elsewhere.  Build a hold
3375         # transit and route the item.
3376         $self->checkin_build_hold_transit();
3377         $copy->status(OILS_COPY_STATUS_IN_TRANSIT);
3378         return 0 if $self->bail_out;
3379         $self->push_events(OpenILS::Event->new('ROUTE_ITEM', org => $hold->pickup_lib));
3380     }
3381
3382     # make sure we save the copy status
3383     $self->update_copy;
3384     return 0 if $copy->status == OILS_COPY_STATUS_CATALOGING;
3385     return 1;
3386 }
3387
3388 sub attempt_checkin_reservation_capture {
3389     my $self = shift;
3390     my $copy = $self->copy;
3391
3392     # we've been explicitly told not to capture any holds
3393     return 0 if $self->capture eq 'nocapture';
3394
3395     my $booking_ses = OpenSRF::AppSession->connect("open-ils.booking");
3396     my $evt = $booking_ses->request(
3397         "open-ils.booking.resources.capture_for_reservation",
3398         $self->editor->authtoken,
3399         $copy->barcode,
3400         1 # don't update copy - we probably have it locked
3401     )->gather(1);
3402     $booking_ses->disconnect;
3403
3404     if (ref($evt) ne "HASH" or not exists $evt->{"textcode"}) {
3405         $logger->warn(
3406             "open-ils.booking.resources.capture_for_reservation " .
3407             "didn't return an event!"
3408         );
3409     } else {
3410         if (
3411             $evt->{"textcode"} eq "RESERVATION_NOT_FOUND" and
3412             $evt->{"payload"}->{"fail_cause"} eq "not-transferable"
3413         ) {
3414             # not-transferable is an error event we'll pass on the user
3415             $logger->warn("reservation capture attempted against non-transferable item");
3416             $self->push_events($evt);
3417             return 0;
3418         } elsif ($evt->{"textcode"} eq "SUCCESS") {
3419             # Re-retrieve copy as reservation capture may have changed
3420             # its status and whatnot.
3421             $logger->info(
3422                 "circulator: booking capture win on copy " . $self->copy->id
3423             );
3424             if (my $new_copy_status = $evt->{"payload"}->{"new_copy_status"}) {
3425                 $logger->info(
3426                     "circulator: changing copy " . $self->copy->id .
3427                     "'s status from " . $self->copy->status . " to " .
3428                     $new_copy_status
3429                 );
3430                 $self->copy->status($new_copy_status);
3431                 $self->update_copy;
3432             }
3433             $self->reservation($evt->{"payload"}->{"reservation"});
3434
3435             if (exists $evt->{"payload"}->{"transit"}) {
3436                 $self->push_events(
3437                     new OpenILS::Event(
3438                         "ROUTE_ITEM",
3439                         "org" => $evt->{"payload"}->{"transit"}->dest
3440                     )
3441                 );
3442             }
3443             $self->checkin_changed(1);
3444             return 1;
3445         }
3446     }
3447     # other results are treated as "nothing to capture"
3448     return 0;
3449 }
3450
3451 sub do_hold_notify {
3452     my( $self, $holdid ) = @_;
3453
3454     my $e = new_editor(xact => 1);
3455     my $hold = $e->retrieve_action_hold_request($holdid) or return $e->die_event;
3456     $e->rollback;
3457     my $ses = OpenSRF::AppSession->create('open-ils.trigger');
3458     $ses->request('open-ils.trigger.event.autocreate', 'hold.available', $hold, $hold->pickup_lib);
3459
3460     $logger->info("circulator: running delayed hold notify process");
3461
3462 #   my $notifier = OpenILS::Application::Circ::HoldNotify->new(
3463 #       hold_id => $holdid, editor => new_editor(requestor=>$self->editor->requestor));
3464
3465     my $notifier = OpenILS::Application::Circ::HoldNotify->new(
3466         hold_id => $holdid, requestor => $self->editor->requestor);
3467
3468     $logger->debug("circulator: built hold notifier");
3469
3470     if(!$notifier->event) {
3471
3472         $logger->info("circulator: attempt at sending hold notification for hold $holdid");
3473
3474         my $stat = $notifier->send_email_notify;
3475         if( $stat == '1' ) {
3476             $logger->info("circulator: hold notify succeeded for hold $holdid");
3477             return;
3478         }
3479
3480         $logger->debug("circulator:  * hold notify cancelled or failed for hold $holdid");
3481
3482     } else {
3483         $logger->info("circulator: Not sending hold notification since the patron has no email address");
3484     }
3485 }
3486
3487 sub retarget_holds {
3488     my $self = shift;
3489     $logger->info("circulator: retargeting holds @{$self->retarget} after opportunistic capture");
3490     my $ses = OpenSRF::AppSession->create('open-ils.hold-targeter');
3491     $ses->request('open-ils.hold-targeter.target', {hold => $self->retarget});
3492     # no reason to wait for the return value
3493     return;
3494 }
3495
3496 sub checkin_build_hold_transit {
3497     my $self = shift;
3498
3499    my $copy = $self->copy;
3500    my $hold = $self->hold;
3501    my $trans = Fieldmapper::action::hold_transit_copy->new;
3502
3503     $logger->debug("circulator: building hold transit for ".$copy->barcode);
3504
3505    $trans->hold($hold->id);
3506    $trans->source($self->circ_lib);
3507    $trans->dest($hold->pickup_lib);
3508    $trans->source_send_time("now");
3509    $trans->target_copy($copy->id);
3510
3511     # when the copy gets to its destination, it will recover
3512     # this status - put it onto the holds shelf
3513    $trans->copy_status(OILS_COPY_STATUS_ON_HOLDS_SHELF);
3514
3515     return $self->bail_on_events($self->editor->event)
3516         unless $self->editor->create_action_hold_transit_copy($trans);
3517 }
3518
3519
3520
3521 sub process_received_transit {
3522     my $self = shift;
3523     my $copy = $self->copy;
3524     my $copyid = $self->copy->id;
3525
3526     my $status_name = $U->copy_status($copy->status)->name;
3527     $logger->debug("circulator: attempting transit receive on ".
3528         "copy $copyid. Copy status is $status_name");
3529
3530     my $transit = $self->transit;
3531
3532     # Check if we are in a transit suppress range
3533     my $suppress_transit = 0;
3534     if ( $transit->dest != $self->circ_lib and not ( $self->hold_as_transit and $transit->copy_status == OILS_COPY_STATUS_ON_HOLDS_SHELF ) ) {
3535         my $suppress_setting = ($transit->copy_status == OILS_COPY_STATUS_ON_HOLDS_SHELF ?  'circ.transit.suppress_hold' : 'circ.transit.suppress_non_hold');
3536         my $suppress_transit_circ = $U->ou_ancestor_setting($self->circ_lib, $suppress_setting);
3537         if($suppress_transit_circ && $suppress_transit_circ->{value}) {
3538             my $suppress_transit_dest = $U->ou_ancestor_setting($transit->dest, $suppress_setting);
3539             if($suppress_transit_dest && $suppress_transit_dest->{value} eq $suppress_transit_circ->{value}) {
3540                 $suppress_transit = 1;
3541                 $self->fake_hold_dest(1) if $transit->copy_status == OILS_COPY_STATUS_ON_HOLDS_SHELF;
3542             }
3543         }
3544     }
3545     if( not $suppress_transit and ( $transit->dest != $self->circ_lib or ($self->hold_as_transit && $transit->copy_status == OILS_COPY_STATUS_ON_HOLDS_SHELF) ) ) {
3546         # - this item is in-transit to a different location
3547         # - Or we are capturing holds as transits, so why create a new transit?
3548
3549         my $tid = $transit->id;
3550         my $loc = $self->circ_lib;
3551         my $dest = $transit->dest;
3552
3553         $logger->info("circulator: Fowarding transit on copy which is destined ".
3554             "for a different location. transit=$tid, copy=$copyid, current ".
3555             "location=$loc, destination location=$dest");
3556
3557         my $evt = OpenILS::Event->new('ROUTE_ITEM', org => $dest, payload => {});
3558
3559         # grab the associated hold object if available
3560         my $ht = $self->editor->retrieve_action_hold_transit_copy($tid);
3561         $self->hold($self->editor->retrieve_action_hold_request($ht->hold)) if $ht;
3562
3563         return $self->bail_on_events($evt);
3564     }
3565
3566     # The transit is received, set the receive time
3567     $transit->dest_recv_time('now');
3568     $self->bail_on_events($self->editor->event)
3569         unless $self->editor->update_action_transit_copy($transit);
3570
3571     my $hold_transit = $self->editor->retrieve_action_hold_transit_copy($transit->id);
3572
3573     $logger->info("circulator: Recovering original copy status in transit: ".$transit->copy_status);
3574     $copy->status( $transit->copy_status );
3575     $self->update_copy();
3576     return if $self->bail_out;
3577
3578     my $ishold = 0;
3579     if($hold_transit) {
3580         my $hold = $self->editor->retrieve_action_hold_request($hold_transit->hold);
3581
3582         if ($hold) {
3583             # hold has arrived at destination, set shelf time
3584             $self->put_hold_on_shelf($hold);
3585             $self->bail_on_events($self->editor->event)
3586                 unless $self->editor->update_action_hold_request($hold);
3587             return if $self->bail_out;
3588
3589             $self->notify_hold($hold_transit->hold);
3590             $ishold = 1;
3591         } else {
3592             $hold_transit = undef;
3593             $self->cancelled_hold_transit(1);
3594             $self->reshelve_copy(1);
3595             $self->fake_hold_dest(0);
3596         }
3597     }
3598
3599     $self->push_events(
3600         OpenILS::Event->new(
3601         'SUCCESS',
3602         ishold => $ishold,
3603       payload => { transit => $transit, holdtransit => $hold_transit } ));
3604
3605     return $hold_transit;
3606 }
3607
3608
3609 # ------------------------------------------------------------------
3610 # Sets the shelf_time and shelf_expire_time for a newly shelved hold
3611 # ------------------------------------------------------------------
3612 sub put_hold_on_shelf {
3613     my($self, $hold) = @_;
3614     $hold->shelf_time('now');
3615     $hold->current_shelf_lib($self->circ_lib);
3616     $holdcode->set_hold_shelf_expire_time($hold, $self->editor);
3617     return undef;
3618 }
3619
3620 sub handle_fines {
3621    my $self = shift;
3622    my $reservation = shift;
3623    my $dt_parser = DateTime::Format::ISO8601->new;
3624
3625    my $obj = $reservation ? $self->reservation : $self->circ;
3626
3627     my $lost_bill_opts = $self->lost_bill_options;
3628     my $circ_lib = $lost_bill_opts->{circ_lib} if $lost_bill_opts;
3629     # first, restore any voided overdues for lost, if needed
3630     if ($self->needs_lost_bill_handling and !$self->void_overdues) {
3631         my $restore_od = $U->ou_ancestor_setting_value(
3632             $circ_lib, $lost_bill_opts->{ous_restore_overdue},
3633             $self->editor) || 0;
3634         $self->checkin_handle_lost_or_lo_now_found_restore_od($circ_lib)
3635             if $restore_od;
3636     }
3637
3638     # next, handle normal overdue generation and apply stop_fines
3639     # XXX reservations don't have stop_fines
3640     # TODO revisit booking_reservation re: stop_fines support
3641     if ($reservation or !$obj->stop_fines) {
3642         my $skip_for_grace;
3643
3644         # This is a crude check for whether we are in a grace period. The code
3645         # in generate_fines() does a more thorough job, so this exists solely
3646         # as a small optimization, and might be better off removed.
3647
3648         # If we have a grace period
3649         if($obj->can('grace_period')) {
3650             # Parse out the due date
3651             my $due_date = $dt_parser->parse_datetime( clean_ISO8601($obj->due_date) );
3652             # Add the grace period to the due date
3653             $due_date->add(seconds => OpenILS::Utils::DateTime->interval_to_seconds($obj->grace_period));
3654             # Don't generate fines on circs still in grace period
3655             $skip_for_grace = $due_date > DateTime->now;
3656         }
3657         $CC->generate_fines({circs => [$obj], editor => $self->editor})
3658             unless $skip_for_grace;
3659
3660         if (!$reservation and !$obj->stop_fines) {
3661             $obj->stop_fines(OILS_STOP_FINES_CHECKIN);
3662             $obj->stop_fines(OILS_STOP_FINES_RENEW) if $self->is_renewal;
3663             $obj->stop_fines(OILS_STOP_FINES_CLAIMS_NEVERCHECKEDOUT) if $self->claims_never_checked_out;
3664             $obj->stop_fines_time('now');
3665             $obj->stop_fines_time($self->backdate) if $self->backdate;
3666             $self->editor->update_action_circulation($obj);
3667         }
3668     }
3669
3670     # finally, handle voiding of lost item and processing fees
3671     if ($self->needs_lost_bill_handling) {
3672         my $void_cost = $U->ou_ancestor_setting_value(
3673             $circ_lib, $lost_bill_opts->{ous_void_item_cost},
3674             $self->editor) || 0;
3675         my $void_proc_fee = $U->ou_ancestor_setting_value(
3676             $circ_lib, $lost_bill_opts->{ous_void_proc_fee},
3677             $self->editor) || 0;
3678         $self->checkin_handle_lost_or_lo_now_found(
3679             $lost_bill_opts->{void_cost_btype},
3680             $lost_bill_opts->{is_longoverdue}) if $void_cost;
3681         $self->checkin_handle_lost_or_lo_now_found(
3682             $lost_bill_opts->{void_fee_btype},
3683             $lost_bill_opts->{is_longoverdue}) if $void_proc_fee;
3684     }
3685
3686    return undef;
3687 }
3688
3689 sub checkin_handle_circ_start {
3690    my $self = shift;
3691    my $circ = $self->circ;
3692    my $copy = $self->copy;
3693    my $evt;
3694    my $obt;
3695
3696    $self->backdate($circ->xact_start) if $self->claims_never_checked_out;
3697
3698    # backdate the circ if necessary
3699    if($self->backdate) {
3700         my $evt = $self->checkin_handle_backdate;
3701         return $self->bail_on_events($evt) if $evt;
3702    }
3703
3704     # Set the checkin vars since we have the item
3705     $circ->checkin_time( ($self->backdate) ? $self->backdate : 'now' );
3706
3707     # capture the true scan time for back-dated checkins
3708     $circ->checkin_scan_time('now');
3709
3710     $circ->checkin_staff($self->editor->requestor->id);
3711     $circ->checkin_lib($self->circ_lib);
3712     $circ->checkin_workstation($self->editor->requestor->wsid);
3713
3714     my $circ_lib = (ref $self->copy->circ_lib) ?
3715         $self->copy->circ_lib->id : $self->copy->circ_lib;
3716     my $stat = $U->copy_status($self->copy->status)->id;
3717
3718     if ($stat == OILS_COPY_STATUS_LOST || $stat == OILS_COPY_STATUS_LOST_AND_PAID) {
3719         # we will now handle lost fines, but the copy will retain its 'lost'
3720         # status if it needs to transit home unless lost_immediately_available
3721         # is true
3722         #
3723         # if we decide to also delay fine handling until the item arrives home,
3724         # we will need to call lost fine handling code both when checking items
3725         # in and also when receiving transits
3726         $self->checkin_handle_lost($circ_lib);
3727     } elsif ($stat == OILS_COPY_STATUS_LONG_OVERDUE) {
3728         # same process as above.
3729         $self->checkin_handle_long_overdue($circ_lib);
3730     } elsif ($circ_lib != $self->circ_lib and $stat == OILS_COPY_STATUS_MISSING) {
3731         $logger->info("circulator: not updating copy status on checkin because copy is missing");
3732     } else {
3733         my $next_status = $self->next_copy_status->[0] || OILS_COPY_STATUS_RESHELVING;
3734         $self->copy->status($U->copy_status($next_status));
3735         $self->update_copy;
3736     }
3737
3738     return undef;
3739 }
3740
3741 sub checkin_handle_circ_finish {
3742     my $self = shift;
3743     my $e = $self->editor;
3744     my $circ = $self->circ;
3745
3746     # Do one last check before the final circulation update to see
3747     # if the xact_finish value should be set or not.
3748     #
3749     # The underlying money.billable_xact may have been updated to
3750     # reflect a change in xact_finish during checkin bills handling,
3751     # however we can't simply refresh the circulation from the DB,
3752     # because other changes may be pending.  Instead, reproduce the
3753     # xact_finish check here.  It won't hurt to do it again.
3754
3755     my $sum = $e->retrieve_money_billable_transaction_summary($circ->id);
3756     if ($sum) { # is this test still needed?
3757
3758         my $balance = $sum->balance_owed;
3759
3760         if ($balance == 0) {
3761             $circ->xact_finish('now');
3762         } else {
3763             $circ->clear_xact_finish;
3764         }
3765
3766         $logger->info("circulator: $balance is owed on this circulation");
3767     }
3768
3769     return $self->bail_on_events($e->event)
3770         unless $e->update_action_circulation($circ);
3771
3772     return undef;
3773 }
3774
3775 # ------------------------------------------------------------------
3776 # See if we need to void billings, etc. for lost checkin
3777 # ------------------------------------------------------------------
3778 sub checkin_handle_lost {
3779     my $self = shift;
3780     my $circ_lib = shift;
3781
3782     my $max_return = $U->ou_ancestor_setting_value($circ_lib,
3783         OILS_SETTING_MAX_ACCEPT_RETURN_OF_LOST, $self->editor) || 0;
3784
3785     $self->lost_bill_options({
3786         circ_lib => $circ_lib,
3787         ous_void_item_cost => OILS_SETTING_VOID_LOST_ON_CHECKIN,
3788         ous_void_proc_fee => OILS_SETTING_VOID_LOST_PROCESS_FEE_ON_CHECKIN,
3789         ous_restore_overdue => OILS_SETTING_RESTORE_OVERDUE_ON_LOST_RETURN,
3790         void_cost_btype => 3,
3791         void_fee_btype => 4
3792     });
3793
3794     return $self->checkin_handle_lost_or_longoverdue(
3795         circ_lib => $circ_lib,
3796         max_return => $max_return,
3797         ous_immediately_available => OILS_SETTING_LOST_IMMEDIATELY_AVAILABLE,
3798         ous_use_last_activity => undef # not supported for LOST checkin
3799     );
3800 }
3801
3802 # ------------------------------------------------------------------
3803 # See if we need to void billings, etc. for long-overdue checkin
3804 # note: not using constants below since they serve little purpose
3805 # for single-use strings that are descriptive in their own right
3806 # and mostly just complicate debugging.
3807 # ------------------------------------------------------------------
3808 sub checkin_handle_long_overdue {
3809     my $self = shift;
3810     my $circ_lib = shift;
3811
3812     $logger->info("circulator: processing long-overdue checkin...");
3813
3814     my $max_return = $U->ou_ancestor_setting_value($circ_lib,
3815         'circ.max_accept_return_of_longoverdue', $self->editor) || 0;
3816
3817     $self->lost_bill_options({
3818         circ_lib => $circ_lib,
3819         ous_void_item_cost => 'circ.void_longoverdue_on_checkin',
3820         ous_void_proc_fee => 'circ.void_longoverdue_proc_fee_on_checkin',
3821         is_longoverdue => 1,
3822         ous_restore_overdue => 'circ.restore_overdue_on_longoverdue_return',
3823         void_cost_btype => 10,
3824         void_fee_btype => 11
3825     });
3826
3827     return $self->checkin_handle_lost_or_longoverdue(
3828         circ_lib => $circ_lib,
3829         max_return => $max_return,
3830         ous_immediately_available => 'circ.longoverdue_immediately_available',
3831         ous_use_last_activity =>
3832             'circ.longoverdue.use_last_activity_date_on_return'
3833     )
3834 }
3835
3836 # last billing activity is last payment time, last billing time, or the
3837 # circ due date.  If the relevant "use last activity" org unit setting is
3838 # false/unset, then last billing activity is always the due date.
3839 sub get_circ_last_billing_activity {
3840     my $self = shift;
3841     my $circ_lib = shift;
3842     my $setting = shift;
3843     my $date = $self->circ->due_date;
3844
3845     return $date unless $setting and
3846         $U->ou_ancestor_setting_value($circ_lib, $setting, $self->editor);
3847
3848     my $xact = $self->editor->retrieve_money_billable_transaction([
3849         $self->circ->id,
3850         {flesh => 1, flesh_fields => {mbt => ['summary']}}
3851     ]);
3852
3853     if ($xact->summary) {
3854         $date = $xact->summary->last_payment_ts ||
3855                 $xact->summary->last_billing_ts ||
3856                 $self->circ->due_date;
3857     }
3858
3859     return $date;
3860 }
3861
3862
3863 sub checkin_handle_lost_or_longoverdue {
3864     my ($self, %args) = @_;
3865
3866     my $circ = $self->circ;
3867     my $max_return = $args{max_return};
3868     my $circ_lib = $args{circ_lib};
3869
3870     if ($max_return) {
3871
3872         my $last_activity =
3873             $self->get_circ_last_billing_activity(
3874                 $circ_lib, $args{ous_use_last_activity});
3875
3876         my $today = time();
3877         my @tm = reverse($last_activity =~ /([\d\.]+)/og);
3878         $tm[5] -= 1 if $tm[5] > 0;
3879         my $due = timelocal(int($tm[1]), int($tm[2]),
3880             int($tm[3]), int($tm[4]), int($tm[5]), int($tm[6]));
3881
3882         my $last_chance =
3883             OpenILS::Utils::DateTime->interval_to_seconds($max_return) + int($due);
3884
3885         $logger->info("MAX OD: $max_return LAST ACTIVITY: ".
3886             "$last_activity DUEDATE: ".$circ->due_date." TODAY: $today ".
3887                 "DUE: $due LAST: $last_chance");
3888
3889         $max_return = 0 if $today < $last_chance;
3890     }
3891
3892
3893     if ($max_return) {
3894
3895         $logger->info("circulator: check-in of lost/lo item exceeds max ".
3896             "return interval.  skipping fine/fee voiding, etc.");
3897
3898     } elsif ($self->dont_change_lost_zero) { # we leave lost zero balance alone
3899
3900         $logger->info("circulator: check-in of lost/lo item having a balance ".
3901             "of zero, skipping fine/fee voiding and reinstatement.");
3902
3903     } else { # within max-return interval or no interval defined
3904
3905         $logger->info("circulator: check-in of lost/lo item is within the ".
3906             "max return interval (or no interval is defined).  Proceeding ".
3907             "with fine/fee voiding, etc.");
3908
3909         $self->needs_lost_bill_handling(1);
3910     }
3911
3912     if ($circ_lib != $self->circ_lib) {
3913         # if the item is not home, check to see if we want to retain the
3914         # lost/longoverdue status at this point in the process
3915
3916         my $immediately_available = $U->ou_ancestor_setting_value($circ_lib,
3917             $args{ous_immediately_available}, $self->editor) || 0;
3918
3919         if ($immediately_available) {
3920             # item status does not need to be retained, so give it a
3921             # reshelving status as if it were a normal checkin
3922             my $next_status = $self->next_copy_status->[0] || OILS_COPY_STATUS_RESHELVING;
3923             $self->copy->status($U->copy_status($next_status));
3924             $self->update_copy;
3925         } else {
3926             $logger->info("circulator: leaving lost/longoverdue copy".
3927                 " status in place on checkin");
3928         }
3929     } else {
3930         # lost/longoverdue item is home and processed, treat like a normal
3931         # checkin from this point on
3932         my $next_status = $self->next_copy_status->[0] || OILS_COPY_STATUS_RESHELVING;
3933         $self->copy->status($U->copy_status($next_status));
3934         $self->update_copy;
3935     }
3936 }
3937
3938
3939 sub checkin_handle_backdate {
3940     my $self = shift;
3941
3942     # ------------------------------------------------------------------
3943     # clean up the backdate for date comparison
3944     # XXX We are currently taking the due-time from the original due-date,
3945     # not the input.  Do we need to do this?  This certainly interferes with
3946     # backdating of hourly checkouts, but that is likely a very rare case.
3947     # ------------------------------------------------------------------
3948     my $bd = clean_ISO8601($self->backdate);
3949     my $original_date = DateTime::Format::ISO8601->new->parse_datetime(clean_ISO8601($self->circ->due_date));
3950     my $new_date = DateTime::Format::ISO8601->new->parse_datetime($bd);
3951     $new_date->set_hour($original_date->hour());
3952     $new_date->set_minute($original_date->minute());
3953     if ($new_date >= DateTime->now) {
3954         # We can't say that the item will be checked in later...so assume someone's clock is wrong instead.
3955         # $self->backdate() autoload handler ignores undef values.
3956         # Clear the backdate manually.
3957         $logger->info("circulator: ignoring future backdate: $new_date");
3958         delete $self->{backdate};
3959     } else {
3960         $self->backdate(clean_ISO8601($new_date->datetime()));
3961     }
3962
3963     return undef;
3964 }
3965
3966
3967 sub check_checkin_copy_status {
3968     my $self = shift;
3969    my $copy = $self->copy;
3970
3971    my $status = $U->copy_status($copy->status)->id;
3972
3973    return undef
3974       if(   $self->new_copy_alerts ||
3975             $status == OILS_COPY_STATUS_AVAILABLE   ||
3976             $status == OILS_COPY_STATUS_CHECKED_OUT ||
3977             $status == OILS_COPY_STATUS_IN_PROCESS  ||
3978             $status == OILS_COPY_STATUS_ON_HOLDS_SHELF  ||
3979             $status == OILS_COPY_STATUS_IN_TRANSIT  ||
3980             $status == OILS_COPY_STATUS_CATALOGING  ||
3981             $status == OILS_COPY_STATUS_ON_RESV_SHELF  ||
3982             $status == OILS_COPY_STATUS_CANCELED_TRANSIT ||
3983             $status == OILS_COPY_STATUS_RESHELVING );
3984
3985    return OpenILS::Event->new('COPY_STATUS_LOST', payload => $copy )
3986       if( $status == OILS_COPY_STATUS_LOST );
3987
3988     return OpenILS::Event->new('COPY_STATUS_LOST_AND_PAID', payload => $copy)
3989         if ($status == OILS_COPY_STATUS_LOST_AND_PAID);
3990
3991    return OpenILS::Event->new('COPY_STATUS_LONG_OVERDUE', payload => $copy )
3992       if( $status == OILS_COPY_STATUS_LONG_OVERDUE );
3993
3994    return OpenILS::Event->new('COPY_STATUS_MISSING', payload => $copy )
3995       if( $status == OILS_COPY_STATUS_MISSING );
3996
3997    return OpenILS::Event->new('COPY_BAD_STATUS', payload => $copy );
3998 }
3999
4000
4001
4002 # --------------------------------------------------------------------------
4003 # On checkin, we need to return as many relevant objects as we can
4004 # --------------------------------------------------------------------------
4005 sub checkin_flesh_events {
4006     my $self = shift;
4007
4008     if( grep { $_->{textcode} eq 'SUCCESS' } @{$self->events}
4009         and grep { $_->{textcode} eq 'ITEM_NOT_CATALOGED' } @{$self->events} ) {
4010             $self->events([grep { $_->{textcode} eq 'ITEM_NOT_CATALOGED' } @{$self->events}]);
4011     }
4012
4013     my $record = $U->record_to_mvr($self->title) if($self->title and !$self->is_precat);
4014
4015     my $hold;
4016     if($self->hold and !$self->hold->cancel_time) {
4017         $hold = $self->hold;
4018         $hold->notes($self->editor->search_action_hold_request_note({hold => $hold->id}));
4019     }
4020
4021     if($self->circ) {
4022         # update our copy of the circ object and
4023         # flesh the billing summary data
4024         $self->circ(
4025             $self->editor->retrieve_action_circulation([
4026                 $self->circ->id, {
4027                     flesh => 2,
4028                     flesh_fields => {
4029                         circ => ['billable_transaction'],
4030                         mbt => ['summary']
4031                     }
4032                 }
4033             ])
4034         );
4035     }
4036
4037     if($self->patron) {
4038         # flesh some patron fields before returning
4039         $self->patron(
4040             $self->editor->retrieve_actor_user([
4041                 $self->patron->id,
4042                 {
4043                     flesh => 1,
4044                     flesh_fields => {
4045                         au => ['card', 'billing_address', 'mailing_address']
4046                     }
4047                 }
4048             ])
4049         );
4050     }
4051
4052     # Flesh the latest inventory.
4053     # NB: This survives the unflesh_copy below. Let's keep it that way.
4054     my $alci = $self->editor->search_asset_latest_inventory([
4055         {copy=>$self->copy->id},
4056         {flesh => 1,
4057          flesh_fields => {
4058              alci => ['inventory_workstation']
4059          }}]);
4060     if ($alci && $alci->[0]) {
4061         $self->copy->latest_inventory($alci->[0]);
4062     }
4063
4064     for my $evt (@{$self->events}) {
4065
4066         my $payload         = {};
4067         $payload->{copy}    = $U->unflesh_copy($self->copy);
4068         $payload->{volume}  = $self->volume;
4069         $payload->{record}  = $record,
4070         $payload->{circ}    = $self->circ;
4071         $payload->{transit} = $self->transit;
4072         $payload->{cancelled_hold_transit} = 1 if $self->cancelled_hold_transit;
4073         $payload->{hold}    = $hold;
4074         $payload->{patron}  = $self->patron;
4075         $payload->{reservation} = $self->reservation
4076             unless (not $self->reservation or $self->reservation->cancel_time);
4077
4078         $evt->{payload}     = $payload;
4079     }
4080 }
4081
4082 sub log_me {
4083     my( $self, $msg ) = @_;
4084     my $bc = ($self->copy) ? $self->copy->barcode :
4085         $self->copy_barcode;
4086     $bc ||= "";
4087     my $usr = ($self->patron) ? $self->patron->id : "";
4088     $logger->info("circulator: $msg requestor=".$self->editor->requestor->id.
4089         ", recipient=$usr, copy=$bc");
4090 }
4091
4092
4093 sub do_renew {
4094     my $self = shift;
4095     my $api = shift;
4096     $self->log_me("do_renew()");
4097
4098     # Make sure there is an open circ to renew
4099     my $usrid = $self->patron->id if $self->patron;
4100     my $circ = $self->editor->search_action_circulation({
4101         target_copy => $self->copy->id,
4102         xact_finish => undef,
4103         checkin_time => undef,
4104         ($usrid ? (usr => $usrid) : ())
4105     })->[0];
4106
4107     return $self->bail_on_events($self->editor->event) unless $circ;
4108
4109     # A user is not allowed to renew another user's items without permission
4110     unless( $circ->usr eq $self->editor->requestor->id ) {
4111         return $self->bail_on_events($self->editor->events)
4112             unless $self->editor->allowed('RENEW_CIRC', $circ->circ_lib);
4113     }
4114
4115     $self->push_events(OpenILS::Event->new('MAX_RENEWALS_REACHED'))
4116         if $circ->renewal_remaining < 1;
4117
4118     $self->push_events(OpenILS::Event->new('MAX_AUTO_RENEWALS_REACHED'))
4119         if $self->auto_renewal and $circ->auto_renewal_remaining < 1;
4120     # -----------------------------------------------------------------
4121
4122     $self->parent_circ($circ->id);
4123     $self->renewal_remaining( $circ->renewal_remaining - 1 );
4124     $self->auto_renewal_remaining( $circ->auto_renewal_remaining - 1 ) if (defined($circ->auto_renewal_remaining));
4125     $self->circ($circ);
4126
4127     # Opac renewal - re-use circ library from original circ (unless told not to)
4128     if($self->opac_renewal or $self->auto_renewal) {
4129         unless(defined($opac_renewal_use_circ_lib)) {
4130             my $use_circ_lib = $self->editor->retrieve_config_global_flag('circ.opac_renewal.use_original_circ_lib');
4131             if($use_circ_lib and $U->is_true($use_circ_lib->enabled)) {
4132                 $opac_renewal_use_circ_lib = 1;
4133             }
4134             else {
4135                 $opac_renewal_use_circ_lib = 0;
4136             }
4137         }
4138         $self->circ_lib($circ->circ_lib) if($opac_renewal_use_circ_lib);
4139     }
4140
4141     # Desk renewal - re-use circ library from original circ (unless told not to)
4142     if($self->desk_renewal) {
4143         unless(defined($desk_renewal_use_circ_lib)) {
4144             my $use_circ_lib = $self->editor->retrieve_config_global_flag('circ.desk_renewal.use_original_circ_lib');
4145             if($use_circ_lib and $U->is_true($use_circ_lib->enabled)) {
4146                 $desk_renewal_use_circ_lib = 1;
4147             }
4148             else {
4149                 $desk_renewal_use_circ_lib = 0;
4150             }
4151         }
4152         $self->circ_lib($circ->circ_lib) if($desk_renewal_use_circ_lib);
4153     }
4154
4155     # Check if expired patron is allowed to renew, and bail if not.
4156     my $expire = DateTime::Format::ISO8601->new->parse_datetime(clean_ISO8601($self->patron->expire_date));
4157     if (CORE::time > $expire->epoch) {
4158         my $allow_renewal = $U->ou_ancestor_setting_value($self->circ_lib, OILS_SETTING_ALLOW_RENEW_FOR_EXPIRED_PATRON);
4159         unless ($U->is_true($allow_renewal)) {
4160             return $self->bail_on_events(OpenILS::Event->new('PATRON_ACCOUNT_EXPIRED'));
4161         }
4162     }
4163
4164     # Run the fine generator against the old circ
4165     # XXX This seems unnecessary, given that handle_fines runs in do_checkin
4166     # a few lines down.  Commenting out, for now.
4167     #$self->handle_fines;
4168
4169     $self->run_renew_permit;
4170
4171     # Check the item in
4172     $self->do_checkin();
4173     return if $self->bail_out;
4174
4175     unless( $self->permit_override ) {
4176         $self->do_permit();
4177         return if $self->bail_out;
4178         $self->is_precat(1) if $self->have_event('ITEM_NOT_CATALOGED');
4179         $self->remove_event('ITEM_NOT_CATALOGED');
4180     }
4181
4182     $self->override_events;
4183     return if $self->bail_out;
4184
4185     $self->events([]);
4186     $self->do_checkout();
4187 }
4188
4189
4190 sub remove_event {
4191     my( $self, $evt ) = @_;
4192     $evt = (ref $evt) ? $evt->{textcode} : $evt;
4193     $logger->debug("circulator: removing event from list: $evt");
4194     my @events = @{$self->events};
4195     $self->events( [ grep { $_->{textcode} ne $evt } @events ] );
4196 }
4197
4198
4199 sub have_event {
4200     my( $self, $evt ) = @_;
4201     $evt = (ref $evt) ? $evt->{textcode} : $evt;
4202     return grep { $_->{textcode} eq $evt } @{$self->events};
4203 }
4204
4205
4206 sub run_renew_permit {
4207     my $self = shift;
4208
4209     if ($U->ou_ancestor_setting_value($self->circ_lib, 'circ.block_renews_for_holds')) {
4210         my ($hold, undef, $retarget) = $holdcode->find_nearest_permitted_hold(
4211             $self->editor, $self->copy, $self->editor->requestor, 1
4212         );
4213         $self->push_events(new OpenILS::Event("COPY_NEEDED_FOR_HOLD")) if $hold;
4214     }
4215
4216     my $results = $self->run_indb_circ_test;
4217     $self->push_events($self->matrix_test_result_events)
4218         unless $self->circ_test_success;
4219 }
4220
4221
4222 # XXX: The primary mechanism for storing circ history is now handled
4223 # by tracking real circulation objects instead of bibs in a bucket.
4224 # However, this code is disabled by default and could be useful
4225 # some day, so may as well leave it for now.
4226 sub append_reading_list {
4227     my $self = shift;
4228
4229     return undef unless
4230         $self->is_checkout and
4231         $self->patron and
4232         $self->copy and
4233         !$self->is_noncat;
4234
4235
4236     # verify history is globally enabled and uses the bucket mechanism
4237     my $htype = OpenSRF::Utils::SettingsClient->new->config_value(
4238         apps => 'open-ils.circ' => app_settings => 'checkout_history_mechanism');
4239
4240     return undef unless $htype and $htype eq 'bucket';
4241
4242     my $e = new_editor(xact => 1, requestor => $self->editor->requestor);
4243
4244     # verify the patron wants to retain the hisory
4245     my $setting = $e->search_actor_user_setting(
4246         {usr => $self->patron->id, name => 'circ.keep_checkout_history'})->[0];
4247
4248     unless($setting and $setting->value) {
4249         $e->rollback;
4250         return undef;
4251     }
4252
4253     my $bkt = $e->search_container_copy_bucket(
4254         {owner => $self->patron->id, btype => 'circ_history'})->[0];
4255
4256     my $pos = 1;
4257
4258     if($bkt) {
4259         # find the next item position
4260         my $last_item = $e->search_container_copy_bucket_item(
4261             {bucket => $bkt->id}, {order_by => {ccbi => 'pos desc'}, limit => 1})->[0];
4262         $pos = $last_item->pos + 1 if $last_item;
4263
4264     } else {
4265         # create the history bucket if necessary
4266         $bkt = Fieldmapper::container::copy_bucket->new;
4267         $bkt->owner($self->patron->id);
4268         $bkt->name('');
4269         $bkt->btype('circ_history');
4270         $bkt->pub('f');
4271         $e->create_container_copy_bucket($bkt) or return $e->die_event;
4272     }
4273
4274     my $item = Fieldmapper::container::copy_bucket_item->new;
4275
4276     $item->bucket($bkt->id);
4277     $item->target_copy($self->copy->id);
4278     $item->pos($pos);
4279
4280     $e->create_container_copy_bucket_item($item) or return $e->die_event;
4281     $e->commit;
4282
4283     return undef;
4284 }
4285
4286
4287 sub make_trigger_events {
4288     my $self = shift;
4289     return unless $self->circ;
4290     $U->create_events_for_hook('checkout', $self->circ, $self->circ_lib) if $self->is_checkout;
4291     $U->create_events_for_hook('checkin',  $self->circ, $self->circ_lib) if $self->is_checkin;
4292     $U->create_events_for_hook('renewal',  $self->circ, $self->circ_lib) if $self->is_renewal;
4293 }
4294
4295
4296
4297 sub checkin_handle_lost_or_lo_now_found {
4298     my ($self, $bill_type, $is_longoverdue) = @_;
4299
4300     my $tag = $is_longoverdue ? "LONGOVERDUE" : "LOST";
4301
4302     $logger->debug("voiding $tag item billings");
4303     my $result = $CC->void_or_zero_bills_of_type($self->editor, $self->circ, $self->copy, $bill_type, "$tag ITEM RETURNED");
4304     $self->bail_on_events($self->editor->event) if ($result);
4305 }
4306
4307 sub checkin_handle_lost_or_lo_now_found_restore_od {
4308     my $self = shift;
4309     my $circ_lib = shift;
4310     my $is_longoverdue = shift;
4311     my $tag = $is_longoverdue ? "LONGOVERDUE" : "LOST";
4312
4313     # ------------------------------------------------------------------
4314     # restore those overdue charges voided when item was set to lost
4315     # ------------------------------------------------------------------
4316
4317     my $ods = $self->editor->search_money_billing([
4318         {
4319             xact => $self->circ->id,
4320             btype => 1
4321         },
4322         {
4323             order_by => {mb => 'billing_ts desc'}
4324         }
4325     ]);
4326
4327     $logger->debug("returning ".scalar(@$ods)." overdue charges pre-$tag");
4328     # Because actual users get up to all kinds of unexpectedness, we
4329     # only recreate up to $circ->max_fine in bills.  I know you think
4330     # it wouldn't happen that bills could get created, voided, and
4331     # recreated more than once, but I guaran-damn-tee you that it will
4332     # happen.
4333     if ($ods && @$ods) {
4334         my $void_amount = 0;
4335         my $void_max = $self->circ->max_fine();
4336         # search for overdues voided the new way (aka "adjusted")
4337         my @billings = map {$_->id()} @$ods;
4338         my $voids = $self->editor->search_money_account_adjustment(
4339             {
4340                 billing => \@billings
4341             }
4342         );
4343         if (@$voids) {
4344             map {$void_amount += $_->amount()} @$voids;
4345         } else {
4346             # if no adjustments found, assume they were voided the old way (aka "voided")
4347             for my $bill (@$ods) {
4348                 if( $U->is_true($bill->voided) ) {
4349                     $void_amount += $bill->amount();
4350                 }
4351             }
4352         }
4353         $CC->create_bill(
4354             $self->editor,
4355             ($void_amount < $void_max ? $void_amount : $void_max),
4356             $ods->[0]->btype(),
4357             $ods->[0]->billing_type(),
4358             $self->circ->id(),
4359             "System: $tag RETURNED - OVERDUES REINSTATED",
4360             $ods->[-1]->period_start(),
4361             $ods->[0]->period_end() # date this restoration the same as the last overdue (for possible subsequent fine generation)
4362         );
4363     }
4364 }
4365
4366 1;