1 package OpenILS::Application::Storage::Publisher::action;
2 use parent qw/OpenILS::Application::Storage::Publisher/;
5 use OpenSRF::Utils::Logger qw/:level :logger/;
6 use OpenSRF::Utils qw/:datetime/;
7 use OpenSRF::Utils::JSON;
8 use OpenSRF::AppSession;
9 use OpenSRF::EX qw/:try/;
10 use OpenILS::Utils::Fieldmapper;
11 use OpenILS::Utils::PermitHold;
13 use DateTime::Format::ISO8601;
14 use OpenILS::Utils::Penalty;
16 use OpenILS::Application::Circ::CircCommon;
17 use OpenILS::Application::AppUtils;
18 my $U = "OpenILS::Application::AppUtils";
20 # Used in build_hold_sort_clause(). See the hash %order_by_sprintf_args in
21 # that sub to confirm what gets used to replace the formatters, and see
22 # nearest_hold() for the main body of the SQL query that these go into.
23 my %HOLD_SORT_ORDER_BY = (
25 hprox => 'actor.org_unit_proximity(%d, h.pickup_lib)', # $cp->call_number->owning_lib
26 aprox => 'COALESCE(hm.proximity, p.prox)',
27 approx => 'action.hold_copy_calculated_proximity(h.id, %d, %d)', # $cp,$here
28 priority => 'pgt.hold_priority',
29 cut => 'CASE WHEN h.cut_in_line IS TRUE THEN 0 ELSE 1 END',
30 depth => 'h.selection_depth',
31 rtime => 'h.request_time',
34 last_event_on_copy.place <> %d AND
35 copy_has_not_been_home.result
36 THEN actor.org_unit_proximity(%d, h.pickup_lib)
39 !, # $cp->call_number->owning_lib x 2
42 last_event_on_copy.place <> %d AND
43 copy_has_not_been_home_even_to_idle.result
44 THEN actor.org_unit_proximity(%d, h.pickup_lib)
47 !, # $cp->call_number->owning_lib x 2
53 return 1 if ($v == 1);
54 return 1 if ($v =~ /^t/io);
55 return 1 if ($v =~ /^y/io);
59 sub ou_ancestor_setting_value_or_cache {
60 # cache should be specific to setting
61 my ($actor, $org_id, $setting, $cache) = @_;
63 if (not exists $cache->{$org_id}) {
64 my $r = $actor->request(
65 'open-ils.actor.ou_setting.ancestor_default', $org_id, $setting
69 $cache->{$org_id} = $r->{value};
71 $cache->{$org_id} = undef;
74 return $cache->{$org_id};
77 my $parser = DateTime::Format::ISO8601->new;
78 my $log = 'OpenSRF::Utils::Logger';
80 sub open_noncat_circs {
85 my $a = action::non_cataloged_circulation->table;
86 my $c = config::non_cataloged_type->table;
91 JOIN $c c ON (a.item_type = c.id)
92 WHERE a.circ_time + c.circ_duration > current_timestamp
96 return action::non_cataloged_circulation->db_Main->selectcol_arrayref($sql, {}, $user);
98 __PACKAGE__->register_method(
99 api_name => 'open-ils.storage.action.open_non_cataloged_circulation.user',
100 method => 'open_noncat_circs',
106 sub ou_hold_requests {
111 my $h_table = action::hold_request->table;
112 my $c_table = asset::copy->table;
113 my $o_table = actor::org_unit->table;
118 JOIN $c_table cp ON (cp.id = h.current_copy)
119 JOIN $o_table ou ON (ou.id = cp.circ_lib)
121 AND h.capture_time IS NULL
122 AND h.cancel_time IS NULL
123 AND (h.expire_time IS NULL OR h.expire_time > NOW())
124 ORDER BY h.request_time
127 my $sth = action::hold_request->db_Main->prepare_cached($SQL);
130 $client->respond($_) for (
133 ->method_lookup('open-ils.storage.direct.action.hold_request.retrieve')
137 } @{ $sth->fetchall_arrayref }
141 __PACKAGE__->register_method(
142 api_name => 'open-ils.storage.action.targeted_hold_request.org_unit',
146 method => 'ou_hold_requests',
151 my $upper_interval = shift || '1 millennium';
154 my $c_t = action::circulation->table;
159 WHERE stop_fines IS NULL
160 AND due_date < ( CURRENT_TIMESTAMP - grace_period )
161 AND fine_interval < ?::INTERVAL
164 my $sth = action::circulation->db_Main->prepare_cached($sql);
165 $sth->execute($upper_interval);
167 my @circs = map { $idlist ? $_->{id} : action::circulation->construct($_) } $sth->fetchall_hash;
169 $c_t = booking::reservation->table;
173 WHERE return_time IS NULL
174 AND end_time < ( CURRENT_TIMESTAMP )
175 AND fine_interval IS NOT NULL
176 AND cancel_time IS NULL
179 $sth = action::circulation->db_Main->prepare_cached($sql);
182 push @circs, map { $idlist ? $_->{id} : booking::reservation->construct($_) } $sth->fetchall_hash;
187 sub complete_reshelving {
192 local $OpenILS::Application::Storage::WRITE = 1;
194 throw OpenSRF::EX::InvalidArg ("I need an interval of more than 0 seconds!")
195 unless (interval_to_seconds( $window ));
197 my $cp = asset::copy->table;
206 AND cp.status_changed_time < NOW() - CAST( COALESCE( BTRIM( (SELECT value FROM actor.org_unit_ancestor_setting('circ.reshelving_complete.interval', cp.circ_lib)),'"' ), ? ) AS INTERVAL)
209 my $sth = action::circulation->db_Main->prepare_cached($sql);
210 $sth->execute($window);
215 __PACKAGE__->register_method(
216 api_name => 'open-ils.storage.action.circulation.reshelving.complete',
219 method => 'complete_reshelving',
222 sub mark_longoverdue {
227 local $OpenILS::Application::Storage::WRITE = 1;
229 throw OpenSRF::EX::InvalidArg ("I need an interval of more than 0 seconds!")
230 unless (interval_to_seconds( $window ));
232 my $setting = actor::org_unit_setting->table;
233 my $circ = action::circulation->table;
237 SET stop_fines = 'LONGOVERDUE',
238 stop_fines_time = now()
242 LEFT JOIN $setting setting
243 ON (circ.circ_lib = setting.org_unit AND setting.name = 'circ.long_overdue.interval')
244 WHERE circ.checkin_time IS NULL AND (stop_fines IS NULL OR stop_fines NOT IN ('LOST','LONGOVERDUE'))
245 AND AGE(circ.due_date) > CAST( COALESCE( BTRIM( setting.value,'"' ), ? ) AS INTERVAL)
249 my $sth = action::circulation->db_Main->prepare_cached($sql);
250 $sth->execute($window);
255 __PACKAGE__->register_method(
256 api_name => 'open-ils.storage.action.circulation.long_overdue',
259 method => 'mark_longoverdue',
262 sub auto_thaw_frozen_holds {
266 local $OpenILS::Application::Storage::WRITE = 1;
268 my $holds = action::hold_request->table;
270 my $sql = "UPDATE $holds SET frozen = FALSE WHERE frozen IS TRUE AND thaw_date < NOW();";
272 my $sth = action::hold_request->db_Main->prepare_cached($sql);
278 __PACKAGE__->register_method(
279 api_name => 'open-ils.storage.action.hold_request.thaw_expired_frozen',
283 method => 'auto_thaw_frozen_holds',
290 my $idlist = $self->api_name =~/id_list/o ? 1 : 0;
292 $client->respond( $idlist ? $_ : $_->to_fieldmapper ) for ( overdue_circs('', $idlist) );
297 __PACKAGE__->register_method(
298 api_name => 'open-ils.storage.action.circulation.overdue',
301 method => 'grab_overdue',
303 Return list of overdue circulations and reservations to be used for fine generation.
304 Despite the name, this is not a generic method for retrieving all overdue loans,
305 as it excludes loans that have already hit the maximum fine limit.
308 __PACKAGE__->register_method(
309 api_name => 'open-ils.storage.action.circulation.overdue.id_list',
312 method => 'grab_overdue',
315 sub get_hold_sort_order {
318 my $dbh = action::hold_request->db_Main;
320 # The purpose of this function is to return column names in a DB-configured
321 # order, so it won't do to add columns here or change column names unless
322 # you also change the expectation of anything calling this function.
324 my $row = $dbh->selectrow_hashref(
327 cbho.pprox, cbho.hprox, cbho.aprox, cbho.approx, cbho.priority,
328 cbho.cut, cbho.depth, cbho.htime, cbho.shtime, cbho.rtime
329 FROM config.best_hold_order cbho
331 SELECT oils_json_to_text(value)::INT
332 FROM actor.org_unit_ancestor_setting('circ.hold_capture_order', ?)
336 pprox => 1, hprox => 8, aprox => 2, priority => 3,
337 cut => 4, depth => 5, htime => 7, rtime => 6
340 # Return only the keys of our hash, sorted by value,
341 # keys for null values omitted.
343 grep { defined $row->{$_} } (
344 sort {$row->{$a} cmp $row->{$b}} keys %$row
349 # Returns an ORDER BY clause
350 # *and* a string with a CTE expression to precede the nearest-hold SQL query
351 # *and* a string with extra JOIN statements needed
352 sub build_hold_sort_clause {
353 my ($columns, $cp, $here) = @_;
355 my %order_by_sprintf_args = (
356 hprox => [$cp->call_number->owning_lib],
357 approx => [$cp->id, $here],
358 htime => [$cp->call_number->owning_lib, $cp->call_number->owning_lib],
359 shtime => [$cp->call_number->owning_lib, $cp->call_number->owning_lib]
364 foreach my $col (@$columns) {
365 if ($col eq 'htime' and not $ctes_needed) {
367 } elsif ($col eq 'shtime') {
372 @args = @{$order_by_sprintf_args{$col}} if
373 exists $order_by_sprintf_args{$col};
375 push @clauses, sprintf($HOLD_SORT_ORDER_BY{$col}, @args);
377 last if $col eq 'rtime'; # rtime is effectively unique, no need for
378 # more order-by clauses after that.
381 my ($ctes, $joins) = ("", "");
382 if ($ctes_needed >= 1) {
383 # Each CTE serves the next. The first is one version or another
384 # of last_event_on_copy, which is described in holds-go-home.txt
385 # TechRef, but it essentially returns place and time of the most
386 # recent transit or circ to do with a copy, and failing that it
387 # returns a synthetic event that means "here" and "now".
389 if ($ctes_needed == 2) {
391 , last_event_on_copy AS ( -- combined circ and transit version
397 COALESCE(dest_recv_time, source_send_time) AS moment
398 FROM action.transit_copy
399 WHERE target_copy = %d
400 ORDER BY moment DESC LIMIT 1
404 COALESCE(checkin_lib, circ_lib) AS place,
405 COALESCE(checkin_time, xact_start) AS moment
406 FROM action.circulation
407 WHERE target_copy = %d
408 ORDER BY moment DESC LIMIT 1
414 ) x ORDER BY concrete DESC, moment DESC LIMIT 1
415 ) !, $cp->id, $cp->id, $cp->call_number->owning_lib);
418 , last_event_on_copy AS ( -- circ only version
422 COALESCE(checkin_lib, circ_lib) AS place,
423 COALESCE(checkin_time, xact_start) AS moment
424 FROM action.circulation
425 WHERE target_copy = %d
426 ORDER BY moment DESC LIMIT 1
431 ) x ORDER BY concrete DESC, moment DESC LIMIT 1
432 ) !, $cp->id, $cp->call_number->owning_lib);
436 JOIN last_event_on_copy ON (true)
439 # For our next auxiliary query, the question we seek to answer is,
440 # "has our copy been circulating away from home too long?"
442 # Have there been no checkouts at the copy's circ_lib since the
443 # beginning of our go-home interval?
445 # [We use sprintf because the outer function that's going to send one
446 # big query through DBI is blind to our process of dynamically building
447 # these CTEs, and it wouldn't know what bind parameters to pass unless
448 # we did a lot more work here. This is injection-safe because we only
449 # use the %d formatter.]
451 , copy_has_not_been_home AS (
454 SELECT MIN(circ.id) FROM action.circulation circ
455 JOIN go_home_interval ON (true)
457 circ.target_copy = %d AND
458 circ.circ_lib = %d AND
459 circ.xact_start >= NOW() - go_home_interval.value
461 ) !, $cp->id, $cp->circ_lib);
464 JOIN copy_has_not_been_home ON (true)
468 if ($ctes_needed == 2) {
469 # By this query, we mean to determine that the copy hasn't landed at
470 # home by means of transit during the go-home interval (in addition
471 # to not having circulated from home in the same time frame).
473 # There have been no homebound transits that arrived for this copy
474 # since the beginning of the go-home interval.
477 , copy_has_not_been_home_even_to_idle AS (
478 SELECT result AND NOT (
479 SELECT COUNT(*)::INT::BOOL
480 FROM action.transit_copy atc
482 atc.target_copy = %d AND
483 (atc.dest = %d OR atc.source = %d) AND
484 atc.dest_recv_time >= NOW() - (SELECT value FROM go_home_interval)
485 ) AS result FROM copy_has_not_been_home
486 ) !, $cp->id, $cp->circ_lib, $cp->circ_lib);
487 $joins .= " JOIN copy_has_not_been_home_even_to_idle ON (true) ";
491 join(", ", @clauses),
500 my $here = shift; # just the ID
501 my $cp = shift; # now an object with call_number fleshed,
502 # formerly just copy ID
503 my $limit = int(shift()) || 10;
504 my $age = shift() || '0 seconds';
507 $log->info("deprecated 'fifo' param true, but ignored") if isTrue $fifo;
509 my ($holdsort, $addl_cte, $addl_join) =
510 build_hold_sort_clause(get_hold_sort_order($here), $cp, $here);
512 local $OpenILS::Application::Storage::WRITE = 1;
514 my $ids = action::hold_request->db_Main->selectcol_arrayref(<<" SQL", {}, $cp->circ_lib, $here, $cp->id, $age);
515 WITH go_home_interval AS (
516 SELECT OILS_JSON_TO_TEXT(
517 (SELECT value FROM actor.org_unit_ancestor_setting(
518 'circ.hold_go_home_interval', ?
520 ))::INTERVAL AS value
524 FROM action.hold_request h
525 JOIN actor.org_unit_proximity p ON (p.from_org = ? AND p.to_org = h.pickup_lib)
526 JOIN action.hold_copy_map hm ON (hm.hold = h.id)
527 JOIN actor.usr au ON (au.id = h.usr)
528 JOIN permission.grp_tree pgt ON (au.profile = pgt.id)
529 LEFT JOIN actor.usr_standing_penalty ausp
530 ON ( au.id = ausp.usr AND ( ausp.stop_date IS NULL OR ausp.stop_date > NOW() ) )
531 LEFT JOIN config.standing_penalty csp
532 ON ( csp.id = ausp.standing_penalty AND csp.block_list LIKE '%CAPTURE%' )
534 WHERE hm.target_copy = ?
535 AND (AGE(NOW(),h.request_time) >= CAST(? AS INTERVAL) OR p.prox = 0)
536 AND h.capture_time IS NULL
537 AND h.cancel_time IS NULL
538 AND (h.expire_time IS NULL OR h.expire_time > NOW())
539 AND h.frozen IS FALSE
541 ORDER BY CASE WHEN h.hold_type IN ('R','F') THEN 0 ELSE 1 END, $holdsort
545 $client->respond( $_ ) for ( @$ids );
548 __PACKAGE__->register_method(
549 api_name => 'open-ils.storage.action.hold_request.nearest_hold',
552 method => 'nearest_hold',
555 sub targetable_holds {
558 my $check_expire = shift;
560 $check_expire ||= '12h';
562 local $OpenILS::Application::Storage::WRITE = 1;
564 # json_query can *almost* represent this query, but can't
565 # handle the CASE statement or the interval arithmetic
566 my $query = <<" SQL";
567 SELECT ahr.id, mmsm.metarecord
568 FROM action.hold_request ahr
569 JOIN reporter.hold_request_record USING (id)
570 JOIN metabib.metarecord_source_map mmsm ON (bib_record = source)
571 WHERE capture_time IS NULL
572 AND (prev_check_time IS NULL or prev_check_time < (NOW() - ?::interval))
573 AND fulfillment_time IS NULL
574 AND cancel_time IS NULL
576 ORDER BY CASE WHEN ahr.hold_type = 'F' THEN 0 ELSE 1 END, selection_depth DESC, request_time;
578 my $sth = action::hold_request->db_Main->prepare_cached($query);
579 $sth->execute($check_expire);
580 $client->respond( $_ ) for @{ $sth->fetchall_arrayref };
585 __PACKAGE__->register_method(
586 api_name => 'open-ils.storage.action.hold_request.targetable_holds.id_list',
589 method => 'targetable_holds',
591 Returns ordered list of hold request and metarecord IDs
592 for all hold requests that are available for initial targeting
594 @param check interval
595 @return list of pairs of hold request and metarecord IDs
599 sub next_resp_group_id {
603 # XXX This is not replication safe!!!
605 my ($id) = action::survey->db_Main->selectrow_array(<<" SQL");
606 SELECT NEXTVAL('action.survey_response_group_id_seq'::TEXT)
610 __PACKAGE__->register_method(
611 api_name => 'open-ils.storage.action.survey_response.next_group_id',
613 method => 'next_resp_group_id',
616 sub patron_circ_summary {
621 return undef unless ($id);
622 my $c_table = action::circulation->table;
623 my $b_table = money::billing->table;
625 $log->debug("Retrieving patron summary for id $id", DEBUG);
627 my $select = <<" SQL";
628 SELECT COUNT(DISTINCT c.id), SUM( COALESCE(b.amount,0) )
630 LEFT OUTER JOIN $b_table b ON (c.id = b.xact AND b.voided = FALSE)
632 AND c.xact_finish IS NULL
634 c.stop_fines NOT IN ('CLAIMSRETURNED','LOST')
635 OR c.stop_fines IS NULL
639 return action::survey->db_Main->selectrow_arrayref($select, {}, $id);
641 __PACKAGE__->register_method(
642 api_name => 'open-ils.storage.action.circulation.patron_summary',
644 method => 'patron_circ_summary',
647 #XXX Fix stored proc calls
648 sub find_local_surveys {
653 return undef unless ($ou);
654 my $s_table = action::survey->table;
656 my $select = <<" SQL";
659 JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
660 WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
663 my $sth = action::survey->db_Main->prepare_cached($select);
666 $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
670 __PACKAGE__->register_method(
671 api_name => 'open-ils.storage.action.survey.all',
674 method => 'find_local_surveys',
677 #XXX Fix stored proc calls
678 sub find_opac_surveys {
683 return undef unless ($ou);
684 my $s_table = action::survey->table;
686 my $select = <<" SQL";
689 JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
690 WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
694 my $sth = action::survey->db_Main->prepare_cached($select);
697 $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
701 __PACKAGE__->register_method(
702 api_name => 'open-ils.storage.action.survey.opac',
705 method => 'find_opac_surveys',
712 my $limit = shift || 10;
713 my $offset = shift || 0;
715 return undef unless ($ou);
716 my $h_table = action::hold_request->table;
717 my $a_table = asset::copy->table;
718 my $ord_table = asset::copy_location_order->table;
720 my $idlist = 1 if ($self->api_name =~/id_list/o);
721 my $count = 1 if ($self->api_name =~/count$/o);
723 my $status_filter = '';
724 $status_filter = 'AND a.status IN (0,7)' if ($self->api_name =~/status_filtered/o);
726 my $select = <<" SQL";
729 JOIN $a_table a ON (h.current_copy = a.id)
730 LEFT JOIN $ord_table ord ON (a.location = ord.location AND a.circ_lib = ord.org)
731 LEFT JOIN actor.usr_standing_penalty ausp
732 ON ( h.usr = ausp.usr AND ( ausp.stop_date IS NULL OR ausp.stop_date > NOW() ) )
733 LEFT JOIN config.standing_penalty csp
734 ON ( csp.id = ausp.standing_penalty AND csp.block_list LIKE '%CAPTURE%' )
736 AND h.capture_time IS NULL
737 AND h.cancel_time IS NULL
738 AND (h.expire_time IS NULL OR h.expire_time > NOW())
741 ORDER BY CASE WHEN ord.position IS NOT NULL THEN ord.position ELSE 999 END, h.request_time
750 JOIN $a_table a ON (h.current_copy = a.id)
751 LEFT JOIN actor.usr_standing_penalty ausp
752 ON ( h.usr = ausp.usr AND ( ausp.stop_date IS NULL OR ausp.stop_date > NOW() ) )
753 LEFT JOIN config.standing_penalty csp
754 ON ( csp.id = ausp.standing_penalty AND csp.block_list LIKE '%CAPTURE%' )
756 AND h.capture_time IS NULL
757 AND h.cancel_time IS NULL
758 AND (h.expire_time IS NULL OR h.expire_time > NOW())
764 my $sth = action::survey->db_Main->prepare_cached($select);
768 $client->respond( $sth->fetchall_arrayref()->[0][0] );
770 $client->respond( $_->{id} ) for ( $sth->fetchall_hash );
772 $client->respond( $_->to_fieldmapper ) for ( map { action::hold_request->construct($_) } $sth->fetchall_hash );
777 __PACKAGE__->register_method(
778 api_name => 'open-ils.storage.direct.action.hold_request.pull_list.current_copy_circ_lib.count',
782 "Returns a count of holds for a specific library's pull list.",
783 [ [org_unit => "The library's org id", "number"] ],
784 ['A count of holds for the stated library to pull ', 'number']
786 method => 'hold_pull_list',
788 __PACKAGE__->register_method(
789 api_name => 'open-ils.storage.direct.action.hold_request.pull_list.current_copy_circ_lib.status_filtered.count',
793 "Returns a status filtered count of holds for a specific library's pull list.",
794 [ [org_unit => "The library's org id", "number"] ],
795 ['A status filtered count of holds for the stated library to pull ', 'number']
797 method => 'hold_pull_list',
799 __PACKAGE__->register_method(
800 api_name => 'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib',
804 "Returns the hold ids for a specific library's pull list.",
805 [ [org_unit => "The library's org id", "number"],
806 [limit => 'An optional page size, defaults to 10', 'number'],
807 [offset => 'Offset for paging, defaults to 0, 0 based', 'number'],
809 ['A list of holds for the stated library to pull for', 'array']
811 method => 'hold_pull_list',
813 __PACKAGE__->register_method(
814 api_name => 'open-ils.storage.direct.action.hold_request.pull_list.search.current_copy_circ_lib',
818 "Returns the holds for a specific library's pull list.",
819 [ [org_unit => "The library's org id", "number"],
820 [limit => 'An optional page size, defaults to 10', 'number'],
821 [offset => 'Offset for paging, defaults to 0, 0 based', 'number'],
823 ['A list of holds for the stated library to pull for', 'array']
825 method => 'hold_pull_list',
827 __PACKAGE__->register_method(
828 api_name => 'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib.status_filtered',
832 "Returns the hold ids for a specific library's pull list that are definitely in that library, based on status.",
833 [ [org_unit => "The library's org id", "number"],
834 [limit => 'An optional page size, defaults to 10', 'number'],
835 [offset => 'Offset for paging, defaults to 0, 0 based', 'number'],
837 ['A list of holds for the stated library to pull for', 'array']
839 method => 'hold_pull_list',
841 __PACKAGE__->register_method(
842 api_name => 'open-ils.storage.direct.action.hold_request.pull_list.search.current_copy_circ_lib.status_filtered',
846 "Returns the holds for a specific library's pull list that are definitely in that library, based on status.",
847 [ [org_unit => "The library's org id", "number"],
848 [limit => 'An optional page size, defaults to 10', 'number'],
849 [offset => 'Offset for paging, defaults to 0, 0 based', 'number'],
851 ['A list of holds for the stated library to pull for', 'array']
853 method => 'hold_pull_list',
856 sub find_optional_surveys {
861 return undef unless ($ou);
862 my $s_table = action::survey->table;
864 my $select = <<" SQL";
867 JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
868 WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
869 AND s.required IS FALSE;
872 my $sth = action::survey->db_Main->prepare_cached($select);
875 $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
879 __PACKAGE__->register_method(
880 api_name => 'open-ils.storage.action.survey.optional',
883 method => 'find_optional_surveys',
886 sub find_required_surveys {
891 return undef unless ($ou);
892 my $s_table = action::survey->table;
894 my $select = <<" SQL";
897 JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
898 WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
899 AND s.required IS TRUE;
902 my $sth = action::survey->db_Main->prepare_cached($select);
905 $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
909 __PACKAGE__->register_method(
910 api_name => 'open-ils.storage.action.survey.required',
913 method => 'find_required_surveys',
916 sub find_usr_summary_surveys {
921 return undef unless ($ou);
922 my $s_table = action::survey->table;
924 my $select = <<" SQL";
927 JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
928 WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
929 AND s.usr_summary IS TRUE;
932 my $sth = action::survey->db_Main->prepare_cached($select);
935 $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
939 __PACKAGE__->register_method(
940 api_name => 'open-ils.storage.action.survey.usr_summary',
943 method => 'find_usr_summary_surveys',
946 sub seconds_to_interval_hash {
947 my $interval = shift;
948 my $limit = shift || 's';
949 $limit =~ s/^(.)/$1/o;
953 my ($y,$ym,$M,$Mm,$w,$wm,$d,$dm,$h,$hm,$m,$mm,$s);
954 my ($year, $month, $week, $day, $hour, $minute, $second) =
955 ('years','months','weeks','days', 'hours', 'minutes', 'seconds');
957 if ($y = int($interval / (60 * 60 * 24 * 365))) {
959 $ym = $interval % (60 * 60 * 24 * 365);
963 return %output if ($limit eq 'y');
965 if ($M = int($ym / ((60 * 60 * 24 * 365)/12))) {
966 $output{$month} = $M;
967 $Mm = $ym % ((60 * 60 * 24 * 365)/12);
971 return %output if ($limit eq 'M');
973 if ($w = int($Mm / 604800)) {
979 return %output if ($limit eq 'w');
981 if ($d = int($wm / 86400)) {
987 return %output if ($limit eq 'd');
989 if ($h = int($dm / 3600)) {
995 return %output if ($limit eq 'h');
997 if ($m = int($hm / 60)) {
998 $output{$minute} = $m;
1003 return %output if ($limit eq 'm');
1005 if ($s = int($mm)) {
1006 $output{$second} = $s;
1008 $output{$second} = 0 unless (keys %output);
1014 sub generate_fines {
1018 my $overbill = shift;
1020 local $OpenILS::Application::Storage::WRITE = 1;
1025 action::circulation->search_where( { id => $circ, stop_fines => undef } ),
1026 booking::reservation->search_where( { id => $circ, return_time => undef, cancel_time => undef } );
1028 push @circs, overdue_circs();
1031 my %hoo = map { ( $_->id => $_ ) } actor::org_unit::hours_of_operation->retrieve_all;
1033 my $penalty = OpenSRF::AppSession->create('open-ils.penalty');
1034 for my $c (@circs) {
1036 my $ctype = ref($c);
1037 $ctype =~ s/^.+::(\w+)$/$1/;
1039 my $due_date_method = 'due_date';
1040 my $target_copy_method = 'target_copy';
1041 my $circ_lib_method = 'circ_lib';
1042 my $recurring_fine_method = 'recurring_fine';
1043 my $is_reservation = 0;
1044 if ($ctype eq 'reservation') {
1045 $is_reservation = 1;
1046 $due_date_method = 'end_time';
1047 $target_copy_method = 'current_resource';
1048 $circ_lib_method = 'pickup_lib';
1049 $recurring_fine_method = 'fine_amount';
1050 next unless ($c->fine_interval);
1052 #TODO: reservation grace periods
1053 my $grace_period = ($is_reservation ? 0 : interval_to_seconds($c->grace_period));
1056 if ($self->method_lookup('open-ils.storage.transaction.current')->run) {
1057 $log->debug("Cleaning up after previous transaction\n");
1058 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
1060 $self->method_lookup('open-ils.storage.transaction.begin')->run( $client );
1062 sprintf("Processing %s %d...",
1063 ($is_reservation ? "reservation" : "circ"), $c->id
1068 my $due_dt = $parser->parse_datetime( cleanse_ISO8601( $c->$due_date_method ) );
1070 my $due = $due_dt->epoch;
1073 my $fine_interval = $c->fine_interval;
1074 $fine_interval =~ s/(\d{2}):(\d{2}):(\d{2})/$1 h $2 m $3 s/o;
1075 $fine_interval = interval_to_seconds( $fine_interval );
1077 if ( $fine_interval == 0 || int($c->$recurring_fine_method * 100) == 0 || int($c->max_fine * 100) == 0 ) {
1078 $client->respond( "Fine Generator skipping circ due to 0 fine interval, 0 fine rate, or 0 max fine.\n" );
1079 $log->info( "Fine Generator skipping circ " . $c->id . " due to 0 fine interval, 0 fine rate, or 0 max fine." );
1083 if ( $is_reservation and $fine_interval >= interval_to_seconds('1d') ) {
1084 my $tz_offset_s = 0;
1085 if ($due_dt->strftime('%z') =~ /(-|\+)(\d{2}):?(\d{2})/) {
1086 $tz_offset_s = $1 . interval_to_seconds( "${2}h ${3}m");
1089 $due -= ($due % $fine_interval) + $tz_offset_s;
1090 $now -= ($now % $fine_interval) + $tz_offset_s;
1094 "ARG! Overdue $ctype ".$c->id.
1095 " for item ".$c->$target_copy_method.
1096 " (user ".$c->usr.").\n".
1097 "\tItem was due on or before: ".localtime($due)."\n");
1099 my @fines = money::billing->search_where(
1102 billing_ts => { '>' => $c->$due_date_method } },
1103 { order_by => 'billing_ts DESC'}
1107 my $fine = $fines[$f_idx] if (@fines);
1109 $fine = $fines[++$f_idx] while ($fine and $fine->voided);
1112 my $current_fine_total = 0;
1113 $current_fine_total += int($_->amount * 100) for (grep { $_ and !$_->voided } @fines);
1117 $client->respond( "Last billing time: ".$fine->billing_ts." (clensed format: ".cleanse_ISO8601( $fine->billing_ts ).")");
1118 $last_fine = $parser->parse_datetime( cleanse_ISO8601( $fine->billing_ts ) )->epoch;
1120 $log->info( "Potential first billing for circ ".$c->id );
1123 $grace_period = OpenILS::Application::Circ::CircCommon->extend_grace_period($c->$circ_lib_method->to_fieldmapper->id,$c->$due_date_method,$grace_period,undef,$hoo{$c->$circ_lib_method});
1126 next if ($last_fine > $now);
1127 # Generate fines for each past interval, including the one we are inside
1128 my $pending_fine_count = ceil( ($now - $last_fine) / $fine_interval );
1130 if ( $last_fine == $due # we have no fines yet
1131 && $grace_period # and we have a grace period
1132 && $now < $due + $grace_period # and some date math says were are within the grace period
1134 $client->respond( "Still inside grace period of: ". seconds_to_interval( $grace_period )."\n" );
1135 $log->info( "Circ ".$c->id." is still inside grace period of: $grace_period [". seconds_to_interval( $grace_period ).']' );
1139 $client->respond( "\t$pending_fine_count pending fine(s)\n" );
1140 next unless ($pending_fine_count);
1142 my $recurring_fine = int($c->$recurring_fine_method * 100);
1143 my $max_fine = int($c->max_fine * 100);
1145 my $skip_closed_check = $U->ou_ancestor_setting_value(
1146 $c->$circ_lib_method->to_fieldmapper->id, 'circ.fines.charge_when_closed');
1147 $skip_closed_check = $U->is_true($skip_closed_check);
1149 my $truncate_to_max_fine = $U->ou_ancestor_setting_value(
1150 $c->$circ_lib_method->to_fieldmapper->id, 'circ.fines.truncate_to_max_fine');
1151 $truncate_to_max_fine = $U->is_true($truncate_to_max_fine);
1153 my ($latest_billing_ts, $latest_amount) = ('',0);
1154 for (my $bill = 1; $bill <= $pending_fine_count; $bill++) {
1156 if ($current_fine_total >= $max_fine) {
1157 $c->update({stop_fines => 'MAXFINES', stop_fines_time => 'now'}) if ($ctype eq 'circulation');
1159 "\tMaximum fine level of ".$c->max_fine.
1160 " reached for this $ctype.\n".
1161 "\tNo more fines will be generated.\n" );
1165 # XXX Use org time zone (or default to 'local') once we have the ou setting built for that
1166 my $billing_ts = DateTime->from_epoch( epoch => $last_fine, time_zone => 'local' );
1167 my $current_bill_count = $bill;
1168 while ( $current_bill_count ) {
1169 $billing_ts->add( seconds_to_interval_hash( $fine_interval ) );
1170 $current_bill_count--;
1173 my $timestamptz = $billing_ts->strftime('%FT%T%z');
1174 if (!$skip_closed_check) {
1175 my $dow = $billing_ts->day_of_week_0();
1176 my $dow_open = "dow_${dow}_open";
1177 my $dow_close = "dow_${dow}_close";
1179 if (my $h = $hoo{$c->$circ_lib_method}) {
1180 next if ( $h->$dow_open eq '00:00:00' and $h->$dow_close eq '00:00:00');
1183 my @cl = actor::org_unit::closed_date->search_where(
1184 { close_start => { '<=' => $timestamptz },
1185 close_end => { '>=' => $timestamptz },
1186 org_unit => $c->$circ_lib_method }
1191 # The billing amount for this billing normally ought to be the recurring fine amount.
1192 # However, if the recurring fine amount would cause total fines to exceed the max fine amount,
1193 # we may wish to reduce the amount for this billing (if circ.fines.truncate_to_max_fine is true).
1194 my $this_billing_amount = $recurring_fine;
1195 if ( $truncate_to_max_fine && ($current_fine_total + $this_billing_amount) > $max_fine ) {
1196 $this_billing_amount = ($max_fine - $current_fine_total);
1198 $current_fine_total += $this_billing_amount;
1199 $latest_amount += $this_billing_amount;
1200 $latest_billing_ts = $timestamptz;
1202 money::billing->create(
1203 { xact => ''.$c->id,
1204 note => "System Generated Overdue Fine",
1205 billing_type => "Overdue materials",
1207 amount => sprintf('%0.2f', $this_billing_amount/100),
1208 billing_ts => $timestamptz,
1214 $client->respond( "\t\tAdding fines totaling $latest_amount for overdue up to $latest_billing_ts\n" )
1215 if ($latest_billing_ts and $latest_amount);
1217 $self->method_lookup('open-ils.storage.transaction.commit')->run;
1221 # Caluclate penalties inline
1222 OpenILS::Utils::Penalty->calculate_penalties(
1223 undef, $c->usr->to_fieldmapper->id.'', $c->$circ_lib_method->to_fieldmapper->id.'');
1227 # Calculate penalties with an aysnc call to the penalty server. This approach
1228 # may lead to duplicate penalties since multiple penalty processes for a
1229 # given user may be running at the same time. Leave this here for reference
1230 # in case we later find that asyc calls are needed in some environments.
1232 'open-ils.penalty.patron_penalty.calculate',
1233 { patronid => ''.$c->usr,
1234 context_org => ''.$c->$circ_lib_method,
1241 } catch Error with {
1243 $client->respond( "Error processing overdue $ctype [".$c->id."]:\n\n$e\n" );
1244 $log->error("Error processing overdue $ctype [".$c->id."]:\n$e\n");
1245 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
1246 throw $e if ($e =~ /IS NOT CONNECTED TO THE NETWORK/o);
1250 __PACKAGE__->register_method(
1251 api_name => 'open-ils.storage.action.circulation.overdue.generate_fines',
1254 method => 'generate_fines',
1259 sub new_hold_copy_targeter {
1262 my $check_expire = shift;
1263 my $one_hold = shift;
1264 my $find_copy = shift;
1266 local $OpenILS::Application::Storage::WRITE = 1;
1268 $self->{target_weight} = {};
1269 $self->{max_loops} = {};
1275 $self->method_lookup('open-ils.storage.transaction.begin')->run( $client );
1276 $holds = [ action::hold_request->search_where( { id => $one_hold, fulfillment_time => undef, cancel_time => undef, frozen => 'f' } ) ];
1277 } elsif ( $check_expire ) {
1279 # what's the retarget time threashold?
1281 $check_expire ||= '12h';
1282 $check_expire = interval_to_seconds( $check_expire );
1284 my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = gmtime(time() - $check_expire);
1287 my $expire_threshold = sprintf(
1288 '%s-%0.2d-%0.2dT%0.2d:%0.2d:%0.2d-00',
1289 $year, $mon, $mday, $hour, $min, $sec
1292 # find all the holds holds needing retargeting
1293 $holds = [ action::hold_request->search_where(
1294 { capture_time => undef,
1295 fulfillment_time => undef,
1296 cancel_time => undef,
1298 prev_check_time => { '<=' => $expire_threshold },
1300 { order_by => 'selection_depth DESC, request_time,prev_check_time' } ) ];
1302 # find all the holds holds needing first time targeting
1303 push @$holds, action::hold_request->search(
1304 capture_time => undef,
1305 fulfillment_time => undef,
1306 prev_check_time => undef,
1308 cancel_time => undef,
1309 { order_by => 'selection_depth DESC, request_time' } );
1312 # find all the holds holds needing first time targeting ONLY
1313 $holds = [ action::hold_request->search(
1314 capture_time => undef,
1315 fulfillment_time => undef,
1316 prev_check_time => undef,
1317 cancel_time => undef,
1319 { order_by => 'selection_depth DESC, request_time' } ) ];
1321 } catch Error with {
1323 die "Could not retrieve uncaptured hold requests:\n\n$e\n";
1326 my @closed = actor::org_unit::closed_date->search_where(
1327 { close_start => { '<=', 'now' },
1328 close_end => { '>=', 'now' } }
1331 if ($check_expire) {
1333 # $check_expire, if it exists, was already converted to seconds
1334 my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = gmtime(time() + $check_expire);
1338 my $next_check_time = sprintf(
1339 '%s-%0.2d-%0.2dT%0.2d:%0.2d:%0.2d-00',
1340 $year, $mon, $mday, $hour, $min, $sec
1344 my @closed_at_next = actor::org_unit::closed_date->search_where(
1345 { close_start => { '<=', $next_check_time },
1346 close_end => { '>=', $next_check_time } }
1350 for my $c_at_n (@closed_at_next) {
1351 if (grep { ''.$_->org_unit eq ''.$c_at_n->org_unit } @closed) {
1352 push @new_closed, $c_at_n;
1355 @closed = @new_closed;
1359 my $actor = OpenSRF::AppSession->create('open-ils.actor');
1361 my $target_when_closed = {};
1362 my $target_when_closed_if_at_pickup_lib = {};
1364 for my $hold (@$holds) {
1366 #start a transaction if needed
1367 if ($self->method_lookup('open-ils.storage.transaction.current')->run) {
1368 $log->debug("Cleaning up after previous transaction\n");
1369 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
1371 $self->method_lookup('open-ils.storage.transaction.begin')->run( $client );
1372 $log->info("Processing hold ".$hold->id."...\n");
1374 #first, re-fetch the hold, to make sure it's not captured already
1375 $hold->remove_from_object_index();
1376 $hold = action::hold_request->retrieve( $hold->id );
1378 die "OK\n" if (!$hold or $hold->capture_time or $hold->cancel_time);
1380 # remove old auto-targeting maps
1381 my @oldmaps = action::hold_copy_map->search( hold => $hold->id );
1382 $_->delete for (@oldmaps);
1384 if ($hold->expire_time) {
1385 my $ex_time = $parser->parse_datetime( cleanse_ISO8601( $hold->expire_time ) );
1386 if ( DateTime->compare($ex_time, DateTime->now) < 0 ) {
1388 # cancel cause = un-targeted expiration
1389 $hold->update( { cancel_time => 'now', cancel_cause => 1 } );
1391 # refresh fields from the DB while still in the xact
1392 my $fm_hold = $hold->to_fieldmapper;
1394 $self->method_lookup('open-ils.storage.transaction.commit')->run;
1396 # tell A/T the hold was cancelled
1397 my $ses = OpenSRF::AppSession->create('open-ils.trigger');
1398 $ses->request('open-ils.trigger.event.autocreate',
1399 'hold_request.cancel.expire_no_target', $fm_hold, $fm_hold->pickup_lib);
1405 my $all_copies = [];
1407 # find filters for MR holds
1408 my ($types, $formats, $lang);
1409 if (defined($hold->holdable_formats)) {
1410 ($types, $formats, $lang) = split '-', $hold->holdable_formats;
1413 # find all the potential copies
1414 if ($hold->hold_type eq 'M') {
1417 isTrue($_->deleted) ? () : ($_->id)
1418 } metabib::metarecord->retrieve($hold->target)->source_records
1423 metabib::record_descriptor
1426 ( $types ? (item_type => [split '', $types]) : () ),
1427 ( $formats ? (item_form => [split '', $formats]) : () ),
1428 ( $lang ? (item_lang => $lang) : () ),
1432 ->method_lookup( 'open-ils.storage.biblio.record_entry.ranged_tree')
1433 ->run( $r->id, $hold->selection_ou, $hold->selection_depth );
1435 for my $cn ( @{ $rtree->call_numbers } ) {
1437 asset::copy->search_where(
1438 { id => [map {$_->id} @{ $cn->copies }],
1440 ) if ($cn && @{ $cn->copies });
1444 } elsif ($hold->hold_type eq 'T') {
1446 ->method_lookup( 'open-ils.storage.biblio.record_entry.ranged_tree')
1447 ->run( $hold->target, $hold->selection_ou, $hold->selection_depth );
1450 push @successes, { hold => $hold->id, eligible_copies => 0, error => 'NO_RECORD' };
1454 for my $cn ( @{ $rtree->call_numbers } ) {
1456 asset::copy->search_where(
1457 { id => [map {$_->id} @{ $cn->copies }],
1459 ) if ($cn && @{ $cn->copies });
1461 } elsif ($hold->hold_type eq 'V') {
1463 ->method_lookup( 'open-ils.storage.asset.call_number.ranged_tree')
1464 ->run( $hold->target, $hold->selection_ou, $hold->selection_depth );
1467 asset::copy->search_where(
1468 { id => [map {$_->id} @{ $vtree->copies }],
1470 ) if ($vtree && @{ $vtree->copies });
1472 } elsif ($hold->hold_type eq 'P') {
1473 my @part_maps = asset::copy_part_map->search_where( { part => $hold->target } );
1475 asset::copy->search_where(
1476 { id => [map {$_->target_copy} @part_maps],
1481 } elsif ($hold->hold_type eq 'I') {
1483 ->method_lookup( 'open-ils.storage.serial.issuance.ranged_tree')
1484 ->run( $hold->target, $hold->selection_ou, $hold->selection_depth );
1487 asset::copy->search_where(
1488 { id => [map {$_->unit->id} @{ $itree->items }],
1490 ) if ($itree && @{ $itree->items });
1492 } elsif ($hold->hold_type eq 'C' || $hold->hold_type eq 'R' || $hold->hold_type eq 'F') {
1493 my $_cp = asset::copy->retrieve($hold->target);
1494 push @$all_copies, $_cp if $_cp;
1497 # Force and recall holds bypass pretty much everything
1498 if ($hold->hold_type ne 'R' && $hold->hold_type ne 'F') {
1500 @$all_copies = grep { isTrue($_->status->holdable) &&
1501 isTrue($_->location->holdable) &&
1502 isTrue($_->holdable) &&
1503 !isTrue($_->deleted) &&
1504 (isTrue($hold->mint_condition) ? isTrue($_->mint_condition) : 1) &&
1505 ( ( $hold->hold_type ne 'C' && $hold->hold_type ne 'I' # Copy-level holds don't care about parts
1506 && $hold->hold_type ne 'P' ) ? $_->part_maps->count == 0 : 1)
1510 # let 'em know we're still working
1511 $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
1513 # if we have no copies ...
1514 if (!ref $all_copies || !@$all_copies) {
1515 $log->info("\tNo copies available for targeting at all!\n");
1516 push @successes, { hold => $hold->id, eligible_copies => 0, error => 'NO_COPIES' };
1518 $hold->update( { prev_check_time => 'today', current_copy => undef } );
1519 $self->method_lookup('open-ils.storage.transaction.commit')->run;
1523 my $copy_count = @$all_copies;
1524 my $found_copy = undef;
1525 $found_copy = 1 if($find_copy and grep $_ == $find_copy, @$all_copies);
1527 # map the potentials, so that we can pick up checkins
1528 # XXX Loop-based targeting may require that /only/ copies from this loop should be added to
1529 # XXX the potentials list. If this is the cased, hold_copy_map creation will move down further.
1530 my $pu_lib = ''.$hold->pickup_lib;
1531 my $prox_list = create_prox_list( $self, $pu_lib, $all_copies, $hold );
1532 $log->debug( "\tMapping ".scalar(@$all_copies)." potential copies for hold ".$hold->id);
1533 for my $prox ( keys %$prox_list ) {
1534 action::hold_copy_map->create( { proximity => $prox, hold => $hold->id, target_copy => $_->id } ) for (@{$$prox_list{$prox}});
1537 #$client->status( new OpenSRF::DomainObject::oilsContinueStatus );
1540 for my $c (@$all_copies) {
1542 next if ($hold->current_copy and $c->id eq $hold->current_copy);
1544 # skip on circ lib is closed IFF we care
1547 if (''.$hold->pickup_lib eq ''.$c->circ_lib) {
1548 $ignore_closing = ou_ancestor_setting_value_or_cache(
1551 'circ.holds.target_when_closed_if_at_pickup_lib',
1552 $target_when_closed_if_at_pickup_lib
1555 if (not $ignore_closing) { # one more chance to find a reason
1556 # to ignore OU closedness.
1557 $ignore_closing = ou_ancestor_setting_value_or_cache(
1560 'circ.holds.target_when_closed',
1566 # "For hold " . $hold->id . " and copy with circ_lib " .
1567 # $c->circ_lib . " we " .
1568 # ($ignore_closing ? "ignore" : "respect")
1573 (not $ignore_closing) and
1574 (grep { ''.$_->org_unit eq ''.$c->circ_lib } @closed)
1577 # target of another hold
1578 next if (action::hold_request
1580 { current_copy => $c->id,
1581 fulfillment_time => undef,
1582 cancel_time => undef,
1587 # we passed all three, keep it
1588 push @good_copies, $c if ($c);
1589 #$client->status( new OpenSRF::DomainObject::oilsContinueStatus );
1592 $log->debug("\t".scalar(@good_copies)." (non-current) copies available for targeting...");
1594 my $old_best = $hold->current_copy;
1595 my $old_best_still_valid = 0; # Assume no, but the next line says yes if it is still a potential.
1596 $old_best_still_valid = 1 if ( $old_best && grep { ''.$old_best->id eq ''.$_->id } @$all_copies );
1597 $hold->update({ current_copy => undef }) if ($old_best);
1599 if (!scalar(@good_copies)) {
1600 $log->info("\tNo (non-current) copies eligible to fill the hold.");
1601 if ( $old_best_still_valid ) {
1602 # the old copy is still available
1603 $log->debug("\tPushing current_copy back onto the targeting list");
1604 push @good_copies, $old_best;
1606 # oops, old copy is not available
1607 $log->debug("\tcurrent_copy is no longer available for targeting... NEXT HOLD, PLEASE!");
1608 $hold->update( { prev_check_time => 'today' } );
1609 $self->method_lookup('open-ils.storage.transaction.commit')->run;
1610 push @successes, { hold => $hold->id, eligible_copies => 0, error => 'NO_TARGETS' };
1615 # reset prox list after trimming good copies
1616 $prox_list = create_prox_list(
1618 [ grep { ''.$_->circ_lib eq $pu_lib && ( $_->status == 0 || $_->status == 7 ) } @good_copies ],
1622 $all_copies = [ grep { ''.$_->circ_lib ne $pu_lib && ( $_->status == 0 || $_->status == 7 ) } @good_copies ];
1624 my $min_prox = [ sort keys %$prox_list ]->[0];
1626 if ($hold->hold_type eq 'R' || $hold->hold_type eq 'F') { # Recall/Force holds bypass hold rules.
1627 $best = $good_copies[0] if(scalar @good_copies);
1629 $best = choose_nearest_copy($hold, { $min_prox => delete($$prox_list{$min_prox}) });
1632 $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
1635 $log->debug("\tNothing at the pickup lib, looking elsewhere among ".scalar(@$all_copies)." copies");
1637 $self->{max_loops}{$pu_lib} = $actor->request(
1638 'open-ils.actor.ou_setting.ancestor_default' => $pu_lib => 'circ.holds.max_org_unit_target_loops'
1641 if (defined($self->{max_loops}{$pu_lib})) {
1642 $self->{max_loops}{$pu_lib} = $self->{max_loops}{$pu_lib}{value};
1644 my %circ_lib_map = map { (''.$_->circ_lib => 1) } @$all_copies;
1645 my $circ_lib_list = [keys %circ_lib_map];
1647 my $cstore = OpenSRF::AppSession->create('open-ils.cstore');
1649 # Grab the "biggest" loop for this hold so far
1650 my $current_loop = $cstore->request(
1651 'open-ils.cstore.json_query',
1653 select => { aufhmxl => ['max'] },
1655 where => { hold => $hold->id}
1659 $current_loop = $current_loop->{max} if ($current_loop);
1660 $current_loop ||= 1;
1662 my $exclude_list = $cstore->request(
1663 'open-ils.cstore.json_query.atomic',
1665 select => { aufhol => ['circ_lib'] },
1667 where => { hold => $hold->id}
1672 if ($exclude_list && @$exclude_list) {
1673 $exclude_list = [map {$_->{circ_lib}} @$exclude_list];
1674 # check to see if we've used up every library in the potentials list
1675 for my $l ( @$circ_lib_list ) {
1677 for my $ex ( @$exclude_list ) {
1683 push(@keepers, $l) if ($keep);
1686 @keepers = @$circ_lib_list;
1689 $current_loop++ if (!@keepers);
1691 if ($self->{max_loops}{$pu_lib} && $self->{max_loops}{$pu_lib} >= $current_loop) {
1692 # We haven't exceeded max_loops yet
1694 for my $cp ( @$all_copies ) {
1695 push(@keeper_copies, $cp) if ( !@keepers || grep { $_ eq ''.$cp->circ_lib } @keepers );
1698 $all_copies = [@keeper_copies];
1700 # We have, and should remove potentials and cancel the hold
1701 my @oldmaps = action::hold_copy_map->search( hold => $hold->id );
1702 $_->delete for (@oldmaps);
1704 # cancel cause = un-targeted expiration
1705 $hold->update( { cancel_time => 'now', cancel_cause => 1 } );
1707 # refresh fields from the DB while still in the xact
1708 my $fm_hold = $hold->to_fieldmapper;
1710 $self->method_lookup('open-ils.storage.transaction.commit')->run;
1712 # tell A/T the hold was cancelled
1713 my $ses = OpenSRF::AppSession->create('open-ils.trigger');
1714 $ses->request('open-ils.trigger.event.autocreate',
1715 'hold_request.cancel.expire_no_target', $fm_hold, $fm_hold->pickup_lib);
1720 $prox_list = create_prox_list( $self, $pu_lib, $all_copies, $hold );
1722 $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
1726 $best = choose_nearest_copy($hold, $prox_list);
1729 $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
1731 # hold wasn't fulfilled, record the fact
1733 $log->info("\tHold was not (but should have been) fulfilled by ".$old_best->id);
1734 action::unfulfilled_hold_list->create(
1735 { hold => ''.$hold->id,
1736 current_copy => ''.$old_best->id,
1737 circ_lib => ''.$old_best->circ_lib,
1742 $hold->update( { current_copy => ''.$best->id, prev_check_time => 'now' } );
1743 $log->debug("\tUpdating hold [".$hold->id."] with new 'current_copy' [".$best->id."] for hold fulfillment.");
1745 $old_best_still_valid &&
1746 !action::hold_request
1748 { current_copy => $old_best->id,
1749 fulfillment_time => undef,
1750 cancel_time => undef,
1753 ( OpenILS::Utils::PermitHold::permit_copy_hold(
1754 { title => $old_best->call_number->record->to_fieldmapper,
1755 title_descriptor => $old_best->call_number->record->record_descriptor->next->to_fieldmapper,
1756 patron => $hold->usr->to_fieldmapper,
1757 copy => $old_best->to_fieldmapper,
1758 requestor => $hold->requestor->to_fieldmapper,
1759 request_lib => $hold->request_lib->to_fieldmapper,
1760 pickup_lib => $hold->pickup_lib->id,
1765 $hold->update( { prev_check_time => 'now', current_copy => ''.$old_best->id } );
1766 $log->debug( "\tRetargeting the previously targeted copy [".$old_best->id."]" );
1768 $hold->update( { prev_check_time => 'now' } );
1769 $log->info( "\tThere were no targetable copies for the hold" );
1770 process_recall($actor, $log, $hold, \@good_copies);
1773 $self->method_lookup('open-ils.storage.transaction.commit')->run;
1774 $log->info("\tProcessing of hold ".$hold->id." complete.");
1777 { hold => $hold->id,
1778 old_target => ($old_best ? $old_best->id : undef),
1779 eligible_copies => $copy_count,
1780 target => ($best ? $best->id : undef),
1781 found_copy => $found_copy };
1786 $log->error("Processing of hold failed: $e");
1787 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
1788 throw $e if ($e =~ /IS NOT CONNECTED TO THE NETWORK/o);
1795 __PACKAGE__->register_method(
1796 api_name => 'open-ils.storage.action.hold_request.copy_targeter',
1798 method => 'new_hold_copy_targeter',
1801 sub process_recall {
1802 my ($actor, $log, $hold, $good_copies) = @_;
1804 # Bail early if we don't have required settings to avoid spurious requests
1805 my ($recall_threshold, $return_interval, $fine_rules);
1807 my $rv = $actor->request(
1808 'open-ils.actor.ou_setting.ancestor_default', ''.$hold->pickup_lib, 'circ.holds.recall_threshold'
1812 $log->info("Recall threshold was not set; bailing out on hold ".$hold->id." processing.");
1815 $recall_threshold = $rv->{value};
1817 $rv = $actor->request(
1818 'open-ils.actor.ou_setting.ancestor_default', ''.$hold->pickup_lib, 'circ.holds.recall_return_interval'
1822 $log->info("Recall return interval was not set; bailing out on hold ".$hold->id." processing.");
1825 $return_interval = $rv->{value};
1827 $rv = $actor->request(
1828 'open-ils.actor.ou_setting.ancestor_default', ''.$hold->pickup_lib, 'circ.holds.recall_fine_rules'
1832 $fine_rules = $rv->{value};
1835 $log->info("Recall threshold: $recall_threshold; return interval: $return_interval");
1837 # We want checked out copies (status = 1) at the hold pickup lib
1838 my $all_copies = [grep { $_->status == 1 } grep {''.$_->circ_lib eq ''.$hold->pickup_lib } @$good_copies];
1840 my @copy_ids = map { $_->id } @$all_copies;
1842 $log->info("Found " . scalar(@$all_copies) . " eligible checked-out copies for recall");
1844 my $return_date = DateTime->now(time_zone => 'local')->add(seconds => interval_to_seconds($return_interval))->iso8601();
1846 # Iterate over the checked-out copies to find a copy with a
1847 # loan period longer than the recall threshold:
1848 my $circs = [ action::circulation->search_where(
1849 { target_copy => \@copy_ids, checkin_time => undef, duration => { '>' => $recall_threshold } },
1850 { order_by => 'due_date ASC' }
1853 # If we have a candidate copy, then:
1854 if (scalar(@$circs)) {
1855 my $circ = $circs->[0];
1856 $log->info("Recalling circ ID : " . $circ->id);
1858 # Give the user a new due date of either a full recall threshold,
1859 # or the return interval, whichever is further in the future
1860 my $threshold_date = DateTime::Format::ISO8601->parse_datetime(cleanse_ISO8601($circ->xact_start))->add(seconds => interval_to_seconds($recall_threshold))->iso8601();
1861 if (DateTime->compare(DateTime::Format::ISO8601->parse_datetime($threshold_date), DateTime::Format::ISO8601->parse_datetime($return_date)) == 1) {
1862 $return_date = $threshold_date;
1865 my $update_fields = {
1866 due_date => $return_date,
1867 renewal_remaining => 0,
1870 # If the OU hasn't defined new fine rules for recalls, keep them
1873 $log->info("Apply recall fine rules: $fine_rules");
1874 my $rules = OpenSRF::Utils::JSON->JSON2perl($fine_rules);
1875 $update_fields->{recurring_fine} = $rules->[0];
1876 $update_fields->{fine_interval} = $rules->[1];
1877 $update_fields->{max_fine} = $rules->[2];
1880 # Adjust circ for current user
1881 $circ->update($update_fields);
1883 # Create trigger event for notifying current user
1884 my $ses = OpenSRF::AppSession->create('open-ils.trigger');
1885 $ses->request('open-ils.trigger.event.autocreate', 'circ.recall.target', $circ->to_fieldmapper(), $circ->circ_lib->id);
1888 $log->info("Processing of hold ".$hold->id." for recall is now complete.");
1891 sub reservation_targeter {
1894 my $one_reservation = shift;
1896 local $OpenILS::Application::Storage::WRITE = 1;
1901 if ($one_reservation) {
1902 $self->method_lookup('open-ils.storage.transaction.begin')->run( $client );
1903 $reservations = [ booking::reservation->search_where( { id => $one_reservation, capture_time => undef, cancel_time => undef } ) ];
1906 # find all the reservations needing targeting
1908 booking::reservation->search_where(
1909 { current_resource => undef,
1910 cancel_time => undef,
1911 start_time => { '>' => 'now' }
1913 { order_by => 'start_time' }
1917 } catch Error with {
1919 die "Could not retrieve reservation requests:\n\n$e\n";
1923 for my $bresv (@$reservations) {
1925 #start a transaction if needed
1926 if ($self->method_lookup('open-ils.storage.transaction.current')->run) {
1927 $log->debug("Cleaning up after previous transaction\n");
1928 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
1930 $self->method_lookup('open-ils.storage.transaction.begin')->run( $client );
1931 $log->info("Processing reservation ".$bresv->id."...\n");
1933 #first, re-fetch the hold, to make sure it's not captured already
1934 $bresv->remove_from_object_index();
1935 $bresv = booking::reservation->retrieve( $bresv->id );
1937 die "OK\n" if (!$bresv or $bresv->capture_time or $bresv->cancel_time);
1939 my $end_time = $parser->parse_datetime( cleanse_ISO8601( $bresv->end_time ) );
1940 if (DateTime->compare($end_time, DateTime->now) < 0) {
1942 # cancel cause = un-targeted expiration
1943 $bresv->update( { cancel_time => 'now' } );
1945 # refresh fields from the DB while still in the xact
1946 my $fm_bresv = $bresv->to_fieldmapper;
1948 $self->method_lookup('open-ils.storage.transaction.commit')->run;
1950 # tell A/T the reservation was cancelled
1951 my $ses = OpenSRF::AppSession->create('open-ils.trigger');
1952 $ses->request('open-ils.trigger.event.autocreate',
1953 'booking.reservation.cancel.expire_no_target', $fm_bresv, $fm_bresv->pickup_lib);
1958 my $possible_resources;
1960 # find all the potential resources
1961 if (!$bresv->target_resource) {
1962 my $filter = { type => $bresv->target_resource_type };
1963 my $attr_maps = [ booking::reservation_attr_value_map->search( reservation => $bresv->id) ];
1965 $filter->{attribute_values} = [ map { $_->attr_value } @$attr_maps ] if (@$attr_maps);
1967 $filter->{available} = [$bresv->start_time, $bresv->end_time];
1968 my $ses = OpenSRF::AppSession->create('open-ils.booking');
1969 $possible_resources = $ses->request('open-ils.booking.resources.filtered_id_list', undef, $filter)->gather(1);
1971 $possible_resources = $bresv->target_resource;
1974 my $all_resources = [ booking::resource->search( id => $possible_resources ) ];
1975 @$all_resources = grep { isTrue($_->type->transferable) || $_->owner.'' eq $bresv->pickup_lib.'' } @$all_resources;
1978 my @good_resources = ();
1980 for my $res (@$all_resources) {
1981 unless (isTrue($res->type->catalog_item)) {
1982 push @good_resources, $res;
1986 my $copy = [ asset::copy->search( deleted => 'f', barcode => $res->barcode )]->[0];
1989 push @good_resources, $res;
1993 # At this point, if we're just targeting one specific
1994 # resource, just succeed. We don't care about its present
1996 if ($bresv->target_resource) {
1997 push @good_resources, $res;
2001 if ($copy->status->id == 0 || $copy->status->id == 7) {
2002 push @good_resources, $res;
2006 if ($copy->status->id == 1) {
2007 my $circs = [ action::circulation->search_where(
2008 {target_copy => $copy->id, checkin_time => undef },
2009 { order_by => 'id DESC' }
2013 my $due_date = $circs->[0]->due_date;
2014 $due_date = $parser->parse_datetime( cleanse_ISO8601( $due_date ) );
2015 my $start_time = $parser->parse_datetime( cleanse_ISO8601( $bresv->start_time ) );
2016 if (DateTime->compare($start_time, $due_date) < 0) {
2017 $conflicts{$res->id} = $circs->[0]->to_fieldmapper;
2021 push @good_resources, $res;
2027 push @good_resources, $res if (isTrue($copy->status->holdable));
2030 # let 'em know we're still working
2031 $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
2033 # if we have no copies ...
2034 if (!@good_resources) {
2035 $log->info("\tNo resources available for targeting at all!\n");
2036 push @successes, { reservation => $bresv->id, eligible_copies => 0, error => 'NO_COPIES', conflicts => \%conflicts };
2039 $self->method_lookup('open-ils.storage.transaction.commit')->run;
2043 $log->debug("\t".scalar(@good_resources)." resources available for targeting...");
2045 # LFW: note that after the inclusion of hold proximity
2046 # adjustment, this prox_list is the only prox_list
2047 # array in this perl package. Other occurences are
2053 $_->owner == $bresv->pickup_lib
2057 $all_resources = [grep {$_->owner != $bresv->pickup_lib } @good_resources];
2058 # $all_copies is now a list of copies not at the pickup library
2060 my $best = shift @good_resources;
2061 $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
2064 $log->debug("\tNothing at the pickup lib, looking elsewhere among ".scalar(@$all_resources)." resources");
2068 sort { $a->[0] <=> $b->[0] }
2070 [ actor::org_unit_proximity->search_where(
2071 { from_org => $bresv->pickup_lib.'', to_org => $_->owner.'' }
2077 $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
2079 $best = shift @$prox_list
2083 $bresv->update( { current_resource => ''.$best->id } );
2084 $log->debug("\tUpdating reservation [".$bresv->id."] with new 'current_resource' [".$best->id."] for reservation fulfillment.");
2087 $self->method_lookup('open-ils.storage.transaction.commit')->run;
2088 $log->info("\tProcessing of bresv ".$bresv->id." complete.");
2091 { reservation => $bresv->id,
2092 current_resource => ($best ? $best->id : undef) };
2097 $log->error("Processing of bresv failed: $e");
2098 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
2099 throw $e if ($e =~ /IS NOT CONNECTED TO THE NETWORK/o);
2106 __PACKAGE__->register_method(
2107 api_name => 'open-ils.storage.booking.reservation.resource_targeter',
2109 method => 'reservation_targeter',
2114 my %cache = (titles => {}, cns => {});
2116 sub copy_hold_capture {
2121 if (!defined($cps)) {
2123 $cps = [ asset::copy->search( id => $hold->target ) ];
2124 } catch Error with {
2126 die "Could not retrieve initial volume list:\n\n$e\n";
2130 my @copies = grep { $_->holdable } @$cps;
2132 for (my $i = 0; $i < @$cps; $i++) {
2133 next unless $$cps[$i];
2135 my $cn = $cache{cns}{$copies[$i]->call_number};
2136 my $rec = $cache{titles}{$cn->record};
2137 $copies[$i] = undef if ($copies[$i] && !grep{ $copies[$i]->status eq $_->id}@$statuses);
2138 $copies[$i] = undef if ($copies[$i] && !grep{ $copies[$i]->location eq $_->id}@$locations);
2139 $copies[$i] = undef if (
2141 !$self->{user_filter}->request(
2142 'open-ils.circ.permit_hold',
2143 $hold->to_fieldmapper, do {
2144 my $cp_fm = $copies[$i]->to_fieldmapper;
2145 $cp_fm->circ_lib( $copies[$i]->circ_lib->to_fieldmapper );
2146 $cp_fm->location( $copies[$i]->location->to_fieldmapper );
2147 $cp_fm->status( $copies[$i]->status->to_fieldmapper );
2150 { title => $rec->to_fieldmapper,
2151 usr => actor::user->retrieve($hold->usr)->to_fieldmapper,
2152 requestor => actor::user->retrieve($hold->requestor)->to_fieldmapper,
2155 $self->{client}->status( new OpenSRF::DomainObject::oilsContinueStatus );
2158 @copies = grep { $_ } @copies;
2160 my $count = @copies;
2162 return unless ($count);
2164 action::hold_copy_map->search( hold => $hold->id )->delete_all;
2167 $self->{client}->respond( "\tMapping ".scalar(@copies)." eligable copies for hold ".$hold->id."\n");
2168 for my $c (@copies) {
2169 push @maps, action::hold_copy_map->create( { hold => $hold->id, target_copy => $c->id } );
2171 $self->{client}->respond( "\tA total of ".scalar(@maps)." mapping were created for hold ".$hold->id."\n");
2177 sub choose_nearest_copy {
2179 my $prox_list = shift;
2181 for my $p ( sort keys %$prox_list ) {
2182 next unless (ref $$prox_list{$p});
2184 my @capturable = @{ $$prox_list{$p} };
2185 next unless (@capturable);
2187 my $rand = int(rand(scalar(@capturable)));
2189 while (my ($c) = splice(@capturable, $rand, 1)) {
2190 return $c if !exists($seen{$c->id}) && ( OpenILS::Utils::PermitHold::permit_copy_hold(
2191 { title => $c->call_number->record->to_fieldmapper,
2192 title_descriptor => $c->call_number->record->record_descriptor->next->to_fieldmapper,
2193 patron => $hold->usr->to_fieldmapper,
2194 copy => $c->to_fieldmapper,
2195 requestor => $hold->requestor->to_fieldmapper,
2196 request_lib => $hold->request_lib->to_fieldmapper,
2197 pickup_lib => $hold->pickup_lib->id,
2203 last unless(@capturable);
2204 $rand = int(rand(scalar(@capturable)));
2209 sub create_prox_list {
2215 my $actor = OpenSRF::AppSession->create('open-ils.actor');
2218 for my $cp (@$copies) {
2219 my ($prox) = $self->method_lookup('open-ils.storage.asset.copy.proximity')->run( $cp, $lib, $hold );
2220 next unless (defined($prox));
2222 my $copy_circ_lib = ''.$cp->circ_lib;
2223 # Fetch the weighting value for hold targeting, defaulting to 1
2224 $self->{target_weight}{$copy_circ_lib} ||= $actor->request(
2225 'open-ils.actor.ou_setting.ancestor_default' => $copy_circ_lib.'' => 'circ.holds.org_unit_target_weight'
2227 $self->{target_weight}{$copy_circ_lib} = $self->{target_weight}{$copy_circ_lib}{value} if (ref $self->{target_weight}{$copy_circ_lib});
2228 $self->{target_weight}{$copy_circ_lib} ||= 1;
2230 $prox_list{$prox} = [] unless defined($prox_list{$prox});
2231 for my $w ( 1 .. $self->{target_weight}{$copy_circ_lib} ) {
2232 push @{$prox_list{$prox}}, $cp;
2238 sub volume_hold_capture {
2243 if (!defined($vols)) {
2245 $vols = [ asset::call_number->search( id => $hold->target ) ];
2246 $cache{cns}{$_->id} = $_ for (@$vols);
2247 } catch Error with {
2249 die "Could not retrieve initial volume list:\n\n$e\n";
2253 my @v_ids = map { $_->id } @$vols;
2257 $cp_list = [ asset::copy->search( call_number => \@v_ids ) ];
2259 } catch Error with {
2261 warn "Could not retrieve copy list:\n\n$e\n";
2264 $self->copy_hold_capture($hold,$cp_list) if (ref $cp_list and @$cp_list);
2267 sub title_hold_capture {
2272 if (!defined($titles)) {
2274 $titles = [ biblio::record_entry->search( id => $hold->target ) ];
2275 $cache{titles}{$_->id} = $_ for (@$titles);
2276 } catch Error with {
2278 die "Could not retrieve initial title list:\n\n$e\n";
2282 my @t_ids = map { $_->id } @$titles;
2285 ($cn_list) = $self->method_lookup('open-ils.storage.direct.asset.call_number.search.record.atomic')->run( \@t_ids );
2287 } catch Error with {
2289 warn "Could not retrieve volume list:\n\n$e\n";
2292 $cache{cns}{$_->id} = $_ for (@$cn_list);
2294 $self->volume_hold_capture($hold,$cn_list) if (ref $cn_list and @$cn_list);
2297 sub metarecord_hold_capture {
2303 $titles = [ metabib::metarecord_source_map->search( metarecord => $hold->target) ];
2305 } catch Error with {
2307 die "Could not retrieve initial title list:\n\n$e\n";
2311 my @recs = map {$_->record} metabib::record_descriptor->search( record => $titles, item_type => [split '', $hold->holdable_formats] );
2313 $titles = [ biblio::record_entry->search( id => \@recs ) ];
2315 } catch Error with {
2317 die "Could not retrieve format-pruned title list:\n\n$e\n";
2321 $cache{titles}{$_->id} = $_ for (@$titles);
2322 $self->title_hold_capture($hold,$titles) if (ref $titles and @$titles);