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