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 $ses = create OpenSRF::AppSession("router");
22 $booking_status = grep {$_ eq "open-ils.booking"} @{
23 $ses->request("opensrf.router.info.class.list")->gather(1)
26 $logger->info("booking status: " . ($booking_status ? "on" : "off"));
29 return $booking_status;
35 flesh_fields => {acp => ['call_number','parts','floating'], acn => ['record']}
38 # table of cases where suppressing a system-generated copy alerts
39 # should generate an override of an old-style event
40 my %COPY_ALERT_OVERRIDES = (
41 "CLAIMSRETURNED\tCHECKOUT" => ['CIRC_CLAIMS_RETURNED'],
42 "CLAIMSRETURNED\tCHECKIN" => ['CIRC_CLAIMS_RETURNED'],
43 "LOST\tCHECKOUT" => ['OPEN_CIRCULATION_EXISTS'],
44 "LONGOVERDUE\tCHECKOUT" => ['OPEN_CIRCULATION_EXISTS'],
45 "MISSING\tCHECKOUT" => ['COPY_NOT_AVAILABLE'],
46 "DAMAGED\tCHECKOUT" => ['COPY_NOT_AVAILABLE'],
47 "LOST_AND_PAID\tCHECKOUT" => ['COPY_NOT_AVAILABLE', 'OPEN_CIRCULATION_EXISTS']
52 __PACKAGE__->register_method(
53 method => "run_method",
54 api_name => "open-ils.circ.checkout.permit",
56 Determines if the given checkout can occur
57 @param authtoken The login session key
58 @param params A trailing hash of named params including
59 barcode : The copy barcode,
60 patron : The patron the checkout is occurring for,
61 renew : true or false - whether or not this is a renewal
62 @return The event that occurred during the permit check.
66 __PACKAGE__->register_method (
67 method => 'run_method',
68 api_name => 'open-ils.circ.checkout.permit.override',
69 signature => q/@see open-ils.circ.checkout.permit/,
73 __PACKAGE__->register_method(
74 method => "run_method",
75 api_name => "open-ils.circ.checkout",
78 @param authtoken The login session key
79 @param params A named hash of params including:
81 barcode If no copy is provided, the copy is retrieved via barcode
82 copyid If no copy or barcode is provide, the copy id will be use
83 patron The patron's id
84 noncat True if this is a circulation for a non-cataloted item
85 noncat_type The non-cataloged type id
86 noncat_circ_lib The location for the noncat circ.
87 precat The item has yet to be cataloged
88 dummy_title The temporary title of the pre-cataloded item
89 dummy_author The temporary authr of the pre-cataloded item
90 Default is the home org of the staff member
91 @return The SUCCESS event on success, any other event depending on the error
94 __PACKAGE__->register_method(
95 method => "run_method",
96 api_name => "open-ils.circ.checkin",
99 Generic super-method for handling all copies
100 @param authtoken The login session key
101 @param params Hash of named parameters including:
102 barcode - The copy barcode
103 force - If true, copies in bad statuses will be checked in and give good statuses
104 noop - don't capture holds or put items into transit
105 void_overdues - void all overdues for the circulation (aka amnesty)
110 __PACKAGE__->register_method(
111 method => "run_method",
112 api_name => "open-ils.circ.checkin.override",
113 signature => q/@see open-ils.circ.checkin/
116 __PACKAGE__->register_method(
117 method => "run_method",
118 api_name => "open-ils.circ.renew.override",
119 signature => q/@see open-ils.circ.renew/,
122 __PACKAGE__->register_method(
123 method => "run_method",
124 api_name => "open-ils.circ.renew",
125 notes => <<" NOTES");
126 PARAMS( authtoken, circ => circ_id );
127 open-ils.circ.renew(login_session, circ_object);
128 Renews the provided circulation. login_session is the requestor of the
129 renewal and if the logged in user is not the same as circ->usr, then
130 the logged in user must have RENEW_CIRC permissions.
133 __PACKAGE__->register_method(
134 method => "run_method",
135 api_name => "open-ils.circ.checkout.full"
137 __PACKAGE__->register_method(
138 method => "run_method",
139 api_name => "open-ils.circ.checkout.full.override"
141 __PACKAGE__->register_method(
142 method => "run_method",
143 api_name => "open-ils.circ.reservation.pickup"
145 __PACKAGE__->register_method(
146 method => "run_method",
147 api_name => "open-ils.circ.reservation.return"
149 __PACKAGE__->register_method(
150 method => "run_method",
151 api_name => "open-ils.circ.reservation.return.override"
153 __PACKAGE__->register_method(
154 method => "run_method",
155 api_name => "open-ils.circ.checkout.inspect",
156 desc => q/Returns the circ matrix test result and, on success, the rule set and matrix test object/
161 my( $self, $conn, $auth, $args ) = @_;
162 translate_legacy_args($args);
163 $args->{override_args} = { all => 1 } unless defined $args->{override_args};
164 $args->{new_copy_alerts} ||= $self->api_level > 1 ? 1 : 0;
165 my $api = $self->api_name;
168 OpenILS::Application::Circ::Circulator->new($auth, %$args);
170 return circ_events($circulator) if $circulator->bail_out;
172 $circulator->use_booking(determine_booking_status());
174 # --------------------------------------------------------------------------
175 # First, check for a booking transit, as the barcode may not be a copy
176 # barcode, but a resource barcode, and nothing else in here will work
177 # --------------------------------------------------------------------------
179 if ($circulator->use_booking && (my $bc = $circulator->copy_barcode) && $api !~ /checkout|inspect/) { # do we have a barcode?
180 my $resources = $circulator->editor->search_booking_resource( { barcode => $bc } ); # any resources by this barcode?
181 if (@$resources) { # yes!
183 my $res_id_list = [ map { $_->id } @$resources ];
184 my $transit = $circulator->editor->search_action_reservation_transit_copy(
186 { target_copy => $res_id_list, dest => $circulator->circ_lib, dest_recv_time => undef, cancel_time => undef },
187 { order_by => { artc => 'source_send_time' }, limit => 1 }
189 )->[0]; # Any transit for this barcode?
191 if ($transit) { # yes! unwrap it.
193 my $reservation = $circulator->editor->retrieve_booking_reservation( $transit->reservation );
194 my $res_type = $circulator->editor->retrieve_booking_resource_type( $reservation->target_resource_type );
196 my $success_event = new OpenILS::Event(
197 "SUCCESS", "payload" => {"reservation" => $reservation}
199 if ($U->is_true($res_type->catalog_item)) { # is there a copy to be had here?
200 if (my $copy = $circulator->editor->search_asset_copy([
201 { barcode => $bc, deleted => 'f' }, $MK_ENV_FLESH
202 ])->[0]) { # got a copy
203 $copy->status( $transit->copy_status );
204 $copy->editor($circulator->editor->requestor->id);
205 $copy->edit_date('now');
206 $circulator->editor->update_asset_copy($copy);
207 $success_event->{"payload"}->{"record"} =
208 $U->record_to_mvr($copy->call_number->record);
209 $success_event->{"payload"}->{"volume"} = $copy->call_number;
210 $copy->call_number($copy->call_number->id);
211 $success_event->{"payload"}->{"copy"} = $copy;
215 $transit->dest_recv_time('now');
216 $circulator->editor->update_action_reservation_transit_copy( $transit );
218 $circulator->editor->commit;
219 # Formerly this branch just stopped here. Argh!
220 $conn->respond_complete($success_event);
226 if ($circulator->use_booking) {
227 $circulator->is_res_checkin($circulator->is_checkin(1))
228 if $api =~ /reservation.return/ or (
229 $api =~ /checkin/ and $circulator->seems_like_reservation()
232 $circulator->is_res_checkout(1) if $api =~ /reservation.pickup/;
235 $circulator->is_renewal(1) if $api =~ /renew/;
236 $circulator->is_checkin(1) if $api =~ /checkin/;
237 $circulator->is_checkout(1) if $api =~ /checkout/;
238 $circulator->override(1) if $api =~ /override/o;
240 $circulator->mk_env();
241 $circulator->noop(1) if $circulator->claims_never_checked_out;
243 return circ_events($circulator) if $circulator->bail_out;
245 if( $api =~ /checkout\.permit/ ) {
246 $circulator->do_permit();
248 } elsif( $api =~ /checkout.full/ ) {
250 # requesting a precat checkout implies that any required
251 # overrides have been performed. Go ahead and re-override.
252 $circulator->skip_permit_key(1);
253 $circulator->override(1) if ( $circulator->request_precat && $circulator->editor->allowed('CREATE_PRECAT') );
254 $circulator->do_permit();
255 $circulator->is_checkout(1);
256 unless( $circulator->bail_out ) {
257 $circulator->events([]);
258 $circulator->do_checkout();
261 } elsif( $circulator->is_res_checkout ) {
262 $circulator->do_reservation_pickup();
264 } elsif( $api =~ /inspect/ ) {
265 my $data = $circulator->do_inspect();
266 $circulator->editor->rollback;
269 } elsif( $api =~ /checkout/ ) {
270 $circulator->do_checkout();
272 } elsif( $circulator->is_res_checkin ) {
273 $circulator->do_reservation_return();
274 $circulator->do_checkin() if ($circulator->copy());
275 } elsif( $api =~ /checkin/ ) {
276 $circulator->do_checkin();
278 } elsif( $api =~ /renew/ ) {
279 $circulator->do_renew($api);
282 if( $circulator->bail_out ) {
285 # make sure no success event accidentally slip in
287 [ grep { $_->{textcode} ne 'SUCCESS' } @{$circulator->events} ]);
290 my @e = @{$circulator->events};
291 push( @ee, $_->{textcode} ) for @e;
292 $logger->info("circulator: bailing out with events: " . (join ", ", @ee));
294 $circulator->editor->rollback;
298 # checkin and reservation return can result in modifications to
299 # actor.usr.claims_never_checked_out_count without also modifying
300 # actor.last_xact_id. Perform a no-op update on the patron to
301 # force an update to last_xact_id.
302 if ($circulator->claims_never_checked_out && $circulator->patron) {
303 $circulator->editor->update_actor_user(
304 $circulator->editor->retrieve_actor_user($circulator->patron->id))
305 or return $circulator->editor->die_event;
308 $circulator->editor->commit;
311 $conn->respond_complete(circ_events($circulator));
313 return undef if $circulator->bail_out;
315 $circulator->do_hold_notify($circulator->notify_hold)
316 if $circulator->notify_hold;
317 $circulator->retarget_holds if $circulator->retarget;
318 $circulator->append_reading_list;
319 $circulator->make_trigger_events;
326 my @e = @{$circ->events};
327 # if we have multiple events, SUCCESS should not be one of them;
328 @e = grep { $_->{textcode} ne 'SUCCESS' } @e if @e > 1;
329 return (@e == 1) ? $e[0] : \@e;
333 sub translate_legacy_args {
336 if( $$args{barcode} ) {
337 $$args{copy_barcode} = $$args{barcode};
338 delete $$args{barcode};
341 if( $$args{copyid} ) {
342 $$args{copy_id} = $$args{copyid};
343 delete $$args{copyid};
346 if( $$args{patronid} ) {
347 $$args{patron_id} = $$args{patronid};
348 delete $$args{patronid};
351 if( $$args{patron} and !ref($$args{patron}) ) {
352 $$args{patron_id} = $$args{patron};
353 delete $$args{patron};
357 if( $$args{noncat} ) {
358 $$args{is_noncat} = $$args{noncat};
359 delete $$args{noncat};
362 if( $$args{precat} ) {
363 $$args{is_precat} = $$args{request_precat} = $$args{precat};
364 delete $$args{precat};
370 # --------------------------------------------------------------------------
371 # This package actually manages all of the circulation logic
372 # --------------------------------------------------------------------------
373 package OpenILS::Application::Circ::Circulator;
374 use strict; use warnings;
375 use vars q/$AUTOLOAD/;
377 use OpenILS::Utils::Fieldmapper;
378 use OpenSRF::Utils::Cache;
379 use Digest::MD5 qw(md5_hex);
380 use DateTime::Format::ISO8601;
381 use OpenILS::Utils::PermitHold;
382 use OpenILS::Utils::DateTime qw/:datetime/;
383 use OpenSRF::Utils::SettingsClient;
384 use OpenILS::Application::Circ::Holds;
385 use OpenILS::Application::Circ::Transit;
386 use OpenSRF::Utils::Logger qw(:logger);
387 use OpenILS::Utils::CStoreEditor qw/:funcs/;
388 use OpenILS::Const qw/:const/;
389 use OpenILS::Utils::Penalty;
390 use OpenILS::Application::Circ::CircCommon;
393 my $CC = "OpenILS::Application::Circ::CircCommon";
394 my $holdcode = "OpenILS::Application::Circ::Holds";
395 my $transcode = "OpenILS::Application::Circ::Transit";
401 # --------------------------------------------------------------------------
402 # Add a pile of automagic getter/setter methods
403 # --------------------------------------------------------------------------
404 my @AUTOLOAD_FIELDS = qw/
416 overrides_per_copy_alerts
457 recurring_fines_level
462 auto_renewal_remaining
471 cancelled_hold_transit
479 circ_matrix_matchpoint
490 claims_never_checked_out
503 dont_change_lost_zero
505 needs_lost_bill_handling
511 my $type = ref($self) or die "$self is not an object";
513 my $name = $AUTOLOAD;
516 unless (grep { $_ eq $name } @AUTOLOAD_FIELDS) {
517 $logger->error("circulator: $type: invalid autoload field: $name");
518 die "$type: invalid autoload field: $name\n"
523 *{"${type}::${name}"} = sub {
526 $s->{$name} = $v if defined $v;
530 return $self->$name($data);
535 my( $class, $auth, %args ) = @_;
536 $class = ref($class) || $class;
537 my $self = bless( {}, $class );
540 $self->editor(new_editor(xact => 1, authtoken => $auth));
542 unless( $self->editor->checkauth ) {
543 $self->bail_on_events($self->editor->event);
547 $self->cache_handle(OpenSRF::Utils::Cache->new('global'));
549 $self->$_($args{$_}) for keys %args;
552 ($self->circ_lib) ? $self->circ_lib : $self->editor->requestor->ws_ou);
554 # if this is a renewal, default to desk_renewal
555 $self->desk_renewal(1) unless
556 $self->opac_renewal or $self->phone_renewal or $self->sip_renewal
557 or $self->auto_renewal;
559 $self->capture('') unless $self->capture;
561 unless(%user_groups) {
562 my $gps = $self->editor->retrieve_all_permission_grp_tree;
563 %user_groups = map { $_->id => $_ } @$gps;
570 # --------------------------------------------------------------------------
571 # True if we should discontinue processing
572 # --------------------------------------------------------------------------
574 my( $self, $bool ) = @_;
575 if( defined $bool ) {
576 $logger->info("circulator: BAILING OUT") if $bool;
577 $self->{bail_out} = $bool;
579 return $self->{bail_out};
584 my( $self, @evts ) = @_;
587 $e->{payload} = $self->copy if
588 ($e->{textcode} eq 'COPY_NOT_AVAILABLE');
590 $logger->info("circulator: pushing event ".$e->{textcode});
591 push( @{$self->events}, $e ) unless
592 grep { $_->{textcode} eq $e->{textcode} } @{$self->events};
598 return '' if $self->skip_permit_key;
599 my $key = md5_hex( time() . rand() . "$$" );
600 $self->cache_handle->put_cache( "oils_permit_key_$key", 1, 300 );
601 return $self->permit_key($key);
604 sub check_permit_key {
606 return 1 if $self->skip_permit_key;
607 my $key = $self->permit_key;
608 return 0 unless $key;
609 my $k = "oils_permit_key_$key";
610 my $one = $self->cache_handle->get_cache($k);
611 $self->cache_handle->delete_cache($k);
612 return ($one) ? 1 : 0;
615 sub seems_like_reservation {
618 # Some words about the following method:
619 # 1) It requires the VIEW_USER permission, but that's not an
620 # issue, right, since all staff should have that?
621 # 2) It returns only one reservation at a time, even if an item can be
622 # and is currently overbooked. Hmmm....
623 my $booking_ses = create OpenSRF::AppSession("open-ils.booking");
624 my $result = $booking_ses->request(
625 "open-ils.booking.reservations.by_returnable_resource_barcode",
626 $self->editor->authtoken,
629 $booking_ses->disconnect;
631 return $self->bail_on_events($result) if defined $U->event_code($result);
634 $self->reservation(shift @$result);
642 # save_trimmed_copy() used just to be a block in mk_env(), but was separated for re-use
643 sub save_trimmed_copy {
644 my ($self, $copy) = @_;
647 $self->volume($copy->call_number);
648 $self->title($self->volume->record);
649 $self->copy->call_number($self->volume->id);
650 $self->volume->record($self->title->id);
651 $self->is_precat(1) if $self->volume->id == OILS_PRECAT_CALL_NUMBER;
652 if($self->copy->deposit_amount and $self->copy->deposit_amount > 0) {
653 $self->is_deposit(1) if $U->is_true($self->copy->deposit);
654 $self->is_rental(1) unless $U->is_true($self->copy->deposit);
658 sub collect_user_copy_alerts {
660 my $e = $self->editor;
663 my $alerts = $e->search_asset_copy_alert([
664 {copy => $self->copy->id, ack_time => undef},
665 {flesh => 1, flesh_fields => { aca => [ qw/ alert_type / ] }}
667 if (ref $alerts eq "ARRAY") {
668 $logger->info("circulator: found " . scalar(@$alerts) . " alerts for copy " .
670 $self->user_copy_alerts($alerts);
675 sub filter_user_copy_alerts {
678 my $e = $self->editor;
680 if(my $alerts = $self->user_copy_alerts) {
682 my $suppress_orgs = $U->get_org_full_path($self->circ_lib);
683 my $suppressions = $e->search_actor_copy_alert_suppress(
684 {org => $suppress_orgs}
688 foreach my $a (@$alerts) {
689 # filter on event type
690 if (defined $a->alert_type) {
691 next if ($a->alert_type->event eq 'CHECKIN' && !$self->is_checkin && !$self->is_renewal);
692 next if ($a->alert_type->event eq 'CHECKOUT' && !$self->is_checkout && !$self->is_renewal);
693 next if (defined $a->alert_type->in_renew && $U->is_true($a->alert_type->in_renew) && !$self->is_renewal);
694 next if (defined $a->alert_type->in_renew && !$U->is_true($a->alert_type->in_renew) && $self->is_renewal);
697 # filter on suppression
698 next if (grep { $a->alert_type->id == $_->alert_type} @$suppressions);
700 # filter on "only at circ lib"
701 if (defined $a->alert_type->at_circ) {
702 my $copy_circ_lib = (ref $self->copy->circ_lib) ?
703 $self->copy->circ_lib->id : $self->copy->circ_lib;
704 my $orgs = $U->get_org_descendants($copy_circ_lib);
706 if ($U->is_true($a->alert_type->invert_location)) {
707 next if (grep {$_ == $self->circ_lib} @$orgs);
709 next unless (grep {$_ == $self->circ_lib} @$orgs);
713 # filter on "only at owning lib"
714 if (defined $a->alert_type->at_owning) {
715 my $copy_owning_lib = (ref $self->volume->owning_lib) ?
716 $self->volume->owning_lib->id : $self->volume->owning_lib;
717 my $orgs = $U->get_org_descendants($copy_owning_lib);
719 if ($U->is_true($a->alert_type->invert_location)) {
720 next if (grep {$_ == $self->circ_lib} @$orgs);
722 next unless (grep {$_ == $self->circ_lib} @$orgs);
726 $a->alert_type->next_status([$U->unique_unnested_numbers($a->alert_type->next_status)]);
728 push @final_alerts, $a;
731 $self->user_copy_alerts(\@final_alerts);
735 sub generate_system_copy_alerts {
737 return unless($self->copy);
739 # don't create system copy alerts if the copy
740 # is in a normal state; we're assuming that there's
741 # never a need to generate a popup for each and every
742 # checkin or checkout of normal items. If this assumption
743 # proves false, then we'll need to add a way to explicitly specify
744 # that a copy alert type should never generate a system copy alert
745 return if $self->copy_state eq 'NORMAL';
747 my $e = $self->editor;
749 my $suppress_orgs = $U->get_org_full_path($self->circ_lib);
750 my $suppressions = $e->search_actor_copy_alert_suppress(
751 {org => $suppress_orgs}
754 # events we care about ...
756 push(@$event, 'CHECKIN') if $self->is_checkin;
757 push(@$event, 'CHECKOUT') if $self->is_checkout;
758 return unless scalar(@$event);
760 my $alert_orgs = $U->get_org_ancestors($self->circ_lib);
761 my $alert_types = $e->search_config_copy_alert_type({
763 scope_org => $alert_orgs,
765 state => $self->copy_state,
766 '-or' => [ { in_renew => $self->is_renewal }, { in_renew => undef } ],
770 foreach my $a (@$alert_types) {
771 # filter on "only at circ lib"
772 if (defined $a->at_circ) {
773 my $copy_circ_lib = (ref $self->copy->circ_lib) ?
774 $self->copy->circ_lib->id : $self->copy->circ_lib;
775 my $orgs = $U->get_org_descendants($copy_circ_lib);
777 if ($U->is_true($a->invert_location)) {
778 next if (grep {$_ == $self->circ_lib} @$orgs);
780 next unless (grep {$_ == $self->circ_lib} @$orgs);
784 # filter on "only at owning lib"
785 if (defined $a->at_owning) {
786 my $copy_owning_lib = (ref $self->volume->owning_lib) ?
787 $self->volume->owning_lib->id : $self->volume->owning_lib;
788 my $orgs = $U->get_org_descendants($copy_owning_lib);
790 if ($U->is_true($a->invert_location)) {
791 next if (grep {$_ == $self->circ_lib} @$orgs);
793 next unless (grep {$_ == $self->circ_lib} @$orgs);
797 push @final_types, $a;
801 $logger->info("circulator: found " . scalar(@final_types) . " system alert types for copy" .
807 # keep track of conditions corresponding to suppressed
808 # system alerts, as these may be used to overridee
809 # certain old-style-events
810 my %auto_override_conditions = ();
811 foreach my $t (@final_types) {
812 if ($t->next_status) {
813 if (grep { $t->id == $_->alert_type } @$suppressions) {
816 $t->next_status([$U->unique_unnested_numbers($t->next_status)]);
820 my $alert = new Fieldmapper::asset::copy_alert ();
821 $alert->alert_type($t->id);
822 $alert->copy($self->copy->id);
824 $alert->create_staff($e->requestor->id);
825 $alert->create_time('now');
826 $alert->ack_staff($e->requestor->id);
827 $alert->ack_time('now');
829 $alert = $e->create_asset_copy_alert($alert);
833 $alert->alert_type($t->clone);
835 push(@{$self->next_copy_status}, @{$t->next_status}) if ($t->next_status);
836 if (grep {$_->alert_type == $t->id} @$suppressions) {
837 $auto_override_conditions{join("\t", $t->state, $t->event)} = 1;
839 push(@alerts, $alert) unless (grep {$_->alert_type == $t->id} @$suppressions);
842 $self->system_copy_alerts(\@alerts);
843 $self->overrides_per_copy_alerts(\%auto_override_conditions);
846 sub add_overrides_from_system_copy_alerts {
848 my $e = $self->editor;
850 foreach my $condition (keys %{$self->overrides_per_copy_alerts()}) {
851 if (exists $COPY_ALERT_OVERRIDES{$condition}) {
853 push @{$self->override_args->{events}}, @{ $COPY_ALERT_OVERRIDES{$condition} };
854 # special handling for long-overdue and lost checkouts
855 if (grep { $_ eq 'OPEN_CIRCULATION_EXISTS' } @{ $COPY_ALERT_OVERRIDES{$condition} }) {
856 my $state = (split /\t/, $condition, -1)[0];
858 if ($state eq 'LOST' or $state eq 'LOST_AND_PAID') {
859 $setting = 'circ.copy_alerts.forgive_fines_on_lost_checkin';
860 } elsif ($state eq 'LONGOVERDUE') {
861 $setting = 'circ.copy_alerts.forgive_fines_on_long_overdue_checkin';
865 my $forgive = $U->ou_ancestor_setting_value(
866 $self->circ_lib, $setting, $e
868 if ($U->is_true($forgive)) {
869 $self->void_overdues(1);
871 $self->noop(1); # do not attempt transits, just check it in
880 my $e = $self->editor;
882 $self->next_copy_status([]) unless (defined $self->next_copy_status);
883 $self->overrides_per_copy_alerts({}) unless (defined $self->overrides_per_copy_alerts);
885 # --------------------------------------------------------------------------
886 # Grab the fleshed copy
887 # --------------------------------------------------------------------------
888 unless($self->is_noncat) {
891 $copy = $e->retrieve_asset_copy(
892 [$self->copy_id, $MK_ENV_FLESH ]) or return $e->event;
894 } elsif( $self->copy_barcode ) {
896 $copy = $e->search_asset_copy(
897 [{barcode => $self->copy_barcode, deleted => 'f'}, $MK_ENV_FLESH ])->[0];
898 } elsif( $self->reservation ) {
899 my $res = $e->json_query(
901 "select" => {"acp" => ["id"]},
906 "field" => "barcode",
910 "field" => "current_resource"
919 "id" => (ref $self->reservation) ?
920 $self->reservation->id : $self->reservation
925 if (ref $res eq "ARRAY" and scalar @$res) {
926 $logger->info("circulator: mapped reservation " .
927 $self->reservation . " to copy " . $res->[0]->{"id"});
928 $copy = $e->retrieve_asset_copy([$res->[0]->{"id"}, $MK_ENV_FLESH]);
933 $self->save_trimmed_copy($copy);
938 {from => ['asset.copy_state', $copy->id]}
939 )->[0]{'asset.copy_state'}
942 $self->generate_system_copy_alerts;
943 $self->add_overrides_from_system_copy_alerts;
944 $self->collect_user_copy_alerts;
945 $self->filter_user_copy_alerts;
948 # We can't renew if there is no copy
949 return $self->bail_on_events(OpenILS::Event->new('ASSET_COPY_NOT_FOUND'))
950 if $self->is_renewal;
955 # --------------------------------------------------------------------------
957 # --------------------------------------------------------------------------
961 flesh_fields => {au => [ qw/ card / ]}
964 if( $self->patron_id ) {
965 $patron = $e->retrieve_actor_user([$self->patron_id, $flesh])
966 or return $self->bail_on_events(OpenILS::Event->new('ACTOR_USER_NOT_FOUND'));
968 } elsif( $self->patron_barcode ) {
970 # note: throwing ACTOR_USER_NOT_FOUND instead of ACTOR_CARD_NOT_FOUND is intentional
971 my $card = $e->search_actor_card({barcode => $self->patron_barcode})->[0]
972 or return $self->bail_on_events(OpenILS::Event->new('ACTOR_USER_NOT_FOUND'));
974 $patron = $e->retrieve_actor_user($card->usr)
975 or return $self->bail_on_events(OpenILS::Event->new('ACTOR_USER_NOT_FOUND'));
977 # Use the card we looked up, not the patron's primary, for card active checks
978 $patron->card($card);
981 if( my $copy = $self->copy ) {
984 $flesh->{flesh_fields}->{circ} = ['usr'];
986 my $circ = $e->search_action_circulation([
987 {target_copy => $copy->id, checkin_time => undef}, $flesh
991 $patron = $circ->usr;
992 $circ->usr($patron->id); # de-flesh for consistency
998 return $self->bail_on_events(OpenILS::Event->new('ACTOR_USER_NOT_FOUND'))
999 unless $self->patron($patron) or $self->is_checkin;
1001 unless($self->is_checkin) {
1003 # Check for inactivity and patron reg. expiration
1005 $self->bail_on_events(OpenILS::Event->new('PATRON_INACTIVE'))
1006 unless $U->is_true($patron->active);
1008 $self->bail_on_events(OpenILS::Event->new('PATRON_CARD_INACTIVE'))
1009 unless $U->is_true($patron->card->active);
1011 # Expired patrons cannot check out. Renewals for expired
1012 # patrons depend on a setting and will be checked in the
1013 # do_renew subroutine.
1014 if ($self->is_checkout) {
1015 my $expire = DateTime::Format::ISO8601->new->parse_datetime(
1016 clean_ISO8601($patron->expire_date));
1018 if (CORE::time > $expire->epoch) {
1019 $self->bail_on_events(OpenILS::Event->new('PATRON_ACCOUNT_EXPIRED'))
1026 # --------------------------------------------------------------------------
1027 # Does the circ permit work
1028 # --------------------------------------------------------------------------
1032 $self->log_me("do_permit()");
1034 unless( $self->editor->requestor->id == $self->patron->id ) {
1035 return $self->bail_on_events($self->editor->event)
1036 unless( $self->editor->allowed('VIEW_PERMIT_CHECKOUT') );
1039 $self->check_captured_holds();
1040 $self->do_copy_checks();
1041 return if $self->bail_out;
1042 $self->run_patron_permit_scripts();
1043 $self->run_copy_permit_scripts()
1044 unless $self->is_precat or $self->is_noncat;
1045 $self->check_item_deposit_events();
1046 $self->override_events();
1047 return if $self->bail_out;
1049 if($self->is_precat and not $self->request_precat) {
1051 OpenILS::Event->new(
1052 'ITEM_NOT_CATALOGED', payload => $self->mk_permit_key));
1053 return $self->bail_out(1) unless $self->is_renewal;
1057 OpenILS::Event->new('SUCCESS', payload => $self->mk_permit_key));
1060 sub check_item_deposit_events {
1062 $self->push_events(OpenILS::Event->new('ITEM_DEPOSIT_REQUIRED', payload => $self->copy))
1063 if $self->is_deposit and not $self->is_deposit_exempt;
1064 $self->push_events(OpenILS::Event->new('ITEM_RENTAL_FEE_REQUIRED', payload => $self->copy))
1065 if $self->is_rental and not $self->is_rental_exempt;
1068 # returns true if the user is not required to pay deposits
1069 sub is_deposit_exempt {
1071 my $pid = (ref $self->patron->profile) ?
1072 $self->patron->profile->id : $self->patron->profile;
1073 my $groups = $U->ou_ancestor_setting_value(
1074 $self->circ_lib, 'circ.deposit.exempt_groups', $self->editor);
1075 for my $grp (@$groups) {
1076 return 1 if $self->is_group_descendant($grp, $pid);
1081 # returns true if the user is not required to pay rental fees
1082 sub is_rental_exempt {
1084 my $pid = (ref $self->patron->profile) ?
1085 $self->patron->profile->id : $self->patron->profile;
1086 my $groups = $U->ou_ancestor_setting_value(
1087 $self->circ_lib, 'circ.rental.exempt_groups', $self->editor);
1088 for my $grp (@$groups) {
1089 return 1 if $self->is_group_descendant($grp, $pid);
1094 sub is_group_descendant {
1095 my($self, $p_id, $c_id) = @_;
1096 return 0 unless defined $p_id and defined $c_id;
1097 return 1 if $c_id == $p_id;
1098 while(my $grp = $user_groups{$c_id}) {
1099 $c_id = $grp->parent;
1100 return 0 unless defined $c_id;
1101 return 1 if $c_id == $p_id;
1106 sub check_captured_holds {
1108 my $copy = $self->copy;
1109 my $patron = $self->patron;
1111 return undef unless $copy;
1113 my $s = $U->copy_status($copy->status)->id;
1114 return unless $s == OILS_COPY_STATUS_ON_HOLDS_SHELF;
1115 $logger->info("circulator: copy is on holds shelf, searching for the correct hold");
1117 # Item is on the holds shelf, make sure it's going to the right person
1118 my $hold = $self->editor->search_action_hold_request(
1121 current_copy => $copy->id ,
1122 capture_time => { '!=' => undef },
1123 cancel_time => undef,
1124 fulfillment_time => undef
1128 flesh_fields => { ahr => ['usr'] }
1133 if ($hold and $hold->usr->id == $patron->id) {
1134 $self->checkout_is_for_hold(1);
1138 my $holdau = $hold->usr;
1141 $payload->{patron_name} = $holdau->first_given_name . ' ' . $holdau->family_name;
1142 $payload->{patron_id} = $holdau->id;
1144 $payload->{patron_name} = "???";
1146 $payload->{hold_id} = $hold->id;
1147 $self->push_events(OpenILS::Event->new('ITEM_ON_HOLDS_SHELF',
1148 payload => $payload));
1151 $logger->info("circulator: this copy is needed by a different patron to fulfill a hold");
1156 sub do_copy_checks {
1158 my $copy = $self->copy;
1159 return unless $copy;
1161 my $stat = $U->copy_status($copy->status)->id;
1163 # We cannot check out a copy if it is in-transit
1164 if( $stat == OILS_COPY_STATUS_IN_TRANSIT ) {
1165 return $self->bail_on_events(OpenILS::Event->new('COPY_IN_TRANSIT'));
1168 $self->handle_claims_returned();
1169 return if $self->bail_out;
1171 # no claims returned circ was found, check if there is any open circ
1172 unless( $self->is_renewal ) {
1174 my $circs = $self->editor->search_action_circulation(
1175 { target_copy => $copy->id, checkin_time => undef }
1178 if(my $old_circ = $circs->[0]) { # an open circ was found
1180 my $payload = {copy => $copy};
1182 if($old_circ->usr == $self->patron->id) {
1184 $payload->{old_circ} = $old_circ;
1186 # If there is an open circulation on the checkout item and an auto-renew
1187 # interval is defined, inform the caller that they should go
1188 # ahead and renew the item instead of warning about open circulations.
1190 my $auto_renew_intvl = $U->ou_ancestor_setting_value(
1192 'circ.checkout_auto_renew_age',
1196 if($auto_renew_intvl) {
1197 my $intvl_seconds = OpenILS::Utils::DateTime->interval_to_seconds($auto_renew_intvl);
1198 my $checkout_time = DateTime::Format::ISO8601->new->parse_datetime( clean_ISO8601($old_circ->xact_start) );
1200 if(DateTime->now > $checkout_time->add(seconds => $intvl_seconds)) {
1201 $payload->{auto_renew} = 1;
1206 return $self->bail_on_events(
1207 OpenILS::Event->new('OPEN_CIRCULATION_EXISTS', payload => $payload)
1213 my $LEGACY_CIRC_EVENT_MAP = {
1214 'no_item' => 'ITEM_NOT_CATALOGED',
1215 'actor.usr.barred' => 'PATRON_BARRED',
1216 'asset.copy.circulate' => 'COPY_CIRC_NOT_ALLOWED',
1217 'asset.copy.status' => 'COPY_NOT_AVAILABLE',
1218 'asset.copy_location.circulate' => 'COPY_CIRC_NOT_ALLOWED',
1219 'config.circ_matrix_test.circulate' => 'COPY_CIRC_NOT_ALLOWED',
1220 'config.circ_matrix_test.max_items_out' => 'PATRON_EXCEEDS_CHECKOUT_COUNT',
1221 'config.circ_matrix_test.max_overdue' => 'PATRON_EXCEEDS_OVERDUE_COUNT',
1222 'config.circ_matrix_test.max_fines' => 'PATRON_EXCEEDS_FINES',
1223 'config.circ_matrix_circ_mod_test' => 'PATRON_EXCEEDS_CHECKOUT_COUNT',
1224 'config.circ_matrix_test.total_copy_hold_ratio' =>
1225 'TOTAL_HOLD_COPY_RATIO_EXCEEDED',
1226 'config.circ_matrix_test.available_copy_hold_ratio' =>
1227 'AVAIL_HOLD_COPY_RATIO_EXCEEDED'
1231 # ---------------------------------------------------------------------
1232 # This pushes any patron-related events into the list but does not
1233 # set bail_out for any events
1234 # ---------------------------------------------------------------------
1235 sub run_patron_permit_scripts {
1237 my $patronid = $self->patron->id;
1242 my $results = $self->run_indb_circ_test;
1243 unless($self->circ_test_success) {
1244 my @trimmed_results;
1246 if ($self->is_noncat) {
1247 # no_item result is OK during noncat checkout
1248 @trimmed_results = grep { ($_->{fail_part} || '') ne 'no_item' } @$results;
1252 if ($self->checkout_is_for_hold) {
1253 # if this checkout will fulfill a hold, ignore CIRC blocks
1254 # and rely instead on the (later-checked) FULFILL block
1256 my @pen_names = grep {$_} map {$_->{fail_part}} @$results;
1257 my $fblock_pens = $self->editor->search_config_standing_penalty(
1258 {name => [@pen_names], block_list => {like => '%CIRC%'}});
1260 for my $res (@$results) {
1261 my $name = $res->{fail_part} || '';
1262 next if grep {$_->name eq $name} @$fblock_pens;
1263 push(@trimmed_results, $res);
1267 # not for hold or noncat
1268 @trimmed_results = @$results;
1272 # update the final set of test results
1273 $self->matrix_test_result(\@trimmed_results);
1275 push @allevents, $self->matrix_test_result_events;
1279 $_->{payload} = $self->copy if
1280 ($_->{textcode} eq 'COPY_NOT_AVAILABLE');
1283 $logger->info("circulator: permit_patron script returned events: @allevents") if @allevents;
1285 $self->push_events(@allevents);
1288 sub matrix_test_result_codes {
1290 map { $_->{"fail_part"} } @{$self->matrix_test_result};
1293 sub matrix_test_result_events {
1296 my $event = new OpenILS::Event(
1297 $LEGACY_CIRC_EVENT_MAP->{$_->{"fail_part"}} || $_->{"fail_part"}
1299 $event->{"payload"} = {"fail_part" => $_->{"fail_part"}};
1301 } (@{$self->matrix_test_result});
1304 sub run_indb_circ_test {
1306 return $self->matrix_test_result if $self->matrix_test_result;
1308 my $dbfunc = ($self->is_renewal) ?
1309 'action.item_user_renew_test' : 'action.item_user_circ_test';
1311 if( $self->is_precat && $self->request_precat) {
1312 $self->make_precat_copy;
1313 return if $self->bail_out;
1316 my $results = $self->editor->json_query(
1320 ($self->is_noncat or ($self->is_precat and !$self->override and !$self->is_renewal)) ? undef : $self->copy->id,
1326 $self->circ_test_success($U->is_true($results->[0]->{success}));
1328 if(my $mp = $results->[0]->{matchpoint}) {
1329 $logger->info("circulator: circ policy test found matchpoint built via rows " . $results->[0]->{buildrows});
1330 $self->circ_matrix_matchpoint($self->editor->retrieve_config_circ_matrix_matchpoint($mp));
1331 $self->circ_matrix_matchpoint->duration_rule($self->editor->retrieve_config_rules_circ_duration($results->[0]->{duration_rule}));
1332 if(defined($results->[0]->{renewals})) {
1333 $self->circ_matrix_matchpoint->duration_rule->max_renewals($results->[0]->{renewals});
1335 $self->circ_matrix_matchpoint->recurring_fine_rule($self->editor->retrieve_config_rules_recurring_fine($results->[0]->{recurring_fine_rule}));
1336 if(defined($results->[0]->{grace_period})) {
1337 $self->circ_matrix_matchpoint->recurring_fine_rule->grace_period($results->[0]->{grace_period});
1339 $self->circ_matrix_matchpoint->max_fine_rule($self->editor->retrieve_config_rules_max_fine($results->[0]->{max_fine_rule}));
1340 if(defined($results->[0]->{hard_due_date})) {
1341 $self->circ_matrix_matchpoint->hard_due_date($self->editor->retrieve_config_hard_due_date($results->[0]->{hard_due_date}));
1343 # Grab the *last* response for limit_groups, where it is more likely to be filled
1344 $self->limit_groups($results->[-1]->{limit_groups});
1347 return $self->matrix_test_result($results);
1350 # ---------------------------------------------------------------------
1351 # given a use and copy, this will calculate the circulation policy
1352 # parameters. Only works with in-db circ.
1353 # ---------------------------------------------------------------------
1357 return OpenILS::Event->new('ASSET_COPY_NOT_FOUND') unless $self->copy;
1359 $self->run_indb_circ_test;
1362 circ_test_success => $self->circ_test_success,
1363 failure_events => [],
1364 failure_codes => [],
1365 matchpoint => $self->circ_matrix_matchpoint
1368 unless($self->circ_test_success) {
1369 $results->{"failure_codes"} = [ $self->matrix_test_result_codes ];
1370 $results->{"failure_events"} = [ $self->matrix_test_result_events ];
1373 if($self->circ_matrix_matchpoint) {
1374 my $duration_rule = $self->circ_matrix_matchpoint->duration_rule;
1375 my $recurring_fine_rule = $self->circ_matrix_matchpoint->recurring_fine_rule;
1376 my $max_fine_rule = $self->circ_matrix_matchpoint->max_fine_rule;
1377 my $hard_due_date = $self->circ_matrix_matchpoint->hard_due_date;
1379 my $policy = $self->get_circ_policy(
1380 $duration_rule, $recurring_fine_rule, $max_fine_rule, $hard_due_date);
1382 $$results{$_} = $$policy{$_} for keys %$policy;
1388 # ---------------------------------------------------------------------
1389 # Loads the circ policy info for duration, recurring fine, and max
1390 # fine based on the current copy
1391 # ---------------------------------------------------------------------
1392 sub get_circ_policy {
1393 my($self, $duration_rule, $recurring_fine_rule, $max_fine_rule, $hard_due_date) = @_;
1396 duration_rule => $duration_rule->name,
1397 recurring_fine_rule => $recurring_fine_rule->name,
1398 max_fine_rule => $max_fine_rule->name,
1399 max_fine => $self->get_max_fine_amount($max_fine_rule),
1400 fine_interval => $recurring_fine_rule->recurrence_interval,
1401 renewal_remaining => $duration_rule->max_renewals,
1402 auto_renewal_remaining => $duration_rule->max_auto_renewals,
1403 grace_period => $recurring_fine_rule->grace_period
1406 if($hard_due_date) {
1407 $policy->{duration_date_ceiling} = $hard_due_date->ceiling_date;
1408 $policy->{duration_date_ceiling_force} = $hard_due_date->forceto;
1411 $policy->{duration_date_ceiling} = undef;
1412 $policy->{duration_date_ceiling_force} = undef;
1415 $policy->{duration} = $duration_rule->shrt
1416 if $self->copy->loan_duration == OILS_CIRC_DURATION_SHORT;
1417 $policy->{duration} = $duration_rule->normal
1418 if $self->copy->loan_duration == OILS_CIRC_DURATION_NORMAL;
1419 $policy->{duration} = $duration_rule->extended
1420 if $self->copy->loan_duration == OILS_CIRC_DURATION_EXTENDED;
1422 $policy->{recurring_fine} = $recurring_fine_rule->low
1423 if $self->copy->fine_level == OILS_REC_FINE_LEVEL_LOW;
1424 $policy->{recurring_fine} = $recurring_fine_rule->normal
1425 if $self->copy->fine_level == OILS_REC_FINE_LEVEL_NORMAL;
1426 $policy->{recurring_fine} = $recurring_fine_rule->high
1427 if $self->copy->fine_level == OILS_REC_FINE_LEVEL_HIGH;
1432 sub get_max_fine_amount {
1434 my $max_fine_rule = shift;
1435 my $max_amount = $max_fine_rule->amount;
1437 # if is_percent is true then the max->amount is
1438 # use as a percentage of the copy price
1439 if ($U->is_true($max_fine_rule->is_percent)) {
1440 my $price = $U->get_copy_price($self->editor, $self->copy, $self->volume);
1441 $max_amount = $price * $max_fine_rule->amount / 100;
1443 $U->ou_ancestor_setting_value(
1445 'circ.max_fine.cap_at_price',
1449 my $price = $U->get_copy_price($self->editor, $self->copy, $self->volume);
1450 $max_amount = ( $price && $max_amount > $price ) ? $price : $max_amount;
1458 sub run_copy_permit_scripts {
1460 my $copy = $self->copy || return;
1464 my $results = $self->run_indb_circ_test;
1465 push @allevents, $self->matrix_test_result_events
1466 unless $self->circ_test_success;
1468 # See if this copy has an alert message
1469 my $ae = $self->check_copy_alert();
1470 push( @allevents, $ae ) if $ae;
1472 # uniquify the events
1473 my %hash = map { ($_->{ilsevent} => $_) } @allevents;
1474 @allevents = values %hash;
1476 $logger->info("circulator: permit_copy script returned events: @allevents") if @allevents;
1478 $self->push_events(@allevents);
1482 sub check_copy_alert {
1485 if ($self->new_copy_alerts) {
1487 push @alerts, @{$self->user_copy_alerts} # we have preexisting alerts
1488 if ($self->user_copy_alerts && @{$self->user_copy_alerts});
1490 push @alerts, @{$self->system_copy_alerts} # we have new dynamic alerts
1491 if ($self->system_copy_alerts && @{$self->system_copy_alerts});
1494 $self->bail_out(1) if (!$self->override);
1495 return OpenILS::Event->new( 'COPY_ALERT_MESSAGE', payload => \@alerts);
1499 return undef if $self->is_renewal;
1500 return OpenILS::Event->new(
1501 'COPY_ALERT_MESSAGE', payload => $self->copy->alert_message)
1502 if $self->copy and $self->copy->alert_message;
1508 # --------------------------------------------------------------------------
1509 # If the call is overriding and has permissions to override every collected
1510 # event, the are cleared. Any event that the caller does not have
1511 # permission to override, will be left in the event list and bail_out will
1513 # XXX We need code in here to cancel any holds/transits on copies
1514 # that are being force-checked out
1515 # --------------------------------------------------------------------------
1516 sub override_events {
1518 my @events = @{$self->events};
1519 return unless @events;
1520 my $oargs = $self->override_args;
1522 if(!$self->override) {
1523 return $self->bail_out(1)
1524 if( @events > 1 or $events[0]->{textcode} ne 'SUCCESS' );
1529 for my $e (@events) {
1530 my $tc = $e->{textcode};
1531 next if $tc eq 'SUCCESS';
1532 if($oargs->{all} || grep { $_ eq $tc } @{$oargs->{events}}) {
1533 my $ov = "$tc.override";
1534 $logger->info("circulator: attempting to override event: $ov");
1536 return $self->bail_on_events($self->editor->event)
1537 unless( $self->editor->allowed($ov) );
1539 return $self->bail_out(1);
1545 # --------------------------------------------------------------------------
1546 # If there is an open claimsreturn circ on the requested copy, close the
1547 # circ if overriding, otherwise bail out
1548 # --------------------------------------------------------------------------
1549 sub handle_claims_returned {
1551 my $copy = $self->copy;
1553 my $CR = $self->editor->search_action_circulation(
1555 target_copy => $copy->id,
1556 stop_fines => OILS_STOP_FINES_CLAIMSRETURNED,
1557 checkin_time => undef,
1561 return unless ($CR = $CR->[0]);
1565 # - If the caller has set the override flag, we will check the item in
1566 if($self->override && ($self->override_args->{all} || grep { $_ eq 'CIRC_CLAIMS_RETURNED' } @{$self->override_args->{events}}) ) {
1568 $CR->checkin_time('now');
1569 $CR->checkin_scan_time('now');
1570 $CR->checkin_lib($self->circ_lib);
1571 $CR->checkin_workstation($self->editor->requestor->wsid);
1572 $CR->checkin_staff($self->editor->requestor->id);
1574 $evt = $self->editor->event
1575 unless $self->editor->update_action_circulation($CR);
1578 $evt = OpenILS::Event->new('CIRC_CLAIMS_RETURNED');
1581 $self->bail_on_events($evt) if $evt;
1586 # --------------------------------------------------------------------------
1587 # This performs the checkout
1588 # --------------------------------------------------------------------------
1592 $self->log_me("do_checkout()");
1594 # make sure perms are good if this isn't a renewal
1595 unless( $self->is_renewal ) {
1596 return $self->bail_on_events($self->editor->event)
1597 unless( $self->editor->allowed('COPY_CHECKOUT') );
1600 # verify the permit key
1601 unless( $self->check_permit_key ) {
1602 if( $self->permit_override ) {
1603 return $self->bail_on_events($self->editor->event)
1604 unless $self->editor->allowed('CIRC_PERMIT_OVERRIDE');
1606 return $self->bail_on_events(OpenILS::Event->new('CIRC_PERMIT_BAD_KEY'))
1610 # if this is a non-cataloged circ, build the circ and finish
1611 if( $self->is_noncat ) {
1612 $self->checkout_noncat;
1614 OpenILS::Event->new('SUCCESS',
1615 payload => { noncat_circ => $self->circ }));
1619 if( $self->is_precat ) {
1620 $self->make_precat_copy;
1621 return if $self->bail_out;
1623 } elsif( $self->copy->call_number == OILS_PRECAT_CALL_NUMBER ) {
1624 return $self->bail_on_events(OpenILS::Event->new('ITEM_NOT_CATALOGED'));
1627 $self->do_copy_checks;
1628 return if $self->bail_out;
1630 $self->run_checkout_scripts();
1631 return if $self->bail_out;
1633 $self->build_checkout_circ_object();
1634 return if $self->bail_out;
1636 my $modify_to_start = $self->booking_adjusted_due_date();
1637 return if $self->bail_out;
1639 $self->apply_modified_due_date($modify_to_start);
1640 return if $self->bail_out;
1642 return $self->bail_on_events($self->editor->event)
1643 unless $self->editor->create_action_circulation($self->circ);
1645 # refresh the circ to force local time zone for now
1646 $self->circ($self->editor->retrieve_action_circulation($self->circ->id));
1648 if($self->limit_groups) {
1649 $self->editor->json_query({ from => ['action.link_circ_limit_groups', $self->circ->id, $self->limit_groups] });
1652 $self->copy->status(OILS_COPY_STATUS_CHECKED_OUT);
1654 return if $self->bail_out;
1656 $self->apply_deposit_fee();
1657 return if $self->bail_out;
1659 $self->handle_checkout_holds();
1660 return if $self->bail_out;
1662 # ------------------------------------------------------------------------------
1663 # Update the patron penalty info in the DB. Run it for permit-overrides
1664 # since the penalties are not updated during the permit phase
1665 # ------------------------------------------------------------------------------
1666 OpenILS::Utils::Penalty->calculate_penalties($self->editor, $self->patron->id, $self->circ_lib);
1668 my $record = $U->record_to_mvr($self->title) unless $self->is_precat;
1671 if($self->is_renewal) {
1672 # flesh the billing summary for the checked-in circ
1673 $pcirc = $self->editor->retrieve_action_circulation([
1675 {flesh => 2, flesh_fields => {circ => ['billable_transaction'], mbt => ['summary']}}
1680 OpenILS::Event->new('SUCCESS',
1682 copy => $U->unflesh_copy($self->copy),
1683 volume => $self->volume,
1684 circ => $self->circ,
1686 holds_fulfilled => $self->fulfilled_holds,
1687 deposit_billing => $self->deposit_billing,
1688 rental_billing => $self->rental_billing,
1689 parent_circ => $pcirc,
1690 patron => ($self->return_patron) ? $self->patron : undef,
1691 patron_money => $self->editor->retrieve_money_user_summary($self->patron->id)
1697 sub apply_deposit_fee {
1699 my $copy = $self->copy;
1701 ($self->is_deposit and not $self->is_deposit_exempt) or
1702 ($self->is_rental and not $self->is_rental_exempt);
1704 return if $self->is_deposit and $self->skip_deposit_fee;
1705 return if $self->is_rental and $self->skip_rental_fee;
1707 my $bill = Fieldmapper::money::billing->new;
1708 my $amount = $copy->deposit_amount;
1712 if($self->is_deposit) {
1713 $billing_type = OILS_BILLING_TYPE_DEPOSIT;
1715 $self->deposit_billing($bill);
1717 $billing_type = OILS_BILLING_TYPE_RENTAL;
1719 $self->rental_billing($bill);
1722 $bill->xact($self->circ->id);
1723 $bill->amount($amount);
1724 $bill->note(OILS_BILLING_NOTE_SYSTEM);
1725 $bill->billing_type($billing_type);
1726 $bill->btype($btype);
1727 $self->editor->create_money_billing($bill) or $self->bail_on_events($self->editor->event);
1729 $logger->info("circulator: charged $amount on checkout with billing type $billing_type");
1734 my $copy = $self->copy;
1736 my $stat = $copy->status if ref $copy->status;
1737 my $loc = $copy->location if ref $copy->location;
1738 my $circ_lib = $copy->circ_lib if ref $copy->circ_lib;
1740 $copy->status($stat->id) if $stat;
1741 $copy->location($loc->id) if $loc;
1742 $copy->circ_lib($circ_lib->id) if $circ_lib;
1743 $copy->editor($self->editor->requestor->id);
1744 $copy->edit_date('now');
1745 $copy->age_protect($copy->age_protect->id) if ref $copy->age_protect;
1747 return $self->bail_on_events($self->editor->event)
1748 unless $self->editor->update_asset_copy($self->copy);
1750 $copy->status($U->copy_status($copy->status));
1751 $copy->location($loc) if $loc;
1752 $copy->circ_lib($circ_lib) if $circ_lib;
1755 sub update_reservation {
1757 my $reservation = $self->reservation;
1759 my $usr = $reservation->usr;
1760 my $target_rt = $reservation->target_resource_type;
1761 my $target_r = $reservation->target_resource;
1762 my $current_r = $reservation->current_resource;
1764 $reservation->usr($usr->id) if ref $usr;
1765 $reservation->target_resource_type($target_rt->id) if ref $target_rt;
1766 $reservation->target_resource($target_r->id) if ref $target_r;
1767 $reservation->current_resource($current_r->id) if ref $current_r;
1769 return $self->bail_on_events($self->editor->event)
1770 unless $self->editor->update_booking_reservation($self->reservation);
1773 ($reservation, $evt) = $U->fetch_booking_reservation($reservation->id);
1774 $self->reservation($reservation);
1778 sub bail_on_events {
1779 my( $self, @evts ) = @_;
1780 $self->push_events(@evts);
1784 # ------------------------------------------------------------------------------
1785 # A hold FULFILL block is just like a CIRC block, except that FULFILL only
1786 # affects copies that will fulfill holds and CIRC affects all other copies.
1787 # If blocks exists, bail, push Events onto the event pile, and return true.
1788 # ------------------------------------------------------------------------------
1789 sub check_hold_fulfill_blocks {
1792 # With the addition of ignore_proximity in csp, we need to fetch
1793 # the proximity of both the circ_lib and the copy's circ_lib to
1794 # the patron's home_ou.
1795 my ($ou_prox, $copy_prox);
1796 my $home_ou = (ref($self->patron->home_ou)) ? $self->patron->home_ou->id : $self->patron->home_ou;
1797 $ou_prox = $U->get_org_unit_proximity($self->editor, $home_ou, $self->circ_lib);
1798 $ou_prox = -1 unless (defined($ou_prox));
1799 my $copy_ou = (ref($self->copy->circ_lib)) ? $self->copy->circ_lib->id : $self->copy->circ_lib;
1800 if ($copy_ou == $self->circ_lib) {
1801 # Save us the time of an extra query.
1802 $copy_prox = $ou_prox;
1804 $copy_prox = $U->get_org_unit_proximity($self->editor, $home_ou, $copy_ou);
1805 $copy_prox = -1 unless (defined($copy_prox));
1808 # See if the user has any penalties applied that prevent hold fulfillment
1809 my $pens = $self->editor->json_query({
1810 select => {csp => ['name', 'label']},
1811 from => {ausp => {csp => {}}},
1814 usr => $self->patron->id,
1815 org_unit => $U->get_org_full_path($self->circ_lib),
1817 {stop_date => undef},
1818 {stop_date => {'>' => 'now'}}
1822 block_list => {'like' => '%FULFILL%'},
1824 {ignore_proximity => undef},
1825 {ignore_proximity => {'<' => $ou_prox}},
1826 {ignore_proximity => {'<' => $copy_prox}}
1832 return 0 unless @$pens;
1834 for my $pen (@$pens) {
1835 $logger->info("circulator: patron has hold FULFILL block " . $pen->{name});
1836 my $event = OpenILS::Event->new($pen->{name});
1837 $event->{desc} = $pen->{label};
1838 $self->push_events($event);
1841 $self->override_events;
1842 return $self->bail_out;
1846 # ------------------------------------------------------------------------------
1847 # When an item is checked out, see if we can fulfill a hold for this patron
1848 # ------------------------------------------------------------------------------
1849 sub handle_checkout_holds {
1851 my $copy = $self->copy;
1852 my $patron = $self->patron;
1854 my $e = $self->editor;
1855 $self->fulfilled_holds([]);
1857 # non-cats can't fulfill a hold
1858 return if $self->is_noncat;
1860 my $hold = $e->search_action_hold_request({
1861 current_copy => $copy->id ,
1862 cancel_time => undef,
1863 fulfillment_time => undef
1866 if($hold and $hold->usr != $patron->id) {
1867 # reset the hold since the copy is now checked out
1869 $logger->info("circulator: un-targeting hold ".$hold->id.
1870 " because copy ".$copy->id." is getting checked out");
1872 $hold->clear_prev_check_time;
1873 $hold->clear_current_copy;
1874 $hold->clear_capture_time;
1875 $hold->clear_shelf_time;
1876 $hold->clear_shelf_expire_time;
1877 $hold->clear_current_shelf_lib;
1879 return $self->bail_on_event($e->event)
1880 unless $e->update_action_hold_request($hold);
1886 $hold = $self->find_related_user_hold($copy, $patron) or return;
1887 $logger->info("circulator: found related hold to fulfill in checkout");
1890 return if $self->check_hold_fulfill_blocks;
1892 $logger->debug("circulator: checkout fulfilling hold " . $hold->id);
1894 # if the hold was never officially captured, capture it.
1895 $hold->current_copy($copy->id);
1896 $hold->capture_time('now') unless $hold->capture_time;
1897 $hold->fulfillment_time('now');
1898 $hold->fulfillment_staff($e->requestor->id);
1899 $hold->fulfillment_lib($self->circ_lib);
1901 return $self->bail_on_events($e->event)
1902 unless $e->update_action_hold_request($hold);
1904 return $self->fulfilled_holds([$hold->id]);
1908 # ------------------------------------------------------------------------------
1909 # If the circ.checkout_fill_related_hold setting is turned on and no hold for
1910 # the patron directly targets the checked out item, see if there is another hold
1911 # for the patron that could be fulfilled by the checked out item. Fulfill the
1912 # oldest hold and only fulfill 1 of them.
1914 # For "another hold":
1916 # First, check for one that the copy matches via hold_copy_map, ensuring that
1917 # *any* hold type that this copy could fill may end up filled.
1919 # Then, if circ.checkout_fill_related_hold_exact_match_only is not enabled, look
1920 # for a Title (T) or Volume (V) hold that matches the item. This allows items
1921 # that are non-requestable to count as capturing those hold types.
1922 # ------------------------------------------------------------------------------
1923 sub find_related_user_hold {
1924 my($self, $copy, $patron) = @_;
1925 my $e = $self->editor;
1927 # holds on precat copies are always copy-level, so this call will
1928 # always return undef. Exit early.
1929 return undef if $self->is_precat;
1931 return undef unless $U->ou_ancestor_setting_value(
1932 $self->circ_lib, 'circ.checkout_fills_related_hold', $e);
1934 # find the oldest unfulfilled hold that has not yet hit the holds shelf.
1936 select => {ahr => ['id']},
1945 fkey => 'current_copy',
1946 type => 'left' # there may be no current_copy
1953 fulfillment_time => undef,
1954 cancel_time => undef,
1956 {expire_time => undef},
1957 {expire_time => {'>' => 'now'}}
1961 target_copy => $self->copy->id
1965 {id => undef}, # left-join copy may be nonexistent
1966 {status => {'!=' => OILS_COPY_STATUS_ON_HOLDS_SHELF}},
1970 order_by => {ahr => {request_time => {direction => 'asc'}}},
1974 my $hold_info = $e->json_query($args)->[0];
1975 return $e->retrieve_action_hold_request($hold_info->{id}) if $hold_info;
1976 return undef if $U->ou_ancestor_setting_value(
1977 $self->circ_lib, 'circ.checkout_fills_related_hold_exact_match_only', $e);
1979 # find the oldest unfulfilled hold that has not yet hit the holds shelf.
1981 select => {ahr => ['id']},
1986 fkey => 'current_copy',
1987 type => 'left' # there may be no current_copy
1994 fulfillment_time => undef,
1995 cancel_time => undef,
1997 {expire_time => undef},
1998 {expire_time => {'>' => 'now'}}
2005 target => $self->volume->id
2011 target => $self->title->id
2017 {id => undef}, # left-join copy may be nonexistent
2018 {status => {'!=' => OILS_COPY_STATUS_ON_HOLDS_SHELF}},
2022 order_by => {ahr => {request_time => {direction => 'asc'}}},
2026 $hold_info = $e->json_query($args)->[0];
2027 return $e->retrieve_action_hold_request($hold_info->{id}) if $hold_info;
2032 sub run_checkout_scripts {
2045 my $hard_due_date_name;
2047 $self->run_indb_circ_test();
2048 $duration = $self->circ_matrix_matchpoint->duration_rule;
2049 $recurring = $self->circ_matrix_matchpoint->recurring_fine_rule;
2050 $max_fine = $self->circ_matrix_matchpoint->max_fine_rule;
2051 $hard_due_date = $self->circ_matrix_matchpoint->hard_due_date;
2053 $duration_name = $duration->name if $duration;
2054 if( $duration_name ne OILS_UNLIMITED_CIRC_DURATION ) {
2057 ($duration, $evt) = $U->fetch_circ_duration_by_name($duration_name);
2058 return $self->bail_on_events($evt) if ($evt && !$nobail);
2060 ($recurring, $evt) = $U->fetch_recurring_fine_by_name($recurring_name);
2061 return $self->bail_on_events($evt) if ($evt && !$nobail);
2063 ($max_fine, $evt) = $U->fetch_max_fine_by_name($max_fine_name);
2064 return $self->bail_on_events($evt) if ($evt && !$nobail);
2066 if($hard_due_date_name) {
2067 ($hard_due_date, $evt) = $U->fetch_hard_due_date_by_name($hard_due_date_name);
2068 return $self->bail_on_events($evt) if ($evt && !$nobail);
2074 # The item circulates with an unlimited duration
2078 $hard_due_date = undef;
2081 $self->duration_rule($duration);
2082 $self->recurring_fines_rule($recurring);
2083 $self->max_fine_rule($max_fine);
2084 $self->hard_due_date($hard_due_date);
2088 sub build_checkout_circ_object {
2091 my $circ = Fieldmapper::action::circulation->new;
2092 my $duration = $self->duration_rule;
2093 my $max = $self->max_fine_rule;
2094 my $recurring = $self->recurring_fines_rule;
2095 my $hard_due_date = $self->hard_due_date;
2096 my $copy = $self->copy;
2097 my $patron = $self->patron;
2098 my $duration_date_ceiling;
2099 my $duration_date_ceiling_force;
2103 my $policy = $self->get_circ_policy($duration, $recurring, $max, $hard_due_date);
2104 $duration_date_ceiling = $policy->{duration_date_ceiling};
2105 $duration_date_ceiling_force = $policy->{duration_date_ceiling_force};
2107 my $dname = $duration->name;
2108 my $mname = $max->name;
2109 my $rname = $recurring->name;
2111 if($hard_due_date) {
2112 $hdname = $hard_due_date->name;
2115 $logger->debug("circulator: building circulation ".
2116 "with duration=$dname, maxfine=$mname, recurring=$rname, hard due date=$hdname");
2118 $circ->duration($policy->{duration});
2119 $circ->recurring_fine($policy->{recurring_fine});
2120 $circ->duration_rule($duration->name);
2121 $circ->recurring_fine_rule($recurring->name);
2122 $circ->max_fine_rule($max->name);
2123 $circ->max_fine($policy->{max_fine});
2124 $circ->fine_interval($recurring->recurrence_interval);
2125 $circ->renewal_remaining($duration->max_renewals);
2126 $circ->auto_renewal_remaining($duration->max_auto_renewals);
2127 $circ->grace_period($policy->{grace_period});
2131 $logger->info("circulator: copy found with an unlimited circ duration");
2132 $circ->duration_rule(OILS_UNLIMITED_CIRC_DURATION);
2133 $circ->recurring_fine_rule(OILS_UNLIMITED_CIRC_DURATION);
2134 $circ->max_fine_rule(OILS_UNLIMITED_CIRC_DURATION);
2135 $circ->renewal_remaining(0);
2136 $circ->grace_period(0);
2139 $circ->target_copy( $copy->id );
2140 $circ->usr( $patron->id );
2141 $circ->circ_lib( $self->circ_lib );
2142 $circ->workstation($self->editor->requestor->wsid)
2143 if defined $self->editor->requestor->wsid;
2145 # renewals maintain a link to the parent circulation
2146 $circ->parent_circ($self->parent_circ);
2148 if( $self->is_renewal ) {
2149 $circ->opac_renewal('t') if $self->opac_renewal;
2150 $circ->phone_renewal('t') if $self->phone_renewal;
2151 $circ->desk_renewal('t') if $self->desk_renewal;
2152 $circ->auto_renewal('t') if $self->auto_renewal;
2153 $circ->renewal_remaining($self->renewal_remaining);
2154 $circ->auto_renewal_remaining($self->auto_renewal_remaining);
2155 $circ->circ_staff($self->editor->requestor->id);
2158 # if the user provided an overiding checkout time,
2159 # (e.g. the checkout really happened several hours ago), then
2160 # we apply that here. Does this need a perm??
2161 $circ->xact_start(clean_ISO8601($self->checkout_time))
2162 if $self->checkout_time;
2164 # if a patron is renewing, 'requestor' will be the patron
2165 $circ->circ_staff($self->editor->requestor->id);
2166 $circ->due_date( $self->create_due_date($circ->duration, $duration_date_ceiling, $duration_date_ceiling_force, $circ->xact_start) ) if $circ->duration;
2171 sub do_reservation_pickup {
2174 $self->log_me("do_reservation_pickup()");
2176 $self->reservation->pickup_time('now');
2179 $self->reservation->current_resource &&
2180 $U->is_true($self->reservation->target_resource_type->catalog_item)
2182 # We used to try to set $self->copy and $self->patron here,
2183 # but that should already be done.
2185 $self->run_checkout_scripts(1);
2187 my $duration = $self->duration_rule;
2188 my $max = $self->max_fine_rule;
2189 my $recurring = $self->recurring_fines_rule;
2191 if ($duration && $max && $recurring) {
2192 my $policy = $self->get_circ_policy($duration, $recurring, $max);
2194 my $dname = $duration->name;
2195 my $mname = $max->name;
2196 my $rname = $recurring->name;
2198 $logger->debug("circulator: updating reservation ".
2199 "with duration=$dname, maxfine=$mname, recurring=$rname");
2201 $self->reservation->fine_amount($policy->{recurring_fine});
2202 $self->reservation->max_fine($policy->{max_fine});
2203 $self->reservation->fine_interval($recurring->recurrence_interval);
2206 $self->copy->status(OILS_COPY_STATUS_CHECKED_OUT);
2207 $self->update_copy();
2210 $self->reservation->fine_amount(
2211 $self->reservation->target_resource_type->fine_amount
2213 $self->reservation->max_fine(
2214 $self->reservation->target_resource_type->max_fine
2216 $self->reservation->fine_interval(
2217 $self->reservation->target_resource_type->fine_interval
2221 $self->update_reservation();
2224 sub do_reservation_return {
2226 my $request = shift;
2228 $self->log_me("do_reservation_return()");
2230 if (not ref $self->reservation) {
2231 my ($reservation, $evt) =
2232 $U->fetch_booking_reservation($self->reservation);
2233 return $self->bail_on_events($evt) if $evt;
2234 $self->reservation($reservation);
2237 $self->handle_fines(1);
2238 $self->reservation->return_time('now');
2239 $self->update_reservation();
2240 $self->reshelve_copy if $self->copy;
2242 if ( $self->reservation->current_resource && $self->reservation->current_resource->catalog_item ) {
2243 $self->copy( $self->reservation->current_resource->catalog_item );
2247 sub booking_adjusted_due_date {
2249 my $circ = $self->circ;
2250 my $copy = $self->copy;
2252 return undef unless $self->use_booking;
2256 if( $self->due_date ) {
2258 return $self->bail_on_events($self->editor->event)
2259 unless $self->editor->allowed('CIRC_OVERRIDE_DUE_DATE', $self->circ_lib);
2261 $circ->due_date(clean_ISO8601($self->due_date));
2265 return unless $copy and $circ->due_date;
2268 my $booking_items = $self->editor->search_booking_resource( { barcode => $copy->barcode } );
2269 if (@$booking_items) {
2270 my $booking_item = $booking_items->[0];
2271 my $resource_type = $self->editor->retrieve_booking_resource_type( $booking_item->type );
2273 my $stop_circ_setting = $U->ou_ancestor_setting_value( $self->circ_lib, 'circ.booking_reservation.stop_circ', $self->editor );
2274 my $shorten_circ_setting = $resource_type->elbow_room ||
2275 $U->ou_ancestor_setting_value( $self->circ_lib, 'circ.booking_reservation.default_elbow_room', $self->editor ) ||
2278 my $booking_ses = OpenSRF::AppSession->create( 'open-ils.booking' );
2279 my $bookings = $booking_ses->request('open-ils.booking.reservations.filtered_id_list', $self->editor->authtoken, {
2280 resource => $booking_item->id
2281 , search_start => 'now'
2282 , search_end => $circ->due_date
2283 , fields => { cancel_time => undef, return_time => undef }
2285 $booking_ses->disconnect;
2287 throw OpenSRF::EX::ERROR ("Improper input arguments") unless defined $bookings;
2288 return $self->bail_on_events($bookings) if ref($bookings) eq 'HASH';
2290 my $dt_parser = DateTime::Format::ISO8601->new;
2291 my $due_date = $dt_parser->parse_datetime( clean_ISO8601($circ->due_date) );
2293 for my $bid (@$bookings) {
2295 my $booking = $self->editor->retrieve_booking_reservation( $bid );
2297 my $booking_start = $dt_parser->parse_datetime( clean_ISO8601($booking->start_time) );
2298 my $booking_end = $dt_parser->parse_datetime( clean_ISO8601($booking->end_time) );
2300 return $self->bail_on_events( OpenILS::Event->new('COPY_RESERVED') )
2301 if ($booking_start < DateTime->now);
2304 if ($U->is_true($stop_circ_setting)) {
2305 $self->bail_on_events( OpenILS::Event->new('COPY_RESERVED') );
2307 $due_date = $booking_start->subtract( seconds => interval_to_seconds($shorten_circ_setting) );
2308 $self->bail_on_events( OpenILS::Event->new('COPY_RESERVED') ) if ($due_date < DateTime->now);
2311 # We set the circ duration here only to affect the logic that will
2312 # later (in a DB trigger) mangle the time part of the due date to
2313 # 11:59pm. Having any circ duration that is not a whole number of
2314 # days is enough to prevent the "correction."
2315 my $new_circ_duration = $due_date->epoch - time;
2316 $new_circ_duration++ if $new_circ_duration % 86400 == 0;
2317 $circ->duration("$new_circ_duration seconds");
2319 $circ->due_date(clean_ISO8601($due_date->strftime('%FT%T%z')));
2323 return $self->bail_on_events($self->editor->event)
2324 unless $self->editor->allowed('CIRC_OVERRIDE_DUE_DATE', $self->circ_lib);
2330 sub apply_modified_due_date {
2332 my $shift_earlier = shift;
2333 my $circ = $self->circ;
2334 my $copy = $self->copy;
2336 if( $self->due_date ) {
2338 return $self->bail_on_events($self->editor->event)
2339 unless $self->editor->allowed('CIRC_OVERRIDE_DUE_DATE', $self->circ_lib);
2341 $circ->due_date(clean_ISO8601($self->due_date));
2345 # if the due_date lands on a day when the location is closed
2346 return unless $copy and $circ->due_date;
2348 #my $org = (ref $copy->circ_lib) ? $copy->circ_lib->id : $copy->circ_lib;
2350 # due-date overlap should be determined by the location the item
2351 # is checked out from, not the owning or circ lib of the item
2352 my $org = $self->circ_lib;
2354 $logger->info("circulator: circ searching for closed date overlap on lib $org".
2355 " with an item due date of ".$circ->due_date );
2357 my $dateinfo = $U->storagereq(
2358 'open-ils.storage.actor.org_unit.closed_date.overlap',
2359 $org, $circ->due_date );
2362 $logger->info("circulator: $dateinfo : circ due data / close date overlap found : due_date=".
2363 $circ->due_date." start=". $dateinfo->{start}.", end=".$dateinfo->{end});
2365 # XXX make the behavior more dynamic
2366 # for now, we just push the due date to after the close date
2367 if ($shift_earlier) {
2368 $circ->due_date($dateinfo->{start});
2370 $circ->due_date($dateinfo->{end});
2378 sub create_due_date {
2379 my( $self, $duration, $date_ceiling, $force_date, $start_time ) = @_;
2381 # Look up circulating library's TZ, or else use client TZ, falling
2383 my $tz = $U->ou_ancestor_setting_value(
2389 my $due_date = $start_time ?
2390 DateTime::Format::ISO8601
2392 ->parse_datetime(clean_ISO8601($start_time))
2393 ->set_time_zone($tz) :
2394 DateTime->now(time_zone => $tz);
2396 # add the circ duration
2397 $due_date->add(seconds => OpenILS::Utils::DateTime->interval_to_seconds($duration, $due_date));
2400 my $cdate = DateTime::Format::ISO8601
2402 ->parse_datetime(clean_ISO8601($date_ceiling))
2403 ->set_time_zone($tz);
2405 if ($cdate > DateTime->now and ($cdate < $due_date or $U->is_true( $force_date ))) {
2406 $logger->info("circulator: overriding due date with date ceiling: $date_ceiling");
2411 # return ISO8601 time with timezone
2412 return $due_date->strftime('%FT%T%z');
2417 sub make_precat_copy {
2419 my $copy = $self->copy;
2420 return $self->bail_on_events(OpenILS::Event->new('PERM_FAILURE'))
2421 unless $self->editor->allowed('CREATE_PRECAT') || $self->is_renewal;
2424 $logger->debug("circulator: Pre-cat copy already exists in checkout: ID=" . $copy->id);
2426 $copy->editor($self->editor->requestor->id);
2427 $copy->edit_date('now');
2428 $copy->dummy_title($self->dummy_title || $copy->dummy_title || '');
2429 $copy->dummy_isbn($self->dummy_isbn || $copy->dummy_isbn || '');
2430 $copy->dummy_author($self->dummy_author || $copy->dummy_author || '');
2431 $copy->circ_modifier($self->circ_modifier || $copy->circ_modifier);
2432 $self->update_copy();
2436 $logger->info("circulator: Creating a new precataloged ".
2437 "copy in checkout with barcode " . $self->copy_barcode);
2439 $copy = Fieldmapper::asset::copy->new;
2440 $copy->circ_lib($self->circ_lib);
2441 $copy->creator($self->editor->requestor->id);
2442 $copy->editor($self->editor->requestor->id);
2443 $copy->barcode($self->copy_barcode);
2444 $copy->call_number(OILS_PRECAT_CALL_NUMBER);
2445 $copy->loan_duration(OILS_PRECAT_COPY_LOAN_DURATION);
2446 $copy->fine_level(OILS_PRECAT_COPY_FINE_LEVEL);
2448 $copy->dummy_title($self->dummy_title || "");
2449 $copy->dummy_author($self->dummy_author || "");
2450 $copy->dummy_isbn($self->dummy_isbn || "");
2451 $copy->circ_modifier($self->circ_modifier);
2454 # See if we need to override the circ_lib for the copy with a configured circ_lib
2455 # Setting is shortname of the org unit
2456 my $precat_circ_lib = $U->ou_ancestor_setting_value(
2457 $self->circ_lib, 'circ.pre_cat_copy_circ_lib', $self->editor);
2459 if($precat_circ_lib) {
2460 my $org = $self->editor->search_actor_org_unit({shortname => $precat_circ_lib})->[0];
2463 $self->bail_on_events($self->editor->event);
2467 $copy->circ_lib($org->id);
2471 unless( $self->copy($self->editor->create_asset_copy($copy)) ) {
2473 $self->push_events($self->editor->event);
2479 sub checkout_noncat {
2485 my $lib = $self->noncat_circ_lib || $self->circ_lib;
2486 my $count = $self->noncat_count || 1;
2487 my $cotime = clean_ISO8601($self->checkout_time) || "";
2489 $logger->info("circulator: circ creating $count noncat circs with checkout time $cotime");
2493 ( $circ, $evt ) = OpenILS::Application::Circ::NonCat::create_non_cat_circ(
2494 $self->editor->requestor->id,
2502 $self->push_events($evt);
2510 # if an item is in transit but the status doesn't agree, then we need to fix things.
2511 # The next two subs will hopefully do that
2512 sub fix_broken_transit_status {
2515 # Capture the transit so we don't have to fetch it again later during checkin
2516 # This used to live in sub check_transit_checkin_interval and later again in
2519 $self->editor->search_action_transit_copy(
2520 {target_copy => $self->copy->id, dest_recv_time => undef, cancel_time => undef}
2524 if ($self->transit && $U->copy_status($self->copy->status)->id != OILS_COPY_STATUS_IN_TRANSIT) {
2525 $logger->warn("circulator: we have a copy ".$self->copy->barcode.
2526 " that is in-transit but without the In Transit status... fixing");
2527 $self->copy->status(OILS_COPY_STATUS_IN_TRANSIT);
2528 # FIXME - do we want to make this permanent if the checkin bails?
2533 sub cancel_transit_if_circ_exists {
2535 if ($self->circ && $self->transit) {
2536 $logger->warn("circulator: we have a copy ".$self->copy->barcode.
2537 " that is in-transit AND circulating... aborting the transit");
2538 my $circ_ses = create OpenSRF::AppSession("open-ils.circ");
2539 my $result = $circ_ses->request(
2540 "open-ils.circ.transit.abort",
2541 $self->editor->authtoken,
2542 { 'transitid' => $self->transit->id }
2544 $logger->warn("circulator: transit abort result: ".$result);
2545 $circ_ses->disconnect;
2546 $self->transit(undef);
2550 # If a copy goes into transit and is then checked in before the transit checkin
2551 # interval has expired, push an event onto the overridable events list.
2552 sub check_transit_checkin_interval {
2555 # only concerned with in-transit items
2556 return unless $U->copy_status($self->copy->status)->id == OILS_COPY_STATUS_IN_TRANSIT;
2558 # no interval, no problem
2559 my $interval = $U->ou_ancestor_setting_value($self->circ_lib, 'circ.transit.min_checkin_interval');
2560 return unless $interval;
2562 # transit from X to X for whatever reason has no min interval
2563 return if $self->transit->source == $self->transit->dest;
2565 my $seconds = OpenILS::Utils::DateTime->interval_to_seconds($interval);
2566 my $t_start = DateTime::Format::ISO8601->new->parse_datetime(clean_ISO8601($self->transit->source_send_time));
2567 my $horizon = $t_start->add(seconds => $seconds);
2569 # See if we are still within the transit checkin forbidden range
2570 $self->push_events(OpenILS::Event->new('TRANSIT_CHECKIN_INTERVAL_BLOCK'))
2571 if $horizon > DateTime->now;
2574 # Retarget local holds at checkin
2575 sub checkin_retarget {
2577 return unless $self->retarget_mode and $self->retarget_mode =~ m/retarget/; # Retargeting?
2578 return unless $self->is_checkin; # Renewals need not be checked
2579 return if $self->capture eq 'nocapture'; # Not capturing holds anyway? Move on.
2580 return if $self->is_precat; # No holds for precats
2581 return unless $self->circ_lib == $self->copy->circ_lib; # Item isn't "home"? Don't check.
2582 return unless $U->is_true($self->copy->holdable); # Not holdable, shouldn't capture holds.
2583 my $status = $U->copy_status($self->copy->status);
2584 return unless $U->is_true($status->holdable); # Current status not holdable means no hold will ever target the item
2585 # Specifically target items that are likely new (by status ID)
2586 return unless $status->id == OILS_COPY_STATUS_IN_PROCESS || $self->retarget_mode =~ m/\.all/;
2587 my $location = $self->copy->location;
2588 if(!ref($location)) {
2589 $location = $self->editor->retrieve_asset_copy_location($self->copy->location);
2590 $self->copy->location($location);
2592 return unless $U->is_true($location->holdable); # Don't bother on non-holdable locations
2594 # Fetch holds for the bib
2595 my ($result) = $holdcode->method_lookup('open-ils.circ.holds.retrieve_all_from_title')->run(
2596 $self->editor->authtoken,
2599 capture_time => undef, # No touching captured holds
2600 frozen => 'f', # Don't bother with frozen holds
2601 pickup_lib => $self->circ_lib # Only holds actually here
2604 # Error? Skip the step.
2605 return if exists $result->{"ilsevent"};
2609 foreach my $holdlist (keys %{$result}) {
2610 push @$holds, @{$result->{$holdlist}};
2613 return if scalar(@$holds) == 0; # No holds, no retargeting
2615 # Check for parts on this copy
2616 my $parts = $self->editor->search_asset_copy_part_map({ target_copy => $self->copy->id });
2617 my %parts_hash = ();
2618 %parts_hash = map {$_->part, 1} @$parts if @$parts;
2620 # Loop over holds in request-ish order
2621 # Stage 1: Get them into request-ish order
2622 # Also grab type and target for skipping low hanging ones
2623 $result = $self->editor->json_query({
2624 "select" => { "ahr" => ["id", "hold_type", "target"] },
2625 "from" => { "ahr" => { "au" => { "fkey" => "usr", "join" => "pgt"} } },
2626 "where" => { "id" => $holds },
2628 { "class" => "pgt", "field" => "hold_priority"},
2629 { "class" => "ahr", "field" => "cut_in_line", "direction" => "desc", "transform" => "coalesce", "params" => ['f']},
2630 { "class" => "ahr", "field" => "selection_depth", "direction" => "desc"},
2631 { "class" => "ahr", "field" => "request_time"}
2636 if (ref $result eq "ARRAY" and scalar @$result) {
2637 foreach (@{$result}) {
2638 # Copy level, but not this copy?
2639 next if ($_->{hold_type} eq 'C' or $_->{hold_type} eq 'R' or $_->{hold_type} eq 'F'
2640 and $_->{target} != $self->copy->id);
2641 # Volume level, but not this volume?
2642 next if ($_->{hold_type} eq 'V' and $_->{target} != $self->volume->id);
2643 if(@$parts) { # We have parts?
2645 next if ($_->{hold_type} eq 'T');
2646 # Skip part holds for parts not on this copy
2647 next if ($_->{hold_type} eq 'P' and not $parts_hash{$_->{target}});
2649 # No parts, no part holds
2650 next if ($_->{hold_type} eq 'P');
2652 # So much for easy stuff, attempt a retarget!
2653 my $tresult = $U->simplereq(
2654 'open-ils.hold-targeter',
2655 'open-ils.hold-targeter.target',
2656 {hold => $_->{id}, find_copy => $self->copy->id}
2658 if(ref $tresult eq "ARRAY" and scalar @$tresult) {
2659 last if(exists $tresult->[0]->{found_copy} and $tresult->[0]->{found_copy});
2667 $self->log_me("do_checkin()");
2669 return $self->bail_on_events(
2670 OpenILS::Event->new('ASSET_COPY_NOT_FOUND'))
2673 $self->fix_broken_transit_status; # if applicable
2674 $self->check_transit_checkin_interval;
2675 $self->checkin_retarget;
2677 # the renew code and mk_env should have already found our circulation object
2678 unless( $self->circ ) {
2680 my $circs = $self->editor->search_action_circulation(
2681 { target_copy => $self->copy->id, checkin_time => undef });
2683 $self->circ($$circs[0]);
2685 # for now, just warn if there are multiple open circs on a copy
2686 $logger->warn("circulator: we have ".scalar(@$circs).
2687 " open circs for copy " .$self->copy->id."!!") if @$circs > 1;
2689 $self->cancel_transit_if_circ_exists; # if applicable
2691 my $stat = $U->copy_status($self->copy->status)->id;
2693 # LOST (and to some extent, LONGOVERDUE) may optionally be handled
2694 # differently if they are already paid for. We need to check for this
2695 # early since overdue generation is potentially affected.
2696 my $dont_change_lost_zero = 0;
2697 if ($stat == OILS_COPY_STATUS_LOST
2698 || $stat == OILS_COPY_STATUS_LOST_AND_PAID
2699 || $stat == OILS_COPY_STATUS_LONG_OVERDUE) {
2701 # LOST fine settings are controlled by the copy's circ lib, not the the
2703 my $copy_circ_lib = (ref $self->copy->circ_lib) ?
2704 $self->copy->circ_lib->id : $self->copy->circ_lib;
2705 $dont_change_lost_zero = $U->ou_ancestor_setting_value(
2706 $copy_circ_lib, 'circ.checkin.lost_zero_balance.do_not_change',
2707 $self->editor) || 0;
2709 # Don't assume there's always a circ based on copy status
2710 if ($dont_change_lost_zero && $self->circ) {
2711 my ($obt) = $U->fetch_mbts($self->circ->id, $self->editor);
2712 $dont_change_lost_zero = 0 if( $obt and $obt->balance_owed != 0 );
2715 $self->dont_change_lost_zero($dont_change_lost_zero);
2718 # Check if the copy can float to here. We need this for inventory
2719 # and to see if the copy needs to transit or stay here later.
2721 if ($self->copy->floating) {
2722 my $res = $self->editor->json_query(
2725 'evergreen.can_float',
2726 $self->copy->floating->id,
2727 $self->copy->circ_lib,
2732 $can_float = $U->is_true($res->[0]->{'evergreen.can_float'}) if $res;
2735 # Do copy inventory if necessary.
2736 if ($self->do_inventory_update && ($self->circ_lib == $self->copy->circ_lib || $can_float)) {
2737 my $aci = Fieldmapper::asset::copy_inventory->new();
2738 $aci->inventory_date('now');
2739 $aci->inventory_workstation($self->editor->requestor->wsid);
2740 $aci->copy($self->copy->id());
2741 $self->editor->create_asset_copy_inventory($aci);
2742 $self->checkin_changed(1);
2745 if( $self->checkin_check_holds_shelf() ) {
2746 $self->bail_on_events(OpenILS::Event->new('NO_CHANGE'));
2747 $self->hold($U->fetch_open_hold_by_copy($self->copy->id));
2748 if($self->fake_hold_dest) {
2749 $self->hold->pickup_lib($self->circ_lib);
2751 $self->checkin_flesh_events;
2755 unless( $self->is_renewal ) {
2756 return $self->bail_on_events($self->editor->event)
2757 unless $self->editor->allowed('COPY_CHECKIN');
2760 $self->push_events($self->check_copy_alert());
2761 $self->push_events($self->check_checkin_copy_status());
2763 # if the circ is marked as 'claims returned', add the event to the list
2764 $self->push_events(OpenILS::Event->new('CIRC_CLAIMS_RETURNED'))
2765 if ($self->circ and $self->circ->stop_fines
2766 and $self->circ->stop_fines eq OILS_STOP_FINES_CLAIMSRETURNED);
2768 $self->check_circ_deposit();
2770 # handle the overridable events
2771 $self->override_events unless $self->is_renewal;
2772 return if $self->bail_out;
2775 $self->checkin_handle_circ_start;
2776 return if $self->bail_out;
2778 if (!$dont_change_lost_zero) {
2779 # if this circ is LOST and we are configured to generate overdue
2780 # fines for lost items on checkin (to fill the gap between mark
2781 # lost time and when the fines would have naturally stopped), then
2782 # stop_fines is no longer valid and should be cleared.
2784 # stop_fines will be set again during the handle_fines() stage.
2785 # XXX should this setting come from the copy circ lib (like other
2786 # LOST settings), instead of the circulation circ lib?
2787 if ($stat == OILS_COPY_STATUS_LOST) {
2788 $self->circ->clear_stop_fines if
2789 $U->ou_ancestor_setting_value(
2791 OILS_SETTING_GENERATE_OVERDUE_ON_LOST_RETURN,
2796 # Set stop_fines when claimed never checked out
2797 $self->circ->stop_fines( OILS_STOP_FINES_CLAIMS_NEVERCHECKEDOUT ) if( $self->claims_never_checked_out );
2799 # handle fines for this circ, including overdue gen if needed
2800 $self->handle_fines;
2803 # Void any item deposits if the library wants to
2804 $self->check_circ_deposit(1);
2806 $self->checkin_handle_circ_finish;
2807 return if $self->bail_out;
2808 $self->checkin_changed(1);
2810 } elsif( $self->transit ) {
2811 my $hold_transit = $self->process_received_transit;
2812 $self->checkin_changed(1);
2814 if( $self->bail_out ) {
2815 $self->checkin_flesh_events;
2819 if( my $e = $self->check_checkin_copy_status() ) {
2820 # If the original copy status is special, alert the caller
2821 my $ev = $self->events;
2822 $self->events([$e]);
2823 $self->override_events;
2824 return if $self->bail_out;
2828 if( $hold_transit or
2829 $U->copy_status($self->copy->status)->id
2830 == OILS_COPY_STATUS_ON_HOLDS_SHELF ) {
2833 if( $hold_transit ) {
2834 $hold = $self->editor->retrieve_action_hold_request($hold_transit->hold);
2836 ($hold) = $U->fetch_open_hold_by_copy($self->copy->id);
2841 if( $hold and ( $hold->cancel_time or $hold->fulfillment_time ) ) { # this transited hold was cancelled or filled mid-transit
2843 $logger->info("circulator: we received a transit on a cancelled or filled hold " . $hold->id);
2844 $self->reshelve_copy(1);
2845 $self->cancelled_hold_transit(1);
2846 $self->notify_hold(0); # don't notify for cancelled holds
2847 $self->fake_hold_dest(0);
2848 return if $self->bail_out;
2850 } elsif ($hold and $hold->hold_type eq 'R') {
2852 $self->copy->status(OILS_COPY_STATUS_CATALOGING);
2853 $self->notify_hold(0); # No need to notify
2854 $self->fake_hold_dest(0);
2855 $self->noop(1); # Don't try and capture for other holds/transits now
2856 $self->update_copy();
2857 $hold->fulfillment_time('now');
2858 $self->bail_on_events($self->editor->event)
2859 unless $self->editor->update_action_hold_request($hold);
2863 # hold transited to correct location
2864 if($self->fake_hold_dest) {
2865 $hold->pickup_lib($self->circ_lib);
2867 $self->checkin_flesh_events;
2872 } elsif( $U->copy_status($self->copy->status)->id == OILS_COPY_STATUS_IN_TRANSIT ) {
2874 $logger->warn("circulator: we have a copy ".$self->copy->barcode.
2875 " that is in-transit, but there is no transit.. repairing");
2876 $self->reshelve_copy(1);
2877 return if $self->bail_out;
2880 if( $self->is_renewal ) {
2881 $self->finish_fines_and_voiding;
2882 return if $self->bail_out;
2883 $self->push_events(OpenILS::Event->new('SUCCESS'));
2887 # ------------------------------------------------------------------------------
2888 # Circulations and transits are now closed where necessary. Now go on to see if
2889 # this copy can fulfill a hold or needs to be routed to a different location
2890 # ------------------------------------------------------------------------------
2892 my $needed_for_something = 0; # formerly "needed_for_hold"
2894 if(!$self->noop) { # /not/ a no-op checkin, capture for hold or put item into transit
2896 if (!$self->remote_hold) {
2897 if ($self->use_booking) {
2898 my $potential_hold = $self->hold_capture_is_possible;
2899 my $potential_reservation = $self->reservation_capture_is_possible;
2901 if ($potential_hold and $potential_reservation) {
2902 $logger->info("circulator: item could fulfill either hold or reservation");
2903 $self->push_events(new OpenILS::Event(
2904 "HOLD_RESERVATION_CONFLICT",
2905 "hold" => $potential_hold,
2906 "reservation" => $potential_reservation
2908 return if $self->bail_out;
2909 } elsif ($potential_hold) {
2910 $needed_for_something =
2911 $self->attempt_checkin_hold_capture;
2912 } elsif ($potential_reservation) {
2913 $needed_for_something =
2914 $self->attempt_checkin_reservation_capture;
2917 $needed_for_something = $self->attempt_checkin_hold_capture;
2920 return if $self->bail_out;
2922 unless($needed_for_something) {
2923 my $circ_lib = (ref $self->copy->circ_lib) ?
2924 $self->copy->circ_lib->id : $self->copy->circ_lib;
2926 if( $self->remote_hold ) {
2927 $circ_lib = $self->remote_hold->pickup_lib;
2928 $logger->warn("circulator: Copy ".$self->copy->barcode.
2929 " is on a remote hold's shelf, sending to $circ_lib");
2932 $logger->debug("circulator: circlib=$circ_lib, workstation=".$self->circ_lib);
2934 my $suppress_transit = 0;
2936 if( $circ_lib != $self->circ_lib and not ($self->hold_as_transit and $self->remote_hold) ) {
2937 my $suppress_transit_source = $U->ou_ancestor_setting($self->circ_lib, 'circ.transit.suppress_non_hold');
2938 if($suppress_transit_source && $suppress_transit_source->{value}) {
2939 my $suppress_transit_dest = $U->ou_ancestor_setting($circ_lib, 'circ.transit.suppress_non_hold');
2940 if($suppress_transit_dest && $suppress_transit_source->{value} eq $suppress_transit_dest->{value}) {
2941 $logger->info("circulator: copy is within transit suppress group: ".$self->copy->barcode." ".$suppress_transit_source->{value});
2942 $suppress_transit = 1;
2947 if( $suppress_transit or ( $circ_lib == $self->circ_lib and not ($self->hold_as_transit and $self->remote_hold) ) ) {
2948 # copy is where it needs to be, either for hold or reshelving
2950 $self->checkin_handle_precat();
2951 return if $self->bail_out;
2954 # copy needs to transit "home", or stick here if it's a floating copy
2955 if ($can_float && ($self->manual_float || !$U->is_true($self->copy->floating->manual)) && !$self->remote_hold) { # Yep, floating, stick here
2956 $self->checkin_changed(1);
2957 $self->copy->circ_lib( $self->circ_lib );
2960 my $bc = $self->copy->barcode;
2961 $logger->info("circulator: copy $bc at the wrong location, sending to $circ_lib");
2962 $self->checkin_build_copy_transit($circ_lib);
2963 return if $self->bail_out;
2964 $self->push_events(OpenILS::Event->new('ROUTE_ITEM', org => $circ_lib));
2968 } else { # no-op checkin
2969 # XXX floating items still stick where they are even with no-op checkin?
2970 if ($self->copy->floating && $can_float) {
2971 $self->checkin_changed(1);
2972 $self->copy->circ_lib( $self->circ_lib );
2977 if($self->claims_never_checked_out and
2978 $U->ou_ancestor_setting_value($self->circ->circ_lib, 'circ.claim_never_checked_out.mark_missing')) {
2980 # the item was not supposed to be checked out to the user and should now be marked as missing
2981 my $next_status = $self->next_copy_status->[0] || OILS_COPY_STATUS_MISSING;
2982 $self->copy->status($next_status);
2986 $self->reshelve_copy unless $needed_for_something;
2989 return if $self->bail_out;
2991 unless($self->checkin_changed) {
2993 $self->push_events(OpenILS::Event->new('NO_CHANGE'));
2994 my $stat = $U->copy_status($self->copy->status)->id;
2996 $self->hold($U->fetch_open_hold_by_copy($self->copy->id))
2997 if( $stat == OILS_COPY_STATUS_ON_HOLDS_SHELF );
2998 $self->bail_out(1); # no need to commit anything
3002 $self->push_events(OpenILS::Event->new('SUCCESS'))
3003 unless @{$self->events};
3006 $self->finish_fines_and_voiding;
3008 OpenILS::Utils::Penalty->calculate_penalties(
3009 $self->editor, $self->patron->id, $self->circ_lib) if $self->patron;
3011 $self->checkin_flesh_events;
3015 sub finish_fines_and_voiding {
3017 return unless $self->circ;
3019 return unless $self->backdate or $self->void_overdues;
3021 # void overdues after fine generation to prevent concurrent DB access to overdue billings
3022 my $note = 'System: Amnesty Checkin' if $self->void_overdues;
3024 my $evt = $CC->void_or_zero_overdues(
3025 $self->editor, $self->circ, {backdate => $self->void_overdues ? undef : $self->backdate, note => $note});
3027 return $self->bail_on_events($evt) if $evt;
3029 # Make sure the circ is open or closed as necessary.
3030 $evt = $U->check_open_xact($self->editor, $self->circ->id);
3031 return $self->bail_on_events($evt) if $evt;
3037 # if a deposit was paid for this item, push the event
3038 # if called with a truthy param perform the void, depending on settings
3039 sub check_circ_deposit {
3043 return unless $self->circ;
3045 my $deposit = $self->editor->search_money_billing(
3047 xact => $self->circ->id,
3049 }, {idlist => 1})->[0];
3051 return unless $deposit;
3054 my $void_on_checkin = $U->ou_ancestor_setting_value(
3055 $self->circ_lib,OILS_SETTING_VOID_ITEM_DEPOSIT_ON_CHECKIN,$self->editor);
3056 if ( $void_on_checkin ) {
3057 my $evt = $CC->void_bills($self->editor,[$deposit], "DEPOSIT ITEM RETURNED");
3058 return $evt if $evt;
3060 } else { # if void is unset this is just a check, notify that there was a deposit billing
3061 $self->push_events(OpenILS::Event->new('ITEM_DEPOSIT_PAID', payload => $deposit));
3067 my $force = $self->force || shift;
3068 my $copy = $self->copy;
3070 my $stat = $U->copy_status($copy->status)->id;
3072 my $next_status = $self->next_copy_status->[0] || OILS_COPY_STATUS_RESHELVING;
3075 $stat != OILS_COPY_STATUS_ON_HOLDS_SHELF and
3076 $stat != OILS_COPY_STATUS_CATALOGING and
3077 $stat != OILS_COPY_STATUS_IN_TRANSIT and
3078 $stat != $next_status )) {
3080 $copy->status( $next_status );
3082 $self->checkin_changed(1);
3087 # Returns true if the item is at the current location
3088 # because it was transited there for a hold and the
3089 # hold has not been fulfilled
3090 sub checkin_check_holds_shelf {
3092 return 0 unless $self->copy;
3095 $U->copy_status($self->copy->status)->id ==
3096 OILS_COPY_STATUS_ON_HOLDS_SHELF;
3098 # Attempt to clear shelf expired holds for this copy
3099 $holdcode->method_lookup('open-ils.circ.hold.clear_shelf.process')->run($self->editor->authtoken, $self->circ_lib, $self->copy->id)
3100 if($self->clear_expired);
3102 # find the hold that put us on the holds shelf
3103 my $holds = $self->editor->search_action_hold_request(
3105 current_copy => $self->copy->id,
3106 capture_time => { '!=' => undef },
3107 fulfillment_time => undef,
3108 cancel_time => undef,
3113 $logger->warn("circulator: copy is on-holds-shelf, but there is no hold - reshelving");
3114 $self->reshelve_copy(1);
3118 my $hold = $$holds[0];
3120 $logger->info("circulator: we found a captured, un-fulfilled hold [".
3121 $hold->id. "] for copy ".$self->copy->barcode);
3123 if( $hold->pickup_lib != $self->circ_lib and not $self->hold_as_transit ) {
3124 my $suppress_transit_circ = $U->ou_ancestor_setting($self->circ_lib, 'circ.transit.suppress_hold');
3125 if($suppress_transit_circ && $suppress_transit_circ->{value}) {
3126 my $suppress_transit_pickup = $U->ou_ancestor_setting($hold->pickup_lib, 'circ.transit.suppress_hold');
3127 if($suppress_transit_pickup && $suppress_transit_circ->{value} eq $suppress_transit_pickup->{value}) {
3128 $logger->info("circulator: hold is within hold transit suppress group .. we're done: ".$self->copy->barcode." ".$suppress_transit_circ->{value});
3129 $self->fake_hold_dest(1);
3135 if( $hold->pickup_lib == $self->circ_lib and not $self->hold_as_transit ) {
3136 $logger->info("circulator: hold is for here .. we're done: ".$self->copy->barcode);
3140 $logger->info("circulator: hold is not for here..");
3141 $self->remote_hold($hold);
3146 sub checkin_handle_precat {
3148 my $copy = $self->copy;
3150 if( $self->is_precat and ($copy->status != OILS_COPY_STATUS_CATALOGING) ) {
3151 $copy->status(OILS_COPY_STATUS_CATALOGING);
3152 $self->update_copy();
3153 $self->checkin_changed(1);
3154 $self->push_events(OpenILS::Event->new('ITEM_NOT_CATALOGED'));
3159 sub checkin_build_copy_transit {
3162 my $copy = $self->copy;
3163 my $transit = Fieldmapper::action::transit_copy->new;
3165 # if we are transiting an item to the shelf shelf, it's a hold transit
3166 if (my $hold = $self->remote_hold) {
3167 $transit = Fieldmapper::action::hold_transit_copy->new;
3168 $transit->hold($hold->id);
3170 # the item is going into transit, remove any shelf-iness
3171 if ($hold->current_shelf_lib or $hold->shelf_time) {
3172 $hold->clear_current_shelf_lib;
3173 $hold->clear_shelf_time;
3174 return $self->bail_on_events($self->editor->event)
3175 unless $self->editor->update_action_hold_request($hold);
3179 #$dest ||= (ref($copy->circ_lib)) ? $copy->circ_lib->id : $copy->circ_lib;
3180 $logger->info("circulator: transiting copy to $dest");
3182 $transit->source($self->circ_lib);
3183 $transit->dest($dest);
3184 $transit->target_copy($copy->id);
3185 $transit->source_send_time('now');
3186 $transit->copy_status( $U->copy_status($copy->status)->id );
3188 $logger->debug("circulator: setting copy status on transit: ".$transit->copy_status);
3190 if ($self->remote_hold) {
3191 return $self->bail_on_events($self->editor->event)
3192 unless $self->editor->create_action_hold_transit_copy($transit);
3194 return $self->bail_on_events($self->editor->event)
3195 unless $self->editor->create_action_transit_copy($transit);
3198 # ensure the transit is returned to the caller
3199 $self->transit($transit);
3201 $copy->status(OILS_COPY_STATUS_IN_TRANSIT);
3203 $self->checkin_changed(1);
3207 sub hold_capture_is_possible {
3209 my $copy = $self->copy;
3211 # we've been explicitly told not to capture any holds
3212 return 0 if $self->capture eq 'nocapture';
3214 # See if this copy can fulfill any holds
3215 my $hold = $holdcode->find_nearest_permitted_hold(
3216 $self->editor, $copy, $self->editor->requestor, 1 # check_only
3218 return undef if ref $hold eq "HASH" and
3219 $hold->{"textcode"} eq "ACTION_HOLD_REQUEST_NOT_FOUND";
3223 sub reservation_capture_is_possible {
3225 my $copy = $self->copy;
3227 # we've been explicitly told not to capture any holds
3228 return 0 if $self->capture eq 'nocapture';
3230 my $booking_ses = OpenSRF::AppSession->connect("open-ils.booking");
3231 my $resv = $booking_ses->request(
3232 "open-ils.booking.reservations.could_capture",
3233 $self->editor->authtoken, $copy->barcode
3235 $booking_ses->disconnect;
3236 if (ref($resv) eq "HASH" and exists $resv->{"textcode"}) {
3237 $self->push_events($resv);
3243 # returns true if the item was used (or may potentially be used
3244 # in subsequent calls) to capture a hold.
3245 sub attempt_checkin_hold_capture {
3247 my $copy = $self->copy;
3249 # we've been explicitly told not to capture any holds
3250 return 0 if $self->capture eq 'nocapture';
3252 # See if this copy can fulfill any holds
3253 my ($hold, undef, $retarget) = $holdcode->find_nearest_permitted_hold(
3254 $self->editor, $copy, $self->editor->requestor );
3257 $logger->debug("circulator: no potential permitted".
3258 "holds found for copy ".$copy->barcode);
3262 if($self->capture ne 'capture') {
3263 # see if this item is in a hold-capture-delay location
3264 my $location = $self->copy->location;
3265 if(!ref($location)) {
3266 $location = $self->editor->retrieve_asset_copy_location($self->copy->location);
3267 $self->copy->location($location);
3269 if($U->is_true($location->hold_verify)) {
3270 $self->bail_on_events(
3271 OpenILS::Event->new('HOLD_CAPTURE_DELAYED', copy_location => $location));
3276 $self->retarget($retarget);
3278 my $suppress_transit = 0;
3279 if( $hold->pickup_lib != $self->circ_lib and not $self->hold_as_transit ) {
3280 my $suppress_transit_circ = $U->ou_ancestor_setting($self->circ_lib, 'circ.transit.suppress_hold');
3281 if($suppress_transit_circ && $suppress_transit_circ->{value}) {
3282 my $suppress_transit_pickup = $U->ou_ancestor_setting($hold->pickup_lib, 'circ.transit.suppress_hold');
3283 if($suppress_transit_pickup && $suppress_transit_circ->{value} eq $suppress_transit_pickup->{value}) {
3284 $suppress_transit = 1;
3285 $hold->pickup_lib($self->circ_lib);
3290 $logger->info("circulator: found permitted hold ".$hold->id." for copy, capturing...");
3292 $hold->current_copy($copy->id);
3293 $hold->capture_time('now');
3294 $self->put_hold_on_shelf($hold)
3295 if ($suppress_transit || ($hold->pickup_lib == $self->circ_lib and not $self->hold_as_transit) );
3297 # prevent DB errors caused by fetching
3298 # holds from storage, and updating through cstore
3299 $hold->clear_fulfillment_time;
3300 $hold->clear_fulfillment_staff;
3301 $hold->clear_fulfillment_lib;
3302 $hold->clear_expire_time;
3303 $hold->clear_cancel_time;
3304 $hold->clear_prev_check_time unless $hold->prev_check_time;
3306 $self->bail_on_events($self->editor->event)
3307 unless $self->editor->update_action_hold_request($hold);
3309 $self->checkin_changed(1);
3311 return 0 if $self->bail_out;
3313 if( $suppress_transit or ( $hold->pickup_lib == $self->circ_lib && not $self->hold_as_transit ) ) {
3315 if ($hold->hold_type eq 'R') {
3316 $copy->status(OILS_COPY_STATUS_CATALOGING);
3317 $hold->fulfillment_time('now');
3318 $self->noop(1); # Block other transit/hold checks
3319 $self->bail_on_events($self->editor->event)
3320 unless $self->editor->update_action_hold_request($hold);
3322 # This hold was captured in the correct location
3323 $copy->status(OILS_COPY_STATUS_ON_HOLDS_SHELF);
3324 $self->push_events(OpenILS::Event->new('SUCCESS'));
3326 #$self->do_hold_notify($hold->id);
3327 $self->notify_hold($hold->id);
3332 # Hold needs to be picked up elsewhere. Build a hold
3333 # transit and route the item.
3334 $self->checkin_build_hold_transit();
3335 $copy->status(OILS_COPY_STATUS_IN_TRANSIT);
3336 return 0 if $self->bail_out;
3337 $self->push_events(OpenILS::Event->new('ROUTE_ITEM', org => $hold->pickup_lib));
3340 # make sure we save the copy status
3342 return 0 if $copy->status == OILS_COPY_STATUS_CATALOGING;
3346 sub attempt_checkin_reservation_capture {
3348 my $copy = $self->copy;
3350 # we've been explicitly told not to capture any holds
3351 return 0 if $self->capture eq 'nocapture';
3353 my $booking_ses = OpenSRF::AppSession->connect("open-ils.booking");
3354 my $evt = $booking_ses->request(
3355 "open-ils.booking.resources.capture_for_reservation",
3356 $self->editor->authtoken,
3358 1 # don't update copy - we probably have it locked
3360 $booking_ses->disconnect;
3362 if (ref($evt) ne "HASH" or not exists $evt->{"textcode"}) {
3364 "open-ils.booking.resources.capture_for_reservation " .
3365 "didn't return an event!"
3369 $evt->{"textcode"} eq "RESERVATION_NOT_FOUND" and
3370 $evt->{"payload"}->{"fail_cause"} eq "not-transferable"
3372 # not-transferable is an error event we'll pass on the user
3373 $logger->warn("reservation capture attempted against non-transferable item");
3374 $self->push_events($evt);
3376 } elsif ($evt->{"textcode"} eq "SUCCESS") {
3377 # Re-retrieve copy as reservation capture may have changed
3378 # its status and whatnot.
3380 "circulator: booking capture win on copy " . $self->copy->id
3382 if (my $new_copy_status = $evt->{"payload"}->{"new_copy_status"}) {
3384 "circulator: changing copy " . $self->copy->id .
3385 "'s status from " . $self->copy->status . " to " .
3388 $self->copy->status($new_copy_status);
3391 $self->reservation($evt->{"payload"}->{"reservation"});
3393 if (exists $evt->{"payload"}->{"transit"}) {
3397 "org" => $evt->{"payload"}->{"transit"}->dest
3401 $self->checkin_changed(1);
3405 # other results are treated as "nothing to capture"
3409 sub do_hold_notify {
3410 my( $self, $holdid ) = @_;
3412 my $e = new_editor(xact => 1);
3413 my $hold = $e->retrieve_action_hold_request($holdid) or return $e->die_event;
3415 my $ses = OpenSRF::AppSession->create('open-ils.trigger');
3416 $ses->request('open-ils.trigger.event.autocreate', 'hold.available', $hold, $hold->pickup_lib);
3418 $logger->info("circulator: running delayed hold notify process");
3420 # my $notifier = OpenILS::Application::Circ::HoldNotify->new(
3421 # hold_id => $holdid, editor => new_editor(requestor=>$self->editor->requestor));
3423 my $notifier = OpenILS::Application::Circ::HoldNotify->new(
3424 hold_id => $holdid, requestor => $self->editor->requestor);
3426 $logger->debug("circulator: built hold notifier");
3428 if(!$notifier->event) {
3430 $logger->info("circulator: attempt at sending hold notification for hold $holdid");
3432 my $stat = $notifier->send_email_notify;
3433 if( $stat == '1' ) {
3434 $logger->info("circulator: hold notify succeeded for hold $holdid");
3438 $logger->debug("circulator: * hold notify cancelled or failed for hold $holdid");
3441 $logger->info("circulator: Not sending hold notification since the patron has no email address");
3445 sub retarget_holds {
3447 $logger->info("circulator: retargeting holds @{$self->retarget} after opportunistic capture");
3448 my $ses = OpenSRF::AppSession->create('open-ils.hold-targeter');
3449 $ses->request('open-ils.hold-targeter.target', {hold => $self->retarget});
3450 # no reason to wait for the return value
3454 sub checkin_build_hold_transit {
3457 my $copy = $self->copy;
3458 my $hold = $self->hold;
3459 my $trans = Fieldmapper::action::hold_transit_copy->new;
3461 $logger->debug("circulator: building hold transit for ".$copy->barcode);
3463 $trans->hold($hold->id);
3464 $trans->source($self->circ_lib);
3465 $trans->dest($hold->pickup_lib);
3466 $trans->source_send_time("now");
3467 $trans->target_copy($copy->id);
3469 # when the copy gets to its destination, it will recover
3470 # this status - put it onto the holds shelf
3471 $trans->copy_status(OILS_COPY_STATUS_ON_HOLDS_SHELF);
3473 return $self->bail_on_events($self->editor->event)
3474 unless $self->editor->create_action_hold_transit_copy($trans);
3479 sub process_received_transit {
3481 my $copy = $self->copy;
3482 my $copyid = $self->copy->id;
3484 my $status_name = $U->copy_status($copy->status)->name;
3485 $logger->debug("circulator: attempting transit receive on ".
3486 "copy $copyid. Copy status is $status_name");
3488 my $transit = $self->transit;
3490 # Check if we are in a transit suppress range
3491 my $suppress_transit = 0;
3492 if ( $transit->dest != $self->circ_lib and not ( $self->hold_as_transit and $transit->copy_status == OILS_COPY_STATUS_ON_HOLDS_SHELF ) ) {
3493 my $suppress_setting = ($transit->copy_status == OILS_COPY_STATUS_ON_HOLDS_SHELF ? 'circ.transit.suppress_hold' : 'circ.transit.suppress_non_hold');
3494 my $suppress_transit_circ = $U->ou_ancestor_setting($self->circ_lib, $suppress_setting);
3495 if($suppress_transit_circ && $suppress_transit_circ->{value}) {
3496 my $suppress_transit_dest = $U->ou_ancestor_setting($transit->dest, $suppress_setting);
3497 if($suppress_transit_dest && $suppress_transit_dest->{value} eq $suppress_transit_circ->{value}) {
3498 $suppress_transit = 1;
3499 $self->fake_hold_dest(1) if $transit->copy_status == OILS_COPY_STATUS_ON_HOLDS_SHELF;
3503 if( not $suppress_transit and ( $transit->dest != $self->circ_lib or ($self->hold_as_transit && $transit->copy_status == OILS_COPY_STATUS_ON_HOLDS_SHELF) ) ) {
3504 # - this item is in-transit to a different location
3505 # - Or we are capturing holds as transits, so why create a new transit?
3507 my $tid = $transit->id;
3508 my $loc = $self->circ_lib;
3509 my $dest = $transit->dest;
3511 $logger->info("circulator: Fowarding transit on copy which is destined ".
3512 "for a different location. transit=$tid, copy=$copyid, current ".
3513 "location=$loc, destination location=$dest");
3515 my $evt = OpenILS::Event->new('ROUTE_ITEM', org => $dest, payload => {});
3517 # grab the associated hold object if available
3518 my $ht = $self->editor->retrieve_action_hold_transit_copy($tid);
3519 $self->hold($self->editor->retrieve_action_hold_request($ht->hold)) if $ht;
3521 return $self->bail_on_events($evt);
3524 # The transit is received, set the receive time
3525 $transit->dest_recv_time('now');
3526 $self->bail_on_events($self->editor->event)
3527 unless $self->editor->update_action_transit_copy($transit);
3529 my $hold_transit = $self->editor->retrieve_action_hold_transit_copy($transit->id);
3531 $logger->info("circulator: Recovering original copy status in transit: ".$transit->copy_status);
3532 $copy->status( $transit->copy_status );
3533 $self->update_copy();
3534 return if $self->bail_out;
3538 my $hold = $self->editor->retrieve_action_hold_request($hold_transit->hold);
3541 # hold has arrived at destination, set shelf time
3542 $self->put_hold_on_shelf($hold);
3543 $self->bail_on_events($self->editor->event)
3544 unless $self->editor->update_action_hold_request($hold);
3545 return if $self->bail_out;
3547 $self->notify_hold($hold_transit->hold);
3550 $hold_transit = undef;
3551 $self->cancelled_hold_transit(1);
3552 $self->reshelve_copy(1);
3553 $self->fake_hold_dest(0);
3558 OpenILS::Event->new(
3561 payload => { transit => $transit, holdtransit => $hold_transit } ));
3563 return $hold_transit;
3567 # ------------------------------------------------------------------
3568 # Sets the shelf_time and shelf_expire_time for a newly shelved hold
3569 # ------------------------------------------------------------------
3570 sub put_hold_on_shelf {
3571 my($self, $hold) = @_;
3572 $hold->shelf_time('now');
3573 $hold->current_shelf_lib($self->circ_lib);
3574 $holdcode->set_hold_shelf_expire_time($hold, $self->editor);
3580 my $reservation = shift;
3581 my $dt_parser = DateTime::Format::ISO8601->new;
3583 my $obj = $reservation ? $self->reservation : $self->circ;
3585 my $lost_bill_opts = $self->lost_bill_options;
3586 my $circ_lib = $lost_bill_opts->{circ_lib} if $lost_bill_opts;
3587 # first, restore any voided overdues for lost, if needed
3588 if ($self->needs_lost_bill_handling and !$self->void_overdues) {
3589 my $restore_od = $U->ou_ancestor_setting_value(
3590 $circ_lib, $lost_bill_opts->{ous_restore_overdue},
3591 $self->editor) || 0;
3592 $self->checkin_handle_lost_or_lo_now_found_restore_od($circ_lib)
3596 # next, handle normal overdue generation and apply stop_fines
3597 # XXX reservations don't have stop_fines
3598 # TODO revisit booking_reservation re: stop_fines support
3599 if ($reservation or !$obj->stop_fines) {
3602 # This is a crude check for whether we are in a grace period. The code
3603 # in generate_fines() does a more thorough job, so this exists solely
3604 # as a small optimization, and might be better off removed.
3606 # If we have a grace period
3607 if($obj->can('grace_period')) {
3608 # Parse out the due date
3609 my $due_date = $dt_parser->parse_datetime( clean_ISO8601($obj->due_date) );
3610 # Add the grace period to the due date
3611 $due_date->add(seconds => OpenILS::Utils::DateTime->interval_to_seconds($obj->grace_period));
3612 # Don't generate fines on circs still in grace period
3613 $skip_for_grace = $due_date > DateTime->now;
3615 $CC->generate_fines({circs => [$obj], editor => $self->editor})
3616 unless $skip_for_grace;
3618 if (!$reservation and !$obj->stop_fines) {
3619 $obj->stop_fines(OILS_STOP_FINES_CHECKIN);
3620 $obj->stop_fines(OILS_STOP_FINES_RENEW) if $self->is_renewal;
3621 $obj->stop_fines(OILS_STOP_FINES_CLAIMS_NEVERCHECKEDOUT) if $self->claims_never_checked_out;
3622 $obj->stop_fines_time('now');
3623 $obj->stop_fines_time($self->backdate) if $self->backdate;
3624 $self->editor->update_action_circulation($obj);
3628 # finally, handle voiding of lost item and processing fees
3629 if ($self->needs_lost_bill_handling) {
3630 my $void_cost = $U->ou_ancestor_setting_value(
3631 $circ_lib, $lost_bill_opts->{ous_void_item_cost},
3632 $self->editor) || 0;
3633 my $void_proc_fee = $U->ou_ancestor_setting_value(
3634 $circ_lib, $lost_bill_opts->{ous_void_proc_fee},
3635 $self->editor) || 0;
3636 $self->checkin_handle_lost_or_lo_now_found(
3637 $lost_bill_opts->{void_cost_btype},
3638 $lost_bill_opts->{is_longoverdue}) if $void_cost;
3639 $self->checkin_handle_lost_or_lo_now_found(
3640 $lost_bill_opts->{void_fee_btype},
3641 $lost_bill_opts->{is_longoverdue}) if $void_proc_fee;
3647 sub checkin_handle_circ_start {
3649 my $circ = $self->circ;
3650 my $copy = $self->copy;
3654 $self->backdate($circ->xact_start) if $self->claims_never_checked_out;
3656 # backdate the circ if necessary
3657 if($self->backdate) {
3658 my $evt = $self->checkin_handle_backdate;
3659 return $self->bail_on_events($evt) if $evt;
3662 # Set the checkin vars since we have the item
3663 $circ->checkin_time( ($self->backdate) ? $self->backdate : 'now' );
3665 # capture the true scan time for back-dated checkins
3666 $circ->checkin_scan_time('now');
3668 $circ->checkin_staff($self->editor->requestor->id);
3669 $circ->checkin_lib($self->circ_lib);
3670 $circ->checkin_workstation($self->editor->requestor->wsid);
3672 my $circ_lib = (ref $self->copy->circ_lib) ?
3673 $self->copy->circ_lib->id : $self->copy->circ_lib;
3674 my $stat = $U->copy_status($self->copy->status)->id;
3676 if ($stat == OILS_COPY_STATUS_LOST || $stat == OILS_COPY_STATUS_LOST_AND_PAID) {
3677 # we will now handle lost fines, but the copy will retain its 'lost'
3678 # status if it needs to transit home unless lost_immediately_available
3681 # if we decide to also delay fine handling until the item arrives home,
3682 # we will need to call lost fine handling code both when checking items
3683 # in and also when receiving transits
3684 $self->checkin_handle_lost($circ_lib);
3685 } elsif ($stat == OILS_COPY_STATUS_LONG_OVERDUE) {
3686 # same process as above.
3687 $self->checkin_handle_long_overdue($circ_lib);
3688 } elsif ($circ_lib != $self->circ_lib and $stat == OILS_COPY_STATUS_MISSING) {
3689 $logger->info("circulator: not updating copy status on checkin because copy is missing");
3691 my $next_status = $self->next_copy_status->[0] || OILS_COPY_STATUS_RESHELVING;
3692 $self->copy->status($U->copy_status($next_status));
3699 sub checkin_handle_circ_finish {
3701 my $e = $self->editor;
3702 my $circ = $self->circ;
3704 # Do one last check before the final circulation update to see
3705 # if the xact_finish value should be set or not.
3707 # The underlying money.billable_xact may have been updated to
3708 # reflect a change in xact_finish during checkin bills handling,
3709 # however we can't simply refresh the circulation from the DB,
3710 # because other changes may be pending. Instead, reproduce the
3711 # xact_finish check here. It won't hurt to do it again.
3713 my $sum = $e->retrieve_money_billable_transaction_summary($circ->id);
3714 if ($sum) { # is this test still needed?
3716 my $balance = $sum->balance_owed;
3718 if ($balance == 0) {
3719 $circ->xact_finish('now');
3721 $circ->clear_xact_finish;
3724 $logger->info("circulator: $balance is owed on this circulation");
3727 return $self->bail_on_events($e->event)
3728 unless $e->update_action_circulation($circ);
3733 # ------------------------------------------------------------------
3734 # See if we need to void billings, etc. for lost checkin
3735 # ------------------------------------------------------------------
3736 sub checkin_handle_lost {
3738 my $circ_lib = shift;
3740 my $max_return = $U->ou_ancestor_setting_value($circ_lib,
3741 OILS_SETTING_MAX_ACCEPT_RETURN_OF_LOST, $self->editor) || 0;
3743 $self->lost_bill_options({
3744 circ_lib => $circ_lib,
3745 ous_void_item_cost => OILS_SETTING_VOID_LOST_ON_CHECKIN,
3746 ous_void_proc_fee => OILS_SETTING_VOID_LOST_PROCESS_FEE_ON_CHECKIN,
3747 ous_restore_overdue => OILS_SETTING_RESTORE_OVERDUE_ON_LOST_RETURN,
3748 void_cost_btype => 3,
3752 return $self->checkin_handle_lost_or_longoverdue(
3753 circ_lib => $circ_lib,
3754 max_return => $max_return,
3755 ous_immediately_available => OILS_SETTING_LOST_IMMEDIATELY_AVAILABLE,
3756 ous_use_last_activity => undef # not supported for LOST checkin
3760 # ------------------------------------------------------------------
3761 # See if we need to void billings, etc. for long-overdue checkin
3762 # note: not using constants below since they serve little purpose
3763 # for single-use strings that are descriptive in their own right
3764 # and mostly just complicate debugging.
3765 # ------------------------------------------------------------------
3766 sub checkin_handle_long_overdue {
3768 my $circ_lib = shift;
3770 $logger->info("circulator: processing long-overdue checkin...");
3772 my $max_return = $U->ou_ancestor_setting_value($circ_lib,
3773 'circ.max_accept_return_of_longoverdue', $self->editor) || 0;
3775 $self->lost_bill_options({
3776 circ_lib => $circ_lib,
3777 ous_void_item_cost => 'circ.void_longoverdue_on_checkin',
3778 ous_void_proc_fee => 'circ.void_longoverdue_proc_fee_on_checkin',
3779 is_longoverdue => 1,
3780 ous_restore_overdue => 'circ.restore_overdue_on_longoverdue_return',
3781 void_cost_btype => 10,
3782 void_fee_btype => 11
3785 return $self->checkin_handle_lost_or_longoverdue(
3786 circ_lib => $circ_lib,
3787 max_return => $max_return,
3788 ous_immediately_available => 'circ.longoverdue_immediately_available',
3789 ous_use_last_activity =>
3790 'circ.longoverdue.use_last_activity_date_on_return'
3794 # last billing activity is last payment time, last billing time, or the
3795 # circ due date. If the relevant "use last activity" org unit setting is
3796 # false/unset, then last billing activity is always the due date.
3797 sub get_circ_last_billing_activity {
3799 my $circ_lib = shift;
3800 my $setting = shift;
3801 my $date = $self->circ->due_date;
3803 return $date unless $setting and
3804 $U->ou_ancestor_setting_value($circ_lib, $setting, $self->editor);
3806 my $xact = $self->editor->retrieve_money_billable_transaction([
3808 {flesh => 1, flesh_fields => {mbt => ['summary']}}
3811 if ($xact->summary) {
3812 $date = $xact->summary->last_payment_ts ||
3813 $xact->summary->last_billing_ts ||
3814 $self->circ->due_date;
3821 sub checkin_handle_lost_or_longoverdue {
3822 my ($self, %args) = @_;
3824 my $circ = $self->circ;
3825 my $max_return = $args{max_return};
3826 my $circ_lib = $args{circ_lib};
3831 $self->get_circ_last_billing_activity(
3832 $circ_lib, $args{ous_use_last_activity});
3835 my @tm = reverse($last_activity =~ /([\d\.]+)/og);
3836 $tm[5] -= 1 if $tm[5] > 0;
3837 my $due = timelocal(int($tm[1]), int($tm[2]),
3838 int($tm[3]), int($tm[4]), int($tm[5]), int($tm[6]));
3841 OpenILS::Utils::DateTime->interval_to_seconds($max_return) + int($due);
3843 $logger->info("MAX OD: $max_return LAST ACTIVITY: ".
3844 "$last_activity DUEDATE: ".$circ->due_date." TODAY: $today ".
3845 "DUE: $due LAST: $last_chance");
3847 $max_return = 0 if $today < $last_chance;
3853 $logger->info("circulator: check-in of lost/lo item exceeds max ".
3854 "return interval. skipping fine/fee voiding, etc.");
3856 } elsif ($self->dont_change_lost_zero) { # we leave lost zero balance alone
3858 $logger->info("circulator: check-in of lost/lo item having a balance ".
3859 "of zero, skipping fine/fee voiding and reinstatement.");
3861 } else { # within max-return interval or no interval defined
3863 $logger->info("circulator: check-in of lost/lo item is within the ".
3864 "max return interval (or no interval is defined). Proceeding ".
3865 "with fine/fee voiding, etc.");
3867 $self->needs_lost_bill_handling(1);
3870 if ($circ_lib != $self->circ_lib) {
3871 # if the item is not home, check to see if we want to retain the
3872 # lost/longoverdue status at this point in the process
3874 my $immediately_available = $U->ou_ancestor_setting_value($circ_lib,
3875 $args{ous_immediately_available}, $self->editor) || 0;
3877 if ($immediately_available) {
3878 # item status does not need to be retained, so give it a
3879 # reshelving status as if it were a normal checkin
3880 my $next_status = $self->next_copy_status->[0] || OILS_COPY_STATUS_RESHELVING;
3881 $self->copy->status($U->copy_status($next_status));
3884 $logger->info("circulator: leaving lost/longoverdue copy".
3885 " status in place on checkin");
3888 # lost/longoverdue item is home and processed, treat like a normal
3889 # checkin from this point on
3890 my $next_status = $self->next_copy_status->[0] || OILS_COPY_STATUS_RESHELVING;
3891 $self->copy->status($U->copy_status($next_status));
3897 sub checkin_handle_backdate {
3900 # ------------------------------------------------------------------
3901 # clean up the backdate for date comparison
3902 # XXX We are currently taking the due-time from the original due-date,
3903 # not the input. Do we need to do this? This certainly interferes with
3904 # backdating of hourly checkouts, but that is likely a very rare case.
3905 # ------------------------------------------------------------------
3906 my $bd = clean_ISO8601($self->backdate);
3907 my $original_date = DateTime::Format::ISO8601->new->parse_datetime(clean_ISO8601($self->circ->due_date));
3908 my $new_date = DateTime::Format::ISO8601->new->parse_datetime($bd);
3909 $new_date->set_hour($original_date->hour());
3910 $new_date->set_minute($original_date->minute());
3911 if ($new_date >= DateTime->now) {
3912 # We can't say that the item will be checked in later...so assume someone's clock is wrong instead.
3913 # $self->backdate() autoload handler ignores undef values.
3914 # Clear the backdate manually.
3915 $logger->info("circulator: ignoring future backdate: $new_date");
3916 delete $self->{backdate};
3918 $self->backdate(clean_ISO8601($new_date->datetime()));
3925 sub check_checkin_copy_status {
3927 my $copy = $self->copy;
3929 my $status = $U->copy_status($copy->status)->id;
3932 if( $self->new_copy_alerts ||
3933 $status == OILS_COPY_STATUS_AVAILABLE ||
3934 $status == OILS_COPY_STATUS_CHECKED_OUT ||
3935 $status == OILS_COPY_STATUS_IN_PROCESS ||
3936 $status == OILS_COPY_STATUS_ON_HOLDS_SHELF ||
3937 $status == OILS_COPY_STATUS_IN_TRANSIT ||
3938 $status == OILS_COPY_STATUS_CATALOGING ||
3939 $status == OILS_COPY_STATUS_ON_RESV_SHELF ||
3940 $status == OILS_COPY_STATUS_CANCELED_TRANSIT ||
3941 $status == OILS_COPY_STATUS_RESHELVING );
3943 return OpenILS::Event->new('COPY_STATUS_LOST', payload => $copy )
3944 if( $status == OILS_COPY_STATUS_LOST );
3946 return OpenILS::Event->new('COPY_STATUS_LOST_AND_PAID', payload => $copy)
3947 if ($status == OILS_COPY_STATUS_LOST_AND_PAID);
3949 return OpenILS::Event->new('COPY_STATUS_LONG_OVERDUE', payload => $copy )
3950 if( $status == OILS_COPY_STATUS_LONG_OVERDUE );
3952 return OpenILS::Event->new('COPY_STATUS_MISSING', payload => $copy )
3953 if( $status == OILS_COPY_STATUS_MISSING );
3955 return OpenILS::Event->new('COPY_BAD_STATUS', payload => $copy );
3960 # --------------------------------------------------------------------------
3961 # On checkin, we need to return as many relevant objects as we can
3962 # --------------------------------------------------------------------------
3963 sub checkin_flesh_events {
3966 if( grep { $_->{textcode} eq 'SUCCESS' } @{$self->events}
3967 and grep { $_->{textcode} eq 'ITEM_NOT_CATALOGED' } @{$self->events} ) {
3968 $self->events([grep { $_->{textcode} eq 'ITEM_NOT_CATALOGED' } @{$self->events}]);
3971 my $record = $U->record_to_mvr($self->title) if($self->title and !$self->is_precat);
3974 if($self->hold and !$self->hold->cancel_time) {
3975 $hold = $self->hold;
3976 $hold->notes($self->editor->search_action_hold_request_note({hold => $hold->id}));
3980 # update our copy of the circ object and
3981 # flesh the billing summary data
3983 $self->editor->retrieve_action_circulation([
3987 circ => ['billable_transaction'],
3996 # flesh some patron fields before returning
3998 $self->editor->retrieve_actor_user([
4003 au => ['card', 'billing_address', 'mailing_address']
4010 # Flesh the latest inventory.
4011 # NB: This survives the unflesh_copy below. Let's keep it that way.
4012 my $alci = $self->editor->search_asset_latest_inventory([
4013 {copy=>$self->copy->id},
4016 alci => ['inventory_workstation']
4018 if ($alci && $alci->[0]) {
4019 $self->copy->latest_inventory($alci->[0]);
4022 for my $evt (@{$self->events}) {
4025 $payload->{copy} = $U->unflesh_copy($self->copy);
4026 $payload->{volume} = $self->volume;
4027 $payload->{record} = $record,
4028 $payload->{circ} = $self->circ;
4029 $payload->{transit} = $self->transit;
4030 $payload->{cancelled_hold_transit} = 1 if $self->cancelled_hold_transit;
4031 $payload->{hold} = $hold;
4032 $payload->{patron} = $self->patron;
4033 $payload->{reservation} = $self->reservation
4034 unless (not $self->reservation or $self->reservation->cancel_time);
4036 $evt->{payload} = $payload;
4041 my( $self, $msg ) = @_;
4042 my $bc = ($self->copy) ? $self->copy->barcode :
4045 my $usr = ($self->patron) ? $self->patron->id : "";
4046 $logger->info("circulator: $msg requestor=".$self->editor->requestor->id.
4047 ", recipient=$usr, copy=$bc");
4054 $self->log_me("do_renew()");
4056 # Make sure there is an open circ to renew
4057 my $usrid = $self->patron->id if $self->patron;
4058 my $circ = $self->editor->search_action_circulation({
4059 target_copy => $self->copy->id,
4060 xact_finish => undef,
4061 checkin_time => undef,
4062 ($usrid ? (usr => $usrid) : ())
4065 return $self->bail_on_events($self->editor->event) unless $circ;
4067 # A user is not allowed to renew another user's items without permission
4068 unless( $circ->usr eq $self->editor->requestor->id ) {
4069 return $self->bail_on_events($self->editor->events)
4070 unless $self->editor->allowed('RENEW_CIRC', $circ->circ_lib);
4073 $self->push_events(OpenILS::Event->new('MAX_RENEWALS_REACHED'))
4074 if $circ->renewal_remaining < 1;
4076 $self->push_events(OpenILS::Event->new('MAX_AUTO_RENEWALS_REACHED'))
4077 if $self->auto_renewal and $circ->auto_renewal_remaining < 1;
4078 # -----------------------------------------------------------------
4080 $self->parent_circ($circ->id);
4081 $self->renewal_remaining( $circ->renewal_remaining - 1 );
4082 $self->auto_renewal_remaining( $circ->auto_renewal_remaining - 1 ) if (defined($circ->auto_renewal_remaining));
4085 # Opac renewal - re-use circ library from original circ (unless told not to)
4086 if($self->opac_renewal or $self->auto_renewal) {
4087 unless(defined($opac_renewal_use_circ_lib)) {
4088 my $use_circ_lib = $self->editor->retrieve_config_global_flag('circ.opac_renewal.use_original_circ_lib');
4089 if($use_circ_lib and $U->is_true($use_circ_lib->enabled)) {
4090 $opac_renewal_use_circ_lib = 1;
4093 $opac_renewal_use_circ_lib = 0;
4096 $self->circ_lib($circ->circ_lib) if($opac_renewal_use_circ_lib);
4099 # Desk renewal - re-use circ library from original circ (unless told not to)
4100 if($self->desk_renewal) {
4101 unless(defined($desk_renewal_use_circ_lib)) {
4102 my $use_circ_lib = $self->editor->retrieve_config_global_flag('circ.desk_renewal.use_original_circ_lib');
4103 if($use_circ_lib and $U->is_true($use_circ_lib->enabled)) {
4104 $desk_renewal_use_circ_lib = 1;
4107 $desk_renewal_use_circ_lib = 0;
4110 $self->circ_lib($circ->circ_lib) if($desk_renewal_use_circ_lib);
4113 # Check if expired patron is allowed to renew, and bail if not.
4114 my $expire = DateTime::Format::ISO8601->new->parse_datetime(clean_ISO8601($self->patron->expire_date));
4115 if (CORE::time > $expire->epoch) {
4116 my $allow_renewal = $U->ou_ancestor_setting_value($self->circ_lib, OILS_SETTING_ALLOW_RENEW_FOR_EXPIRED_PATRON);
4117 unless ($U->is_true($allow_renewal)) {
4118 return $self->bail_on_events(OpenILS::Event->new('PATRON_ACCOUNT_EXPIRED'));
4122 # Run the fine generator against the old circ
4123 # XXX This seems unnecessary, given that handle_fines runs in do_checkin
4124 # a few lines down. Commenting out, for now.
4125 #$self->handle_fines;
4127 $self->run_renew_permit;
4130 $self->do_checkin();
4131 return if $self->bail_out;
4133 unless( $self->permit_override ) {
4135 return if $self->bail_out;
4136 $self->is_precat(1) if $self->have_event('ITEM_NOT_CATALOGED');
4137 $self->remove_event('ITEM_NOT_CATALOGED');
4140 $self->override_events;
4141 return if $self->bail_out;
4144 $self->do_checkout();
4149 my( $self, $evt ) = @_;
4150 $evt = (ref $evt) ? $evt->{textcode} : $evt;
4151 $logger->debug("circulator: removing event from list: $evt");
4152 my @events = @{$self->events};
4153 $self->events( [ grep { $_->{textcode} ne $evt } @events ] );
4158 my( $self, $evt ) = @_;
4159 $evt = (ref $evt) ? $evt->{textcode} : $evt;
4160 return grep { $_->{textcode} eq $evt } @{$self->events};
4164 sub run_renew_permit {
4167 if ($U->ou_ancestor_setting_value($self->circ_lib, 'circ.block_renews_for_holds')) {
4168 my ($hold, undef, $retarget) = $holdcode->find_nearest_permitted_hold(
4169 $self->editor, $self->copy, $self->editor->requestor, 1
4171 $self->push_events(new OpenILS::Event("COPY_NEEDED_FOR_HOLD")) if $hold;
4174 my $results = $self->run_indb_circ_test;
4175 $self->push_events($self->matrix_test_result_events)
4176 unless $self->circ_test_success;
4180 # XXX: The primary mechanism for storing circ history is now handled
4181 # by tracking real circulation objects instead of bibs in a bucket.
4182 # However, this code is disabled by default and could be useful
4183 # some day, so may as well leave it for now.
4184 sub append_reading_list {
4188 $self->is_checkout and
4194 # verify history is globally enabled and uses the bucket mechanism
4195 my $htype = OpenSRF::Utils::SettingsClient->new->config_value(
4196 apps => 'open-ils.circ' => app_settings => 'checkout_history_mechanism');
4198 return undef unless $htype and $htype eq 'bucket';
4200 my $e = new_editor(xact => 1, requestor => $self->editor->requestor);
4202 # verify the patron wants to retain the hisory
4203 my $setting = $e->search_actor_user_setting(
4204 {usr => $self->patron->id, name => 'circ.keep_checkout_history'})->[0];
4206 unless($setting and $setting->value) {
4211 my $bkt = $e->search_container_copy_bucket(
4212 {owner => $self->patron->id, btype => 'circ_history'})->[0];
4217 # find the next item position
4218 my $last_item = $e->search_container_copy_bucket_item(
4219 {bucket => $bkt->id}, {order_by => {ccbi => 'pos desc'}, limit => 1})->[0];
4220 $pos = $last_item->pos + 1 if $last_item;
4223 # create the history bucket if necessary
4224 $bkt = Fieldmapper::container::copy_bucket->new;
4225 $bkt->owner($self->patron->id);
4227 $bkt->btype('circ_history');
4229 $e->create_container_copy_bucket($bkt) or return $e->die_event;
4232 my $item = Fieldmapper::container::copy_bucket_item->new;
4234 $item->bucket($bkt->id);
4235 $item->target_copy($self->copy->id);
4238 $e->create_container_copy_bucket_item($item) or return $e->die_event;
4245 sub make_trigger_events {
4247 return unless $self->circ;
4248 $U->create_events_for_hook('checkout', $self->circ, $self->circ_lib) if $self->is_checkout;
4249 $U->create_events_for_hook('checkin', $self->circ, $self->circ_lib) if $self->is_checkin;
4250 $U->create_events_for_hook('renewal', $self->circ, $self->circ_lib) if $self->is_renewal;
4255 sub checkin_handle_lost_or_lo_now_found {
4256 my ($self, $bill_type, $is_longoverdue) = @_;
4258 my $tag = $is_longoverdue ? "LONGOVERDUE" : "LOST";
4260 $logger->debug("voiding $tag item billings");
4261 my $result = $CC->void_or_zero_bills_of_type($self->editor, $self->circ, $self->copy, $bill_type, "$tag ITEM RETURNED");
4262 $self->bail_on_events($self->editor->event) if ($result);
4265 sub checkin_handle_lost_or_lo_now_found_restore_od {
4267 my $circ_lib = shift;
4268 my $is_longoverdue = shift;
4269 my $tag = $is_longoverdue ? "LONGOVERDUE" : "LOST";
4271 # ------------------------------------------------------------------
4272 # restore those overdue charges voided when item was set to lost
4273 # ------------------------------------------------------------------
4275 my $ods = $self->editor->search_money_billing([
4277 xact => $self->circ->id,
4281 order_by => {mb => 'billing_ts desc'}
4285 $logger->debug("returning ".scalar(@$ods)." overdue charges pre-$tag");
4286 # Because actual users get up to all kinds of unexpectedness, we
4287 # only recreate up to $circ->max_fine in bills. I know you think
4288 # it wouldn't happen that bills could get created, voided, and
4289 # recreated more than once, but I guaran-damn-tee you that it will
4291 if ($ods && @$ods) {
4292 my $void_amount = 0;
4293 my $void_max = $self->circ->max_fine();
4294 # search for overdues voided the new way (aka "adjusted")
4295 my @billings = map {$_->id()} @$ods;
4296 my $voids = $self->editor->search_money_account_adjustment(
4298 billing => \@billings
4302 map {$void_amount += $_->amount()} @$voids;
4304 # if no adjustments found, assume they were voided the old way (aka "voided")
4305 for my $bill (@$ods) {
4306 if( $U->is_true($bill->voided) ) {
4307 $void_amount += $bill->amount();
4313 ($void_amount < $void_max ? $void_amount : $void_max),
4315 $ods->[0]->billing_type(),
4317 "System: $tag RETURNED - OVERDUES REINSTATED",
4318 $ods->[-1]->period_start(),
4319 $ods->[0]->period_end() # date this restoration the same as the last overdue (for possible subsequent fine generation)