7d6ed8698143355ab24d6ae4e483ac125a86febd
[Evergreen.git] / Open-ILS / src / perlmods / OpenILS / Application / Storage / Publisher / action.pm
1 package OpenILS::Application::Storage::Publisher::action;
2 use base qw/OpenILS::Application::Storage::Publisher/;
3 use OpenSRF::Utils::Logger qw/:level/;
4 use OpenSRF::Utils qw/:datetime/;
5 use OpenSRF::AppSession;
6 use OpenSRF::EX qw/:try/;
7 use OpenILS::Utils::Fieldmapper;
8 use OpenILS::Utils::PermitHold;
9 use DateTime;
10 use DateTime::Format::ISO8601;
11
12 sub isTrue {
13         my $v = shift;
14         return 1 if ($v == 1);
15         return 1 if ($v =~ /^t/io);
16         return 1 if ($v =~ /^y/io);
17         return 0;
18 }
19
20 my $parser = DateTime::Format::ISO8601->new;
21 my $log = 'OpenSRF::Utils::Logger';
22
23 sub open_noncat_circs {
24         my $self = shift;
25         my $client = shift;
26         my $user = shift;
27
28         my $a = action::non_cataloged_circulation->table;
29         my $c = config::non_cataloged_type->table;
30
31         my $sql = <<"   SQL";
32                 SELECT  a.id
33                   FROM  $a a
34                         JOIN $c c ON (a.item_type = c.id)
35                   WHERE a.circ_time + c.circ_duration > current_timestamp
36                         AND a.patron = ?
37         SQL
38
39         return action::non_cataloged_circulation->db_Main->selectcol_arrayref($sql, {}, $user);
40 }
41 __PACKAGE__->register_method(
42         api_name        => 'open-ils.storage.action.open_non_cataloged_circulation.user',
43         api_level       => 1,
44         argc            => 1,
45         method          => 'open_noncat_circs',
46 );
47
48
49 sub ou_hold_requests {
50         my $self = shift;
51         my $client = shift;
52         my $ou = shift;
53
54         my $h_table = action::hold_request->table;
55         my $c_table = asset::copy->table;
56         my $o_table = actor::org_unit->table;
57
58         my $SQL = <<"   SQL";
59                 SELECT  h.id
60                   FROM  $h_table h
61                         JOIN $c_table cp ON (cp.id = h.current_copy)
62                         JOIN $o_table ou ON (ou.id = cp.circ_lib)
63                   WHERE ou.id = ?
64                         AND h.capture_time IS NULL
65                         AND h.cancel_time IS NULL
66                   ORDER BY h.request_time
67         SQL
68
69         my $sth = action::hold_request->db_Main->prepare_cached($SQL);
70         $sth->execute($ou);
71
72         $client->respond($_) for (
73                 map {
74                         $self
75                                 ->method_lookup('open-ils.storage.direct.action.hold_request.retrieve')
76                                 ->run($_)
77                 } map {
78                         $_->[0]
79                 } @{ $sth->fetchall_arrayref }
80         );
81         return undef;
82 }
83 __PACKAGE__->register_method(
84         api_name        => 'open-ils.storage.action.targeted_hold_request.org_unit',
85         api_level       => 1,
86         argc            => 1,
87         stream          => 1,
88         method          => 'ou_hold_requests',
89 );
90
91
92 sub overdue_circs {
93         my $grace = shift;
94
95         my $c_t = action::circulation->table;
96
97         $grace = " - ($grace * (fine_interval))" if ($grace);
98
99         my $sql = <<"   SQL";
100                 SELECT  *
101                   FROM  $c_t
102                   WHERE stop_fines IS NULL
103                         AND due_date < ( CURRENT_TIMESTAMP $grace)
104         SQL
105
106         my $sth = action::circulation->db_Main->prepare_cached($sql);
107         $sth->execute;
108
109         return ( map { action::circulation->construct($_) } $sth->fetchall_hash );
110
111 }
112
113 sub complete_reshelving {
114         my $self = shift;
115         my $client = shift;
116         my $window = shift;
117
118         local $OpenILS::Application::Storage::WRITE = 1;
119
120         throw OpenSRF::EX::InvalidArg ("I need an interval of more than 0 seconds!")
121                 unless (interval_to_seconds( $window ));
122
123         my $circ = action::circulation->table;
124         my $cp = asset::copy->table;
125
126         my $sql = <<"   SQL";
127                 UPDATE  $cp
128                   SET   status = 0
129                   WHERE id IN
130                         ( SELECT id FROM (
131                                 SELECT  cp.id, MAX(circ.checkin_time)
132                                   FROM  $cp cp
133                                         JOIN $circ circ ON (circ.target_copy = cp.id)
134                                   WHERE circ.checkin_time IS NOT NULL
135                                         AND cp.status = 7
136                                   GROUP BY 1
137                                         HAVING MAX(circ.checkin_time) < NOW() - CAST(? AS INTERVAL)
138                         ) AS foo
139                 )
140         SQL
141
142         my $sth = action::circulation->db_Main->prepare_cached($sql);
143         $sth->execute($window);
144
145         return $sth->rows;
146
147 }
148 __PACKAGE__->register_method(
149         api_name        => 'open-ils.storage.action.circulation.reshelving.complete',
150         api_level       => 1,
151         stream          => 1,
152         argc            => 1,
153         method          => 'complete_reshelving',
154 );
155
156 sub grab_overdue {
157         my $self = shift;
158         my $client = shift;
159         my $grace = shift || '';
160
161         $client->respond( $_->to_fieldmapper ) for ( overdue_circs($grace) );
162
163         return undef;
164
165 }
166 __PACKAGE__->register_method(
167         api_name        => 'open-ils.storage.action.circulation.overdue',
168         api_level       => 1,
169         stream          => 1,
170         method          => 'grab_overdue',
171 );
172
173 sub nearest_hold {
174         my $self = shift;
175         my $client = shift;
176         my $pl = shift;
177         my $cp = shift;
178         my $limit = int(shift()) || 10;
179
180         my ($id) = action::hold_request->db_Main->selectrow_array(<<"   SQL", {}, $cp, $pl);
181                 SELECT  h.id
182                   FROM  action.hold_request h
183                         JOIN action.hold_copy_map hm ON (hm.hold = h.id)
184                         JOIN actor.org_unit_proximity p ON (p.from_org = h.pickup_lib)
185                   WHERE hm.target_copy = ?
186                         AND p.to_org = ?
187                         AND h.capture_time IS NULL
188                         AND h.cancel_time IS NULL
189                 ORDER BY
190                         p.prox,
191                         h.selection_depth DESC,
192                         h.request_time
193                 LIMIT $limit
194         SQL
195         return $id;
196 }
197 __PACKAGE__->register_method(
198         api_name        => 'open-ils.storage.action.hold_request.nearest_hold',
199         api_level       => 1,
200         stream          => 1,
201         method          => 'nearest_hold',
202 );
203
204 sub next_resp_group_id {
205         my $self = shift;
206         my $client = shift;
207
208         # XXX This is not replication safe!!!
209
210         my ($id) = action::survey->db_Main->selectrow_array(<<" SQL");
211                 SELECT NEXTVAL('action.survey_response_group_id_seq'::TEXT)
212         SQL
213         return $id;
214 }
215 __PACKAGE__->register_method(
216         api_name        => 'open-ils.storage.action.survey_response.next_group_id',
217         api_level       => 1,
218         method          => 'next_resp_group_id',
219 );
220
221 sub patron_circ_summary {
222         my $self = shift;
223         my $client = shift;
224         my $id = ''.shift();
225
226         return undef unless ($id);
227         my $c_table = action::circulation->table;
228         my $b_table = money::billing->table;
229
230         $log->debug("Retrieving patron summary for id $id", DEBUG);
231
232         my $select = <<"        SQL";
233                 SELECT  COUNT(DISTINCT c.id), SUM( COALESCE(b.amount,0) )
234                   FROM  $c_table c
235                         LEFT OUTER JOIN $b_table b ON (c.id = b.xact AND b.voided = FALSE)
236                   WHERE c.usr = ?
237                         AND c.xact_finish IS NULL
238                         AND (
239                                 c.stop_fines NOT IN ('CLAIMSRETURNED','LOST')
240                                 OR c.stop_fines IS NULL
241                         )
242         SQL
243
244         return action::survey->db_Main->selectrow_arrayref($select, {}, $id);
245 }
246 __PACKAGE__->register_method(
247         api_name        => 'open-ils.storage.action.circulation.patron_summary',
248         api_level       => 1,
249         method          => 'patron_circ_summary',
250 );
251
252 #XXX Fix stored proc calls
253 sub find_local_surveys {
254         my $self = shift;
255         my $client = shift;
256         my $ou = ''.shift();
257
258         return undef unless ($ou);
259         my $s_table = action::survey->table;
260
261         my $select = <<"        SQL";
262                 SELECT  s.*
263                   FROM  $s_table s
264                         JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
265                   WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
266         SQL
267
268         my $sth = action::survey->db_Main->prepare_cached($select);
269         $sth->execute($ou);
270
271         $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
272
273         return undef;
274 }
275 __PACKAGE__->register_method(
276         api_name        => 'open-ils.storage.action.survey.all',
277         api_level       => 1,
278         stream          => 1,
279         method          => 'find_local_surveys',
280 );
281
282 #XXX Fix stored proc calls
283 sub find_opac_surveys {
284         my $self = shift;
285         my $client = shift;
286         my $ou = ''.shift();
287
288         return undef unless ($ou);
289         my $s_table = action::survey->table;
290
291         my $select = <<"        SQL";
292                 SELECT  s.*
293                   FROM  $s_table s
294                         JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
295                   WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
296                         AND s.opac IS TRUE;
297         SQL
298
299         my $sth = action::survey->db_Main->prepare_cached($select);
300         $sth->execute($ou);
301
302         $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
303
304         return undef;
305 }
306 __PACKAGE__->register_method(
307         api_name        => 'open-ils.storage.action.survey.opac',
308         api_level       => 1,
309         stream          => 1,
310         method          => 'find_opac_surveys',
311 );
312
313 sub hold_pull_list {
314         my $self = shift;
315         my $client = shift;
316         my $ou = shift;
317         my $limit = shift || 10;
318         my $offset = shift || 0;
319
320         return undef unless ($ou);
321         my $h_table = action::hold_request->table;
322         my $a_table = asset::copy->table;
323
324         my $idlist = 1 if ($self->api_name =~/id_list/o);
325
326         my $select = <<"        SQL";
327                 SELECT  h.*
328                   FROM  $h_table h
329                         JOIN $a_table a ON (h.current_copy = a.id)
330                   WHERE a.circ_lib = ?
331                         AND h.capture_time IS NULL
332                         AND h.cancel_time IS NULL
333                   ORDER BY h.request_time ASC
334                   LIMIT $limit
335                   OFFSET $offset
336         SQL
337
338         my $sth = action::survey->db_Main->prepare_cached($select);
339         $sth->execute($ou);
340
341         if ($idlist) {
342                 $client->respond( $_->{id} ) for ( $sth->fetchall_hash );
343         } else {
344                 $client->respond( $_->to_fieldmapper ) for ( map { action::hold_request->construct($_) } $sth->fetchall_hash );
345         }
346
347         return undef;
348 }
349 __PACKAGE__->register_method(
350         api_name        => 'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib',
351         api_level       => 1,
352         stream          => 1,
353         signature       => [
354                 "Returns the hold ids for a specific library's pull list.",
355                 [ [org_unit => "The library's org id", "number"],
356                   [limit => 'An optional page size, defaults to 10', 'number'],
357                   [offset => 'Offset for paging, defaults to 0, 0 based', 'number'],
358                 ],
359                 ['A list of holds for the stated library to pull for', 'array']
360         ],
361         method          => 'hold_pull_list',
362 );
363 __PACKAGE__->register_method(
364         api_name        => 'open-ils.storage.direct.action.hold_request.pull_list.search.current_copy_circ_lib',
365         api_level       => 1,
366         stream          => 1,
367         signature       => [
368                 "Returns the holds for a specific library's pull list.",
369                 [ [org_unit => "The library's org id", "number"],
370                   [limit => 'An optional page size, defaults to 10', 'number'],
371                   [offset => 'Offset for paging, defaults to 0, 0 based', 'number'],
372                 ],
373                 ['A list of holds for the stated library to pull for', 'array']
374         ],
375         method          => 'hold_pull_list',
376 );
377
378 sub find_optional_surveys {
379         my $self = shift;
380         my $client = shift;
381         my $ou = ''.shift();
382
383         return undef unless ($ou);
384         my $s_table = action::survey->table;
385
386         my $select = <<"        SQL";
387                 SELECT  s.*
388                   FROM  $s_table s
389                         JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
390                   WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
391                         AND s.required IS FALSE;
392         SQL
393
394         my $sth = action::survey->db_Main->prepare_cached($select);
395         $sth->execute($ou);
396
397         $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
398
399         return undef;
400 }
401 __PACKAGE__->register_method(
402         api_name        => 'open-ils.storage.action.survey.optional',
403         api_level       => 1,
404         stream          => 1,
405         method          => 'find_optional_surveys',
406 );
407
408 sub find_required_surveys {
409         my $self = shift;
410         my $client = shift;
411         my $ou = ''.shift();
412
413         return undef unless ($ou);
414         my $s_table = action::survey->table;
415
416         my $select = <<"        SQL";
417                 SELECT  s.*
418                   FROM  $s_table s
419                         JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
420                   WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
421                         AND s.required IS TRUE;
422         SQL
423
424         my $sth = action::survey->db_Main->prepare_cached($select);
425         $sth->execute($ou);
426
427         $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
428
429         return undef;
430 }
431 __PACKAGE__->register_method(
432         api_name        => 'open-ils.storage.action.survey.required',
433         api_level       => 1,
434         stream          => 1,
435         method          => 'find_required_surveys',
436 );
437
438 sub find_usr_summary_surveys {
439         my $self = shift;
440         my $client = shift;
441         my $ou = ''.shift();
442
443         return undef unless ($ou);
444         my $s_table = action::survey->table;
445
446         my $select = <<"        SQL";
447                 SELECT  s.*
448                   FROM  $s_table s
449                         JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
450                   WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
451                         AND s.usr_summary IS TRUE;
452         SQL
453
454         my $sth = action::survey->db_Main->prepare_cached($select);
455         $sth->execute($ou);
456
457         $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
458
459         return undef;
460 }
461 __PACKAGE__->register_method(
462         api_name        => 'open-ils.storage.action.survey.usr_summary',
463         api_level       => 1,
464         stream          => 1,
465         method          => 'find_usr_summary_surveys',
466 );
467
468
469 sub generate_fines {
470         my $self = shift;
471         my $client = shift;
472         my $grace = shift;
473         my $circ = shift;
474         my $overbill = shift;
475
476         local $OpenILS::Application::Storage::WRITE = 1;
477
478         my @circs;
479         if ($circ) {
480                 push @circs, action::circulation->search_where( { id => $circ, stop_fines => undef } );
481         } else {
482                 push @circs, overdue_circs($grace);
483         }
484
485         my %hoo = map { ( $_->id => $_ ) } actor::org_unit::hours_of_operation->retrieve_all;
486
487         my $penalty = OpenSRF::AppSession->create('open-ils.penalty');
488         for my $c (@circs) {
489         
490                 try {
491                         if ($self->method_lookup('open-ils.storage.transaction.current')->run) {
492                                 $log->debug("Cleaning up after previous transaction\n");
493                                 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
494                         }
495                         $self->method_lookup('open-ils.storage.transaction.begin')->run( $client );
496                         $log->info("Processing circ ".$c->id."...\n");
497
498
499                         my $due_dt = $parser->parse_datetime( clense_ISO8601( $c->due_date ) );
500         
501                         my $due = $due_dt->epoch;
502                         my $now = time;
503                         my $fine_interval = interval_to_seconds( $c->fine_interval );
504         
505                         if ( interval_to_seconds( $c->fine_interval ) >= interval_to_seconds('1d') ) {  
506                                 my $tz_offset_s = 0;
507                                 if ($due_dt->strftime('%z') =~ /(-|\+)(\d{2}):?(\d{2})/) {
508                                         $tz_offset_s = $1 . interval_to_seconds( "${2}h ${3}m"); 
509                                 }
510         
511                                 $due -= ($due % $fine_interval) + $tz_offset_s;
512                                 $now -= ($now % $fine_interval) + $tz_offset_s;
513                         }
514         
515                         $client->respond(
516                                 "ARG! Overdue circulation ".$c->id.
517                                 " for item ".$c->target_copy.
518                                 " (user ".$c->usr.").\n".
519                                 "\tItem was due on or before: ".localtime($due)."\n");
520         
521                         my @fines = money::billing->search_where(
522                                 { xact => $c->id, billing_type => 'Overdue materials' },
523                                 { order_by => 'billing_ts DESC'}
524                         );
525
526                         my $f_idx = 0;
527                         my $fine = $fines[$f_idx] if (@fines);
528                         if ($overbill) {
529                                 $fine = $fines[++$f_idx] while ($fine and $fine->voided);
530                         }
531
532                         my $current_fine_total = 0;
533                         $current_fine_total += int($_->amount * 100) for (grep { $_ and !$_->voided } @fines);
534         
535                         my $last_fine;
536                         if ($fine) {
537                                 $client->respond( "Last billing time: ".$fine->billing_ts." (clensed fromat: ".clense_ISO8601( $fine->billing_ts ).")");
538                                 $last_fine = $parser->parse_datetime( clense_ISO8601( $fine->billing_ts ) )->epoch;
539                         } else {
540                                 $last_fine = $due;
541
542                                 # XXX There is some contention over this ... it basically makes the grace period "hard" (non-fining)
543                                 #$last_fine += $fine_interval * $grace;
544                         }
545         
546                         my $pending_fine_count = int( ($now - $last_fine) / $fine_interval ); 
547                         if ($pending_fine_count < 1 + $grace) {
548                                 $client->respond( "\tNo fines to create.  " );
549                                 if ($grace && $now < $due + $fine_interval * $grace) {
550                                         $client->respond( "Still inside grace period of: ". seconds_to_interval( $fine_interval * $grace)."\n" );
551                                 } else {
552                                         $client->respond( "Last fine generated for: ".localtime($last_fine)."\n" );
553                                 }
554                                 next;
555                         }
556         
557                         $client->respond( "\t$pending_fine_count pending fine(s)\n" );
558
559                         my $recuring_fine = int($c->recuring_fine * 100);
560                         my $max_fine = int($c->max_fine * 100);
561
562                         my ($latest_billing_ts, $latest_amount) = ('',0);;
563                         for (my $bill = 1; $bill <= $pending_fine_count; $bill++) {
564         
565                                 if ($current_fine_total >= $max_fine) {
566                                         $c->update({stop_fines => 'MAXFINES', stop_fines_time => 'now'});
567                                         $client->respond(
568                                                 "\tMaximum fine level of ".$c->max_fine.
569                                                 " reached for this circulation.\n".
570                                                 "\tNo more fines will be generated.\n" );
571                                         last;
572                                 }
573                                 
574                                 my $billing_ts = DateTime->from_epoch( epoch => $last_fine + $fine_interval * $bill );
575
576                                 my $dow = $billing_ts->dow;
577                                 my $dow_open = "dow_${dow}_open";
578                                 my $dow_close = "dow_${dow}_close";
579
580                                 if (my $h = $hoo{$c->circ_lib}) {
581                                         next if ( $h->$dow_open eq '00:00:00' and $h->$dow_close eq '00:00:00');
582                                 }
583
584                                 my $timestamptz = $billing_ts->strftime('%FT%T%z');
585                                 my @cl = actor::org_unit::closed_date->search_where(
586                                                 { close_start   => { '<=' => $timestamptz },
587                                                   close_end     => { '>=' => $timestamptz },
588                                                   org_unit      => $c->circ_lib }
589                                 );
590                                 next if (@cl);
591         
592                                 $current_fine_total += $recuring_fine;
593                                 $latest_amount += $recuring_fine;
594                                 $latest_billing_ts = $timestamptz;
595
596                                 money::billing->create(
597                                         { xact          => ''.$c->id,
598                                           note          => "System Generated Overdue Fine",
599                                           billing_type  => "Overdue materials",
600                                           amount        => sprintf('%0.2f', $recuring_fine/100),
601                                           billing_ts    => $timestamptz,
602                                         }
603                                 );
604
605                         }
606
607                         $client->respond( "\t\tAdding fines totaling $latest_amount for overdue up to $latest_billing_ts\n" )
608                                 if ($latest_billing_ts and $latest_amount);
609
610                         $self->method_lookup('open-ils.storage.transaction.commit')->run;
611
612                         $penalty->request(
613                                 'open-ils.penalty.patron_penalty.calculate',
614                                 { patron        => $c->usr->to_fieldmapper,
615                                   update        => 1,
616                                   background    => 1,
617                                 }
618                         )->gather(1);
619
620                 } catch Error with {
621                         my $e = shift;
622                         $client->respond( "Error processing overdue circulation [".$c->id."]:\n\n$e\n" );
623                         $log->error("Error processing overdue circulation [".$c->id."]:\n$e\n");
624                         $self->method_lookup('open-ils.storage.transaction.rollback')->run;
625                         throw $e ifif ($e =~ /IS NOT CONNECTED TO THE NETWORK/o);
626                 };
627         }
628 }
629 __PACKAGE__->register_method(
630         api_name        => 'open-ils.storage.action.circulation.overdue.generate_fines',
631         api_level       => 1,
632         stream          => 1,
633         method          => 'generate_fines',
634 );
635
636
637
638 sub new_hold_copy_targeter {
639         my $self = shift;
640         my $client = shift;
641         my $check_expire = shift;
642         my $one_hold = shift;
643
644         local $OpenILS::Application::Storage::WRITE = 1;
645
646         my $holds;
647
648         try {
649                 if ($one_hold) {
650                         $holds = [ action::hold_request->search_where( { id => $one_hold, fulfillment_time => undef, cancel_time => undef } ) ];
651                 } elsif ( $check_expire ) {
652
653                         # what's the retarget time threashold?
654                         my $time = time;
655                         $check_expire ||= '12h';
656                         $check_expire = interval_to_seconds( $check_expire );
657
658                         my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = gmtime(time() - $check_expire);
659                         $year += 1900;
660                         $mon += 1;
661                         my $expire_threshold = sprintf(
662                                 '%s-%0.2d-%0.2dT%0.2d:%0.2d:%0.2d-00',
663                                 $year, $mon, $mday, $hour, $min, $sec
664                         );
665
666                         # find all the holds holds needing retargeting
667                         $holds = [ action::hold_request->search_where(
668                                                         { capture_time => undef,
669                                                           fulfillment_time => undef,
670                                                           cancel_time => undef,
671                                                           prev_check_time => { '<=' => $expire_threshold },
672                                                         },
673                                                         { order_by => 'selection_depth DESC, request_time,prev_check_time' } ) ];
674
675                         # find all the holds holds needing first time targeting
676                         push @$holds, action::hold_request->search(
677                                                         capture_time => undef,
678                                                         fulfillment_time => undef,
679                                                         prev_check_time => undef,
680                                                         cancel_time => undef,
681                                                         { order_by => 'selection_depth DESC, request_time' } );
682                 } else {
683
684                         # find all the holds holds needing first time targeting ONLY
685                         $holds = [ action::hold_request->search(
686                                                         capture_time => undef,
687                                                         fulfillment_time => undef,
688                                                         prev_check_time => undef,
689                                                         cancel_time => undef,
690                                                         { order_by => 'selection_depth DESC, request_time' } ) ];
691                 }
692         } catch Error with {
693                 my $e = shift;
694                 die "Could not retrieve uncaptured hold requests:\n\n$e\n";
695         };
696
697         my @closed = actor::org_unit::closed_date->search_where(
698                 { close_start => { '<=', 'today' },
699                   close_end => { '>=', 'today' } }
700         );
701
702
703         my @successes;
704
705         for my $hold (@$holds) {
706                 try {
707                         #start a transaction if needed
708                         if ($self->method_lookup('open-ils.storage.transaction.current')->run) {
709                                 $log->debug("Cleaning up after previous transaction\n");
710                                 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
711                         }
712                         $self->method_lookup('open-ils.storage.transaction.begin')->run( $client );
713                         $log->info("Processing hold ".$hold->id."...\n");
714
715                         # remove old auto-targeting maps
716                         my @oldmaps = action::hold_copy_map->search( hold => $hold->id );
717                         $_->delete for (@oldmaps);
718
719         
720                         my $all_copies = [];
721
722                         # find filters for MR holds
723                         my ($types, $formats, $lang) = split '-', $hold->holdable_formats;
724
725                         # find all the potential copies
726                         if ($hold->hold_type eq 'M') {
727                                 for my $r ( map
728                                                 {$_->record}
729                                                 metabib::record_descriptor
730                                                         ->search(
731                                                                 record => [ map { $_->id } metabib::metarecord->retrieve($hold->target)->source_records ],
732                                                                 ( $types   ? (item_type => [split '', $types])   : () ),
733                                                                 ( $formats ? (item_form => [split '', $formats]) : () ),
734                                                                 ( $lang    ? (item_lang => $lang)                : () ),
735                                                         )
736                                 ) {
737                                         my ($rtree) = $self
738                                                 ->method_lookup( 'open-ils.storage.biblio.record_entry.ranged_tree')
739                                                 ->run( $r->id, $hold->selection_ou, $hold->selection_depth );
740
741                                         for my $cn ( @{ $rtree->call_numbers } ) {
742                                                 push @$all_copies,
743                                                         asset::copy->search( id => [map {$_->id} @{ $cn->copies }] );
744                                         }
745                                 }
746                         } elsif ($hold->hold_type eq 'T') {
747                                 my ($rtree) = $self
748                                         ->method_lookup( 'open-ils.storage.biblio.record_entry.ranged_tree')
749                                         ->run( $hold->target, $hold->selection_ou, $hold->selection_depth );
750
751                                 unless ($rtree) {
752                                         push @successes, { hold => $hold->id, eligible_copies => 0, error => 'NO_RECORD' };
753                                         die 'OK';
754                                 }
755
756                                 for my $cn ( @{ $rtree->call_numbers } ) {
757                                         push @$all_copies,
758                                                 asset::copy->search( id => [map {$_->id} @{ $cn->copies }] );
759                                 }
760                         } elsif ($hold->hold_type eq 'V') {
761                                 my ($vtree) = $self
762                                         ->method_lookup( 'open-ils.storage.asset.call_number.ranged_tree')
763                                         ->run( $hold->target, $hold->selection_ou, $hold->selection_depth );
764
765                                 push @$all_copies,
766                                         asset::copy->search( id => [map {$_->id} @{ $vtree->copies }] );
767                                         
768                         } elsif  ($hold->hold_type eq 'C') {
769
770                                 $all_copies = [asset::copy->retrieve($hold->target)];
771                         }
772
773                         # trim unholdables
774                         @$all_copies = grep {   isTrue($_->status->holdable) && 
775                                                 isTrue($_->location->holdable) && 
776                                                 isTrue($_->holdable)
777                                         } @$all_copies;
778
779                         # let 'em know we're still working
780                         $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
781                         
782                         # if we have no copies ...
783                         if (!ref $all_copies || !@$all_copies) {
784                                 $log->info("\tNo copies available for targeting at all!\n");
785                                 $self->method_lookup('open-ils.storage.transaction.commit')->run;
786                                 push @successes, { hold => $hold->id, eligible_copies => 0, error => 'NO_COPIES' };
787
788                                 $hold->update( { prev_check_time => 'today' } );
789                                 $self->method_lookup('open-ils.storage.transaction.commit')->run;
790                                 die 'OK';
791                         }
792
793                         my $copy_count = @$all_copies;
794
795                         # map the potentials, so that we can pick up checkins
796                         $log->debug( "\tMapping ".scalar(@$all_copies)." potential copies for hold ".$hold->id);
797                         action::hold_copy_map->create( { hold => $hold->id, target_copy => $_->id } ) for (@$all_copies);
798
799                         $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
800
801                         my @good_copies;
802                         for my $c (@$all_copies) {
803                                 # current target
804                                 next if ($c->id == $hold->current_copy);
805
806                                 # circ lib is closed
807                                 next if ( grep { ''.$_->org_unit == ''.$c->circ_lib } @closed );
808
809                                 # target of another hold
810                                 next if (action::hold_request
811                                                 ->search_where(
812                                                         { current_copy => $c->id,
813                                                           fulfillment_time => undef,
814                                                           cancel_time => undef,
815                                                         }
816                                                 )
817                                 );
818
819                                 # we passed all three, keep it
820                                 push @good_copies, $c if ($c);
821                                 $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
822                         }
823
824                         $log->debug("\t".scalar(@good_copies)." (non-current) copies available for targeting...");
825
826                         my $old_best = $hold->current_copy;
827                         $hold->update({ current_copy => undef }) if ($old_best);
828         
829                         if (!scalar(@good_copies)) {
830                                 $log->info("\tNo (non-current) copies eligible to fill the hold.");
831                                 if (
832                                   $old_best &&
833                                   grep { $old_best eq $_ } @$all_copies &&
834                                   !action::hold_request->search_where({ current_copy => $old_best->id, capture_time => undef, cancel_time => undef })
835                                 ) {
836                                         # the old copy is still available
837                                         $log->debug("\tPushing current_copy back onto the targeting list");
838                                         push @good_copies, $old_best;
839                                 } else {
840                                         # oops, old copy is not available
841                                         $log->debug("\tcurrent_copy is no longer available for targeting... NEXT HOLD, PLEASE!");
842                                         $hold->update( { prev_check_time => 'today' } );
843                                         $self->method_lookup('open-ils.storage.transaction.commit')->run;
844                                         push @successes, { hold => $hold->id, eligible_copies => 0, error => 'NO_TARGETS' };
845                                         die 'OK';
846                                 }
847                         }
848
849                         $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
850                         my $prox_list = [];
851                         $$prox_list[0] =
852                         [
853                                 grep {
854                                         $_->circ_lib == $hold->pickup_lib
855                                 } @good_copies
856                         ];
857
858                         $all_copies = [grep {$_->circ_lib != $hold->pickup_lib } @good_copies];
859
860                         $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
861                         my $best = choose_nearest_copy($hold, $prox_list);
862                         $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
863
864                         if (!$best) {
865                                 $log->debug("\tNothing at the pickup lib, looking elsewhere among ".scalar(@$all_copies)." copies");
866                                 $prox_list = create_prox_list( $self, $hold->pickup_lib, $all_copies );
867
868                                 $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
869
870                                 $best = choose_nearest_copy($hold, $prox_list);
871                         }
872
873                         $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
874                         if ($old_best) {
875                                 # hold wasn't fulfilled, record the fact
876                         
877                                 $log->info("\tHold was not (but should have been) fulfilled by ".$old_best->id);
878                                 action::unfulfilled_hold_list->create(
879                                                 { hold => ''.$hold->id,
880                                                   current_copy => ''.$old_best->id,
881                                                   circ_lib => ''.$old_best->circ_lib,
882                                                 });
883                         }
884
885                         if ($best) {
886                                 $hold->update( { current_copy => ''.$best->id, prev_check_time => 'now' } );
887                                 $log->debug("\tUpdating hold [".$hold->id."] with new 'current_copy' [".$best->id."] for hold fulfillment.");
888                         } else {
889                                 $hold->update( { prev_check_time => 'now' } );
890                                 $log->info( "\tThere were no targetable copies for the hold" );
891                         }
892
893                         $self->method_lookup('open-ils.storage.transaction.commit')->run;
894                         $log->info("\tProcessing of hold ".$hold->id." complete.");
895
896                         push @successes,
897                                 { hold => $hold->id,
898                                   old_target => ($old_best ? $old_best->id : undef),
899                                   eligible_copies => $copy_count,
900                                   target => ($best ? $best->id : undef) };
901
902                 } otherwise {
903                         my $e = shift;
904                         if ($e !~ /^OK/o) {
905                                 $log->error("Processing of hold failed:  $e");
906                                 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
907                                 throw $e if ($e =~ /IS NOT CONNECTED TO THE NETWORK/o);
908                         }
909                 };
910         }
911
912         return \@successes;
913 }
914 __PACKAGE__->register_method(
915         api_name        => 'open-ils.storage.action.hold_request.copy_targeter',
916         api_level       => 1,
917         method          => 'new_hold_copy_targeter',
918 );
919
920 my $locations;
921 my $statuses;
922 my %cache = (titles => {}, cns => {});
923 sub hold_copy_targeter {
924         my $self = shift;
925         my $client = shift;
926         my $check_expire = shift;
927         my $one_hold = shift;
928
929         $self->{user_filter} = OpenSRF::AppSession->create('open-ils.circ');
930         $self->{user_filter}->connect;
931         $self->{client} = $client;
932
933         my $time = time;
934         $check_expire ||= '12h';
935         $check_expire = interval_to_seconds( $check_expire );
936
937         my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = gmtime(time() - $check_expire);
938         $year += 1900;
939         $mon += 1;
940         my $expire_threshold = sprintf(
941                 '%s-%0.2d-%0.2dT%0.2d:%0.2d:%0.2d-00',
942                 $year, $mon, $mday, $hour, $min, $sec
943         );
944
945
946         $statuses ||= [ config::copy_status->search(holdable => 't') ];
947
948         $locations ||= [ asset::copy_location->search(holdable => 't') ];
949
950         my $holds;
951
952         %cache = (titles => {}, cns => {});
953
954         try {
955                 if ($one_hold) {
956                         $holds = [ action::hold_request->search(id => $one_hold) ];
957                 } else {
958                         $holds = [ action::hold_request->search_where(
959                                                         { capture_time => undef,
960                                                           prev_check_time => { '<=' => $expire_threshold },
961                                                         },
962                                                         { order_by => 'request_time,prev_check_time' } ) ];
963                         push @$holds, action::hold_request->search_where(
964                                                         { capture_time => undef,
965                                                           prev_check_time => undef,
966                                                         },
967                                                         { order_by => 'request_time' } );
968                 }
969         } catch Error with {
970                 my $e = shift;
971                 die "Could not retrieve uncaptured hold requests:\n\n$e\n";
972         };
973
974         for my $hold (@$holds) {
975                 try {
976                         #action::hold_request->db_Main->begin_work;
977                         if ($self->method_lookup('open-ils.storage.transaction.current')->run) {
978                                 $client->respond("Cleaning up after previous transaction\n");
979                                 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
980                         }
981                         $self->method_lookup('open-ils.storage.transaction.begin')->run( $client );
982                         $client->respond("Processing hold ".$hold->id."...\n");
983
984                         my $copies;
985
986                         $copies = $self->metarecord_hold_capture($hold) if ($hold->hold_type eq 'M');
987                         $self->{client}->status( new OpenSRF::DomainObject::oilsContinueStatus );
988
989                         $copies = $self->title_hold_capture($hold) if ($hold->hold_type eq 'T');
990                         $self->{client}->status( new OpenSRF::DomainObject::oilsContinueStatus );
991                         
992                         $copies = $self->volume_hold_capture($hold) if ($hold->hold_type eq 'V');
993                         $self->{client}->status( new OpenSRF::DomainObject::oilsContinueStatus );
994                         
995                         $copies = $self->copy_hold_capture($hold) if ($hold->hold_type eq 'C');
996
997                         unless (ref $copies || !@$copies) {
998                                 $client->respond("\tNo copies available for targeting at all!\n");
999                         }
1000
1001                         my @good_copies;
1002                         for my $c (@$copies) {
1003                                 next if ( grep {$c->id == $hold->current_copy} @good_copies);
1004                                 push @good_copies, $c if ($c);
1005                         }
1006
1007                         $client->respond("\t".scalar(@good_copies)." (non-current) copies available for targeting...\n");
1008
1009                         my $old_best = $hold->current_copy;
1010                         $hold->update({ current_copy => undef });
1011         
1012                         if (!scalar(@good_copies)) {
1013                                 $client->respond("\tNo (non-current) copies available to fill the hold.\n");
1014                                 if ( $old_best && grep {$c->id == $hold->current_copy} @$copies ) {
1015                                         $client->respond("\tPushing current_copy back onto the targeting list\n");
1016                                         push @good_copies, asset::copy->retrieve( $old_best );
1017                                 } else {
1018                                         $client->respond("\tcurrent_copy is no longer available for targeting... NEXT HOLD, PLEASE!\n");
1019                                         next;
1020                                 }
1021                         }
1022
1023                         my $prox_list;
1024                         $$prox_list[0] = [grep {$_->circ_lib == $hold->pickup_lib } @good_copies];
1025                         $copies = [grep {$_->circ_lib != $hold->pickup_lib } @good_copies];
1026
1027                         my $best = choose_nearest_copy($hold, $prox_list);
1028
1029                         if (!$best) {
1030                                 $prox_list = create_prox_list( $self, $hold->pickup_lib, $copies );
1031                                 $best = choose_nearest_copy($hold, $prox_list);
1032                         }
1033
1034                         if ($old_best) {
1035                                 # hold wasn't fulfilled, record the fact
1036                         
1037                                 $client->respond("\tHold was not (but should have been) fulfilled by ".$old_best->id.".\n");
1038                                 action::unfulfilled_hold_list->create(
1039                                                 { hold => ''.$hold->id,
1040                                                   current_copy => ''.$old_best->id,
1041                                                   circ_lib => ''.$old_best->circ_lib,
1042                                                 });
1043                         }
1044
1045                         if ($best) {
1046                                 $hold->update( { current_copy => ''.$best->id } );
1047                                 $client->respond("\tTargeting copy ".$best->id." for hold fulfillment.\n");
1048                         }
1049
1050                         $hold->update( { prev_check_time => 'now' } );
1051                         $client->respond("\tUpdating hold ".$hold->id." with new 'current_copy' for hold fulfillment.\n");
1052
1053                         $client->respond("\tProcessing of hold ".$hold->id." complete.\n");
1054                         $self->method_lookup('open-ils.storage.transaction.commit')->run;
1055
1056                         #action::hold_request->dbi_commit;
1057
1058                 } otherwise {
1059                         my $e = shift;
1060                         $log->error("Processing of hold failed:  $e");
1061                         $client->respond("\tProcessing of hold failed!.\n\t\t$e\n");
1062                         $self->method_lookup('open-ils.storage.transaction.rollback')->run;
1063                         #action::hold_request->dbi_rollback;
1064                 };
1065         }
1066
1067         $self->{user_filter}->disconnect;
1068         $self->{user_filter}->finish;
1069         delete $$self{user_filter};
1070         return undef;
1071 }
1072 __PACKAGE__->register_method(
1073         api_name        => 'open-ils.storage.action.hold_request.copy_targeter',
1074         api_level       => 0,
1075         stream          => 1,
1076         method          => 'hold_copy_targeter',
1077 );
1078
1079
1080 sub copy_hold_capture {
1081         my $self = shift;
1082         my $hold = shift;
1083         my $cps = shift;
1084
1085         if (!defined($cps)) {
1086                 try {
1087                         $cps = [ asset::copy->search( id => $hold->target ) ];
1088                 } catch Error with {
1089                         my $e = shift;
1090                         die "Could not retrieve initial volume list:\n\n$e\n";
1091                 };
1092         }
1093
1094         my @copies = grep { $_->holdable } @$cps;
1095
1096         for (my $i = 0; $i < @$cps; $i++) {
1097                 next unless $$cps[$i];
1098                 
1099                 my $cn = $cache{cns}{$copies[$i]->call_number};
1100                 my $rec = $cache{titles}{$cn->record};
1101                 $copies[$i] = undef if ($copies[$i] && !grep{ $copies[$i]->status eq $_->id}@$statuses);
1102                 $copies[$i] = undef if ($copies[$i] && !grep{ $copies[$i]->location eq $_->id}@$locations);
1103                 $copies[$i] = undef if (
1104                         !$copies[$i] ||
1105                         !$self->{user_filter}->request(
1106                                 'open-ils.circ.permit_hold',
1107                                 $hold->to_fieldmapper, do {
1108                                         my $cp_fm = $copies[$i]->to_fieldmapper;
1109                                         $cp_fm->circ_lib( $copies[$i]->circ_lib->to_fieldmapper );
1110                                         $cp_fm->location( $copies[$i]->location->to_fieldmapper );
1111                                         $cp_fm->status( $copies[$i]->status->to_fieldmapper );
1112                                         $cp_fm;
1113                                 },
1114                                 { title => $rec->to_fieldmapper,
1115                                   usr => actor::user->retrieve($hold->usr)->to_fieldmapper,
1116                                   requestor => actor::user->retrieve($hold->requestor)->to_fieldmapper,
1117                                 })->gather(1)
1118                 );
1119                 $self->{client}->status( new OpenSRF::DomainObject::oilsContinueStatus );
1120         }
1121
1122         @copies = grep { $_ } @copies;
1123
1124         my $count = @copies;
1125
1126         return unless ($count);
1127         
1128         action::hold_copy_map->search( hold => $hold->id )->delete_all;
1129         
1130         my @maps;
1131         $self->{client}->respond( "\tMapping ".scalar(@copies)." eligable copies for hold ".$hold->id."\n");
1132         for my $c (@copies) {
1133                 push @maps, action::hold_copy_map->create( { hold => $hold->id, target_copy => $c->id } );
1134         }
1135         $self->{client}->respond( "\tA total of ".scalar(@maps)." mapping were created for hold ".$hold->id."\n");
1136
1137         return \@copies;
1138 }
1139
1140
1141 sub choose_nearest_copy {
1142         my $hold = shift;
1143         my $prox_list = shift;
1144
1145         for my $p ( 0 .. int( scalar(@$prox_list) - 1) ) {
1146                 next unless (ref $$prox_list[$p]);
1147
1148                 my @capturable = grep { $_->status == 0 || $_->status == 7 } @{ $$prox_list[$p] };
1149                 next unless (@capturable);
1150
1151                 my $rand = int(rand(scalar(@capturable)));
1152                 while (my ($c) = splice(@capturable,$rand)) {
1153                         unless ( OpenILS::Utils::PermitHold::permit_copy_hold(
1154                                 { title => $c->call_number->record->to_fieldmapper,
1155                                   title_descriptor => $c->call_number->record->record_descriptor->next->to_fieldmapper,
1156                                   patron => $hold->usr->to_fieldmapper,
1157                                   copy => $c->to_fieldmapper,
1158                                   requestor => $hold->requestor->to_fieldmapper,
1159                                   request_lib => $hold->request_lib->to_fieldmapper,
1160                                 }
1161                         )) {
1162                                 last unless(@capturable);
1163                                 $rand = int(rand(scalar(@capturable)));
1164                                 next;
1165                         }
1166                         return $c;
1167                 }
1168         }
1169 }
1170
1171 sub create_prox_list {
1172         my $self = shift;
1173         my $lib = shift;
1174         my $copies = shift;
1175
1176         my @prox_list;
1177         for my $cp (@$copies) {
1178                 my ($prox) = $self->method_lookup('open-ils.storage.asset.copy.proximity')->run( $cp, $lib );
1179                 next unless (defined($prox));
1180                 $prox_list[$prox] = [] unless defined($prox_list[$prox]);
1181                 push @{$prox_list[$prox]}, $cp;
1182         }
1183         return \@prox_list;
1184 }
1185
1186 sub volume_hold_capture {
1187         my $self = shift;
1188         my $hold = shift;
1189         my $vols = shift;
1190
1191         if (!defined($vols)) {
1192                 try {
1193                         $vols = [ asset::call_number->search( id => $hold->target ) ];
1194                         $cache{cns}{$_->id} = $_ for (@$vols);
1195                 } catch Error with {
1196                         my $e = shift;
1197                         die "Could not retrieve initial volume list:\n\n$e\n";
1198                 };
1199         }
1200
1201         my @v_ids = map { $_->id } @$vols;
1202
1203         my $cp_list;
1204         try {
1205                 $cp_list = [ asset::copy->search( call_number => \@v_ids ) ];
1206         
1207         } catch Error with {
1208                 my $e = shift;
1209                 warn "Could not retrieve copy list:\n\n$e\n";
1210         };
1211
1212         $self->copy_hold_capture($hold,$cp_list) if (ref $cp_list and @$cp_list);
1213 }
1214
1215 sub title_hold_capture {
1216         my $self = shift;
1217         my $hold = shift;
1218         my $titles = shift;
1219
1220         if (!defined($titles)) {
1221                 try {
1222                         $titles = [ biblio::record_entry->search( id => $hold->target ) ];
1223                         $cache{titles}{$_->id} = $_ for (@$titles);
1224                 } catch Error with {
1225                         my $e = shift;
1226                         die "Could not retrieve initial title list:\n\n$e\n";
1227                 };
1228         }
1229
1230         my @t_ids = map { $_->id } @$titles;
1231         my $cn_list;
1232         try {
1233                 ($cn_list) = $self->method_lookup('open-ils.storage.direct.asset.call_number.search.record.atomic')->run( \@t_ids );
1234         
1235         } catch Error with {
1236                 my $e = shift;
1237                 warn "Could not retrieve volume list:\n\n$e\n";
1238         };
1239
1240         $cache{cns}{$_->id} = $_ for (@$cn_list);
1241
1242         $self->volume_hold_capture($hold,$cn_list) if (ref $cn_list and @$cn_list);
1243 }
1244
1245 sub metarecord_hold_capture {
1246         my $self = shift;
1247         my $hold = shift;
1248
1249         my $titles;
1250         try {
1251                 $titles = [ metabib::metarecord_source_map->search( metarecord => $hold->target) ];
1252         
1253         } catch Error with {
1254                 my $e = shift;
1255                 die "Could not retrieve initial title list:\n\n$e\n";
1256         };
1257
1258         try {
1259                 my @recs = map {$_->record} metabib::record_descriptor->search( record => $titles, item_type => [split '', $hold->holdable_formats] ); 
1260
1261                 $titles = [ biblio::record_entry->search( id => \@recs ) ];
1262         
1263         } catch Error with {
1264                 my $e = shift;
1265                 die "Could not retrieve format-pruned title list:\n\n$e\n";
1266         };
1267
1268
1269         $cache{titles}{$_->id} = $_ for (@$titles);
1270         $self->title_hold_capture($hold,$titles) if (ref $titles and @$titles);
1271 }
1272
1273 1;