potential speedup
[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 $select = <<"        SQL";
313                 SELECT  h.*
314                   FROM  $h_table h
315                         JOIN $a_table a ON (h.current_copy = a.id)
316                   WHERE a.circ_lib = ?
317                         AND h.capture_time IS NULL
318                         AND h.cancel_time IS NULL
319                   ORDER BY h.request_time ASC
320                   LIMIT $limit
321                   OFFSET $offset
322         SQL
323
324         my $sth = action::survey->db_Main->prepare_cached($select);
325         $sth->execute($ou);
326
327         $client->respond( $_->to_fieldmapper ) for ( map { action::hold_request->construct($_) } $sth->fetchall_hash );
328
329         return undef;
330 }
331 __PACKAGE__->register_method(
332         api_name        => 'open-ils.storage.direct.action.hold_request.pull_list.search.current_copy_circ_lib',
333         api_level       => 1,
334         stream          => 1,
335         signature       => [
336                 "Returns the holds for a specific library's pull list.",
337                 [ [org_unit => "The library's org id", "number"],
338                   [limit => 'An optional page size, defaults to 10', 'number'],
339                   [offset => 'Offset for paging, defaults to 0, 0 based', 'number'],
340                 ],
341                 ['A list of holds for the stated library to pull for', 'array']
342         ],
343         method          => 'hold_pull_list',
344 );
345
346 sub find_optional_surveys {
347         my $self = shift;
348         my $client = shift;
349         my $ou = ''.shift();
350
351         return undef unless ($ou);
352         my $s_table = action::survey->table;
353
354         my $select = <<"        SQL";
355                 SELECT  s.*
356                   FROM  $s_table s
357                         JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
358                   WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
359                         AND s.required IS FALSE;
360         SQL
361
362         my $sth = action::survey->db_Main->prepare_cached($select);
363         $sth->execute($ou);
364
365         $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
366
367         return undef;
368 }
369 __PACKAGE__->register_method(
370         api_name        => 'open-ils.storage.action.survey.optional',
371         api_level       => 1,
372         stream          => 1,
373         method          => 'find_optional_surveys',
374 );
375
376 sub find_required_surveys {
377         my $self = shift;
378         my $client = shift;
379         my $ou = ''.shift();
380
381         return undef unless ($ou);
382         my $s_table = action::survey->table;
383
384         my $select = <<"        SQL";
385                 SELECT  s.*
386                   FROM  $s_table s
387                         JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
388                   WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
389                         AND s.required IS TRUE;
390         SQL
391
392         my $sth = action::survey->db_Main->prepare_cached($select);
393         $sth->execute($ou);
394
395         $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
396
397         return undef;
398 }
399 __PACKAGE__->register_method(
400         api_name        => 'open-ils.storage.action.survey.required',
401         api_level       => 1,
402         stream          => 1,
403         method          => 'find_required_surveys',
404 );
405
406 sub find_usr_summary_surveys {
407         my $self = shift;
408         my $client = shift;
409         my $ou = ''.shift();
410
411         return undef unless ($ou);
412         my $s_table = action::survey->table;
413
414         my $select = <<"        SQL";
415                 SELECT  s.*
416                   FROM  $s_table s
417                         JOIN actor.org_unit_full_path(?) p ON (p.id = s.owner)
418                   WHERE CURRENT_TIMESTAMP BETWEEN s.start_date AND s.end_date
419                         AND s.usr_summary IS TRUE;
420         SQL
421
422         my $sth = action::survey->db_Main->prepare_cached($select);
423         $sth->execute($ou);
424
425         $client->respond( $_->to_fieldmapper ) for ( map { action::survey->construct($_) } $sth->fetchall_hash );
426
427         return undef;
428 }
429 __PACKAGE__->register_method(
430         api_name        => 'open-ils.storage.action.survey.usr_summary',
431         api_level       => 1,
432         stream          => 1,
433         method          => 'find_usr_summary_surveys',
434 );
435
436
437 sub generate_fines {
438         my $self = shift;
439         my $client = shift;
440         my $grace = shift;
441         my $circ = shift;
442         my $overbill = shift;
443
444         local $OpenILS::Application::Storage::WRITE = 1;
445
446         my @circs;
447         if ($circ) {
448                 push @circs, action::circulation->search_where( { id => $circ, stop_fines => undef } );
449         } else {
450                 push @circs, overdue_circs($grace);
451         }
452
453         my %hoo = map { ( $_->id => $_ ) } actor::org_unit::hours_of_operation->retrieve_all;
454
455         my $penalty = OpenSRF::AppSession->create('open-ils.penalty');
456         for my $c (@circs) {
457         
458                 try {
459                         if ($self->method_lookup('open-ils.storage.transaction.current')->run) {
460                                 $log->debug("Cleaning up after previous transaction\n");
461                                 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
462                         }
463                         $self->method_lookup('open-ils.storage.transaction.begin')->run( $client );
464                         $log->info("Processing circ ".$c->id."...\n");
465
466
467                         my $due_dt = $parser->parse_datetime( clense_ISO8601( $c->due_date ) );
468         
469                         my $due = $due_dt->epoch;
470                         my $now = time;
471                         my $fine_interval = interval_to_seconds( $c->fine_interval );
472         
473                         if ( interval_to_seconds( $c->fine_interval ) >= interval_to_seconds('1d') ) {  
474                                 my $tz_offset_s = 0;
475                                 if ($due_dt->strftime('%z') =~ /(-|\+)(\d{2}):?(\d{2})/) {
476                                         $tz_offset_s = $1 . interval_to_seconds( "${2}h ${3}m"); 
477                                 }
478         
479                                 $due -= ($due % $fine_interval) + $tz_offset_s;
480                                 $now -= ($now % $fine_interval) + $tz_offset_s;
481                         }
482         
483                         $client->respond(
484                                 "ARG! Overdue circulation ".$c->id.
485                                 " for item ".$c->target_copy.
486                                 " (user ".$c->usr.").\n".
487                                 "\tItem was due on or before: ".localtime($due)."\n");
488         
489                         my @fines = money::billing->search_where(
490                                 { xact => $c->id, billing_type => 'Overdue materials' },
491                                 { order_by => 'billing_ts DESC'}
492                         );
493
494                         my $f_idx = 0;
495                         my $fine = $fines[$f_idx] if (@fines);
496                         if ($overbill) {
497                                 $fine = $fines[++$f_idx] while ($fine and $fine->voided);
498                         }
499
500                         my $current_fine_total = 0;
501                         $current_fine_total += $_->amount for (grep { $_ and !$_->voided } @fines);
502         
503                         my $last_fine;
504                         if ($fine) {
505                                 $client->respond( "Last billing time: ".$fine->billing_ts." (clensed fromat: ".clense_ISO8601( $fine->billing_ts ).")");
506                                 $last_fine = $parser->parse_datetime( clense_ISO8601( $fine->billing_ts ) )->epoch;
507                         } else {
508                                 $last_fine = $due;
509
510                                 # XXX There is some contention over this ... it basically makes the grace period "hard" (non-fining)
511                                 #$last_fine += $fine_interval * $grace;
512                         }
513         
514                         my $pending_fine_count = int( ($now - $last_fine) / $fine_interval ) - 1; 
515                         if ($pending_fine_count < 1) {
516                                 $client->respond( "\tNo fines to create.  " );
517                                 if ($grace && $now < $due + $fine_interval * $grace) {
518                                         $client->respond( "Still inside grace period of: ". seconds_to_interval( $fine_interval * $grace)."\n" );
519                                 } else {
520                                         $client->respond( "Last fine generated for: ".localtime($last_fine)."\n" );
521                                 }
522                                 next;
523                         }
524         
525                         $client->respond( "\t$pending_fine_count pending fine(s)\n" );
526         
527                         for (my $bill = 1; $bill <= $pending_fine_count; $bill++) {
528         
529                                 if ($current_fine_total > $c->max_fine) {
530                                         $c->update({stop_fines => 'MAXFINES'});
531                                         $client->respond(
532                                                 "\tMaximum fine level of ".$c->max_fine.
533                                                 " reached for this circulation.\n".
534                                                 "\tNo more fines will be generated.\n" );
535                                         last;
536                                 }
537                                 
538                                 my $billing_ts = DateTime->from_epoch( epoch => $last_fine + $fine_interval * $bill );
539
540                                 my $dow = $billing_ts->dow;
541                                 my $dow_open = "dow_${dow}_open";
542                                 my $dow_close = "dow_${dow}_close";
543
544                                 if (my $h = $hoo{$c->circ_lib}) {
545                                         next if ( $h->$dow_open eq '00:00:00' and $h->$dow_close eq '00:00:00');
546                                 }
547
548                                 my $timestamptz = $billing_ts->strftime('%FT%T%z');
549                                 my @cl = actor::org_unit::closed_date->search_where(
550                                                 { close_start   => { '<=' => $timestamptz },
551                                                   close_end     => { '>=' => $timestamptz },
552                                                   org_unit      => $c->circ_lib }
553                                 );
554                                 next if (@cl);
555         
556                                 my $billing = money::billing->create(
557                                         { xact          => ''.$c->id,
558                                           note          => "System Generated Overdue Fine",
559                                           billing_type  => "Overdue materials",
560                                           amount        => ''.$c->recuring_fine,
561                                           billing_ts    => $timestamptz,
562                                         }
563                                 );
564
565                                 $current_fine_total += $billing->amount;
566         
567                                 $client->respond( "\t\tCreating fine of ".$billing->amount." for period starting ".$billing->billing_ts."\n" );
568                         }
569
570                         $self->method_lookup('open-ils.storage.transaction.commit')->run;
571
572                         $penalty->request(
573                                 'open-ils.penalty.patron_penalty.calculate',
574                                 { patron        => $c->usr->to_fieldmapper,
575                                   update        => 1,
576                                   background    => 1,
577                                 }
578                         )->gather(1);
579
580                 } catch Error with {
581                         my $e = shift;
582                         $client->respond( "Error processing overdue circulation [".$c->id."]:\n\n$e\n" );
583                         $log->error("Error processing overdue circulation [".$c->id."]:\n$e\n");
584                         $self->method_lookup('open-ils.storage.transaction.rollback')->run;
585                 };
586         }
587 }
588 __PACKAGE__->register_method(
589         api_name        => 'open-ils.storage.action.circulation.overdue.generate_fines',
590         api_level       => 1,
591         stream          => 1,
592         method          => 'generate_fines',
593 );
594
595
596
597 sub new_hold_copy_targeter {
598         my $self = shift;
599         my $client = shift;
600         my $check_expire = shift;
601         my $one_hold = shift;
602
603         local $OpenILS::Application::Storage::WRITE = 1;
604
605         my $holds;
606
607         try {
608                 if ($one_hold) {
609                         $holds = [ action::hold_request->search_where( { id => $one_hold, fulfillment_time => undef, cancel_time => undef } ) ];
610                 } elsif ( $check_expire ) {
611
612                         my $time = time;
613                         $check_expire ||= '12h';
614                         $check_expire = interval_to_seconds( $check_expire );
615
616                         my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = gmtime(time() - $check_expire);
617                         $year += 1900;
618                         $mon += 1;
619                         my $expire_threshold = sprintf(
620                                 '%s-%0.2d-%0.2dT%0.2d:%0.2d:%0.2d-00',
621                                 $year, $mon, $mday, $hour, $min, $sec
622                         );
623
624                         $holds = [ action::hold_request->search_where(
625                                                         { capture_time => undef,
626                                                           fulfillment_time => undef,
627                                                           cancel_time => undef,
628                                                           prev_check_time => { '<=' => $expire_threshold },
629                                                         },
630                                                         { order_by => 'selection_depth DESC, request_time,prev_check_time' } ) ];
631                         push @$holds, action::hold_request->search(
632                                                         capture_time => undef,
633                                                         fulfillment_time => undef,
634                                                         prev_check_time => undef,
635                                                         cancel_time => undef,
636                                                         { order_by => 'selection_depth DESC, request_time' } );
637                 } else {
638                         $holds = [ action::hold_request->search(
639                                                         capture_time => undef,
640                                                         fulfillment_time => undef,
641                                                         prev_check_time => undef,
642                                                         cancel_time => undef,
643                                                         { order_by => 'selection_depth DESC, request_time' } ) ];
644                 }
645         } catch Error with {
646                 my $e = shift;
647                 die "Could not retrieve uncaptured hold requests:\n\n$e\n";
648         };
649
650         my @successes;
651
652         for my $hold (@$holds) {
653                 try {
654                         #action::hold_request->db_Main->begin_work;
655                         if ($self->method_lookup('open-ils.storage.transaction.current')->run) {
656                                 $log->debug("Cleaning up after previous transaction\n");
657                                 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
658                         }
659                         $self->method_lookup('open-ils.storage.transaction.begin')->run( $client );
660                         $log->info("Processing hold ".$hold->id."...\n");
661
662                         my @oldmaps = action::hold_copy_map->search( hold => $hold->id );
663                         $_->delete for (@oldmaps);
664
665         
666                         my $all_copies = [];
667
668                         my ($types, $formats, $lang) = split '-', $hold->holdable_formats;
669
670                         # find all the potential copies
671                         if ($hold->hold_type eq 'M') {
672                                 for my $r ( map
673                                                 {$_->record}
674                                                 metabib::record_descriptor
675                                                         ->search(
676                                                                 record => [ map { $_->id } metabib::metarecord->retrieve($hold->target)->source_records ],
677                                                                 ( $types   ? (item_type => [split '', $types])   : () ),
678                                                                 ( $formats ? (item_form => [split '', $formats]) : () ),
679                                                                 ( $lang    ? (item_lang => $lang)                : () ),
680                                                         )
681                                 ) {
682                                         my ($rtree) = $self
683                                                 ->method_lookup( 'open-ils.storage.biblio.record_entry.ranged_tree')
684                                                 ->run( $r->id, $hold->selection_ou, $hold->selection_depth );
685
686                                         for my $cn ( @{ $rtree->call_numbers } ) {
687                                                 push @$all_copies,
688                                                         asset::copy->search( id => [map {$_->id} @{ $cn->copies }] );
689                                         }
690                                 }
691                         } elsif ($hold->hold_type eq 'T') {
692                                 my ($rtree) = $self
693                                         ->method_lookup( 'open-ils.storage.biblio.record_entry.ranged_tree')
694                                         ->run( $hold->target, $hold->selection_ou, $hold->selection_depth );
695
696                                 unless ($rtree) {
697                                         push @successes, { hold => $hold->id, eligible_copies => 0, error => 'NO_RECORD' };
698                                         die 'OK';
699                                 }
700
701                                 for my $cn ( @{ $rtree->call_numbers } ) {
702                                         push @$all_copies,
703                                                 asset::copy->search( id => [map {$_->id} @{ $cn->copies }] );
704                                 }
705                         } elsif ($hold->hold_type eq 'V') {
706                                 my ($vtree) = $self
707                                         ->method_lookup( 'open-ils.storage.asset.call_number.ranged_tree')
708                                         ->run( $hold->target, $hold->selection_ou, $hold->selection_depth );
709
710                                 push @$all_copies,
711                                         asset::copy->search( id => [map {$_->id} @{ $vtree->copies }] );
712                                         
713                         } elsif  ($hold->hold_type eq 'C') {
714
715                                 $all_copies = [asset::copy->retrieve($hold->target)];
716                         }
717
718                         @$all_copies = grep {   $_->status->holdable && 
719                                                 $_->location->holdable && 
720                                                 $_->holdable
721                                         } @$all_copies;
722
723                         # let 'em know we're still working
724                         $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
725                         
726                         if (!ref $all_copies || !@$all_copies) {
727                                 $log->info("\tNo copies available for targeting at all!\n");
728                                 $self->method_lookup('open-ils.storage.transaction.commit')->run;
729                                 push @successes, { hold => $hold->id, eligible_copies => 0, error => 'NO_COPIES' };
730                                 die 'OK';
731                         }
732
733                         my $copy_count = @$all_copies;
734
735                         # map the potentials, so that we can pick up checkins
736                         $log->debug( "\tMapping ".scalar(@$all_copies)." potential copies for hold ".$hold->id);
737                         action::hold_copy_map->create( { hold => $hold->id, target_copy => $_->id } ) for (@$all_copies);
738
739                         $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
740
741                         my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime();
742                         $year += 1900;
743                         $mon += 1;
744                         my $today= sprintf( '%s-%0.2d-%0.2d', $year, $mon, $mday );
745
746                         my @closed = actor::org_unit::closed_date->search_where(
747                                 { close_start => { '<=', $today },
748                                   close_end => { '>=', $today } }
749                         );
750
751                         my @good_copies;
752                         for my $c (@$all_copies) {
753                                 next if ($c->id == $hold->current_copy);
754                                 next if ( grep { ''.$_->org_unit == ''.$c->circ_lib } @closed );
755                                 next if (action::hold_request
756                                                 ->search_where(
757                                                         { current_copy => $c->id,
758                                                           capture_time => undef,
759                                                           cancel_time => undef,
760                                                         }
761                                                 )
762                                 );
763                                 push @good_copies, $c if ($c);
764                                 $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
765                         }
766
767                         $log->debug("\t".scalar(@good_copies)." (non-current) copies available for targeting...");
768
769                         my $old_best = $hold->current_copy;
770                         $hold->update({ current_copy => undef });
771         
772                         if (!scalar(@good_copies)) {
773                                 $log->info("\tNo (non-current) copies eligible to fill the hold.");
774                                 if (
775                                   $old_best &&
776                                   grep { $old_best eq $_ } @$all_copies &&
777                                   !action::hold_request->search_where({ current_copy => $old_best->id, capture_time => undef, cancel_time => undef })
778                                 ) {
779                                         $log->debug("\tPushing current_copy back onto the targeting list");
780                                         push @good_copies, $old_best;
781                                 } else {
782                                         $log->debug("\tcurrent_copy is no longer available for targeting... NEXT HOLD, PLEASE!");
783                                         $self->method_lookup('open-ils.storage.transaction.commit')->run;
784                                         push @successes, { hold => $hold->id, eligible_copies => 0, error => 'NO_TARGETS' };
785                                         die 'OK';
786                                 }
787                         }
788
789                         $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
790                         my $prox_list = [];
791                         $$prox_list[0] =
792                         [
793                                 grep {
794                                         $_->circ_lib == $hold->pickup_lib
795                                 } @good_copies
796                         ];
797
798                         $all_copies = [grep {$_->circ_lib != $hold->pickup_lib } @good_copies];
799
800                         $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
801                         my $best = choose_nearest_copy($hold, $prox_list);
802                         $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
803
804                         if (!$best) {
805                                 $log->debug("\tNothing at the pickup lib, looking elsewhere among ".scalar(@$all_copies)." copies");
806                                 $prox_list = create_prox_list( $self, $hold->pickup_lib, $all_copies );
807
808                                 $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
809
810                                 $best = choose_nearest_copy($hold, $prox_list);
811                         }
812
813                         $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
814                         if ($old_best) {
815                                 # hold wasn't fulfilled, record the fact
816                         
817                                 $log->info("\tHold was not (but should have been) fulfilled by ".$old_best->id);
818                                 action::unfulfilled_hold_list->create(
819                                                 { hold => ''.$hold->id,
820                                                   current_copy => ''.$old_best->id,
821                                                   circ_lib => ''.$old_best->circ_lib,
822                                                 });
823                         }
824
825                         if ($best) {
826                                 $hold->update( { current_copy => ''.$best->id } );
827                                 $log->debug("\tUpdating hold [".$hold->id."] with new 'current_copy' [".$best->id."] for hold fulfillment.");
828                         } else {
829                                 $log->info( "\tThere were no targetable copies for the hold" );
830                         }
831
832                         $hold->update( { prev_check_time => 'now' } );
833
834                         $self->method_lookup('open-ils.storage.transaction.commit')->run;
835                         $log->info("\tProcessing of hold ".$hold->id." complete.");
836
837                         push @successes,
838                                 { hold => $hold->id,
839                                   old_target => ($old_best ? $old_best->id : undef),
840                                   eligible_copies => $copy_count,
841                                   target => ($best ? $best->id : undef) };
842
843                 } otherwise {
844                         my $e = shift;
845                         if ($e !~ /^OK/o) {
846                                 $log->error("Processing of hold failed:  $e");
847                                 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
848                         }
849                 };
850         }
851
852         return \@successes;
853 }
854 __PACKAGE__->register_method(
855         api_name        => 'open-ils.storage.action.hold_request.copy_targeter',
856         api_level       => 1,
857         method          => 'new_hold_copy_targeter',
858 );
859
860 my $locations;
861 my $statuses;
862 my %cache = (titles => {}, cns => {});
863 sub hold_copy_targeter {
864         my $self = shift;
865         my $client = shift;
866         my $check_expire = shift;
867         my $one_hold = shift;
868
869         $self->{user_filter} = OpenSRF::AppSession->create('open-ils.circ');
870         $self->{user_filter}->connect;
871         $self->{client} = $client;
872
873         my $time = time;
874         $check_expire ||= '12h';
875         $check_expire = interval_to_seconds( $check_expire );
876
877         my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = gmtime(time() - $check_expire);
878         $year += 1900;
879         $mon += 1;
880         my $expire_threshold = sprintf(
881                 '%s-%0.2d-%0.2dT%0.2d:%0.2d:%0.2d-00',
882                 $year, $mon, $mday, $hour, $min, $sec
883         );
884
885
886         $statuses ||= [ config::copy_status->search(holdable => 't') ];
887
888         $locations ||= [ asset::copy_location->search(holdable => 't') ];
889
890         my $holds;
891
892         %cache = (titles => {}, cns => {});
893
894         try {
895                 if ($one_hold) {
896                         $holds = [ action::hold_request->search(id => $one_hold) ];
897                 } else {
898                         $holds = [ action::hold_request->search_where(
899                                                         { capture_time => undef,
900                                                           prev_check_time => { '<=' => $expire_threshold },
901                                                         },
902                                                         { order_by => 'request_time,prev_check_time' } ) ];
903                         push @$holds, action::hold_request->search_where(
904                                                         { capture_time => undef,
905                                                           prev_check_time => undef,
906                                                         },
907                                                         { order_by => 'request_time' } );
908                 }
909         } catch Error with {
910                 my $e = shift;
911                 die "Could not retrieve uncaptured hold requests:\n\n$e\n";
912         };
913
914         for my $hold (@$holds) {
915                 try {
916                         #action::hold_request->db_Main->begin_work;
917                         if ($self->method_lookup('open-ils.storage.transaction.current')->run) {
918                                 $client->respond("Cleaning up after previous transaction\n");
919                                 $self->method_lookup('open-ils.storage.transaction.rollback')->run;
920                         }
921                         $self->method_lookup('open-ils.storage.transaction.begin')->run( $client );
922                         $client->respond("Processing hold ".$hold->id."...\n");
923
924                         my $copies;
925
926                         $copies = $self->metarecord_hold_capture($hold) if ($hold->hold_type eq 'M');
927                         $self->{client}->status( new OpenSRF::DomainObject::oilsContinueStatus );
928
929                         $copies = $self->title_hold_capture($hold) if ($hold->hold_type eq 'T');
930                         $self->{client}->status( new OpenSRF::DomainObject::oilsContinueStatus );
931                         
932                         $copies = $self->volume_hold_capture($hold) if ($hold->hold_type eq 'V');
933                         $self->{client}->status( new OpenSRF::DomainObject::oilsContinueStatus );
934                         
935                         $copies = $self->copy_hold_capture($hold) if ($hold->hold_type eq 'C');
936
937                         unless (ref $copies || !@$copies) {
938                                 $client->respond("\tNo copies available for targeting at all!\n");
939                         }
940
941                         my @good_copies;
942                         for my $c (@$copies) {
943                                 next if ( grep {$c->id == $hold->current_copy} @good_copies);
944                                 push @good_copies, $c if ($c);
945                         }
946
947                         $client->respond("\t".scalar(@good_copies)." (non-current) copies available for targeting...\n");
948
949                         my $old_best = $hold->current_copy;
950                         $hold->update({ current_copy => undef });
951         
952                         if (!scalar(@good_copies)) {
953                                 $client->respond("\tNo (non-current) copies available to fill the hold.\n");
954                                 if ( $old_best && grep {$c->id == $hold->current_copy} @$copies ) {
955                                         $client->respond("\tPushing current_copy back onto the targeting list\n");
956                                         push @good_copies, asset::copy->retrieve( $old_best );
957                                 } else {
958                                         $client->respond("\tcurrent_copy is no longer available for targeting... NEXT HOLD, PLEASE!\n");
959                                         next;
960                                 }
961                         }
962
963                         my $prox_list;
964                         $$prox_list[0] = [grep {$_->circ_lib == $hold->pickup_lib } @good_copies];
965                         $copies = [grep {$_->circ_lib != $hold->pickup_lib } @good_copies];
966
967                         my $best = choose_nearest_copy($hold, $prox_list);
968
969                         if (!$best) {
970                                 $prox_list = create_prox_list( $self, $hold->pickup_lib, $copies );
971                                 $best = choose_nearest_copy($hold, $prox_list);
972                         }
973
974                         if ($old_best) {
975                                 # hold wasn't fulfilled, record the fact
976                         
977                                 $client->respond("\tHold was not (but should have been) fulfilled by ".$old_best->id.".\n");
978                                 action::unfulfilled_hold_list->create(
979                                                 { hold => ''.$hold->id,
980                                                   current_copy => ''.$old_best->id,
981                                                   circ_lib => ''.$old_best->circ_lib,
982                                                 });
983                         }
984
985                         if ($best) {
986                                 $hold->update( { current_copy => ''.$best->id } );
987                                 $client->respond("\tTargeting copy ".$best->id." for hold fulfillment.\n");
988                         }
989
990                         $hold->update( { prev_check_time => 'now' } );
991                         $client->respond("\tUpdating hold ".$hold->id." with new 'current_copy' for hold fulfillment.\n");
992
993                         $client->respond("\tProcessing of hold ".$hold->id." complete.\n");
994                         $self->method_lookup('open-ils.storage.transaction.commit')->run;
995
996                         #action::hold_request->dbi_commit;
997
998                 } otherwise {
999                         my $e = shift;
1000                         $log->error("Processing of hold failed:  $e");
1001                         $client->respond("\tProcessing of hold failed!.\n\t\t$e\n");
1002                         $self->method_lookup('open-ils.storage.transaction.rollback')->run;
1003                         #action::hold_request->dbi_rollback;
1004                 };
1005         }
1006
1007         $self->{user_filter}->disconnect;
1008         $self->{user_filter}->finish;
1009         delete $$self{user_filter};
1010         return undef;
1011 }
1012 __PACKAGE__->register_method(
1013         api_name        => 'open-ils.storage.action.hold_request.copy_targeter',
1014         api_level       => 0,
1015         stream          => 1,
1016         method          => 'hold_copy_targeter',
1017 );
1018
1019
1020 sub copy_hold_capture {
1021         my $self = shift;
1022         my $hold = shift;
1023         my $cps = shift;
1024
1025         if (!defined($cps)) {
1026                 try {
1027                         $cps = [ asset::copy->search( id => $hold->target ) ];
1028                 } catch Error with {
1029                         my $e = shift;
1030                         die "Could not retrieve initial volume list:\n\n$e\n";
1031                 };
1032         }
1033
1034         my @copies = grep { $_->holdable } @$cps;
1035
1036         for (my $i = 0; $i < @$cps; $i++) {
1037                 next unless $$cps[$i];
1038                 
1039                 my $cn = $cache{cns}{$copies[$i]->call_number};
1040                 my $rec = $cache{titles}{$cn->record};
1041                 $copies[$i] = undef if ($copies[$i] && !grep{ $copies[$i]->status eq $_->id}@$statuses);
1042                 $copies[$i] = undef if ($copies[$i] && !grep{ $copies[$i]->location eq $_->id}@$locations);
1043                 $copies[$i] = undef if (
1044                         !$copies[$i] ||
1045                         !$self->{user_filter}->request(
1046                                 'open-ils.circ.permit_hold',
1047                                 $hold->to_fieldmapper, do {
1048                                         my $cp_fm = $copies[$i]->to_fieldmapper;
1049                                         $cp_fm->circ_lib( $copies[$i]->circ_lib->to_fieldmapper );
1050                                         $cp_fm->location( $copies[$i]->location->to_fieldmapper );
1051                                         $cp_fm->status( $copies[$i]->status->to_fieldmapper );
1052                                         $cp_fm;
1053                                 },
1054                                 { title => $rec->to_fieldmapper,
1055                                   usr => actor::user->retrieve($hold->usr)->to_fieldmapper,
1056                                   requestor => actor::user->retrieve($hold->requestor)->to_fieldmapper,
1057                                 })->gather(1)
1058                 );
1059                 $self->{client}->status( new OpenSRF::DomainObject::oilsContinueStatus );
1060         }
1061
1062         @copies = grep { $_ } @copies;
1063
1064         my $count = @copies;
1065
1066         return unless ($count);
1067         
1068         action::hold_copy_map->search( hold => $hold->id )->delete_all;
1069         
1070         my @maps;
1071         $self->{client}->respond( "\tMapping ".scalar(@copies)." eligable copies for hold ".$hold->id."\n");
1072         for my $c (@copies) {
1073                 push @maps, action::hold_copy_map->create( { hold => $hold->id, target_copy => $c->id } );
1074         }
1075         $self->{client}->respond( "\tA total of ".scalar(@maps)." mapping were created for hold ".$hold->id."\n");
1076
1077         return \@copies;
1078 }
1079
1080
1081 sub choose_nearest_copy {
1082         my $hold = shift;
1083         my $prox_list = shift;
1084
1085         for my $p ( 0 .. int( scalar(@$prox_list) - 1) ) {
1086                 next unless (ref $$prox_list[$p]);
1087
1088                 my @capturable = grep { $_->status == 0 || $_->status == 7 } @{ $$prox_list[$p] };
1089                 next unless (@capturable);
1090
1091                 my $rand = int(rand(scalar(@capturable)));
1092                 while (my ($c) = splice(@capturable,$rand)) {
1093                         unless ( OpenILS::Utils::PermitHold::permit_copy_hold(
1094                                 { title => $c->call_number->record->to_fieldmapper,
1095                                   title_descriptor => $c->call_number->record->record_descriptor->next->to_fieldmapper,
1096                                   patron => $hold->usr->to_fieldmapper,
1097                                   copy => $c->to_fieldmapper,
1098                                   requestor => $hold->requestor->to_fieldmapper,
1099                                   request_lib => $hold->request_lib->to_fieldmapper,
1100                                 }
1101                         )) {
1102                                 last unless(@capturable);
1103                                 $rand = int(rand(scalar(@capturable)));
1104                                 next;
1105                         }
1106                         return $c;
1107                 }
1108         }
1109 }
1110
1111 sub create_prox_list {
1112         my $self = shift;
1113         my $lib = shift;
1114         my $copies = shift;
1115
1116         my @prox_list;
1117         for my $cp (@$copies) {
1118                 my ($prox) = $self->method_lookup('open-ils.storage.asset.copy.proximity')->run( $cp, $lib );
1119                 next unless (defined($prox));
1120                 $prox_list[$prox] = [] unless defined($prox_list[$prox]);
1121                 push @{$prox_list[$prox]}, $cp;
1122         }
1123         return \@prox_list;
1124 }
1125
1126 sub volume_hold_capture {
1127         my $self = shift;
1128         my $hold = shift;
1129         my $vols = shift;
1130
1131         if (!defined($vols)) {
1132                 try {
1133                         $vols = [ asset::call_number->search( id => $hold->target ) ];
1134                         $cache{cns}{$_->id} = $_ for (@$vols);
1135                 } catch Error with {
1136                         my $e = shift;
1137                         die "Could not retrieve initial volume list:\n\n$e\n";
1138                 };
1139         }
1140
1141         my @v_ids = map { $_->id } @$vols;
1142
1143         my $cp_list;
1144         try {
1145                 $cp_list = [ asset::copy->search( call_number => \@v_ids ) ];
1146         
1147         } catch Error with {
1148                 my $e = shift;
1149                 warn "Could not retrieve copy list:\n\n$e\n";
1150         };
1151
1152         $self->copy_hold_capture($hold,$cp_list) if (ref $cp_list and @$cp_list);
1153 }
1154
1155 sub title_hold_capture {
1156         my $self = shift;
1157         my $hold = shift;
1158         my $titles = shift;
1159
1160         if (!defined($titles)) {
1161                 try {
1162                         $titles = [ biblio::record_entry->search( id => $hold->target ) ];
1163                         $cache{titles}{$_->id} = $_ for (@$titles);
1164                 } catch Error with {
1165                         my $e = shift;
1166                         die "Could not retrieve initial title list:\n\n$e\n";
1167                 };
1168         }
1169
1170         my @t_ids = map { $_->id } @$titles;
1171         my $cn_list;
1172         try {
1173                 ($cn_list) = $self->method_lookup('open-ils.storage.direct.asset.call_number.search.record.atomic')->run( \@t_ids );
1174         
1175         } catch Error with {
1176                 my $e = shift;
1177                 warn "Could not retrieve volume list:\n\n$e\n";
1178         };
1179
1180         $cache{cns}{$_->id} = $_ for (@$cn_list);
1181
1182         $self->volume_hold_capture($hold,$cn_list) if (ref $cn_list and @$cn_list);
1183 }
1184
1185 sub metarecord_hold_capture {
1186         my $self = shift;
1187         my $hold = shift;
1188
1189         my $titles;
1190         try {
1191                 $titles = [ metabib::metarecord_source_map->search( metarecord => $hold->target) ];
1192         
1193         } catch Error with {
1194                 my $e = shift;
1195                 die "Could not retrieve initial title list:\n\n$e\n";
1196         };
1197
1198         try {
1199                 my @recs = map {$_->record} metabib::record_descriptor->search( record => $titles, item_type => [split '', $hold->holdable_formats] ); 
1200
1201                 $titles = [ biblio::record_entry->search( id => \@recs ) ];
1202         
1203         } catch Error with {
1204                 my $e = shift;
1205                 die "Could not retrieve format-pruned title list:\n\n$e\n";
1206         };
1207
1208
1209         $cache{titles}{$_->id} = $_ for (@$titles);
1210         $self->title_hold_capture($hold,$titles) if (ref $titles and @$titles);
1211 }
1212
1213 1;