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