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 # ScriptBuilder fleshes the circ_lib, which confuses things; ensure we
510 # are working with a circ lib ID and not an object
512 if (ref $cp->circ_lib) {
513 $cp_circ_lib = $cp->circ_lib->id;
515 $cp_circ_lib = $cp->circ_lib;
519 if (ref $cp->call_number->owning_lib) {
520 $cp_owning_lib = $cp->call_number->owning_lib->id;
522 $cp_owning_lib = $cp->call_number->owning_lib;
525 my ($holdsort, $addl_cte, $addl_join) =
526 build_hold_sort_clause(get_hold_sort_order($cp_owning_lib), $cp, $here);
528 local $OpenILS::Application::Storage::WRITE = 1;
530 my $ids = action::hold_request->db_Main->selectcol_arrayref(<<" SQL", {}, $cp_circ_lib, $here, $cp->id, $age);
531 WITH go_home_interval AS (
532 SELECT OILS_JSON_TO_TEXT(
533 (SELECT value FROM actor.org_unit_ancestor_setting(
534 'circ.hold_go_home_interval', ?
536 ))::INTERVAL AS value
540 FROM action.hold_request h
541 JOIN actor.org_unit_proximity p ON (p.from_org = ? AND p.to_org = h.pickup_lib)
542 JOIN action.hold_copy_map hm ON (hm.hold = h.id)
543 JOIN actor.usr au ON (au.id = h.usr)
544 JOIN permission.grp_tree pgt ON (au.profile = pgt.id)
545 LEFT JOIN actor.usr_standing_penalty ausp
546 ON ( au.id = ausp.usr AND ( ausp.stop_date IS NULL OR ausp.stop_date > NOW() ) )
547 LEFT JOIN config.standing_penalty csp
548 ON ( csp.id = ausp.standing_penalty AND csp.block_list LIKE '%CAPTURE%' )
550 WHERE hm.target_copy = ?
551 AND (AGE(NOW(),h.request_time) >= CAST(? AS INTERVAL) OR hm.proximity = 0 OR p.prox = 0)
552 AND h.capture_time IS NULL
553 AND h.cancel_time IS NULL
554 AND (h.expire_time IS NULL OR h.expire_time > NOW())
555 AND h.frozen IS FALSE
557 ORDER BY CASE WHEN h.hold_type IN ('R','F') THEN 0 ELSE 1 END, $holdsort
561 $client->respond( $_ ) for ( @$ids );
564 __PACKAGE__->register_method(
565 api_name => 'open-ils.storage.action.hold_request.nearest_hold',
568 method => 'nearest_hold',
571 sub targetable_holds {
574 my $check_expire = shift;
576 $check_expire ||= '12h';
578 local $OpenILS::Application::Storage::WRITE = 1;
580 # json_query can *almost* represent this query, but can't
581 # handle the CASE statement or the interval arithmetic
582 my $query = <<" SQL";
583 SELECT ahr.id, mmsm.metarecord
584 FROM action.hold_request ahr
585 JOIN reporter.hold_request_record USING (id)
586 JOIN metabib.metarecord_source_map mmsm ON (bib_record = source)
587 WHERE capture_time IS NULL
588 AND (prev_check_time IS NULL or prev_check_time < (NOW() - ?::interval))
589 AND fulfillment_time IS NULL
590 AND cancel_time IS NULL
592 ORDER BY CASE WHEN ahr.hold_type = 'F' THEN 0 ELSE 1 END, selection_depth DESC, request_time;
594 my $sth = action::hold_request->db_Main->prepare_cached($query);
595 $sth->execute($check_expire);
596 $client->respond( $_ ) for @{ $sth->fetchall_arrayref };
601 __PACKAGE__->register_method(
602 api_name => 'open-ils.storage.action.hold_request.targetable_holds.id_list',
605 method => 'targetable_holds',
607 Returns ordered list of hold request and metarecord IDs
608 for all hold requests that are available for initial targeting
610 @param check interval
611 @return list of pairs of hold request and metarecord IDs
615 sub next_resp_group_id {
619 # XXX This is not replication safe!!!
621 my ($id) = action::survey->db_Main->selectrow_array(<<" SQL");
622 SELECT NEXTVAL('action.survey_response_group_id_seq'::TEXT)
626 __PACKAGE__->register_method(
627 api_name => 'open-ils.storage.action.survey_response.next_group_id',
629 method => 'next_resp_group_id',
632 sub patron_circ_summary {
637 return undef unless ($id);
638 my $c_table = action::circulation->table;
639 my $b_table = money::billing->table;
641 $log->debug("Retrieving patron summary for id $id", DEBUG);
643 my $select = <<" SQL";
644 SELECT COUNT(DISTINCT c.id), SUM( COALESCE(b.amount,0) )
646 LEFT OUTER JOIN $b_table b ON (c.id = b.xact AND b.voided = FALSE)
648 AND c.xact_finish IS NULL
650 c.stop_fines NOT IN ('CLAIMSRETURNED','LOST')
651 OR c.stop_fines IS NULL
655 return action::survey->db_Main->selectrow_arrayref($select, {}, $id);
657 __PACKAGE__->register_method(
658 api_name => 'open-ils.storage.action.circulation.patron_summary',
660 method => 'patron_circ_summary',
663 #XXX Fix stored proc calls
664 sub find_local_surveys {
669 return undef unless ($ou);
670 my $s_table = action::survey->table;
672 my $select = <<" SQL";
675 JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
676 WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
679 my $sth = action::survey->db_Main->prepare_cached($select);
682 $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
686 __PACKAGE__->register_method(
687 api_name => 'open-ils.storage.action.survey.all',
690 method => 'find_local_surveys',
693 #XXX Fix stored proc calls
694 sub find_opac_surveys {
699 return undef unless ($ou);
700 my $s_table = action::survey->table;
702 my $select = <<" SQL";
705 JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
706 WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
710 my $sth = action::survey->db_Main->prepare_cached($select);
713 $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
717 __PACKAGE__->register_method(
718 api_name => 'open-ils.storage.action.survey.opac',
721 method => 'find_opac_surveys',
728 my $limit = shift || 10;
729 my $offset = shift || 0;
731 return undef unless ($ou);
732 my $h_table = action::hold_request->table;
733 my $a_table = asset::copy->table;
734 my $ord_table = asset::copy_location_order->table;
736 my $idlist = 1 if ($self->api_name =~/id_list/o);
737 my $count = 1 if ($self->api_name =~/count$/o);
739 my $status_filter = '';
740 $status_filter = 'AND a.status IN (0,7)' if ($self->api_name =~/status_filtered/o);
742 my $select = <<" SQL";
745 JOIN $a_table a ON (h.current_copy = a.id)
746 LEFT JOIN $ord_table ord ON (a.location = ord.location AND a.circ_lib = ord.org)
748 AND h.capture_time IS NULL
749 AND h.cancel_time IS NULL
750 AND (h.expire_time IS NULL OR h.expire_time > NOW())
753 FROM actor.usr_standing_penalty ausp
754 JOIN config.standing_penalty csp ON (
755 csp.id = ausp.standing_penalty
756 AND csp.block_list LIKE '%CAPTURE%'
758 WHERE h.usr = ausp.usr
759 AND ( ausp.stop_date IS NULL OR ausp.stop_date > NOW() )
762 ORDER BY CASE WHEN ord.position IS NOT NULL THEN ord.position ELSE 999 END, h.request_time
769 SELECT count(DISTINCT h.id)
771 JOIN $a_table a ON (h.current_copy = a.id)
773 AND h.capture_time IS NULL
774 AND h.cancel_time IS NULL
775 AND (h.expire_time IS NULL OR h.expire_time > NOW())
778 FROM actor.usr_standing_penalty ausp
779 JOIN config.standing_penalty csp ON (
780 csp.id = ausp.standing_penalty
781 AND csp.block_list LIKE '%CAPTURE%'
783 WHERE h.usr = ausp.usr
784 AND ( ausp.stop_date IS NULL OR ausp.stop_date > NOW() )
790 my $sth = action::survey->db_Main->prepare_cached($select);
794 $client->respond( $sth->fetchall_arrayref()->[0][0] );
796 $client->respond( $_->{id} ) for ( $sth->fetchall_hash );
798 $client->respond( $_->to_fieldmapper ) for ( map { action::hold_request->construct($_) } $sth->fetchall_hash );
803 __PACKAGE__->register_method(
804 api_name => 'open-ils.storage.direct.action.hold_request.pull_list.current_copy_circ_lib.count',
808 "Returns a count of holds for a specific library's pull list.",
809 [ [org_unit => "The library's org id", "number"] ],
810 ['A count of holds for the stated library to pull ', 'number']
812 method => 'hold_pull_list',
814 __PACKAGE__->register_method(
815 api_name => 'open-ils.storage.direct.action.hold_request.pull_list.current_copy_circ_lib.status_filtered.count',
819 "Returns a status filtered count of holds for a specific library's pull list.",
820 [ [org_unit => "The library's org id", "number"] ],
821 ['A status filtered count of holds for the stated library to pull ', 'number']
823 method => 'hold_pull_list',
825 __PACKAGE__->register_method(
826 api_name => 'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib',
830 "Returns the hold ids for a specific library's pull list.",
831 [ [org_unit => "The library's org id", "number"],
832 [limit => 'An optional page size, defaults to 10', 'number'],
833 [offset => 'Offset for paging, defaults to 0, 0 based', 'number'],
835 ['A list of holds for the stated library to pull for', 'array']
837 method => 'hold_pull_list',
839 __PACKAGE__->register_method(
840 api_name => 'open-ils.storage.direct.action.hold_request.pull_list.search.current_copy_circ_lib',
844 "Returns the holds for a specific library's pull list.",
845 [ [org_unit => "The library's org id", "number"],
846 [limit => 'An optional page size, defaults to 10', 'number'],
847 [offset => 'Offset for paging, defaults to 0, 0 based', 'number'],
849 ['A list of holds for the stated library to pull for', 'array']
851 method => 'hold_pull_list',
853 __PACKAGE__->register_method(
854 api_name => 'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib.status_filtered',
858 "Returns the hold ids for a specific library's pull list that are definitely in that library, based on status.",
859 [ [org_unit => "The library's org id", "number"],
860 [limit => 'An optional page size, defaults to 10', 'number'],
861 [offset => 'Offset for paging, defaults to 0, 0 based', 'number'],
863 ['A list of holds for the stated library to pull for', 'array']
865 method => 'hold_pull_list',
867 __PACKAGE__->register_method(
868 api_name => 'open-ils.storage.direct.action.hold_request.pull_list.search.current_copy_circ_lib.status_filtered',
872 "Returns the holds for a specific library's pull list that are definitely in that library, based on status.",
873 [ [org_unit => "The library's org id", "number"],
874 [limit => 'An optional page size, defaults to 10', 'number'],
875 [offset => 'Offset for paging, defaults to 0, 0 based', 'number'],
877 ['A list of holds for the stated library to pull for', 'array']
879 method => 'hold_pull_list',
882 sub find_optional_surveys {
887 return undef unless ($ou);
888 my $s_table = action::survey->table;
890 my $select = <<" SQL";
893 JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
894 WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
895 AND s.required IS FALSE;
898 my $sth = action::survey->db_Main->prepare_cached($select);
901 $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
905 __PACKAGE__->register_method(
906 api_name => 'open-ils.storage.action.survey.optional',
909 method => 'find_optional_surveys',
912 sub find_required_surveys {
917 return undef unless ($ou);
918 my $s_table = action::survey->table;
920 my $select = <<" SQL";
923 JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
924 WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
925 AND s.required IS TRUE;
928 my $sth = action::survey->db_Main->prepare_cached($select);
931 $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
935 __PACKAGE__->register_method(
936 api_name => 'open-ils.storage.action.survey.required',
939 method => 'find_required_surveys',
942 sub find_usr_summary_surveys {
947 return undef unless ($ou);
948 my $s_table = action::survey->table;
950 my $select = <<" SQL";
953 JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
954 WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
955 AND s.usr_summary IS TRUE;
958 my $sth = action::survey->db_Main->prepare_cached($select);
961 $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
965 __PACKAGE__->register_method(
966 api_name => 'open-ils.storage.action.survey.usr_summary',
969 method => 'find_usr_summary_surveys',
972 sub seconds_to_interval_hash {
973 my $interval = shift;
974 my $limit = shift || 's';
975 $limit =~ s/^(.)/$1/o;
979 my ($y,$ym,$M,$Mm,$w,$wm,$d,$dm,$h,$hm,$m,$mm,$s);
980 my ($year, $month, $week, $day, $hour, $minute, $second) =
981 ('years','months','weeks','days', 'hours', 'minutes', 'seconds');
983 if ($y = int($interval / (60 * 60 * 24 * 365))) {
985 $ym = $interval % (60 * 60 * 24 * 365);
989 return %output if ($limit eq 'y');
991 if ($M = int($ym / ((60 * 60 * 24 * 365)/12))) {
992 $output{$month} = $M;
993 $Mm = $ym % ((60 * 60 * 24 * 365)/12);
997 return %output if ($limit eq 'M');
999 if ($w = int($Mm / 604800)) {
1000 $output{$week} = $w;
1005 return %output if ($limit eq 'w');
1007 if ($d = int($wm / 86400)) {
1013 return %output if ($limit eq 'd');
1015 if ($h = int($dm / 3600)) {
1016 $output{$hour} = $h;
1021 return %output if ($limit eq 'h');
1023 if ($m = int($hm / 60)) {
1024 $output{$minute} = $m;
1029 return %output if ($limit eq 'm');
1031 if ($s = int($mm)) {
1032 $output{$second} = $s;
1034 $output{$second} = 0 unless (keys %output);
1040 sub generate_fines {
1044 my $overbill = shift;
1046 local $OpenILS::Application::Storage::WRITE = 1;
1051 action::circulation->search_where( { id => $circ, stop_fines => undef } ),
1052 booking::reservation->search_where( { id => $circ, return_time => undef, cancel_time => undef } );
1054 push @circs, overdue_circs();
1057 my %hoo = map { ( $_->id => $_ ) } actor::org_unit::hours_of_operation->retrieve_all;
1059 my $penalty = OpenSRF::AppSession->create('open-ils.penalty');
1060 for my $c (@circs) {
1062 my $ctype = ref($c);
1063 $ctype =~ s/^.+::(\w+)$/$1/;
1065 my $due_date_method = 'due_date';
1066 my $target_copy_method = 'target_copy';
1067 my $circ_lib_method = 'circ_lib';
1068 my $recurring_fine_method = 'recurring_fine';
1069 my $is_reservation = 0;
1070 if ($ctype eq 'reservation') {
1071 $is_reservation = 1;
1072 $due_date_method = 'end_time';
1073 $target_copy_method = 'current_resource';
1074 $circ_lib_method = 'pickup_lib';
1075 $recurring_fine_method = 'fine_amount';
1076 next unless ($c->fine_interval);
1078 #TODO: reservation grace periods
1079 my $grace_period = ($is_reservation ? 0 : interval_to_seconds($c->grace_period));
1082 if ($self->method_lookup('open-ils.storage.transaction.current')->run) {
1083 $log->debug("Cleaning up after previous transaction\n");
1084 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
1086 $self->method_lookup('open-ils.storage.transaction.begin')->run( $client );
1088 sprintf("Processing %s %d...",
1089 ($is_reservation ? "reservation" : "circ"), $c->id
1094 my $due_dt = $parser->parse_datetime( cleanse_ISO8601( $c->$due_date_method ) );
1096 my $due = $due_dt->epoch;
1099 my $fine_interval = $c->fine_interval;
1100 $fine_interval =~ s/(\d{2}):(\d{2}):(\d{2})/$1 h $2 m $3 s/o;
1101 $fine_interval = interval_to_seconds( $fine_interval );
1103 if ( $fine_interval == 0 || int($c->$recurring_fine_method * 100) == 0 || int($c->max_fine * 100) == 0 ) {
1104 $client->respond( "Fine Generator skipping circ due to 0 fine interval, 0 fine rate, or 0 max fine.\n" );
1105 $log->info( "Fine Generator skipping circ " . $c->id . " due to 0 fine interval, 0 fine rate, or 0 max fine." );
1109 if ( $is_reservation and $fine_interval >= interval_to_seconds('1d') ) {
1110 my $tz_offset_s = 0;
1111 if ($due_dt->strftime('%z') =~ /(-|\+)(\d{2}):?(\d{2})/) {
1112 $tz_offset_s = $1 . interval_to_seconds( "${2}h ${3}m");
1115 $due -= ($due % $fine_interval) + $tz_offset_s;
1116 $now -= ($now % $fine_interval) + $tz_offset_s;
1120 "ARG! Overdue $ctype ".$c->id.
1121 " for item ".$c->$target_copy_method.
1122 " (user ".$c->usr.").\n".
1123 "\tItem was due on or before: ".localtime($due)."\n");
1125 my @fines = money::billing->search_where(
1128 billing_ts => { '>' => $c->$due_date_method } },
1129 { order_by => 'billing_ts DESC'}
1133 my $fine = $fines[$f_idx] if (@fines);
1135 $fine = $fines[++$f_idx] while ($fine and $fine->voided);
1138 my $current_fine_total = 0;
1139 $current_fine_total += int($_->amount * 100) for (grep { $_ and !$_->voided } @fines);
1143 $client->respond( "Last billing time: ".$fine->billing_ts." (clensed format: ".cleanse_ISO8601( $fine->billing_ts ).")");
1144 $last_fine = $parser->parse_datetime( cleanse_ISO8601( $fine->billing_ts ) )->epoch;
1146 $log->info( "Potential first billing for circ ".$c->id );
1149 $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});
1152 return if ($last_fine > $now);
1153 # Generate fines for each past interval, including the one we are inside
1154 my $pending_fine_count = ceil( ($now - $last_fine) / $fine_interval );
1156 if ( $last_fine == $due # we have no fines yet
1157 && $grace_period # and we have a grace period
1158 && $now < $due + $grace_period # and some date math says were are within the grace period
1160 $client->respond( "Still inside grace period of: ". seconds_to_interval( $grace_period )."\n" );
1161 $log->info( "Circ ".$c->id." is still inside grace period of: $grace_period [". seconds_to_interval( $grace_period ).']' );
1165 $client->respond( "\t$pending_fine_count pending fine(s)\n" );
1166 return unless ($pending_fine_count);
1168 my $recurring_fine = int($c->$recurring_fine_method * 100);
1169 my $max_fine = int($c->max_fine * 100);
1171 my $skip_closed_check = $U->ou_ancestor_setting_value(
1172 $c->$circ_lib_method->to_fieldmapper->id, 'circ.fines.charge_when_closed');
1173 $skip_closed_check = $U->is_true($skip_closed_check);
1175 my $truncate_to_max_fine = $U->ou_ancestor_setting_value(
1176 $c->$circ_lib_method->to_fieldmapper->id, 'circ.fines.truncate_to_max_fine');
1177 $truncate_to_max_fine = $U->is_true($truncate_to_max_fine);
1179 my ($latest_billing_ts, $latest_amount) = ('',0);
1180 for (my $bill = 1; $bill <= $pending_fine_count; $bill++) {
1182 if ($current_fine_total >= $max_fine) {
1183 $c->update({stop_fines => 'MAXFINES', stop_fines_time => 'now'}) if ($ctype eq 'circulation');
1185 "\tMaximum fine level of ".$c->max_fine.
1186 " reached for this $ctype.\n".
1187 "\tNo more fines will be generated.\n" );
1191 # XXX Use org time zone (or default to 'local') once we have the ou setting built for that
1192 my $billing_ts = DateTime->from_epoch( epoch => $last_fine, time_zone => 'local' );
1193 my $current_bill_count = $bill;
1194 while ( $current_bill_count ) {
1195 $billing_ts->add( seconds_to_interval_hash( $fine_interval ) );
1196 $current_bill_count--;
1199 my $timestamptz = $billing_ts->strftime('%FT%T%z');
1200 if (!$skip_closed_check) {
1201 my $dow = $billing_ts->day_of_week_0();
1202 my $dow_open = "dow_${dow}_open";
1203 my $dow_close = "dow_${dow}_close";
1205 if (my $h = $hoo{$c->$circ_lib_method}) {
1206 next if ( $h->$dow_open eq '00:00:00' and $h->$dow_close eq '00:00:00');
1209 my @cl = actor::org_unit::closed_date->search_where(
1210 { close_start => { '<=' => $timestamptz },
1211 close_end => { '>=' => $timestamptz },
1212 org_unit => $c->$circ_lib_method }
1217 # The billing amount for this billing normally ought to be the recurring fine amount.
1218 # However, if the recurring fine amount would cause total fines to exceed the max fine amount,
1219 # we may wish to reduce the amount for this billing (if circ.fines.truncate_to_max_fine is true).
1220 my $this_billing_amount = $recurring_fine;
1221 if ( $truncate_to_max_fine && ($current_fine_total + $this_billing_amount) > $max_fine ) {
1222 $this_billing_amount = ($max_fine - $current_fine_total);
1224 $current_fine_total += $this_billing_amount;
1225 $latest_amount += $this_billing_amount;
1226 $latest_billing_ts = $timestamptz;
1228 money::billing->create(
1229 { xact => ''.$c->id,
1230 note => "System Generated Overdue Fine",
1231 billing_type => "Overdue materials",
1233 amount => sprintf('%0.2f', $this_billing_amount/100),
1234 billing_ts => $timestamptz,
1240 $client->respond( "\t\tAdding fines totaling $latest_amount for overdue up to $latest_billing_ts\n" )
1241 if ($latest_billing_ts and $latest_amount);
1243 $self->method_lookup('open-ils.storage.transaction.commit')->run;
1247 # Caluclate penalties inline
1248 OpenILS::Utils::Penalty->calculate_penalties(
1249 undef, $c->usr->to_fieldmapper->id.'', $c->$circ_lib_method->to_fieldmapper->id.'');
1253 # Calculate penalties with an aysnc call to the penalty server. This approach
1254 # may lead to duplicate penalties since multiple penalty processes for a
1255 # given user may be running at the same time. Leave this here for reference
1256 # in case we later find that asyc calls are needed in some environments.
1258 'open-ils.penalty.patron_penalty.calculate',
1259 { patronid => ''.$c->usr,
1260 context_org => ''.$c->$circ_lib_method,
1271 $client->respond( "Error processing overdue $ctype [".$c->id."]:\n\n$e\n" );
1272 $log->error("Error processing overdue $ctype [".$c->id."]:\n$e\n");
1273 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
1274 last if ($e =~ /IS NOT CONNECTED TO THE NETWORK/o);
1278 __PACKAGE__->register_method(
1279 api_name => 'open-ils.storage.action.circulation.overdue.generate_fines',
1282 method => 'generate_fines',
1286 sub MR_records_matching_format {
1293 # find filters for MR holds
1295 if (defined($filter)) {
1296 ($mr_filter) = @{action::hold_request->db_Main->selectcol_arrayref(
1297 'SELECT metabib.compile_composite_attr(?)',
1303 my $records = [metabib::metarecord->retrieve($MR)->source_records];
1305 my $q = 'SELECT source FROM metabib.record_attr_vector_list WHERE source = ? AND vlist @@ ? AND asset.record_has_holdable_copy(?,?)';
1306 my @args = ( $mr_filter, $org );
1308 $q = 'SELECT true WHERE asset.record_has_holdable_copy(?,?)';
1312 for my $r ( map { isTrue($_->deleted) ? () : ($_->id) } @$records ) {
1313 # the map{} below is tricky. it puts the record ID in front of each param. see $q above
1314 $client->respond($r)
1315 if @{action::hold_request->db_Main->selectcol_arrayref( $q, {}, map { ( $r => $_ ) } @args )};
1318 return; # discard final l-val
1320 __PACKAGE__->register_method(
1321 api_name => 'open-ils.storage.metarecord.filtered_records',
1325 method => 'MR_records_matching_format',
1329 sub new_hold_copy_targeter {
1332 my $check_expire = shift;
1333 my $one_hold = shift;
1334 my $find_copy = shift;
1336 local $OpenILS::Application::Storage::WRITE = 1;
1338 $self->{target_weight} = {};
1339 $self->{max_loops} = {};
1345 $self->method_lookup('open-ils.storage.transaction.begin')->run( $client );
1346 $holds = [ action::hold_request->search_where( { id => $one_hold, fulfillment_time => undef, cancel_time => undef, frozen => 'f' } ) ];
1347 } elsif ( $check_expire ) {
1349 # what's the retarget time threashold?
1351 $check_expire ||= '12h';
1352 $check_expire = interval_to_seconds( $check_expire );
1354 my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = gmtime(time() - $check_expire);
1357 my $expire_threshold = sprintf(
1358 '%s-%0.2d-%0.2dT%0.2d:%0.2d:%0.2d-00',
1359 $year, $mon, $mday, $hour, $min, $sec
1362 # find all the holds holds needing retargeting
1363 $holds = [ action::hold_request->search_where(
1364 { capture_time => undef,
1365 fulfillment_time => undef,
1366 cancel_time => undef,
1368 prev_check_time => { '<=' => $expire_threshold },
1370 { order_by => 'selection_depth DESC, request_time,prev_check_time' } ) ];
1372 # find all the holds holds needing first time targeting
1373 push @$holds, action::hold_request->search(
1374 capture_time => undef,
1375 fulfillment_time => undef,
1376 prev_check_time => undef,
1378 cancel_time => undef,
1379 { order_by => 'selection_depth DESC, request_time' } );
1382 # find all the holds holds needing first time targeting ONLY
1383 $holds = [ action::hold_request->search(
1384 capture_time => undef,
1385 fulfillment_time => undef,
1386 prev_check_time => undef,
1387 cancel_time => undef,
1389 { order_by => 'selection_depth DESC, request_time' } ) ];
1391 } catch Error with {
1393 die "Could not retrieve uncaptured hold requests:\n\n$e\n";
1396 my @closed = actor::org_unit::closed_date->search_where(
1397 { close_start => { '<=', 'now' },
1398 close_end => { '>=', 'now' } }
1401 if ($check_expire) {
1403 # $check_expire, if it exists, was already converted to seconds
1404 my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = gmtime(time() + $check_expire);
1408 my $next_check_time = sprintf(
1409 '%s-%0.2d-%0.2dT%0.2d:%0.2d:%0.2d-00',
1410 $year, $mon, $mday, $hour, $min, $sec
1414 my @closed_at_next = actor::org_unit::closed_date->search_where(
1415 { close_start => { '<=', $next_check_time },
1416 close_end => { '>=', $next_check_time } }
1420 for my $c_at_n (@closed_at_next) {
1421 if (grep { ''.$_->org_unit eq ''.$c_at_n->org_unit } @closed) {
1422 push @new_closed, $c_at_n;
1425 @closed = @new_closed;
1429 my $actor = OpenSRF::AppSession->create('open-ils.actor');
1431 my $target_when_closed = {};
1432 my $target_when_closed_if_at_pickup_lib = {};
1434 for my $hold (@$holds) {
1436 #start a transaction if needed
1437 if ($self->method_lookup('open-ils.storage.transaction.current')->run) {
1438 $log->debug("Cleaning up after previous transaction\n");
1439 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
1441 $self->method_lookup('open-ils.storage.transaction.begin')->run( $client );
1442 $log->info("Processing hold ".$hold->id."...\n");
1444 #first, re-fetch the hold, to make sure it's not captured already
1445 $hold->remove_from_object_index();
1446 $hold = action::hold_request->retrieve( $hold->id );
1448 die "OK\n" if (!$hold or $hold->capture_time or $hold->cancel_time);
1450 # remove old auto-targeting maps
1451 my @oldmaps = action::hold_copy_map->search( hold => $hold->id );
1452 $_->delete for (@oldmaps);
1454 if ($hold->expire_time) {
1455 my $ex_time = $parser->parse_datetime( cleanse_ISO8601( $hold->expire_time ) );
1456 if ( DateTime->compare($ex_time, DateTime->now) < 0 ) {
1458 # cancel cause = un-targeted expiration
1459 $hold->update( { cancel_time => 'now', cancel_cause => 1 } );
1461 # refresh fields from the DB while still in the xact
1462 my $fm_hold = $hold->to_fieldmapper;
1464 $self->method_lookup('open-ils.storage.transaction.commit')->run;
1466 # tell A/T the hold was cancelled
1467 my $ses = OpenSRF::AppSession->create('open-ils.trigger');
1468 $ses->request('open-ils.trigger.event.autocreate',
1469 'hold_request.cancel.expire_no_target', $fm_hold, $fm_hold->pickup_lib);
1475 my $all_copies = [];
1477 # find all the potential copies
1478 if ($hold->hold_type eq 'M') {
1480 $self->method_lookup(
1481 'open-ils.storage.metarecord.filtered_records'
1482 )->run( $hold->target, $hold->holdable_formats )
1485 ->method_lookup( 'open-ils.storage.biblio.record_entry.ranged_tree')
1486 ->run( $r_id, $hold->selection_ou, $hold->selection_depth );
1488 for my $cn ( @{ $rtree->call_numbers } ) {
1490 asset::copy->search_where(
1491 { id => [map {$_->id} @{ $cn->copies }],
1493 ) if ($cn && @{ $cn->copies });
1496 } elsif ($hold->hold_type eq 'T') {
1498 ->method_lookup( 'open-ils.storage.biblio.record_entry.ranged_tree')
1499 ->run( $hold->target, $hold->selection_ou, $hold->selection_depth );
1502 push @successes, { hold => $hold->id, eligible_copies => 0, error => 'NO_RECORD' };
1506 for my $cn ( @{ $rtree->call_numbers } ) {
1508 asset::copy->search_where(
1509 { id => [map {$_->id} @{ $cn->copies }],
1511 ) if ($cn && @{ $cn->copies });
1513 } elsif ($hold->hold_type eq 'V') {
1515 ->method_lookup( 'open-ils.storage.asset.call_number.ranged_tree')
1516 ->run( $hold->target, $hold->selection_ou, $hold->selection_depth );
1519 asset::copy->search_where(
1520 { id => [map {$_->id} @{ $vtree->copies }],
1522 ) if ($vtree && @{ $vtree->copies });
1524 } elsif ($hold->hold_type eq 'P') {
1525 my @part_maps = asset::copy_part_map->search_where( { part => $hold->target } );
1527 asset::copy->search_where(
1528 { id => [map {$_->target_copy} @part_maps],
1533 } elsif ($hold->hold_type eq 'I') {
1535 ->method_lookup( 'open-ils.storage.serial.issuance.ranged_tree')
1536 ->run( $hold->target, $hold->selection_ou, $hold->selection_depth );
1539 asset::copy->search_where(
1540 { id => [map {$_->unit->id} @{ $itree->items }],
1542 ) if ($itree && @{ $itree->items });
1544 } elsif ($hold->hold_type eq 'C' || $hold->hold_type eq 'R' || $hold->hold_type eq 'F') {
1545 my $_cp = asset::copy->retrieve($hold->target);
1546 push @$all_copies, $_cp if $_cp;
1549 # Force and recall holds bypass pretty much everything
1550 if ($hold->hold_type ne 'R' && $hold->hold_type ne 'F') {
1552 @$all_copies = grep { isTrue($_->status->holdable) &&
1553 isTrue($_->location->holdable) &&
1554 isTrue($_->holdable) &&
1555 !isTrue($_->deleted) &&
1556 (isTrue($hold->mint_condition) ? isTrue($_->mint_condition) : 1) &&
1557 ( ( $hold->hold_type ne 'C' && $hold->hold_type ne 'I' # Copy-level holds don't care about parts
1558 && $hold->hold_type ne 'P' ) ? $_->part_maps->count == 0 : 1)
1562 # let 'em know we're still working
1563 $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
1565 # if we have no copies ...
1566 if (!ref $all_copies || !@$all_copies) {
1567 $log->info("\tNo copies available for targeting at all!\n");
1568 push @successes, { hold => $hold->id, eligible_copies => 0, error => 'NO_COPIES' };
1570 $hold->update( { prev_check_time => 'today', current_copy => undef } );
1571 $self->method_lookup('open-ils.storage.transaction.commit')->run;
1575 my $copy_count = @$all_copies;
1576 my $found_copy = undef;
1577 $found_copy = 1 if($find_copy and grep $_ == $find_copy, @$all_copies);
1579 # map the potentials, so that we can pick up checkins
1580 # XXX Loop-based targeting may require that /only/ copies from this loop should be added to
1581 # XXX the potentials list. If this is the cased, hold_copy_map creation will move down further.
1582 my $pu_lib = ''.$hold->pickup_lib;
1583 my $prox_list = create_prox_list( $self, $pu_lib, $all_copies, $hold );
1584 $log->debug( "\tMapping ".scalar(@$all_copies)." potential copies for hold ".$hold->id);
1585 for my $prox ( keys %$prox_list ) {
1586 action::hold_copy_map->create( { proximity => $prox, hold => $hold->id, target_copy => $_ } )
1587 for keys( %{{ map { $_->id => 1 } @{$$prox_list{$prox}} }} );
1590 #$client->status( new OpenSRF::DomainObject::oilsContinueStatus );
1593 for my $c (@$all_copies) {
1595 next if ($hold->current_copy and $c->id eq $hold->current_copy);
1597 # skip on circ lib is closed IFF we care
1600 if (''.$hold->pickup_lib eq ''.$c->circ_lib) {
1601 $ignore_closing = ou_ancestor_setting_value_or_cache(
1604 'circ.holds.target_when_closed_if_at_pickup_lib',
1605 $target_when_closed_if_at_pickup_lib
1608 if (not $ignore_closing) { # one more chance to find a reason
1609 # to ignore OU closedness.
1610 $ignore_closing = ou_ancestor_setting_value_or_cache(
1613 'circ.holds.target_when_closed',
1619 # "For hold " . $hold->id . " and copy with circ_lib " .
1620 # $c->circ_lib . " we " .
1621 # ($ignore_closing ? "ignore" : "respect")
1626 (not $ignore_closing) and
1627 (grep { ''.$_->org_unit eq ''.$c->circ_lib } @closed)
1630 # target of another hold
1631 next if (action::hold_request
1633 { current_copy => $c->id,
1634 fulfillment_time => undef,
1635 cancel_time => undef,
1640 # we passed all three, keep it
1641 push @good_copies, $c if ($c);
1642 #$client->status( new OpenSRF::DomainObject::oilsContinueStatus );
1645 $log->debug("\t".scalar(@good_copies)." (non-current) copies available for targeting...");
1647 my $old_best = $hold->current_copy;
1648 my $old_best_still_valid = 0; # Assume no, but the next line says yes if it is still a potential.
1649 $old_best_still_valid = 1 if ( $old_best && grep { ''.$old_best->id eq ''.$_->id } @$all_copies );
1650 $hold->update({ current_copy => undef }) if ($old_best);
1652 if (!scalar(@good_copies)) {
1653 $log->info("\tNo (non-current) copies eligible to fill the hold.");
1654 if ( $old_best_still_valid ) {
1655 # the old copy is still available
1656 $log->debug("\tPushing current_copy back onto the targeting list");
1657 push @good_copies, $old_best;
1659 # oops, old copy is not available
1660 $log->debug("\tcurrent_copy is no longer available for targeting... NEXT HOLD, PLEASE!");
1661 $hold->update( { prev_check_time => 'today' } );
1662 $self->method_lookup('open-ils.storage.transaction.commit')->run;
1663 push @successes, { hold => $hold->id, eligible_copies => 0, error => 'NO_TARGETS' };
1668 # reset prox list after trimming good copies
1669 $prox_list = create_prox_list(
1671 [ grep { $_->status == 0 || $_->status == 7 } @good_copies ],
1675 $all_copies = [ grep { ''.$_->circ_lib ne $pu_lib && ( $_->status == 0 || $_->status == 7 ) } @good_copies ];
1677 my $min_prox = [ sort keys %$prox_list ]->[0];
1679 if ($hold->hold_type eq 'R' || $hold->hold_type eq 'F') { # Recall/Force holds bypass hold rules.
1680 $best = $good_copies[0] if(scalar @good_copies);
1682 $best = choose_nearest_copy($hold, { $min_prox => delete($$prox_list{$min_prox}) });
1685 $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
1688 $log->debug("\tNothing at the pickup lib, looking elsewhere among ".scalar(@$all_copies)." copies");
1690 $self->{max_loops}{$pu_lib} = $actor->request(
1691 'open-ils.actor.ou_setting.ancestor_default' => $pu_lib => 'circ.holds.max_org_unit_target_loops'
1694 if (defined($self->{max_loops}{$pu_lib})) {
1695 $self->{max_loops}{$pu_lib} = $self->{max_loops}{$pu_lib}{value};
1697 my %circ_lib_map = map { (''.$_->circ_lib => 1) } @$all_copies;
1698 my $circ_lib_list = [keys %circ_lib_map];
1700 my $cstore = OpenSRF::AppSession->create('open-ils.cstore');
1702 # Grab the "biggest" loop for this hold so far
1703 my $current_loop = $cstore->request(
1704 'open-ils.cstore.json_query',
1706 select => { aufhmxl => ['max'] },
1708 where => { hold => $hold->id}
1712 $current_loop = $current_loop->{max} if ($current_loop);
1713 $current_loop ||= 1;
1715 my $exclude_list = $cstore->request(
1716 'open-ils.cstore.json_query.atomic',
1718 select => { aufhol => ['circ_lib'] },
1720 where => { hold => $hold->id}
1725 if ($exclude_list && @$exclude_list) {
1726 $exclude_list = [map {$_->{circ_lib}} @$exclude_list];
1727 # check to see if we've used up every library in the potentials list
1728 for my $l ( @$circ_lib_list ) {
1730 for my $ex ( @$exclude_list ) {
1736 push(@keepers, $l) if ($keep);
1739 @keepers = @$circ_lib_list;
1742 $current_loop++ if (!@keepers);
1744 if ($self->{max_loops}{$pu_lib} && $self->{max_loops}{$pu_lib} >= $current_loop) {
1745 # We haven't exceeded max_loops yet
1747 for my $cp ( @$all_copies ) {
1748 push(@keeper_copies, $cp) if ( !@keepers || grep { $_ eq ''.$cp->circ_lib } @keepers );
1751 $all_copies = [@keeper_copies];
1753 # We have, and should remove potentials and cancel the hold
1754 my @oldmaps = action::hold_copy_map->search( hold => $hold->id );
1755 $_->delete for (@oldmaps);
1757 # cancel cause = un-targeted expiration
1758 $hold->update( { cancel_time => 'now', cancel_cause => 1 } );
1760 # refresh fields from the DB while still in the xact
1761 my $fm_hold = $hold->to_fieldmapper;
1763 $self->method_lookup('open-ils.storage.transaction.commit')->run;
1765 # tell A/T the hold was cancelled
1766 my $ses = OpenSRF::AppSession->create('open-ils.trigger');
1767 $ses->request('open-ils.trigger.event.autocreate',
1768 'hold_request.cancel.expire_no_target', $fm_hold, $fm_hold->pickup_lib);
1773 $prox_list = create_prox_list( $self, $pu_lib, $all_copies, $hold );
1775 $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
1779 $best = choose_nearest_copy($hold, $prox_list);
1782 $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
1784 # hold wasn't fulfilled, record the fact
1786 $log->info("\tHold was not (but should have been) fulfilled by ".$old_best->id);
1787 action::unfulfilled_hold_list->create(
1788 { hold => ''.$hold->id,
1789 current_copy => ''.$old_best->id,
1790 circ_lib => ''.$old_best->circ_lib,
1795 $hold->update( { current_copy => ''.$best->id, prev_check_time => 'now' } );
1796 $log->debug("\tUpdating hold [".$hold->id."] with new 'current_copy' [".$best->id."] for hold fulfillment.");
1798 $old_best_still_valid &&
1799 !action::hold_request
1801 { current_copy => $old_best->id,
1802 fulfillment_time => undef,
1803 cancel_time => undef,
1806 ( OpenILS::Utils::PermitHold::permit_copy_hold(
1807 { title => $old_best->call_number->record->to_fieldmapper,
1808 title_descriptor => $old_best->call_number->record->record_descriptor->next->to_fieldmapper,
1809 patron => $hold->usr->to_fieldmapper,
1810 copy => $old_best->to_fieldmapper,
1811 requestor => $hold->requestor->to_fieldmapper,
1812 request_lib => $hold->request_lib->to_fieldmapper,
1813 pickup_lib => $hold->pickup_lib->id,
1818 $hold->update( { prev_check_time => 'now', current_copy => ''.$old_best->id } );
1819 $log->debug( "\tRetargeting the previously targeted copy [".$old_best->id."]" );
1821 $hold->update( { prev_check_time => 'now' } );
1822 $log->info( "\tThere were no targetable copies for the hold" );
1823 process_recall($actor, $log, $hold, \@good_copies);
1826 $self->method_lookup('open-ils.storage.transaction.commit')->run;
1827 $log->info("\tProcessing of hold ".$hold->id." complete.");
1830 { hold => $hold->id,
1831 old_target => ($old_best ? $old_best->id : undef),
1832 eligible_copies => $copy_count,
1833 target => ($best ? $best->id : undef),
1834 found_copy => $found_copy };
1839 $log->error("Processing of hold failed: $e");
1840 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
1841 throw $e if ($e =~ /IS NOT CONNECTED TO THE NETWORK/o);
1848 __PACKAGE__->register_method(
1849 api_name => 'open-ils.storage.action.hold_request.copy_targeter',
1851 method => 'new_hold_copy_targeter',
1854 sub process_recall {
1855 my ($actor, $log, $hold, $good_copies) = @_;
1857 # Bail early if we don't have required settings to avoid spurious requests
1858 my ($recall_threshold, $return_interval, $fine_rules);
1860 my $rv = $actor->request(
1861 'open-ils.actor.ou_setting.ancestor_default', ''.$hold->pickup_lib, 'circ.holds.recall_threshold'
1865 $log->info("Recall threshold was not set; bailing out on hold ".$hold->id." processing.");
1868 $recall_threshold = $rv->{value};
1870 $rv = $actor->request(
1871 'open-ils.actor.ou_setting.ancestor_default', ''.$hold->pickup_lib, 'circ.holds.recall_return_interval'
1875 $log->info("Recall return interval was not set; bailing out on hold ".$hold->id." processing.");
1878 $return_interval = $rv->{value};
1880 $rv = $actor->request(
1881 'open-ils.actor.ou_setting.ancestor_default', ''.$hold->pickup_lib, 'circ.holds.recall_fine_rules'
1885 $fine_rules = $rv->{value};
1888 $log->info("Recall threshold: $recall_threshold; return interval: $return_interval");
1890 # We want checked out copies (status = 1) at the hold pickup lib
1891 my $all_copies = [grep { $_->status == 1 } grep {''.$_->circ_lib eq ''.$hold->pickup_lib } @$good_copies];
1893 my @copy_ids = map { $_->id } @$all_copies;
1895 $log->info("Found " . scalar(@$all_copies) . " eligible checked-out copies for recall");
1897 my $return_date = DateTime->now(time_zone => 'local')->add(seconds => interval_to_seconds($return_interval))->iso8601();
1899 # Iterate over the checked-out copies to find a copy with a
1900 # loan period longer than the recall threshold:
1901 my $circs = [ action::circulation->search_where(
1902 { target_copy => \@copy_ids, checkin_time => undef, duration => { '>' => $recall_threshold } },
1903 { order_by => 'due_date ASC' }
1906 # If we have a candidate copy, then:
1907 if (scalar(@$circs)) {
1908 my $circ = $circs->[0];
1909 $log->info("Recalling circ ID : " . $circ->id);
1911 # Give the user a new due date of either a full recall threshold,
1912 # or the return interval, whichever is further in the future
1913 my $threshold_date = DateTime::Format::ISO8601->parse_datetime(cleanse_ISO8601($circ->xact_start))->add(seconds => interval_to_seconds($recall_threshold))->iso8601();
1914 if (DateTime->compare(DateTime::Format::ISO8601->parse_datetime($threshold_date), DateTime::Format::ISO8601->parse_datetime($return_date)) == 1) {
1915 $return_date = $threshold_date;
1918 my $update_fields = {
1919 due_date => $return_date,
1920 renewal_remaining => 0,
1923 # If the OU hasn't defined new fine rules for recalls, keep them
1926 $log->info("Apply recall fine rules: $fine_rules");
1927 my $rules = OpenSRF::Utils::JSON->JSON2perl($fine_rules);
1928 $update_fields->{recurring_fine} = $rules->[0];
1929 $update_fields->{fine_interval} = $rules->[1];
1930 $update_fields->{max_fine} = $rules->[2];
1933 # Adjust circ for current user
1934 $circ->update($update_fields);
1936 # Create trigger event for notifying current user
1937 my $ses = OpenSRF::AppSession->create('open-ils.trigger');
1938 $ses->request('open-ils.trigger.event.autocreate', 'circ.recall.target', $circ->to_fieldmapper(), $circ->circ_lib->id);
1941 $log->info("Processing of hold ".$hold->id." for recall is now complete.");
1944 sub reservation_targeter {
1947 my $one_reservation = shift;
1949 local $OpenILS::Application::Storage::WRITE = 1;
1954 if ($one_reservation) {
1955 $self->method_lookup('open-ils.storage.transaction.begin')->run( $client );
1956 $reservations = [ booking::reservation->search_where( { id => $one_reservation, capture_time => undef, cancel_time => undef } ) ];
1959 # find all the reservations needing targeting
1961 booking::reservation->search_where(
1962 { current_resource => undef,
1963 cancel_time => undef,
1964 start_time => { '>' => 'now' }
1966 { order_by => 'start_time' }
1970 } catch Error with {
1972 die "Could not retrieve reservation requests:\n\n$e\n";
1976 for my $bresv (@$reservations) {
1978 #start a transaction if needed
1979 if ($self->method_lookup('open-ils.storage.transaction.current')->run) {
1980 $log->debug("Cleaning up after previous transaction\n");
1981 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
1983 $self->method_lookup('open-ils.storage.transaction.begin')->run( $client );
1984 $log->info("Processing reservation ".$bresv->id."...\n");
1986 #first, re-fetch the hold, to make sure it's not captured already
1987 $bresv->remove_from_object_index();
1988 $bresv = booking::reservation->retrieve( $bresv->id );
1990 die "OK\n" if (!$bresv or $bresv->capture_time or $bresv->cancel_time);
1992 my $end_time = $parser->parse_datetime( cleanse_ISO8601( $bresv->end_time ) );
1993 if (DateTime->compare($end_time, DateTime->now) < 0) {
1995 # cancel cause = un-targeted expiration
1996 $bresv->update( { cancel_time => 'now' } );
1998 # refresh fields from the DB while still in the xact
1999 my $fm_bresv = $bresv->to_fieldmapper;
2001 $self->method_lookup('open-ils.storage.transaction.commit')->run;
2003 # tell A/T the reservation was cancelled
2004 my $ses = OpenSRF::AppSession->create('open-ils.trigger');
2005 $ses->request('open-ils.trigger.event.autocreate',
2006 'booking.reservation.cancel.expire_no_target', $fm_bresv, $fm_bresv->pickup_lib);
2011 my $possible_resources;
2013 # find all the potential resources
2014 if (!$bresv->target_resource) {
2015 my $filter = { type => $bresv->target_resource_type };
2016 my $attr_maps = [ booking::reservation_attr_value_map->search( reservation => $bresv->id) ];
2018 $filter->{attribute_values} = [ map { $_->attr_value } @$attr_maps ] if (@$attr_maps);
2020 $filter->{available} = [$bresv->start_time, $bresv->end_time];
2021 my $ses = OpenSRF::AppSession->create('open-ils.booking');
2022 $possible_resources = $ses->request('open-ils.booking.resources.filtered_id_list', undef, $filter)->gather(1);
2024 $possible_resources = $bresv->target_resource;
2027 my $all_resources = [ booking::resource->search( id => $possible_resources ) ];
2028 @$all_resources = grep { isTrue($_->type->transferable) || $_->owner.'' eq $bresv->pickup_lib.'' } @$all_resources;
2031 my @good_resources = ();
2033 for my $res (@$all_resources) {
2034 unless (isTrue($res->type->catalog_item)) {
2035 push @good_resources, $res;
2039 my $copy = [ asset::copy->search( deleted => 'f', barcode => $res->barcode )]->[0];
2042 push @good_resources, $res;
2046 # At this point, if we're just targeting one specific
2047 # resource, just succeed. We don't care about its present
2049 if ($bresv->target_resource) {
2050 push @good_resources, $res;
2054 if ($copy->status->id == 0 || $copy->status->id == 7) {
2055 push @good_resources, $res;
2059 if ($copy->status->id == 1) {
2060 my $circs = [ action::circulation->search_where(
2061 {target_copy => $copy->id, checkin_time => undef },
2062 { order_by => 'id DESC' }
2066 my $due_date = $circs->[0]->due_date;
2067 $due_date = $parser->parse_datetime( cleanse_ISO8601( $due_date ) );
2068 my $start_time = $parser->parse_datetime( cleanse_ISO8601( $bresv->start_time ) );
2069 if (DateTime->compare($start_time, $due_date) < 0) {
2070 $conflicts{$res->id} = $circs->[0]->to_fieldmapper;
2074 push @good_resources, $res;
2080 push @good_resources, $res if (isTrue($copy->status->holdable));
2083 # let 'em know we're still working
2084 $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
2086 # if we have no copies ...
2087 if (!@good_resources) {
2088 $log->info("\tNo resources available for targeting at all!\n");
2089 push @successes, { reservation => $bresv->id, eligible_copies => 0, error => 'NO_COPIES', conflicts => \%conflicts };
2092 $self->method_lookup('open-ils.storage.transaction.commit')->run;
2096 $log->debug("\t".scalar(@good_resources)." resources available for targeting...");
2098 # LFW: note that after the inclusion of hold proximity
2099 # adjustment, this prox_list is the only prox_list
2100 # array in this perl package. Other occurences are
2106 $_->owner == $bresv->pickup_lib
2110 $all_resources = [grep {$_->owner != $bresv->pickup_lib } @good_resources];
2111 # $all_copies is now a list of copies not at the pickup library
2113 my $best = shift @good_resources;
2114 $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
2117 $log->debug("\tNothing at the pickup lib, looking elsewhere among ".scalar(@$all_resources)." resources");
2121 sort { $a->[0] <=> $b->[0] }
2123 [ actor::org_unit_proximity->search_where(
2124 { from_org => $bresv->pickup_lib.'', to_org => $_->owner.'' }
2130 $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
2132 $best = shift @$prox_list
2136 $bresv->update( { current_resource => ''.$best->id } );
2137 $log->debug("\tUpdating reservation [".$bresv->id."] with new 'current_resource' [".$best->id."] for reservation fulfillment.");
2140 $self->method_lookup('open-ils.storage.transaction.commit')->run;
2141 $log->info("\tProcessing of bresv ".$bresv->id." complete.");
2144 { reservation => $bresv->id,
2145 current_resource => ($best ? $best->id : undef) };
2150 $log->error("Processing of bresv failed: $e");
2151 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
2152 throw $e if ($e =~ /IS NOT CONNECTED TO THE NETWORK/o);
2159 __PACKAGE__->register_method(
2160 api_name => 'open-ils.storage.booking.reservation.resource_targeter',
2162 method => 'reservation_targeter',
2167 my %cache = (titles => {}, cns => {});
2169 sub copy_hold_capture {
2174 if (!defined($cps)) {
2176 $cps = [ asset::copy->search( id => $hold->target ) ];
2177 } catch Error with {
2179 die "Could not retrieve initial volume list:\n\n$e\n";
2183 my @copies = grep { $_->holdable } @$cps;
2185 for (my $i = 0; $i < @$cps; $i++) {
2186 next unless $$cps[$i];
2188 my $cn = $cache{cns}{$copies[$i]->call_number};
2189 my $rec = $cache{titles}{$cn->record};
2190 $copies[$i] = undef if ($copies[$i] && !grep{ $copies[$i]->status eq $_->id}@$statuses);
2191 $copies[$i] = undef if ($copies[$i] && !grep{ $copies[$i]->location eq $_->id}@$locations);
2192 $copies[$i] = undef if (
2194 !$self->{user_filter}->request(
2195 'open-ils.circ.permit_hold',
2196 $hold->to_fieldmapper, do {
2197 my $cp_fm = $copies[$i]->to_fieldmapper;
2198 $cp_fm->circ_lib( $copies[$i]->circ_lib->to_fieldmapper );
2199 $cp_fm->location( $copies[$i]->location->to_fieldmapper );
2200 $cp_fm->status( $copies[$i]->status->to_fieldmapper );
2203 { title => $rec->to_fieldmapper,
2204 usr => actor::user->retrieve($hold->usr)->to_fieldmapper,
2205 requestor => actor::user->retrieve($hold->requestor)->to_fieldmapper,
2208 $self->{client}->status( new OpenSRF::DomainObject::oilsContinueStatus );
2211 @copies = grep { $_ } @copies;
2213 my $count = @copies;
2215 return unless ($count);
2217 action::hold_copy_map->search( hold => $hold->id )->delete_all;
2220 $self->{client}->respond( "\tMapping ".scalar(@copies)." eligable copies for hold ".$hold->id."\n");
2221 for my $c (@copies) {
2222 push @maps, action::hold_copy_map->create( { hold => $hold->id, target_copy => $c->id } );
2224 $self->{client}->respond( "\tA total of ".scalar(@maps)." mapping were created for hold ".$hold->id."\n");
2230 sub choose_nearest_copy {
2232 my $prox_list = shift;
2234 for my $p ( sort keys %$prox_list ) {
2235 next unless (ref $$prox_list{$p});
2237 my @capturable = @{ $$prox_list{$p} };
2238 next unless (@capturable);
2240 my $rand = int(rand(scalar(@capturable)));
2242 while (my ($c) = splice(@capturable, $rand, 1)) {
2243 return $c if !exists($seen{$c->id}) && ( OpenILS::Utils::PermitHold::permit_copy_hold(
2244 { title => $c->call_number->record->to_fieldmapper,
2245 title_descriptor => $c->call_number->record->record_descriptor->next->to_fieldmapper,
2246 patron => $hold->usr->to_fieldmapper,
2247 copy => $c->to_fieldmapper,
2248 requestor => $hold->requestor->to_fieldmapper,
2249 request_lib => $hold->request_lib->to_fieldmapper,
2250 pickup_lib => $hold->pickup_lib->id,
2256 last unless(@capturable);
2257 $rand = int(rand(scalar(@capturable)));
2262 sub create_prox_list {
2268 my $actor = OpenSRF::AppSession->create('open-ils.actor');
2271 for my $cp (@$copies) {
2272 my ($prox) = $self->method_lookup('open-ils.storage.asset.copy.proximity')->run( $cp, $lib, $hold );
2273 next unless (defined($prox));
2275 my $copy_circ_lib = ''.$cp->circ_lib;
2276 # Fetch the weighting value for hold targeting, defaulting to 1
2277 $self->{target_weight}{$copy_circ_lib} ||= $actor->request(
2278 'open-ils.actor.ou_setting.ancestor_default' => $copy_circ_lib.'' => 'circ.holds.org_unit_target_weight'
2280 $self->{target_weight}{$copy_circ_lib} = $self->{target_weight}{$copy_circ_lib}{value} if (ref $self->{target_weight}{$copy_circ_lib});
2281 $self->{target_weight}{$copy_circ_lib} ||= 1;
2283 $prox_list{$prox} = [] unless defined($prox_list{$prox});
2284 for my $w ( 1 .. $self->{target_weight}{$copy_circ_lib} ) {
2285 push @{$prox_list{$prox}}, $cp;
2291 sub volume_hold_capture {
2296 if (!defined($vols)) {
2298 $vols = [ asset::call_number->search( id => $hold->target ) ];
2299 $cache{cns}{$_->id} = $_ for (@$vols);
2300 } catch Error with {
2302 die "Could not retrieve initial volume list:\n\n$e\n";
2306 my @v_ids = map { $_->id } @$vols;
2310 $cp_list = [ asset::copy->search( call_number => \@v_ids ) ];
2312 } catch Error with {
2314 warn "Could not retrieve copy list:\n\n$e\n";
2317 $self->copy_hold_capture($hold,$cp_list) if (ref $cp_list and @$cp_list);
2320 sub title_hold_capture {
2325 if (!defined($titles)) {
2327 $titles = [ biblio::record_entry->search( id => $hold->target ) ];
2328 $cache{titles}{$_->id} = $_ for (@$titles);
2329 } catch Error with {
2331 die "Could not retrieve initial title list:\n\n$e\n";
2335 my @t_ids = map { $_->id } @$titles;
2338 ($cn_list) = $self->method_lookup('open-ils.storage.direct.asset.call_number.search.record.atomic')->run( \@t_ids );
2340 } catch Error with {
2342 warn "Could not retrieve volume list:\n\n$e\n";
2345 $cache{cns}{$_->id} = $_ for (@$cn_list);
2347 $self->volume_hold_capture($hold,$cn_list) if (ref $cn_list and @$cn_list);