]> git.evergreen-ils.org Git - working/Evergreen.git/blob - Open-ILS/src/perlmods/lib/OpenILS/Application/Storage/Publisher/action.pm
Support script-based circ in nearest_hold()
[working/Evergreen.git] / Open-ILS / src / perlmods / lib / OpenILS / Application / Storage / Publisher / action.pm
1 package OpenILS::Application::Storage::Publisher::action;
2 use parent qw/OpenILS::Application::Storage::Publisher/;
3 use strict;
4 use warnings;
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;
12 use DateTime;
13 use DateTime::Format::ISO8601;
14 use OpenILS::Utils::Penalty;
15 use POSIX qw(ceil);
16 use OpenILS::Application::Circ::CircCommon;
17 use OpenILS::Application::AppUtils;
18 my $U = "OpenILS::Application::AppUtils";
19
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 = (
24     pprox => 'p.prox',
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',
32     htime => q!
33         CASE WHEN
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)
37         ELSE 999
38         END
39     !,  # $cp->call_number->owning_lib x 2
40     shtime => q!
41         CASE WHEN
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)
45         ELSE 999
46         END
47     !,  # $cp->call_number->owning_lib x 2
48 );
49
50
51 sub isTrue {
52     my $v = shift || '0';
53     return 1 if ($v == 1);
54     return 1 if ($v =~ /^t/io);
55     return 1 if ($v =~ /^y/io);
56     return 0;
57 }
58
59 sub ou_ancestor_setting_value_or_cache {
60     # cache should be specific to setting
61     my ($actor, $org_id, $setting, $cache) = @_;
62
63     if (not exists $cache->{$org_id}) {
64         my $r = $actor->request(
65             'open-ils.actor.ou_setting.ancestor_default', $org_id, $setting
66         )->gather(1);
67
68         if ($r) {
69             $cache->{$org_id} = $r->{value};
70         } else {
71             $cache->{$org_id} = undef;
72         }
73     }
74     return $cache->{$org_id};
75 }
76
77 my $parser = DateTime::Format::ISO8601->new;
78 my $log = 'OpenSRF::Utils::Logger';
79
80 sub open_noncat_circs {
81     my $self = shift;
82     my $client = shift;
83     my $user = shift;
84
85     my $a = action::non_cataloged_circulation->table;
86     my $c = config::non_cataloged_type->table;
87
88     my $sql = <<"    SQL";
89         SELECT  a.id
90           FROM  $a a
91             JOIN $c c ON (a.item_type = c.id)
92           WHERE a.circ_time + c.circ_duration > current_timestamp
93             AND a.patron = ?
94     SQL
95
96     return action::non_cataloged_circulation->db_Main->selectcol_arrayref($sql, {}, $user);
97 }
98 __PACKAGE__->register_method(
99     api_name  => 'open-ils.storage.action.open_non_cataloged_circulation.user',
100     method    => 'open_noncat_circs',
101     api_level => 1,
102     argc      => 1,
103 );
104
105
106 sub ou_hold_requests {
107     my $self = shift;
108     my $client = shift;
109     my $ou = shift;
110
111     my $h_table = action::hold_request->table;
112     my $c_table = asset::copy->table;
113     my $o_table = actor::org_unit->table;
114
115     my $SQL = <<"    SQL";
116         SELECT  h.id
117           FROM  $h_table h
118             JOIN $c_table cp ON (cp.id = h.current_copy)
119             JOIN $o_table ou ON (ou.id = cp.circ_lib)
120           WHERE ou.id = ?
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
125     SQL
126
127     my $sth = action::hold_request->db_Main->prepare_cached($SQL);
128     $sth->execute($ou);
129
130     $client->respond($_) for (
131         map {
132             $self
133                 ->method_lookup('open-ils.storage.direct.action.hold_request.retrieve')
134                 ->run($_)
135         } map {
136             $_->[0]
137         } @{ $sth->fetchall_arrayref }
138     );
139     return undef;
140 }
141 __PACKAGE__->register_method(
142     api_name        => 'open-ils.storage.action.targeted_hold_request.org_unit',
143     api_level       => 1,
144     argc        => 1,
145     stream      => 1,
146     method          => 'ou_hold_requests',
147 );
148
149
150 sub overdue_circs {
151     my $upper_interval = shift || '1 millennium';
152     my $idlist = shift;
153
154     my $c_t = action::circulation->table;
155
156     my $sql = <<"    SQL";
157         SELECT  *
158           FROM  $c_t
159           WHERE stop_fines IS NULL
160             AND due_date < ( CURRENT_TIMESTAMP - grace_period )
161             AND fine_interval < ?::INTERVAL
162     SQL
163
164     my $sth = action::circulation->db_Main->prepare_cached($sql);
165     $sth->execute($upper_interval);
166
167     my @circs = map { $idlist ? $_->{id} : action::circulation->construct($_) } $sth->fetchall_hash;
168
169     $c_t = booking::reservation->table;
170     $sql = <<"    SQL";
171         SELECT  *
172           FROM  $c_t
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
177     SQL
178
179     $sth = action::circulation->db_Main->prepare_cached($sql);
180     $sth->execute();
181
182     push @circs, map { $idlist ? $_->{id} : booking::reservation->construct($_) } $sth->fetchall_hash;
183
184     return @circs;
185 }
186
187 sub complete_reshelving {
188     my $self = shift;
189     my $client = shift;
190     my $window = shift;
191
192     local $OpenILS::Application::Storage::WRITE = 1;
193
194     throw OpenSRF::EX::InvalidArg ("I need an interval of more than 0 seconds!")
195         unless (interval_to_seconds( $window ));
196
197     my $cp = asset::copy->table;
198
199     my $sql = <<"    SQL";
200         UPDATE  $cp
201           SET   status = 0
202           WHERE id IN (
203             SELECT cp.id 
204             FROM  $cp cp
205             WHERE cp.status = 7
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)
207           )
208     SQL
209     my $sth = action::circulation->db_Main->prepare_cached($sql);
210     $sth->execute($window);
211
212     return $sth->rows;
213
214 }
215 __PACKAGE__->register_method(
216     api_name        => 'open-ils.storage.action.circulation.reshelving.complete',
217     api_level       => 1,
218     argc        => 1,
219     method          => 'complete_reshelving',
220 );
221
222 sub mark_longoverdue {
223     my $self = shift;
224     my $client = shift;
225     my $window = shift;
226
227     local $OpenILS::Application::Storage::WRITE = 1;
228
229     throw OpenSRF::EX::InvalidArg ("I need an interval of more than 0 seconds!")
230         unless (interval_to_seconds( $window ));
231
232     my $setting = actor::org_unit_setting->table;
233     my $circ = action::circulation->table;
234
235     my $sql = <<"    SQL";
236         UPDATE  $circ
237           SET   stop_fines = 'LONGOVERDUE',
238             stop_fines_time = now()
239           WHERE id IN (
240             SELECT  circ.id
241                       FROM  $circ circ
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)
246                   )
247     SQL
248
249     my $sth = action::circulation->db_Main->prepare_cached($sql);
250     $sth->execute($window);
251
252     return $sth->rows;
253
254 }
255 __PACKAGE__->register_method(
256     api_name        => 'open-ils.storage.action.circulation.long_overdue',
257     api_level       => 1,
258     argc        => 1,
259     method          => 'mark_longoverdue',
260 );
261
262 sub auto_thaw_frozen_holds {
263     my $self = shift;
264     my $client = shift;
265
266     local $OpenILS::Application::Storage::WRITE = 1;
267
268     my $holds = action::hold_request->table;
269
270     my $sql = "UPDATE $holds SET frozen = FALSE WHERE frozen IS TRUE AND thaw_date < NOW();";
271
272     my $sth = action::hold_request->db_Main->prepare_cached($sql);
273     $sth->execute();
274
275     return $sth->rows;
276
277 }
278 __PACKAGE__->register_method(
279     api_name        => 'open-ils.storage.action.hold_request.thaw_expired_frozen',
280     api_level       => 1,
281     stream      => 0,
282     argc        => 0,
283     method          => 'auto_thaw_frozen_holds',
284 );
285
286 sub grab_overdue {
287     my $self = shift;
288     my $client = shift;
289
290     my $idlist = $self->api_name =~/id_list/o ? 1 : 0;
291     
292     $client->respond( $idlist ? $_ : $_->to_fieldmapper ) for ( overdue_circs('', $idlist) );
293
294     return undef;
295
296 }
297 __PACKAGE__->register_method(
298     api_name        => 'open-ils.storage.action.circulation.overdue',
299     api_level       => 1,
300     stream          => 1,
301     method          => 'grab_overdue',
302     signature       => q/
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.
306 /,
307 );
308 __PACKAGE__->register_method(
309     api_name        => 'open-ils.storage.action.circulation.overdue.id_list',
310     api_level       => 1,
311     stream      => 1,
312     method          => 'grab_overdue',
313 );
314
315 sub get_hold_sort_order {
316     my ($ou) = @_;
317
318     my $dbh = action::hold_request->db_Main;
319
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.
323
324     my $row = $dbh->selectrow_hashref(
325         q!
326         SELECT
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
330         WHERE id = (
331             SELECT oils_json_to_text(value)::INT
332             FROM actor.org_unit_ancestor_setting('circ.hold_capture_order', ?)
333         )
334         !, undef, $ou
335     ) || {
336         pprox => 1, hprox => 8, aprox => 2, priority => 3,
337         cut => 4, depth => 5, htime => 7, rtime => 6
338     };
339
340     # Return only the keys of our hash, sorted by value,
341     # keys for null values omitted.
342     return [
343         grep { defined $row->{$_} } (
344             sort {$row->{$a} cmp $row->{$b}} keys %$row
345         )
346     ];
347 }
348
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) = @_;
354
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]
360     );
361
362     my @clauses;
363     my $ctes_needed = 0;
364     foreach my $col (@$columns) {
365         if ($col eq 'htime' and not $ctes_needed) {
366             $ctes_needed = 1;
367         } elsif ($col eq 'shtime') {
368             $ctes_needed = 2;
369         }
370
371         my @args;
372         @args = @{$order_by_sprintf_args{$col}} if
373             exists $order_by_sprintf_args{$col};
374
375         push @clauses, sprintf($HOLD_SORT_ORDER_BY{$col}, @args);
376
377         last if $col eq 'rtime';    # rtime is effectively unique, no need for
378                                     # more order-by clauses after that.
379     }
380
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".
388
389         if ($ctes_needed == 2) {
390             $ctes .= sprintf(q!
391 , last_event_on_copy AS (    -- combined circ and transit version
392     SELECT *
393     FROM (
394         (   SELECT
395                 TRUE AS concrete,
396                 dest AS place,
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
401         ) UNION (
402             SELECT
403                 TRUE AS concrete,
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
409         ) UNION
410             SELECT
411                 FALSE AS concrete,
412                 %d AS place,
413                 NOW() AS moment
414     ) x ORDER BY concrete DESC, moment DESC LIMIT 1
415 ) !, $cp->id, $cp->id, $cp->call_number->owning_lib);
416         } else {
417             $ctes .= sprintf(q!
418 , last_event_on_copy AS (   -- circ only version
419     SELECT * FROM (
420         ( SELECT
421                 TRUE AS concrete,
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
427         ) UNION SELECT
428                 FALSE AS concrete,
429                 %d AS place,
430                 NOW() AS moment
431     ) x ORDER BY concrete DESC, moment DESC LIMIT 1
432 ) !, $cp->id, $cp->call_number->owning_lib);
433         }
434
435         $joins .= q!
436             JOIN last_event_on_copy ON (true)
437         !;
438
439         # For our next auxiliary query, the question we seek to answer is,
440         # "has our copy been circulating away from home too long?"
441         #
442         # Have there been no checkouts at the copy's circ_lib since the
443         # beginning of our go-home interval?
444
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.]
450         $ctes .= sprintf(q!
451 , copy_has_not_been_home AS (
452     SELECT (
453         -- part 1
454         SELECT MIN(circ.id) FROM action.circulation circ
455         JOIN go_home_interval ON (true)
456         WHERE
457             circ.target_copy = %d AND
458             circ.circ_lib = %d AND
459             circ.xact_start >= NOW() - go_home_interval.value
460     ) IS NULL AS result
461 ) !, $cp->id, $cp->circ_lib);
462
463         $joins .= q!
464             JOIN copy_has_not_been_home ON (true)
465         !;
466     }
467
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).
472         #
473         # There have been no homebound transits that arrived for this copy
474         # since the beginning of the go-home interval.
475
476         $ctes .= sprintf(q!
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
481         WHERE
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) ";
488     }
489
490     return (
491         join(", ", @clauses),
492         $ctes,
493         $joins
494     );
495 }
496
497 sub nearest_hold {
498     my $self = shift;
499     my $client = shift;
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';
505     my $fifo = shift();
506
507     $log->info("deprecated 'fifo' param true, but ignored") if isTrue($fifo);
508
509     # ScriptBuilder fleshes the circ_lib, which confuses things; ensure we
510     # are working with a circ lib ID and not an object
511     my $cp_circ_lib;
512     if (ref $cp->circ_lib) {
513         $cp_circ_lib = $cp->circ_lib->id;
514     } else {
515         $cp_circ_lib = $cp->circ_lib;
516     }
517
518     my ($holdsort, $addl_cte, $addl_join) =
519         build_hold_sort_clause(get_hold_sort_order($here), $cp, $here);
520
521     local $OpenILS::Application::Storage::WRITE = 1;
522
523     my $ids = action::hold_request->db_Main->selectcol_arrayref(<<"    SQL", {}, $cp_circ_lib, $here, $cp->id, $age);
524         WITH go_home_interval AS (
525             SELECT OILS_JSON_TO_TEXT(
526                 (SELECT value FROM actor.org_unit_ancestor_setting(
527                     'circ.hold_go_home_interval', ?
528                 )
529             ))::INTERVAL AS value
530         )
531         $addl_cte
532         SELECT  h.id
533           FROM  action.hold_request h
534             JOIN actor.org_unit_proximity p ON (p.from_org = ? AND p.to_org = h.pickup_lib)
535             JOIN action.hold_copy_map hm ON (hm.hold = h.id)
536             JOIN actor.usr au ON (au.id = h.usr)
537             JOIN permission.grp_tree pgt ON (au.profile = pgt.id)
538             LEFT JOIN actor.usr_standing_penalty ausp
539                 ON ( au.id = ausp.usr AND ( ausp.stop_date IS NULL OR ausp.stop_date > NOW() ) )
540             LEFT JOIN config.standing_penalty csp
541                 ON ( csp.id = ausp.standing_penalty AND csp.block_list LIKE '%CAPTURE%' )
542             $addl_join
543           WHERE hm.target_copy = ?
544             AND (AGE(NOW(),h.request_time) >= CAST(? AS INTERVAL) OR p.prox = 0)
545             AND h.capture_time IS NULL
546             AND h.cancel_time IS NULL
547             AND (h.expire_time IS NULL OR h.expire_time > NOW())
548             AND h.frozen IS FALSE
549             AND csp.id IS NULL
550         ORDER BY CASE WHEN h.hold_type IN ('R','F') THEN 0 ELSE 1 END, $holdsort
551         LIMIT $limit
552     SQL
553     
554     $client->respond( $_ ) for ( @$ids );
555     return undef;
556 }
557 __PACKAGE__->register_method(
558     api_name    => 'open-ils.storage.action.hold_request.nearest_hold',
559     api_level   => 1,
560     stream      => 1,
561     method      => 'nearest_hold',
562 );
563
564 sub targetable_holds {
565     my $self = shift;
566     my $client = shift;
567     my $check_expire = shift;
568
569     $check_expire ||= '12h';
570
571     local $OpenILS::Application::Storage::WRITE = 1;
572
573     # json_query can *almost* represent this query, but can't
574     # handle the CASE statement or the interval arithmetic
575     my $query = <<"    SQL";
576         SELECT ahr.id, mmsm.metarecord
577         FROM action.hold_request ahr
578         JOIN reporter.hold_request_record USING (id)
579         JOIN metabib.metarecord_source_map mmsm ON (bib_record = source)
580         WHERE capture_time IS NULL
581         AND (prev_check_time IS NULL or prev_check_time < (NOW() - ?::interval))
582         AND fulfillment_time IS NULL
583         AND cancel_time IS NULL
584         AND NOT frozen
585         ORDER BY CASE WHEN ahr.hold_type = 'F' THEN 0 ELSE 1 END, selection_depth DESC, request_time;
586     SQL
587     my $sth = action::hold_request->db_Main->prepare_cached($query);
588     $sth->execute($check_expire);
589     $client->respond( $_ ) for @{ $sth->fetchall_arrayref };
590
591     return undef;
592 }
593
594 __PACKAGE__->register_method(
595     api_name    => 'open-ils.storage.action.hold_request.targetable_holds.id_list',
596     api_level   => 1,
597     stream      => 1,
598     method      => 'targetable_holds',
599     signature   => q/
600         Returns ordered list of hold request and metarecord IDs
601         for all hold requests that are available for initial targeting
602         or retargeting.
603         @param check interval
604         @return list of pairs of hold request and metarecord IDs
605 /,
606 );
607
608 sub next_resp_group_id {
609     my $self = shift;
610     my $client = shift;
611
612     # XXX This is not replication safe!!!
613
614     my ($id) = action::survey->db_Main->selectrow_array(<<"    SQL");
615         SELECT NEXTVAL('action.survey_response_group_id_seq'::TEXT)
616     SQL
617     return $id;
618 }
619 __PACKAGE__->register_method(
620     api_name        => 'open-ils.storage.action.survey_response.next_group_id',
621     api_level       => 1,
622     method          => 'next_resp_group_id',
623 );
624
625 sub patron_circ_summary {
626     my $self = shift;
627     my $client = shift;
628     my $id = ''.shift();
629
630     return undef unless ($id);
631     my $c_table = action::circulation->table;
632     my $b_table = money::billing->table;
633
634     $log->debug("Retrieving patron summary for id $id", DEBUG);
635
636     my $select = <<"    SQL";
637         SELECT  COUNT(DISTINCT c.id), SUM( COALESCE(b.amount,0) )
638           FROM  $c_table c
639             LEFT OUTER JOIN $b_table b ON (c.id = b.xact AND b.voided = FALSE)
640           WHERE c.usr = ?
641             AND c.xact_finish IS NULL
642             AND (
643                 c.stop_fines NOT IN ('CLAIMSRETURNED','LOST')
644                 OR c.stop_fines IS NULL
645             )
646     SQL
647
648     return action::survey->db_Main->selectrow_arrayref($select, {}, $id);
649 }
650 __PACKAGE__->register_method(
651     api_name        => 'open-ils.storage.action.circulation.patron_summary',
652     api_level       => 1,
653     method          => 'patron_circ_summary',
654 );
655
656 #XXX Fix stored proc calls
657 sub find_local_surveys {
658     my $self = shift;
659     my $client = shift;
660     my $ou = ''.shift();
661
662     return undef unless ($ou);
663     my $s_table = action::survey->table;
664
665     my $select = <<"    SQL";
666         SELECT  s.*
667           FROM  $s_table s
668             JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
669           WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
670     SQL
671
672     my $sth = action::survey->db_Main->prepare_cached($select);
673     $sth->execute($ou);
674
675     $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
676
677     return undef;
678 }
679 __PACKAGE__->register_method(
680     api_name        => 'open-ils.storage.action.survey.all',
681     api_level       => 1,
682     stream          => 1,
683     method          => 'find_local_surveys',
684 );
685
686 #XXX Fix stored proc calls
687 sub find_opac_surveys {
688     my $self = shift;
689     my $client = shift;
690     my $ou = ''.shift();
691
692     return undef unless ($ou);
693     my $s_table = action::survey->table;
694
695     my $select = <<"    SQL";
696         SELECT  s.*
697           FROM  $s_table s
698             JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
699           WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
700             AND s.opac IS TRUE;
701     SQL
702
703     my $sth = action::survey->db_Main->prepare_cached($select);
704     $sth->execute($ou);
705
706     $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
707
708     return undef;
709 }
710 __PACKAGE__->register_method(
711     api_name        => 'open-ils.storage.action.survey.opac',
712     api_level       => 1,
713     stream          => 1,
714     method          => 'find_opac_surveys',
715 );
716
717 sub hold_pull_list {
718     my $self = shift;
719     my $client = shift;
720     my $ou = shift;
721     my $limit = shift || 10;
722     my $offset = shift || 0;
723
724     return undef unless ($ou);
725     my $h_table = action::hold_request->table;
726     my $a_table = asset::copy->table;
727     my $ord_table = asset::copy_location_order->table;
728
729     my $idlist = 1 if ($self->api_name =~/id_list/o);
730     my $count = 1 if ($self->api_name =~/count$/o);
731
732     my $status_filter = '';
733     $status_filter = 'AND a.status IN (0,7)' if ($self->api_name =~/status_filtered/o);
734
735     my $select = <<"    SQL";
736         SELECT  h.*
737           FROM  $h_table h
738             JOIN $a_table a ON (h.current_copy = a.id)
739             LEFT JOIN $ord_table ord ON (a.location = ord.location AND a.circ_lib = ord.org)
740             LEFT JOIN actor.usr_standing_penalty ausp 
741                 ON ( h.usr = ausp.usr AND ( ausp.stop_date IS NULL OR ausp.stop_date > NOW() ) )
742             LEFT JOIN config.standing_penalty csp
743                 ON ( csp.id = ausp.standing_penalty AND csp.block_list LIKE '%CAPTURE%' )
744           WHERE a.circ_lib = ?
745             AND h.capture_time IS NULL
746             AND h.cancel_time IS NULL
747             AND (h.expire_time IS NULL OR h.expire_time > NOW())
748             AND csp.id IS NULL
749             $status_filter
750           ORDER BY CASE WHEN ord.position IS NOT NULL THEN ord.position ELSE 999 END, h.request_time
751           LIMIT $limit
752           OFFSET $offset
753     SQL
754
755     if ($count) {
756         $select = <<"        SQL";
757             SELECT    count(*)
758               FROM    $h_table h
759                   JOIN $a_table a ON (h.current_copy = a.id)
760                   LEFT JOIN actor.usr_standing_penalty ausp 
761                     ON ( h.usr = ausp.usr AND ( ausp.stop_date IS NULL OR ausp.stop_date > NOW() ) )
762                   LEFT JOIN config.standing_penalty csp
763                     ON ( csp.id = ausp.standing_penalty AND csp.block_list LIKE '%CAPTURE%' )
764               WHERE    a.circ_lib = ?
765                   AND h.capture_time IS NULL
766                   AND h.cancel_time IS NULL
767                   AND (h.expire_time IS NULL OR h.expire_time > NOW())
768                   AND csp.id IS NULL
769                 $status_filter
770         SQL
771     }
772
773     my $sth = action::survey->db_Main->prepare_cached($select);
774     $sth->execute($ou);
775
776     if ($count) {
777         $client->respond( $sth->fetchall_arrayref()->[0][0] );
778     } elsif ($idlist) {
779         $client->respond( $_->{id} ) for ( $sth->fetchall_hash );
780     } else {
781         $client->respond( $_->to_fieldmapper ) for ( map { action::hold_request->construct($_) } $sth->fetchall_hash );
782     }
783
784     return undef;
785 }
786 __PACKAGE__->register_method(
787     api_name        => 'open-ils.storage.direct.action.hold_request.pull_list.current_copy_circ_lib.count',
788     api_level       => 1,
789     stream          => 1,
790     signature   => [
791         "Returns a count of holds for a specific library's pull list.",
792         [ [org_unit => "The library's org id", "number"] ],
793         ['A count of holds for the stated library to pull ', 'number']
794     ],
795     method          => 'hold_pull_list',
796 );
797 __PACKAGE__->register_method(
798     api_name        => 'open-ils.storage.direct.action.hold_request.pull_list.current_copy_circ_lib.status_filtered.count',
799     api_level       => 1,
800     stream          => 1,
801     signature   => [
802         "Returns a status filtered count of holds for a specific library's pull list.",
803         [ [org_unit => "The library's org id", "number"] ],
804         ['A status filtered count of holds for the stated library to pull ', 'number']
805     ],
806     method          => 'hold_pull_list',
807 );
808 __PACKAGE__->register_method(
809     api_name        => 'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib',
810     api_level       => 1,
811     stream          => 1,
812     signature   => [
813         "Returns the hold ids for a specific library's pull list.",
814         [ [org_unit => "The library's org id", "number"],
815           [limit => 'An optional page size, defaults to 10', 'number'],
816           [offset => 'Offset for paging, defaults to 0, 0 based', 'number'],
817         ],
818         ['A list of holds for the stated library to pull for', 'array']
819     ],
820     method          => 'hold_pull_list',
821 );
822 __PACKAGE__->register_method(
823     api_name        => 'open-ils.storage.direct.action.hold_request.pull_list.search.current_copy_circ_lib',
824     api_level       => 1,
825     stream          => 1,
826     signature   => [
827         "Returns the holds for a specific library's pull list.",
828         [ [org_unit => "The library's org id", "number"],
829           [limit => 'An optional page size, defaults to 10', 'number'],
830           [offset => 'Offset for paging, defaults to 0, 0 based', 'number'],
831         ],
832         ['A list of holds for the stated library to pull for', 'array']
833     ],
834     method          => 'hold_pull_list',
835 );
836 __PACKAGE__->register_method(
837     api_name        => 'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib.status_filtered',
838     api_level       => 1,
839     stream          => 1,
840     signature   => [
841         "Returns the hold ids for a specific library's pull list that are definitely in that library, based on status.",
842         [ [org_unit => "The library's org id", "number"],
843           [limit => 'An optional page size, defaults to 10', 'number'],
844           [offset => 'Offset for paging, defaults to 0, 0 based', 'number'],
845         ],
846         ['A list of holds for the stated library to pull for', 'array']
847     ],
848     method          => 'hold_pull_list',
849 );
850 __PACKAGE__->register_method(
851     api_name        => 'open-ils.storage.direct.action.hold_request.pull_list.search.current_copy_circ_lib.status_filtered',
852     api_level       => 1,
853     stream          => 1,
854     signature   => [
855         "Returns the holds for a specific library's pull list that are definitely in that library, based on status.",
856         [ [org_unit => "The library's org id", "number"],
857           [limit => 'An optional page size, defaults to 10', 'number'],
858           [offset => 'Offset for paging, defaults to 0, 0 based', 'number'],
859         ],
860         ['A list of holds for the stated library to pull for', 'array']
861     ],
862     method          => 'hold_pull_list',
863 );
864
865 sub find_optional_surveys {
866     my $self = shift;
867     my $client = shift;
868     my $ou = ''.shift();
869
870     return undef unless ($ou);
871     my $s_table = action::survey->table;
872
873     my $select = <<"    SQL";
874         SELECT  s.*
875           FROM  $s_table s
876             JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
877           WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
878             AND s.required IS FALSE;
879     SQL
880
881     my $sth = action::survey->db_Main->prepare_cached($select);
882     $sth->execute($ou);
883
884     $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
885
886     return undef;
887 }
888 __PACKAGE__->register_method(
889     api_name        => 'open-ils.storage.action.survey.optional',
890     api_level       => 1,
891     stream          => 1,
892     method          => 'find_optional_surveys',
893 );
894
895 sub find_required_surveys {
896     my $self = shift;
897     my $client = shift;
898     my $ou = ''.shift();
899
900     return undef unless ($ou);
901     my $s_table = action::survey->table;
902
903     my $select = <<"    SQL";
904         SELECT  s.*
905           FROM  $s_table s
906             JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
907           WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
908             AND s.required IS TRUE;
909     SQL
910
911     my $sth = action::survey->db_Main->prepare_cached($select);
912     $sth->execute($ou);
913
914     $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
915
916     return undef;
917 }
918 __PACKAGE__->register_method(
919     api_name        => 'open-ils.storage.action.survey.required',
920     api_level       => 1,
921     stream          => 1,
922     method          => 'find_required_surveys',
923 );
924
925 sub find_usr_summary_surveys {
926     my $self = shift;
927     my $client = shift;
928     my $ou = ''.shift();
929
930     return undef unless ($ou);
931     my $s_table = action::survey->table;
932
933     my $select = <<"    SQL";
934         SELECT  s.*
935           FROM  $s_table s
936             JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
937           WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
938             AND s.usr_summary IS TRUE;
939     SQL
940
941     my $sth = action::survey->db_Main->prepare_cached($select);
942     $sth->execute($ou);
943
944     $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
945
946     return undef;
947 }
948 __PACKAGE__->register_method(
949     api_name        => 'open-ils.storage.action.survey.usr_summary',
950     api_level       => 1,
951     stream          => 1,
952     method          => 'find_usr_summary_surveys',
953 );
954
955 sub seconds_to_interval_hash {
956         my $interval = shift;
957         my $limit = shift || 's';
958         $limit =~ s/^(.)/$1/o;
959
960         my %output;
961
962         my ($y,$ym,$M,$Mm,$w,$wm,$d,$dm,$h,$hm,$m,$mm,$s);
963         my ($year, $month, $week, $day, $hour, $minute, $second) =
964                 ('years','months','weeks','days', 'hours', 'minutes', 'seconds');
965
966         if ($y = int($interval / (60 * 60 * 24 * 365))) {
967                 $output{$year} = $y;
968                 $ym = $interval % (60 * 60 * 24 * 365);
969         } else {
970                 $ym = $interval;
971         }
972         return %output if ($limit eq 'y');
973
974         if ($M = int($ym / ((60 * 60 * 24 * 365)/12))) {
975                 $output{$month} = $M;
976                 $Mm = $ym % ((60 * 60 * 24 * 365)/12);
977         } else {
978                 $Mm = $ym;
979         }
980         return %output if ($limit eq 'M');
981
982         if ($w = int($Mm / 604800)) {
983                 $output{$week} = $w;
984                 $wm = $Mm % 604800;
985         } else {
986                 $wm = $Mm;
987         }
988         return %output if ($limit eq 'w');
989
990         if ($d = int($wm / 86400)) {
991                 $output{$day} = $d;
992                 $dm = $wm % 86400;
993         } else {
994                 $dm = $wm;
995         }
996         return %output if ($limit eq 'd');
997
998         if ($h = int($dm / 3600)) {
999                 $output{$hour} = $h;
1000                 $hm = $dm % 3600;
1001         } else {
1002                 $hm = $dm;
1003         }
1004         return %output if ($limit eq 'h');
1005
1006         if ($m = int($hm / 60)) {
1007                 $output{$minute} = $m;
1008                 $mm = $hm % 60;
1009         } else {
1010                 $mm = $hm;
1011         }
1012         return %output if ($limit eq 'm');
1013
1014         if ($s = int($mm)) {
1015                 $output{$second} = $s;
1016         } else {
1017                 $output{$second} = 0 unless (keys %output);
1018         }
1019         return %output;
1020 }
1021
1022
1023 sub generate_fines {
1024     my $self = shift;
1025     my $client = shift;
1026     my $circ = shift;
1027     my $overbill = shift;
1028
1029     local $OpenILS::Application::Storage::WRITE = 1;
1030
1031     my @circs;
1032     if ($circ) {
1033         push @circs,
1034             action::circulation->search_where( { id => $circ, stop_fines => undef } ),
1035             booking::reservation->search_where( { id => $circ, return_time => undef, cancel_time => undef } );
1036     } else {
1037         push @circs, overdue_circs();
1038     }
1039
1040     my %hoo = map { ( $_->id => $_ ) } actor::org_unit::hours_of_operation->retrieve_all;
1041
1042     my $penalty = OpenSRF::AppSession->create('open-ils.penalty');
1043     for my $c (@circs) {
1044
1045         my $ctype = ref($c);
1046         $ctype =~ s/^.+::(\w+)$/$1/;
1047     
1048         my $due_date_method = 'due_date';
1049         my $target_copy_method = 'target_copy';
1050         my $circ_lib_method = 'circ_lib';
1051         my $recurring_fine_method = 'recurring_fine';
1052         my $is_reservation = 0;
1053         if ($ctype eq 'reservation') {
1054             $is_reservation = 1;
1055             $due_date_method = 'end_time';
1056             $target_copy_method = 'current_resource';
1057             $circ_lib_method = 'pickup_lib';
1058             $recurring_fine_method = 'fine_amount';
1059             next unless ($c->fine_interval);
1060         }
1061         #TODO: reservation grace periods
1062         my $grace_period = ($is_reservation ? 0 : interval_to_seconds($c->grace_period));
1063
1064         eval {
1065             if ($self->method_lookup('open-ils.storage.transaction.current')->run) {
1066                 $log->debug("Cleaning up after previous transaction\n");
1067                 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
1068             }
1069             $self->method_lookup('open-ils.storage.transaction.begin')->run( $client );
1070             $log->info(
1071                 sprintf("Processing %s %d...",
1072                     ($is_reservation ? "reservation" : "circ"), $c->id
1073                 )
1074             );
1075
1076
1077             my $due_dt = $parser->parse_datetime( cleanse_ISO8601( $c->$due_date_method ) );
1078     
1079             my $due = $due_dt->epoch;
1080             my $now = time;
1081
1082             my $fine_interval = $c->fine_interval;
1083             $fine_interval =~ s/(\d{2}):(\d{2}):(\d{2})/$1 h $2 m $3 s/o;
1084             $fine_interval = interval_to_seconds( $fine_interval );
1085     
1086             if ( $fine_interval == 0 || int($c->$recurring_fine_method * 100) == 0 || int($c->max_fine * 100) == 0 ) {
1087                 $client->respond( "Fine Generator skipping circ due to 0 fine interval, 0 fine rate, or 0 max fine.\n" );
1088                 $log->info( "Fine Generator skipping circ " . $c->id . " due to 0 fine interval, 0 fine rate, or 0 max fine." );
1089                 next;
1090             }
1091
1092             if ( $is_reservation and $fine_interval >= interval_to_seconds('1d') ) {    
1093                 my $tz_offset_s = 0;
1094                 if ($due_dt->strftime('%z') =~ /(-|\+)(\d{2}):?(\d{2})/) {
1095                     $tz_offset_s = $1 . interval_to_seconds( "${2}h ${3}m"); 
1096                 }
1097     
1098                 $due -= ($due % $fine_interval) + $tz_offset_s;
1099                 $now -= ($now % $fine_interval) + $tz_offset_s;
1100             }
1101     
1102             $client->respond(
1103                 "ARG! Overdue $ctype ".$c->id.
1104                 " for item ".$c->$target_copy_method.
1105                 " (user ".$c->usr.").\n".
1106                 "\tItem was due on or before: ".localtime($due)."\n");
1107     
1108             my @fines = money::billing->search_where(
1109                 { xact => $c->id,
1110                   btype => 1,
1111                   billing_ts => { '>' => $c->$due_date_method } },
1112                 { order_by => 'billing_ts DESC'}
1113             );
1114
1115             my $f_idx = 0;
1116             my $fine = $fines[$f_idx] if (@fines);
1117             if ($overbill) {
1118                 $fine = $fines[++$f_idx] while ($fine and $fine->voided);
1119             }
1120
1121             my $current_fine_total = 0;
1122             $current_fine_total += int($_->amount * 100) for (grep { $_ and !$_->voided } @fines);
1123     
1124             my $last_fine;
1125             if ($fine) {
1126                 $client->respond( "Last billing time: ".$fine->billing_ts." (clensed format: ".cleanse_ISO8601( $fine->billing_ts ).")");
1127                 $last_fine = $parser->parse_datetime( cleanse_ISO8601( $fine->billing_ts ) )->epoch;
1128             } else {
1129                 $log->info( "Potential first billing for circ ".$c->id );
1130                 $last_fine = $due;
1131
1132                 $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});
1133             }
1134
1135             next if ($last_fine > $now);
1136             # Generate fines for each past interval, including the one we are inside
1137             my $pending_fine_count = ceil( ($now - $last_fine) / $fine_interval );
1138
1139             if ( $last_fine == $due                         # we have no fines yet
1140                  && $grace_period                           # and we have a grace period
1141                  && $now < $due + $grace_period             # and some date math says were are within the grace period
1142             ) {
1143                 $client->respond( "Still inside grace period of: ". seconds_to_interval( $grace_period )."\n" );
1144                 $log->info( "Circ ".$c->id." is still inside grace period of: $grace_period [". seconds_to_interval( $grace_period ).']' );
1145                 next;
1146             }
1147
1148             $client->respond( "\t$pending_fine_count pending fine(s)\n" );
1149             next unless ($pending_fine_count);
1150
1151             my $recurring_fine = int($c->$recurring_fine_method * 100);
1152             my $max_fine = int($c->max_fine * 100);
1153
1154             my $skip_closed_check = $U->ou_ancestor_setting_value(
1155                 $c->$circ_lib_method->to_fieldmapper->id, 'circ.fines.charge_when_closed');
1156             $skip_closed_check = $U->is_true($skip_closed_check);
1157
1158             my $truncate_to_max_fine = $U->ou_ancestor_setting_value(
1159                 $c->$circ_lib_method->to_fieldmapper->id, 'circ.fines.truncate_to_max_fine');
1160             $truncate_to_max_fine = $U->is_true($truncate_to_max_fine);
1161
1162             my ($latest_billing_ts, $latest_amount) = ('',0);
1163             for (my $bill = 1; $bill <= $pending_fine_count; $bill++) {
1164     
1165                 if ($current_fine_total >= $max_fine) {
1166                     $c->update({stop_fines => 'MAXFINES', stop_fines_time => 'now'}) if ($ctype eq 'circulation');
1167                     $client->respond(
1168                         "\tMaximum fine level of ".$c->max_fine.
1169                         " reached for this $ctype.\n".
1170                         "\tNo more fines will be generated.\n" );
1171                     last;
1172                 }
1173                 
1174                 # XXX Use org time zone (or default to 'local') once we have the ou setting built for that
1175                 my $billing_ts = DateTime->from_epoch( epoch => $last_fine, time_zone => 'local' );
1176                 my $current_bill_count = $bill;
1177                 while ( $current_bill_count ) {
1178                     $billing_ts->add( seconds_to_interval_hash( $fine_interval ) );
1179                     $current_bill_count--;
1180                 }
1181
1182                 my $timestamptz = $billing_ts->strftime('%FT%T%z');
1183                 if (!$skip_closed_check) {
1184                     my $dow = $billing_ts->day_of_week_0();
1185                     my $dow_open = "dow_${dow}_open";
1186                     my $dow_close = "dow_${dow}_close";
1187
1188                     if (my $h = $hoo{$c->$circ_lib_method}) {
1189                         next if ( $h->$dow_open eq '00:00:00' and $h->$dow_close eq '00:00:00');
1190                     }
1191     
1192                     my @cl = actor::org_unit::closed_date->search_where(
1193                             { close_start   => { '<=' => $timestamptz },
1194                               close_end => { '>=' => $timestamptz },
1195                               org_unit  => $c->$circ_lib_method }
1196                     );
1197                     next if (@cl);
1198                 }
1199
1200                 # The billing amount for this billing normally ought to be the recurring fine amount.
1201                 # However, if the recurring fine amount would cause total fines to exceed the max fine amount,
1202                 # we may wish to reduce the amount for this billing (if circ.fines.truncate_to_max_fine is true).
1203                 my $this_billing_amount = $recurring_fine;
1204                 if ( $truncate_to_max_fine && ($current_fine_total + $this_billing_amount) > $max_fine ) {
1205                     $this_billing_amount = ($max_fine - $current_fine_total);
1206                 }
1207                 $current_fine_total += $this_billing_amount;
1208                 $latest_amount += $this_billing_amount;
1209                 $latest_billing_ts = $timestamptz;
1210
1211                 money::billing->create(
1212                     { xact      => ''.$c->id,
1213                       note      => "System Generated Overdue Fine",
1214                       billing_type  => "Overdue materials",
1215                       btype     => 1,
1216                       amount    => sprintf('%0.2f', $this_billing_amount/100),
1217                       billing_ts    => $timestamptz,
1218                     }
1219                 );
1220
1221             }
1222
1223             $client->respond( "\t\tAdding fines totaling $latest_amount for overdue up to $latest_billing_ts\n" )
1224                 if ($latest_billing_ts and $latest_amount);
1225
1226             $self->method_lookup('open-ils.storage.transaction.commit')->run;
1227
1228             if(1) { 
1229
1230                 # Caluclate penalties inline
1231                 OpenILS::Utils::Penalty->calculate_penalties(
1232                     undef, $c->usr->to_fieldmapper->id.'', $c->$circ_lib_method->to_fieldmapper->id.'');
1233
1234             } else {
1235
1236                 # Calculate penalties with an aysnc call to the penalty server.  This approach
1237                 # may lead to duplicate penalties since multiple penalty processes for a
1238                 # given user may be running at the same time. Leave this here for reference 
1239                 # in case we later find that asyc calls are needed in some environments.
1240                 $penalty->request(
1241                     'open-ils.penalty.patron_penalty.calculate',
1242                     { patronid  => ''.$c->usr,
1243                     context_org => ''.$c->$circ_lib_method,
1244                     update  => 1,
1245                     background  => 1,
1246                     }
1247                 )->gather(1);
1248             }
1249
1250         };
1251
1252         if ($@) {
1253             my $e = $@;
1254             $client->respond( "Error processing overdue $ctype [".$c->id."]:\n\n$e\n" );
1255             $log->error("Error processing overdue $ctype [".$c->id."]:\n$e\n");
1256             $self->method_lookup('open-ils.storage.transaction.rollback')->run;
1257             last if ($e =~ /IS NOT CONNECTED TO THE NETWORK/o);
1258         }
1259     }
1260 }
1261 __PACKAGE__->register_method(
1262     api_name        => 'open-ils.storage.action.circulation.overdue.generate_fines',
1263     api_level       => 1,
1264     stream      => 1,
1265     method          => 'generate_fines',
1266 );
1267
1268
1269
1270 sub new_hold_copy_targeter {
1271     my $self = shift;
1272     my $client = shift;
1273     my $check_expire = shift;
1274     my $one_hold = shift;
1275     my $find_copy = shift;
1276
1277     local $OpenILS::Application::Storage::WRITE = 1;
1278
1279     $self->{target_weight} = {};
1280     $self->{max_loops} = {};
1281
1282     my $holds;
1283
1284     try {
1285         if ($one_hold) {
1286             $self->method_lookup('open-ils.storage.transaction.begin')->run( $client );
1287             $holds = [ action::hold_request->search_where( { id => $one_hold, fulfillment_time => undef, cancel_time => undef, frozen => 'f' } ) ];
1288         } elsif ( $check_expire ) {
1289
1290             # what's the retarget time threashold?
1291             my $time = time;
1292             $check_expire ||= '12h';
1293             $check_expire = interval_to_seconds( $check_expire );
1294
1295             my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = gmtime(time() - $check_expire);
1296             $year += 1900;
1297             $mon += 1;
1298             my $expire_threshold = sprintf(
1299                 '%s-%0.2d-%0.2dT%0.2d:%0.2d:%0.2d-00',
1300                 $year, $mon, $mday, $hour, $min, $sec
1301             );
1302
1303             # find all the holds holds needing retargeting
1304             $holds = [ action::hold_request->search_where(
1305                             { capture_time => undef,
1306                               fulfillment_time => undef,
1307                               cancel_time => undef,
1308                               frozen => 'f',
1309                               prev_check_time => { '<=' => $expire_threshold },
1310                             },
1311                             { order_by => 'selection_depth DESC, request_time,prev_check_time' } ) ];
1312
1313             # find all the holds holds needing first time targeting
1314             push @$holds, action::hold_request->search(
1315                             capture_time => undef,
1316                             fulfillment_time => undef,
1317                             prev_check_time => undef,
1318                             frozen => 'f',
1319                             cancel_time => undef,
1320                             { order_by => 'selection_depth DESC, request_time' } );
1321         } else {
1322
1323             # find all the holds holds needing first time targeting ONLY
1324             $holds = [ action::hold_request->search(
1325                             capture_time => undef,
1326                             fulfillment_time => undef,
1327                             prev_check_time => undef,
1328                             cancel_time => undef,
1329                             frozen => 'f',
1330                             { order_by => 'selection_depth DESC, request_time' } ) ];
1331         }
1332     } catch Error with {
1333         my $e = shift;
1334         die "Could not retrieve uncaptured hold requests:\n\n$e\n";
1335     };
1336
1337     my @closed = actor::org_unit::closed_date->search_where(
1338         { close_start => { '<=', 'now' },
1339           close_end => { '>=', 'now' } }
1340     );
1341
1342     if ($check_expire) {
1343
1344         # $check_expire, if it exists, was already converted to seconds
1345         my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = gmtime(time() + $check_expire);
1346         $year += 1900;
1347         $mon += 1;
1348
1349         my $next_check_time = sprintf(
1350             '%s-%0.2d-%0.2dT%0.2d:%0.2d:%0.2d-00',
1351             $year, $mon, $mday, $hour, $min, $sec
1352         );
1353
1354
1355         my @closed_at_next = actor::org_unit::closed_date->search_where(
1356             { close_start => { '<=', $next_check_time },
1357               close_end => { '>=', $next_check_time } }
1358         );
1359
1360         my @new_closed;
1361         for my $c_at_n (@closed_at_next) {
1362             if (grep { ''.$_->org_unit eq ''.$c_at_n->org_unit } @closed) {
1363                 push @new_closed, $c_at_n;
1364             }
1365         }
1366         @closed = @new_closed;
1367     }
1368
1369     my @successes;
1370     my $actor = OpenSRF::AppSession->create('open-ils.actor');
1371
1372     my $target_when_closed = {};
1373     my $target_when_closed_if_at_pickup_lib = {};
1374
1375     for my $hold (@$holds) {
1376         try {
1377             #start a transaction if needed
1378             if ($self->method_lookup('open-ils.storage.transaction.current')->run) {
1379                 $log->debug("Cleaning up after previous transaction\n");
1380                 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
1381             }
1382             $self->method_lookup('open-ils.storage.transaction.begin')->run( $client );
1383             $log->info("Processing hold ".$hold->id."...\n");
1384
1385             #first, re-fetch the hold, to make sure it's not captured already
1386             $hold->remove_from_object_index();
1387             $hold = action::hold_request->retrieve( $hold->id );
1388
1389             die "OK\n" if (!$hold or $hold->capture_time or $hold->cancel_time);
1390
1391             # remove old auto-targeting maps
1392             my @oldmaps = action::hold_copy_map->search( hold => $hold->id );
1393             $_->delete for (@oldmaps);
1394
1395             if ($hold->expire_time) {
1396                 my $ex_time = $parser->parse_datetime( cleanse_ISO8601( $hold->expire_time ) );
1397                 if ( DateTime->compare($ex_time, DateTime->now) < 0 ) {
1398
1399                     # cancel cause = un-targeted expiration
1400                     $hold->update( { cancel_time => 'now', cancel_cause => 1 } ); 
1401
1402                     # refresh fields from the DB while still in the xact
1403                     my $fm_hold = $hold->to_fieldmapper; 
1404
1405                     $self->method_lookup('open-ils.storage.transaction.commit')->run;
1406
1407                     # tell A/T the hold was cancelled
1408                     my $ses = OpenSRF::AppSession->create('open-ils.trigger');
1409                     $ses->request('open-ils.trigger.event.autocreate', 
1410                         'hold_request.cancel.expire_no_target', $fm_hold, $fm_hold->pickup_lib);
1411
1412                     die "OK\n";
1413                 }
1414             }
1415
1416             my $all_copies = [];
1417
1418             # find filters for MR holds
1419             my ($types, $formats, $lang);
1420             if (defined($hold->holdable_formats)) {
1421                 ($types, $formats, $lang) = split '-', $hold->holdable_formats;
1422             }
1423
1424             # find all the potential copies
1425             if ($hold->hold_type eq 'M') {
1426                 my $records = [
1427                     map {
1428                         isTrue($_->deleted) ?  () : ($_->id)
1429                     } metabib::metarecord->retrieve($hold->target)->source_records
1430                 ];
1431                 if(@$records > 0) {
1432                     for my $r ( map
1433                             {$_->record}
1434                             metabib::record_descriptor
1435                                 ->search(
1436                                     record => $records,
1437                                     ( $types   ? (item_type => [split '', $types])   : () ),
1438                                     ( $formats ? (item_form => [split '', $formats]) : () ),
1439                                     ( $lang    ? (item_lang => $lang)                : () ),
1440                                 )
1441                     ) {
1442                         my ($rtree) = $self
1443                             ->method_lookup( 'open-ils.storage.biblio.record_entry.ranged_tree')
1444                             ->run( $r->id, $hold->selection_ou, $hold->selection_depth );
1445
1446                         for my $cn ( @{ $rtree->call_numbers } ) {
1447                             push @$all_copies,
1448                                 asset::copy->search_where(
1449                                     { id => [map {$_->id} @{ $cn->copies }],
1450                                       deleted => 'f' }
1451                                 ) if ($cn && @{ $cn->copies });
1452                         }
1453                     }
1454                 }
1455             } elsif ($hold->hold_type eq 'T') {
1456                 my ($rtree) = $self
1457                     ->method_lookup( 'open-ils.storage.biblio.record_entry.ranged_tree')
1458                     ->run( $hold->target, $hold->selection_ou, $hold->selection_depth );
1459
1460                 unless ($rtree) {
1461                     push @successes, { hold => $hold->id, eligible_copies => 0, error => 'NO_RECORD' };
1462                     die "OK\n";
1463                 }
1464
1465                 for my $cn ( @{ $rtree->call_numbers } ) {
1466                     push @$all_copies,
1467                         asset::copy->search_where(
1468                             { id => [map {$_->id} @{ $cn->copies }],
1469                               deleted => 'f' }
1470                         ) if ($cn && @{ $cn->copies });
1471                 }
1472             } elsif ($hold->hold_type eq 'V') {
1473                 my ($vtree) = $self
1474                     ->method_lookup( 'open-ils.storage.asset.call_number.ranged_tree')
1475                     ->run( $hold->target, $hold->selection_ou, $hold->selection_depth );
1476
1477                 push @$all_copies,
1478                     asset::copy->search_where(
1479                         { id => [map {$_->id} @{ $vtree->copies }],
1480                           deleted => 'f' }
1481                     ) if ($vtree && @{ $vtree->copies });
1482
1483             } elsif ($hold->hold_type eq 'P') {
1484                 my @part_maps = asset::copy_part_map->search_where( { part => $hold->target } );
1485                 $all_copies = [
1486                     asset::copy->search_where(
1487                         { id => [map {$_->target_copy} @part_maps],
1488                           deleted => 'f' }
1489                     )
1490                 ] if (@part_maps);
1491                     
1492             } elsif ($hold->hold_type eq 'I') {
1493                 my ($itree) = $self
1494                     ->method_lookup( 'open-ils.storage.serial.issuance.ranged_tree')
1495                     ->run( $hold->target, $hold->selection_ou, $hold->selection_depth );
1496
1497                 push @$all_copies,
1498                     asset::copy->search_where(
1499                         { id => [map {$_->unit->id} @{ $itree->items }],
1500                           deleted => 'f' }
1501                     ) if ($itree && @{ $itree->items });
1502                     
1503             } elsif  ($hold->hold_type eq 'C' || $hold->hold_type eq 'R' || $hold->hold_type eq 'F') {
1504                 my $_cp = asset::copy->retrieve($hold->target);
1505                 push @$all_copies, $_cp if $_cp;
1506             }
1507
1508             # Force and recall holds bypass pretty much everything
1509             if ($hold->hold_type ne 'R' && $hold->hold_type ne 'F') {
1510                 # trim unholdables
1511                 @$all_copies = grep {   isTrue($_->status->holdable) && 
1512                             isTrue($_->location->holdable) && 
1513                             isTrue($_->holdable) &&
1514                             !isTrue($_->deleted) &&
1515                             (isTrue($hold->mint_condition) ? isTrue($_->mint_condition) : 1) &&
1516                             ( ( $hold->hold_type ne 'C' && $hold->hold_type ne 'I' # Copy-level holds don't care about parts
1517                                 && $hold->hold_type ne 'P' ) ? $_->part_maps->count == 0 : 1)
1518                         } @$all_copies;
1519             }
1520
1521             # let 'em know we're still working
1522             $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
1523             
1524             # if we have no copies ...
1525             if (!ref $all_copies || !@$all_copies) {
1526                 $log->info("\tNo copies available for targeting at all!\n");
1527                 push @successes, { hold => $hold->id, eligible_copies => 0, error => 'NO_COPIES' };
1528
1529                 $hold->update( { prev_check_time => 'today', current_copy => undef } );
1530                 $self->method_lookup('open-ils.storage.transaction.commit')->run;
1531                 die "OK\n";
1532             }
1533
1534             my $copy_count = @$all_copies;
1535             my $found_copy = undef;
1536             $found_copy = 1 if($find_copy and grep $_ == $find_copy, @$all_copies);
1537
1538             # map the potentials, so that we can pick up checkins
1539             # XXX Loop-based targeting may require that /only/ copies from this loop should be added to
1540             # XXX the potentials list.  If this is the cased, hold_copy_map creation will move down further.
1541             my $pu_lib = ''.$hold->pickup_lib;
1542             my $prox_list = create_prox_list( $self, $pu_lib, $all_copies, $hold );
1543             $log->debug( "\tMapping ".scalar(@$all_copies)." potential copies for hold ".$hold->id);
1544             for my $prox ( keys %$prox_list ) {
1545                 action::hold_copy_map->create( { proximity => $prox, hold => $hold->id, target_copy => $_->id } ) for (@{$$prox_list{$prox}});
1546             }
1547
1548             #$client->status( new OpenSRF::DomainObject::oilsContinueStatus );
1549
1550             my @good_copies;
1551             for my $c (@$all_copies) {
1552                 # current target
1553                 next if ($hold->current_copy and $c->id eq $hold->current_copy);
1554
1555                 # skip on circ lib is closed IFF we care
1556                 my $ignore_closing;
1557
1558                 if (''.$hold->pickup_lib eq ''.$c->circ_lib) {
1559                     $ignore_closing = ou_ancestor_setting_value_or_cache(
1560                         $actor,
1561                         ''.$c->circ_lib,
1562                         'circ.holds.target_when_closed_if_at_pickup_lib',
1563                         $target_when_closed_if_at_pickup_lib
1564                     ) || 0;
1565                 }
1566                 if (not $ignore_closing) {  # one more chance to find a reason
1567                                             # to ignore OU closedness.
1568                     $ignore_closing = ou_ancestor_setting_value_or_cache(
1569                         $actor,
1570                         ''.$c->circ_lib,
1571                         'circ.holds.target_when_closed',
1572                         $target_when_closed
1573                     ) || 0;
1574                 }
1575
1576 #               $logger->info(
1577 #                   "For hold " . $hold->id . " and copy with circ_lib " .
1578 #                   $c->circ_lib . " we " .
1579 #                   ($ignore_closing ? "ignore" : "respect")
1580 #                   . " closed dates"
1581 #               );
1582
1583                 next if (
1584                     (not $ignore_closing) and
1585                     (grep { ''.$_->org_unit eq ''.$c->circ_lib } @closed)
1586                 );
1587
1588                 # target of another hold
1589                 next if (action::hold_request
1590                         ->search_where(
1591                             { current_copy => $c->id,
1592                               fulfillment_time => undef,
1593                               cancel_time => undef,
1594                             }
1595                         )
1596                 );
1597
1598                 # we passed all three, keep it
1599                 push @good_copies, $c if ($c);
1600                 #$client->status( new OpenSRF::DomainObject::oilsContinueStatus );
1601             }
1602
1603             $log->debug("\t".scalar(@good_copies)." (non-current) copies available for targeting...");
1604
1605             my $old_best = $hold->current_copy;
1606             my $old_best_still_valid = 0; # Assume no, but the next line says yes if it is still a potential.
1607             $old_best_still_valid = 1 if ( $old_best && grep { ''.$old_best->id eq ''.$_->id } @$all_copies );
1608             $hold->update({ current_copy => undef }) if ($old_best);
1609     
1610             if (!scalar(@good_copies)) {
1611                 $log->info("\tNo (non-current) copies eligible to fill the hold.");
1612                 if ( $old_best_still_valid ) {
1613                     # the old copy is still available
1614                     $log->debug("\tPushing current_copy back onto the targeting list");
1615                     push @good_copies, $old_best;
1616                 } else {
1617                     # oops, old copy is not available
1618                     $log->debug("\tcurrent_copy is no longer available for targeting... NEXT HOLD, PLEASE!");
1619                     $hold->update( { prev_check_time => 'today' } );
1620                     $self->method_lookup('open-ils.storage.transaction.commit')->run;
1621                     push @successes, { hold => $hold->id, eligible_copies => 0, error => 'NO_TARGETS' };
1622                     die "OK\n";
1623                 }
1624             }
1625
1626             # reset prox list after trimming good copies
1627             $prox_list = create_prox_list(
1628                 $self, $pu_lib,
1629                 [ grep { $_->status == 0 || $_->status == 7 } @good_copies ],
1630                 $hold
1631             );
1632
1633             $all_copies = [ grep { ''.$_->circ_lib ne $pu_lib && ( $_->status == 0 || $_->status == 7 ) } @good_copies ];
1634
1635             my $min_prox = [ sort keys %$prox_list ]->[0];
1636             my $best;
1637             if  ($hold->hold_type eq 'R' || $hold->hold_type eq 'F') { # Recall/Force holds bypass hold rules.
1638                 $best = $good_copies[0] if(scalar @good_copies);
1639             } else {
1640                 $best = choose_nearest_copy($hold, { $min_prox => delete($$prox_list{$min_prox}) });
1641             }
1642
1643             $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
1644
1645             if (!$best) {
1646                 $log->debug("\tNothing at the pickup lib, looking elsewhere among ".scalar(@$all_copies)." copies");
1647
1648                 $self->{max_loops}{$pu_lib} = $actor->request(
1649                     'open-ils.actor.ou_setting.ancestor_default' => $pu_lib => 'circ.holds.max_org_unit_target_loops'
1650                 )->gather(1);
1651
1652                 if (defined($self->{max_loops}{$pu_lib})) {
1653                     $self->{max_loops}{$pu_lib} = $self->{max_loops}{$pu_lib}{value};
1654
1655                     my %circ_lib_map =  map { (''.$_->circ_lib => 1) } @$all_copies;
1656                     my $circ_lib_list = [keys %circ_lib_map];
1657     
1658                     my $cstore = OpenSRF::AppSession->create('open-ils.cstore');
1659     
1660                     # Grab the "biggest" loop for this hold so far
1661                     my $current_loop = $cstore->request(
1662                         'open-ils.cstore.json_query',
1663                         { distinct => 1,
1664                           select => { aufhmxl => ['max'] },
1665                           from => 'aufhmxl',
1666                           where => { hold => $hold->id}
1667                         }
1668                     )->gather(1);
1669     
1670                     $current_loop = $current_loop->{max} if ($current_loop);
1671                     $current_loop ||= 1;
1672     
1673                     my $exclude_list = $cstore->request(
1674                         'open-ils.cstore.json_query.atomic',
1675                         { distinct => 1,
1676                           select => { aufhol => ['circ_lib'] },
1677                           from => 'aufhol',
1678                           where => { hold => $hold->id}
1679                         }
1680                     )->gather(1);
1681     
1682                     my @keepers;
1683                     if ($exclude_list && @$exclude_list) {
1684                         $exclude_list = [map {$_->{circ_lib}} @$exclude_list];
1685                         # check to see if we've used up every library in the potentials list
1686                         for my $l ( @$circ_lib_list ) {
1687                             my $keep = 1;
1688                             for my $ex ( @$exclude_list ) {
1689                                 if ($ex eq $l) {
1690                                     $keep = 0;
1691                                     last;
1692                                 }
1693                             }
1694                             push(@keepers, $l) if ($keep);
1695                         }
1696                     } else {
1697                         @keepers = @$circ_lib_list;
1698                     }
1699     
1700                     $current_loop++ if (!@keepers);
1701     
1702                     if ($self->{max_loops}{$pu_lib} && $self->{max_loops}{$pu_lib} >= $current_loop) {
1703                         # We haven't exceeded max_loops yet
1704                         my @keeper_copies;
1705                         for my $cp ( @$all_copies ) {
1706                             push(@keeper_copies, $cp) if ( !@keepers || grep { $_ eq ''.$cp->circ_lib } @keepers );
1707
1708                         }
1709                         $all_copies = [@keeper_copies];
1710                     } else {
1711                         # We have, and should remove potentials and cancel the hold
1712                         my @oldmaps = action::hold_copy_map->search( hold => $hold->id );
1713                         $_->delete for (@oldmaps);
1714
1715                         # cancel cause = un-targeted expiration
1716                         $hold->update( { cancel_time => 'now', cancel_cause => 1 } ); 
1717
1718                         # refresh fields from the DB while still in the xact
1719                         my $fm_hold = $hold->to_fieldmapper; 
1720
1721                         $self->method_lookup('open-ils.storage.transaction.commit')->run;
1722
1723                         # tell A/T the hold was cancelled
1724                         my $ses = OpenSRF::AppSession->create('open-ils.trigger');
1725                         $ses->request('open-ils.trigger.event.autocreate', 
1726                             'hold_request.cancel.expire_no_target', $fm_hold, $fm_hold->pickup_lib);
1727
1728                         die "OK\n";
1729                     }
1730
1731                     $prox_list = create_prox_list( $self, $pu_lib, $all_copies, $hold );
1732
1733                     $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
1734
1735                 }
1736
1737                 $best = choose_nearest_copy($hold, $prox_list);
1738             }
1739
1740             $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
1741             if ($old_best) {
1742                 # hold wasn't fulfilled, record the fact
1743             
1744                 $log->info("\tHold was not (but should have been) fulfilled by ".$old_best->id);
1745                 action::unfulfilled_hold_list->create(
1746                         { hold => ''.$hold->id,
1747                           current_copy => ''.$old_best->id,
1748                           circ_lib => ''.$old_best->circ_lib,
1749                         });
1750             }
1751
1752             if ($best) {
1753                 $hold->update( { current_copy => ''.$best->id, prev_check_time => 'now' } );
1754                 $log->debug("\tUpdating hold [".$hold->id."] with new 'current_copy' [".$best->id."] for hold fulfillment.");
1755             } elsif (
1756                 $old_best_still_valid &&
1757                 !action::hold_request
1758                     ->search_where(
1759                         { current_copy => $old_best->id,
1760                           fulfillment_time => undef,
1761                           cancel_time => undef,
1762                         }       
1763                     ) &&
1764                 ( OpenILS::Utils::PermitHold::permit_copy_hold(
1765                     { title => $old_best->call_number->record->to_fieldmapper,
1766                       title_descriptor => $old_best->call_number->record->record_descriptor->next->to_fieldmapper,
1767                       patron => $hold->usr->to_fieldmapper,
1768                       copy => $old_best->to_fieldmapper,
1769                       requestor => $hold->requestor->to_fieldmapper,
1770                       request_lib => $hold->request_lib->to_fieldmapper,
1771                       pickup_lib => $hold->pickup_lib->id,
1772                       retarget => 1
1773                     }
1774                 ))
1775             ) {     
1776                 $hold->update( { prev_check_time => 'now', current_copy => ''.$old_best->id } );
1777                 $log->debug( "\tRetargeting the previously targeted copy [".$old_best->id."]" );
1778             } else {
1779                 $hold->update( { prev_check_time => 'now' } );
1780                 $log->info( "\tThere were no targetable copies for the hold" );
1781                 process_recall($actor, $log, $hold, \@good_copies);
1782             }
1783
1784             $self->method_lookup('open-ils.storage.transaction.commit')->run;
1785             $log->info("\tProcessing of hold ".$hold->id." complete.");
1786
1787             push @successes,
1788                 { hold => $hold->id,
1789                   old_target => ($old_best ? $old_best->id : undef),
1790                   eligible_copies => $copy_count,
1791                   target => ($best ? $best->id : undef),
1792                   found_copy => $found_copy };
1793
1794         } otherwise {
1795             my $e = shift;
1796             if ($e !~ /^OK/o) {
1797                 $log->error("Processing of hold failed:  $e");
1798                 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
1799                 throw $e if ($e =~ /IS NOT CONNECTED TO THE NETWORK/o);
1800             }
1801         };
1802     }
1803
1804     return \@successes;
1805 }
1806 __PACKAGE__->register_method(
1807     api_name    => 'open-ils.storage.action.hold_request.copy_targeter',
1808     api_level   => 1,
1809     method      => 'new_hold_copy_targeter',
1810 );
1811
1812 sub process_recall {
1813     my ($actor, $log, $hold, $good_copies) = @_;
1814
1815     # Bail early if we don't have required settings to avoid spurious requests
1816     my ($recall_threshold, $return_interval, $fine_rules);
1817
1818     my $rv = $actor->request(
1819         'open-ils.actor.ou_setting.ancestor_default', ''.$hold->pickup_lib, 'circ.holds.recall_threshold'
1820     )->gather(1);
1821
1822     if (!$rv) {
1823         $log->info("Recall threshold was not set; bailing out on hold ".$hold->id." processing.");
1824         return;
1825     }
1826     $recall_threshold = $rv->{value};
1827
1828     $rv = $actor->request(
1829         'open-ils.actor.ou_setting.ancestor_default', ''.$hold->pickup_lib, 'circ.holds.recall_return_interval'
1830     )->gather(1);
1831
1832     if (!$rv) {
1833         $log->info("Recall return interval was not set; bailing out on hold ".$hold->id." processing.");
1834         return;
1835     }
1836     $return_interval = $rv->{value};
1837
1838     $rv = $actor->request(
1839         'open-ils.actor.ou_setting.ancestor_default', ''.$hold->pickup_lib, 'circ.holds.recall_fine_rules'
1840     )->gather(1);
1841
1842     if ($rv) {
1843         $fine_rules = $rv->{value};
1844     }
1845
1846     $log->info("Recall threshold: $recall_threshold; return interval: $return_interval");
1847
1848     # We want checked out copies (status = 1) at the hold pickup lib
1849     my $all_copies = [grep { $_->status == 1 } grep {''.$_->circ_lib eq ''.$hold->pickup_lib } @$good_copies];
1850
1851     my @copy_ids = map { $_->id } @$all_copies;
1852
1853     $log->info("Found " . scalar(@$all_copies) . " eligible checked-out copies for recall");
1854
1855     my $return_date = DateTime->now(time_zone => 'local')->add(seconds => interval_to_seconds($return_interval))->iso8601();
1856
1857     # Iterate over the checked-out copies to find a copy with a
1858     # loan period longer than the recall threshold:
1859     my $circs = [ action::circulation->search_where(
1860         { target_copy => \@copy_ids, checkin_time => undef, duration => { '>' => $recall_threshold } },
1861         { order_by => 'due_date ASC' }
1862     )];
1863
1864     # If we have a candidate copy, then:
1865     if (scalar(@$circs)) {
1866         my $circ = $circs->[0];
1867         $log->info("Recalling circ ID : " . $circ->id);
1868
1869         # Give the user a new due date of either a full recall threshold,
1870         # or the return interval, whichever is further in the future
1871         my $threshold_date = DateTime::Format::ISO8601->parse_datetime(cleanse_ISO8601($circ->xact_start))->add(seconds => interval_to_seconds($recall_threshold))->iso8601();
1872         if (DateTime->compare(DateTime::Format::ISO8601->parse_datetime($threshold_date), DateTime::Format::ISO8601->parse_datetime($return_date)) == 1) {
1873             $return_date = $threshold_date;
1874         }
1875
1876         my $update_fields = {
1877             due_date => $return_date,
1878             renewal_remaining => 0,
1879         };
1880
1881         # If the OU hasn't defined new fine rules for recalls, keep them
1882         # as they were
1883         if ($fine_rules) {
1884             $log->info("Apply recall fine rules: $fine_rules");
1885             my $rules = OpenSRF::Utils::JSON->JSON2perl($fine_rules);
1886             $update_fields->{recurring_fine} = $rules->[0];
1887             $update_fields->{fine_interval} = $rules->[1];
1888             $update_fields->{max_fine} = $rules->[2];
1889         }
1890
1891         # Adjust circ for current user
1892         $circ->update($update_fields);
1893
1894         # Create trigger event for notifying current user
1895         my $ses = OpenSRF::AppSession->create('open-ils.trigger');
1896         $ses->request('open-ils.trigger.event.autocreate', 'circ.recall.target', $circ->to_fieldmapper(), $circ->circ_lib->id);
1897     }
1898
1899     $log->info("Processing of hold ".$hold->id." for recall is now complete.");
1900 }
1901
1902 sub reservation_targeter {
1903     my $self = shift;
1904     my $client = shift;
1905     my $one_reservation = shift;
1906
1907     local $OpenILS::Application::Storage::WRITE = 1;
1908
1909     my $reservations;
1910
1911     try {
1912         if ($one_reservation) {
1913             $self->method_lookup('open-ils.storage.transaction.begin')->run( $client );
1914             $reservations = [ booking::reservation->search_where( { id => $one_reservation, capture_time => undef, cancel_time => undef } ) ];
1915         } else {
1916
1917             # find all the reservations needing targeting
1918             $reservations = [
1919                 booking::reservation->search_where(
1920                     { current_resource => undef,
1921                       cancel_time => undef,
1922                       start_time => { '>' => 'now' }
1923                     },
1924                     { order_by => 'start_time' }
1925                 )
1926             ];
1927         }
1928     } catch Error with {
1929         my $e = shift;
1930         die "Could not retrieve reservation requests:\n\n$e\n";
1931     };
1932
1933     my @successes = ();
1934     for my $bresv (@$reservations) {
1935         try {
1936             #start a transaction if needed
1937             if ($self->method_lookup('open-ils.storage.transaction.current')->run) {
1938                 $log->debug("Cleaning up after previous transaction\n");
1939                 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
1940             }
1941             $self->method_lookup('open-ils.storage.transaction.begin')->run( $client );
1942             $log->info("Processing reservation ".$bresv->id."...\n");
1943
1944             #first, re-fetch the hold, to make sure it's not captured already
1945             $bresv->remove_from_object_index();
1946             $bresv = booking::reservation->retrieve( $bresv->id );
1947
1948             die "OK\n" if (!$bresv or $bresv->capture_time or $bresv->cancel_time);
1949
1950             my $end_time = $parser->parse_datetime( cleanse_ISO8601( $bresv->end_time ) );
1951             if (DateTime->compare($end_time, DateTime->now) < 0) {
1952
1953                 # cancel cause = un-targeted expiration
1954                 $bresv->update( { cancel_time => 'now' } ); 
1955
1956                 # refresh fields from the DB while still in the xact
1957                 my $fm_bresv = $bresv->to_fieldmapper;
1958
1959                 $self->method_lookup('open-ils.storage.transaction.commit')->run;
1960
1961                 # tell A/T the reservation was cancelled
1962                 my $ses = OpenSRF::AppSession->create('open-ils.trigger');
1963                 $ses->request('open-ils.trigger.event.autocreate', 
1964                     'booking.reservation.cancel.expire_no_target', $fm_bresv, $fm_bresv->pickup_lib);
1965
1966                 die "OK\n";
1967             }
1968
1969             my $possible_resources;
1970
1971             # find all the potential resources
1972             if (!$bresv->target_resource) {
1973                 my $filter = { type => $bresv->target_resource_type };
1974                 my $attr_maps = [ booking::reservation_attr_value_map->search( reservation => $bresv->id) ];
1975
1976                 $filter->{attribute_values} = [ map { $_->attr_value } @$attr_maps ] if (@$attr_maps);
1977
1978                 $filter->{available} = [$bresv->start_time, $bresv->end_time];
1979                 my $ses = OpenSRF::AppSession->create('open-ils.booking');
1980                 $possible_resources = $ses->request('open-ils.booking.resources.filtered_id_list', undef, $filter)->gather(1);
1981             } else {
1982                 $possible_resources = $bresv->target_resource;
1983             }
1984
1985             my $all_resources = [ booking::resource->search( id => $possible_resources ) ];
1986             @$all_resources = grep { isTrue($_->type->transferable) || $_->owner.'' eq $bresv->pickup_lib.'' } @$all_resources;
1987
1988
1989             my @good_resources = ();
1990             my %conflicts = ();
1991             for my $res (@$all_resources) {
1992                 unless (isTrue($res->type->catalog_item)) {
1993                     push @good_resources, $res;
1994                     next;
1995                 }
1996
1997                 my $copy = [ asset::copy->search( deleted => 'f', barcode => $res->barcode )]->[0];
1998
1999                 unless ($copy) {
2000                     push @good_resources, $res;
2001                     next;
2002                 }
2003
2004                 # At this point, if we're just targeting one specific
2005                 # resource, just succeed. We don't care about its present
2006                 # copy status.
2007                 if ($bresv->target_resource) {
2008                     push @good_resources, $res;
2009                     next;
2010                 }
2011
2012                 if ($copy->status->id == 0 || $copy->status->id == 7) {
2013                     push @good_resources, $res;
2014                     next;
2015                 }
2016
2017                 if ($copy->status->id == 1) {
2018                     my $circs = [ action::circulation->search_where(
2019                         {target_copy => $copy->id, checkin_time => undef },
2020                         { order_by => 'id DESC' }
2021                     ) ];
2022
2023                     if (@$circs) {
2024                         my $due_date = $circs->[0]->due_date;
2025                         $due_date = $parser->parse_datetime( cleanse_ISO8601( $due_date ) );
2026                         my $start_time = $parser->parse_datetime( cleanse_ISO8601( $bresv->start_time ) );
2027                         if (DateTime->compare($start_time, $due_date) < 0) {
2028                             $conflicts{$res->id} = $circs->[0]->to_fieldmapper;
2029                             next;
2030                         }
2031
2032                         push @good_resources, $res;
2033                     }
2034
2035                     next;
2036                 }
2037
2038                 push @good_resources, $res if (isTrue($copy->status->holdable));
2039             }
2040
2041             # let 'em know we're still working
2042             $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
2043             
2044             # if we have no copies ...
2045             if (!@good_resources) {
2046                 $log->info("\tNo resources available for targeting at all!\n");
2047                 push @successes, { reservation => $bresv->id, eligible_copies => 0, error => 'NO_COPIES', conflicts => \%conflicts };
2048
2049
2050                 $self->method_lookup('open-ils.storage.transaction.commit')->run;
2051                 die "OK\n";
2052             }
2053
2054             $log->debug("\t".scalar(@good_resources)." resources available for targeting...");
2055
2056             # LFW: note that after the inclusion of hold proximity
2057             # adjustment, this prox_list is the only prox_list
2058             # array in this perl package.  Other occurences are
2059             # hashes.
2060             my $prox_list = [];
2061             $$prox_list[0] =
2062             [
2063                 grep {
2064                     $_->owner == $bresv->pickup_lib
2065                 } @good_resources
2066             ];
2067
2068             $all_resources = [grep {$_->owner != $bresv->pickup_lib } @good_resources];
2069             # $all_copies is now a list of copies not at the pickup library
2070
2071             my $best = shift @good_resources;
2072             $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
2073
2074             if (!$best) {
2075                 $log->debug("\tNothing at the pickup lib, looking elsewhere among ".scalar(@$all_resources)." resources");
2076
2077                 $prox_list =
2078                     map  { $_->[1] }
2079                     sort { $a->[0] <=> $b->[0] }
2080                     map  {
2081                         [   actor::org_unit_proximity->search_where(
2082                                 { from_org => $bresv->pickup_lib.'', to_org => $_->owner.'' }
2083                             )->[0]->prox,
2084                             $_
2085                         ]
2086                     } @$all_resources;
2087
2088                 $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
2089
2090                 $best = shift @$prox_list
2091             }
2092
2093             if ($best) {
2094                 $bresv->update( { current_resource => ''.$best->id } );
2095                 $log->debug("\tUpdating reservation [".$bresv->id."] with new 'current_resource' [".$best->id."] for reservation fulfillment.");
2096             }
2097
2098             $self->method_lookup('open-ils.storage.transaction.commit')->run;
2099             $log->info("\tProcessing of bresv ".$bresv->id." complete.");
2100
2101             push @successes,
2102                 { reservation => $bresv->id,
2103                   current_resource => ($best ? $best->id : undef) };
2104
2105         } otherwise {
2106             my $e = shift;
2107             if ($e !~ /^OK/o) {
2108                 $log->error("Processing of bresv failed:  $e");
2109                 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
2110                 throw $e if ($e =~ /IS NOT CONNECTED TO THE NETWORK/o);
2111             }
2112         };
2113     }
2114
2115     return \@successes;
2116 }
2117 __PACKAGE__->register_method(
2118     api_name    => 'open-ils.storage.booking.reservation.resource_targeter',
2119     api_level   => 1,
2120     method      => 'reservation_targeter',
2121 );
2122
2123 my $locations;
2124 my $statuses;
2125 my %cache = (titles => {}, cns => {});
2126
2127 sub copy_hold_capture {
2128     my $self = shift;
2129     my $hold = shift;
2130     my $cps = shift;
2131
2132     if (!defined($cps)) {
2133         try {
2134             $cps = [ asset::copy->search( id => $hold->target ) ];
2135         } catch Error with {
2136             my $e = shift;
2137             die "Could not retrieve initial volume list:\n\n$e\n";
2138         };
2139     }
2140
2141     my @copies = grep { $_->holdable } @$cps;
2142
2143     for (my $i = 0; $i < @$cps; $i++) {
2144         next unless $$cps[$i];
2145         
2146         my $cn = $cache{cns}{$copies[$i]->call_number};
2147         my $rec = $cache{titles}{$cn->record};
2148         $copies[$i] = undef if ($copies[$i] && !grep{ $copies[$i]->status eq $_->id}@$statuses);
2149         $copies[$i] = undef if ($copies[$i] && !grep{ $copies[$i]->location eq $_->id}@$locations);
2150         $copies[$i] = undef if (
2151             !$copies[$i] ||
2152             !$self->{user_filter}->request(
2153                 'open-ils.circ.permit_hold',
2154                 $hold->to_fieldmapper, do {
2155                     my $cp_fm = $copies[$i]->to_fieldmapper;
2156                     $cp_fm->circ_lib( $copies[$i]->circ_lib->to_fieldmapper );
2157                     $cp_fm->location( $copies[$i]->location->to_fieldmapper );
2158                     $cp_fm->status( $copies[$i]->status->to_fieldmapper );
2159                     $cp_fm;
2160                 },
2161                 { title => $rec->to_fieldmapper,
2162                   usr => actor::user->retrieve($hold->usr)->to_fieldmapper,
2163                   requestor => actor::user->retrieve($hold->requestor)->to_fieldmapper,
2164                 })->gather(1)
2165         );
2166         $self->{client}->status( new OpenSRF::DomainObject::oilsContinueStatus );
2167     }
2168
2169     @copies = grep { $_ } @copies;
2170
2171     my $count = @copies;
2172
2173     return unless ($count);
2174     
2175     action::hold_copy_map->search( hold => $hold->id )->delete_all;
2176     
2177     my @maps;
2178     $self->{client}->respond( "\tMapping ".scalar(@copies)." eligable copies for hold ".$hold->id."\n");
2179     for my $c (@copies) {
2180         push @maps, action::hold_copy_map->create( { hold => $hold->id, target_copy => $c->id } );
2181     }
2182     $self->{client}->respond( "\tA total of ".scalar(@maps)." mapping were created for hold ".$hold->id."\n");
2183
2184     return \@copies;
2185 }
2186
2187
2188 sub choose_nearest_copy {
2189     my $hold = shift;
2190     my $prox_list = shift;
2191
2192     for my $p ( sort keys %$prox_list ) {
2193         next unless (ref $$prox_list{$p});
2194
2195         my @capturable = @{ $$prox_list{$p} };
2196         next unless (@capturable);
2197
2198         my $rand = int(rand(scalar(@capturable)));
2199         my %seen = ();
2200         while (my ($c) = splice(@capturable, $rand, 1)) {
2201             return $c if !exists($seen{$c->id}) && ( OpenILS::Utils::PermitHold::permit_copy_hold(
2202                 { title => $c->call_number->record->to_fieldmapper,
2203                   title_descriptor => $c->call_number->record->record_descriptor->next->to_fieldmapper,
2204                   patron => $hold->usr->to_fieldmapper,
2205                   copy => $c->to_fieldmapper,
2206                   requestor => $hold->requestor->to_fieldmapper,
2207                   request_lib => $hold->request_lib->to_fieldmapper,
2208                   pickup_lib => $hold->pickup_lib->id,
2209                   retarget => 1
2210                 }
2211             ));
2212             $seen{$c->id}++;
2213
2214             last unless(@capturable);
2215             $rand = int(rand(scalar(@capturable)));
2216         }
2217     }
2218 }
2219
2220 sub create_prox_list {
2221     my $self = shift;
2222     my $lib = shift;
2223     my $copies = shift;
2224     my $hold = shift;
2225
2226     my $actor = OpenSRF::AppSession->create('open-ils.actor');
2227
2228     my %prox_list;
2229     for my $cp (@$copies) {
2230         my ($prox) = $self->method_lookup('open-ils.storage.asset.copy.proximity')->run( $cp, $lib, $hold );
2231         next unless (defined($prox));
2232
2233         my $copy_circ_lib = ''.$cp->circ_lib;
2234         # Fetch the weighting value for hold targeting, defaulting to 1
2235         $self->{target_weight}{$copy_circ_lib} ||= $actor->request(
2236             'open-ils.actor.ou_setting.ancestor_default' => $copy_circ_lib.'' => 'circ.holds.org_unit_target_weight'
2237         )->gather(1);
2238         $self->{target_weight}{$copy_circ_lib} = $self->{target_weight}{$copy_circ_lib}{value} if (ref $self->{target_weight}{$copy_circ_lib});
2239         $self->{target_weight}{$copy_circ_lib} ||= 1;
2240
2241         $prox_list{$prox} = [] unless defined($prox_list{$prox});
2242         for my $w ( 1 .. $self->{target_weight}{$copy_circ_lib} ) {
2243             push @{$prox_list{$prox}}, $cp;
2244         }
2245     }
2246     return \%prox_list;
2247 }
2248
2249 sub volume_hold_capture {
2250     my $self = shift;
2251     my $hold = shift;
2252     my $vols = shift;
2253
2254     if (!defined($vols)) {
2255         try {
2256             $vols = [ asset::call_number->search( id => $hold->target ) ];
2257             $cache{cns}{$_->id} = $_ for (@$vols);
2258         } catch Error with {
2259             my $e = shift;
2260             die "Could not retrieve initial volume list:\n\n$e\n";
2261         };
2262     }
2263
2264     my @v_ids = map { $_->id } @$vols;
2265
2266     my $cp_list;
2267     try {
2268         $cp_list = [ asset::copy->search( call_number => \@v_ids ) ];
2269     
2270     } catch Error with {
2271         my $e = shift;
2272         warn "Could not retrieve copy list:\n\n$e\n";
2273     };
2274
2275     $self->copy_hold_capture($hold,$cp_list) if (ref $cp_list and @$cp_list);
2276 }
2277
2278 sub title_hold_capture {
2279     my $self = shift;
2280     my $hold = shift;
2281     my $titles = shift;
2282
2283     if (!defined($titles)) {
2284         try {
2285             $titles = [ biblio::record_entry->search( id => $hold->target ) ];
2286             $cache{titles}{$_->id} = $_ for (@$titles);
2287         } catch Error with {
2288             my $e = shift;
2289             die "Could not retrieve initial title list:\n\n$e\n";
2290         };
2291     }
2292
2293     my @t_ids = map { $_->id } @$titles;
2294     my $cn_list;
2295     try {
2296         ($cn_list) = $self->method_lookup('open-ils.storage.direct.asset.call_number.search.record.atomic')->run( \@t_ids );
2297     
2298     } catch Error with {
2299         my $e = shift;
2300         warn "Could not retrieve volume list:\n\n$e\n";
2301     };
2302
2303     $cache{cns}{$_->id} = $_ for (@$cn_list);
2304
2305     $self->volume_hold_capture($hold,$cn_list) if (ref $cn_list and @$cn_list);
2306 }
2307
2308 sub metarecord_hold_capture {
2309     my $self = shift;
2310     my $hold = shift;
2311
2312     my $titles;
2313     try {
2314         $titles = [ metabib::metarecord_source_map->search( metarecord => $hold->target) ];
2315     
2316     } catch Error with {
2317         my $e = shift;
2318         die "Could not retrieve initial title list:\n\n$e\n";
2319     };
2320
2321     try {
2322         my @recs = map {$_->record} metabib::record_descriptor->search( record => $titles, item_type => [split '', $hold->holdable_formats] ); 
2323
2324         $titles = [ biblio::record_entry->search( id => \@recs ) ];
2325     
2326     } catch Error with {
2327         my $e = shift;
2328         die "Could not retrieve format-pruned title list:\n\n$e\n";
2329     };
2330
2331
2332     $cache{titles}{$_->id} = $_ for (@$titles);
2333     $self->title_hold_capture($hold,$titles) if (ref $titles and @$titles);
2334 }
2335
2336 1;