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