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;
12 my $U = "OpenILS::Application::AppUtils";
16 my $opac_renewal_use_circ_lib;
17 my $desk_renewal_use_circ_lib;
19 sub determine_booking_status {
20 unless (defined $booking_status) {
21 my $router_name = OpenSRF::Utils::Config
24 ->router_name || 'router';
26 my $ses = create OpenSRF::AppSession($router_name);
27 $booking_status = grep {$_ eq "open-ils.booking"} @{
28 $ses->request("opensrf.router.info.class.list")->gather(1)
31 $logger->info("booking status: " . ($booking_status ? "on" : "off"));
34 return $booking_status;
40 flesh_fields => {acp => ['call_number','parts','floating'], acn => ['record']}
45 __PACKAGE__->register_method(
46 method => "run_method",
47 api_name => "open-ils.circ.checkout.permit",
49 Determines if the given checkout can occur
50 @param authtoken The login session key
51 @param params A trailing hash of named params including
52 barcode : The copy barcode,
53 patron : The patron the checkout is occurring for,
54 renew : true or false - whether or not this is a renewal
55 @return The event that occurred during the permit check.
59 __PACKAGE__->register_method (
60 method => 'run_method',
61 api_name => 'open-ils.circ.checkout.permit.override',
62 signature => q/@see open-ils.circ.checkout.permit/,
66 __PACKAGE__->register_method(
67 method => "run_method",
68 api_name => "open-ils.circ.checkout",
71 @param authtoken The login session key
72 @param params A named hash of params including:
74 barcode If no copy is provided, the copy is retrieved via barcode
75 copyid If no copy or barcode is provide, the copy id will be use
76 patron The patron's id
77 noncat True if this is a circulation for a non-cataloted item
78 noncat_type The non-cataloged type id
79 noncat_circ_lib The location for the noncat circ.
80 precat The item has yet to be cataloged
81 dummy_title The temporary title of the pre-cataloded item
82 dummy_author The temporary authr of the pre-cataloded item
83 Default is the home org of the staff member
84 @return The SUCCESS event on success, any other event depending on the error
87 __PACKAGE__->register_method(
88 method => "run_method",
89 api_name => "open-ils.circ.checkin",
92 Generic super-method for handling all copies
93 @param authtoken The login session key
94 @param params Hash of named parameters including:
95 barcode - The copy barcode
96 force - If true, copies in bad statuses will be checked in and give good statuses
97 noop - don't capture holds or put items into transit
98 void_overdues - void all overdues for the circulation (aka amnesty)
103 __PACKAGE__->register_method(
104 method => "run_method",
105 api_name => "open-ils.circ.checkin.override",
106 signature => q/@see open-ils.circ.checkin/
109 __PACKAGE__->register_method(
110 method => "run_method",
111 api_name => "open-ils.circ.renew.override",
112 signature => q/@see open-ils.circ.renew/,
116 __PACKAGE__->register_method(
117 method => "run_method",
118 api_name => "open-ils.circ.renew",
119 notes => <<" NOTES");
120 PARAMS( authtoken, circ => circ_id );
121 open-ils.circ.renew(login_session, circ_object);
122 Renews the provided circulation. login_session is the requestor of the
123 renewal and if the logged in user is not the same as circ->usr, then
124 the logged in user must have RENEW_CIRC permissions.
127 __PACKAGE__->register_method(
128 method => "run_method",
129 api_name => "open-ils.circ.checkout.full"
131 __PACKAGE__->register_method(
132 method => "run_method",
133 api_name => "open-ils.circ.checkout.full.override"
135 __PACKAGE__->register_method(
136 method => "run_method",
137 api_name => "open-ils.circ.reservation.pickup"
139 __PACKAGE__->register_method(
140 method => "run_method",
141 api_name => "open-ils.circ.reservation.return"
143 __PACKAGE__->register_method(
144 method => "run_method",
145 api_name => "open-ils.circ.reservation.return.override"
147 __PACKAGE__->register_method(
148 method => "run_method",
149 api_name => "open-ils.circ.checkout.inspect",
150 desc => q/Returns the circ matrix test result and, on success, the rule set and matrix test object/
155 my( $self, $conn, $auth, $args ) = @_;
156 translate_legacy_args($args);
157 $args->{override_args} = { all => 1 } unless defined $args->{override_args};
158 my $api = $self->api_name;
161 OpenILS::Application::Circ::Circulator->new($auth, %$args);
163 return circ_events($circulator) if $circulator->bail_out;
165 $circulator->use_booking(determine_booking_status());
167 # --------------------------------------------------------------------------
168 # First, check for a booking transit, as the barcode may not be a copy
169 # barcode, but a resource barcode, and nothing else in here will work
170 # --------------------------------------------------------------------------
172 if ($circulator->use_booking && (my $bc = $circulator->copy_barcode) && $api !~ /checkout|inspect/) { # do we have a barcode?
173 my $resources = $circulator->editor->search_booking_resource( { barcode => $bc } ); # any resources by this barcode?
174 if (@$resources) { # yes!
176 my $res_id_list = [ map { $_->id } @$resources ];
177 my $transit = $circulator->editor->search_action_reservation_transit_copy(
179 { target_copy => $res_id_list, dest => $circulator->circ_lib, dest_recv_time => undef },
180 { order_by => { artc => 'source_send_time' }, limit => 1 }
182 )->[0]; # Any transit for this barcode?
184 if ($transit) { # yes! unwrap it.
186 my $reservation = $circulator->editor->retrieve_booking_reservation( $transit->reservation );
187 my $res_type = $circulator->editor->retrieve_booking_resource_type( $reservation->target_resource_type );
189 my $success_event = new OpenILS::Event(
190 "SUCCESS", "payload" => {"reservation" => $reservation}
192 if ($U->is_true($res_type->catalog_item)) { # is there a copy to be had here?
193 if (my $copy = $circulator->editor->search_asset_copy([
194 { barcode => $bc, deleted => 'f' }, $MK_ENV_FLESH
195 ])->[0]) { # got a copy
196 $copy->status( $transit->copy_status );
197 $copy->editor($circulator->editor->requestor->id);
198 $copy->edit_date('now');
199 $circulator->editor->update_asset_copy($copy);
200 $success_event->{"payload"}->{"record"} =
201 $U->record_to_mvr($copy->call_number->record);
202 $success_event->{"payload"}->{"volume"} = $copy->call_number;
203 $copy->call_number($copy->call_number->id);
204 $success_event->{"payload"}->{"copy"} = $copy;
208 $transit->dest_recv_time('now');
209 $circulator->editor->update_action_reservation_transit_copy( $transit );
211 $circulator->editor->commit;
212 # Formerly this branch just stopped here. Argh!
213 $conn->respond_complete($success_event);
219 if ($circulator->use_booking) {
220 $circulator->is_res_checkin($circulator->is_checkin(1))
221 if $api =~ /reservation.return/ or (
222 $api =~ /checkin/ and $circulator->seems_like_reservation()
225 $circulator->is_res_checkout(1) if $api =~ /reservation.pickup/;
228 $circulator->is_renewal(1) if $api =~ /renew/;
229 $circulator->is_checkin(1) if $api =~ /checkin/;
231 $circulator->mk_env();
232 $circulator->noop(1) if $circulator->claims_never_checked_out;
234 return circ_events($circulator) if $circulator->bail_out;
236 $circulator->override(1) if $api =~ /override/o;
238 if( $api =~ /checkout\.permit/ ) {
239 $circulator->do_permit();
241 } elsif( $api =~ /checkout.full/ ) {
243 # requesting a precat checkout implies that any required
244 # overrides have been performed. Go ahead and re-override.
245 $circulator->skip_permit_key(1);
246 $circulator->override(1) if $circulator->request_precat;
247 $circulator->do_permit();
248 $circulator->is_checkout(1);
249 unless( $circulator->bail_out ) {
250 $circulator->events([]);
251 $circulator->do_checkout();
254 } elsif( $circulator->is_res_checkout ) {
255 $circulator->do_reservation_pickup();
257 } elsif( $api =~ /inspect/ ) {
258 my $data = $circulator->do_inspect();
259 $circulator->editor->rollback;
262 } elsif( $api =~ /checkout/ ) {
263 $circulator->is_checkout(1);
264 $circulator->do_checkout();
266 } elsif( $circulator->is_res_checkin ) {
267 $circulator->do_reservation_return();
268 $circulator->do_checkin() if ($circulator->copy());
269 } elsif( $api =~ /checkin/ ) {
270 $circulator->do_checkin();
272 } elsif( $api =~ /renew/ ) {
273 $circulator->is_renewal(1);
274 $circulator->do_renew();
277 if( $circulator->bail_out ) {
280 # make sure no success event accidentally slip in
282 [ grep { $_->{textcode} ne 'SUCCESS' } @{$circulator->events} ]);
285 my @e = @{$circulator->events};
286 push( @ee, $_->{textcode} ) for @e;
287 $logger->info("circulator: bailing out with events: " . (join ", ", @ee));
289 $circulator->editor->rollback;
293 $circulator->editor->commit;
296 $conn->respond_complete(circ_events($circulator));
298 return undef if $circulator->bail_out;
300 $circulator->do_hold_notify($circulator->notify_hold)
301 if $circulator->notify_hold;
302 $circulator->retarget_holds if $circulator->retarget;
303 $circulator->append_reading_list;
304 $circulator->make_trigger_events;
311 my @e = @{$circ->events};
312 # if we have multiple events, SUCCESS should not be one of them;
313 @e = grep { $_->{textcode} ne 'SUCCESS' } @e if @e > 1;
314 return (@e == 1) ? $e[0] : \@e;
318 sub translate_legacy_args {
321 if( $$args{barcode} ) {
322 $$args{copy_barcode} = $$args{barcode};
323 delete $$args{barcode};
326 if( $$args{copyid} ) {
327 $$args{copy_id} = $$args{copyid};
328 delete $$args{copyid};
331 if( $$args{patronid} ) {
332 $$args{patron_id} = $$args{patronid};
333 delete $$args{patronid};
336 if( $$args{patron} and !ref($$args{patron}) ) {
337 $$args{patron_id} = $$args{patron};
338 delete $$args{patron};
342 if( $$args{noncat} ) {
343 $$args{is_noncat} = $$args{noncat};
344 delete $$args{noncat};
347 if( $$args{precat} ) {
348 $$args{is_precat} = $$args{request_precat} = $$args{precat};
349 delete $$args{precat};
355 # --------------------------------------------------------------------------
356 # This package actually manages all of the circulation logic
357 # --------------------------------------------------------------------------
358 package OpenILS::Application::Circ::Circulator;
359 use strict; use warnings;
360 use vars q/$AUTOLOAD/;
362 use OpenILS::Utils::Fieldmapper;
363 use OpenSRF::Utils::Cache;
364 use Digest::MD5 qw(md5_hex);
365 use DateTime::Format::ISO8601;
366 use OpenILS::Utils::PermitHold;
367 use OpenSRF::Utils qw/:datetime/;
368 use OpenSRF::Utils::SettingsClient;
369 use OpenILS::Application::Circ::Holds;
370 use OpenILS::Application::Circ::Transit;
371 use OpenSRF::Utils::Logger qw(:logger);
372 use OpenILS::Utils::CStoreEditor qw/:funcs/;
373 use OpenILS::Const qw/:const/;
374 use OpenILS::Utils::Penalty;
375 use OpenILS::Application::Circ::CircCommon;
378 my $CC = "OpenILS::Application::Circ::CircCommon";
379 my $holdcode = "OpenILS::Application::Circ::Holds";
380 my $transcode = "OpenILS::Application::Circ::Transit";
386 # --------------------------------------------------------------------------
387 # Add a pile of automagic getter/setter methods
388 # --------------------------------------------------------------------------
389 my @AUTOLOAD_FIELDS = qw/
435 recurring_fines_level
448 cancelled_hold_transit
455 circ_matrix_matchpoint
466 claims_never_checked_out
479 dont_change_lost_zero
481 needs_lost_bill_handling
487 my $type = ref($self) or die "$self is not an object";
489 my $name = $AUTOLOAD;
492 unless (grep { $_ eq $name } @AUTOLOAD_FIELDS) {
493 $logger->error("circulator: $type: invalid autoload field: $name");
494 die "$type: invalid autoload field: $name\n"
499 *{"${type}::${name}"} = sub {
502 $s->{$name} = $v if defined $v;
506 return $self->$name($data);
511 my( $class, $auth, %args ) = @_;
512 $class = ref($class) || $class;
513 my $self = bless( {}, $class );
516 $self->editor(new_editor(xact => 1, authtoken => $auth));
518 unless( $self->editor->checkauth ) {
519 $self->bail_on_events($self->editor->event);
523 $self->cache_handle(OpenSRF::Utils::Cache->new('global'));
525 $self->$_($args{$_}) for keys %args;
528 ($self->circ_lib) ? $self->circ_lib : $self->editor->requestor->ws_ou);
530 # if this is a renewal, default to desk_renewal
531 $self->desk_renewal(1) unless
532 $self->opac_renewal or $self->phone_renewal or $self->sip_renewal;
534 $self->capture('') unless $self->capture;
536 unless(%user_groups) {
537 my $gps = $self->editor->retrieve_all_permission_grp_tree;
538 %user_groups = map { $_->id => $_ } @$gps;
545 # --------------------------------------------------------------------------
546 # True if we should discontinue processing
547 # --------------------------------------------------------------------------
549 my( $self, $bool ) = @_;
550 if( defined $bool ) {
551 $logger->info("circulator: BAILING OUT") if $bool;
552 $self->{bail_out} = $bool;
554 return $self->{bail_out};
559 my( $self, @evts ) = @_;
562 $e->{payload} = $self->copy if
563 ($e->{textcode} eq 'COPY_NOT_AVAILABLE');
565 $logger->info("circulator: pushing event ".$e->{textcode});
566 push( @{$self->events}, $e ) unless
567 grep { $_->{textcode} eq $e->{textcode} } @{$self->events};
573 return '' if $self->skip_permit_key;
574 my $key = md5_hex( time() . rand() . "$$" );
575 $self->cache_handle->put_cache( "oils_permit_key_$key", 1, 300 );
576 return $self->permit_key($key);
579 sub check_permit_key {
581 return 1 if $self->skip_permit_key;
582 my $key = $self->permit_key;
583 return 0 unless $key;
584 my $k = "oils_permit_key_$key";
585 my $one = $self->cache_handle->get_cache($k);
586 $self->cache_handle->delete_cache($k);
587 return ($one) ? 1 : 0;
590 sub seems_like_reservation {
593 # Some words about the following method:
594 # 1) It requires the VIEW_USER permission, but that's not an
595 # issue, right, since all staff should have that?
596 # 2) It returns only one reservation at a time, even if an item can be
597 # and is currently overbooked. Hmmm....
598 my $booking_ses = create OpenSRF::AppSession("open-ils.booking");
599 my $result = $booking_ses->request(
600 "open-ils.booking.reservations.by_returnable_resource_barcode",
601 $self->editor->authtoken,
604 $booking_ses->disconnect;
606 return $self->bail_on_events($result) if defined $U->event_code($result);
609 $self->reservation(shift @$result);
617 # save_trimmed_copy() used just to be a block in mk_env(), but was separated for re-use
618 sub save_trimmed_copy {
619 my ($self, $copy) = @_;
622 $self->volume($copy->call_number);
623 $self->title($self->volume->record);
624 $self->copy->call_number($self->volume->id);
625 $self->volume->record($self->title->id);
626 $self->is_precat(1) if $self->volume->id == OILS_PRECAT_CALL_NUMBER;
627 if($self->copy->deposit_amount and $self->copy->deposit_amount > 0) {
628 $self->is_deposit(1) if $U->is_true($self->copy->deposit);
629 $self->is_rental(1) unless $U->is_true($self->copy->deposit);
635 my $e = $self->editor;
637 # --------------------------------------------------------------------------
638 # Grab the fleshed copy
639 # --------------------------------------------------------------------------
640 unless($self->is_noncat) {
643 $copy = $e->retrieve_asset_copy(
644 [$self->copy_id, $MK_ENV_FLESH ]) or return $e->event;
646 } elsif( $self->copy_barcode ) {
648 $copy = $e->search_asset_copy(
649 [{barcode => $self->copy_barcode, deleted => 'f'}, $MK_ENV_FLESH ])->[0];
650 } elsif( $self->reservation ) {
651 my $res = $e->json_query(
653 "select" => {"acp" => ["id"]},
658 "field" => "barcode",
662 "field" => "current_resource"
670 "id" => (ref $self->reservation) ?
671 $self->reservation->id : $self->reservation
676 if (ref $res eq "ARRAY" and scalar @$res) {
677 $logger->info("circulator: mapped reservation " .
678 $self->reservation . " to copy " . $res->[0]->{"id"});
679 $copy = $e->retrieve_asset_copy([$res->[0]->{"id"}, $MK_ENV_FLESH]);
684 $self->save_trimmed_copy($copy);
686 # We can't renew if there is no copy
687 return $self->bail_on_events(OpenILS::Event->new('ASSET_COPY_NOT_FOUND'))
688 if $self->is_renewal;
693 # --------------------------------------------------------------------------
695 # --------------------------------------------------------------------------
699 flesh_fields => {au => [ qw/ card / ]}
702 if( $self->patron_id ) {
703 $patron = $e->retrieve_actor_user([$self->patron_id, $flesh])
704 or return $self->bail_on_events(OpenILS::Event->new('ACTOR_USER_NOT_FOUND'));
706 } elsif( $self->patron_barcode ) {
708 # note: throwing ACTOR_USER_NOT_FOUND instead of ACTOR_CARD_NOT_FOUND is intentional
709 my $card = $e->search_actor_card({barcode => $self->patron_barcode})->[0]
710 or return $self->bail_on_events(OpenILS::Event->new('ACTOR_USER_NOT_FOUND'));
712 $patron = $e->retrieve_actor_user($card->usr)
713 or return $self->bail_on_events(OpenILS::Event->new('ACTOR_USER_NOT_FOUND'));
715 # Use the card we looked up, not the patron's primary, for card active checks
716 $patron->card($card);
719 if( my $copy = $self->copy ) {
722 $flesh->{flesh_fields}->{circ} = ['usr'];
724 my $circ = $e->search_action_circulation([
725 {target_copy => $copy->id, checkin_time => undef}, $flesh
729 $patron = $circ->usr;
730 $circ->usr($patron->id); # de-flesh for consistency
736 return $self->bail_on_events(OpenILS::Event->new('ACTOR_USER_NOT_FOUND'))
737 unless $self->patron($patron) or $self->is_checkin;
739 unless($self->is_checkin) {
741 # Check for inactivity and patron reg. expiration
743 $self->bail_on_events(OpenILS::Event->new('PATRON_INACTIVE'))
744 unless $U->is_true($patron->active);
746 $self->bail_on_events(OpenILS::Event->new('PATRON_CARD_INACTIVE'))
747 unless $U->is_true($patron->card->active);
749 my $expire = DateTime::Format::ISO8601->new->parse_datetime(
750 cleanse_ISO8601($patron->expire_date));
752 $self->bail_on_events(OpenILS::Event->new('PATRON_ACCOUNT_EXPIRED'))
753 if( CORE::time > $expire->epoch ) ;
758 # --------------------------------------------------------------------------
759 # Does the circ permit work
760 # --------------------------------------------------------------------------
764 $self->log_me("do_permit()");
766 unless( $self->editor->requestor->id == $self->patron->id ) {
767 return $self->bail_on_events($self->editor->event)
768 unless( $self->editor->allowed('VIEW_PERMIT_CHECKOUT') );
771 $self->check_captured_holds();
772 $self->do_copy_checks();
773 return if $self->bail_out;
774 $self->run_patron_permit_scripts();
775 $self->run_copy_permit_scripts()
776 unless $self->is_precat or $self->is_noncat;
777 $self->check_item_deposit_events();
778 $self->override_events();
779 return if $self->bail_out;
781 if($self->is_precat and not $self->request_precat) {
784 'ITEM_NOT_CATALOGED', payload => $self->mk_permit_key));
785 return $self->bail_out(1) unless $self->is_renewal;
789 OpenILS::Event->new('SUCCESS', payload => $self->mk_permit_key));
792 sub check_item_deposit_events {
794 $self->push_events(OpenILS::Event->new('ITEM_DEPOSIT_REQUIRED', payload => $self->copy))
795 if $self->is_deposit and not $self->is_deposit_exempt;
796 $self->push_events(OpenILS::Event->new('ITEM_RENTAL_FEE_REQUIRED', payload => $self->copy))
797 if $self->is_rental and not $self->is_rental_exempt;
800 # returns true if the user is not required to pay deposits
801 sub is_deposit_exempt {
803 my $pid = (ref $self->patron->profile) ?
804 $self->patron->profile->id : $self->patron->profile;
805 my $groups = $U->ou_ancestor_setting_value(
806 $self->circ_lib, 'circ.deposit.exempt_groups', $self->editor);
807 for my $grp (@$groups) {
808 return 1 if $self->is_group_descendant($grp, $pid);
813 # returns true if the user is not required to pay rental fees
814 sub is_rental_exempt {
816 my $pid = (ref $self->patron->profile) ?
817 $self->patron->profile->id : $self->patron->profile;
818 my $groups = $U->ou_ancestor_setting_value(
819 $self->circ_lib, 'circ.rental.exempt_groups', $self->editor);
820 for my $grp (@$groups) {
821 return 1 if $self->is_group_descendant($grp, $pid);
826 sub is_group_descendant {
827 my($self, $p_id, $c_id) = @_;
828 return 0 unless defined $p_id and defined $c_id;
829 return 1 if $c_id == $p_id;
830 while(my $grp = $user_groups{$c_id}) {
831 $c_id = $grp->parent;
832 return 0 unless defined $c_id;
833 return 1 if $c_id == $p_id;
838 sub check_captured_holds {
840 my $copy = $self->copy;
841 my $patron = $self->patron;
843 return undef unless $copy;
845 my $s = $U->copy_status($copy->status)->id;
846 return unless $s == OILS_COPY_STATUS_ON_HOLDS_SHELF;
847 $logger->info("circulator: copy is on holds shelf, searching for the correct hold");
849 # Item is on the holds shelf, make sure it's going to the right person
850 my $hold = $self->editor->search_action_hold_request(
853 current_copy => $copy->id ,
854 capture_time => { '!=' => undef },
855 cancel_time => undef,
856 fulfillment_time => undef
862 if ($hold and $hold->usr == $patron->id) {
863 $self->checkout_is_for_hold(1);
867 $logger->info("circulator: this copy is needed by a different patron to fulfill a hold");
869 $self->push_events(OpenILS::Event->new('ITEM_ON_HOLDS_SHELF'));
875 my $copy = $self->copy;
878 my $stat = $U->copy_status($copy->status)->id;
880 # We cannot check out a copy if it is in-transit
881 if( $stat == OILS_COPY_STATUS_IN_TRANSIT ) {
882 return $self->bail_on_events(OpenILS::Event->new('COPY_IN_TRANSIT'));
885 $self->handle_claims_returned();
886 return if $self->bail_out;
888 # no claims returned circ was found, check if there is any open circ
889 unless( $self->is_renewal ) {
891 my $circs = $self->editor->search_action_circulation(
892 { target_copy => $copy->id, checkin_time => undef }
895 if(my $old_circ = $circs->[0]) { # an open circ was found
897 my $payload = {copy => $copy};
899 if($old_circ->usr == $self->patron->id) {
901 $payload->{old_circ} = $old_circ;
903 # If there is an open circulation on the checkout item and an auto-renew
904 # interval is defined, inform the caller that they should go
905 # ahead and renew the item instead of warning about open circulations.
907 my $auto_renew_intvl = $U->ou_ancestor_setting_value(
909 'circ.checkout_auto_renew_age',
913 if($auto_renew_intvl) {
914 my $intvl_seconds = OpenSRF::Utils->interval_to_seconds($auto_renew_intvl);
915 my $checkout_time = DateTime::Format::ISO8601->new->parse_datetime( cleanse_ISO8601($old_circ->xact_start) );
917 if(DateTime->now > $checkout_time->add(seconds => $intvl_seconds)) {
918 $payload->{auto_renew} = 1;
923 return $self->bail_on_events(
924 OpenILS::Event->new('OPEN_CIRCULATION_EXISTS', payload => $payload)
930 my $LEGACY_CIRC_EVENT_MAP = {
931 'no_item' => 'ITEM_NOT_CATALOGED',
932 'actor.usr.barred' => 'PATRON_BARRED',
933 'asset.copy.circulate' => 'COPY_CIRC_NOT_ALLOWED',
934 'asset.copy.status' => 'COPY_NOT_AVAILABLE',
935 'asset.copy_location.circulate' => 'COPY_CIRC_NOT_ALLOWED',
936 'config.circ_matrix_test.circulate' => 'COPY_CIRC_NOT_ALLOWED',
937 'config.circ_matrix_test.max_items_out' => 'PATRON_EXCEEDS_CHECKOUT_COUNT',
938 'config.circ_matrix_test.max_overdue' => 'PATRON_EXCEEDS_OVERDUE_COUNT',
939 'config.circ_matrix_test.max_fines' => 'PATRON_EXCEEDS_FINES',
940 'config.circ_matrix_circ_mod_test' => 'PATRON_EXCEEDS_CHECKOUT_COUNT',
941 'config.circ_matrix_test.total_copy_hold_ratio' =>
942 'TOTAL_HOLD_COPY_RATIO_EXCEEDED',
943 'config.circ_matrix_test.available_copy_hold_ratio' =>
944 'AVAIL_HOLD_COPY_RATIO_EXCEEDED'
948 # ---------------------------------------------------------------------
949 # This pushes any patron-related events into the list but does not
950 # set bail_out for any events
951 # ---------------------------------------------------------------------
952 sub run_patron_permit_scripts {
954 my $patronid = $self->patron->id;
959 my $results = $self->run_indb_circ_test;
960 unless($self->circ_test_success) {
963 if ($self->is_noncat) {
964 # no_item result is OK during noncat checkout
965 @trimmed_results = grep { ($_->{fail_part} || '') ne 'no_item' } @$results;
969 if ($self->checkout_is_for_hold) {
970 # if this checkout will fulfill a hold, ignore CIRC blocks
971 # and rely instead on the (later-checked) FULFILL block
973 my @pen_names = grep {$_} map {$_->{fail_part}} @$results;
974 my $fblock_pens = $self->editor->search_config_standing_penalty(
975 {name => [@pen_names], block_list => {like => '%CIRC%'}});
977 for my $res (@$results) {
978 my $name = $res->{fail_part} || '';
979 next if grep {$_->name eq $name} @$fblock_pens;
980 push(@trimmed_results, $res);
984 # not for hold or noncat
985 @trimmed_results = @$results;
989 # update the final set of test results
990 $self->matrix_test_result(\@trimmed_results);
992 push @allevents, $self->matrix_test_result_events;
996 $_->{payload} = $self->copy if
997 ($_->{textcode} eq 'COPY_NOT_AVAILABLE');
1000 $logger->info("circulator: permit_patron script returned events: @allevents") if @allevents;
1002 $self->push_events(@allevents);
1005 sub matrix_test_result_codes {
1007 map { $_->{"fail_part"} } @{$self->matrix_test_result};
1010 sub matrix_test_result_events {
1013 my $event = new OpenILS::Event(
1014 $LEGACY_CIRC_EVENT_MAP->{$_->{"fail_part"}} || $_->{"fail_part"}
1016 $event->{"payload"} = {"fail_part" => $_->{"fail_part"}};
1018 } (@{$self->matrix_test_result});
1021 sub run_indb_circ_test {
1023 return $self->matrix_test_result if $self->matrix_test_result;
1025 my $dbfunc = ($self->is_renewal) ?
1026 'action.item_user_renew_test' : 'action.item_user_circ_test';
1028 if( $self->is_precat && $self->request_precat) {
1029 $self->make_precat_copy;
1030 return if $self->bail_out;
1033 my $results = $self->editor->json_query(
1037 ($self->is_noncat or ($self->is_precat and !$self->override and !$self->is_renewal)) ? undef : $self->copy->id,
1043 $self->circ_test_success($U->is_true($results->[0]->{success}));
1045 if(my $mp = $results->[0]->{matchpoint}) {
1046 $logger->info("circulator: circ policy test found matchpoint built via rows " . $results->[0]->{buildrows});
1047 $self->circ_matrix_matchpoint($self->editor->retrieve_config_circ_matrix_matchpoint($mp));
1048 $self->circ_matrix_matchpoint->duration_rule($self->editor->retrieve_config_rules_circ_duration($results->[0]->{duration_rule}));
1049 if(defined($results->[0]->{renewals})) {
1050 $self->circ_matrix_matchpoint->duration_rule->max_renewals($results->[0]->{renewals});
1052 $self->circ_matrix_matchpoint->recurring_fine_rule($self->editor->retrieve_config_rules_recurring_fine($results->[0]->{recurring_fine_rule}));
1053 if(defined($results->[0]->{grace_period})) {
1054 $self->circ_matrix_matchpoint->recurring_fine_rule->grace_period($results->[0]->{grace_period});
1056 $self->circ_matrix_matchpoint->max_fine_rule($self->editor->retrieve_config_rules_max_fine($results->[0]->{max_fine_rule}));
1057 $self->circ_matrix_matchpoint->hard_due_date($self->editor->retrieve_config_hard_due_date($results->[0]->{hard_due_date}));
1058 # Grab the *last* response for limit_groups, where it is more likely to be filled
1059 $self->limit_groups($results->[-1]->{limit_groups});
1062 return $self->matrix_test_result($results);
1065 # ---------------------------------------------------------------------
1066 # given a use and copy, this will calculate the circulation policy
1067 # parameters. Only works with in-db circ.
1068 # ---------------------------------------------------------------------
1072 return OpenILS::Event->new('ASSET_COPY_NOT_FOUND') unless $self->copy;
1074 $self->run_indb_circ_test;
1077 circ_test_success => $self->circ_test_success,
1078 failure_events => [],
1079 failure_codes => [],
1080 matchpoint => $self->circ_matrix_matchpoint
1083 unless($self->circ_test_success) {
1084 $results->{"failure_codes"} = [ $self->matrix_test_result_codes ];
1085 $results->{"failure_events"} = [ $self->matrix_test_result_events ];
1088 if($self->circ_matrix_matchpoint) {
1089 my $duration_rule = $self->circ_matrix_matchpoint->duration_rule;
1090 my $recurring_fine_rule = $self->circ_matrix_matchpoint->recurring_fine_rule;
1091 my $max_fine_rule = $self->circ_matrix_matchpoint->max_fine_rule;
1092 my $hard_due_date = $self->circ_matrix_matchpoint->hard_due_date;
1094 my $policy = $self->get_circ_policy(
1095 $duration_rule, $recurring_fine_rule, $max_fine_rule, $hard_due_date);
1097 $$results{$_} = $$policy{$_} for keys %$policy;
1103 # ---------------------------------------------------------------------
1104 # Loads the circ policy info for duration, recurring fine, and max
1105 # fine based on the current copy
1106 # ---------------------------------------------------------------------
1107 sub get_circ_policy {
1108 my($self, $duration_rule, $recurring_fine_rule, $max_fine_rule, $hard_due_date) = @_;
1111 duration_rule => $duration_rule->name,
1112 recurring_fine_rule => $recurring_fine_rule->name,
1113 max_fine_rule => $max_fine_rule->name,
1114 max_fine => $self->get_max_fine_amount($max_fine_rule),
1115 fine_interval => $recurring_fine_rule->recurrence_interval,
1116 renewal_remaining => $duration_rule->max_renewals,
1117 grace_period => $recurring_fine_rule->grace_period
1120 if($hard_due_date) {
1121 $policy->{duration_date_ceiling} = $hard_due_date->ceiling_date;
1122 $policy->{duration_date_ceiling_force} = $hard_due_date->forceto;
1125 $policy->{duration_date_ceiling} = undef;
1126 $policy->{duration_date_ceiling_force} = undef;
1129 $policy->{duration} = $duration_rule->shrt
1130 if $self->copy->loan_duration == OILS_CIRC_DURATION_SHORT;
1131 $policy->{duration} = $duration_rule->normal
1132 if $self->copy->loan_duration == OILS_CIRC_DURATION_NORMAL;
1133 $policy->{duration} = $duration_rule->extended
1134 if $self->copy->loan_duration == OILS_CIRC_DURATION_EXTENDED;
1136 $policy->{recurring_fine} = $recurring_fine_rule->low
1137 if $self->copy->fine_level == OILS_REC_FINE_LEVEL_LOW;
1138 $policy->{recurring_fine} = $recurring_fine_rule->normal
1139 if $self->copy->fine_level == OILS_REC_FINE_LEVEL_NORMAL;
1140 $policy->{recurring_fine} = $recurring_fine_rule->high
1141 if $self->copy->fine_level == OILS_REC_FINE_LEVEL_HIGH;
1146 sub get_max_fine_amount {
1148 my $max_fine_rule = shift;
1149 my $max_amount = $max_fine_rule->amount;
1151 # if is_percent is true then the max->amount is
1152 # use as a percentage of the copy price
1153 if ($U->is_true($max_fine_rule->is_percent)) {
1154 my $price = $U->get_copy_price($self->editor, $self->copy, $self->volume);
1155 $max_amount = $price * $max_fine_rule->amount / 100;
1157 $U->ou_ancestor_setting_value(
1159 'circ.max_fine.cap_at_price',
1163 my $price = $U->get_copy_price($self->editor, $self->copy, $self->volume);
1164 $max_amount = ( $price && $max_amount > $price ) ? $price : $max_amount;
1172 sub run_copy_permit_scripts {
1174 my $copy = $self->copy || return;
1178 my $results = $self->run_indb_circ_test;
1179 push @allevents, $self->matrix_test_result_events
1180 unless $self->circ_test_success;
1182 # See if this copy has an alert message
1183 my $ae = $self->check_copy_alert();
1184 push( @allevents, $ae ) if $ae;
1186 # uniquify the events
1187 my %hash = map { ($_->{ilsevent} => $_) } @allevents;
1188 @allevents = values %hash;
1190 $logger->info("circulator: permit_copy script returned events: @allevents") if @allevents;
1192 $self->push_events(@allevents);
1196 sub check_copy_alert {
1198 return undef if $self->is_renewal;
1199 return OpenILS::Event->new(
1200 'COPY_ALERT_MESSAGE', payload => $self->copy->alert_message)
1201 if $self->copy and $self->copy->alert_message;
1207 # --------------------------------------------------------------------------
1208 # If the call is overriding and has permissions to override every collected
1209 # event, the are cleared. Any event that the caller does not have
1210 # permission to override, will be left in the event list and bail_out will
1212 # XXX We need code in here to cancel any holds/transits on copies
1213 # that are being force-checked out
1214 # --------------------------------------------------------------------------
1215 sub override_events {
1217 my @events = @{$self->events};
1218 return unless @events;
1219 my $oargs = $self->override_args;
1221 if(!$self->override) {
1222 return $self->bail_out(1)
1223 if( @events > 1 or $events[0]->{textcode} ne 'SUCCESS' );
1228 for my $e (@events) {
1229 my $tc = $e->{textcode};
1230 next if $tc eq 'SUCCESS';
1231 if($oargs->{all} || grep { $_ eq $tc } @{$oargs->{events}}) {
1232 my $ov = "$tc.override";
1233 $logger->info("circulator: attempting to override event: $ov");
1235 return $self->bail_on_events($self->editor->event)
1236 unless( $self->editor->allowed($ov) );
1238 return $self->bail_out(1);
1244 # --------------------------------------------------------------------------
1245 # If there is an open claimsreturn circ on the requested copy, close the
1246 # circ if overriding, otherwise bail out
1247 # --------------------------------------------------------------------------
1248 sub handle_claims_returned {
1250 my $copy = $self->copy;
1252 my $CR = $self->editor->search_action_circulation(
1254 target_copy => $copy->id,
1255 stop_fines => OILS_STOP_FINES_CLAIMSRETURNED,
1256 checkin_time => undef,
1260 return unless ($CR = $CR->[0]);
1264 # - If the caller has set the override flag, we will check the item in
1265 if($self->override && ($self->override_args->{all} || grep { $_ eq 'CIRC_CLAIMS_RETURNED' } @{$self->override_args->{events}}) ) {
1267 $CR->checkin_time('now');
1268 $CR->checkin_scan_time('now');
1269 $CR->checkin_lib($self->circ_lib);
1270 $CR->checkin_workstation($self->editor->requestor->wsid);
1271 $CR->checkin_staff($self->editor->requestor->id);
1273 $evt = $self->editor->event
1274 unless $self->editor->update_action_circulation($CR);
1277 $evt = OpenILS::Event->new('CIRC_CLAIMS_RETURNED');
1280 $self->bail_on_events($evt) if $evt;
1285 # --------------------------------------------------------------------------
1286 # This performs the checkout
1287 # --------------------------------------------------------------------------
1291 $self->log_me("do_checkout()");
1293 # make sure perms are good if this isn't a renewal
1294 unless( $self->is_renewal ) {
1295 return $self->bail_on_events($self->editor->event)
1296 unless( $self->editor->allowed('COPY_CHECKOUT') );
1299 # verify the permit key
1300 unless( $self->check_permit_key ) {
1301 if( $self->permit_override ) {
1302 return $self->bail_on_events($self->editor->event)
1303 unless $self->editor->allowed('CIRC_PERMIT_OVERRIDE');
1305 return $self->bail_on_events(OpenILS::Event->new('CIRC_PERMIT_BAD_KEY'))
1309 # if this is a non-cataloged circ, build the circ and finish
1310 if( $self->is_noncat ) {
1311 $self->checkout_noncat;
1313 OpenILS::Event->new('SUCCESS',
1314 payload => { noncat_circ => $self->circ }));
1318 if( $self->is_precat ) {
1319 $self->make_precat_copy;
1320 return if $self->bail_out;
1322 } elsif( $self->copy->call_number == OILS_PRECAT_CALL_NUMBER ) {
1323 return $self->bail_on_events(OpenILS::Event->new('ITEM_NOT_CATALOGED'));
1326 $self->do_copy_checks;
1327 return if $self->bail_out;
1329 $self->run_checkout_scripts();
1330 return if $self->bail_out;
1332 $self->build_checkout_circ_object();
1333 return if $self->bail_out;
1335 my $modify_to_start = $self->booking_adjusted_due_date();
1336 return if $self->bail_out;
1338 $self->apply_modified_due_date($modify_to_start);
1339 return if $self->bail_out;
1341 return $self->bail_on_events($self->editor->event)
1342 unless $self->editor->create_action_circulation($self->circ);
1344 # refresh the circ to force local time zone for now
1345 $self->circ($self->editor->retrieve_action_circulation($self->circ->id));
1347 if($self->limit_groups) {
1348 $self->editor->json_query({ from => ['action.link_circ_limit_groups', $self->circ->id, $self->limit_groups] });
1351 $self->copy->status(OILS_COPY_STATUS_CHECKED_OUT);
1353 return if $self->bail_out;
1355 $self->apply_deposit_fee();
1356 return if $self->bail_out;
1358 $self->handle_checkout_holds();
1359 return if $self->bail_out;
1361 # ------------------------------------------------------------------------------
1362 # Update the patron penalty info in the DB. Run it for permit-overrides
1363 # since the penalties are not updated during the permit phase
1364 # ------------------------------------------------------------------------------
1365 OpenILS::Utils::Penalty->calculate_penalties($self->editor, $self->patron->id, $self->circ_lib);
1367 my $record = $U->record_to_mvr($self->title) unless $self->is_precat;
1370 if($self->is_renewal) {
1371 # flesh the billing summary for the checked-in circ
1372 $pcirc = $self->editor->retrieve_action_circulation([
1374 {flesh => 2, flesh_fields => {circ => ['billable_transaction'], mbt => ['summary']}}
1379 OpenILS::Event->new('SUCCESS',
1381 copy => $U->unflesh_copy($self->copy),
1382 volume => $self->volume,
1383 circ => $self->circ,
1385 holds_fulfilled => $self->fulfilled_holds,
1386 deposit_billing => $self->deposit_billing,
1387 rental_billing => $self->rental_billing,
1388 parent_circ => $pcirc,
1389 patron => ($self->return_patron) ? $self->patron : undef,
1390 patron_money => $self->editor->retrieve_money_user_summary($self->patron->id)
1396 sub apply_deposit_fee {
1398 my $copy = $self->copy;
1400 ($self->is_deposit and not $self->is_deposit_exempt) or
1401 ($self->is_rental and not $self->is_rental_exempt);
1403 return if $self->is_deposit and $self->skip_deposit_fee;
1404 return if $self->is_rental and $self->skip_rental_fee;
1406 my $bill = Fieldmapper::money::billing->new;
1407 my $amount = $copy->deposit_amount;
1411 if($self->is_deposit) {
1412 $billing_type = OILS_BILLING_TYPE_DEPOSIT;
1414 $self->deposit_billing($bill);
1416 $billing_type = OILS_BILLING_TYPE_RENTAL;
1418 $self->rental_billing($bill);
1421 $bill->xact($self->circ->id);
1422 $bill->amount($amount);
1423 $bill->note(OILS_BILLING_NOTE_SYSTEM);
1424 $bill->billing_type($billing_type);
1425 $bill->btype($btype);
1426 $self->editor->create_money_billing($bill) or $self->bail_on_events($self->editor->event);
1428 $logger->info("circulator: charged $amount on checkout with billing type $billing_type");
1433 my $copy = $self->copy;
1435 my $stat = $copy->status if ref $copy->status;
1436 my $loc = $copy->location if ref $copy->location;
1437 my $circ_lib = $copy->circ_lib if ref $copy->circ_lib;
1439 $copy->status($stat->id) if $stat;
1440 $copy->location($loc->id) if $loc;
1441 $copy->circ_lib($circ_lib->id) if $circ_lib;
1442 $copy->editor($self->editor->requestor->id);
1443 $copy->edit_date('now');
1444 $copy->age_protect($copy->age_protect->id) if ref $copy->age_protect;
1446 return $self->bail_on_events($self->editor->event)
1447 unless $self->editor->update_asset_copy($self->copy);
1449 $copy->status($U->copy_status($copy->status));
1450 $copy->location($loc) if $loc;
1451 $copy->circ_lib($circ_lib) if $circ_lib;
1454 sub update_reservation {
1456 my $reservation = $self->reservation;
1458 my $usr = $reservation->usr;
1459 my $target_rt = $reservation->target_resource_type;
1460 my $target_r = $reservation->target_resource;
1461 my $current_r = $reservation->current_resource;
1463 $reservation->usr($usr->id) if ref $usr;
1464 $reservation->target_resource_type($target_rt->id) if ref $target_rt;
1465 $reservation->target_resource($target_r->id) if ref $target_r;
1466 $reservation->current_resource($current_r->id) if ref $current_r;
1468 return $self->bail_on_events($self->editor->event)
1469 unless $self->editor->update_booking_reservation($self->reservation);
1472 ($reservation, $evt) = $U->fetch_booking_reservation($reservation->id);
1473 $self->reservation($reservation);
1477 sub bail_on_events {
1478 my( $self, @evts ) = @_;
1479 $self->push_events(@evts);
1483 # ------------------------------------------------------------------------------
1484 # A hold FULFILL block is just like a CIRC block, except that FULFILL only
1485 # affects copies that will fulfill holds and CIRC affects all other copies.
1486 # If blocks exists, bail, push Events onto the event pile, and return true.
1487 # ------------------------------------------------------------------------------
1488 sub check_hold_fulfill_blocks {
1491 # With the addition of ignore_proximity in csp, we need to fetch
1492 # the proximity of both the circ_lib and the copy's circ_lib to
1493 # the patron's home_ou.
1494 my ($ou_prox, $copy_prox);
1495 my $home_ou = (ref($self->patron->home_ou)) ? $self->patron->home_ou->id : $self->patron->home_ou;
1496 $ou_prox = $U->get_org_unit_proximity($self->editor, $home_ou, $self->circ_lib);
1497 $ou_prox = -1 unless (defined($ou_prox));
1498 my $copy_ou = (ref($self->copy->circ_lib)) ? $self->copy->circ_lib->id : $self->copy->circ_lib;
1499 if ($copy_ou == $self->circ_lib) {
1500 # Save us the time of an extra query.
1501 $copy_prox = $ou_prox;
1503 $copy_prox = $U->get_org_unit_proximity($self->editor, $home_ou, $copy_ou);
1504 $copy_prox = -1 unless (defined($copy_prox));
1507 # See if the user has any penalties applied that prevent hold fulfillment
1508 my $pens = $self->editor->json_query({
1509 select => {csp => ['name', 'label']},
1510 from => {ausp => {csp => {}}},
1513 usr => $self->patron->id,
1514 org_unit => $U->get_org_full_path($self->circ_lib),
1516 {stop_date => undef},
1517 {stop_date => {'>' => 'now'}}
1521 block_list => {'like' => '%FULFILL%'},
1523 {ignore_proximity => undef},
1524 {ignore_proximity => {'<' => $ou_prox}},
1525 {ignore_proximity => {'<' => $copy_prox}}
1531 return 0 unless @$pens;
1533 for my $pen (@$pens) {
1534 $logger->info("circulator: patron has hold FULFILL block " . $pen->{name});
1535 my $event = OpenILS::Event->new($pen->{name});
1536 $event->{desc} = $pen->{label};
1537 $self->push_events($event);
1540 $self->override_events;
1541 return $self->bail_out;
1545 # ------------------------------------------------------------------------------
1546 # When an item is checked out, see if we can fulfill a hold for this patron
1547 # ------------------------------------------------------------------------------
1548 sub handle_checkout_holds {
1550 my $copy = $self->copy;
1551 my $patron = $self->patron;
1553 my $e = $self->editor;
1554 $self->fulfilled_holds([]);
1556 # non-cats can't fulfill a hold
1557 return if $self->is_noncat;
1559 my $hold = $e->search_action_hold_request({
1560 current_copy => $copy->id ,
1561 cancel_time => undef,
1562 fulfillment_time => undef
1565 if($hold and $hold->usr != $patron->id) {
1566 # reset the hold since the copy is now checked out
1568 $logger->info("circulator: un-targeting hold ".$hold->id.
1569 " because copy ".$copy->id." is getting checked out");
1571 $hold->clear_prev_check_time;
1572 $hold->clear_current_copy;
1573 $hold->clear_capture_time;
1574 $hold->clear_shelf_time;
1575 $hold->clear_shelf_expire_time;
1576 $hold->clear_current_shelf_lib;
1578 return $self->bail_on_event($e->event)
1579 unless $e->update_action_hold_request($hold);
1585 $hold = $self->find_related_user_hold($copy, $patron) or return;
1586 $logger->info("circulator: found related hold to fulfill in checkout");
1589 return if $self->check_hold_fulfill_blocks;
1591 $logger->debug("circulator: checkout fulfilling hold " . $hold->id);
1593 # if the hold was never officially captured, capture it.
1594 $hold->current_copy($copy->id);
1595 $hold->capture_time('now') unless $hold->capture_time;
1596 $hold->fulfillment_time('now');
1597 $hold->fulfillment_staff($e->requestor->id);
1598 $hold->fulfillment_lib($self->circ_lib);
1600 return $self->bail_on_events($e->event)
1601 unless $e->update_action_hold_request($hold);
1603 return $self->fulfilled_holds([$hold->id]);
1607 # ------------------------------------------------------------------------------
1608 # If the circ.checkout_fill_related_hold setting is turned on and no hold for
1609 # the patron directly targets the checked out item, see if there is another hold
1610 # for the patron that could be fulfilled by the checked out item. Fulfill the
1611 # oldest hold and only fulfill 1 of them.
1613 # For "another hold":
1615 # First, check for one that the copy matches via hold_copy_map, ensuring that
1616 # *any* hold type that this copy could fill may end up filled.
1618 # Then, if circ.checkout_fill_related_hold_exact_match_only is not enabled, look
1619 # for a Title (T) or Volume (V) hold that matches the item. This allows items
1620 # that are non-requestable to count as capturing those hold types.
1621 # ------------------------------------------------------------------------------
1622 sub find_related_user_hold {
1623 my($self, $copy, $patron) = @_;
1624 my $e = $self->editor;
1626 # holds on precat copies are always copy-level, so this call will
1627 # always return undef. Exit early.
1628 return undef if $self->is_precat;
1630 return undef unless $U->ou_ancestor_setting_value(
1631 $self->circ_lib, 'circ.checkout_fills_related_hold', $e);
1633 # find the oldest unfulfilled hold that has not yet hit the holds shelf.
1635 select => {ahr => ['id']},
1644 fkey => 'current_copy',
1645 type => 'left' # there may be no current_copy
1652 fulfillment_time => undef,
1653 cancel_time => undef,
1655 {expire_time => undef},
1656 {expire_time => {'>' => 'now'}}
1660 target_copy => $self->copy->id
1664 {id => undef}, # left-join copy may be nonexistent
1665 {status => {'!=' => OILS_COPY_STATUS_ON_HOLDS_SHELF}},
1669 order_by => {ahr => {request_time => {direction => 'asc'}}},
1673 my $hold_info = $e->json_query($args)->[0];
1674 return $e->retrieve_action_hold_request($hold_info->{id}) if $hold_info;
1675 return undef if $U->ou_ancestor_setting_value(
1676 $self->circ_lib, 'circ.checkout_fills_related_hold_exact_match_only', $e);
1678 # find the oldest unfulfilled hold that has not yet hit the holds shelf.
1680 select => {ahr => ['id']},
1685 fkey => 'current_copy',
1686 type => 'left' # there may be no current_copy
1693 fulfillment_time => undef,
1694 cancel_time => undef,
1696 {expire_time => undef},
1697 {expire_time => {'>' => 'now'}}
1704 target => $self->volume->id
1710 target => $self->title->id
1716 {id => undef}, # left-join copy may be nonexistent
1717 {status => {'!=' => OILS_COPY_STATUS_ON_HOLDS_SHELF}},
1721 order_by => {ahr => {request_time => {direction => 'asc'}}},
1725 $hold_info = $e->json_query($args)->[0];
1726 return $e->retrieve_action_hold_request($hold_info->{id}) if $hold_info;
1731 sub run_checkout_scripts {
1744 my $hard_due_date_name;
1746 $self->run_indb_circ_test();
1747 $duration = $self->circ_matrix_matchpoint->duration_rule;
1748 $recurring = $self->circ_matrix_matchpoint->recurring_fine_rule;
1749 $max_fine = $self->circ_matrix_matchpoint->max_fine_rule;
1750 $hard_due_date = $self->circ_matrix_matchpoint->hard_due_date;
1752 $duration_name = $duration->name if $duration;
1753 if( $duration_name ne OILS_UNLIMITED_CIRC_DURATION ) {
1756 ($duration, $evt) = $U->fetch_circ_duration_by_name($duration_name);
1757 return $self->bail_on_events($evt) if ($evt && !$nobail);
1759 ($recurring, $evt) = $U->fetch_recurring_fine_by_name($recurring_name);
1760 return $self->bail_on_events($evt) if ($evt && !$nobail);
1762 ($max_fine, $evt) = $U->fetch_max_fine_by_name($max_fine_name);
1763 return $self->bail_on_events($evt) if ($evt && !$nobail);
1765 if($hard_due_date_name) {
1766 ($hard_due_date, $evt) = $U->fetch_hard_due_date_by_name($hard_due_date_name);
1767 return $self->bail_on_events($evt) if ($evt && !$nobail);
1773 # The item circulates with an unlimited duration
1777 $hard_due_date = undef;
1780 $self->duration_rule($duration);
1781 $self->recurring_fines_rule($recurring);
1782 $self->max_fine_rule($max_fine);
1783 $self->hard_due_date($hard_due_date);
1787 sub build_checkout_circ_object {
1790 my $circ = Fieldmapper::action::circulation->new;
1791 my $duration = $self->duration_rule;
1792 my $max = $self->max_fine_rule;
1793 my $recurring = $self->recurring_fines_rule;
1794 my $hard_due_date = $self->hard_due_date;
1795 my $copy = $self->copy;
1796 my $patron = $self->patron;
1797 my $duration_date_ceiling;
1798 my $duration_date_ceiling_force;
1802 my $policy = $self->get_circ_policy($duration, $recurring, $max, $hard_due_date);
1803 $duration_date_ceiling = $policy->{duration_date_ceiling};
1804 $duration_date_ceiling_force = $policy->{duration_date_ceiling_force};
1806 my $dname = $duration->name;
1807 my $mname = $max->name;
1808 my $rname = $recurring->name;
1810 if($hard_due_date) {
1811 $hdname = $hard_due_date->name;
1814 $logger->debug("circulator: building circulation ".
1815 "with duration=$dname, maxfine=$mname, recurring=$rname, hard due date=$hdname");
1817 $circ->duration($policy->{duration});
1818 $circ->recurring_fine($policy->{recurring_fine});
1819 $circ->duration_rule($duration->name);
1820 $circ->recurring_fine_rule($recurring->name);
1821 $circ->max_fine_rule($max->name);
1822 $circ->max_fine($policy->{max_fine});
1823 $circ->fine_interval($recurring->recurrence_interval);
1824 $circ->renewal_remaining($duration->max_renewals);
1825 $circ->grace_period($policy->{grace_period});
1829 $logger->info("circulator: copy found with an unlimited circ duration");
1830 $circ->duration_rule(OILS_UNLIMITED_CIRC_DURATION);
1831 $circ->recurring_fine_rule(OILS_UNLIMITED_CIRC_DURATION);
1832 $circ->max_fine_rule(OILS_UNLIMITED_CIRC_DURATION);
1833 $circ->renewal_remaining(0);
1834 $circ->grace_period(0);
1837 $circ->target_copy( $copy->id );
1838 $circ->usr( $patron->id );
1839 $circ->circ_lib( $self->circ_lib );
1840 $circ->workstation($self->editor->requestor->wsid)
1841 if defined $self->editor->requestor->wsid;
1843 # renewals maintain a link to the parent circulation
1844 $circ->parent_circ($self->parent_circ);
1846 if( $self->is_renewal ) {
1847 $circ->opac_renewal('t') if $self->opac_renewal;
1848 $circ->phone_renewal('t') if $self->phone_renewal;
1849 $circ->desk_renewal('t') if $self->desk_renewal;
1850 $circ->renewal_remaining($self->renewal_remaining);
1851 $circ->circ_staff($self->editor->requestor->id);
1855 # if the user provided an overiding checkout time,
1856 # (e.g. the checkout really happened several hours ago), then
1857 # we apply that here. Does this need a perm??
1858 $circ->xact_start(cleanse_ISO8601($self->checkout_time))
1859 if $self->checkout_time;
1861 # if a patron is renewing, 'requestor' will be the patron
1862 $circ->circ_staff($self->editor->requestor->id);
1863 $circ->due_date( $self->create_due_date($circ->duration, $duration_date_ceiling, $duration_date_ceiling_force, $circ->xact_start) ) if $circ->duration;
1868 sub do_reservation_pickup {
1871 $self->log_me("do_reservation_pickup()");
1873 $self->reservation->pickup_time('now');
1876 $self->reservation->current_resource &&
1877 $U->is_true($self->reservation->target_resource_type->catalog_item)
1879 # We used to try to set $self->copy and $self->patron here,
1880 # but that should already be done.
1882 $self->run_checkout_scripts(1);
1884 my $duration = $self->duration_rule;
1885 my $max = $self->max_fine_rule;
1886 my $recurring = $self->recurring_fines_rule;
1888 if ($duration && $max && $recurring) {
1889 my $policy = $self->get_circ_policy($duration, $recurring, $max);
1891 my $dname = $duration->name;
1892 my $mname = $max->name;
1893 my $rname = $recurring->name;
1895 $logger->debug("circulator: updating reservation ".
1896 "with duration=$dname, maxfine=$mname, recurring=$rname");
1898 $self->reservation->fine_amount($policy->{recurring_fine});
1899 $self->reservation->max_fine($policy->{max_fine});
1900 $self->reservation->fine_interval($recurring->recurrence_interval);
1903 $self->copy->status(OILS_COPY_STATUS_CHECKED_OUT);
1904 $self->update_copy();
1907 $self->reservation->fine_amount(
1908 $self->reservation->target_resource_type->fine_amount
1910 $self->reservation->max_fine(
1911 $self->reservation->target_resource_type->max_fine
1913 $self->reservation->fine_interval(
1914 $self->reservation->target_resource_type->fine_interval
1918 $self->update_reservation();
1921 sub do_reservation_return {
1923 my $request = shift;
1925 $self->log_me("do_reservation_return()");
1927 if (not ref $self->reservation) {
1928 my ($reservation, $evt) =
1929 $U->fetch_booking_reservation($self->reservation);
1930 return $self->bail_on_events($evt) if $evt;
1931 $self->reservation($reservation);
1934 $self->handle_fines(1);
1935 $self->reservation->return_time('now');
1936 $self->update_reservation();
1937 $self->reshelve_copy if $self->copy;
1939 if ( $self->reservation->current_resource && $self->reservation->current_resource->catalog_item ) {
1940 $self->copy( $self->reservation->current_resource->catalog_item );
1944 sub booking_adjusted_due_date {
1946 my $circ = $self->circ;
1947 my $copy = $self->copy;
1949 return undef unless $self->use_booking;
1953 if( $self->due_date ) {
1955 return $self->bail_on_events($self->editor->event)
1956 unless $self->editor->allowed('CIRC_OVERRIDE_DUE_DATE', $self->circ_lib);
1958 $circ->due_date(cleanse_ISO8601($self->due_date));
1962 return unless $copy and $circ->due_date;
1965 my $booking_items = $self->editor->search_booking_resource( { barcode => $copy->barcode } );
1966 if (@$booking_items) {
1967 my $booking_item = $booking_items->[0];
1968 my $resource_type = $self->editor->retrieve_booking_resource_type( $booking_item->type );
1970 my $stop_circ_setting = $U->ou_ancestor_setting_value( $self->circ_lib, 'circ.booking_reservation.stop_circ', $self->editor );
1971 my $shorten_circ_setting = $resource_type->elbow_room ||
1972 $U->ou_ancestor_setting_value( $self->circ_lib, 'circ.booking_reservation.default_elbow_room', $self->editor ) ||
1975 my $booking_ses = OpenSRF::AppSession->create( 'open-ils.booking' );
1976 my $bookings = $booking_ses->request('open-ils.booking.reservations.filtered_id_list', $self->editor->authtoken, {
1977 resource => $booking_item->id
1978 , search_start => 'now'
1979 , search_end => $circ->due_date
1980 , fields => { cancel_time => undef, return_time => undef }
1982 $booking_ses->disconnect;
1984 throw OpenSRF::EX::ERROR ("Improper input arguments") unless defined $bookings;
1985 return $self->bail_on_events($bookings) if ref($bookings) eq 'HASH';
1987 my $dt_parser = DateTime::Format::ISO8601->new;
1988 my $due_date = $dt_parser->parse_datetime( cleanse_ISO8601($circ->due_date) );
1990 for my $bid (@$bookings) {
1992 my $booking = $self->editor->retrieve_booking_reservation( $bid );
1994 my $booking_start = $dt_parser->parse_datetime( cleanse_ISO8601($booking->start_time) );
1995 my $booking_end = $dt_parser->parse_datetime( cleanse_ISO8601($booking->end_time) );
1997 return $self->bail_on_events( OpenILS::Event->new('COPY_RESERVED') )
1998 if ($booking_start < DateTime->now);
2001 if ($U->is_true($stop_circ_setting)) {
2002 $self->bail_on_events( OpenILS::Event->new('COPY_RESERVED') );
2004 $due_date = $booking_start->subtract( seconds => interval_to_seconds($shorten_circ_setting) );
2005 $self->bail_on_events( OpenILS::Event->new('COPY_RESERVED') ) if ($due_date < DateTime->now);
2008 # We set the circ duration here only to affect the logic that will
2009 # later (in a DB trigger) mangle the time part of the due date to
2010 # 11:59pm. Having any circ duration that is not a whole number of
2011 # days is enough to prevent the "correction."
2012 my $new_circ_duration = $due_date->epoch - time;
2013 $new_circ_duration++ if $new_circ_duration % 86400 == 0;
2014 $circ->duration("$new_circ_duration seconds");
2016 $circ->due_date(cleanse_ISO8601($due_date->strftime('%FT%T%z')));
2020 return $self->bail_on_events($self->editor->event)
2021 unless $self->editor->allowed('CIRC_OVERRIDE_DUE_DATE', $self->circ_lib);
2027 sub apply_modified_due_date {
2029 my $shift_earlier = shift;
2030 my $circ = $self->circ;
2031 my $copy = $self->copy;
2033 if( $self->due_date ) {
2035 return $self->bail_on_events($self->editor->event)
2036 unless $self->editor->allowed('CIRC_OVERRIDE_DUE_DATE', $self->circ_lib);
2038 $circ->due_date(cleanse_ISO8601($self->due_date));
2042 # if the due_date lands on a day when the location is closed
2043 return unless $copy and $circ->due_date;
2045 #my $org = (ref $copy->circ_lib) ? $copy->circ_lib->id : $copy->circ_lib;
2047 # due-date overlap should be determined by the location the item
2048 # is checked out from, not the owning or circ lib of the item
2049 my $org = $self->circ_lib;
2051 $logger->info("circulator: circ searching for closed date overlap on lib $org".
2052 " with an item due date of ".$circ->due_date );
2054 my $dateinfo = $U->storagereq(
2055 'open-ils.storage.actor.org_unit.closed_date.overlap',
2056 $org, $circ->due_date );
2059 $logger->info("circulator: $dateinfo : circ due data / close date overlap found : due_date=".
2060 $circ->due_date." start=". $dateinfo->{start}.", end=".$dateinfo->{end});
2062 # XXX make the behavior more dynamic
2063 # for now, we just push the due date to after the close date
2064 if ($shift_earlier) {
2065 $circ->due_date($dateinfo->{start});
2067 $circ->due_date($dateinfo->{end});
2075 sub create_due_date {
2076 my( $self, $duration, $date_ceiling, $force_date, $start_time ) = @_;
2078 # if there is a raw time component (e.g. from postgres),
2079 # turn it into an interval that interval_to_seconds can parse
2080 $duration =~ s/(\d{2}):(\d{2}):(\d{2})/$1 h $2 m $3 s/o;
2082 # for now, use the server timezone. TODO: use workstation org timezone
2083 my $due_date = DateTime->now(time_zone => 'local');
2084 $due_date = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($start_time)) if $start_time;
2086 # add the circ duration
2087 $due_date->add(seconds => OpenSRF::Utils->interval_to_seconds($duration));
2090 my $cdate = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($date_ceiling));
2091 if ($cdate > DateTime->now and ($cdate < $due_date or $U->is_true( $force_date ))) {
2092 $logger->info("circulator: overriding due date with date ceiling: $date_ceiling");
2097 # return ISO8601 time with timezone
2098 return $due_date->strftime('%FT%T%z');
2103 sub make_precat_copy {
2105 my $copy = $self->copy;
2108 $logger->debug("circulator: Pre-cat copy already exists in checkout: ID=" . $copy->id);
2110 $copy->editor($self->editor->requestor->id);
2111 $copy->edit_date('now');
2112 $copy->dummy_title($self->dummy_title || $copy->dummy_title || '');
2113 $copy->dummy_isbn($self->dummy_isbn || $copy->dummy_isbn || '');
2114 $copy->dummy_author($self->dummy_author || $copy->dummy_author || '');
2115 $copy->circ_modifier($self->circ_modifier || $copy->circ_modifier);
2116 $self->update_copy();
2120 $logger->info("circulator: Creating a new precataloged ".
2121 "copy in checkout with barcode " . $self->copy_barcode);
2123 $copy = Fieldmapper::asset::copy->new;
2124 $copy->circ_lib($self->circ_lib);
2125 $copy->creator($self->editor->requestor->id);
2126 $copy->editor($self->editor->requestor->id);
2127 $copy->barcode($self->copy_barcode);
2128 $copy->call_number(OILS_PRECAT_CALL_NUMBER);
2129 $copy->loan_duration(OILS_PRECAT_COPY_LOAN_DURATION);
2130 $copy->fine_level(OILS_PRECAT_COPY_FINE_LEVEL);
2132 $copy->dummy_title($self->dummy_title || "");
2133 $copy->dummy_author($self->dummy_author || "");
2134 $copy->dummy_isbn($self->dummy_isbn || "");
2135 $copy->circ_modifier($self->circ_modifier);
2138 # See if we need to override the circ_lib for the copy with a configured circ_lib
2139 # Setting is shortname of the org unit
2140 my $precat_circ_lib = $U->ou_ancestor_setting_value(
2141 $self->circ_lib, 'circ.pre_cat_copy_circ_lib', $self->editor);
2143 if($precat_circ_lib) {
2144 my $org = $self->editor->search_actor_org_unit({shortname => $precat_circ_lib})->[0];
2147 $self->bail_on_events($self->editor->event);
2151 $copy->circ_lib($org->id);
2155 unless( $self->copy($self->editor->create_asset_copy($copy)) ) {
2157 $self->push_events($self->editor->event);
2163 sub checkout_noncat {
2169 my $lib = $self->noncat_circ_lib || $self->circ_lib;
2170 my $count = $self->noncat_count || 1;
2171 my $cotime = cleanse_ISO8601($self->checkout_time) || "";
2173 $logger->info("circulator: circ creating $count noncat circs with checkout time $cotime");
2177 ( $circ, $evt ) = OpenILS::Application::Circ::NonCat::create_non_cat_circ(
2178 $self->editor->requestor->id,
2186 $self->push_events($evt);
2194 # If a copy goes into transit and is then checked in before the transit checkin
2195 # interval has expired, push an event onto the overridable events list.
2196 sub check_transit_checkin_interval {
2199 # only concerned with in-transit items
2200 return unless $U->copy_status($self->copy->status)->id == OILS_COPY_STATUS_IN_TRANSIT;
2202 # no interval, no problem
2203 my $interval = $U->ou_ancestor_setting_value($self->circ_lib, 'circ.transit.min_checkin_interval');
2204 return unless $interval;
2206 # capture the transit so we don't have to fetch it again later during checkin
2208 $self->editor->search_action_transit_copy(
2209 {target_copy => $self->copy->id, dest_recv_time => undef}
2213 # transit from X to X for whatever reason has no min interval
2214 return if $self->transit->source == $self->transit->dest;
2216 my $seconds = OpenSRF::Utils->interval_to_seconds($interval);
2217 my $t_start = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($self->transit->source_send_time));
2218 my $horizon = $t_start->add(seconds => $seconds);
2220 # See if we are still within the transit checkin forbidden range
2221 $self->push_events(OpenILS::Event->new('TRANSIT_CHECKIN_INTERVAL_BLOCK'))
2222 if $horizon > DateTime->now;
2225 # Retarget local holds at checkin
2226 sub checkin_retarget {
2228 return unless $self->retarget_mode and $self->retarget_mode =~ m/retarget/; # Retargeting?
2229 return unless $self->is_checkin; # Renewals need not be checked
2230 return if $self->capture eq 'nocapture'; # Not capturing holds anyway? Move on.
2231 return if $self->is_precat; # No holds for precats
2232 return unless $self->circ_lib == $self->copy->circ_lib; # Item isn't "home"? Don't check.
2233 return unless $U->is_true($self->copy->holdable); # Not holdable, shouldn't capture holds.
2234 my $status = $U->copy_status($self->copy->status);
2235 return unless $U->is_true($status->holdable); # Current status not holdable means no hold will ever target the item
2236 # Specifically target items that are likely new (by status ID)
2237 return unless $status->id == OILS_COPY_STATUS_IN_PROCESS || $self->retarget_mode =~ m/\.all/;
2238 my $location = $self->copy->location;
2239 if(!ref($location)) {
2240 $location = $self->editor->retrieve_asset_copy_location($self->copy->location);
2241 $self->copy->location($location);
2243 return unless $U->is_true($location->holdable); # Don't bother on non-holdable locations
2245 # Fetch holds for the bib
2246 my ($result) = $holdcode->method_lookup('open-ils.circ.holds.retrieve_all_from_title')->run(
2247 $self->editor->authtoken,
2250 capture_time => undef, # No touching captured holds
2251 frozen => 'f', # Don't bother with frozen holds
2252 pickup_lib => $self->circ_lib # Only holds actually here
2255 # Error? Skip the step.
2256 return if exists $result->{"ilsevent"};
2260 foreach my $holdlist (keys %{$result}) {
2261 push @$holds, @{$result->{$holdlist}};
2264 return if scalar(@$holds) == 0; # No holds, no retargeting
2266 # Check for parts on this copy
2267 my $parts = $self->editor->search_asset_copy_part_map({ target_copy => $self->copy->id });
2268 my %parts_hash = ();
2269 %parts_hash = map {$_->part, 1} @$parts if @$parts;
2271 # Loop over holds in request-ish order
2272 # Stage 1: Get them into request-ish order
2273 # Also grab type and target for skipping low hanging ones
2274 $result = $self->editor->json_query({
2275 "select" => { "ahr" => ["id", "hold_type", "target"] },
2276 "from" => { "ahr" => { "au" => { "fkey" => "usr", "join" => "pgt"} } },
2277 "where" => { "id" => $holds },
2279 { "class" => "pgt", "field" => "hold_priority"},
2280 { "class" => "ahr", "field" => "cut_in_line", "direction" => "desc", "transform" => "coalesce", "params" => ['f']},
2281 { "class" => "ahr", "field" => "selection_depth", "direction" => "desc"},
2282 { "class" => "ahr", "field" => "request_time"}
2287 if (ref $result eq "ARRAY" and scalar @$result) {
2288 foreach (@{$result}) {
2289 # Copy level, but not this copy?
2290 next if ($_->{hold_type} eq 'C' or $_->{hold_type} eq 'R' or $_->{hold_type} eq 'F'
2291 and $_->{target} != $self->copy->id);
2292 # Volume level, but not this volume?
2293 next if ($_->{hold_type} eq 'V' and $_->{target} != $self->volume->id);
2294 if(@$parts) { # We have parts?
2296 next if ($_->{hold_type} eq 'T');
2297 # Skip part holds for parts not on this copy
2298 next if ($_->{hold_type} eq 'P' and not $parts_hash{$_->{target}});
2300 # No parts, no part holds
2301 next if ($_->{hold_type} eq 'P');
2303 # So much for easy stuff, attempt a retarget!
2304 my $tresult = $U->simplereq(
2305 'open-ils.hold-targeter',
2306 'open-ils.hold-targeter.target',
2307 {hold => $_->{id}, find_copy => $self->copy->id}
2309 if(ref $tresult eq "ARRAY" and scalar @$tresult) {
2310 last if(exists $tresult->[0]->{found_copy} and $tresult->[0]->{found_copy});
2318 $self->log_me("do_checkin()");
2320 return $self->bail_on_events(
2321 OpenILS::Event->new('ASSET_COPY_NOT_FOUND'))
2324 $self->check_transit_checkin_interval;
2325 $self->checkin_retarget;
2327 # the renew code and mk_env should have already found our circulation object
2328 unless( $self->circ ) {
2330 my $circs = $self->editor->search_action_circulation(
2331 { target_copy => $self->copy->id, checkin_time => undef });
2333 $self->circ($$circs[0]);
2335 # for now, just warn if there are multiple open circs on a copy
2336 $logger->warn("circulator: we have ".scalar(@$circs).
2337 " open circs for copy " .$self->copy->id."!!") if @$circs > 1;
2340 my $stat = $U->copy_status($self->copy->status)->id;
2342 # LOST (and to some extent, LONGOVERDUE) may optionally be handled
2343 # differently if they are already paid for. We need to check for this
2344 # early since overdue generation is potentially affected.
2345 my $dont_change_lost_zero = 0;
2346 if ($stat == OILS_COPY_STATUS_LOST
2347 || $stat == OILS_COPY_STATUS_LOST_AND_PAID
2348 || $stat == OILS_COPY_STATUS_LONG_OVERDUE) {
2350 # LOST fine settings are controlled by the copy's circ lib, not the the
2352 my $copy_circ_lib = (ref $self->copy->circ_lib) ?
2353 $self->copy->circ_lib->id : $self->copy->circ_lib;
2354 $dont_change_lost_zero = $U->ou_ancestor_setting_value(
2355 $copy_circ_lib, 'circ.checkin.lost_zero_balance.do_not_change',
2356 $self->editor) || 0;
2358 if ($dont_change_lost_zero) {
2359 my ($obt) = $U->fetch_mbts($self->circ->id, $self->editor);
2360 $dont_change_lost_zero = 0 if( $obt and $obt->balance_owed != 0 );
2363 $self->dont_change_lost_zero($dont_change_lost_zero);
2366 if( $self->checkin_check_holds_shelf() ) {
2367 $self->bail_on_events(OpenILS::Event->new('NO_CHANGE'));
2368 $self->hold($U->fetch_open_hold_by_copy($self->copy->id));
2369 if($self->fake_hold_dest) {
2370 $self->hold->pickup_lib($self->circ_lib);
2372 $self->checkin_flesh_events;
2376 unless( $self->is_renewal ) {
2377 return $self->bail_on_events($self->editor->event)
2378 unless $self->editor->allowed('COPY_CHECKIN');
2381 $self->push_events($self->check_copy_alert());
2382 $self->push_events($self->check_checkin_copy_status());
2384 # if the circ is marked as 'claims returned', add the event to the list
2385 $self->push_events(OpenILS::Event->new('CIRC_CLAIMS_RETURNED'))
2386 if ($self->circ and $self->circ->stop_fines
2387 and $self->circ->stop_fines eq OILS_STOP_FINES_CLAIMSRETURNED);
2389 $self->check_circ_deposit();
2391 # handle the overridable events
2392 $self->override_events unless $self->is_renewal;
2393 return if $self->bail_out;
2395 if( $self->copy and !$self->transit ) {
2397 $self->editor->search_action_transit_copy(
2398 { target_copy => $self->copy->id, dest_recv_time => undef }
2404 $self->checkin_handle_circ_start;
2405 return if $self->bail_out;
2407 if (!$dont_change_lost_zero) {
2408 # if this circ is LOST and we are configured to generate overdue
2409 # fines for lost items on checkin (to fill the gap between mark
2410 # lost time and when the fines would have naturally stopped), then
2411 # stop_fines is no longer valid and should be cleared.
2413 # stop_fines will be set again during the handle_fines() stage.
2414 # XXX should this setting come from the copy circ lib (like other
2415 # LOST settings), instead of the circulation circ lib?
2416 if ($stat == OILS_COPY_STATUS_LOST) {
2417 $self->circ->clear_stop_fines if
2418 $U->ou_ancestor_setting_value(
2420 OILS_SETTING_GENERATE_OVERDUE_ON_LOST_RETURN,
2425 # Set stop_fines when claimed never checked out
2426 $self->circ->stop_fines( OILS_STOP_FINES_CLAIMS_NEVERCHECKEDOUT ) if( $self->claims_never_checked_out );
2428 # handle fines for this circ, including overdue gen if needed
2429 $self->handle_fines;
2432 $self->checkin_handle_circ_finish;
2433 return if $self->bail_out;
2434 $self->checkin_changed(1);
2436 } elsif( $self->transit ) {
2437 my $hold_transit = $self->process_received_transit;
2438 $self->checkin_changed(1);
2440 if( $self->bail_out ) {
2441 $self->checkin_flesh_events;
2445 if( my $e = $self->check_checkin_copy_status() ) {
2446 # If the original copy status is special, alert the caller
2447 my $ev = $self->events;
2448 $self->events([$e]);
2449 $self->override_events;
2450 return if $self->bail_out;
2454 if( $hold_transit or
2455 $U->copy_status($self->copy->status)->id
2456 == OILS_COPY_STATUS_ON_HOLDS_SHELF ) {
2459 if( $hold_transit ) {
2460 $hold = $self->editor->retrieve_action_hold_request($hold_transit->hold);
2462 ($hold) = $U->fetch_open_hold_by_copy($self->copy->id);
2467 if( $hold and ( $hold->cancel_time or $hold->fulfillment_time ) ) { # this transited hold was cancelled or filled mid-transit
2469 $logger->info("circulator: we received a transit on a cancelled or filled hold " . $hold->id);
2470 $self->reshelve_copy(1);
2471 $self->cancelled_hold_transit(1);
2472 $self->notify_hold(0); # don't notify for cancelled holds
2473 $self->fake_hold_dest(0);
2474 return if $self->bail_out;
2476 } elsif ($hold and $hold->hold_type eq 'R') {
2478 $self->copy->status(OILS_COPY_STATUS_CATALOGING);
2479 $self->notify_hold(0); # No need to notify
2480 $self->fake_hold_dest(0);
2481 $self->noop(1); # Don't try and capture for other holds/transits now
2482 $self->update_copy();
2483 $hold->fulfillment_time('now');
2484 $self->bail_on_events($self->editor->event)
2485 unless $self->editor->update_action_hold_request($hold);
2489 # hold transited to correct location
2490 if($self->fake_hold_dest) {
2491 $hold->pickup_lib($self->circ_lib);
2493 $self->checkin_flesh_events;
2498 } elsif( $U->copy_status($self->copy->status)->id == OILS_COPY_STATUS_IN_TRANSIT ) {
2500 $logger->warn("circulator: we have a copy ".$self->copy->barcode.
2501 " that is in-transit, but there is no transit.. repairing");
2502 $self->reshelve_copy(1);
2503 return if $self->bail_out;
2506 if( $self->is_renewal ) {
2507 $self->finish_fines_and_voiding;
2508 return if $self->bail_out;
2509 $self->push_events(OpenILS::Event->new('SUCCESS'));
2513 # ------------------------------------------------------------------------------
2514 # Circulations and transits are now closed where necessary. Now go on to see if
2515 # this copy can fulfill a hold or needs to be routed to a different location
2516 # ------------------------------------------------------------------------------
2518 my $needed_for_something = 0; # formerly "needed_for_hold"
2520 if(!$self->noop) { # /not/ a no-op checkin, capture for hold or put item into transit
2522 if (!$self->remote_hold) {
2523 if ($self->use_booking) {
2524 my $potential_hold = $self->hold_capture_is_possible;
2525 my $potential_reservation = $self->reservation_capture_is_possible;
2527 if ($potential_hold and $potential_reservation) {
2528 $logger->info("circulator: item could fulfill either hold or reservation");
2529 $self->push_events(new OpenILS::Event(
2530 "HOLD_RESERVATION_CONFLICT",
2531 "hold" => $potential_hold,
2532 "reservation" => $potential_reservation
2534 return if $self->bail_out;
2535 } elsif ($potential_hold) {
2536 $needed_for_something =
2537 $self->attempt_checkin_hold_capture;
2538 } elsif ($potential_reservation) {
2539 $needed_for_something =
2540 $self->attempt_checkin_reservation_capture;
2543 $needed_for_something = $self->attempt_checkin_hold_capture;
2546 return if $self->bail_out;
2548 unless($needed_for_something) {
2549 my $circ_lib = (ref $self->copy->circ_lib) ?
2550 $self->copy->circ_lib->id : $self->copy->circ_lib;
2552 if( $self->remote_hold ) {
2553 $circ_lib = $self->remote_hold->pickup_lib;
2554 $logger->warn("circulator: Copy ".$self->copy->barcode.
2555 " is on a remote hold's shelf, sending to $circ_lib");
2558 $logger->debug("circulator: circlib=$circ_lib, workstation=".$self->circ_lib);
2560 my $suppress_transit = 0;
2562 if( $circ_lib != $self->circ_lib and not ($self->hold_as_transit and $self->remote_hold) ) {
2563 my $suppress_transit_source = $U->ou_ancestor_setting($self->circ_lib, 'circ.transit.suppress_non_hold');
2564 if($suppress_transit_source && $suppress_transit_source->{value}) {
2565 my $suppress_transit_dest = $U->ou_ancestor_setting($circ_lib, 'circ.transit.suppress_non_hold');
2566 if($suppress_transit_dest && $suppress_transit_source->{value} eq $suppress_transit_dest->{value}) {
2567 $logger->info("circulator: copy is within transit suppress group: ".$self->copy->barcode." ".$suppress_transit_source->{value});
2568 $suppress_transit = 1;
2573 if( $suppress_transit or ( $circ_lib == $self->circ_lib and not ($self->hold_as_transit and $self->remote_hold) ) ) {
2574 # copy is where it needs to be, either for hold or reshelving
2576 $self->checkin_handle_precat();
2577 return if $self->bail_out;
2580 # copy needs to transit "home", or stick here if it's a floating copy
2582 if ($self->copy->floating && ($self->manual_float || !$U->is_true($self->copy->floating->manual)) && !$self->remote_hold) { # copy is potentially floating?
2583 my $res = $self->editor->json_query(
2585 'evergreen.can_float',
2586 $self->copy->floating->id,
2587 $self->copy->circ_lib,
2592 $can_float = $U->is_true($res->[0]->{'evergreen.can_float'}) if $res;
2594 if ($can_float) { # Yep, floating, stick here
2595 $self->checkin_changed(1);
2596 $self->copy->circ_lib( $self->circ_lib );
2599 my $bc = $self->copy->barcode;
2600 $logger->info("circulator: copy $bc at the wrong location, sending to $circ_lib");
2601 $self->checkin_build_copy_transit($circ_lib);
2602 return if $self->bail_out;
2603 $self->push_events(OpenILS::Event->new('ROUTE_ITEM', org => $circ_lib));
2607 } else { # no-op checkin
2608 if ($self->copy->floating) { # XXX floating items still stick where they are even with no-op checkin?
2609 my $res = $self->editor->json_query(
2612 'evergreen.can_float',
2613 $self->copy->floating->id,
2614 $self->copy->circ_lib,
2619 if ($res && @$res && $U->is_true($res->[0]->{'evergreen.can_float'})) {
2620 $self->checkin_changed(1);
2621 $self->copy->circ_lib( $self->circ_lib );
2627 if($self->claims_never_checked_out and
2628 $U->ou_ancestor_setting_value($self->circ->circ_lib, 'circ.claim_never_checked_out.mark_missing')) {
2630 # the item was not supposed to be checked out to the user and should now be marked as missing
2631 $self->copy->status(OILS_COPY_STATUS_MISSING);
2635 $self->reshelve_copy unless $needed_for_something;
2638 return if $self->bail_out;
2640 unless($self->checkin_changed) {
2642 $self->push_events(OpenILS::Event->new('NO_CHANGE'));
2643 my $stat = $U->copy_status($self->copy->status)->id;
2645 $self->hold($U->fetch_open_hold_by_copy($self->copy->id))
2646 if( $stat == OILS_COPY_STATUS_ON_HOLDS_SHELF );
2647 $self->bail_out(1); # no need to commit anything
2651 $self->push_events(OpenILS::Event->new('SUCCESS'))
2652 unless @{$self->events};
2655 $self->finish_fines_and_voiding;
2657 OpenILS::Utils::Penalty->calculate_penalties(
2658 $self->editor, $self->patron->id, $self->circ_lib) if $self->patron;
2660 $self->checkin_flesh_events;
2664 sub finish_fines_and_voiding {
2666 return unless $self->circ;
2668 return unless $self->backdate or $self->void_overdues;
2670 # void overdues after fine generation to prevent concurrent DB access to overdue billings
2671 my $note = 'System: Amnesty Checkin' if $self->void_overdues;
2673 my $evt = $CC->void_or_zero_overdues(
2674 $self->editor, $self->circ, {backdate => $self->void_overdues ? undef : $self->backdate, note => $note});
2676 return $self->bail_on_events($evt) if $evt;
2678 # Make sure the circ is open or closed as necessary.
2679 $evt = $U->check_open_xact($self->editor, $self->circ->id);
2680 return $self->bail_on_events($evt) if $evt;
2686 # if a deposit was payed for this item, push the event
2687 sub check_circ_deposit {
2689 return unless $self->circ;
2690 my $deposit = $self->editor->search_money_billing(
2692 xact => $self->circ->id,
2694 }, {idlist => 1})->[0];
2696 $self->push_events(OpenILS::Event->new(
2697 'ITEM_DEPOSIT_PAID', payload => $deposit)) if $deposit;
2702 my $force = $self->force || shift;
2703 my $copy = $self->copy;
2705 my $stat = $U->copy_status($copy->status)->id;
2708 $stat != OILS_COPY_STATUS_ON_HOLDS_SHELF and
2709 $stat != OILS_COPY_STATUS_CATALOGING and
2710 $stat != OILS_COPY_STATUS_IN_TRANSIT and
2711 $stat != OILS_COPY_STATUS_RESHELVING )) {
2713 $copy->status( OILS_COPY_STATUS_RESHELVING );
2715 $self->checkin_changed(1);
2720 # Returns true if the item is at the current location
2721 # because it was transited there for a hold and the
2722 # hold has not been fulfilled
2723 sub checkin_check_holds_shelf {
2725 return 0 unless $self->copy;
2728 $U->copy_status($self->copy->status)->id ==
2729 OILS_COPY_STATUS_ON_HOLDS_SHELF;
2731 # Attempt to clear shelf expired holds for this copy
2732 $holdcode->method_lookup('open-ils.circ.hold.clear_shelf.process')->run($self->editor->authtoken, $self->circ_lib, $self->copy->id)
2733 if($self->clear_expired);
2735 # find the hold that put us on the holds shelf
2736 my $holds = $self->editor->search_action_hold_request(
2738 current_copy => $self->copy->id,
2739 capture_time => { '!=' => undef },
2740 fulfillment_time => undef,
2741 cancel_time => undef,
2746 $logger->warn("circulator: copy is on-holds-shelf, but there is no hold - reshelving");
2747 $self->reshelve_copy(1);
2751 my $hold = $$holds[0];
2753 $logger->info("circulator: we found a captured, un-fulfilled hold [".
2754 $hold->id. "] for copy ".$self->copy->barcode);
2756 if( $hold->pickup_lib != $self->circ_lib and not $self->hold_as_transit ) {
2757 my $suppress_transit_circ = $U->ou_ancestor_setting($self->circ_lib, 'circ.transit.suppress_hold');
2758 if($suppress_transit_circ && $suppress_transit_circ->{value}) {
2759 my $suppress_transit_pickup = $U->ou_ancestor_setting($hold->pickup_lib, 'circ.transit.suppress_hold');
2760 if($suppress_transit_pickup && $suppress_transit_circ->{value} eq $suppress_transit_pickup->{value}) {
2761 $logger->info("circulator: hold is within hold transit suppress group .. we're done: ".$self->copy->barcode." ".$suppress_transit_circ->{value});
2762 $self->fake_hold_dest(1);
2768 if( $hold->pickup_lib == $self->circ_lib and not $self->hold_as_transit ) {
2769 $logger->info("circulator: hold is for here .. we're done: ".$self->copy->barcode);
2773 $logger->info("circulator: hold is not for here..");
2774 $self->remote_hold($hold);
2779 sub checkin_handle_precat {
2781 my $copy = $self->copy;
2783 if( $self->is_precat and ($copy->status != OILS_COPY_STATUS_CATALOGING) ) {
2784 $copy->status(OILS_COPY_STATUS_CATALOGING);
2785 $self->update_copy();
2786 $self->checkin_changed(1);
2787 $self->push_events(OpenILS::Event->new('ITEM_NOT_CATALOGED'));
2792 sub checkin_build_copy_transit {
2795 my $copy = $self->copy;
2796 my $transit = Fieldmapper::action::transit_copy->new;
2798 # if we are transiting an item to the shelf shelf, it's a hold transit
2799 if (my $hold = $self->remote_hold) {
2800 $transit = Fieldmapper::action::hold_transit_copy->new;
2801 $transit->hold($hold->id);
2803 # the item is going into transit, remove any shelf-iness
2804 if ($hold->current_shelf_lib or $hold->shelf_time) {
2805 $hold->clear_current_shelf_lib;
2806 $hold->clear_shelf_time;
2807 return $self->bail_on_events($self->editor->event)
2808 unless $self->editor->update_action_hold_request($hold);
2812 #$dest ||= (ref($copy->circ_lib)) ? $copy->circ_lib->id : $copy->circ_lib;
2813 $logger->info("circulator: transiting copy to $dest");
2815 $transit->source($self->circ_lib);
2816 $transit->dest($dest);
2817 $transit->target_copy($copy->id);
2818 $transit->source_send_time('now');
2819 $transit->copy_status( $U->copy_status($copy->status)->id );
2821 $logger->debug("circulator: setting copy status on transit: ".$transit->copy_status);
2823 if ($self->remote_hold) {
2824 return $self->bail_on_events($self->editor->event)
2825 unless $self->editor->create_action_hold_transit_copy($transit);
2827 return $self->bail_on_events($self->editor->event)
2828 unless $self->editor->create_action_transit_copy($transit);
2831 # ensure the transit is returned to the caller
2832 $self->transit($transit);
2834 $copy->status(OILS_COPY_STATUS_IN_TRANSIT);
2836 $self->checkin_changed(1);
2840 sub hold_capture_is_possible {
2842 my $copy = $self->copy;
2844 # we've been explicitly told not to capture any holds
2845 return 0 if $self->capture eq 'nocapture';
2847 # See if this copy can fulfill any holds
2848 my $hold = $holdcode->find_nearest_permitted_hold(
2849 $self->editor, $copy, $self->editor->requestor, 1 # check_only
2851 return undef if ref $hold eq "HASH" and
2852 $hold->{"textcode"} eq "ACTION_HOLD_REQUEST_NOT_FOUND";
2856 sub reservation_capture_is_possible {
2858 my $copy = $self->copy;
2860 # we've been explicitly told not to capture any holds
2861 return 0 if $self->capture eq 'nocapture';
2863 my $booking_ses = OpenSRF::AppSession->connect("open-ils.booking");
2864 my $resv = $booking_ses->request(
2865 "open-ils.booking.reservations.could_capture",
2866 $self->editor->authtoken, $copy->barcode
2868 $booking_ses->disconnect;
2869 if (ref($resv) eq "HASH" and exists $resv->{"textcode"}) {
2870 $self->push_events($resv);
2876 # returns true if the item was used (or may potentially be used
2877 # in subsequent calls) to capture a hold.
2878 sub attempt_checkin_hold_capture {
2880 my $copy = $self->copy;
2882 # we've been explicitly told not to capture any holds
2883 return 0 if $self->capture eq 'nocapture';
2885 # See if this copy can fulfill any holds
2886 my ($hold, undef, $retarget) = $holdcode->find_nearest_permitted_hold(
2887 $self->editor, $copy, $self->editor->requestor );
2890 $logger->debug("circulator: no potential permitted".
2891 "holds found for copy ".$copy->barcode);
2895 if($self->capture ne 'capture') {
2896 # see if this item is in a hold-capture-delay location
2897 my $location = $self->copy->location;
2898 if(!ref($location)) {
2899 $location = $self->editor->retrieve_asset_copy_location($self->copy->location);
2900 $self->copy->location($location);
2902 if($U->is_true($location->hold_verify)) {
2903 $self->bail_on_events(
2904 OpenILS::Event->new('HOLD_CAPTURE_DELAYED', copy_location => $location));
2909 $self->retarget($retarget);
2911 my $suppress_transit = 0;
2912 if( $hold->pickup_lib != $self->circ_lib and not $self->hold_as_transit ) {
2913 my $suppress_transit_circ = $U->ou_ancestor_setting($self->circ_lib, 'circ.transit.suppress_hold');
2914 if($suppress_transit_circ && $suppress_transit_circ->{value}) {
2915 my $suppress_transit_pickup = $U->ou_ancestor_setting($hold->pickup_lib, 'circ.transit.suppress_hold');
2916 if($suppress_transit_pickup && $suppress_transit_circ->{value} eq $suppress_transit_pickup->{value}) {
2917 $suppress_transit = 1;
2918 $hold->pickup_lib($self->circ_lib);
2923 $logger->info("circulator: found permitted hold ".$hold->id." for copy, capturing...");
2925 $hold->current_copy($copy->id);
2926 $hold->capture_time('now');
2927 $self->put_hold_on_shelf($hold)
2928 if ($suppress_transit || ($hold->pickup_lib == $self->circ_lib and not $self->hold_as_transit) );
2930 # prevent DB errors caused by fetching
2931 # holds from storage, and updating through cstore
2932 $hold->clear_fulfillment_time;
2933 $hold->clear_fulfillment_staff;
2934 $hold->clear_fulfillment_lib;
2935 $hold->clear_expire_time;
2936 $hold->clear_cancel_time;
2937 $hold->clear_prev_check_time unless $hold->prev_check_time;
2939 $self->bail_on_events($self->editor->event)
2940 unless $self->editor->update_action_hold_request($hold);
2942 $self->checkin_changed(1);
2944 return 0 if $self->bail_out;
2946 if( $suppress_transit or ( $hold->pickup_lib == $self->circ_lib && not $self->hold_as_transit ) ) {
2948 if ($hold->hold_type eq 'R') {
2949 $copy->status(OILS_COPY_STATUS_CATALOGING);
2950 $hold->fulfillment_time('now');
2951 $self->noop(1); # Block other transit/hold checks
2952 $self->bail_on_events($self->editor->event)
2953 unless $self->editor->update_action_hold_request($hold);
2955 # This hold was captured in the correct location
2956 $copy->status(OILS_COPY_STATUS_ON_HOLDS_SHELF);
2957 $self->push_events(OpenILS::Event->new('SUCCESS'));
2959 #$self->do_hold_notify($hold->id);
2960 $self->notify_hold($hold->id);
2965 # Hold needs to be picked up elsewhere. Build a hold
2966 # transit and route the item.
2967 $self->checkin_build_hold_transit();
2968 $copy->status(OILS_COPY_STATUS_IN_TRANSIT);
2969 return 0 if $self->bail_out;
2970 $self->push_events(OpenILS::Event->new('ROUTE_ITEM', org => $hold->pickup_lib));
2973 # make sure we save the copy status
2975 return 0 if $copy->status == OILS_COPY_STATUS_CATALOGING;
2979 sub attempt_checkin_reservation_capture {
2981 my $copy = $self->copy;
2983 # we've been explicitly told not to capture any holds
2984 return 0 if $self->capture eq 'nocapture';
2986 my $booking_ses = OpenSRF::AppSession->connect("open-ils.booking");
2987 my $evt = $booking_ses->request(
2988 "open-ils.booking.resources.capture_for_reservation",
2989 $self->editor->authtoken,
2991 1 # don't update copy - we probably have it locked
2993 $booking_ses->disconnect;
2995 if (ref($evt) ne "HASH" or not exists $evt->{"textcode"}) {
2997 "open-ils.booking.resources.capture_for_reservation " .
2998 "didn't return an event!"
3002 $evt->{"textcode"} eq "RESERVATION_NOT_FOUND" and
3003 $evt->{"payload"}->{"fail_cause"} eq "not-transferable"
3005 # not-transferable is an error event we'll pass on the user
3006 $logger->warn("reservation capture attempted against non-transferable item");
3007 $self->push_events($evt);
3009 } elsif ($evt->{"textcode"} eq "SUCCESS") {
3010 # Re-retrieve copy as reservation capture may have changed
3011 # its status and whatnot.
3013 "circulator: booking capture win on copy " . $self->copy->id
3015 if (my $new_copy_status = $evt->{"payload"}->{"new_copy_status"}) {
3017 "circulator: changing copy " . $self->copy->id .
3018 "'s status from " . $self->copy->status . " to " .
3021 $self->copy->status($new_copy_status);
3024 $self->reservation($evt->{"payload"}->{"reservation"});
3026 if (exists $evt->{"payload"}->{"transit"}) {
3030 "org" => $evt->{"payload"}->{"transit"}->dest
3034 $self->checkin_changed(1);
3038 # other results are treated as "nothing to capture"
3042 sub do_hold_notify {
3043 my( $self, $holdid ) = @_;
3045 my $e = new_editor(xact => 1);
3046 my $hold = $e->retrieve_action_hold_request($holdid) or return $e->die_event;
3048 my $ses = OpenSRF::AppSession->create('open-ils.trigger');
3049 $ses->request('open-ils.trigger.event.autocreate', 'hold.available', $hold, $hold->pickup_lib);
3051 $logger->info("circulator: running delayed hold notify process");
3053 # my $notifier = OpenILS::Application::Circ::HoldNotify->new(
3054 # hold_id => $holdid, editor => new_editor(requestor=>$self->editor->requestor));
3056 my $notifier = OpenILS::Application::Circ::HoldNotify->new(
3057 hold_id => $holdid, requestor => $self->editor->requestor);
3059 $logger->debug("circulator: built hold notifier");
3061 if(!$notifier->event) {
3063 $logger->info("circulator: attempt at sending hold notification for hold $holdid");
3065 my $stat = $notifier->send_email_notify;
3066 if( $stat == '1' ) {
3067 $logger->info("circulator: hold notify succeeded for hold $holdid");
3071 $logger->debug("circulator: * hold notify cancelled or failed for hold $holdid");
3074 $logger->info("circulator: Not sending hold notification since the patron has no email address");
3078 sub retarget_holds {
3080 $logger->info("circulator: retargeting holds @{$self->retarget} after opportunistic capture");
3081 my $ses = OpenSRF::AppSession->create('open-ils.hold-targeter');
3082 $ses->request('open-ils.hold-targeter.target', {hold => $self->retarget});
3083 # no reason to wait for the return value
3087 sub checkin_build_hold_transit {
3090 my $copy = $self->copy;
3091 my $hold = $self->hold;
3092 my $trans = Fieldmapper::action::hold_transit_copy->new;
3094 $logger->debug("circulator: building hold transit for ".$copy->barcode);
3096 $trans->hold($hold->id);
3097 $trans->source($self->circ_lib);
3098 $trans->dest($hold->pickup_lib);
3099 $trans->source_send_time("now");
3100 $trans->target_copy($copy->id);
3102 # when the copy gets to its destination, it will recover
3103 # this status - put it onto the holds shelf
3104 $trans->copy_status(OILS_COPY_STATUS_ON_HOLDS_SHELF);
3106 return $self->bail_on_events($self->editor->event)
3107 unless $self->editor->create_action_hold_transit_copy($trans);
3112 sub process_received_transit {
3114 my $copy = $self->copy;
3115 my $copyid = $self->copy->id;
3117 my $status_name = $U->copy_status($copy->status)->name;
3118 $logger->debug("circulator: attempting transit receive on ".
3119 "copy $copyid. Copy status is $status_name");
3121 my $transit = $self->transit;
3123 # Check if we are in a transit suppress range
3124 my $suppress_transit = 0;
3125 if ( $transit->dest != $self->circ_lib and not ( $self->hold_as_transit and $transit->copy_status == OILS_COPY_STATUS_ON_HOLDS_SHELF ) ) {
3126 my $suppress_setting = ($transit->copy_status == OILS_COPY_STATUS_ON_HOLDS_SHELF ? 'circ.transit.suppress_hold' : 'circ.transit.suppress_non_hold');
3127 my $suppress_transit_circ = $U->ou_ancestor_setting($self->circ_lib, $suppress_setting);
3128 if($suppress_transit_circ && $suppress_transit_circ->{value}) {
3129 my $suppress_transit_dest = $U->ou_ancestor_setting($transit->dest, $suppress_setting);
3130 if($suppress_transit_dest && $suppress_transit_dest->{value} eq $suppress_transit_circ->{value}) {
3131 $suppress_transit = 1;
3132 $self->fake_hold_dest(1) if $transit->copy_status == OILS_COPY_STATUS_ON_HOLDS_SHELF;
3136 if( not $suppress_transit and ( $transit->dest != $self->circ_lib or ($self->hold_as_transit && $transit->copy_status == OILS_COPY_STATUS_ON_HOLDS_SHELF) ) ) {
3137 # - this item is in-transit to a different location
3138 # - Or we are capturing holds as transits, so why create a new transit?
3140 my $tid = $transit->id;
3141 my $loc = $self->circ_lib;
3142 my $dest = $transit->dest;
3144 $logger->info("circulator: Fowarding transit on copy which is destined ".
3145 "for a different location. transit=$tid, copy=$copyid, current ".
3146 "location=$loc, destination location=$dest");
3148 my $evt = OpenILS::Event->new('ROUTE_ITEM', org => $dest, payload => {});
3150 # grab the associated hold object if available
3151 my $ht = $self->editor->retrieve_action_hold_transit_copy($tid);
3152 $self->hold($self->editor->retrieve_action_hold_request($ht->hold)) if $ht;
3154 return $self->bail_on_events($evt);
3157 # The transit is received, set the receive time
3158 $transit->dest_recv_time('now');
3159 $self->bail_on_events($self->editor->event)
3160 unless $self->editor->update_action_transit_copy($transit);
3162 my $hold_transit = $self->editor->retrieve_action_hold_transit_copy($transit->id);
3164 $logger->info("circulator: Recovering original copy status in transit: ".$transit->copy_status);
3165 $copy->status( $transit->copy_status );
3166 $self->update_copy();
3167 return if $self->bail_out;
3171 my $hold = $self->editor->retrieve_action_hold_request($hold_transit->hold);
3174 # hold has arrived at destination, set shelf time
3175 $self->put_hold_on_shelf($hold);
3176 $self->bail_on_events($self->editor->event)
3177 unless $self->editor->update_action_hold_request($hold);
3178 return if $self->bail_out;
3180 $self->notify_hold($hold_transit->hold);
3183 $hold_transit = undef;
3184 $self->cancelled_hold_transit(1);
3185 $self->reshelve_copy(1);
3186 $self->fake_hold_dest(0);
3191 OpenILS::Event->new(
3194 payload => { transit => $transit, holdtransit => $hold_transit } ));
3196 return $hold_transit;
3200 # ------------------------------------------------------------------
3201 # Sets the shelf_time and shelf_expire_time for a newly shelved hold
3202 # ------------------------------------------------------------------
3203 sub put_hold_on_shelf {
3204 my($self, $hold) = @_;
3205 $hold->shelf_time('now');
3206 $hold->current_shelf_lib($self->circ_lib);
3207 $holdcode->set_hold_shelf_expire_time($hold, $self->editor);
3213 my $reservation = shift;
3214 my $dt_parser = DateTime::Format::ISO8601->new;
3216 my $obj = $reservation ? $self->reservation : $self->circ;
3218 my $lost_bill_opts = $self->lost_bill_options;
3219 my $circ_lib = $lost_bill_opts->{circ_lib} if $lost_bill_opts;
3220 # first, restore any voided overdues for lost, if needed
3221 if ($self->needs_lost_bill_handling and !$self->void_overdues) {
3222 my $restore_od = $U->ou_ancestor_setting_value(
3223 $circ_lib, $lost_bill_opts->{ous_restore_overdue},
3224 $self->editor) || 0;
3225 $self->checkin_handle_lost_or_lo_now_found_restore_od($circ_lib)
3229 # next, handle normal overdue generation and apply stop_fines
3230 # XXX reservations don't have stop_fines
3231 # TODO revisit booking_reservation re: stop_fines support
3232 if ($reservation or !$obj->stop_fines) {
3235 # This is a crude check for whether we are in a grace period. The code
3236 # in generate_fines() does a more thorough job, so this exists solely
3237 # as a small optimization, and might be better off removed.
3239 # If we have a grace period
3240 if($obj->can('grace_period')) {
3241 # Parse out the due date
3242 my $due_date = $dt_parser->parse_datetime( cleanse_ISO8601($obj->due_date) );
3243 # Add the grace period to the due date
3244 $due_date->add(seconds => OpenSRF::Utils->interval_to_seconds($obj->grace_period));
3245 # Don't generate fines on circs still in grace period
3246 $skip_for_grace = $due_date > DateTime->now;
3248 $CC->generate_fines({circs => [$obj], editor => $self->editor})
3249 unless $skip_for_grace;
3251 if (!$reservation and !$obj->stop_fines) {
3252 $obj->stop_fines(OILS_STOP_FINES_CHECKIN);
3253 $obj->stop_fines(OILS_STOP_FINES_RENEW) if $self->is_renewal;
3254 $obj->stop_fines(OILS_STOP_FINES_CLAIMS_NEVERCHECKEDOUT) if $self->claims_never_checked_out;
3255 $obj->stop_fines_time('now');
3256 $obj->stop_fines_time($self->backdate) if $self->backdate;
3257 $self->editor->update_action_circulation($obj);
3261 # finally, handle voiding of lost item and processing fees
3262 if ($self->needs_lost_bill_handling) {
3263 my $void_cost = $U->ou_ancestor_setting_value(
3264 $circ_lib, $lost_bill_opts->{ous_void_item_cost},
3265 $self->editor) || 0;
3266 my $void_proc_fee = $U->ou_ancestor_setting_value(
3267 $circ_lib, $lost_bill_opts->{ous_void_proc_fee},
3268 $self->editor) || 0;
3269 $self->checkin_handle_lost_or_lo_now_found(
3270 $lost_bill_opts->{void_cost_btype},
3271 $lost_bill_opts->{is_longoverdue}) if $void_cost;
3272 $self->checkin_handle_lost_or_lo_now_found(
3273 $lost_bill_opts->{void_fee_btype},
3274 $lost_bill_opts->{is_longoverdue}) if $void_proc_fee;
3280 sub checkin_handle_circ_start {
3282 my $circ = $self->circ;
3283 my $copy = $self->copy;
3287 $self->backdate($circ->xact_start) if $self->claims_never_checked_out;
3289 # backdate the circ if necessary
3290 if($self->backdate) {
3291 my $evt = $self->checkin_handle_backdate;
3292 return $self->bail_on_events($evt) if $evt;
3295 # Set the checkin vars since we have the item
3296 $circ->checkin_time( ($self->backdate) ? $self->backdate : 'now' );
3298 # capture the true scan time for back-dated checkins
3299 $circ->checkin_scan_time('now');
3301 $circ->checkin_staff($self->editor->requestor->id);
3302 $circ->checkin_lib($self->circ_lib);
3303 $circ->checkin_workstation($self->editor->requestor->wsid);
3305 my $circ_lib = (ref $self->copy->circ_lib) ?
3306 $self->copy->circ_lib->id : $self->copy->circ_lib;
3307 my $stat = $U->copy_status($self->copy->status)->id;
3309 if ($stat == OILS_COPY_STATUS_LOST || $stat == OILS_COPY_STATUS_LOST_AND_PAID) {
3310 # we will now handle lost fines, but the copy will retain its 'lost'
3311 # status if it needs to transit home unless lost_immediately_available
3314 # if we decide to also delay fine handling until the item arrives home,
3315 # we will need to call lost fine handling code both when checking items
3316 # in and also when receiving transits
3317 $self->checkin_handle_lost($circ_lib);
3318 } elsif ($stat == OILS_COPY_STATUS_LONG_OVERDUE) {
3319 # same process as above.
3320 $self->checkin_handle_long_overdue($circ_lib);
3321 } elsif ($circ_lib != $self->circ_lib and $stat == OILS_COPY_STATUS_MISSING) {
3322 $logger->info("circulator: not updating copy status on checkin because copy is missing");
3324 $self->copy->status($U->copy_status(OILS_COPY_STATUS_RESHELVING));
3331 sub checkin_handle_circ_finish {
3333 my $circ = $self->circ;
3335 # see if there are any fines owed on this circ. if not, close it
3336 my ($obt) = $U->fetch_mbts($circ->id, $self->editor);
3337 $circ->xact_finish('now') if( $obt and $obt->balance_owed == 0 );
3339 $logger->debug("circulator: ".$obt->balance_owed." is owed on this circulation");
3341 return $self->bail_on_events($self->editor->event)
3342 unless $self->editor->update_action_circulation($circ);
3347 # ------------------------------------------------------------------
3348 # See if we need to void billings, etc. for lost checkin
3349 # ------------------------------------------------------------------
3350 sub checkin_handle_lost {
3352 my $circ_lib = shift;
3354 my $max_return = $U->ou_ancestor_setting_value($circ_lib,
3355 OILS_SETTING_MAX_ACCEPT_RETURN_OF_LOST, $self->editor) || 0;
3357 $self->lost_bill_options({
3358 circ_lib => $circ_lib,
3359 ous_void_item_cost => OILS_SETTING_VOID_LOST_ON_CHECKIN,
3360 ous_void_proc_fee => OILS_SETTING_VOID_LOST_PROCESS_FEE_ON_CHECKIN,
3361 ous_restore_overdue => OILS_SETTING_RESTORE_OVERDUE_ON_LOST_RETURN,
3362 void_cost_btype => 3,
3366 return $self->checkin_handle_lost_or_longoverdue(
3367 circ_lib => $circ_lib,
3368 max_return => $max_return,
3369 ous_immediately_available => OILS_SETTING_LOST_IMMEDIATELY_AVAILABLE,
3370 ous_use_last_activity => undef # not supported for LOST checkin
3374 # ------------------------------------------------------------------
3375 # See if we need to void billings, etc. for long-overdue checkin
3376 # note: not using constants below since they serve little purpose
3377 # for single-use strings that are descriptive in their own right
3378 # and mostly just complicate debugging.
3379 # ------------------------------------------------------------------
3380 sub checkin_handle_long_overdue {
3382 my $circ_lib = shift;
3384 $logger->info("circulator: processing long-overdue checkin...");
3386 my $max_return = $U->ou_ancestor_setting_value($circ_lib,
3387 'circ.max_accept_return_of_longoverdue', $self->editor) || 0;
3389 $self->lost_bill_options({
3390 circ_lib => $circ_lib,
3391 ous_void_item_cost => 'circ.void_longoverdue_on_checkin',
3392 ous_void_proc_fee => 'circ.void_longoverdue_proc_fee_on_checkin',
3393 is_longoverdue => 1,
3394 ous_restore_overdue => 'circ.restore_overdue_on_longoverdue_return',
3395 void_cost_btype => 10,
3396 void_fee_btype => 11
3399 return $self->checkin_handle_lost_or_longoverdue(
3400 circ_lib => $circ_lib,
3401 max_return => $max_return,
3402 ous_immediately_available => 'circ.longoverdue_immediately_available',
3403 ous_use_last_activity =>
3404 'circ.longoverdue.use_last_activity_date_on_return'
3408 # last billing activity is last payment time, last billing time, or the
3409 # circ due date. If the relevant "use last activity" org unit setting is
3410 # false/unset, then last billing activity is always the due date.
3411 sub get_circ_last_billing_activity {
3413 my $circ_lib = shift;
3414 my $setting = shift;
3415 my $date = $self->circ->due_date;
3417 return $date unless $setting and
3418 $U->ou_ancestor_setting_value($circ_lib, $setting, $self->editor);
3420 my $xact = $self->editor->retrieve_money_billable_transaction([
3422 {flesh => 1, flesh_fields => {mbt => ['summary']}}
3425 if ($xact->summary) {
3426 $date = $xact->summary->last_payment_ts ||
3427 $xact->summary->last_billing_ts ||
3428 $self->circ->due_date;
3435 sub checkin_handle_lost_or_longoverdue {
3436 my ($self, %args) = @_;
3438 my $circ = $self->circ;
3439 my $max_return = $args{max_return};
3440 my $circ_lib = $args{circ_lib};
3445 $self->get_circ_last_billing_activity(
3446 $circ_lib, $args{ous_use_last_activity});
3449 my @tm = reverse($last_activity =~ /([\d\.]+)/og);
3450 $tm[5] -= 1 if $tm[5] > 0;
3451 my $due = timelocal(int($tm[1]), int($tm[2]),
3452 int($tm[3]), int($tm[4]), int($tm[5]), int($tm[6]));
3455 OpenSRF::Utils->interval_to_seconds($max_return) + int($due);
3457 $logger->info("MAX OD: $max_return LAST ACTIVITY: ".
3458 "$last_activity DUEDATE: ".$circ->due_date." TODAY: $today ".
3459 "DUE: $due LAST: $last_chance");
3461 $max_return = 0 if $today < $last_chance;
3467 $logger->info("circulator: check-in of lost/lo item exceeds max ".
3468 "return interval. skipping fine/fee voiding, etc.");
3470 } elsif ($self->dont_change_lost_zero) { # we leave lost zero balance alone
3472 $logger->info("circulator: check-in of lost/lo item having a balance ".
3473 "of zero, skipping fine/fee voiding and reinstatement.");
3475 } else { # within max-return interval or no interval defined
3477 $logger->info("circulator: check-in of lost/lo item is within the ".
3478 "max return interval (or no interval is defined). Proceeding ".
3479 "with fine/fee voiding, etc.");
3481 $self->needs_lost_bill_handling(1);
3484 if ($circ_lib != $self->circ_lib) {
3485 # if the item is not home, check to see if we want to retain the
3486 # lost/longoverdue status at this point in the process
3488 my $immediately_available = $U->ou_ancestor_setting_value($circ_lib,
3489 $args{ous_immediately_available}, $self->editor) || 0;
3491 if ($immediately_available) {
3492 # item status does not need to be retained, so give it a
3493 # reshelving status as if it were a normal checkin
3494 $self->copy->status($U->copy_status(OILS_COPY_STATUS_RESHELVING));
3497 $logger->info("circulator: leaving lost/longoverdue copy".
3498 " status in place on checkin");
3501 # lost/longoverdue item is home and processed, treat like a normal
3502 # checkin from this point on
3503 $self->copy->status($U->copy_status(OILS_COPY_STATUS_RESHELVING));
3509 sub checkin_handle_backdate {
3512 # ------------------------------------------------------------------
3513 # clean up the backdate for date comparison
3514 # XXX We are currently taking the due-time from the original due-date,
3515 # not the input. Do we need to do this? This certainly interferes with
3516 # backdating of hourly checkouts, but that is likely a very rare case.
3517 # ------------------------------------------------------------------
3518 my $bd = cleanse_ISO8601($self->backdate);
3519 my $original_date = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($self->circ->due_date));
3520 my $new_date = DateTime::Format::ISO8601->new->parse_datetime($bd);
3521 $new_date->set_hour($original_date->hour());
3522 $new_date->set_minute($original_date->minute());
3523 if ($new_date >= DateTime->now) {
3524 # We can't say that the item will be checked in later...so assume someone's clock is wrong instead.
3525 # $self->backdate() autoload handler ignores undef values.
3526 # Clear the backdate manually.
3527 $logger->info("circulator: ignoring future backdate: $new_date");
3528 delete $self->{backdate};
3530 $self->backdate(cleanse_ISO8601($new_date->datetime()));
3537 sub check_checkin_copy_status {
3539 my $copy = $self->copy;
3541 my $status = $U->copy_status($copy->status)->id;
3544 if( $status == OILS_COPY_STATUS_AVAILABLE ||
3545 $status == OILS_COPY_STATUS_CHECKED_OUT ||
3546 $status == OILS_COPY_STATUS_IN_PROCESS ||
3547 $status == OILS_COPY_STATUS_ON_HOLDS_SHELF ||
3548 $status == OILS_COPY_STATUS_IN_TRANSIT ||
3549 $status == OILS_COPY_STATUS_CATALOGING ||
3550 $status == OILS_COPY_STATUS_ON_RESV_SHELF ||
3551 $status == OILS_COPY_STATUS_CANCELED_TRANSIT ||
3552 $status == OILS_COPY_STATUS_RESHELVING );
3554 return OpenILS::Event->new('COPY_STATUS_LOST', payload => $copy )
3555 if( $status == OILS_COPY_STATUS_LOST );
3557 return OpenILS::Event->new('COPY_STATUS_LOST_AND_PAID', payload => $copy)
3558 if ($status == OILS_COPY_STATUS_LOST_AND_PAID);
3560 return OpenILS::Event->new('COPY_STATUS_LONG_OVERDUE', payload => $copy )
3561 if( $status == OILS_COPY_STATUS_LONG_OVERDUE );
3563 return OpenILS::Event->new('COPY_STATUS_MISSING', payload => $copy )
3564 if( $status == OILS_COPY_STATUS_MISSING );
3566 return OpenILS::Event->new('COPY_BAD_STATUS', payload => $copy );
3571 # --------------------------------------------------------------------------
3572 # On checkin, we need to return as many relevant objects as we can
3573 # --------------------------------------------------------------------------
3574 sub checkin_flesh_events {
3577 if( grep { $_->{textcode} eq 'SUCCESS' } @{$self->events}
3578 and grep { $_->{textcode} eq 'ITEM_NOT_CATALOGED' } @{$self->events} ) {
3579 $self->events([grep { $_->{textcode} eq 'ITEM_NOT_CATALOGED' } @{$self->events}]);
3582 my $record = $U->record_to_mvr($self->title) if($self->title and !$self->is_precat);
3585 if($self->hold and !$self->hold->cancel_time) {
3586 $hold = $self->hold;
3587 $hold->notes($self->editor->search_action_hold_request_note({hold => $hold->id}));
3591 # update our copy of the circ object and
3592 # flesh the billing summary data
3594 $self->editor->retrieve_action_circulation([
3598 circ => ['billable_transaction'],
3607 # flesh some patron fields before returning
3609 $self->editor->retrieve_actor_user([
3614 au => ['card', 'billing_address', 'mailing_address']
3621 for my $evt (@{$self->events}) {
3624 $payload->{copy} = $U->unflesh_copy($self->copy);
3625 $payload->{volume} = $self->volume;
3626 $payload->{record} = $record,
3627 $payload->{circ} = $self->circ;
3628 $payload->{transit} = $self->transit;
3629 $payload->{cancelled_hold_transit} = 1 if $self->cancelled_hold_transit;
3630 $payload->{hold} = $hold;
3631 $payload->{patron} = $self->patron;
3632 $payload->{reservation} = $self->reservation
3633 unless (not $self->reservation or $self->reservation->cancel_time);
3635 $evt->{payload} = $payload;
3640 my( $self, $msg ) = @_;
3641 my $bc = ($self->copy) ? $self->copy->barcode :
3644 my $usr = ($self->patron) ? $self->patron->id : "";
3645 $logger->info("circulator: $msg requestor=".$self->editor->requestor->id.
3646 ", recipient=$usr, copy=$bc");
3652 $self->log_me("do_renew()");
3654 # Make sure there is an open circ to renew
3655 my $usrid = $self->patron->id if $self->patron;
3656 my $circ = $self->editor->search_action_circulation({
3657 target_copy => $self->copy->id,
3658 xact_finish => undef,
3659 checkin_time => undef,
3660 ($usrid ? (usr => $usrid) : ())
3663 return $self->bail_on_events($self->editor->event) unless $circ;
3665 # A user is not allowed to renew another user's items without permission
3666 unless( $circ->usr eq $self->editor->requestor->id ) {
3667 return $self->bail_on_events($self->editor->events)
3668 unless $self->editor->allowed('RENEW_CIRC', $circ->circ_lib);
3671 $self->push_events(OpenILS::Event->new('MAX_RENEWALS_REACHED'))
3672 if $circ->renewal_remaining < 1;
3674 # -----------------------------------------------------------------
3676 $self->parent_circ($circ->id);
3677 $self->renewal_remaining( $circ->renewal_remaining - 1 );
3680 # Opac renewal - re-use circ library from original circ (unless told not to)
3681 if($self->opac_renewal) {
3682 unless(defined($opac_renewal_use_circ_lib)) {
3683 my $use_circ_lib = $self->editor->retrieve_config_global_flag('circ.opac_renewal.use_original_circ_lib');
3684 if($use_circ_lib and $U->is_true($use_circ_lib->enabled)) {
3685 $opac_renewal_use_circ_lib = 1;
3688 $opac_renewal_use_circ_lib = 0;
3691 $self->circ_lib($circ->circ_lib) if($opac_renewal_use_circ_lib);
3694 # Desk renewal - re-use circ library from original circ (unless told not to)
3695 if($self->desk_renewal) {
3696 unless(defined($desk_renewal_use_circ_lib)) {
3697 my $use_circ_lib = $self->editor->retrieve_config_global_flag('circ.desk_renewal.use_original_circ_lib');
3698 if($use_circ_lib and $U->is_true($use_circ_lib->enabled)) {
3699 $desk_renewal_use_circ_lib = 1;
3702 $desk_renewal_use_circ_lib = 0;
3705 $self->circ_lib($circ->circ_lib) if($desk_renewal_use_circ_lib);
3708 # Run the fine generator against the old circ
3709 # XXX This seems unnecessary, given that handle_fines runs in do_checkin
3710 # a few lines down. Commenting out, for now.
3711 #$self->handle_fines;
3713 $self->run_renew_permit;
3716 $self->do_checkin();
3717 return if $self->bail_out;
3719 unless( $self->permit_override ) {
3721 return if $self->bail_out;
3722 $self->is_precat(1) if $self->have_event('ITEM_NOT_CATALOGED');
3723 $self->remove_event('ITEM_NOT_CATALOGED');
3726 $self->override_events;
3727 return if $self->bail_out;
3730 $self->do_checkout();
3735 my( $self, $evt ) = @_;
3736 $evt = (ref $evt) ? $evt->{textcode} : $evt;
3737 $logger->debug("circulator: removing event from list: $evt");
3738 my @events = @{$self->events};
3739 $self->events( [ grep { $_->{textcode} ne $evt } @events ] );
3744 my( $self, $evt ) = @_;
3745 $evt = (ref $evt) ? $evt->{textcode} : $evt;
3746 return grep { $_->{textcode} eq $evt } @{$self->events};
3750 sub run_renew_permit {
3753 if ($U->ou_ancestor_setting_value($self->circ_lib, 'circ.block_renews_for_holds')) {
3754 my ($hold, undef, $retarget) = $holdcode->find_nearest_permitted_hold(
3755 $self->editor, $self->copy, $self->editor->requestor, 1
3757 $self->push_events(new OpenILS::Event("COPY_NEEDED_FOR_HOLD")) if $hold;
3760 my $results = $self->run_indb_circ_test;
3761 $self->push_events($self->matrix_test_result_events)
3762 unless $self->circ_test_success;
3766 # XXX: The primary mechanism for storing circ history is now handled
3767 # by tracking real circulation objects instead of bibs in a bucket.
3768 # However, this code is disabled by default and could be useful
3769 # some day, so may as well leave it for now.
3770 sub append_reading_list {
3774 $self->is_checkout and
3780 # verify history is globally enabled and uses the bucket mechanism
3781 my $htype = OpenSRF::Utils::SettingsClient->new->config_value(
3782 apps => 'open-ils.circ' => app_settings => 'checkout_history_mechanism');
3784 return undef unless $htype and $htype eq 'bucket';
3786 my $e = new_editor(xact => 1, requestor => $self->editor->requestor);
3788 # verify the patron wants to retain the hisory
3789 my $setting = $e->search_actor_user_setting(
3790 {usr => $self->patron->id, name => 'circ.keep_checkout_history'})->[0];
3792 unless($setting and $setting->value) {
3797 my $bkt = $e->search_container_copy_bucket(
3798 {owner => $self->patron->id, btype => 'circ_history'})->[0];
3803 # find the next item position
3804 my $last_item = $e->search_container_copy_bucket_item(
3805 {bucket => $bkt->id}, {order_by => {ccbi => 'pos desc'}, limit => 1})->[0];
3806 $pos = $last_item->pos + 1 if $last_item;
3809 # create the history bucket if necessary
3810 $bkt = Fieldmapper::container::copy_bucket->new;
3811 $bkt->owner($self->patron->id);
3813 $bkt->btype('circ_history');
3815 $e->create_container_copy_bucket($bkt) or return $e->die_event;
3818 my $item = Fieldmapper::container::copy_bucket_item->new;
3820 $item->bucket($bkt->id);
3821 $item->target_copy($self->copy->id);
3824 $e->create_container_copy_bucket_item($item) or return $e->die_event;
3831 sub make_trigger_events {
3833 return unless $self->circ;
3834 $U->create_events_for_hook('checkout', $self->circ, $self->circ_lib) if $self->is_checkout;
3835 $U->create_events_for_hook('checkin', $self->circ, $self->circ_lib) if $self->is_checkin;
3836 $U->create_events_for_hook('renewal', $self->circ, $self->circ_lib) if $self->is_renewal;
3841 sub checkin_handle_lost_or_lo_now_found {
3842 my ($self, $bill_type, $is_longoverdue) = @_;
3844 my $tag = $is_longoverdue ? "LONGOVERDUE" : "LOST";
3846 $logger->debug("voiding $tag item billings");
3847 my $result = $CC->void_or_zero_bills_of_type($self->editor, $self->circ, $self->copy, $bill_type, "$tag ITEM RETURNED");
3848 $self->bail_on_events($self->editor->event) if ($result);
3851 sub checkin_handle_lost_or_lo_now_found_restore_od {
3853 my $circ_lib = shift;
3854 my $is_longoverdue = shift;
3855 my $tag = $is_longoverdue ? "LONGOVERDUE" : "LOST";
3857 # ------------------------------------------------------------------
3858 # restore those overdue charges voided when item was set to lost
3859 # ------------------------------------------------------------------
3861 my $ods = $self->editor->search_money_billing([
3863 xact => $self->circ->id,
3867 order_by => {mb => 'billing_ts desc'}
3871 $logger->debug("returning ".scalar(@$ods)." overdue charges pre-$tag");
3872 # Because actual users get up to all kinds of unexpectedness, we
3873 # only recreate up to $circ->max_fine in bills. I know you think
3874 # it wouldn't happen that bills could get created, voided, and
3875 # recreated more than once, but I guaran-damn-tee you that it will
3877 if ($ods && @$ods) {
3878 my $void_amount = 0;
3879 my $void_max = $self->circ->max_fine();
3880 # search for overdues voided the new way (aka "adjusted")
3881 my @billings = map {$_->id()} @$ods;
3882 my $voids = $self->editor->search_money_account_adjustment(
3884 billing => \@billings
3888 map {$void_amount += $_->amount()} @$voids;
3890 # if no adjustments found, assume they were voided the old way (aka "voided")
3891 for my $bill (@$ods) {
3892 if( $U->is_true($bill->voided) ) {
3893 $void_amount += $bill->amount();
3899 ($void_amount < $void_max ? $void_amount : $void_max),
3901 $ods->[0]->billing_type(),
3903 "System: $tag RETURNED - OVERDUES REINSTATED",
3904 $ods->[0]->billing_ts() # date this restoration the same as the last overdue (for possible subsequent fine generation)