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