3c69f3302cf4bc26a8794f6bec7bb181fa40fccd
[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 OpenILS::Utils::CStoreEditor qw/:funcs/;
13 use DateTime;
14 use DateTime::Format::ISO8601;
15 use OpenILS::Utils::Penalty;
16 use OpenILS::Application::Circ::CircCommon;
17 use OpenILS::Application::AppUtils;
18 my $U = "OpenILS::Application::AppUtils";
19
20 # Used in build_hold_sort_clause().  See the hash %order_by_sprintf_args in
21 # that sub to confirm what gets used to replace the formatters, and see
22 # nearest_hold() for the main body of the SQL query that these go into.
23 my %HOLD_SORT_ORDER_BY = (
24     pprox => 'p.prox',
25     hprox => 'actor.org_unit_proximity(%d, h.pickup_lib)',  # $cp->call_number->owning_lib
26     aprox => 'COALESCE(hm.proximity, p.prox)',
27     approx => 'action.hold_copy_calculated_proximity(h.id, %d, %d)', # $cp,$here
28     priority => 'pgt.hold_priority',
29     cut => 'CASE WHEN h.cut_in_line IS TRUE THEN 0 ELSE 1 END',
30     depth => 'h.selection_depth',
31     rtime => 'h.request_time',
32     htime => q!
33         CASE WHEN
34             last_event_on_copy.place <> %d AND
35             copy_has_not_been_home.result
36         THEN actor.org_unit_proximity(%d, h.pickup_lib)
37         ELSE 999
38         END
39     !,  # $cp->call_number->owning_lib x 2
40     shtime => q!
41         CASE WHEN
42             last_event_on_copy.place <> %d AND
43             copy_has_not_been_home_even_to_idle.result
44         THEN actor.org_unit_proximity(%d, h.pickup_lib)
45         ELSE 999
46         END
47     !,  # $cp->call_number->owning_lib x 2
48 );
49
50
51 sub isTrue {
52     my $v = shift || '0';
53     return 1 if ($v == 1);
54     return 1 if ($v =~ /^t/io);
55     return 1 if ($v =~ /^y/io);
56     return 0;
57 }
58
59 sub ou_ancestor_setting_value_or_cache {
60     # cache should be specific to setting
61     my ($e, $org_id, $setting, $cache) = @_;
62
63     if (not exists $cache->{$org_id}) {
64         my $r = $U->ou_ancestor_setting(
65             $org_id, $setting, $e # undef $e is ok
66         );
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 # partition -- if set, an 'undef' will be inserted into the result list
151 # between the last circulation and the first reservation.  This is
152 # useful in conjunction with 'idlist' so the caller can tell what type 
153 # of transaction the ID refers to without having to query the DB.
154 # skip_no_fines - filter out transactions which will never be billed, 
155 # e.g. circs with a $0 max fine or $0 recurring fine.
156 sub overdue_circs {
157     my $upper_interval = shift || '1 millennium';
158     my $idlist = shift;
159     my $partition = shift;
160     my $skip_no_fines = shift;
161
162     # Only retrieve ID's in the initial query if that's all the caller needs.
163     my $contents = $idlist ? 'id' : '*';
164
165     my $fines_filter = $skip_no_fines ? 
166         'AND recurring_fine <> 0 AND max_fine <> 0' : '';
167
168     my $c_t = action::circulation->table;
169
170     my $sql = <<"    SQL";
171         SELECT  $contents
172           FROM  $c_t
173           WHERE stop_fines IS NULL
174             $fines_filter
175             AND due_date < ( CURRENT_TIMESTAMP - grace_period )
176             AND fine_interval < ?::INTERVAL
177     SQL
178
179     my $sth = action::circulation->db_Main->prepare_cached($sql);
180     $sth->execute($upper_interval);
181
182     my @circs = map { $idlist ? $_->{id} : action::circulation->construct($_) } $sth->fetchall_hash;
183
184     push (@circs, undef) if $partition;
185
186     $fines_filter = $skip_no_fines ? 
187         'AND fine_amount <> 0 AND max_fine <> 0' : '';
188
189     $c_t = booking::reservation->table;
190     $sql = <<"    SQL";
191         SELECT  $contents
192           FROM  $c_t
193           WHERE return_time IS NULL
194             $fines_filter
195             AND end_time < ( CURRENT_TIMESTAMP )
196             AND fine_interval IS NOT NULL
197             AND cancel_time IS NULL
198     SQL
199
200     $sth = action::circulation->db_Main->prepare_cached($sql);
201     $sth->execute();
202
203     push @circs, map { $idlist ? $_->{id} : booking::reservation->construct($_) } $sth->fetchall_hash;
204
205     return @circs;
206 }
207
208 sub complete_reshelving {
209     my $self = shift;
210     my $client = shift;
211     my $window = shift;
212
213     local $OpenILS::Application::Storage::WRITE = 1;
214
215     throw OpenSRF::EX::InvalidArg ("I need an interval of more than 0 seconds!")
216         unless (interval_to_seconds( $window ));
217
218     my $cp = asset::copy->table;
219
220     my $sql = <<"    SQL";
221         UPDATE  $cp
222           SET   status = 0
223           WHERE id IN (
224             SELECT cp.id 
225             FROM  $cp cp
226             WHERE cp.status = 7
227                 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)
228           )
229     SQL
230     my $sth = action::circulation->db_Main->prepare_cached($sql);
231     $sth->execute($window);
232
233     return $sth->rows;
234
235 }
236 __PACKAGE__->register_method(
237     api_name        => 'open-ils.storage.action.circulation.reshelving.complete',
238     api_level       => 1,
239     argc        => 1,
240     method          => 'complete_reshelving',
241 );
242
243 sub mark_longoverdue {
244     my $self = shift;
245     my $client = shift;
246     my $window = shift;
247
248     local $OpenILS::Application::Storage::WRITE = 1;
249
250     throw OpenSRF::EX::InvalidArg ("I need an interval of more than 0 seconds!")
251         unless (interval_to_seconds( $window ));
252
253     my $setting = actor::org_unit_setting->table;
254     my $circ = action::circulation->table;
255
256     my $sql = <<"    SQL";
257         UPDATE  $circ
258           SET   stop_fines = 'LONGOVERDUE',
259             stop_fines_time = now()
260           WHERE id IN (
261             SELECT  circ.id
262                       FROM  $circ circ
263                             LEFT JOIN $setting setting
264                                 ON (circ.circ_lib = setting.org_unit AND setting.name = 'circ.long_overdue.interval')
265                       WHERE circ.checkin_time IS NULL AND (stop_fines IS NULL OR stop_fines NOT IN ('LOST','LONGOVERDUE'))
266                             AND AGE(circ.due_date) > CAST( COALESCE( BTRIM( setting.value,'"' ), ? )  AS INTERVAL)
267                   )
268     SQL
269
270     my $sth = action::circulation->db_Main->prepare_cached($sql);
271     $sth->execute($window);
272
273     return $sth->rows;
274
275 }
276 __PACKAGE__->register_method(
277     api_name        => 'open-ils.storage.action.circulation.long_overdue',
278     api_level       => 1,
279     argc        => 1,
280     method          => 'mark_longoverdue',
281 );
282
283 sub auto_thaw_frozen_holds {
284     my $self = shift;
285     my $client = shift;
286
287     local $OpenILS::Application::Storage::WRITE = 1;
288
289     my $holds = action::hold_request->table;
290
291     my $sql = "UPDATE $holds SET frozen = FALSE WHERE frozen IS TRUE AND thaw_date < NOW();";
292
293     my $sth = action::hold_request->db_Main->prepare_cached($sql);
294     $sth->execute();
295
296     return $sth->rows;
297
298 }
299 __PACKAGE__->register_method(
300     api_name        => 'open-ils.storage.action.hold_request.thaw_expired_frozen',
301     api_level       => 1,
302     stream      => 0,
303     argc        => 0,
304     method          => 'auto_thaw_frozen_holds',
305 );
306
307 sub grab_overdue {
308     my $self = shift;
309     my $client = shift;
310
311     my $idlist = $self->api_name =~/id_list/o ? 1 : 0;
312     
313     $client->respond( $idlist ? $_ : $_->to_fieldmapper ) 
314         for ( overdue_circs('', $idlist, undef, 1) );
315
316     return undef;
317
318 }
319 __PACKAGE__->register_method(
320     api_name        => 'open-ils.storage.action.circulation.overdue',
321     api_level       => 1,
322     stream          => 1,
323     method          => 'grab_overdue',
324     signature       => q/
325         Return list of overdue circulations and reservations to be used for fine generation.
326         Despite the name, this is not a generic method for retrieving all overdue loans,
327         as it excludes loans that have already hit the maximum fine limit
328         and transactions which do not accrue fines.
329 /,
330 );
331 __PACKAGE__->register_method(
332     api_name        => 'open-ils.storage.action.circulation.overdue.id_list',
333     api_level       => 1,
334     stream      => 1,
335     method          => 'grab_overdue',
336 );
337
338 sub get_hold_sort_order {
339     my ($ou) = @_;
340
341     my $dbh = action::hold_request->db_Main;
342
343     # The purpose of this function is to return column names in a DB-configured
344     # order, so it won't do to add columns here or change column names unless
345     # you also change the expectation of anything calling this function.
346
347     my $row = $dbh->selectrow_hashref(
348         q!
349         SELECT
350             cbho.pprox, cbho.hprox, cbho.aprox, cbho.approx, cbho.priority,
351             cbho.cut, cbho.depth, cbho.htime, cbho.shtime, cbho.rtime
352         FROM config.best_hold_order cbho
353         WHERE id = (
354             SELECT oils_json_to_text(value)::INT
355             FROM actor.org_unit_ancestor_setting('circ.hold_capture_order', ?)
356         )
357         !, undef, $ou
358     ) || {
359         pprox => 1, hprox => 8, aprox => 2, priority => 3,
360         cut => 4, depth => 5, htime => 7, rtime => 6
361     };
362
363     # Return only the keys of our hash, sorted by value,
364     # keys for null values omitted.
365     return [
366         sort { $row->{$a} <=> $row->{$b} } (
367           grep { defined $row->{$_} } keys %$row
368         )
369     ];
370 }
371
372 # Returns an ORDER BY clause
373 # *and* a string with a CTE expression to precede the nearest-hold SQL query
374 # *and* a string with extra JOIN statements needed
375 sub build_hold_sort_clause {
376     my ($columns, $cp, $here) = @_;
377
378     my %order_by_sprintf_args = (
379         hprox => [$cp->call_number->owning_lib],
380         approx => [$cp->id, $here],
381         htime => [$cp->call_number->owning_lib, $cp->call_number->owning_lib],
382         shtime => [$cp->call_number->owning_lib, $cp->call_number->owning_lib]
383     );
384
385     my @clauses;
386     my $ctes_needed = 0;
387     foreach my $col (@$columns) {
388         if ($col eq 'htime' and not $ctes_needed) {
389             $ctes_needed = 1;
390         } elsif ($col eq 'shtime') {
391             $ctes_needed = 2;
392         }
393
394         my @args;
395         @args = @{$order_by_sprintf_args{$col}} if
396             exists $order_by_sprintf_args{$col};
397
398         push @clauses, sprintf($HOLD_SORT_ORDER_BY{$col}, @args);
399
400         last if $col eq 'rtime';    # rtime is effectively unique, no need for
401                                     # more order-by clauses after that.
402     }
403
404     my ($ctes, $joins) = ("", "");
405     if ($ctes_needed >= 1) {
406         # Each CTE serves the next. The first is one version or another
407         # of last_event_on_copy, which is described in holds-go-home.txt
408         # TechRef, but it essentially returns place and time of the most
409         # recent transit or circ to do with a copy, and failing that it
410         # returns a synthetic event that means "here" and "now".
411
412         if ($ctes_needed == 2) {
413             $ctes .= sprintf(q!
414 , last_event_on_copy AS (    -- combined circ and transit version
415     SELECT *
416     FROM (
417         (   SELECT
418                 TRUE AS concrete,
419                 dest AS place,
420                 COALESCE(dest_recv_time, source_send_time) AS moment
421             FROM action.transit_copy
422             WHERE target_copy = %d
423             AND cancel_time IS NULL
424             ORDER BY moment DESC LIMIT 1
425         ) UNION (
426             SELECT
427                 TRUE AS concrete,
428                 COALESCE(checkin_lib, circ_lib) AS place,
429                 COALESCE(checkin_time, xact_start) AS moment
430             FROM action.circulation
431             WHERE target_copy = %d
432             ORDER BY moment DESC LIMIT 1
433         ) UNION
434             SELECT
435                 FALSE AS concrete,
436                 %d AS place,
437                 NOW() AS moment
438     ) x ORDER BY concrete DESC, moment DESC LIMIT 1
439 ) !, $cp->id, $cp->id, $cp->call_number->owning_lib);
440         } else {
441             $ctes .= sprintf(q!
442 , last_event_on_copy AS (   -- circ only version
443     SELECT * FROM (
444         ( SELECT
445                 TRUE AS concrete,
446                 COALESCE(checkin_lib, circ_lib) AS place,
447                 COALESCE(checkin_time, xact_start) AS moment
448             FROM action.circulation
449             WHERE target_copy = %d
450             ORDER BY moment DESC LIMIT 1
451         ) UNION SELECT
452                 FALSE AS concrete,
453                 %d AS place,
454                 NOW() AS moment
455     ) x ORDER BY concrete DESC, moment DESC LIMIT 1
456 ) !, $cp->id, $cp->call_number->owning_lib);
457         }
458
459         $joins .= q!
460             JOIN last_event_on_copy ON (true)
461         !;
462
463         # For our next auxiliary query, the question we seek to answer is,
464         # "has our copy been circulating away from home too long?"
465         #
466         # Have there been no checkouts at the copy's circ_lib since the
467         # beginning of our go-home interval?
468
469         # [We use sprintf because the outer function that's going to send one
470         # big query through DBI is blind to our process of dynamically building
471         # these CTEs, and it wouldn't know what bind parameters to pass unless
472         # we did a lot more work here. This is injection-safe because we only
473         # use the %d formatter.]
474         $ctes .= sprintf(q!
475 , copy_has_not_been_home AS (
476     SELECT (
477         -- part 1
478         SELECT MIN(circ.id) FROM action.circulation circ
479         JOIN go_home_interval ON (true)
480         WHERE
481             circ.target_copy = %d AND
482             circ.circ_lib = %d AND
483             circ.xact_start >= NOW() - go_home_interval.value
484     ) IS NULL AS result
485 ) !, $cp->id, $cp->circ_lib);
486
487         $joins .= q!
488             JOIN copy_has_not_been_home ON (true)
489         !;
490     }
491
492     if ($ctes_needed == 2) {
493         # By this query, we mean to determine that the copy hasn't landed at
494         # home by means of transit during the go-home interval (in addition
495         # to not having circulated from home in the same time frame).
496         #
497         # There have been no homebound transits that arrived for this copy
498         # since the beginning of the go-home interval.
499
500         $ctes .= sprintf(q!
501 , copy_has_not_been_home_even_to_idle AS (
502     SELECT result AND NOT (
503         SELECT COUNT(*)::INT::BOOL
504         FROM action.transit_copy atc
505         WHERE
506             atc.target_copy = %d AND
507             (atc.dest = %d OR atc.source = %d) AND
508             atc.dest_recv_time >= NOW() - (SELECT value FROM go_home_interval) AND
509             atc.cancel_time IS NULL
510     ) AS result FROM copy_has_not_been_home
511 ) !, $cp->id, $cp->circ_lib, $cp->circ_lib);
512         $joins .= " JOIN copy_has_not_been_home_even_to_idle ON (true) ";
513     }
514
515     return (
516         join(", ", @clauses),
517         $ctes,
518         $joins
519     );
520 }
521
522 sub nearest_hold {
523     my $self = shift;
524     my $client = shift;
525     my $here = shift;   # just the ID
526     my $cp = shift;     # now an object with call_number fleshed,
527                         # formerly just copy ID
528     my $limit = int(shift()) || 10;
529     my $age = shift() || '0 seconds';
530     my $fifo = shift();
531
532     $log->info("deprecated 'fifo' param true, but ignored") if isTrue($fifo);
533
534     # ScriptBuilder fleshes the circ_lib, which confuses things; ensure we
535     # are working with a circ lib ID and not an object
536     my $cp_circ_lib;
537     if (ref $cp->circ_lib) {
538         $cp_circ_lib = $cp->circ_lib->id;
539     } else {
540         $cp_circ_lib = $cp->circ_lib;
541     }
542
543     my $cp_owning_lib;
544     if (ref $cp->call_number->owning_lib) {
545         $cp_owning_lib = $cp->call_number->owning_lib->id;
546     } else {
547         $cp_owning_lib = $cp->call_number->owning_lib;
548     }
549
550     my ($holdsort, $addl_cte, $addl_join) =
551         build_hold_sort_clause(get_hold_sort_order($cp_owning_lib), $cp, $here);
552
553     local $OpenILS::Application::Storage::WRITE = 1;
554
555     my $ids = action::hold_request->db_Main->selectcol_arrayref(<<"    SQL", {}, $cp_circ_lib, $here, $cp->id, $age);
556         WITH go_home_interval AS (
557             SELECT OILS_JSON_TO_TEXT(
558                 (SELECT value FROM actor.org_unit_ancestor_setting(
559                     'circ.hold_go_home_interval', ?
560                 )
561             ))::INTERVAL AS value
562         )
563         $addl_cte
564         SELECT  h.id
565           FROM  action.hold_request h
566             JOIN actor.org_unit_proximity p ON (p.from_org = ? AND p.to_org = h.pickup_lib)
567             JOIN action.hold_copy_map hm ON (hm.hold = h.id)
568             JOIN actor.usr au ON (au.id = h.usr)
569             JOIN permission.grp_tree pgt ON (au.profile = pgt.id)
570             LEFT JOIN actor.usr_standing_penalty ausp
571                 ON ( au.id = ausp.usr AND ( ausp.stop_date IS NULL OR ausp.stop_date > NOW() ) )
572             LEFT JOIN config.standing_penalty csp
573                 ON ( csp.id = ausp.standing_penalty AND csp.block_list LIKE '%CAPTURE%' )
574             $addl_join
575           WHERE hm.target_copy = ?
576             AND (AGE(NOW(),h.request_time) >= CAST(? AS INTERVAL) OR hm.proximity = 0 OR p.prox = 0)
577             AND h.capture_time IS NULL
578             AND h.cancel_time IS NULL
579             AND (h.expire_time IS NULL OR h.expire_time > NOW())
580             AND h.frozen IS FALSE
581             AND csp.id IS NULL
582         ORDER BY CASE WHEN h.hold_type IN ('R','F') THEN 0 ELSE 1 END, $holdsort
583         LIMIT $limit
584     SQL
585     
586     $client->respond( $_ ) for ( @$ids );
587     return undef;
588 }
589 __PACKAGE__->register_method(
590     api_name    => 'open-ils.storage.action.hold_request.nearest_hold',
591     api_level   => 1,
592     stream      => 1,
593     method      => 'nearest_hold',
594 );
595
596 sub targetable_holds {
597     my $self = shift;
598     my $client = shift;
599     my $check_expire = shift;
600
601     $check_expire ||= '12h';
602
603     local $OpenILS::Application::Storage::WRITE = 1;
604
605     # json_query can *almost* represent this query, but can't
606     # handle the CASE statement or the interval arithmetic
607     my $query = <<"    SQL";
608         SELECT ahr.id, mmsm.metarecord
609         FROM action.hold_request ahr
610         JOIN reporter.hold_request_record USING (id)
611         JOIN metabib.metarecord_source_map mmsm ON (bib_record = source)
612         WHERE capture_time IS NULL
613         AND (prev_check_time IS NULL or prev_check_time < (NOW() - ?::interval))
614         AND fulfillment_time IS NULL
615         AND cancel_time IS NULL
616         AND NOT frozen
617         ORDER BY CASE WHEN ahr.hold_type = 'F' THEN 0 ELSE 1 END, selection_depth DESC, request_time;
618     SQL
619     my $sth = action::hold_request->db_Main->prepare_cached($query);
620     $sth->execute($check_expire);
621     $client->respond( $_ ) for @{ $sth->fetchall_arrayref };
622
623     return undef;
624 }
625
626 __PACKAGE__->register_method(
627     api_name    => 'open-ils.storage.action.hold_request.targetable_holds.id_list',
628     api_level   => 1,
629     stream      => 1,
630     method      => 'targetable_holds',
631     signature   => q/
632         Returns ordered list of hold request and metarecord IDs
633         for all hold requests that are available for initial targeting
634         or retargeting.
635         @param check interval
636         @return list of pairs of hold request and metarecord IDs
637 /,
638 );
639
640 sub next_resp_group_id {
641     my $self = shift;
642     my $client = shift;
643
644     # XXX This is not replication safe!!!
645
646     my ($id) = action::survey->db_Main->selectrow_array(<<"    SQL");
647         SELECT NEXTVAL('action.survey_response_group_id_seq'::TEXT)
648     SQL
649     return $id;
650 }
651 __PACKAGE__->register_method(
652     api_name        => 'open-ils.storage.action.survey_response.next_group_id',
653     api_level       => 1,
654     method          => 'next_resp_group_id',
655 );
656
657 sub patron_circ_summary {
658     my $self = shift;
659     my $client = shift;
660     my $id = ''.shift();
661
662     return undef unless ($id);
663     my $c_table = action::circulation->table;
664     my $b_table = money::billing->table;
665
666     $log->debug("Retrieving patron summary for id $id", DEBUG);
667
668     my $select = <<"    SQL";
669         SELECT  COUNT(DISTINCT c.id), SUM( COALESCE(b.amount,0) )
670           FROM  $c_table c
671             LEFT OUTER JOIN $b_table b ON (c.id = b.xact AND b.voided = FALSE)
672           WHERE c.usr = ?
673             AND c.xact_finish IS NULL
674             AND (
675                 c.stop_fines NOT IN ('CLAIMSRETURNED','LOST')
676                 OR c.stop_fines IS NULL
677             )
678     SQL
679
680     return action::survey->db_Main->selectrow_arrayref($select, {}, $id);
681 }
682 __PACKAGE__->register_method(
683     api_name        => 'open-ils.storage.action.circulation.patron_summary',
684     api_level       => 1,
685     method          => 'patron_circ_summary',
686 );
687
688 #XXX Fix stored proc calls
689 sub find_local_surveys {
690     my $self = shift;
691     my $client = shift;
692     my $ou = ''.shift();
693
694     return undef unless ($ou);
695     my $s_table = action::survey->table;
696
697     my $select = <<"    SQL";
698         SELECT  s.*
699           FROM  $s_table s
700             JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
701           WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
702     SQL
703
704     my $sth = action::survey->db_Main->prepare_cached($select);
705     $sth->execute($ou);
706
707     $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
708
709     return undef;
710 }
711 __PACKAGE__->register_method(
712     api_name        => 'open-ils.storage.action.survey.all',
713     api_level       => 1,
714     stream          => 1,
715     method          => 'find_local_surveys',
716 );
717
718 #XXX Fix stored proc calls
719 sub find_opac_surveys {
720     my $self = shift;
721     my $client = shift;
722     my $ou = ''.shift();
723
724     return undef unless ($ou);
725     my $s_table = action::survey->table;
726
727     my $select = <<"    SQL";
728         SELECT  s.*
729           FROM  $s_table s
730             JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
731           WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
732             AND s.opac IS TRUE;
733     SQL
734
735     my $sth = action::survey->db_Main->prepare_cached($select);
736     $sth->execute($ou);
737
738     $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
739
740     return undef;
741 }
742 __PACKAGE__->register_method(
743     api_name        => 'open-ils.storage.action.survey.opac',
744     api_level       => 1,
745     stream          => 1,
746     method          => 'find_opac_surveys',
747 );
748
749 sub hold_pull_list {
750     my $self = shift;
751     my $client = shift;
752     my $ou = shift;
753     my $limit = shift || 10;
754     my $offset = shift || 0;
755
756     return undef unless ($ou);
757     my $h_table = action::hold_request->table;
758     my $a_table = asset::copy->table;
759     my $ord_table = asset::copy_location_order->table;
760
761     my $idlist = 1 if ($self->api_name =~/id_list/o);
762     my $count = 1 if ($self->api_name =~/count$/o);
763
764     my $status_filter = '';
765     $status_filter = 'AND a.status IN (0,7)' if ($self->api_name =~/status_filtered/o);
766
767     my $select = <<"    SQL";
768         SELECT  h.*
769           FROM  $h_table h
770             JOIN $a_table a ON (h.current_copy = a.id)
771             LEFT JOIN $ord_table ord ON (a.location = ord.location AND a.circ_lib = ord.org)
772           WHERE a.circ_lib = ?
773             AND h.capture_time IS NULL
774             AND h.cancel_time IS NULL
775             AND (h.expire_time IS NULL OR h.expire_time > NOW())
776             AND NOT EXISTS (
777                 SELECT  1
778                   FROM  actor.usr_standing_penalty ausp
779                         JOIN config.standing_penalty csp ON (
780                             csp.id = ausp.standing_penalty
781                             AND csp.block_list LIKE '%CAPTURE%'
782                         )
783                   WHERE h.usr = ausp.usr
784                         AND ( ausp.stop_date IS NULL OR ausp.stop_date > NOW() )
785             )
786             $status_filter
787           ORDER BY CASE WHEN ord.position IS NOT NULL THEN ord.position ELSE 999 END, h.request_time
788           LIMIT $limit
789           OFFSET $offset
790     SQL
791
792     if ($count) {
793         $select = <<"        SQL";
794             SELECT    count(DISTINCT h.id)
795               FROM    $h_table h
796                   JOIN $a_table a ON (h.current_copy = a.id)
797               WHERE    a.circ_lib = ?
798                   AND h.capture_time IS NULL
799                   AND h.cancel_time IS NULL
800                   AND (h.expire_time IS NULL OR h.expire_time > NOW())
801                   AND NOT EXISTS (
802                     SELECT  1
803                       FROM  actor.usr_standing_penalty ausp
804                             JOIN config.standing_penalty csp ON (
805                                 csp.id = ausp.standing_penalty
806                                 AND csp.block_list LIKE '%CAPTURE%'
807                             )
808                       WHERE h.usr = ausp.usr
809                             AND ( ausp.stop_date IS NULL OR ausp.stop_date > NOW() )
810                 )
811                 $status_filter
812         SQL
813     }
814
815     my $sth = action::survey->db_Main->prepare_cached($select);
816     $sth->execute($ou);
817
818     if ($count) {
819         $client->respond( $sth->fetchall_arrayref()->[0][0] );
820     } elsif ($idlist) {
821         $client->respond( $_->{id} ) for ( $sth->fetchall_hash );
822     } else {
823         $client->respond( $_->to_fieldmapper ) for ( map { action::hold_request->construct($_) } $sth->fetchall_hash );
824     }
825
826     return undef;
827 }
828 __PACKAGE__->register_method(
829     api_name        => 'open-ils.storage.direct.action.hold_request.pull_list.current_copy_circ_lib.count',
830     api_level       => 1,
831     stream          => 1,
832     signature   => [
833         "Returns a count of holds for a specific library's pull list.",
834         [ [org_unit => "The library's org id", "number"] ],
835         ['A count of holds for the stated library to pull ', 'number']
836     ],
837     method          => 'hold_pull_list',
838 );
839 __PACKAGE__->register_method(
840     api_name        => 'open-ils.storage.direct.action.hold_request.pull_list.current_copy_circ_lib.status_filtered.count',
841     api_level       => 1,
842     stream          => 1,
843     signature   => [
844         "Returns a status filtered count of holds for a specific library's pull list.",
845         [ [org_unit => "The library's org id", "number"] ],
846         ['A status filtered count of holds for the stated library to pull ', 'number']
847     ],
848     method          => 'hold_pull_list',
849 );
850 __PACKAGE__->register_method(
851     api_name        => 'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib',
852     api_level       => 1,
853     stream          => 1,
854     signature   => [
855         "Returns the hold ids for a specific library's pull list.",
856         [ [org_unit => "The library's org id", "number"],
857           [limit => 'An optional page size, defaults to 10', 'number'],
858           [offset => 'Offset for paging, defaults to 0, 0 based', 'number'],
859         ],
860         ['A list of holds for the stated library to pull for', 'array']
861     ],
862     method          => 'hold_pull_list',
863 );
864 __PACKAGE__->register_method(
865     api_name        => 'open-ils.storage.direct.action.hold_request.pull_list.search.current_copy_circ_lib',
866     api_level       => 1,
867     stream          => 1,
868     signature   => [
869         "Returns the holds for a specific library's pull list.",
870         [ [org_unit => "The library's org id", "number"],
871           [limit => 'An optional page size, defaults to 10', 'number'],
872           [offset => 'Offset for paging, defaults to 0, 0 based', 'number'],
873         ],
874         ['A list of holds for the stated library to pull for', 'array']
875     ],
876     method          => 'hold_pull_list',
877 );
878 __PACKAGE__->register_method(
879     api_name        => 'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib.status_filtered',
880     api_level       => 1,
881     stream          => 1,
882     signature   => [
883         "Returns the hold ids for a specific library's pull list that are definitely in that library, based on status.",
884         [ [org_unit => "The library's org id", "number"],
885           [limit => 'An optional page size, defaults to 10', 'number'],
886           [offset => 'Offset for paging, defaults to 0, 0 based', 'number'],
887         ],
888         ['A list of holds for the stated library to pull for', 'array']
889     ],
890     method          => 'hold_pull_list',
891 );
892 __PACKAGE__->register_method(
893     api_name        => 'open-ils.storage.direct.action.hold_request.pull_list.search.current_copy_circ_lib.status_filtered',
894     api_level       => 1,
895     stream          => 1,
896     signature   => [
897         "Returns the holds for a specific library's pull list that are definitely in that library, based on status.",
898         [ [org_unit => "The library's org id", "number"],
899           [limit => 'An optional page size, defaults to 10', 'number'],
900           [offset => 'Offset for paging, defaults to 0, 0 based', 'number'],
901         ],
902         ['A list of holds for the stated library to pull for', 'array']
903     ],
904     method          => 'hold_pull_list',
905 );
906
907 sub find_optional_surveys {
908     my $self = shift;
909     my $client = shift;
910     my $ou = ''.shift();
911
912     return undef unless ($ou);
913     my $s_table = action::survey->table;
914
915     my $select = <<"    SQL";
916         SELECT  s.*
917           FROM  $s_table s
918             JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
919           WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
920             AND s.required IS FALSE;
921     SQL
922
923     my $sth = action::survey->db_Main->prepare_cached($select);
924     $sth->execute($ou);
925
926     $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
927
928     return undef;
929 }
930 __PACKAGE__->register_method(
931     api_name        => 'open-ils.storage.action.survey.optional',
932     api_level       => 1,
933     stream          => 1,
934     method          => 'find_optional_surveys',
935 );
936
937 sub find_required_surveys {
938     my $self = shift;
939     my $client = shift;
940     my $ou = ''.shift();
941
942     return undef unless ($ou);
943     my $s_table = action::survey->table;
944
945     my $select = <<"    SQL";
946         SELECT  s.*
947           FROM  $s_table s
948             JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
949           WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
950             AND s.required IS TRUE;
951     SQL
952
953     my $sth = action::survey->db_Main->prepare_cached($select);
954     $sth->execute($ou);
955
956     $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
957
958     return undef;
959 }
960 __PACKAGE__->register_method(
961     api_name        => 'open-ils.storage.action.survey.required',
962     api_level       => 1,
963     stream          => 1,
964     method          => 'find_required_surveys',
965 );
966
967 sub find_usr_summary_surveys {
968     my $self = shift;
969     my $client = shift;
970     my $ou = ''.shift();
971
972     return undef unless ($ou);
973     my $s_table = action::survey->table;
974
975     my $select = <<"    SQL";
976         SELECT  s.*
977           FROM  $s_table s
978             JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
979           WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
980             AND s.usr_summary IS TRUE;
981     SQL
982
983     my $sth = action::survey->db_Main->prepare_cached($select);
984     $sth->execute($ou);
985
986     $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
987
988     return undef;
989 }
990 __PACKAGE__->register_method(
991     api_name        => 'open-ils.storage.action.survey.usr_summary',
992     api_level       => 1,
993     stream          => 1,
994     method          => 'find_usr_summary_surveys',
995 );
996
997 sub generate_fines {
998     my $self = shift;
999     my $client = shift;
1000     my $circ_id = shift;
1001
1002     my $circs;
1003     my $editor = new_editor;
1004     if ($circ_id) {
1005 #        my $circ;
1006 #        if ($circ = action::circulation->search_where( { id => $circ_id, stop_fines => undef } )) {
1007 #            $circ = action::circulation->retrieve($circ_id)->to_fieldmapper;
1008 #        } elsif ($circ = booking::reservation->search_where( { id => $circ_id, return_time => undef, cancel_time => undef } )) {
1009 #            $circ = booking::reservation->retrieve($circ_id)->to_fieldmapper;
1010 #        }
1011 #        $circs = [$circ] if ($circ);
1012         $circs = $editor->search_action_circulation( { id => $circ_id, stop_fines => undef } );
1013         unless (@$circs) {
1014             $circs = $editor->search_booking_reservation->search_where( { id => $circ_id, return_time => undef, cancel_time => undef } );
1015         }
1016     } else {
1017         $circs = [overdue_circs(undef, 1, 1, 1)];
1018     }
1019
1020     return OpenILS::Application::Circ::CircCommon->generate_fines({circs => $circs, conn => $client})
1021 }
1022 __PACKAGE__->register_method(
1023     api_name        => 'open-ils.storage.action.circulation.overdue.generate_fines',
1024     api_level       => 1,
1025     stream      => 1,
1026     method          => 'generate_fines',
1027 );
1028
1029
1030 sub MR_records_matching_format {
1031     my $self = shift;
1032     my $client = shift;
1033     my $MR = shift;
1034     my $filter = shift;
1035     my $org = shift;
1036     # include all visible copies, regardless of holdability
1037     my $opac_visible = shift;
1038
1039     # find filters for MR holds
1040     my $mr_filter;
1041     if (defined($filter)) {
1042         ($mr_filter) = @{action::hold_request->db_Main->selectcol_arrayref(
1043             'SELECT metabib.compile_composite_attr(?)',
1044             {},
1045             $filter
1046         )};
1047     }
1048
1049     my $records = [metabib::metarecord->retrieve($MR)->source_records];
1050
1051     my $vis_q = 'asset.record_has_holdable_copy(?,?)';
1052     if ($opac_visible) {
1053         $vis_q = <<'        SQL';
1054             EXISTS(
1055                 SELECT  1
1056                   FROM  asset.patron_default_visibility_mask() mask,
1057                         asset.copy_vis_attr_cache v
1058                         JOIN asset.copy c ON (
1059                             c.id = v.target_copy
1060                             AND v.record = ?
1061                             AND c.circ_lib IN (
1062                                 SELECT id FROM actor.org_unit_descendants(?)
1063                             )
1064                         )
1065                   WHERE v.vis_attr_vector @@ mask.c_attrs::query_int
1066             )
1067         SQL
1068     }
1069
1070     my $q = "SELECT source FROM metabib.record_attr_vector_list WHERE source = ? AND vlist @@ ? AND $vis_q";
1071     my @args = ( $mr_filter, $org );
1072     if (!$mr_filter) {
1073         $q = "SELECT true WHERE $vis_q";
1074         @args = ( $org );
1075     }
1076
1077     for my $r ( map { isTrue($_->deleted) ?  () : ($_->id) } @$records ) {
1078         # the map{} below is tricky. it puts the record ID in front of each param. see $q above
1079         $client->respond($r)
1080             if @{action::hold_request->db_Main->selectcol_arrayref( $q, {}, map { ( $r => $_ ) } @args )};
1081     }
1082
1083     return; # discard final l-val
1084 }
1085 __PACKAGE__->register_method(
1086     api_name        => 'open-ils.storage.metarecord.filtered_records',
1087     api_level       => 1,
1088     stream          => 1,
1089     argc            => 2,
1090     method          => 'MR_records_matching_format',
1091 );
1092
1093
1094 sub new_hold_copy_targeter {
1095     my $self = shift;
1096     my $client = shift;
1097     my $check_expire = shift;
1098     my $one_hold = shift;
1099     my $find_copy = shift;
1100
1101     local $OpenILS::Application::Storage::WRITE = 1;
1102
1103     $self->{target_weight} = {};
1104     $self->{max_loops} = {};
1105
1106     my $holds;
1107
1108     try {
1109         if ($one_hold) {
1110             $self->method_lookup('open-ils.storage.transaction.begin')->run();
1111             $holds = [ action::hold_request->search_where( { id => $one_hold, fulfillment_time => undef, cancel_time => undef, frozen => 'f' } ) ];
1112         } elsif ( $check_expire ) {
1113
1114             # what's the retarget time threashold?
1115             my $time = time;
1116             $check_expire ||= '12h';
1117             $check_expire = interval_to_seconds( $check_expire );
1118
1119             my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = gmtime(time() - $check_expire);
1120             $year += 1900;
1121             $mon += 1;
1122             my $expire_threshold = sprintf(
1123                 '%s-%0.2d-%0.2dT%0.2d:%0.2d:%0.2d-00',
1124                 $year, $mon, $mday, $hour, $min, $sec
1125             );
1126
1127             # find all the holds holds needing retargeting
1128             $holds = [ action::hold_request->search_where(
1129                             { capture_time => undef,
1130                               fulfillment_time => undef,
1131                               cancel_time => undef,
1132                               frozen => 'f',
1133                               prev_check_time => { '<=' => $expire_threshold },
1134                             },
1135                             { order_by => 'selection_depth DESC, request_time,prev_check_time' } ) ];
1136
1137             # find all the holds holds needing first time targeting
1138             push @$holds, action::hold_request->search(
1139                             capture_time => undef,
1140                             fulfillment_time => undef,
1141                             prev_check_time => undef,
1142                             frozen => 'f',
1143                             cancel_time => undef,
1144                             { order_by => 'selection_depth DESC, request_time' } );
1145         } else {
1146
1147             # find all the holds holds needing first time targeting ONLY
1148             $holds = [ action::hold_request->search(
1149                             capture_time => undef,
1150                             fulfillment_time => undef,
1151                             prev_check_time => undef,
1152                             cancel_time => undef,
1153                             frozen => 'f',
1154                             { order_by => 'selection_depth DESC, request_time' } ) ];
1155         }
1156     } catch Error with {
1157         my $e = shift;
1158         die "Could not retrieve uncaptured hold requests:\n\n$e\n";
1159     };
1160
1161     my @closed = actor::org_unit::closed_date->search_where(
1162         { close_start => { '<=', 'now' },
1163           close_end => { '>=', 'now' } }
1164     );
1165
1166     if ($check_expire) {
1167
1168         # $check_expire, if it exists, was already converted to seconds
1169         my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = gmtime(time() + $check_expire);
1170         $year += 1900;
1171         $mon += 1;
1172
1173         my $next_check_time = sprintf(
1174             '%s-%0.2d-%0.2dT%0.2d:%0.2d:%0.2d-00',
1175             $year, $mon, $mday, $hour, $min, $sec
1176         );
1177
1178
1179         my @closed_at_next = actor::org_unit::closed_date->search_where(
1180             { close_start => { '<=', $next_check_time },
1181               close_end => { '>=', $next_check_time } }
1182         );
1183
1184         my @new_closed;
1185         for my $c_at_n (@closed_at_next) {
1186             if (grep { ''.$_->org_unit eq ''.$c_at_n->org_unit } @closed) {
1187                 push @new_closed, $c_at_n;
1188             }
1189         }
1190         @closed = @new_closed;
1191     }
1192
1193     my @successes;
1194     my $actor = OpenSRF::AppSession->create('open-ils.actor');
1195     my $editor = new_editor;
1196
1197     my $target_when_closed = {};
1198     my $target_when_closed_if_at_pickup_lib = {};
1199
1200     for my $hold (@$holds) {
1201         try {
1202             #start a transaction if needed
1203             if ($self->method_lookup('open-ils.storage.transaction.current')->run) {
1204                 $log->debug("Cleaning up after previous transaction\n");
1205                 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
1206             }
1207             $self->method_lookup('open-ils.storage.transaction.begin')->run();
1208             $log->info("Processing hold ".$hold->id."...\n");
1209
1210             #first, re-fetch the hold, to make sure it's not captured already
1211             $hold->remove_from_object_index();
1212             $hold = action::hold_request->retrieve( $hold->id );
1213
1214             die "OK\n" if (!$hold or $hold->capture_time or $hold->cancel_time);
1215
1216             # remove old auto-targeting maps
1217             my @oldmaps = action::hold_copy_map->search( hold => $hold->id );
1218             $_->delete for (@oldmaps);
1219
1220             if ($hold->expire_time) {
1221                 my $ex_time = $parser->parse_datetime( cleanse_ISO8601( $hold->expire_time ) );
1222                 if ( DateTime->compare($ex_time, DateTime->now) < 0 ) {
1223
1224                     # cancel cause = un-targeted expiration
1225                     $hold->update( { cancel_time => 'now', cancel_cause => 1 } ); 
1226
1227                     # refresh fields from the DB while still in the xact
1228                     my $fm_hold = $hold->to_fieldmapper; 
1229
1230                     $self->method_lookup('open-ils.storage.transaction.commit')->run;
1231
1232                     # tell A/T the hold was cancelled
1233                     my $ses = OpenSRF::AppSession->create('open-ils.trigger');
1234                     $ses->request('open-ils.trigger.event.autocreate', 
1235                         'hold_request.cancel.expire_no_target', $fm_hold, $fm_hold->pickup_lib);
1236
1237                     die "OK\n";
1238                 }
1239             }
1240
1241             my $all_copies = [];
1242
1243             # find all the potential copies
1244             if ($hold->hold_type eq 'M') {
1245                 for my $r_id (
1246                     $self->method_lookup(
1247                         'open-ils.storage.metarecord.filtered_records'
1248                     )->run( $hold->target, $hold->holdable_formats )
1249                 ) {
1250                     my ($rtree) = $self
1251                         ->method_lookup( 'open-ils.storage.biblio.record_entry.ranged_tree')
1252                         ->run( $r_id, $hold->selection_ou, $hold->selection_depth );
1253
1254                     for my $cn ( @{ $rtree->call_numbers } ) {
1255                         push @$all_copies,
1256                             asset::copy->search_where(
1257                                 { id => [map {$_->id} @{ $cn->copies }],
1258                                   deleted => 'f' }
1259                             ) if ($cn && @{ $cn->copies });
1260                     }
1261                 }
1262             } elsif ($hold->hold_type eq 'T') {
1263                 my ($rtree) = $self
1264                     ->method_lookup( 'open-ils.storage.biblio.record_entry.ranged_tree')
1265                     ->run( $hold->target, $hold->selection_ou, $hold->selection_depth );
1266
1267                 unless ($rtree) {
1268                     push @successes, { hold => $hold->id, eligible_copies => 0, error => 'NO_RECORD' };
1269                     die "OK\n";
1270                 }
1271
1272                 for my $cn ( @{ $rtree->call_numbers } ) {
1273                     push @$all_copies,
1274                         asset::copy->search_where(
1275                             { id => [map {$_->id} @{ $cn->copies }],
1276                               deleted => 'f' }
1277                         ) if ($cn && @{ $cn->copies });
1278                 }
1279             } elsif ($hold->hold_type eq 'V') {
1280                 my ($vtree) = $self
1281                     ->method_lookup( 'open-ils.storage.asset.call_number.ranged_tree')
1282                     ->run( $hold->target, $hold->selection_ou, $hold->selection_depth );
1283
1284                 push @$all_copies,
1285                     asset::copy->search_where(
1286                         { id => [map {$_->id} @{ $vtree->copies }],
1287                           deleted => 'f' }
1288                     ) if ($vtree && @{ $vtree->copies });
1289
1290             } elsif ($hold->hold_type eq 'P') {
1291                 my @part_maps = asset::copy_part_map->search_where( { part => $hold->target } );
1292                 $all_copies = [
1293                     asset::copy->search_where(
1294                         { id => [map {$_->target_copy} @part_maps],
1295                           deleted => 'f' }
1296                     )
1297                 ] if (@part_maps);
1298                     
1299             } elsif ($hold->hold_type eq 'I') {
1300                 my ($itree) = $self
1301                     ->method_lookup( 'open-ils.storage.serial.issuance.ranged_tree')
1302                     ->run( $hold->target, $hold->selection_ou, $hold->selection_depth );
1303
1304                 push @$all_copies,
1305                     asset::copy->search_where(
1306                         { id => [map {$_->unit->id} @{ $itree->items }],
1307                           deleted => 'f' }
1308                     ) if ($itree && @{ $itree->items });
1309                     
1310             } elsif  ($hold->hold_type eq 'C' || $hold->hold_type eq 'R' || $hold->hold_type eq 'F') {
1311                 my $_cp = asset::copy->retrieve($hold->target);
1312                 push @$all_copies, $_cp if $_cp;
1313             }
1314
1315             # Force and recall holds bypass pretty much everything
1316             if ($hold->hold_type ne 'R' && $hold->hold_type ne 'F') {
1317                 # trim unholdables
1318                 @$all_copies = grep {   isTrue($_->status->holdable) && 
1319                             isTrue($_->location->holdable) && 
1320                             isTrue($_->holdable) &&
1321                             !isTrue($_->deleted) &&
1322                             (isTrue($hold->mint_condition) ? isTrue($_->mint_condition) : 1) &&
1323                             ( ( $hold->hold_type ne 'C' && $hold->hold_type ne 'I' # Copy-level holds don't care about parts
1324                                 && $hold->hold_type ne 'P' ) ? $_->part_maps->count == 0 : 1)
1325                         } @$all_copies;
1326             }
1327
1328             # let 'em know we're still working
1329             $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
1330             
1331             # if we have no copies ...
1332             if (!ref $all_copies || !@$all_copies) {
1333                 $log->info("\tNo copies available for targeting at all!\n");
1334                 push @successes, { hold => $hold->id, eligible_copies => 0, error => 'NO_COPIES' };
1335
1336                 $hold->update( { prev_check_time => 'today', current_copy => undef } );
1337                 $self->method_lookup('open-ils.storage.transaction.commit')->run;
1338                 die "OK\n";
1339             }
1340
1341             my $copy_count = @$all_copies;
1342             my $found_copy = undef;
1343             $found_copy = 1 if($find_copy and grep $_ == $find_copy, @$all_copies);
1344
1345             # map the potentials, so that we can pick up checkins
1346             my $hold_copy_map = {};
1347             $hold_copy_map->{$_->hold}->{$_->target_copy} = $_->proximity
1348                 for (
1349                     map {
1350                         action::hold_copy_map->create( { hold => $hold->id, target_copy => $_->id } )
1351                     } @$all_copies
1352                 );
1353
1354             my $pu_lib = ''.$hold->pickup_lib;
1355             my $prox_list = create_prox_list( $self, $pu_lib, $all_copies, $hold, $hold_copy_map );
1356             $log->debug( "\tMapping ".scalar(@$all_copies)." potential copies for hold ".$hold->id);
1357
1358             #$client->status( new OpenSRF::DomainObject::oilsContinueStatus );
1359
1360             my @good_copies;
1361             for my $c (@$all_copies) {
1362                 # current target
1363                 next if ($hold->current_copy and $c->id eq $hold->current_copy);
1364
1365                 # skip on circ lib is closed IFF we care
1366                 my $ignore_closing;
1367
1368                 if (''.$hold->pickup_lib eq ''.$c->circ_lib) {
1369                     $ignore_closing = ou_ancestor_setting_value_or_cache(
1370                         $editor,
1371                         ''.$c->circ_lib,
1372                         'circ.holds.target_when_closed_if_at_pickup_lib',
1373                         $target_when_closed_if_at_pickup_lib
1374                     ) || 0;
1375                 }
1376                 if (not $ignore_closing) {  # one more chance to find a reason
1377                                             # to ignore OU closedness.
1378                     $ignore_closing = ou_ancestor_setting_value_or_cache(
1379                         $editor,
1380                         ''.$c->circ_lib,
1381                         'circ.holds.target_when_closed',
1382                         $target_when_closed
1383                     ) || 0;
1384                 }
1385
1386 #               $logger->info(
1387 #                   "For hold " . $hold->id . " and copy with circ_lib " .
1388 #                   $c->circ_lib . " we " .
1389 #                   ($ignore_closing ? "ignore" : "respect")
1390 #                   . " closed dates"
1391 #               );
1392
1393                 next if (
1394                     (not $ignore_closing) and
1395                     (grep { ''.$_->org_unit eq ''.$c->circ_lib } @closed)
1396                 );
1397
1398                 # target of another hold
1399                 next if (action::hold_request
1400                         ->search_where(
1401                             { current_copy => $c->id,
1402                               fulfillment_time => undef,
1403                               cancel_time => undef,
1404                             }
1405                         )
1406                 );
1407
1408                 # we passed all three, keep it
1409                 push @good_copies, $c if ($c);
1410                 #$client->status( new OpenSRF::DomainObject::oilsContinueStatus );
1411             }
1412
1413             $log->debug("\t".scalar(@good_copies)." (non-current) copies available for targeting...");
1414
1415             my $old_best = $hold->current_copy;
1416             my $old_best_still_valid = 0; # Assume no, but the next line says yes if it is still a potential.
1417             $old_best_still_valid = 1 if ( $old_best && grep { ''.$old_best->id eq ''.$_->id } @$all_copies );
1418             $hold->update({ current_copy => undef }) if ($old_best);
1419     
1420             if (!scalar(@good_copies)) {
1421                 $log->info("\tNo (non-current) copies eligible to fill the hold.");
1422                 if ( $old_best_still_valid ) {
1423                     # the old copy is still available
1424                     $log->debug("\tPushing current_copy back onto the targeting list");
1425                     push @good_copies, $old_best;
1426                 } else {
1427                     # oops, old copy is not available
1428                     $log->debug("\tcurrent_copy is no longer available for targeting... NEXT HOLD, PLEASE!");
1429                     $hold->update( { prev_check_time => 'today' } );
1430                     $self->method_lookup('open-ils.storage.transaction.commit')->run;
1431                     push @successes, { hold => $hold->id, eligible_copies => 0, error => 'NO_TARGETS' };
1432                     die "OK\n";
1433                 }
1434             }
1435
1436             # reset prox list after trimming good copies
1437             $prox_list = create_prox_list(
1438                 $self, $pu_lib,
1439                 [ grep { $_->status == 0 || $_->status == 7 } @good_copies ],
1440                 $hold, $hold_copy_map
1441             );
1442
1443             $all_copies = [ grep { ''.$_->circ_lib ne $pu_lib && ( $_->status == 0 || $_->status == 7 ) } @good_copies ];
1444
1445             my $min_prox = [ sort {$a<=>$b} keys %$prox_list ]->[0];
1446             my $best;
1447             if  ($hold->hold_type eq 'R' || $hold->hold_type eq 'F') { # Recall/Force holds bypass hold rules.
1448                 $best = $good_copies[0] if(scalar @good_copies);
1449             } elsif (defined $min_prox) {
1450                 $best = choose_nearest_copy($hold, { $min_prox => delete($$prox_list{$min_prox}) });
1451             }
1452
1453             $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
1454
1455             if (!$best) {
1456                 $log->debug("\tNothing at the pickup lib, looking elsewhere among ".scalar(@$all_copies)." copies");
1457
1458                 $self->{max_loops}{$pu_lib} = $U->ou_ancestor_setting(
1459                     $pu_lib, 'circ.holds.max_org_unit_target_loops', $editor
1460                 );
1461
1462                 if (defined($self->{max_loops}{$pu_lib})) {
1463                     $self->{max_loops}{$pu_lib} = $self->{max_loops}{$pu_lib}{value};
1464
1465                     my %circ_lib_map =  map { (''.$_->circ_lib => 1) } @$all_copies;
1466                     my $circ_lib_list = [keys %circ_lib_map];
1467     
1468                     my $cstore = OpenSRF::AppSession->create('open-ils.cstore');
1469     
1470                     # Grab the "biggest" loop for this hold so far
1471                     my $current_loop = $cstore->request(
1472                         'open-ils.cstore.json_query',
1473                         { distinct => 1,
1474                           select => { aufhmxl => ['max'] },
1475                           from => 'aufhmxl',
1476                           where => { hold => $hold->id}
1477                         }
1478                     )->gather(1);
1479     
1480                     $current_loop = $current_loop->{max} if ($current_loop);
1481                     $current_loop ||= 1;
1482     
1483                     my $exclude_list = $cstore->request(
1484                         'open-ils.cstore.json_query.atomic',
1485                         { distinct => 1,
1486                           select => { aufhol => ['circ_lib'] },
1487                           from => 'aufhol',
1488                           where => { hold => $hold->id}
1489                         }
1490                     )->gather(1);
1491     
1492                     my @keepers;
1493                     if ($exclude_list && @$exclude_list) {
1494                         $exclude_list = [map {$_->{circ_lib}} @$exclude_list];
1495                         # check to see if we've used up every library in the potentials list
1496                         for my $l ( @$circ_lib_list ) {
1497                             my $keep = 1;
1498                             for my $ex ( @$exclude_list ) {
1499                                 if ($ex eq $l) {
1500                                     $keep = 0;
1501                                     last;
1502                                 }
1503                             }
1504                             push(@keepers, $l) if ($keep);
1505                         }
1506                     } else {
1507                         @keepers = @$circ_lib_list;
1508                     }
1509     
1510                     $current_loop++ if (!@keepers);
1511     
1512                     if ($self->{max_loops}{$pu_lib} && $self->{max_loops}{$pu_lib} >= $current_loop) {
1513                         # We haven't exceeded max_loops yet
1514                         my @keeper_copies;
1515                         for my $cp ( @$all_copies ) {
1516                             push(@keeper_copies, $cp) if ( !@keepers || grep { $_ eq ''.$cp->circ_lib } @keepers );
1517
1518                         }
1519                         $all_copies = [@keeper_copies];
1520                     } else {
1521                         # We have, and should remove potentials and cancel the hold
1522                         my @oldmaps = action::hold_copy_map->search( hold => $hold->id );
1523                         $_->delete for (@oldmaps);
1524
1525                         # cancel cause = un-targeted expiration
1526                         $hold->update( { cancel_time => 'now', cancel_cause => 1 } ); 
1527
1528                         # refresh fields from the DB while still in the xact
1529                         my $fm_hold = $hold->to_fieldmapper; 
1530
1531                         $self->method_lookup('open-ils.storage.transaction.commit')->run;
1532
1533                         # tell A/T the hold was cancelled
1534                         my $ses = OpenSRF::AppSession->create('open-ils.trigger');
1535                         $ses->request('open-ils.trigger.event.autocreate', 
1536                             'hold_request.cancel.expire_no_target', $fm_hold, $fm_hold->pickup_lib);
1537
1538                         die "OK\n";
1539                     }
1540
1541                     $prox_list = create_prox_list( $self, $pu_lib, $all_copies, $hold, $hold_copy_map );
1542
1543                     $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
1544
1545                 }
1546
1547                 $best = choose_nearest_copy($hold, $prox_list);
1548             }
1549
1550             $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
1551             if ($old_best) {
1552                 # hold wasn't fulfilled, record the fact
1553             
1554                 $log->info("\tHold was not (but should have been) fulfilled by ".$old_best->id);
1555                 action::unfulfilled_hold_list->create(
1556                         { hold => ''.$hold->id,
1557                           current_copy => ''.$old_best->id,
1558                           circ_lib => ''.$old_best->circ_lib,
1559                         });
1560             }
1561
1562             if ($best) {
1563                 $hold->update( { current_copy => ''.$best->id, prev_check_time => 'now' } );
1564                 $log->debug("\tUpdating hold [".$hold->id."] with new 'current_copy' [".$best->id."] for hold fulfillment.");
1565             } elsif (
1566                 $old_best_still_valid &&
1567                 !action::hold_request
1568                     ->search_where(
1569                         { current_copy => $old_best->id,
1570                           fulfillment_time => undef,
1571                           cancel_time => undef,
1572                         }       
1573                     ) &&
1574                 ( OpenILS::Utils::PermitHold::permit_copy_hold(
1575                     { title => $old_best->call_number->record->to_fieldmapper,
1576                       patron => $hold->usr->to_fieldmapper,
1577                       copy => $old_best->to_fieldmapper,
1578                       requestor => $hold->requestor->to_fieldmapper,
1579                       request_lib => $hold->request_lib->to_fieldmapper,
1580                       pickup_lib => $hold->pickup_lib->id,
1581                       retarget => 1
1582                     }
1583                 ))
1584             ) {     
1585                 $hold->update( { prev_check_time => 'now', current_copy => ''.$old_best->id } );
1586                 $log->debug( "\tRetargeting the previously targeted copy [".$old_best->id."]" );
1587             } else {
1588                 $hold->update( { prev_check_time => 'now' } );
1589                 $log->info( "\tThere were no targetable copies for the hold" );
1590                 process_recall($actor, $log, $hold, \@good_copies);
1591             }
1592
1593             $self->method_lookup('open-ils.storage.transaction.commit')->run;
1594             $log->info("\tProcessing of hold ".$hold->id." complete.");
1595
1596             push @successes,
1597                 { hold => $hold->id,
1598                   old_target => ($old_best ? $old_best->id : undef),
1599                   eligible_copies => $copy_count,
1600                   target => ($best ? $best->id : undef),
1601                   found_copy => $found_copy };
1602
1603         } otherwise {
1604             my $e = shift;
1605             if ($e !~ /^OK/o) {
1606                 $log->error("Processing of hold failed:  $e");
1607                 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
1608                 throw $e if ($e =~ /IS NOT CONNECTED TO THE NETWORK/o);
1609             }
1610         };
1611     }
1612
1613     return \@successes;
1614 }
1615 __PACKAGE__->register_method(
1616     api_name    => 'open-ils.storage.action.hold_request.copy_targeter',
1617     api_level   => 1,
1618     method      => 'new_hold_copy_targeter',
1619 );
1620
1621 sub process_recall {
1622     my ($actor, $log, $hold, $good_copies) = @_;
1623
1624     # Bail early if we don't have required settings to avoid spurious requests
1625     my ($recall_threshold, $return_interval, $fine_rules);
1626
1627     my $rv = $actor->request(
1628         'open-ils.actor.ou_setting.ancestor_default', ''.$hold->pickup_lib, 'circ.holds.recall_threshold'
1629     )->gather(1);
1630
1631     if (!$rv) {
1632         $log->info("Recall threshold was not set; bailing out on hold ".$hold->id." processing.");
1633         return;
1634     }
1635     $recall_threshold = $rv->{value};
1636
1637     $rv = $actor->request(
1638         'open-ils.actor.ou_setting.ancestor_default', ''.$hold->pickup_lib, 'circ.holds.recall_return_interval'
1639     )->gather(1);
1640
1641     if (!$rv) {
1642         $log->info("Recall return interval was not set; bailing out on hold ".$hold->id." processing.");
1643         return;
1644     }
1645     $return_interval = $rv->{value};
1646
1647     $rv = $actor->request(
1648         'open-ils.actor.ou_setting.ancestor_default', ''.$hold->pickup_lib, 'circ.holds.recall_fine_rules'
1649     )->gather(1);
1650
1651     if ($rv) {
1652         $fine_rules = $rv->{value};
1653     }
1654
1655     $log->info("Recall threshold: $recall_threshold; return interval: $return_interval");
1656
1657     # We want checked out copies (status = 1) at the hold pickup lib
1658     my $all_copies = [grep { $_->status == 1 } grep {''.$_->circ_lib eq ''.$hold->pickup_lib } @$good_copies];
1659
1660     my @copy_ids = map { $_->id } @$all_copies;
1661
1662     $log->info("Found " . scalar(@$all_copies) . " eligible checked-out copies for recall");
1663
1664     my $return_date = DateTime->now(time_zone => 'local')->add(seconds => interval_to_seconds($return_interval))->iso8601();
1665
1666     # Iterate over the checked-out copies to find a copy with a
1667     # loan period longer than the recall threshold:
1668     my $circs = [ action::circulation->search_where(
1669         { target_copy => \@copy_ids, checkin_time => undef, duration => { '>' => $recall_threshold } },
1670         { order_by => 'due_date ASC' }
1671     )];
1672
1673     # If we have a candidate copy, then:
1674     if (scalar(@$circs)) {
1675         my $circ = $circs->[0];
1676         $log->info("Recalling circ ID : " . $circ->id);
1677
1678         # Give the user a new due date of either a full recall threshold,
1679         # or the return interval, whichever is further in the future
1680         my $threshold_date = DateTime::Format::ISO8601->parse_datetime(cleanse_ISO8601($circ->xact_start))->add(seconds => interval_to_seconds($recall_threshold))->iso8601();
1681         if (DateTime->compare(DateTime::Format::ISO8601->parse_datetime($threshold_date), DateTime::Format::ISO8601->parse_datetime($return_date)) == 1) {
1682             $return_date = $threshold_date;
1683         }
1684
1685         my $update_fields = {
1686             due_date => $return_date,
1687             renewal_remaining => 0,
1688         };
1689
1690         # If the OU hasn't defined new fine rules for recalls, keep them
1691         # as they were
1692         if ($fine_rules) {
1693             $log->info("Apply recall fine rules: $fine_rules");
1694             my $rules = OpenSRF::Utils::JSON->JSON2perl($fine_rules);
1695             $update_fields->{recurring_fine} = $rules->[0];
1696             $update_fields->{fine_interval} = $rules->[1];
1697             $update_fields->{max_fine} = $rules->[2];
1698         }
1699
1700         # Adjust circ for current user
1701         $circ->update($update_fields);
1702
1703         # Create trigger event for notifying current user
1704         my $ses = OpenSRF::AppSession->create('open-ils.trigger');
1705         $ses->request('open-ils.trigger.event.autocreate', 'circ.recall.target', $circ->to_fieldmapper(), $circ->circ_lib->id);
1706     }
1707
1708     $log->info("Processing of hold ".$hold->id." for recall is now complete.");
1709 }
1710
1711 sub reservation_targeter {
1712     my $self = shift;
1713     my $client = shift;
1714     my $one_reservation = shift;
1715
1716     local $OpenILS::Application::Storage::WRITE = 1;
1717
1718     my $reservations;
1719
1720     try {
1721         if ($one_reservation) {
1722             $self->method_lookup('open-ils.storage.transaction.begin')->run();
1723             $reservations = [ booking::reservation->search_where( { id => $one_reservation, capture_time => undef, cancel_time => undef } ) ];
1724         } else {
1725
1726             # find all the reservations needing targeting
1727             $reservations = [
1728                 booking::reservation->search_where(
1729                     { current_resource => undef,
1730                       cancel_time => undef,
1731                       start_time => { '>' => 'now' }
1732                     },
1733                     { order_by => 'start_time' }
1734                 )
1735             ];
1736         }
1737     } catch Error with {
1738         my $e = shift;
1739         die "Could not retrieve reservation requests:\n\n$e\n";
1740     };
1741
1742     my @successes = ();
1743     for my $bresv (@$reservations) {
1744         try {
1745             #start a transaction if needed
1746             if ($self->method_lookup('open-ils.storage.transaction.current')->run) {
1747                 $log->debug("Cleaning up after previous transaction\n");
1748                 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
1749             }
1750             $self->method_lookup('open-ils.storage.transaction.begin')->run();
1751             $log->info("Processing reservation ".$bresv->id."...\n");
1752
1753             #first, re-fetch the hold, to make sure it's not captured already
1754             $bresv->remove_from_object_index();
1755             $bresv = booking::reservation->retrieve( $bresv->id );
1756
1757             die "OK\n" if (!$bresv or $bresv->capture_time or $bresv->cancel_time);
1758
1759             my $end_time = $parser->parse_datetime( cleanse_ISO8601( $bresv->end_time ) );
1760             if (DateTime->compare($end_time, DateTime->now) < 0) {
1761
1762                 # cancel cause = un-targeted expiration
1763                 $bresv->update( { cancel_time => 'now' } ); 
1764
1765                 # refresh fields from the DB while still in the xact
1766                 my $fm_bresv = $bresv->to_fieldmapper;
1767
1768                 $self->method_lookup('open-ils.storage.transaction.commit')->run;
1769
1770                 # tell A/T the reservation was cancelled
1771                 my $ses = OpenSRF::AppSession->create('open-ils.trigger');
1772                 $ses->request('open-ils.trigger.event.autocreate', 
1773                     'booking.reservation.cancel.expire_no_target', $fm_bresv, $fm_bresv->pickup_lib);
1774
1775                 die "OK\n";
1776             }
1777
1778             my $possible_resources;
1779
1780             # find all the potential resources
1781             if (!$bresv->target_resource) {
1782                 my $filter = { type => $bresv->target_resource_type };
1783                 my $attr_maps = [ booking::reservation_attr_value_map->search( reservation => $bresv->id) ];
1784
1785                 $filter->{attribute_values} = [ map { $_->attr_value } @$attr_maps ] if (@$attr_maps);
1786
1787                 $filter->{available} = [$bresv->start_time, $bresv->end_time];
1788                 my $ses = OpenSRF::AppSession->create('open-ils.booking');
1789                 $possible_resources = $ses->request('open-ils.booking.resources.filtered_id_list', undef, $filter)->gather(1);
1790             } else {
1791                 $possible_resources = $bresv->target_resource;
1792             }
1793
1794             my $all_resources = [ booking::resource->search( id => $possible_resources ) ];
1795             @$all_resources = grep { isTrue($_->type->transferable) || $_->owner.'' eq $bresv->pickup_lib.'' } @$all_resources;
1796
1797
1798             my @good_resources = ();
1799             my %conflicts = ();
1800             for my $res (@$all_resources) {
1801                 unless (isTrue($res->type->catalog_item)) {
1802                     push @good_resources, $res;
1803                     next;
1804                 }
1805
1806                 my $copy = [ asset::copy->search( deleted => 'f', barcode => $res->barcode )]->[0];
1807
1808                 unless ($copy) {
1809                     push @good_resources, $res;
1810                     next;
1811                 }
1812
1813                 # At this point, if we're just targeting one specific
1814                 # resource, just succeed. We don't care about its present
1815                 # copy status.
1816                 if ($bresv->target_resource) {
1817                     push @good_resources, $res;
1818                     next;
1819                 }
1820
1821                 if ($copy->status->id == 0 || $copy->status->id == 7) {
1822                     push @good_resources, $res;
1823                     next;
1824                 }
1825
1826                 if ($copy->status->id == 1) {
1827                     my $circs = [ action::circulation->search_where(
1828                         {target_copy => $copy->id, checkin_time => undef },
1829                         { order_by => 'id DESC' }
1830                     ) ];
1831
1832                     if (@$circs) {
1833                         my $due_date = $circs->[0]->due_date;
1834                         $due_date = $parser->parse_datetime( cleanse_ISO8601( $due_date ) );
1835                         my $start_time = $parser->parse_datetime( cleanse_ISO8601( $bresv->start_time ) );
1836                         if (DateTime->compare($start_time, $due_date) < 0) {
1837                             $conflicts{$res->id} = $circs->[0]->to_fieldmapper;
1838                             next;
1839                         }
1840
1841                         push @good_resources, $res;
1842                     }
1843
1844                     next;
1845                 }
1846
1847                 push @good_resources, $res if (isTrue($copy->status->holdable));
1848             }
1849
1850             # let 'em know we're still working
1851             $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
1852             
1853             # if we have no copies ...
1854             if (!@good_resources) {
1855                 $log->info("\tNo resources available for targeting at all!\n");
1856                 push @successes, { reservation => $bresv->id, eligible_copies => 0, error => 'NO_COPIES', conflicts => \%conflicts };
1857
1858
1859                 $self->method_lookup('open-ils.storage.transaction.commit')->run;
1860                 die "OK\n";
1861             }
1862
1863             $log->debug("\t".scalar(@good_resources)." resources available for targeting...");
1864
1865             # LFW: note that after the inclusion of hold proximity
1866             # adjustment, this prox_list is the only prox_list
1867             # array in this perl package.  Other occurences are
1868             # hashes.
1869             my $prox_list = [];
1870             $$prox_list[0] =
1871             [
1872                 grep {
1873                     $_->owner == $bresv->pickup_lib
1874                 } @good_resources
1875             ];
1876
1877             $all_resources = [grep {$_->owner != $bresv->pickup_lib } @good_resources];
1878             # $all_copies is now a list of copies not at the pickup library
1879
1880             my $best = shift @good_resources;
1881             $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
1882
1883             if (!$best) {
1884                 $log->debug("\tNothing at the pickup lib, looking elsewhere among ".scalar(@$all_resources)." resources");
1885
1886                 $prox_list =
1887                     map  { $_->[1] }
1888                     sort { $a->[0] <=> $b->[0] }
1889                     map  {
1890                         [   actor::org_unit_proximity->search_where(
1891                                 { from_org => $bresv->pickup_lib.'', to_org => $_->owner.'' }
1892                             )->[0]->prox,
1893                             $_
1894                         ]
1895                     } @$all_resources;
1896
1897                 $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
1898
1899                 $best = shift @$prox_list
1900             }
1901
1902             if ($best) {
1903                 $bresv->update( { current_resource => ''.$best->id } );
1904                 $log->debug("\tUpdating reservation [".$bresv->id."] with new 'current_resource' [".$best->id."] for reservation fulfillment.");
1905             }
1906
1907             $self->method_lookup('open-ils.storage.transaction.commit')->run;
1908             $log->info("\tProcessing of bresv ".$bresv->id." complete.");
1909
1910             push @successes,
1911                 { reservation => $bresv->id,
1912                   current_resource => ($best ? $best->id : undef) };
1913
1914         } otherwise {
1915             my $e = shift;
1916             if ($e !~ /^OK/o) {
1917                 $log->error("Processing of bresv failed:  $e");
1918                 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
1919                 throw $e if ($e =~ /IS NOT CONNECTED TO THE NETWORK/o);
1920             }
1921         };
1922     }
1923
1924     return \@successes;
1925 }
1926 __PACKAGE__->register_method(
1927     api_name    => 'open-ils.storage.booking.reservation.resource_targeter',
1928     api_level   => 1,
1929     method      => 'reservation_targeter',
1930 );
1931
1932 my $locations;
1933 my $statuses;
1934 my %cache = (titles => {}, cns => {});
1935
1936 sub copy_hold_capture {
1937     my $self = shift;
1938     my $hold = shift;
1939     my $cps = shift;
1940
1941     if (!defined($cps)) {
1942         try {
1943             $cps = [ asset::copy->search( id => $hold->target ) ];
1944         } catch Error with {
1945             my $e = shift;
1946             die "Could not retrieve initial volume list:\n\n$e\n";
1947         };
1948     }
1949
1950     my @copies = grep { $_->holdable } @$cps;
1951
1952     for (my $i = 0; $i < @$cps; $i++) {
1953         next unless $$cps[$i];
1954         
1955         my $cn = $cache{cns}{$copies[$i]->call_number};
1956         my $rec = $cache{titles}{$cn->record};
1957         $copies[$i] = undef if ($copies[$i] && !grep{ $copies[$i]->status eq $_->id}@$statuses);
1958         $copies[$i] = undef if ($copies[$i] && !grep{ $copies[$i]->location eq $_->id}@$locations);
1959         $copies[$i] = undef if (
1960             !$copies[$i] ||
1961             !$self->{user_filter}->request(
1962                 'open-ils.circ.permit_hold',
1963                 $hold->to_fieldmapper, do {
1964                     my $cp_fm = $copies[$i]->to_fieldmapper;
1965                     $cp_fm->circ_lib( $copies[$i]->circ_lib->to_fieldmapper );
1966                     $cp_fm->location( $copies[$i]->location->to_fieldmapper );
1967                     $cp_fm->status( $copies[$i]->status->to_fieldmapper );
1968                     $cp_fm;
1969                 },
1970                 { title => $rec->to_fieldmapper,
1971                   usr => actor::user->retrieve($hold->usr)->to_fieldmapper,
1972                   requestor => actor::user->retrieve($hold->requestor)->to_fieldmapper,
1973                 })->gather(1)
1974         );
1975         $self->{client}->status( new OpenSRF::DomainObject::oilsContinueStatus );
1976     }
1977
1978     @copies = grep { $_ } @copies;
1979
1980     my $count = @copies;
1981
1982     return unless ($count);
1983     
1984     action::hold_copy_map->search( hold => $hold->id )->delete_all;
1985     
1986     my @maps;
1987     $self->{client}->respond( "\tMapping ".scalar(@copies)." eligable copies for hold ".$hold->id."\n");
1988     for my $c (@copies) {
1989         push @maps, action::hold_copy_map->create( { hold => $hold->id, target_copy => $c->id } );
1990     }
1991     $self->{client}->respond( "\tA total of ".scalar(@maps)." mapping were created for hold ".$hold->id."\n");
1992
1993     return \@copies;
1994 }
1995
1996
1997 sub choose_nearest_copy {
1998     my $hold = shift;
1999     my $prox_list = shift;
2000
2001     for my $p ( sort {$a<=>$b} keys %$prox_list ) {
2002         next unless (ref $$prox_list{$p});
2003
2004         my @capturable = @{ $$prox_list{$p} };
2005         next unless (@capturable);
2006
2007         my $rand = int(rand(scalar(@capturable)));
2008         my %seen = ();
2009         while (my ($c) = splice(@capturable, $rand, 1)) {
2010             return $c if !exists($seen{$c->id}) && ( OpenILS::Utils::PermitHold::permit_copy_hold(
2011                 { title => $c->call_number->record->to_fieldmapper,
2012                   patron => $hold->usr->to_fieldmapper,
2013                   copy => $c->to_fieldmapper,
2014                   requestor => $hold->requestor->to_fieldmapper,
2015                   request_lib => $hold->request_lib->to_fieldmapper,
2016                   pickup_lib => $hold->pickup_lib->id,
2017                   retarget => 1
2018                 }
2019             ));
2020             $seen{$c->id}++;
2021
2022             last unless(@capturable);
2023             $rand = int(rand(scalar(@capturable)));
2024         }
2025     }
2026 }
2027
2028 sub create_prox_list {
2029     my $self = shift;
2030     my $lib = shift;
2031     my $copies = shift;
2032     my $hold = shift;
2033     my $hold_copy_map = shift || {};
2034
2035     my %prox_list;
2036     my $editor = new_editor;
2037     for my $cp (@$copies) {
2038         my $prox = $hold_copy_map->{"$hold"}->{"$cp"}; # Allow CDBI stringification to get the pkey
2039         ($prox) = $self->method_lookup('open-ils.storage.asset.copy.proximity')->run( $cp, $lib, $hold ) unless (defined $prox);
2040         next unless (defined($prox));
2041
2042         my $copy_circ_lib = ''.$cp->circ_lib;
2043         # Fetch the weighting value for hold targeting, defaulting to 1
2044         $self->{target_weight}{$copy_circ_lib} ||= $U->ou_ancestor_setting(
2045             $copy_circ_lib.'', 'circ.holds.org_unit_target_weight', $editor
2046         );
2047         $self->{target_weight}{$copy_circ_lib} = $self->{target_weight}{$copy_circ_lib}{value} if (ref $self->{target_weight}{$copy_circ_lib});
2048         $self->{target_weight}{$copy_circ_lib} ||= 1;
2049
2050         $prox_list{$prox} = [] unless defined($prox_list{$prox});
2051         for my $w ( 1 .. $self->{target_weight}{$copy_circ_lib} ) {
2052             push @{$prox_list{$prox}}, $cp;
2053         }
2054     }
2055     return \%prox_list;
2056 }
2057
2058 sub volume_hold_capture {
2059     my $self = shift;
2060     my $hold = shift;
2061     my $vols = shift;
2062
2063     if (!defined($vols)) {
2064         try {
2065             $vols = [ asset::call_number->search( id => $hold->target ) ];
2066             $cache{cns}{$_->id} = $_ for (@$vols);
2067         } catch Error with {
2068             my $e = shift;
2069             die "Could not retrieve initial volume list:\n\n$e\n";
2070         };
2071     }
2072
2073     my @v_ids = map { $_->id } @$vols;
2074
2075     my $cp_list;
2076     try {
2077         $cp_list = [ asset::copy->search( call_number => \@v_ids ) ];
2078     
2079     } catch Error with {
2080         my $e = shift;
2081         warn "Could not retrieve copy list:\n\n$e\n";
2082     };
2083
2084     $self->copy_hold_capture($hold,$cp_list) if (ref $cp_list and @$cp_list);
2085 }
2086
2087 sub title_hold_capture {
2088     my $self = shift;
2089     my $hold = shift;
2090     my $titles = shift;
2091
2092     if (!defined($titles)) {
2093         try {
2094             $titles = [ biblio::record_entry->search( id => $hold->target ) ];
2095             $cache{titles}{$_->id} = $_ for (@$titles);
2096         } catch Error with {
2097             my $e = shift;
2098             die "Could not retrieve initial title list:\n\n$e\n";
2099         };
2100     }
2101
2102     my @t_ids = map { $_->id } @$titles;
2103     my $cn_list;
2104     try {
2105         ($cn_list) = $self->method_lookup('open-ils.storage.direct.asset.call_number.search.record.atomic')->run( \@t_ids );
2106     
2107     } catch Error with {
2108         my $e = shift;
2109         warn "Could not retrieve volume list:\n\n$e\n";
2110     };
2111
2112     $cache{cns}{$_->id} = $_ for (@$cn_list);
2113
2114     $self->volume_hold_capture($hold,$cn_list) if (ref $cn_list and @$cn_list);
2115 }
2116
2117
2118 sub wide_hold_data {
2119     my $self = shift;
2120     my $client = shift;
2121     my $restrictions = shift; # hashref of field restrictions {f1=>undef,f2=>[1,2,3],f3=>'foo',f4=>{not=>undef}}
2122     my $order_by = shift; # arrayref of hashrefs of ORDER BY clause, [{field =>{dir=>'desc',nulls=>'last'}}]
2123     my $limit = shift;
2124     my $offset = shift;
2125
2126     $order_by = [$order_by] if (ref($order_by) !~ /ARRAY/);
2127     
2128     $log->info('Received '. keys(%$restrictions) .' restrictions');
2129     return 0 unless (ref $restrictions and keys %$restrictions);
2130
2131     # force this to either 'true' or 'false'
2132     my $is_staff_request = delete($$restrictions{is_staff_request}) || 'false';
2133     $is_staff_request = 'false' if (!grep {$is_staff_request eq $_} qw/true false/);
2134
2135     # option to filter for the latest captured hold for a given copy
2136     my $last_captured_hold = delete($$restrictions{last_captured_hold}) || 'false';
2137     $last_captured_hold = $last_captured_hold eq 'true' ? 1 : 0;
2138
2139     my $initial_condition = 'TRUE';
2140     if ($last_captured_hold) {
2141         $initial_condition = <<"        SQL";
2142             (h.capture_time IS NULL OR (h.id = (
2143                 SELECT  id
2144                   FROM  action.hold_request recheck
2145                   WHERE recheck.current_copy = cp.id
2146                   ORDER BY capture_time DESC
2147                   LIMIT 1
2148             )))
2149         SQL
2150     }
2151
2152     my $select = <<"    SQL";
2153 WITH
2154     t_field AS (SELECT field FROM config.display_field_map WHERE name = 'title'),
2155     a_field AS (SELECT field FROM config.display_field_map WHERE name = 'author')
2156 SELECT  h.id, h.request_time, h.capture_time, h.fulfillment_time, h.checkin_time,
2157         h.return_time, h.prev_check_time, h.expire_time, h.cancel_time, h.cancel_cause,
2158         h.cancel_note, h.target, h.current_copy, h.fulfillment_staff, h.fulfillment_lib,
2159         h.request_lib, h.requestor, h.usr, h.selection_ou, h.selection_depth, h.pickup_lib,
2160         h.hold_type, h.holdable_formats, h.phone_notify, h.email_notify, h.sms_notify,
2161         h.sms_carrier, h.frozen, h.thaw_date, h.shelf_time, h.cut_in_line, h.mint_condition,
2162         h.shelf_expire_time, h.current_shelf_lib, h.behind_desk,
2163
2164         CASE WHEN h.cancel_time IS NOT NULL THEN 6
2165              WHEN h.frozen AND h.capture_time IS NULL THEN 7
2166              WHEN h.current_shelf_lib IS NOT NULL AND h.current_shelf_lib <> h.pickup_lib THEN 8
2167              WHEN h.fulfillment_time IS NOT NULL THEN 9
2168              WHEN h.current_copy IS NULL THEN 1
2169              WHEN h.capture_time IS NULL THEN 2
2170              WHEN cp.status = 6 THEN 3
2171              WHEN EXTRACT(EPOCH FROM COALESCE(NULLIF(BTRIM(hold_wait_time.value,'"'),''),'0 seconds')::INTERVAL) = 0 THEN 4
2172              WHEN NOW() + COALESCE(NULLIF(BTRIM(hold_wait_time.value,'"'),''),'0 seconds')::INTERVAL > NOW() THEN 5
2173              ELSE 5
2174         END AS hold_status,
2175
2176         (h.shelf_expire_time < NOW() OR h.cancel_time IS NOT NULL OR (h.current_shelf_lib IS NOT NULL AND h.current_shelf_lib <> h.pickup_lib)) AS clear_me,
2177
2178         (h.usr <> h.requestor) AS is_staff_hold,
2179
2180         cc.id AS cc_id, cc.label AS cc_label,
2181
2182         pl.id AS pl_id, pl.parent_ou AS pl_parent_ou, pl.ou_type AS pl_ou_type,
2183         pl.ill_address AS pl_ill_address, pl.holds_address AS pl_holds_address,
2184         pl.mailing_address AS pl_mailing_address, pl.billing_address AS pl_billing_address,
2185         pl.shortname AS pl_shortname, pl.name AS pl_name, pl.email AS pl_email,
2186         pl.phone AS pl_phone, pl.opac_visible AS pl_opac_visible, pl.fiscal_calendar AS pl_fiscal_calendar,
2187
2188         tr.id AS tr_id, tr.source_send_time AS tr_source_send_time, tr.dest_recv_time AS tr_dest_recv_time,
2189         tr.target_copy AS tr_target_copy, tr.source AS tr_source, tr.dest AS tr_dest, tr.prev_hop AS tr_prev_hop,
2190         tr.copy_status AS tr_copy_status, tr.persistant_transfer AS tr_persistant_transfer,
2191         tr.prev_dest AS tr_prev_dest, tr.hold AS tr_hold, tr.cancel_time AS tr_cancel_time,
2192
2193         notes.count AS note_count,
2194
2195         u.id AS usr_id, u.card AS usr_card, u.profile AS usr_profile, u.usrname AS usr_usrname,
2196         u.email AS usr_email, u.standing AS usr_standing, u.ident_type AS usr_ident_type,
2197         u.ident_value AS usr_ident_value, u.ident_type2 AS usr_ident_type2,
2198         u.ident_value2 AS usr_ident_value2, u.net_access_level AS usr_net_access_level,
2199         u.photo_url AS usr_photo_url, u.prefix AS usr_prefix, u.first_given_name AS usr_first_given_name,
2200         u.second_given_name AS usr_second_given_name, u.family_name AS usr_family_name,
2201         u.suffix AS usr_suffix, u.alias AS usr_alias, u.day_phone AS usr_day_phone,
2202         u.evening_phone AS usr_evening_phone, u.other_phone AS usr_other_phone,
2203         u.mailing_address AS usr_mailing_address, u.billing_address AS usr_billing_address,
2204         u.home_ou AS usr_home_ou, u.dob AS usr_dob, u.active AS usr_active,
2205         u.master_account AS usr_master_account, u.super_user AS usr_super_user,
2206         u.barred AS usr_barred, u.deleted AS usr_deleted, u.juvenile AS usr_juvenile,
2207         u.usrgroup AS usr_usrgroup, u.claims_returned_count AS usr_claims_returned_count,
2208         u.credit_forward_balance AS usr_credit_forward_balance, u.last_xact_id AS usr_last_xact_id,
2209         u.alert_message AS usr_alert_message, u.create_date AS usr_create_date,
2210         u.expire_date AS usr_expire_date, u.claims_never_checked_out_count AS usr_claims_never_checked_out_count,
2211         u.last_update_time AS usr_last_update_time,
2212
2213         CASE WHEN u.alias IS NOT NULL THEN
2214             u.alias
2215         ELSE
2216             u.first_given_name
2217         END AS usr_alias_or_first_given_name,
2218
2219         CASE WHEN u.alias IS NOT NULL THEN
2220             u.alias
2221         ELSE
2222             REGEXP_REPLACE(ARRAY_TO_STRING(ARRAY[
2223                 COALESCE(u.family_name, ''),
2224                 COALESCE(u.suffix, ''),
2225                 ', ',
2226                 COALESCE(u.prefix, ''),
2227                 COALESCE(u.first_given_name, ''),
2228                 COALESCE(u.second_given_name, '')
2229             ], ' '), E'\\s+,', ',')
2230         END AS usr_alias_or_display_name,
2231
2232         REGEXP_REPLACE(ARRAY_TO_STRING(ARRAY[
2233             COALESCE(u.family_name, ''),
2234             COALESCE(u.suffix, ''),
2235             ', ',
2236             COALESCE(u.prefix, ''),
2237             COALESCE(u.first_given_name, ''),
2238             COALESCE(u.second_given_name, '')
2239         ], ' '), E'\\s+,', ',') AS usr_display_name,
2240
2241         uc.id AS ucard_id, uc.barcode AS ucard_barcode, uc.usr AS ucard_usr, uc.active AS ucard_active,
2242
2243         ru.id AS rusr_id, ru.card AS rusr_card, ru.profile AS rusr_profile, ru.usrname AS rusr_usrname,
2244         ru.email AS rusr_email, ru.standing AS rusr_standing, ru.ident_type AS rusr_ident_type,
2245         ru.ident_value AS rusr_ident_value, ru.ident_type2 AS rusr_ident_type2,
2246         ru.ident_value2 AS rusr_ident_value2, ru.net_access_level AS rusr_net_access_level,
2247         ru.photo_url AS rusr_photo_url, ru.prefix AS rusr_prefix, ru.first_given_name AS rusr_first_given_name,
2248         ru.second_given_name AS rusr_second_given_name, ru.family_name AS rusr_family_name,
2249         ru.suffix AS rusr_suffix, ru.alias AS rusr_alias, ru.day_phone AS rusr_day_phone,
2250         ru.evening_phone AS rusr_evening_phone, ru.other_phone AS rusr_other_phone,
2251         ru.mailing_address AS rusr_mailing_address, ru.billing_address AS rusr_billing_address,
2252         ru.home_ou AS rusr_home_ou, ru.dob AS rusr_dob, ru.active AS rusr_active,
2253         ru.master_account AS rusr_master_account, ru.super_user AS rusr_super_user,
2254         ru.barred AS rusr_barred, ru.deleted AS rusr_deleted, ru.juvenile AS rusr_juvenile,
2255         ru.usrgroup AS rusr_usrgroup, ru.claims_returned_count AS rusr_claims_returned_count,
2256         ru.credit_forward_balance AS rusr_credit_forward_balance, ru.last_xact_id AS rusr_last_xact_id,
2257         ru.alert_message AS rusr_alert_message, ru.create_date AS rusr_create_date,
2258         ru.expire_date AS rusr_expire_date, ru.claims_never_checked_out_count AS rusr_claims_never_checked_out_count,
2259         ru.last_update_time AS rusr_last_update_time,
2260
2261         ruc.id AS rucard_id, ruc.barcode AS rucard_barcode, ruc.usr AS rucard_usr, ruc.active AS rucard_active,
2262
2263         cp.id AS cp_id, cp.circ_lib AS cp_circ_lib, cp.creator AS cp_creator, cp.call_number AS cp_call_number,
2264         cp.editor AS cp_editor, cp.create_date AS cp_create_date, cp.edit_date AS cp_edit_date,
2265         cp.copy_number AS cp_copy_number, cp.status AS cp_status, cp.location AS cp_location,
2266         cp.loan_duration AS cp_loan_duration, cp.fine_level AS cp_fine_level, cp.age_protect AS cp_age_protect,
2267         cp.circulate AS cp_circulate, cp.deposit AS cp_deposit, cp.ref AS cp_ref, cp.holdable AS cp_holdable,
2268         cp.deposit_amount AS cp_deposit_amount, cp.price AS cp_price, cp.barcode AS cp_barcode,
2269         cp.circ_modifier AS cp_circ_modifier, cp.circ_as_type AS cp_circ_as_type, cp.dummy_title AS cp_dummy_title,
2270         cp.dummy_author AS cp_dummy_author, cp.alert_message AS cp_alert_message, cp.opac_visible AS cp_opac_visible,
2271         cp.deleted AS cp_deleted, cp.floating AS cp_floating, cp.dummy_isbn AS cp_dummy_isbn,
2272         cp.status_changed_time AS cp_status_change_time, cp.active_date AS cp_active_date,
2273         cp.mint_condition AS cp_mint_condition, cp.cost AS cp_cost,
2274
2275         cs.id AS cs_id, cs.name AS cs_name, cs.holdable AS cs_holdable, cs.opac_visible AS cs_opac_visible,
2276         cs.copy_active AS cs_copy_active, cs.restrict_copy_delete AS cs_restrict_copy_delete,
2277         cs.is_available AS cs_is_available,
2278
2279         siss.label AS issuance_label,
2280
2281         cn.id AS cn_id, cn.creator AS cn_creator, cn.create_date AS cn_create_date, cn.editor AS cn_editor,
2282         cn.edit_date AS cn_edit_date, cn.record AS cn_record, cn.owning_lib AS cn_owning_lib, cn.label AS cn_label,
2283         cn.deleted AS cn_deleted, cn.prefix AS cn_prefix, cn.suffix AS cn_suffix, cn.label_class AS cn_label_class,
2284         cn.label_sortkey AS cn_label_sortkey,
2285
2286         p.id AS p_id, p.record AS p_record, p.label AS p_label, p.label_sortkey AS p_label_sortkey, p.deleted AS p_deleted,
2287
2288         acnp.label AS ancp_label, acns.label AS ancs_label,
2289         TRIM(acnp.label || ' ' || cn.label || ' ' || acns.label) AS cn_full_label,
2290
2291         r.bib_record AS record_id,
2292
2293         t.value AS title,
2294         a.value AS author,
2295
2296         acpl.id AS acpl_id, acpl.name AS acpl_name, acpl.owning_lib AS acpl_owning_lib, acpl.holdable AS acpl_holdable,
2297         acpl.hold_verify AS acpl_hold_verify, acpl.opac_visible AS acpl_opac_visible, acpl.circulate AS acpl_circulate,
2298         acpl.label_prefix AS acpl_label_prefix, acpl.label_suffix AS acpl_label_suffix,
2299         acpl.checkin_alert AS acpl_checkin_alert, acpl.deleted AS acpl_deleted, acpl.url AS acpl_url,
2300
2301         COALESCE(acplo.position, acpl_ordered.fallback_position) AS copy_location_order_position,
2302
2303         ROW_NUMBER() OVER (
2304             PARTITION BY r.bib_record
2305             ORDER BY h.cut_in_line DESC NULLS LAST, h.request_time ASC
2306         ) AS relative_queue_position,
2307
2308         EXTRACT(EPOCH FROM COALESCE(
2309             NULLIF(BTRIM(default_estimated_wait_interval.value,'"'),''),
2310             '0 seconds'
2311         )::INTERVAL) AS default_estimated_wait,
2312
2313         EXTRACT(EPOCH FROM COALESCE(
2314             NULLIF(BTRIM(min_estimated_wait_interval.value,'"'),''),
2315             '0 seconds'
2316         )::INTERVAL) AS min_estimated_wait,
2317
2318         COALESCE(hold_wait.potenials,0) AS potentials,
2319         COALESCE(hold_wait.other_holds,0) AS other_holds,
2320         COALESCE(hold_wait.total_wait_time,0) AS total_wait_time,
2321
2322         n.count AS notification_count,
2323         n.max AS last_notification_time
2324
2325   FROM  action.hold_request h
2326         JOIN reporter.hold_request_record r ON (r.id = h.id)
2327         JOIN actor.usr u ON (u.id = h.usr)
2328         JOIN actor.card uc ON (uc.id = u.card)
2329         JOIN actor.usr ru ON (ru.id = h.requestor)
2330         JOIN actor.card ruc ON (ruc.id = ru.card)
2331         JOIN actor.org_unit pl ON (h.pickup_lib = pl.id)
2332         JOIN t_field ON TRUE
2333         JOIN a_field ON TRUE
2334         LEFT JOIN action.hold_request_cancel_cause cc ON (h.cancel_cause = cc.id)
2335         LEFT JOIN biblio.monograph_part p ON (h.hold_type = 'P' AND p.id = h.target)
2336         LEFT JOIN serial.issuance siss ON (h.hold_type = 'I' AND siss.id = h.target)
2337         LEFT JOIN asset.copy cp ON (h.current_copy = cp.id OR (h.hold_type IN ('C','F','R') AND cp.id = h.target))
2338         LEFT JOIN config.copy_status cs ON (cp.status = cs.id)
2339         LEFT JOIN asset.copy_location acpl ON (cp.location = acpl.id)
2340         LEFT JOIN asset.copy_location_order acplo ON (cp.location = acplo.location AND cp.circ_lib = acplo.org)
2341         LEFT JOIN (
2342             SELECT *, (ROW_NUMBER() OVER (ORDER BY name) + 1000000) AS fallback_position
2343             FROM asset.copy_location
2344         ) acpl_ordered ON (acpl_ordered.id = cp.location)
2345         LEFT JOIN asset.call_number cn ON (cn.id = cp.call_number OR (h.hold_type = 'V' AND cn.id = h.target))
2346         LEFT JOIN asset.call_number_prefix acnp ON (cn.prefix = acnp.id)
2347         LEFT JOIN asset.call_number_suffix acns ON (cn.suffix = acns.id)
2348         LEFT JOIN LATERAL (SELECT * FROM action.hold_transit_copy WHERE h.id = hold ORDER BY id DESC LIMIT 1) tr ON TRUE
2349         LEFT JOIN LATERAL (SELECT COUNT(*) FROM action.hold_request_note WHERE h.id = hold AND (pub = TRUE OR staff = $is_staff_request)) notes ON TRUE
2350         LEFT JOIN LATERAL (SELECT COUNT(*), MAX(notify_time) FROM action.hold_notification WHERE h.id = hold) n ON TRUE
2351         LEFT JOIN LATERAL (SELECT FIRST(value) AS value FROM metabib.display_entry WHERE source = r.bib_record AND field = t_field.field) t ON TRUE
2352         LEFT JOIN LATERAL (SELECT FIRST(value) AS value FROM metabib.display_entry WHERE source = r.bib_record AND field = a_field.field) a ON TRUE
2353         LEFT JOIN LATERAL actor.org_unit_ancestor_setting('circ.holds.default_estimated_wait_interval',u.home_ou) AS default_estimated_wait_interval ON TRUE
2354         LEFT JOIN LATERAL actor.org_unit_ancestor_setting('circ.holds.min_estimated_wait_interval',u.home_ou) AS min_estimated_wait_interval ON TRUE
2355         LEFT JOIN LATERAL actor.org_unit_ancestor_setting('circ.hold_shelf_status_delay',h.pickup_lib) AS hold_wait_time ON TRUE,
2356         LATERAL (
2357             SELECT  COUNT(*) AS potenials,
2358                     COUNT(DISTINCT hold) AS other_holds,
2359                     SUM(
2360                         EXTRACT(EPOCH FROM
2361                             COALESCE(
2362                                 cm.avg_wait_time,
2363                                 COALESCE(NULLIF(BTRIM(default_estimated_wait_interval.value,'"'),''),'0 seconds')::INTERVAL
2364                             )
2365                         )
2366                     ) AS total_wait_time
2367               FROM  action.hold_copy_map m
2368                     JOIN asset.copy cp ON (cp.id = m.target_copy)
2369                     LEFT JOIN config.circ_modifier cm ON (cp.circ_modifier = cm.code)
2370               WHERE m.hold = h.id
2371         ) AS hold_wait
2372   WHERE $initial_condition
2373     SQL
2374
2375     my %field_map = (
2376         record_id => 'r.bib_record',
2377         usr_id => 'u.id',
2378         cs_id => 'cs.id',
2379         cp_id => 'cp.id',
2380         cancel_time => 'h.cancel_time',
2381         tr_cancel_time => 'tr.cancel_time',
2382     );
2383
2384     my $restricted = 0;
2385     for my $r (keys %$restrictions) {
2386         my $real = $field_map{$r} || $r;
2387         next if ($r =~ /[^a-z_.]/); # skip obvious bad inputs
2388
2389         my $not = '';
2390         if (ref($$restrictions{$r}) and ref($$restrictions{$r}) =~ /HASH/) {
2391             $not = 'NOT';
2392             $$restrictions{$r} = $$restrictions{$r}{not};
2393         }
2394
2395         if (!defined($$restrictions{$r})) { 
2396             $select .= " AND $real IS $not NULL ";
2397         } elsif (ref($$restrictions{$r})) { 
2398             $select .= " AND $real $not IN (\$_$$\$" . join("\$_$$\$,\$_$$\$", @{$$restrictions{$r}}) . "\$_$$\$)";
2399         } else {
2400             $not = '!' if $not;
2401             $select .= " AND $real $not= \$_$$\$$$restrictions{$r}\$_$$\$";
2402         }
2403
2404         $restricted++;
2405     }
2406
2407     return 0 unless $restricted;
2408
2409     my @ob;
2410     for my $o (@$order_by) {
2411         next unless $o;
2412         my ($r) = keys %$o;
2413         next if ($r =~ /[^a-z_.]/); # skip obvious bad inputs
2414         my $real = $field_map{$r} || $r;
2415         push(@ob, $real);
2416         $ob[-1] .= ' DESC' if ($$o{$r}->{dir} and $$o{$r}->{dir} =~ /^d/i);
2417         $ob[-1] .= ' NULLS LAST' if ($$o{$r}->{nulls} and $$o{$r}->{nulls} =~ /^l/i);
2418         $ob[-1] .= ' NULLS FIRST' if ($$o{$r}->{nulls} and $$o{$r}->{nulls} =~ /^f/i);
2419     }
2420
2421     $select .= ' ORDER BY ' . join(', ', @ob) if (@ob);
2422     $select .= ' LIMIT ' . $limit if ($limit and $limit =~ /^\d+$/);
2423     $select .= ' OFFSET ' . $offset if ($offset and $offset =~ /^\d+$/);
2424
2425     my $sth = action::hold_request->db_Main->prepare($select);
2426     $sth->execute();
2427
2428     my @list = $sth->fetchall_hash;
2429     $client->respond(scalar(@list)); # send the row count first, for progress tracking
2430     $client->respond( $_ ) for (@list);
2431
2432     $client->respond_complete;
2433 }
2434 __PACKAGE__->register_method(
2435     api_name        => 'open-ils.storage.action.live_holds.wide_hash',
2436     api_level       => 1,
2437     stream          => 1,
2438     max_bundle_count=> 1,
2439     method          => 'wide_hold_data',
2440 );
2441
2442
2443 1;
2444