Hold current_shelf_lib API for setting/clearing.
[Evergreen.git] / Open-ILS / src / perlmods / lib / OpenILS / Application / Circ / Holds.pm
1 # ---------------------------------------------------------------
2 # Copyright (C) 2005  Georgia Public Library Service 
3 # Bill Erickson <highfalutin@gmail.com>
4
5 # This program is free software; you can redistribute it and/or
6 # modify it under the terms of the GNU General Public License
7 # as published by the Free Software Foundation; either version 2
8 # of the License, or (at your option) any later version.
9
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 # GNU General Public License for more details.
14 # ---------------------------------------------------------------
15
16
17 package OpenILS::Application::Circ::Holds;
18 use base qw/OpenILS::Application/;
19 use strict; use warnings;
20 use OpenILS::Application::AppUtils;
21 use DateTime;
22 use Data::Dumper;
23 use OpenSRF::EX qw(:try);
24 use OpenILS::Perm;
25 use OpenILS::Event;
26 use OpenSRF::Utils;
27 use OpenSRF::Utils::Logger qw(:logger);
28 use OpenILS::Utils::CStoreEditor q/:funcs/;
29 use OpenILS::Utils::PermitHold;
30 use OpenSRF::Utils::SettingsClient;
31 use OpenILS::Const qw/:const/;
32 use OpenILS::Application::Circ::Transit;
33 use OpenILS::Application::Actor::Friends;
34 use DateTime;
35 use DateTime::Format::ISO8601;
36 use OpenSRF::Utils qw/:datetime/;
37 use Digest::MD5 qw(md5_hex);
38 use OpenSRF::Utils::Cache;
39 my $apputils = "OpenILS::Application::AppUtils";
40 my $U = $apputils;
41
42 __PACKAGE__->register_method(
43     method    => "test_and_create_hold_batch",
44     api_name  => "open-ils.circ.holds.test_and_create.batch",
45     stream => 1,
46     signature => {
47         desc => q/This is for batch creating a set of holds where every field is identical except for the targets./,
48         params => [
49             { desc => 'Authentication token', type => 'string' },
50             { desc => 'Hash of named parameters.  Same as for open-ils.circ.title_hold.is_possible, though the pertinent target field is automatically populated based on the hold_type and the specified list of targets.', type => 'object'},
51             { desc => 'Array of target ids', type => 'array' }
52         ],
53         return => {
54             desc => 'Array of hold ID on success, -1 on missing arg, event (or ref to array of events) on error(s)',
55         },
56     }
57 );
58
59 __PACKAGE__->register_method(
60     method    => "test_and_create_hold_batch",
61     api_name  => "open-ils.circ.holds.test_and_create.batch.override",
62     stream => 1,
63     signature => {
64         desc  => '@see open-ils.circ.holds.test_and_create.batch',
65     }
66 );
67
68
69 sub test_and_create_hold_batch {
70         my( $self, $conn, $auth, $params, $target_list ) = @_;
71
72         my $override = 1 if $self->api_name =~ /override/;
73
74         my $e = new_editor(authtoken=>$auth);
75         return $e->die_event unless $e->checkauth;
76     $$params{'requestor'} = $e->requestor->id;
77
78     my $target_field;
79     if ($$params{'hold_type'} eq 'T') { $target_field = 'titleid'; }
80     elsif ($$params{'hold_type'} eq 'C') { $target_field = 'copy_id'; }
81     elsif ($$params{'hold_type'} eq 'R') { $target_field = 'copy_id'; }
82     elsif ($$params{'hold_type'} eq 'F') { $target_field = 'copy_id'; }
83     elsif ($$params{'hold_type'} eq 'I') { $target_field = 'issuanceid'; }
84     elsif ($$params{'hold_type'} eq 'V') { $target_field = 'volume_id'; }
85     elsif ($$params{'hold_type'} eq 'M') { $target_field = 'mrid'; }
86     elsif ($$params{'hold_type'} eq 'P') { $target_field = 'partid'; }
87     else { return undef; }
88
89     foreach (@$target_list) {
90         $$params{$target_field} = $_;
91         my $res;
92         if (! $override) {        
93             ($res) = $self->method_lookup(
94                 'open-ils.circ.title_hold.is_possible')->run($auth, $params);
95         }
96         if ($override || $res->{'success'} == 1) {
97             my $ahr = construct_hold_request_object($params);
98             my ($res2) = $self->method_lookup(
99                 $override
100                 ? 'open-ils.circ.holds.create.override'
101                 : 'open-ils.circ.holds.create'
102             )->run($auth, $ahr);
103             $res2 = {
104                 'target' => $$params{$target_field},
105                 'result' => $res2
106             };
107             $conn->respond($res2);
108         } else {
109             $res = {
110                 'target' => $$params{$target_field},
111                 'result' => $res
112             };
113             $conn->respond($res);
114         }
115     }
116     return undef;
117 }
118
119 sub construct_hold_request_object {
120     my ($params) = @_;
121
122     my $ahr = Fieldmapper::action::hold_request->new;
123     $ahr->isnew('1');
124
125     foreach my $field (keys %{ $params }) {
126         if ($field eq 'depth') { $ahr->selection_depth($$params{$field}); }
127         elsif ($field eq 'patronid') {
128             $ahr->usr($$params{$field}); }
129         elsif ($field eq 'titleid') { $ahr->target($$params{$field}); }
130         elsif ($field eq 'copy_id') { $ahr->target($$params{$field}); }
131         elsif ($field eq 'issuanceid') { $ahr->target($$params{$field}); }
132         elsif ($field eq 'volume_id') { $ahr->target($$params{$field}); }
133         elsif ($field eq 'mrid') { $ahr->target($$params{$field}); }
134         elsif ($field eq 'partid') { $ahr->target($$params{$field}); }
135         else {
136             $ahr->$field($$params{$field});
137         }
138     }
139     return $ahr;
140 }
141
142 __PACKAGE__->register_method(
143     method    => "create_hold_batch",
144     api_name  => "open-ils.circ.holds.create.batch",
145     stream => 1,
146     signature => {
147         desc => q/@see open-ils.circ.holds.create.batch/,
148         params => [
149             { desc => 'Authentication token', type => 'string' },
150             { desc => 'Array of hold objects', type => 'array' }
151         ],
152         return => {
153             desc => 'Array of hold ID on success, -1 on missing arg, event (or ref to array of events) on error(s)',
154         },
155     }
156 );
157
158 __PACKAGE__->register_method(
159     method    => "create_hold_batch",
160     api_name  => "open-ils.circ.holds.create.override.batch",
161     stream => 1,
162     signature => {
163         desc  => '@see open-ils.circ.holds.create.batch',
164     }
165 );
166
167
168 sub create_hold_batch {
169         my( $self, $conn, $auth, $hold_list ) = @_;
170     (my $method = $self->api_name) =~ s/\.batch//og;
171     foreach (@$hold_list) {
172         my ($res) = $self->method_lookup($method)->run($auth, $_);
173         $conn->respond($res);
174     }
175     return undef;
176 }
177
178
179 __PACKAGE__->register_method(
180     method    => "create_hold",
181     api_name  => "open-ils.circ.holds.create",
182     signature => {
183         desc => "Create a new hold for an item.  From a permissions perspective, " .
184                 "the login session is used as the 'requestor' of the hold.  "      . 
185                 "The hold recipient is determined by the 'usr' setting within the hold object. " .
186                 'First we verify the requestor has holds request permissions.  '         .
187                 'Then we verify that the recipient is allowed to make the given hold.  ' .
188                 'If not, we see if the requestor has "override" capabilities.  If not, ' .
189                 'a permission exception is returned.  If permissions allow, we cycle '   .
190                 'through the set of holds objects and create.  '                         .
191                 'If the recipient does not have permission to place multiple holds '     .
192                 'on a single title and said operation is attempted, a permission '       .
193                 'exception is returned',
194         params => [
195             { desc => 'Authentication token',               type => 'string' },
196             { desc => 'Hold object for hold to be created',
197                 type => 'object', class => 'ahr' }
198         ],
199         return => {
200             desc => 'New ahr ID on success, -1 on missing arg, event (or ref to array of events) on error(s)',
201         },
202     }
203 );
204
205 __PACKAGE__->register_method(
206     method    => "create_hold",
207     api_name  => "open-ils.circ.holds.create.override",
208     notes     => '@see open-ils.circ.holds.create',
209     signature => {
210         desc  => "If the recipient is not allowed to receive the requested hold, " .
211                  "call this method to attempt the override",
212         params => [
213             { desc => 'Authentication token',               type => 'string' },
214             {
215                 desc => 'Hold object for hold to be created',
216                 type => 'object', class => 'ahr'
217             }
218         ],
219         return => {
220             desc => 'New hold (ahr) ID on success, -1 on missing arg, event (or ref to array of events) on error(s)',
221         },
222     }
223 );
224
225 sub create_hold {
226         my( $self, $conn, $auth, $hold ) = @_;
227     return -1 unless $hold;
228         my $e = new_editor(authtoken=>$auth, xact=>1);
229         return $e->die_event unless $e->checkauth;
230
231         my $override = 1 if $self->api_name =~ /override/;
232
233     my @events;
234
235     my $requestor = $e->requestor;
236     my $recipient = $requestor;
237
238     if( $requestor->id ne $hold->usr ) {
239         # Make sure the requestor is allowed to place holds for 
240         # the recipient if they are not the same people
241         $recipient = $e->retrieve_actor_user($hold->usr)  or return $e->die_event;
242         $e->allowed('REQUEST_HOLDS', $recipient->home_ou) or return $e->die_event;
243     }
244
245     # If the related org setting tells us to, block if patron privs have expired
246     my $expire_setting = $U->ou_ancestor_setting_value($recipient->home_ou, OILS_SETTING_BLOCK_HOLD_FOR_EXPIRED_PATRON);
247     if ($expire_setting) {
248         my $expire = DateTime::Format::ISO8601->new->parse_datetime(
249             cleanse_ISO8601($recipient->expire_date));
250
251         push( @events, OpenILS::Event->new(
252             'PATRON_ACCOUNT_EXPIRED',
253             "payload" => {"fail_part" => "actor.usr.privs_expired"}
254             )) if( CORE::time > $expire->epoch ) ;
255     }
256
257     # Now make sure the recipient is allowed to receive the specified hold
258     my $porg = $recipient->home_ou;
259     my $rid  = $e->requestor->id;
260     my $t    = $hold->hold_type;
261
262     # See if a duplicate hold already exists
263     my $sargs = {
264         usr                     => $recipient->id, 
265         hold_type       => $t, 
266         fulfillment_time => undef, 
267         target          => $hold->target,
268         cancel_time     => undef,
269     };
270
271     $sargs->{holdable_formats} = $hold->holdable_formats if $t eq 'M';
272         
273     my $existing = $e->search_action_hold_request($sargs); 
274     push( @events, OpenILS::Event->new('HOLD_EXISTS')) if @$existing;
275
276     my $checked_out = hold_item_is_checked_out($e, $recipient->id, $hold->hold_type, $hold->target);
277     push( @events, OpenILS::Event->new('HOLD_ITEM_CHECKED_OUT')) if $checked_out;
278
279     if ( $t eq OILS_HOLD_TYPE_METARECORD ) {
280         return $e->die_event unless $e->allowed('MR_HOLDS',     $porg);
281     } elsif ( $t eq OILS_HOLD_TYPE_TITLE ) {
282         return $e->die_event unless $e->allowed('TITLE_HOLDS',  $porg);
283     } elsif ( $t eq OILS_HOLD_TYPE_VOLUME ) {
284         return $e->die_event unless $e->allowed('VOLUME_HOLDS', $porg);
285     } elsif ( $t eq OILS_HOLD_TYPE_MONOPART ) {
286         return $e->die_event unless $e->allowed('TITLE_HOLDS', $porg);
287     } elsif ( $t eq OILS_HOLD_TYPE_ISSUANCE ) {
288         return $e->die_event unless $e->allowed('ISSUANCE_HOLDS', $porg);
289     } elsif ( $t eq OILS_HOLD_TYPE_COPY ) {
290         return $e->die_event unless $e->allowed('COPY_HOLDS',   $porg);
291     } elsif ( $t eq OILS_HOLD_TYPE_FORCE ) {
292         return $e->die_event unless $e->allowed('COPY_HOLDS',   $porg);
293     } elsif ( $t eq OILS_HOLD_TYPE_RECALL ) {
294         return $e->die_event unless $e->allowed('COPY_HOLDS',   $porg);
295     }
296
297     if( @events ) {
298         if (!$override) {
299             $e->rollback;
300             return \@events;
301         }
302         for my $evt (@events) {
303             next unless $evt;
304             my $name = $evt->{textcode};
305             return $e->die_event unless $e->allowed("$name.override", $porg);
306         }
307     }
308
309     # set the configured expire time
310     unless($hold->expire_time) {
311         my $interval = $U->ou_ancestor_setting_value($recipient->home_ou, OILS_SETTING_HOLD_EXPIRE);
312         if($interval) {
313             my $date = DateTime->now->add(seconds => OpenSRF::Utils::interval_to_seconds($interval));
314             $hold->expire_time($U->epoch2ISO8601($date->epoch));
315         }
316     }
317
318     $hold->requestor($e->requestor->id); 
319     $hold->request_lib($e->requestor->ws_ou);
320     $hold->selection_ou($hold->pickup_lib) unless $hold->selection_ou;
321     $hold = $e->create_action_hold_request($hold) or return $e->die_event;
322
323         $e->commit;
324
325         $conn->respond_complete($hold->id);
326
327     $U->storagereq(
328         'open-ils.storage.action.hold_request.copy_targeter', 
329         undef, $hold->id ) unless $U->is_true($hold->frozen);
330
331         return undef;
332 }
333
334 # makes sure that a user has permission to place the type of requested hold
335 # returns the Perm exception if not allowed, returns undef if all is well
336 sub _check_holds_perm {
337         my($type, $user_id, $org_id) = @_;
338
339         my $evt;
340         if ($type eq "M") {
341                 $evt = $apputils->check_perms($user_id, $org_id, "MR_HOLDS"    );
342         } elsif ($type eq "T") {
343                 $evt = $apputils->check_perms($user_id, $org_id, "TITLE_HOLDS" );
344         } elsif($type eq "V") {
345                 $evt = $apputils->check_perms($user_id, $org_id, "VOLUME_HOLDS");
346         } elsif($type eq "C") {
347                 $evt = $apputils->check_perms($user_id, $org_id, "COPY_HOLDS"  );
348         }
349
350     return $evt if $evt;
351         return undef;
352 }
353
354 # tests if the given user is allowed to place holds on another's behalf
355 sub _check_request_holds_perm {
356         my $user_id = shift;
357         my $org_id  = shift;
358         if (my $evt = $apputils->check_perms(
359                 $user_id, $org_id, "REQUEST_HOLDS")) {
360                 return $evt;
361         }
362 }
363
364 my $ses_is_req_note = 'The login session is the requestor.  If the requestor is different from the user, ' .
365                       'then the requestor must have VIEW_HOLD permissions';
366
367 __PACKAGE__->register_method(
368     method    => "retrieve_holds_by_id",
369     api_name  => "open-ils.circ.holds.retrieve_by_id",
370     signature => {
371         desc   => "Retrieve the hold, with hold transits attached, for the specified ID.  $ses_is_req_note",
372         params => [
373             { desc => 'Authentication token', type => 'string' },
374             { desc => 'Hold ID',              type => 'number' }
375         ],
376         return => {
377             desc => 'Hold object with transits attached, event on error',
378         }
379     }
380 );
381
382
383 sub retrieve_holds_by_id {
384         my($self, $client, $auth, $hold_id) = @_;
385         my $e = new_editor(authtoken=>$auth);
386         $e->checkauth or return $e->event;
387         $e->allowed('VIEW_HOLD') or return $e->event;
388
389         my $holds = $e->search_action_hold_request(
390                 [
391                         { id =>  $hold_id , fulfillment_time => undef }, 
392                         { 
393                 order_by => { ahr => "request_time" },
394                 flesh => 1,
395                 flesh_fields => {ahr => ['notes']}
396             }
397                 ]
398         );
399
400         flesh_hold_transits($holds);
401         flesh_hold_notices($holds, $e);
402         return $holds;
403 }
404
405
406 __PACKAGE__->register_method(
407     method    => "retrieve_holds",
408     api_name  => "open-ils.circ.holds.retrieve",
409     signature => {
410         desc   => "Retrieves all the holds, with hold transits attached, for the specified user.  $ses_is_req_note",
411         params => [
412             { desc => 'Authentication token', type => 'string'  },
413             { desc => 'User ID',              type => 'integer' }
414         ],
415         return => {
416             desc => 'list of holds, event on error',
417         }
418    }
419 );
420
421 __PACKAGE__->register_method(
422     method        => "retrieve_holds",
423     api_name      => "open-ils.circ.holds.id_list.retrieve",
424     authoritative => 1,
425     signature     => {
426         desc   => "Retrieves all the hold IDs, for the specified user.  $ses_is_req_note",
427         params => [
428             { desc => 'Authentication token', type => 'string'  },
429             { desc => 'User ID',              type => 'integer' }
430         ],
431         return => {
432             desc => 'list of holds, event on error',
433         }
434    }
435 );
436
437 __PACKAGE__->register_method(
438     method        => "retrieve_holds",
439     api_name      => "open-ils.circ.holds.canceled.retrieve",
440     authoritative => 1,
441     signature     => {
442         desc   => "Retrieves all the cancelled holds for the specified user.  $ses_is_req_note",
443         params => [
444             { desc => 'Authentication token', type => 'string'  },
445             { desc => 'User ID',              type => 'integer' }
446         ],
447         return => {
448             desc => 'list of holds, event on error',
449         }
450    }
451 );
452
453 __PACKAGE__->register_method(
454     method        => "retrieve_holds",
455     api_name      => "open-ils.circ.holds.canceled.id_list.retrieve",
456     authoritative => 1,
457     signature     => {
458         desc   => "Retrieves list of cancelled hold IDs for the specified user.  $ses_is_req_note",
459         params => [
460             { desc => 'Authentication token', type => 'string'  },
461             { desc => 'User ID',              type => 'integer' }
462         ],
463         return => {
464             desc => 'list of hold IDs, event on error',
465         }
466    }
467 );
468
469
470 sub retrieve_holds {
471     my ($self, $client, $auth, $user_id) = @_;
472
473     my $e = new_editor(authtoken=>$auth);
474     return $e->event unless $e->checkauth;
475     $user_id = $e->requestor->id unless defined $user_id;
476
477     my $notes_filter = {staff => 'f'};
478     my $user = $e->retrieve_actor_user($user_id) or return $e->event;
479     unless($user_id == $e->requestor->id) {
480         if($e->allowed('VIEW_HOLD', $user->home_ou)) {
481             $notes_filter = {staff => 't'}
482         } else {
483             my $allowed = OpenILS::Application::Actor::Friends->friend_perm_allowed(
484                 $e, $user_id, $e->requestor->id, 'hold.view');
485             return $e->event unless $allowed;
486         }
487     } else {
488         # staff member looking at his/her own holds can see staff and non-staff notes
489         $notes_filter = {} if $e->allowed('VIEW_HOLD', $user->home_ou);
490     }
491
492     my $holds_query = {
493         select => {ahr => ['id']},
494         from => 'ahr', 
495         where => {usr => $user_id, fulfillment_time => undef}
496     };
497
498     if($self->api_name =~ /canceled/) {
499
500         # Fetch the canceled holds
501         # order cancelled holds by cancel time, most recent first
502
503         $holds_query->{order_by} = [{class => 'ahr', field => 'cancel_time', direction => 'desc'}];
504
505         my $cancel_age;
506         my $cancel_count = $U->ou_ancestor_setting_value(
507                 $e->requestor->ws_ou, 'circ.holds.canceled.display_count', $e);
508
509         unless($cancel_count) {
510             $cancel_age = $U->ou_ancestor_setting_value(
511                 $e->requestor->ws_ou, 'circ.holds.canceled.display_age', $e);
512
513             # if no settings are defined, default to last 10 cancelled holds
514             $cancel_count = 10 unless $cancel_age;
515         }
516
517         if($cancel_count) { # limit by count
518
519             $holds_query->{where}->{cancel_time} = {'!=' => undef};
520             $holds_query->{limit} = $cancel_count;
521
522         } elsif($cancel_age) { # limit by age
523
524             # find all of the canceled holds that were canceled within the configured time frame
525             my $date = DateTime->now->subtract(seconds => OpenSRF::Utils::interval_to_seconds($cancel_age));
526             $date = $U->epoch2ISO8601($date->epoch);
527             $holds_query->{where}->{cancel_time} = {'>=' => $date};
528         }
529
530     } else {
531
532         # order non-cancelled holds by ready-for-pickup, then active, followed by suspended
533         $holds_query->{order_by} = {ahr => ['shelf_time', 'frozen', 'request_time']};
534         $holds_query->{where}->{cancel_time} = undef;
535     }
536
537     my $hold_ids = $e->json_query($holds_query);
538     $hold_ids = [ map { $_->{id} } @$hold_ids ];
539
540     return $hold_ids if $self->api_name =~ /id_list/;
541
542     my @holds;
543     for my $hold_id ( @$hold_ids ) {
544
545         my $hold = $e->retrieve_action_hold_request($hold_id);
546         $hold->notes($e->search_action_hold_request_note({hold => $hold_id, %$notes_filter}));
547
548         $hold->transit(
549             $e->search_action_hold_transit_copy([
550                 {hold => $hold->id},
551                 {order_by => {ahtc => 'source_send_time desc'}, limit => 1}])->[0]
552         );
553
554         push(@holds, $hold);
555     }
556
557     return \@holds;
558 }
559
560
561 __PACKAGE__->register_method(
562     method   => 'user_hold_count',
563     api_name => 'open-ils.circ.hold.user.count'
564 );
565
566 sub user_hold_count {
567     my ( $self, $conn, $auth, $userid ) = @_;
568     my $e = new_editor( authtoken => $auth );
569     return $e->event unless $e->checkauth;
570     my $patron = $e->retrieve_actor_user($userid)
571         or return $e->event;
572     return $e->event unless $e->allowed( 'VIEW_HOLD', $patron->home_ou );
573     return __user_hold_count( $self, $e, $userid );
574 }
575
576 sub __user_hold_count {
577     my ( $self, $e, $userid ) = @_;
578     my $holds = $e->search_action_hold_request(
579         {
580             usr              => $userid,
581             fulfillment_time => undef,
582             cancel_time      => undef,
583         },
584         { idlist => 1 }
585     );
586
587     return scalar(@$holds);
588 }
589
590
591 __PACKAGE__->register_method(
592     method   => "retrieve_holds_by_pickup_lib",
593     api_name => "open-ils.circ.holds.retrieve_by_pickup_lib",
594     notes    => 
595       "Retrieves all the holds, with hold transits attached, for the specified pickup_ou id."
596 );
597
598 __PACKAGE__->register_method(
599     method   => "retrieve_holds_by_pickup_lib",
600     api_name => "open-ils.circ.holds.id_list.retrieve_by_pickup_lib",
601     notes    => "Retrieves all the hold ids for the specified pickup_ou id. "
602 );
603
604 sub retrieve_holds_by_pickup_lib {
605     my ($self, $client, $login_session, $ou_id) = @_;
606
607     #FIXME -- put an appropriate permission check here
608     #my( $user, $target, $evt ) = $apputils->checkses_requestor(
609     #   $login_session, $user_id, 'VIEW_HOLD' );
610     #return $evt if $evt;
611
612         my $holds = $apputils->simplereq(
613                 'open-ils.cstore',
614                 "open-ils.cstore.direct.action.hold_request.search.atomic",
615                 { 
616                         pickup_lib =>  $ou_id , 
617                         fulfillment_time => undef,
618                         cancel_time => undef
619                 }, 
620                 { order_by => { ahr => "request_time" } }
621     );
622
623     if ( ! $self->api_name =~ /id_list/ ) {
624         flesh_hold_transits($holds);
625         return $holds;
626     }
627     # else id_list
628     return [ map { $_->id } @$holds ];
629 }
630
631
632 __PACKAGE__->register_method(
633     method   => "uncancel_hold",
634     api_name => "open-ils.circ.hold.uncancel"
635 );
636
637 sub uncancel_hold {
638         my($self, $client, $auth, $hold_id) = @_;
639         my $e = new_editor(authtoken=>$auth, xact=>1);
640         return $e->die_event unless $e->checkauth;
641
642         my $hold = $e->retrieve_action_hold_request($hold_id)
643                 or return $e->die_event;
644     return $e->die_event unless $e->allowed('CANCEL_HOLDS', $hold->request_lib);
645
646     if ($hold->fulfillment_time) {
647         $e->rollback;
648         return 0;
649     }
650     unless ($hold->cancel_time) {
651         $e->rollback;
652         return 1;
653     }
654
655     # if configured to reset the request time, also reset the expire time
656     if($U->ou_ancestor_setting_value(
657         $hold->request_lib, 'circ.holds.uncancel.reset_request_time', $e)) {
658
659         $hold->request_time('now');
660         my $interval = $U->ou_ancestor_setting_value($hold->request_lib, OILS_SETTING_HOLD_EXPIRE);
661         if($interval) {
662             my $date = DateTime->now->add(seconds => OpenSRF::Utils::interval_to_seconds($interval));
663             $hold->expire_time($U->epoch2ISO8601($date->epoch));
664         }
665     }
666
667     $hold->clear_cancel_time;
668     $hold->clear_cancel_cause;
669     $hold->clear_cancel_note;
670     $hold->clear_shelf_time;
671     $hold->clear_current_copy;
672     $hold->clear_capture_time;
673     $hold->clear_prev_check_time;
674     $hold->clear_shelf_expire_time;
675         $hold->clear_current_shelf_lib;
676
677     $e->update_action_hold_request($hold) or return $e->die_event;
678     $e->commit;
679
680     $U->storagereq('open-ils.storage.action.hold_request.copy_targeter', undef, $hold_id);
681
682     return 1;
683 }
684
685
686 __PACKAGE__->register_method(
687     method    => "cancel_hold",
688     api_name  => "open-ils.circ.hold.cancel",
689     signature => {
690         desc   => 'Cancels the specified hold.  The login session is the requestor.  If the requestor is different from the usr field ' .
691                   'on the hold, the requestor must have CANCEL_HOLDS permissions. The hold may be either the hold object or the hold id',
692         param  => [
693             {desc => 'Authentication token',  type => 'string'},
694             {desc => 'Hold ID',               type => 'number'},
695             {desc => 'Cause of Cancellation', type => 'string'},
696             {desc => 'Note',                  type => 'string'}
697         ],
698         return => {
699             desc => '1 on success, event on error'
700         }
701     }
702 );
703
704 sub cancel_hold {
705         my($self, $client, $auth, $holdid, $cause, $note) = @_;
706
707         my $e = new_editor(authtoken=>$auth, xact=>1);
708         return $e->die_event unless $e->checkauth;
709
710         my $hold = $e->retrieve_action_hold_request($holdid)
711                 or return $e->die_event;
712
713         if( $e->requestor->id ne $hold->usr ) {
714                 return $e->die_event unless $e->allowed('CANCEL_HOLDS');
715         }
716
717         if ($hold->cancel_time) {
718         $e->rollback;
719         return 1;
720     }
721
722         # If the hold is captured, reset the copy status
723         if( $hold->capture_time and $hold->current_copy ) {
724
725                 my $copy = $e->retrieve_asset_copy($hold->current_copy)
726                         or return $e->die_event;
727
728                 if( $copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF ) {
729          $logger->info("canceling hold $holdid whose item is on the holds shelf");
730 #                       $logger->info("setting copy to status 'reshelving' on hold cancel");
731 #                       $copy->status(OILS_COPY_STATUS_RESHELVING);
732 #                       $copy->editor($e->requestor->id);
733 #                       $copy->edit_date('now');
734 #                       $e->update_asset_copy($copy) or return $e->event;
735
736                 } elsif( $copy->status == OILS_COPY_STATUS_IN_TRANSIT ) {
737
738                         my $hid = $hold->id;
739                         $logger->warn("! canceling hold [$hid] that is in transit");
740                         my $transid = $e->search_action_hold_transit_copy({hold=>$hold->id},{idlist=>1})->[0];
741
742                         if( $transid ) {
743                                 my $trans = $e->retrieve_action_transit_copy($transid);
744                                 # Leave the transit alive, but  set the copy status to 
745                                 # reshelving so it will be properly reshelved when it gets back home
746                                 if( $trans ) {
747                                         $trans->copy_status( OILS_COPY_STATUS_RESHELVING );
748                                         $e->update_action_transit_copy($trans) or return $e->die_event;
749                                 }
750                         }
751                 }
752         }
753
754         $hold->cancel_time('now');
755     $hold->cancel_cause($cause);
756     $hold->cancel_note($note);
757         $e->update_action_hold_request($hold)
758                 or return $e->die_event;
759
760         delete_hold_copy_maps($self, $e, $hold->id);
761
762         $e->commit;
763
764     # re-fetch the hold to pick up the real cancel_time (not "now") for A/T
765     $e->xact_begin;
766     $hold = $e->retrieve_action_hold_request($hold->id) or return $e->die_event;
767     $e->rollback;
768
769     if ($e->requestor->id == $hold->usr) {
770         $U->create_events_for_hook('hold_request.cancel.patron', $hold, $hold->pickup_lib);
771     } else {
772         $U->create_events_for_hook('hold_request.cancel.staff', $hold, $hold->pickup_lib);
773     }
774
775         return 1;
776 }
777
778 sub delete_hold_copy_maps {
779         my $class  = shift;
780         my $editor = shift;
781         my $holdid = shift;
782
783         my $maps = $editor->search_action_hold_copy_map({hold=>$holdid});
784         for(@$maps) {
785                 $editor->delete_action_hold_copy_map($_) 
786                         or return $editor->event;
787         }
788         return undef;
789 }
790
791
792 my $update_hold_desc = 'The login session is the requestor. '       .
793    'If the requestor is different from the usr field on the hold, ' .
794    'the requestor must have UPDATE_HOLDS permissions. '             .
795    'If supplying a hash of hold data, "id" must be included. '      .
796    'The hash is ignored if a hold object is supplied, '             .
797    'so you should supply only one kind of hold data argument.'      ;
798
799 __PACKAGE__->register_method(
800     method    => "update_hold",
801     api_name  => "open-ils.circ.hold.update",
802     signature => {
803         desc   => "Updates the specified hold.  $update_hold_desc",
804         params => [
805             {desc => 'Authentication token',         type => 'string'},
806             {desc => 'Hold Object',                  type => 'object'},
807             {desc => 'Hash of values to be applied', type => 'object'}
808         ],
809         return => {
810             desc => 'Hold ID on success, event on error',
811             # type => 'number'
812         }
813     }
814 );
815
816 __PACKAGE__->register_method(
817     method    => "batch_update_hold",
818     api_name  => "open-ils.circ.hold.update.batch",
819     stream    => 1,
820     signature => {
821         desc   => "Updates the specified hold(s).  $update_hold_desc",
822         params => [
823             {desc => 'Authentication token',                    type => 'string'},
824             {desc => 'Array of hold obejcts',                   type => 'array' },
825             {desc => 'Array of hashes of values to be applied', type => 'array' }
826         ],
827         return => {
828             desc => 'Hold ID per success, event per error',
829         }
830     }
831 );
832
833 sub update_hold {
834         my($self, $client, $auth, $hold, $values) = @_;
835     my $e = new_editor(authtoken=>$auth, xact=>1);
836     return $e->die_event unless $e->checkauth;
837     my $resp = update_hold_impl($self, $e, $hold, $values);
838     if ($U->event_code($resp)) {
839         $e->rollback;
840         return $resp;
841     }
842     $e->commit;     # FIXME: update_hold_impl already does $e->commit  ??
843     return $resp;
844 }
845
846 sub batch_update_hold {
847         my($self, $client, $auth, $hold_list, $values_list) = @_;
848     my $e = new_editor(authtoken=>$auth);
849     return $e->die_event unless $e->checkauth;
850
851     my $count = ($hold_list) ? scalar(@$hold_list) : scalar(@$values_list);     # FIXME: we don't know for sure that we got $values_list.  we could have neither list.
852     $hold_list   ||= [];
853     $values_list ||= [];      # FIXME: either move this above $count declaration, or send an event if both lists undef.  Probably the latter.
854
855 # FIXME: Failing over to [] guarantees warnings for "Use of unitialized value" in update_hold_impl call.
856 # FIXME: We should be sure we only call update_hold_impl with hold object OR hash, not both.
857
858     for my $idx (0..$count-1) {
859         $e->xact_begin;
860         my $resp = update_hold_impl($self, $e, $hold_list->[$idx], $values_list->[$idx]);
861         $e->xact_commit unless $U->event_code($resp);
862         $client->respond($resp);
863     }
864
865     $e->disconnect;
866     return undef;       # not in the register return type, assuming we should always have at least one list populated
867 }
868
869 sub update_hold_impl {
870     my($self, $e, $hold, $values) = @_;
871     my $hold_status;
872
873     unless($hold) {
874         $hold = $e->retrieve_action_hold_request($values->{id})
875             or return $e->die_event;
876         for my $k (keys %$values) {
877             if (defined $values->{$k}) {
878                 $hold->$k($values->{$k});
879             } else {
880                 my $f = "clear_$k"; $hold->$f();
881             }
882         }
883     }
884
885     my $orig_hold = $e->retrieve_action_hold_request($hold->id)
886         or return $e->die_event;
887
888     # don't allow the user to be changed
889     return OpenILS::Event->new('BAD_PARAMS') if $hold->usr != $orig_hold->usr;
890
891     if($hold->usr ne $e->requestor->id) {
892         # if the hold is for a different user, make sure the 
893         # requestor has the appropriate permissions
894         my $usr = $e->retrieve_actor_user($hold->usr)
895             or return $e->die_event;
896         return $e->die_event unless $e->allowed('UPDATE_HOLD', $usr->home_ou);
897     }
898
899
900     # --------------------------------------------------------------
901     # Changing the request time is like playing God
902     # --------------------------------------------------------------
903     if($hold->request_time ne $orig_hold->request_time) {
904         return OpenILS::Event->new('BAD_PARAMS') if $hold->fulfillment_time;
905         return $e->die_event unless $e->allowed('UPDATE_HOLD_REQUEST_TIME', $hold->pickup_lib);
906     }
907     
908         
909         # --------------------------------------------------------------
910         # Code for making sure staff have appropriate permissons for cut_in_line
911         # This, as is, doesn't prevent a user from cutting their own holds in line 
912         # but needs to
913         # --------------------------------------------------------------        
914         if($U->is_true($hold->cut_in_line) ne $U->is_true($orig_hold->cut_in_line)) {
915                 return $e->die_event unless $e->allowed('UPDATE_HOLD_REQUEST_TIME', $hold->pickup_lib);
916         }
917
918
919     # --------------------------------------------------------------
920     # Disallow hold suspencion if the hold is already captured.
921     # --------------------------------------------------------------
922     if ($U->is_true($hold->frozen) and not $U->is_true($orig_hold->frozen)) {
923         $hold_status = _hold_status($e, $hold);
924         if ($hold_status > 2) { # hold is captured
925             $logger->info("bypassing hold freeze on captured hold");
926             return OpenILS::Event->new('HOLD_SUSPEND_AFTER_CAPTURE');
927         }
928     }
929
930
931     # --------------------------------------------------------------
932     # if the hold is on the holds shelf or in transit and the pickup 
933     # lib changes we need to create a new transit.
934     # --------------------------------------------------------------
935     if($orig_hold->pickup_lib ne $hold->pickup_lib) {
936
937         $hold_status = _hold_status($e, $hold) unless $hold_status;
938
939         if($hold_status == 3) { # in transit
940
941             return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_TRANSIT', $orig_hold->pickup_lib);
942             return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_TRANSIT', $hold->pickup_lib);
943
944             $logger->info("updating pickup lib for hold ".$hold->id." while already in transit");
945
946             # update the transit to reflect the new pickup location
947                         my $transit = $e->search_action_hold_transit_copy(
948                 {hold=>$hold->id, dest_recv_time => undef})->[0] 
949                 or return $e->die_event;
950
951             $transit->prev_dest($transit->dest); # mark the previous destination on the transit
952             $transit->dest($hold->pickup_lib);
953             $e->update_action_hold_transit_copy($transit) or return $e->die_event;
954
955         } elsif($hold_status == 4) { # on holds shelf
956
957             return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_HOLDS_SHELF', $orig_hold->pickup_lib);
958             return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_HOLDS_SHELF', $hold->pickup_lib);
959
960             $logger->info("updating pickup lib for hold ".$hold->id." while on holds shelf");
961
962             # create the new transit
963             my $evt = transit_hold($e, $orig_hold, $hold, $e->retrieve_asset_copy($hold->current_copy));
964             return $evt if $evt;
965
966             # hold is leaving the shelf  
967             $hold->clear_shelf_time;
968             $hold->clear_shelf_expire_time;
969         }
970     } 
971
972     update_hold_if_frozen($self, $e, $hold, $orig_hold);
973     $e->update_action_hold_request($hold) or return $e->die_event;
974     $e->commit;
975
976     # a change to mint-condition changes the set of potential copies, so retarget the hold;
977     if($U->is_true($hold->mint_condition) and !$U->is_true($orig_hold->mint_condition)) {
978         _reset_hold($self, $e->requestor, $hold) 
979     }
980
981     return $hold->id;
982 }
983
984 sub transit_hold {
985     my($e, $orig_hold, $hold, $copy) = @_;
986     my $src  = $orig_hold->pickup_lib;
987     my $dest = $hold->pickup_lib;
988
989     $logger->info("putting hold into transit on pickup_lib update");
990
991     my $transit = Fieldmapper::action::hold_transit_copy->new;
992     $transit->hold($hold->id);
993     $transit->source($src);
994     $transit->dest($dest);
995     $transit->target_copy($copy->id);
996     $transit->source_send_time('now');
997     $transit->copy_status(OILS_COPY_STATUS_ON_HOLDS_SHELF);
998
999     $copy->status(OILS_COPY_STATUS_IN_TRANSIT);
1000     $copy->editor($e->requestor->id);
1001     $copy->edit_date('now');
1002
1003     $e->create_action_hold_transit_copy($transit) or return $e->die_event;
1004     $e->update_asset_copy($copy) or return $e->die_event;
1005     return undef;
1006 }
1007
1008 # if the hold is frozen, this method ensures that the hold is not "targeted", 
1009 # that is, it clears the current_copy and prev_check_time to essentiallly 
1010 # reset the hold.  If it is being activated, it runs the targeter in the background
1011 sub update_hold_if_frozen {
1012     my($self, $e, $hold, $orig_hold) = @_;
1013     return if $hold->capture_time;
1014
1015     if($U->is_true($hold->frozen)) {
1016         $logger->info("clearing current_copy and check_time for frozen hold ".$hold->id);
1017         $hold->clear_current_copy;
1018         $hold->clear_prev_check_time;
1019
1020     } else {
1021         if($U->is_true($orig_hold->frozen)) {
1022             $logger->info("Running targeter on activated hold ".$hold->id);
1023             $U->storagereq( 'open-ils.storage.action.hold_request.copy_targeter', undef, $hold->id );
1024         }
1025     }
1026 }
1027
1028 __PACKAGE__->register_method(
1029     method    => "hold_note_CUD",
1030     api_name  => "open-ils.circ.hold_request.note.cud",
1031     signature => {
1032         desc   => 'Create, update or delete a hold request note.  If the operator (from Auth. token) '
1033                 . 'is not the owner of the hold, the UPDATE_HOLD permission is required',
1034         params => [
1035             { desc => 'Authentication token', type => 'string' },
1036             { desc => 'Hold note object',     type => 'object' }
1037         ],
1038         return => {
1039             desc => 'Returns the note ID, event on error'
1040         },
1041     }
1042 );
1043
1044 sub hold_note_CUD {
1045         my($self, $conn, $auth, $note) = @_;
1046
1047     my $e = new_editor(authtoken => $auth, xact => 1);
1048     return $e->die_event unless $e->checkauth;
1049
1050     my $hold = $e->retrieve_action_hold_request($note->hold)
1051         or return $e->die_event;
1052
1053     if($hold->usr ne $e->requestor->id) {
1054         my $usr = $e->retrieve_actor_user($hold->usr);
1055         return $e->die_event unless $e->allowed('UPDATE_HOLD', $usr->home_ou);
1056         $note->staff('t') if $note->isnew;
1057     }
1058
1059     if($note->isnew) {
1060         $e->create_action_hold_request_note($note) or return $e->die_event;
1061     } elsif($note->ischanged) {
1062         $e->update_action_hold_request_note($note) or return $e->die_event;
1063     } elsif($note->isdeleted) {
1064         $e->delete_action_hold_request_note($note) or return $e->die_event;
1065     }
1066
1067     $e->commit;
1068     return $note->id;
1069 }
1070
1071
1072 __PACKAGE__->register_method(
1073     method    => "retrieve_hold_status",
1074     api_name  => "open-ils.circ.hold.status.retrieve",
1075     signature => {
1076         desc   => 'Calculates the current status of the hold. The requestor must have '      .
1077                   'VIEW_HOLD permissions if the hold is for a user other than the requestor' ,
1078         param  => [
1079             { desc => 'Hold ID', type => 'number' }
1080         ],
1081         return => {
1082             # type => 'number',     # event sometimes
1083             desc => <<'END_OF_DESC'
1084 Returns event on error or:
1085 -1 on error (for now),
1086  1 for 'waiting for copy to become available',
1087  2 for 'waiting for copy capture',
1088  3 for 'in transit',
1089  4 for 'arrived',
1090  5 for 'hold-shelf-delay'
1091  6 for 'canceled'
1092  7 for 'suspended'
1093 END_OF_DESC
1094         }
1095     }
1096 );
1097
1098 sub retrieve_hold_status {
1099         my($self, $client, $auth, $hold_id) = @_;
1100
1101         my $e = new_editor(authtoken => $auth);
1102         return $e->event unless $e->checkauth;
1103         my $hold = $e->retrieve_action_hold_request($hold_id)
1104                 or return $e->event;
1105
1106         if( $e->requestor->id != $hold->usr ) {
1107                 return $e->event unless $e->allowed('VIEW_HOLD');
1108         }
1109
1110         return _hold_status($e, $hold);
1111
1112 }
1113
1114 sub _hold_status {
1115         my($e, $hold) = @_;
1116     if ($hold->cancel_time) {
1117         return 6;
1118     }
1119     if ($U->is_true($hold->frozen)) {
1120         return 7;
1121     }
1122         return 1 unless $hold->current_copy;
1123         return 2 unless $hold->capture_time;
1124
1125         my $copy = $hold->current_copy;
1126         unless( ref $copy ) {
1127                 $copy = $e->retrieve_asset_copy($hold->current_copy)
1128                         or return $e->event;
1129         }
1130
1131         return 3 if $copy->status == OILS_COPY_STATUS_IN_TRANSIT;
1132
1133         if($copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF) {
1134
1135         my $hs_wait_interval = $U->ou_ancestor_setting_value($hold->pickup_lib, 'circ.hold_shelf_status_delay');
1136         return 4 unless $hs_wait_interval;
1137
1138         # if a hold_shelf_status_delay interval is defined and start_time plus 
1139         # the interval is greater than now, consider the hold to be in the virtual 
1140         # "on its way to the holds shelf" status. Return 5.
1141
1142         my $transit    = $e->search_action_hold_transit_copy({hold => $hold->id})->[0];
1143         my $start_time = ($transit) ? $transit->dest_recv_time : $hold->capture_time;
1144         $start_time    = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($start_time));
1145         my $end_time   = $start_time->add(seconds => OpenSRF::Utils::interval_to_seconds($hs_wait_interval));
1146
1147         return 5 if $end_time > DateTime->now;
1148         return 4;
1149     }
1150
1151     return -1;  # error
1152 }
1153
1154
1155
1156 __PACKAGE__->register_method(
1157     method    => "retrieve_hold_queue_stats",
1158     api_name  => "open-ils.circ.hold.queue_stats.retrieve",
1159     signature => {
1160         desc   => 'Returns summary data about the state of a hold',
1161         params => [
1162             { desc => 'Authentication token',  type => 'string'},
1163             { desc => 'Hold ID', type => 'number'},
1164         ],
1165         return => {
1166             desc => q/Summary object with keys: 
1167                 total_holds : total holds in queue
1168                 queue_position : current queue position
1169                 potential_copies : number of potential copies for this hold
1170                 estimated_wait : estimated wait time in days
1171                 status : hold status  
1172                      -1 => error or unexpected state,
1173                      1 => 'waiting for copy to become available',
1174                      2 => 'waiting for copy capture',
1175                      3 => 'in transit',
1176                      4 => 'arrived',
1177                      5 => 'hold-shelf-delay'
1178             /,
1179             type => 'object'
1180         }
1181     }
1182 );
1183
1184 sub retrieve_hold_queue_stats {
1185     my($self, $conn, $auth, $hold_id) = @_;
1186         my $e = new_editor(authtoken => $auth);
1187         return $e->event unless $e->checkauth;
1188         my $hold = $e->retrieve_action_hold_request($hold_id) or return $e->event;
1189         if($e->requestor->id != $hold->usr) {
1190                 return $e->event unless $e->allowed('VIEW_HOLD');
1191         }
1192     return retrieve_hold_queue_status_impl($e, $hold);
1193 }
1194
1195 sub retrieve_hold_queue_status_impl {
1196     my $e = shift;
1197     my $hold = shift;
1198
1199     # The holds queue is defined as the distinct set of holds that share at 
1200     # least one potential copy with the context hold, plus any holds that
1201     # share the same hold type and target.  The latter part exists to
1202     # accomodate holds that currently have no potential copies
1203     my $q_holds = $e->json_query({
1204
1205         # fetch cut_in_line and request_time since they're in the order_by
1206         # and we're asking for distinct values
1207         select => {ahr => ['id', 'cut_in_line', 'request_time']},
1208         from   => {
1209             ahr => {
1210                 'ahcm' => {
1211                     join => {
1212                         'ahcm2' => {
1213                             'class' => 'ahcm',
1214                             'field' => 'target_copy',
1215                             'fkey'  => 'target_copy'
1216                         }
1217                     }
1218                 }
1219             }
1220         },
1221         order_by => [
1222             {
1223                 "class" => "ahr",
1224                 "field" => "cut_in_line",
1225                 "transform" => "coalesce",
1226                 "params" => [ 0 ],
1227                 "direction" => "desc"
1228             },
1229             { "class" => "ahr", "field" => "request_time" }
1230         ],
1231         distinct => 1,
1232         where => {
1233             '+ahcm2' => { hold => $hold->id }
1234         }
1235     });
1236
1237     if (!@$q_holds) { # none? maybe we don't have a map ... 
1238         $q_holds = $e->json_query({
1239             select => {ahr => ['id', 'cut_in_line', 'request_time']},
1240             from   => 'ahr',
1241             order_by => [
1242                 {
1243                     "class" => "ahr",
1244                     "field" => "cut_in_line",
1245                     "transform" => "coalesce",
1246                     "params" => [ 0 ],
1247                     "direction" => "desc"
1248                 },
1249                 { "class" => "ahr", "field" => "request_time" }
1250             ],
1251             where    => {
1252                 hold_type => $hold->hold_type, 
1253                 target    => $hold->target 
1254            } 
1255         });
1256     }
1257
1258
1259     my $qpos = 1;
1260     for my $h (@$q_holds) {
1261         last if $h->{id} == $hold->id;
1262         $qpos++;
1263     }
1264
1265     my $hold_data = $e->json_query({
1266         select => {
1267             acp => [ {column => 'id', transform => 'count', aggregate => 1, alias => 'count'} ],
1268             ccm => [ {column =>'avg_wait_time'} ]
1269         }, 
1270         from => {
1271             ahcm => {
1272                 acp => {
1273                     join => {
1274                         ccm => {type => 'left'}
1275                     }
1276                 }
1277             }
1278         }, 
1279         where => {'+ahcm' => {hold => $hold->id} }
1280     });
1281
1282     my $user_org = $e->json_query({select => {au => ['home_ou']}, from => 'au', where => {id => $hold->usr}})->[0]->{home_ou};
1283
1284     my $default_wait = $U->ou_ancestor_setting_value($user_org, OILS_SETTING_HOLD_ESIMATE_WAIT_INTERVAL);
1285     my $min_wait = $U->ou_ancestor_setting_value($user_org, 'circ.holds.min_estimated_wait_interval');
1286     $min_wait = OpenSRF::Utils::interval_to_seconds($min_wait || '0 seconds');
1287     $default_wait ||= '0 seconds';
1288
1289     # Estimated wait time is the average wait time across the set 
1290     # of potential copies, divided by the number of potential copies
1291     # times the queue position.  
1292
1293     my $combined_secs = 0;
1294     my $num_potentials = 0;
1295
1296     for my $wait_data (@$hold_data) {
1297         my $count += $wait_data->{count};
1298         $combined_secs += $count * 
1299             OpenSRF::Utils::interval_to_seconds($wait_data->{avg_wait_time} || $default_wait);
1300         $num_potentials += $count;
1301     }
1302
1303     my $estimated_wait = -1;
1304
1305     if($num_potentials) {
1306         my $avg_wait = $combined_secs / $num_potentials;
1307         $estimated_wait = $qpos * ($avg_wait / $num_potentials);
1308         $estimated_wait = $min_wait if $estimated_wait < $min_wait and $estimated_wait != -1;
1309     }
1310
1311     return {
1312         total_holds      => scalar(@$q_holds),
1313         queue_position   => $qpos,
1314         potential_copies => $num_potentials,
1315         status           => _hold_status( $e, $hold ),
1316         estimated_wait   => int($estimated_wait)
1317     };
1318 }
1319
1320
1321 sub fetch_open_hold_by_current_copy {
1322         my $class = shift;
1323         my $copyid = shift;
1324         my $hold = $apputils->simplereq(
1325                 'open-ils.cstore', 
1326                 'open-ils.cstore.direct.action.hold_request.search.atomic',
1327                 { current_copy =>  $copyid , cancel_time => undef, fulfillment_time => undef });
1328         return $hold->[0] if ref($hold);
1329         return undef;
1330 }
1331
1332 sub fetch_related_holds {
1333         my $class = shift;
1334         my $copyid = shift;
1335         return $apputils->simplereq(
1336                 'open-ils.cstore', 
1337                 'open-ils.cstore.direct.action.hold_request.search.atomic',
1338                 { current_copy =>  $copyid , cancel_time => undef, fulfillment_time => undef });
1339 }
1340
1341
1342 __PACKAGE__->register_method(
1343     method    => "hold_pull_list",
1344     api_name  => "open-ils.circ.hold_pull_list.retrieve",
1345     signature => {
1346         desc   => 'Returns (reference to) a list of holds that need to be "pulled" by a given location. ' .
1347                   'The location is determined by the login session.',
1348         params => [
1349             { desc => 'Limit (optional)',  type => 'number'},
1350             { desc => 'Offset (optional)', type => 'number'},
1351         ],
1352         return => {
1353             desc => 'reference to a list of holds, or event on failure',
1354         }
1355     }
1356 );
1357
1358 __PACKAGE__->register_method(
1359     method    => "hold_pull_list",
1360     api_name  => "open-ils.circ.hold_pull_list.id_list.retrieve",
1361     signature => {
1362         desc   => 'Returns (reference to) a list of holds IDs that need to be "pulled" by a given location. ' .
1363                   'The location is determined by the login session.',
1364         params => [
1365             { desc => 'Limit (optional)',  type => 'number'},
1366             { desc => 'Offset (optional)', type => 'number'},
1367         ],
1368         return => {
1369             desc => 'reference to a list of holds, or event on failure',
1370         }
1371     }
1372 );
1373
1374 __PACKAGE__->register_method(
1375     method    => "hold_pull_list",
1376     api_name  => "open-ils.circ.hold_pull_list.retrieve.count",
1377     signature => {
1378         desc   => 'Returns a count of holds that need to be "pulled" by a given location. ' .
1379                   'The location is determined by the login session.',
1380         params => [
1381             { desc => 'Limit (optional)',  type => 'number'},
1382             { desc => 'Offset (optional)', type => 'number'},
1383         ],
1384         return => {
1385             desc => 'Holds count (integer), or event on failure',
1386             # type => 'number'
1387         }
1388     }
1389 );
1390
1391
1392 sub hold_pull_list {
1393         my( $self, $conn, $authtoken, $limit, $offset ) = @_;
1394         my( $reqr, $evt ) = $U->checkses($authtoken);
1395         return $evt if $evt;
1396
1397         my $org = $reqr->ws_ou || $reqr->home_ou;
1398         # the perm locaiton shouldn't really matter here since holds
1399         # will exist all over and VIEW_HOLDS should be universal
1400         $evt = $U->check_perms($reqr->id, $org, 'VIEW_HOLD');
1401         return $evt if $evt;
1402
1403     if($self->api_name =~ /count/) {
1404
1405                 my $count = $U->storagereq(
1406                         'open-ils.storage.direct.action.hold_request.pull_list.current_copy_circ_lib.status_filtered.count',
1407                         $org, $limit, $offset ); 
1408
1409         $logger->info("Grabbing pull list for org unit $org with $count items");
1410         return $count;
1411
1412     } elsif( $self->api_name =~ /id_list/ ) {
1413                 return $U->storagereq(
1414                         'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib.status_filtered.atomic',
1415                         $org, $limit, $offset ); 
1416
1417         } else {
1418                 return $U->storagereq(
1419                         'open-ils.storage.direct.action.hold_request.pull_list.search.current_copy_circ_lib.status_filtered.atomic',
1420                         $org, $limit, $offset ); 
1421         }
1422 }
1423
1424 __PACKAGE__->register_method(
1425     method    => "print_hold_pull_list",
1426     api_name  => "open-ils.circ.hold_pull_list.print",
1427     signature => {
1428         desc   => 'Returns an HTML-formatted holds pull list',
1429         params => [
1430             { desc => 'Authtoken', type => 'string'},
1431             { desc => 'Org unit ID.  Optional, defaults to workstation org unit', type => 'number'},
1432         ],
1433         return => {
1434             desc => 'HTML string',
1435             type => 'string'
1436         }
1437     }
1438 );
1439
1440 sub print_hold_pull_list {
1441     my($self, $client, $auth, $org_id) = @_;
1442
1443     my $e = new_editor(authtoken=>$auth);
1444     return $e->event unless $e->checkauth;
1445
1446     $org_id = (defined $org_id) ? $org_id : $e->requestor->ws_ou;
1447     return $e->event unless $e->allowed('VIEW_HOLD', $org_id);
1448
1449     my $hold_ids = $U->storagereq(
1450         'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib.status_filtered.atomic',
1451         $org_id, 10000);
1452
1453     return undef unless @$hold_ids;
1454
1455     $client->status(new OpenSRF::DomainObject::oilsContinueStatus);
1456
1457     # Holds will /NOT/ be in order after this ...
1458     my $holds = $e->search_action_hold_request({id => $hold_ids}, {substream => 1});
1459     $client->status(new OpenSRF::DomainObject::oilsContinueStatus);
1460
1461     # ... so we must resort.
1462     my $hold_map = +{map { $_->id => $_ } @$holds};
1463     my $sorted_holds = [];
1464     push @$sorted_holds, $hold_map->{$_} foreach @$hold_ids;
1465
1466     return $U->fire_object_event(
1467         undef, "ahr.format.pull_list", $sorted_holds,
1468         $org_id, undef, undef, $client
1469     );
1470
1471 }
1472
1473 __PACKAGE__->register_method(
1474     method    => "print_hold_pull_list_stream",
1475     stream   => 1,
1476     api_name  => "open-ils.circ.hold_pull_list.print.stream",
1477     signature => {
1478         desc   => 'Returns a stream of fleshed holds',
1479         params => [
1480             { desc => 'Authtoken', type => 'string'},
1481             { desc => 'Hash of optional param: Org unit ID (defaults to workstation org unit), limit, offset, sort (array of: acplo.position, prefix, call_number, suffix, request_time)',
1482               type => 'object'
1483             },
1484         ],
1485         return => {
1486             desc => 'A stream of fleshed holds',
1487             type => 'object'
1488         }
1489     }
1490 );
1491
1492 sub print_hold_pull_list_stream {
1493     my($self, $client, $auth, $params) = @_;
1494
1495     my $e = new_editor(authtoken=>$auth);
1496     return $e->die_event unless $e->checkauth;
1497
1498     delete($$params{org_id}) unless (int($$params{org_id}));
1499     delete($$params{limit}) unless (int($$params{limit}));
1500     delete($$params{offset}) unless (int($$params{offset}));
1501     delete($$params{chunk_size}) unless (int($$params{chunk_size}));
1502     delete($$params{chunk_size}) if  ($$params{chunk_size} && $$params{chunk_size} > 50); # keep the size reasonable
1503     $$params{chunk_size} ||= 10;
1504
1505     $$params{org_id} = (defined $$params{org_id}) ? $$params{org_id}: $e->requestor->ws_ou;
1506     return $e->die_event unless $e->allowed('VIEW_HOLD', $$params{org_id });
1507
1508     my $sort = [];
1509     if ($$params{sort} && @{ $$params{sort} }) {
1510         for my $s (@{ $$params{sort} }) {
1511             if ($s eq 'acplo.position') {
1512                 push @$sort, {
1513                     "class" => "acplo", "field" => "position",
1514                     "transform" => "coalesce", "params" => [999]
1515                 };
1516             } elsif ($s eq 'prefix') {
1517                 push @$sort, {"class" => "acnp", "field" => "label_sortkey"};
1518             } elsif ($s eq 'call_number') {
1519                 push @$sort, {"class" => "acn", "field" => "label_sortkey"};
1520             } elsif ($s eq 'suffix') {
1521                 push @$sort, {"class" => "acns", "field" => "label_sortkey"};
1522             } elsif ($s eq 'request_time') {
1523                 push @$sort, {"class" => "ahr", "field" => "request_time"};
1524             }
1525         }
1526     } else {
1527         push @$sort, {"class" => "ahr", "field" => "request_time"};
1528     }
1529
1530     my $holds_ids = $e->json_query(
1531         {
1532             "select" => {"ahr" => ["id"]},
1533             "from" => {
1534                 "ahr" => {
1535                     "acp" => { 
1536                         "field" => "id",
1537                         "fkey" => "current_copy",
1538                         "filter" => {
1539                             "circ_lib" => $$params{org_id}, "status" => [0,7]
1540                         },
1541                         "join" => {
1542                             "acn" => {
1543                                 "field" => "id",
1544                                 "fkey" => "call_number",
1545                                 "join" => {
1546                                     "acnp" => {
1547                                         "field" => "id",
1548                                         "fkey" => "prefix"
1549                                     },
1550                                     "acns" => {
1551                                         "field" => "id",
1552                                         "fkey" => "suffix"
1553                                     }
1554                                 }
1555                             },
1556                             "acplo" => {
1557                                 "field" => "org",
1558                                 "fkey" => "circ_lib", 
1559                                 "type" => "left",
1560                                 "filter" => {
1561                                     "location" => {"=" => {"+acp" => "location"}}
1562                                 }
1563                             }
1564                         }
1565                     }
1566                 }
1567             },
1568             "where" => {
1569                 "+ahr" => {
1570                     "capture_time" => undef,
1571                     "cancel_time" => undef,
1572                     "-or" => [
1573                         {"expire_time" => undef },
1574                         {"expire_time" => {">" => "now"}}
1575                     ]
1576                 }
1577             },
1578             (@$sort ? (order_by => $sort) : ()),
1579             ($$params{limit} ? (limit => $$params{limit}) : ()),
1580             ($$params{offset} ? (offset => $$params{offset}) : ())
1581         }, {"substream" => 1}
1582     ) or return $e->die_event;
1583
1584     $logger->info("about to stream back " . scalar(@$holds_ids) . " holds");
1585
1586     my @chunk;
1587     for my $hid (@$holds_ids) {
1588         push @chunk, $e->retrieve_action_hold_request([
1589             $hid->{"id"}, {
1590                 "flesh" => 3,
1591                 "flesh_fields" => {
1592                     "ahr" => ["usr", "current_copy"],
1593                     "au"  => ["card"],
1594                     "acp" => ["location", "call_number", "parts"],
1595                     "acn" => ["record","prefix","suffix"]
1596                 }
1597             }
1598         ]);
1599
1600         if (@chunk >= $$params{chunk_size}) {
1601             $client->respond( \@chunk );
1602             @chunk = ();
1603         }
1604     }
1605     $client->respond_complete( \@chunk ) if (@chunk);
1606     $e->disconnect;
1607     return undef;
1608 }
1609
1610
1611
1612 __PACKAGE__->register_method(
1613     method        => 'fetch_hold_notify',
1614     api_name      => 'open-ils.circ.hold_notification.retrieve_by_hold',
1615     authoritative => 1,
1616     signature     => q/ 
1617 Returns a list of hold notification objects based on hold id.
1618 @param authtoken The loggin session key
1619 @param holdid The id of the hold whose notifications we want to retrieve
1620 @return An array of hold notification objects, event on error.
1621 /
1622 );
1623
1624 sub fetch_hold_notify {
1625         my( $self, $conn, $authtoken, $holdid ) = @_;
1626         my( $requestor, $evt ) = $U->checkses($authtoken);
1627         return $evt if $evt;
1628         my ($hold, $patron);
1629         ($hold, $evt) = $U->fetch_hold($holdid);
1630         return $evt if $evt;
1631         ($patron, $evt) = $U->fetch_user($hold->usr);
1632         return $evt if $evt;
1633
1634         $evt = $U->check_perms($requestor->id, $patron->home_ou, 'VIEW_HOLD_NOTIFICATION');
1635         return $evt if $evt;
1636
1637         $logger->info("User ".$requestor->id." fetching hold notifications for hold $holdid");
1638         return $U->cstorereq(
1639                 'open-ils.cstore.direct.action.hold_notification.search.atomic', {hold => $holdid} );
1640 }
1641
1642
1643 __PACKAGE__->register_method(
1644     method    => 'create_hold_notify',
1645     api_name  => 'open-ils.circ.hold_notification.create',
1646     signature => q/
1647 Creates a new hold notification object
1648 @param authtoken The login session key
1649 @param notification The hold notification object to create
1650 @return ID of the new object on success, Event on error
1651 /
1652 );
1653
1654 sub create_hold_notify {
1655    my( $self, $conn, $auth, $note ) = @_;
1656    my $e = new_editor(authtoken=>$auth, xact=>1);
1657    return $e->die_event unless $e->checkauth;
1658
1659    my $hold = $e->retrieve_action_hold_request($note->hold)
1660       or return $e->die_event;
1661    my $patron = $e->retrieve_actor_user($hold->usr) 
1662       or return $e->die_event;
1663
1664    return $e->die_event unless 
1665       $e->allowed('CREATE_HOLD_NOTIFICATION', $patron->home_ou);
1666
1667    $note->notify_staff($e->requestor->id);
1668    $e->create_action_hold_notification($note) or return $e->die_event;
1669    $e->commit;
1670    return $note->id;
1671 }
1672
1673 __PACKAGE__->register_method(
1674     method    => 'create_hold_note',
1675     api_name  => 'open-ils.circ.hold_note.create',
1676     signature => q/
1677                 Creates a new hold request note object
1678                 @param authtoken The login session key
1679                 @param note The hold note object to create
1680                 @return ID of the new object on success, Event on error
1681                 /
1682 );
1683
1684 sub create_hold_note {
1685    my( $self, $conn, $auth, $note ) = @_;
1686    my $e = new_editor(authtoken=>$auth, xact=>1);
1687    return $e->die_event unless $e->checkauth;
1688
1689    my $hold = $e->retrieve_action_hold_request($note->hold)
1690       or return $e->die_event;
1691    my $patron = $e->retrieve_actor_user($hold->usr) 
1692       or return $e->die_event;
1693
1694    return $e->die_event unless 
1695       $e->allowed('UPDATE_HOLD', $patron->home_ou); # FIXME: Using permcrud perm listed in fm_IDL.xml for ahrn.  Probably want something more specific
1696
1697    $e->create_action_hold_request_note($note) or return $e->die_event;
1698    $e->commit;
1699    return $note->id;
1700 }
1701
1702 __PACKAGE__->register_method(
1703     method    => 'reset_hold',
1704     api_name  => 'open-ils.circ.hold.reset',
1705     signature => q/
1706                 Un-captures and un-targets a hold, essentially returning
1707                 it to the state it was in directly after it was placed,
1708                 then attempts to re-target the hold
1709                 @param authtoken The login session key
1710                 @param holdid The id of the hold
1711         /
1712 );
1713
1714
1715 sub reset_hold {
1716         my( $self, $conn, $auth, $holdid ) = @_;
1717         my $reqr;
1718         my ($hold, $evt) = $U->fetch_hold($holdid);
1719         return $evt if $evt;
1720         ($reqr, $evt) = $U->checksesperm($auth, 'UPDATE_HOLD');
1721         return $evt if $evt;
1722         $evt = _reset_hold($self, $reqr, $hold);
1723         return $evt if $evt;
1724         return 1;
1725 }
1726
1727
1728 __PACKAGE__->register_method(
1729     method   => 'reset_hold_batch',
1730     api_name => 'open-ils.circ.hold.reset.batch'
1731 );
1732
1733 sub reset_hold_batch {
1734     my($self, $conn, $auth, $hold_ids) = @_;
1735
1736     my $e = new_editor(authtoken => $auth);
1737     return $e->event unless $e->checkauth;
1738
1739     for my $hold_id ($hold_ids) {
1740
1741         my $hold = $e->retrieve_action_hold_request(
1742             [$hold_id, {flesh => 1, flesh_fields => {ahr => ['usr']}}]) 
1743             or return $e->event;
1744
1745             next unless $e->allowed('UPDATE_HOLD', $hold->usr->home_ou);
1746         _reset_hold($self, $e->requestor, $hold);
1747     }
1748
1749     return 1;
1750 }
1751
1752
1753 sub _reset_hold {
1754         my ($self, $reqr, $hold) = @_;
1755
1756         my $e = new_editor(xact =>1, requestor => $reqr);
1757
1758         $logger->info("reseting hold ".$hold->id);
1759
1760         my $hid = $hold->id;
1761
1762         if( $hold->capture_time and $hold->current_copy ) {
1763
1764                 my $copy = $e->retrieve_asset_copy($hold->current_copy)
1765                         or return $e->die_event;
1766
1767                 if( $copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF ) {
1768                         $logger->info("setting copy to status 'reshelving' on hold retarget");
1769                         $copy->status(OILS_COPY_STATUS_RESHELVING);
1770                         $copy->editor($e->requestor->id);
1771                         $copy->edit_date('now');
1772                         $e->update_asset_copy($copy) or return $e->die_event;
1773
1774                 } elsif( $copy->status == OILS_COPY_STATUS_IN_TRANSIT ) {
1775
1776                         # We don't want the copy to remain "in transit"
1777                         $copy->status(OILS_COPY_STATUS_RESHELVING);
1778                         $logger->warn("! reseting hold [$hid] that is in transit");
1779                         my $transid = $e->search_action_hold_transit_copy({hold=>$hold->id},{idlist=>1})->[0];
1780
1781                         if( $transid ) {
1782                                 my $trans = $e->retrieve_action_transit_copy($transid);
1783                                 if( $trans ) {
1784                                         $logger->info("Aborting transit [$transid] on hold [$hid] reset...");
1785                                         my $evt = OpenILS::Application::Circ::Transit::__abort_transit($e, $trans, $copy, 1);
1786                                         $logger->info("Transit abort completed with result $evt");
1787                                         unless ("$evt" eq 1) {
1788                         $e->rollback;
1789                                             return $evt;
1790                     }
1791                                 }
1792                         }
1793                 }
1794         }
1795
1796         $hold->clear_capture_time;
1797         $hold->clear_current_copy;
1798         $hold->clear_shelf_time;
1799         $hold->clear_shelf_expire_time;
1800         $hold->clear_current_shelf_lib;
1801
1802         $e->update_action_hold_request($hold) or return $e->die_event;
1803         $e->commit;
1804
1805         $U->storagereq(
1806                 'open-ils.storage.action.hold_request.copy_targeter', undef, $hold->id );
1807
1808         return undef;
1809 }
1810
1811
1812 __PACKAGE__->register_method(
1813     method    => 'fetch_open_title_holds',
1814     api_name  => 'open-ils.circ.open_holds.retrieve',
1815     signature => q/
1816                 Returns a list ids of un-fulfilled holds for a given title id
1817                 @param authtoken The login session key
1818                 @param id the id of the item whose holds we want to retrieve
1819                 @param type The hold type - M, T, I, V, C, F, R
1820         /
1821 );
1822
1823 sub fetch_open_title_holds {
1824         my( $self, $conn, $auth, $id, $type, $org ) = @_;
1825         my $e = new_editor( authtoken => $auth );
1826         return $e->event unless $e->checkauth;
1827
1828         $type ||= "T";
1829         $org  ||= $e->requestor->ws_ou;
1830
1831 #       return $e->search_action_hold_request(
1832 #               { target => $id, hold_type => $type, fulfillment_time => undef }, {idlist=>1});
1833
1834         # XXX make me return IDs in the future ^--
1835         my $holds = $e->search_action_hold_request(
1836                 { 
1837                         target                          => $id, 
1838                         cancel_time                     => undef, 
1839                         hold_type                       => $type, 
1840                         fulfillment_time        => undef 
1841                 }
1842         );
1843
1844         flesh_hold_transits($holds);
1845         return $holds;
1846 }
1847
1848
1849 sub flesh_hold_transits {
1850         my $holds = shift;
1851         for my $hold ( @$holds ) {
1852                 $hold->transit(
1853                         $apputils->simplereq(
1854                                 'open-ils.cstore',
1855                                 "open-ils.cstore.direct.action.hold_transit_copy.search.atomic",
1856                                 { hold => $hold->id },
1857                                 { order_by => { ahtc => 'id desc' }, limit => 1 }
1858                         )->[0]
1859                 );
1860         }
1861 }
1862
1863 sub flesh_hold_notices {
1864         my( $holds, $e ) = @_;
1865         $e ||= new_editor();
1866
1867         for my $hold (@$holds) {
1868                 my $notices = $e->search_action_hold_notification(
1869                         [
1870                                 { hold => $hold->id },
1871                                 { order_by => { anh => 'notify_time desc' } },
1872                         ],
1873                         {idlist=>1}
1874                 );
1875
1876                 $hold->notify_count(scalar(@$notices));
1877                 if( @$notices ) {
1878                         my $n = $e->retrieve_action_hold_notification($$notices[0])
1879                                 or return $e->event;
1880                         $hold->notify_time($n->notify_time);
1881                 }
1882         }
1883 }
1884
1885
1886 __PACKAGE__->register_method(
1887     method    => 'fetch_captured_holds',
1888     api_name  => 'open-ils.circ.captured_holds.on_shelf.retrieve',
1889     stream    => 1,
1890     authoritative => 1,
1891     signature => q/
1892                 Returns a list of un-fulfilled holds (on the Holds Shelf) for a given title id
1893                 @param authtoken The login session key
1894                 @param org The org id of the location in question
1895         /
1896 );
1897
1898 __PACKAGE__->register_method(
1899     method    => 'fetch_captured_holds',
1900     api_name  => 'open-ils.circ.captured_holds.id_list.on_shelf.retrieve',
1901     stream    => 1,
1902     authoritative => 1,
1903     signature => q/
1904                 Returns list ids of un-fulfilled holds (on the Holds Shelf) for a given title id
1905                 @param authtoken The login session key
1906                 @param org The org id of the location in question
1907         /
1908 );
1909
1910 __PACKAGE__->register_method(
1911     method    => 'fetch_captured_holds',
1912     api_name  => 'open-ils.circ.captured_holds.id_list.expired_on_shelf.retrieve',
1913     stream    => 1,
1914     authoritative => 1,
1915     signature => q/
1916                 Returns list ids of shelf-expired un-fulfilled holds for a given title id
1917                 @param authtoken The login session key
1918                 @param org The org id of the location in question
1919         /
1920 );
1921
1922
1923 sub fetch_captured_holds {
1924         my( $self, $conn, $auth, $org ) = @_;
1925
1926         my $e = new_editor(authtoken => $auth);
1927         return $e->die_event unless $e->checkauth;
1928         return $e->die_event unless $e->allowed('VIEW_HOLD'); # XXX rely on editor perm
1929
1930         $org ||= $e->requestor->ws_ou;
1931
1932     my $query = { 
1933         select => { alhr => ['id'] },
1934         from   => {
1935             alhr => {
1936                 acp => {
1937                     field => 'id',
1938                     fkey  => 'current_copy'
1939                 },
1940             }
1941         }, 
1942         where => {
1943             '+acp' => { status => OILS_COPY_STATUS_ON_HOLDS_SHELF },
1944             '+alhr' => {
1945                 capture_time     => { "!=" => undef },
1946                 current_copy     => { "!=" => undef },
1947                 fulfillment_time => undef,
1948                 pickup_lib       => $org,
1949 #                cancel_time      => undef,
1950               }
1951         }
1952     };
1953     if($self->api_name =~ /expired/) {
1954 #       $query->{'where'}->{'+ahr'}->{'shelf_expire_time'} = {'<' => 'now'};
1955         $query->{'where'}->{'+alhr'}->{'shelf_time'} = {'!=' => undef};
1956         $query->{'where'}->{'+alhr'}->{'-or'} = {
1957                 shelf_expire_time => { '<' => 'now'},
1958                 cancel_time => { '!=' => undef },
1959         };
1960     }
1961     my $hold_ids = $e->json_query( $query );
1962
1963     for my $hold_id (@$hold_ids) {
1964         if($self->api_name =~ /id_list/) {
1965             $conn->respond($hold_id->{id});
1966             next;
1967         } else {
1968             $conn->respond(
1969                 $e->retrieve_action_hold_request([
1970                     $hold_id->{id},
1971                     {
1972                         flesh => 1,
1973                         flesh_fields => {ahr => ['notifications', 'transit', 'notes']},
1974                         order_by => {anh => 'notify_time desc'}
1975                     }
1976                 ])
1977             );
1978         }
1979     }
1980
1981     return undef;
1982 }
1983
1984 __PACKAGE__->register_method(
1985     method    => "print_expired_holds_stream",
1986     api_name  => "open-ils.circ.captured_holds.expired.print.stream",
1987     stream    => 1
1988 );
1989
1990 sub print_expired_holds_stream {
1991     my ($self, $client, $auth, $params) = @_;
1992
1993     # No need to check specific permissions: we're going to call another method
1994     # that will do that.
1995     my $e = new_editor("authtoken" => $auth);
1996     return $e->die_event unless $e->checkauth;
1997
1998     delete($$params{org_id}) unless (int($$params{org_id}));
1999     delete($$params{limit}) unless (int($$params{limit}));
2000     delete($$params{offset}) unless (int($$params{offset}));
2001     delete($$params{chunk_size}) unless (int($$params{chunk_size}));
2002     delete($$params{chunk_size}) if  ($$params{chunk_size} && $$params{chunk_size} > 50); # keep the size reasonable
2003     $$params{chunk_size} ||= 10;
2004
2005     $$params{org_id} = (defined $$params{org_id}) ? $$params{org_id}: $e->requestor->ws_ou;
2006
2007     my @hold_ids = $self->method_lookup(
2008         "open-ils.circ.captured_holds.id_list.expired_on_shelf.retrieve"
2009     )->run($auth, $params->{"org_id"});
2010
2011     if (!@hold_ids) {
2012         $e->disconnect;
2013         return;
2014     } elsif (defined $U->event_code($hold_ids[0])) {
2015         $e->disconnect;
2016         return $hold_ids[0];
2017     }
2018
2019     $logger->info("about to stream back up to " . scalar(@hold_ids) . " expired holds");
2020
2021     while (@hold_ids) {
2022         my @hid_chunk = splice @hold_ids, 0, $params->{"chunk_size"};
2023
2024         my $result_chunk = $e->json_query({
2025             "select" => {
2026                 "acp" => ["barcode"],
2027                 "au" => [qw/
2028                     first_given_name second_given_name family_name alias
2029                 /],
2030                 "acn" => ["label"],
2031                 "bre" => ["marc"],
2032                 "acpl" => ["name"]
2033             },
2034             "from" => {
2035                 "ahr" => {
2036                     "acp" => {
2037                         "field" => "id", "fkey" => "current_copy",
2038                         "join" => {
2039                             "acn" => {
2040                                 "field" => "id", "fkey" => "call_number",
2041                                 "join" => {
2042                                     "bre" => {
2043                                         "field" => "id", "fkey" => "record"
2044                                     }
2045                                 }
2046                             },
2047                             "acpl" => {"field" => "id", "fkey" => "location"}
2048                         }
2049                     },
2050                     "au" => {"field" => "id", "fkey" => "usr"}
2051                 }
2052             },
2053             "where" => {"+ahr" => {"id" => \@hid_chunk}}
2054         }) or return $e->die_event;
2055         $client->respond($result_chunk);
2056     }
2057
2058     $e->disconnect;
2059     undef;
2060 }
2061
2062 __PACKAGE__->register_method(
2063     method    => "check_title_hold_batch",
2064     api_name  => "open-ils.circ.title_hold.is_possible.batch",
2065     stream    => 1,
2066     signature => {
2067         desc  => '@see open-ils.circ.title_hold.is_possible.batch',
2068         params => [
2069             { desc => 'Authentication token',     type => 'string'},
2070             { desc => 'Array of Hash of named parameters', type => 'array'},
2071         ],
2072         return => {
2073             desc => 'Array of response objects',
2074             type => 'array'
2075         }
2076     }
2077 );
2078
2079 sub check_title_hold_batch {
2080     my($self, $client, $authtoken, $param_list) = @_;
2081     foreach (@$param_list) {
2082         my ($res) = $self->method_lookup('open-ils.circ.title_hold.is_possible')->run($authtoken, $_);
2083         $client->respond($res);
2084     }
2085     return undef;
2086 }
2087
2088
2089 __PACKAGE__->register_method(
2090     method    => "check_title_hold",
2091     api_name  => "open-ils.circ.title_hold.is_possible",
2092     signature => {
2093         desc  => 'Determines if a hold were to be placed by a given user, ' .
2094              'whether or not said hold would have any potential copies to fulfill it.' .
2095              'The named paramaters of the second argument include: ' .
2096              'patronid, titleid, volume_id, copy_id, mrid, depth, pickup_lib, hold_type, selection_ou. ' .
2097              'See perldoc ' . __PACKAGE__ . ' for more info on these fields.' , 
2098         params => [
2099             { desc => 'Authentication token',     type => 'string'},
2100             { desc => 'Hash of named parameters', type => 'object'},
2101         ],
2102         return => {
2103             desc => 'List of new message IDs (empty if none)',
2104             type => 'array'
2105         }
2106     }
2107 );
2108
2109 =head3 check_title_hold (token, hash)
2110
2111 The named fields in the hash are: 
2112
2113  patronid     - ID of the hold recipient  (required)
2114  depth        - hold range depth          (default 0)
2115  pickup_lib   - destination for hold, fallback value for selection_ou
2116  selection_ou - ID of org_unit establishing hard and soft hold boundary settings
2117  issuanceid   - ID of the issuance to be held, required for Issuance level hold
2118  partid       - ID of the monograph part to be held, required for monograph part level hold
2119  titleid      - ID (BRN) of the title to be held, required for Title level hold
2120  volume_id    - required for Volume level hold
2121  copy_id      - required for Copy level hold
2122  mrid         - required for Meta-record level hold
2123  hold_type    - T, C (or R or F), I, V or M for Title, Copy, Issuance, Volume or Meta-record  (default "T")
2124
2125 All key/value pairs are passed on to do_possibility_checks.
2126
2127 =cut
2128
2129 # FIXME: better params checking.  what other params are required, if any?
2130 # FIXME: 3 copies of values confusing: $x, $params->{x} and $params{x}
2131 # FIXME: for example, $depth gets a default value, but then $$params{depth} is still 
2132 # used in conditionals, where it may be undefined, causing a warning.
2133 # FIXME: specify proper usage/interaction of selection_ou and pickup_lib
2134
2135 sub check_title_hold {
2136     my( $self, $client, $authtoken, $params ) = @_;
2137     my $e = new_editor(authtoken=>$authtoken);
2138     return $e->event unless $e->checkauth;
2139
2140     my %params       = %$params;
2141     my $depth        = $params{depth}        || 0;
2142     my $selection_ou = $params{selection_ou} || $params{pickup_lib};
2143
2144         my $patron = $e->retrieve_actor_user($params{patronid})
2145                 or return $e->event;
2146
2147         if( $e->requestor->id ne $patron->id ) {
2148                 return $e->event unless 
2149                         $e->allowed('VIEW_HOLD_PERMIT', $patron->home_ou);
2150         }
2151
2152         return OpenILS::Event->new('PATRON_BARRED') if $U->is_true($patron->barred);
2153
2154         my $request_lib = $e->retrieve_actor_org_unit($e->requestor->ws_ou)
2155                 or return $e->event;
2156
2157     my $soft_boundary = $U->ou_ancestor_setting_value($selection_ou, OILS_SETTING_HOLD_SOFT_BOUNDARY);
2158     my $hard_boundary = $U->ou_ancestor_setting_value($selection_ou, OILS_SETTING_HOLD_HARD_BOUNDARY);
2159
2160     my @status = ();
2161     my $return_depth = $hard_boundary; # default depth to return on success
2162     if(defined $soft_boundary and $depth < $soft_boundary) {
2163         # work up the tree and as soon as we find a potential copy, use that depth
2164         # also, make sure we don't go past the hard boundary if it exists
2165
2166         # our min boundary is the greater of user-specified boundary or hard boundary
2167         my $min_depth = (defined $hard_boundary and $hard_boundary > $depth) ?  
2168             $hard_boundary : $depth;
2169
2170         my $depth = $soft_boundary;
2171         while($depth >= $min_depth) {
2172             $logger->info("performing hold possibility check with soft boundary $depth");
2173             @status = do_possibility_checks($e, $patron, $request_lib, $depth, %params);
2174             if ($status[0]) {
2175                 $return_depth = $depth;
2176                 last;
2177             }
2178             $depth--;
2179         }
2180     } elsif(defined $hard_boundary and $depth < $hard_boundary) {
2181         # there is no soft boundary, enforce the hard boundary if it exists
2182         $logger->info("performing hold possibility check with hard boundary $hard_boundary");
2183         @status = do_possibility_checks($e, $patron, $request_lib, $hard_boundary, %params);
2184     } else {
2185         # no boundaries defined, fall back to user specifed boundary or no boundary
2186         $logger->info("performing hold possibility check with no boundary");
2187         @status = do_possibility_checks($e, $patron, $request_lib, $params{depth}, %params);
2188     }
2189
2190     if ($status[0]) {
2191         return {
2192             "success" => 1,
2193             "depth" => $return_depth,
2194             "local_avail" => $status[1]
2195         };
2196     } elsif ($status[2]) {
2197         my $n = scalar @{$status[2]};
2198         return {"success" => 0, "last_event" => $status[2]->[$n - 1]};
2199     } else {
2200         return {"success" => 0};
2201     }
2202 }
2203
2204
2205
2206 sub do_possibility_checks {
2207     my($e, $patron, $request_lib, $depth, %params) = @_;
2208
2209     my $issuanceid   = $params{issuanceid}      || "";
2210     my $partid       = $params{partid}      || "";
2211     my $titleid      = $params{titleid}      || "";
2212     my $volid        = $params{volume_id};
2213     my $copyid       = $params{copy_id};
2214     my $mrid         = $params{mrid}         || "";
2215     my $pickup_lib   = $params{pickup_lib};
2216     my $hold_type    = $params{hold_type}    || 'T';
2217     my $selection_ou = $params{selection_ou} || $pickup_lib;
2218     my $holdable_formats = $params{holdable_formats};
2219
2220
2221         my $copy;
2222         my $volume;
2223         my $title;
2224
2225         if( $hold_type eq OILS_HOLD_TYPE_FORCE || $hold_type eq OILS_HOLD_TYPE_RECALL || $hold_type eq OILS_HOLD_TYPE_COPY ) {
2226
2227         return $e->event unless $copy   = $e->retrieve_asset_copy($copyid);
2228         return $e->event unless $volume = $e->retrieve_asset_call_number($copy->call_number);
2229         return $e->event unless $title  = $e->retrieve_biblio_record_entry($volume->record);
2230
2231         return verify_copy_for_hold( 
2232             $patron, $e->requestor, $title, $copy, $pickup_lib, $request_lib
2233         );
2234
2235         } elsif( $hold_type eq OILS_HOLD_TYPE_VOLUME ) {
2236
2237                 return $e->event unless $volume = $e->retrieve_asset_call_number($volid);
2238                 return $e->event unless $title  = $e->retrieve_biblio_record_entry($volume->record);
2239
2240                 return _check_volume_hold_is_possible(
2241                         $volume, $title, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou
2242         );
2243
2244         } elsif( $hold_type eq OILS_HOLD_TYPE_TITLE ) {
2245
2246                 return _check_title_hold_is_possible(
2247                         $titleid, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou
2248         );
2249
2250         } elsif( $hold_type eq OILS_HOLD_TYPE_ISSUANCE ) {
2251
2252                 return _check_issuance_hold_is_possible(
2253                         $issuanceid, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou
2254         );
2255
2256         } elsif( $hold_type eq OILS_HOLD_TYPE_MONOPART ) {
2257
2258                 return _check_monopart_hold_is_possible(
2259                         $partid, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou
2260         );
2261
2262         } elsif( $hold_type eq OILS_HOLD_TYPE_METARECORD ) {
2263
2264                 my $maps = $e->search_metabib_metarecord_source_map({metarecord=>$mrid});
2265                 my @recs = map { $_->source } @$maps;
2266                 my @status = ();
2267                 for my $rec (@recs) {
2268                         @status = _check_title_hold_is_possible(
2269                                 $rec, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou, $holdable_formats
2270                         );
2271                         last if $status[0];
2272                 }
2273                 return @status;
2274         }
2275 #   else { Unrecognized hold_type ! }   # FIXME: return error? or 0?
2276 }
2277
2278 my %prox_cache;
2279 sub create_ranged_org_filter {
2280     my($e, $selection_ou, $depth) = @_;
2281
2282     # find the orgs from which this hold may be fulfilled, 
2283     # based on the selection_ou and depth
2284
2285     my $top_org = $e->search_actor_org_unit([
2286         {parent_ou => undef}, 
2287         {flesh=>1, flesh_fields=>{aou=>['ou_type']}}])->[0];
2288     my %org_filter;
2289
2290     return () if $depth == $top_org->ou_type->depth;
2291
2292     my $org_list = $U->storagereq('open-ils.storage.actor.org_unit.descendants.atomic', $selection_ou, $depth);
2293     %org_filter = (circ_lib => []);
2294     push(@{$org_filter{circ_lib}}, $_->id) for @$org_list;
2295
2296     $logger->info("hold org filter at depth $depth and selection_ou ".
2297         "$selection_ou created list of @{$org_filter{circ_lib}}");
2298
2299     return %org_filter;
2300 }
2301
2302
2303 sub _check_title_hold_is_possible {
2304     my( $titleid, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou, $holdable_formats ) = @_;
2305    
2306     my ($types, $formats, $lang);
2307     if (defined($holdable_formats)) {
2308         ($types, $formats, $lang) = split '-', $holdable_formats;
2309     }
2310
2311     my $e = new_editor();
2312     my %org_filter = create_ranged_org_filter($e, $selection_ou, $depth);
2313
2314     # this monster will grab the id and circ_lib of all of the "holdable" copies for the given record
2315     my $copies = $e->json_query(
2316         { 
2317             select => { acp => ['id', 'circ_lib'] },
2318               from => {
2319                 acp => {
2320                     acn => {
2321                         field  => 'id',
2322                         fkey   => 'call_number',
2323                         'join' => {
2324                             bre => {
2325                                 field  => 'id',
2326                                 filter => { id => $titleid },
2327                                 fkey   => 'record'
2328                             },
2329                             mrd => {
2330                                 field  => 'record',
2331                                 fkey   => 'record',
2332                                 filter => {
2333                                     record => $titleid,
2334                                     ( $types   ? (item_type => [split '', $types])   : () ),
2335                                     ( $formats ? (item_form => [split '', $formats]) : () ),
2336                                     ( $lang    ? (item_lang => $lang)                : () )
2337                                 }
2338                             }
2339                         }
2340                     },
2341                     acpl => { field => 'id', filter => { holdable => 't'}, fkey => 'location' },
2342                     ccs  => { field => 'id', filter => { holdable => 't'}, fkey => 'status'   },
2343                     acpm => { field => 'target_copy', type => 'left' } # ignore part-linked copies
2344                 }
2345             }, 
2346             where => {
2347                 '+acp' => { circulate => 't', deleted => 'f', holdable => 't', %org_filter },
2348                 '+acpm' => { target_copy => undef } # ignore part-linked copies
2349             }
2350         }
2351     );
2352
2353     $logger->info("title possible found ".scalar(@$copies)." potential copies");
2354     return (
2355         0, 0, [
2356             new OpenILS::Event(
2357                 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2358                 "payload" => {"fail_part" => "no_ultimate_items"}
2359             )
2360         ]
2361     ) unless @$copies;
2362
2363     # -----------------------------------------------------------------------
2364     # sort the copies into buckets based on their circ_lib proximity to 
2365     # the patron's home_ou.  
2366     # -----------------------------------------------------------------------
2367
2368     my $home_org = $patron->home_ou;
2369     my $req_org = $request_lib->id;
2370
2371     $logger->info("prox cache $home_org " . $prox_cache{$home_org});
2372
2373     $prox_cache{$home_org} = 
2374         $e->search_actor_org_unit_proximity({from_org => $home_org})
2375         unless $prox_cache{$home_org};
2376     my $home_prox = $prox_cache{$home_org};
2377
2378     my %buckets;
2379     my %hash = map { ($_->to_org => $_->prox) } @$home_prox;
2380     push( @{$buckets{ $hash{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2381
2382     my @keys = sort { $a <=> $b } keys %buckets;
2383
2384
2385     if( $home_org ne $req_org ) {
2386       # -----------------------------------------------------------------------
2387       # shove the copies close to the request_lib into the primary buckets 
2388       # directly before the farthest away copies.  That way, they are not 
2389       # given priority, but they are checked before the farthest copies.
2390       # -----------------------------------------------------------------------
2391         $prox_cache{$req_org} = 
2392             $e->search_actor_org_unit_proximity({from_org => $req_org})
2393             unless $prox_cache{$req_org};
2394         my $req_prox = $prox_cache{$req_org};
2395
2396         my %buckets2;
2397         my %hash2 = map { ($_->to_org => $_->prox) } @$req_prox;
2398         push( @{$buckets2{ $hash2{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2399
2400         my $highest_key = $keys[@keys - 1];  # the farthest prox in the exising buckets
2401         my $new_key = $highest_key - 0.5; # right before the farthest prox
2402         my @keys2   = sort { $a <=> $b } keys %buckets2;
2403         for my $key (@keys2) {
2404             last if $key >= $highest_key;
2405             push( @{$buckets{$new_key}}, $_ ) for @{$buckets2{$key}};
2406         }
2407     }
2408
2409     @keys = sort { $a <=> $b } keys %buckets;
2410
2411     my $title;
2412     my %seen;
2413     my @status;
2414     OUTER: for my $key (@keys) {
2415       my @cps = @{$buckets{$key}};
2416
2417       $logger->info("looking at " . scalar(@{$buckets{$key}}). " copies in proximity bucket $key");
2418
2419       for my $copyid (@cps) {
2420
2421          next if $seen{$copyid};
2422          $seen{$copyid} = 1; # there could be dupes given the merged buckets
2423          my $copy = $e->retrieve_asset_copy($copyid);
2424          $logger->debug("looking at bucket_key=$key, copy $copyid : circ_lib = " . $copy->circ_lib);
2425
2426          unless($title) { # grab the title if we don't already have it
2427             my $vol = $e->retrieve_asset_call_number(
2428                [ $copy->call_number, { flesh => 1, flesh_fields => { bre => ['fixed_fields'], acn => ['record'] } } ] );
2429             $title = $vol->record;
2430          }
2431    
2432          @status = verify_copy_for_hold(
2433             $patron, $requestor, $title, $copy, $pickup_lib, $request_lib);
2434
2435          last OUTER if $status[0];
2436       }
2437     }
2438
2439     return @status;
2440 }
2441
2442 sub _check_issuance_hold_is_possible {
2443     my( $issuanceid, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou ) = @_;
2444    
2445     my $e = new_editor();
2446     my %org_filter = create_ranged_org_filter($e, $selection_ou, $depth);
2447
2448     # this monster will grab the id and circ_lib of all of the "holdable" copies for the given record
2449     my $copies = $e->json_query(
2450         { 
2451             select => { acp => ['id', 'circ_lib'] },
2452               from => {
2453                 acp => {
2454                     sitem => {
2455                         field  => 'unit',
2456                         fkey   => 'id',
2457                         filter => { issuance => $issuanceid }
2458                     },
2459                     acpl => { field => 'id', filter => { holdable => 't'}, fkey => 'location' },
2460                     ccs  => { field => 'id', filter => { holdable => 't'}, fkey => 'status'   }
2461                 }
2462             }, 
2463             where => {
2464                 '+acp' => { circulate => 't', deleted => 'f', holdable => 't', %org_filter }
2465             },
2466             distinct => 1
2467         }
2468     );
2469
2470     $logger->info("issuance possible found ".scalar(@$copies)." potential copies");
2471
2472     my $empty_ok;
2473     if (!@$copies) {
2474         $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_issuance_ok');
2475         $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2476
2477         return (
2478             0, 0, [
2479                 new OpenILS::Event(
2480                     "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2481                     "payload" => {"fail_part" => "no_ultimate_items"}
2482                 )
2483             ]
2484         ) unless $empty_ok;
2485
2486         return (1, 0);
2487     }
2488
2489     # -----------------------------------------------------------------------
2490     # sort the copies into buckets based on their circ_lib proximity to 
2491     # the patron's home_ou.  
2492     # -----------------------------------------------------------------------
2493
2494     my $home_org = $patron->home_ou;
2495     my $req_org = $request_lib->id;
2496
2497     $logger->info("prox cache $home_org " . $prox_cache{$home_org});
2498
2499     $prox_cache{$home_org} = 
2500         $e->search_actor_org_unit_proximity({from_org => $home_org})
2501         unless $prox_cache{$home_org};
2502     my $home_prox = $prox_cache{$home_org};
2503
2504     my %buckets;
2505     my %hash = map { ($_->to_org => $_->prox) } @$home_prox;
2506     push( @{$buckets{ $hash{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2507
2508     my @keys = sort { $a <=> $b } keys %buckets;
2509
2510
2511     if( $home_org ne $req_org ) {
2512       # -----------------------------------------------------------------------
2513       # shove the copies close to the request_lib into the primary buckets 
2514       # directly before the farthest away copies.  That way, they are not 
2515       # given priority, but they are checked before the farthest copies.
2516       # -----------------------------------------------------------------------
2517         $prox_cache{$req_org} = 
2518             $e->search_actor_org_unit_proximity({from_org => $req_org})
2519             unless $prox_cache{$req_org};
2520         my $req_prox = $prox_cache{$req_org};
2521
2522         my %buckets2;
2523         my %hash2 = map { ($_->to_org => $_->prox) } @$req_prox;
2524         push( @{$buckets2{ $hash2{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2525
2526         my $highest_key = $keys[@keys - 1];  # the farthest prox in the exising buckets
2527         my $new_key = $highest_key - 0.5; # right before the farthest prox
2528         my @keys2   = sort { $a <=> $b } keys %buckets2;
2529         for my $key (@keys2) {
2530             last if $key >= $highest_key;
2531             push( @{$buckets{$new_key}}, $_ ) for @{$buckets2{$key}};
2532         }
2533     }
2534
2535     @keys = sort { $a <=> $b } keys %buckets;
2536
2537     my $title;
2538     my %seen;
2539     my @status;
2540     OUTER: for my $key (@keys) {
2541       my @cps = @{$buckets{$key}};
2542
2543       $logger->info("looking at " . scalar(@{$buckets{$key}}). " copies in proximity bucket $key");
2544
2545       for my $copyid (@cps) {
2546
2547          next if $seen{$copyid};
2548          $seen{$copyid} = 1; # there could be dupes given the merged buckets
2549          my $copy = $e->retrieve_asset_copy($copyid);
2550          $logger->debug("looking at bucket_key=$key, copy $copyid : circ_lib = " . $copy->circ_lib);
2551
2552          unless($title) { # grab the title if we don't already have it
2553             my $vol = $e->retrieve_asset_call_number(
2554                [ $copy->call_number, { flesh => 1, flesh_fields => { bre => ['fixed_fields'], acn => ['record'] } } ] );
2555             $title = $vol->record;
2556          }
2557    
2558          @status = verify_copy_for_hold(
2559             $patron, $requestor, $title, $copy, $pickup_lib, $request_lib);
2560
2561          last OUTER if $status[0];
2562       }
2563     }
2564
2565     if (!$status[0]) {
2566         if (!defined($empty_ok)) {
2567             $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_issuance_ok');
2568             $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2569         }
2570
2571         return (1,0) if ($empty_ok);
2572     }
2573     return @status;
2574 }
2575
2576 sub _check_monopart_hold_is_possible {
2577     my( $partid, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou ) = @_;
2578    
2579     my $e = new_editor();
2580     my %org_filter = create_ranged_org_filter($e, $selection_ou, $depth);
2581
2582     # this monster will grab the id and circ_lib of all of the "holdable" copies for the given record
2583     my $copies = $e->json_query(
2584         { 
2585             select => { acp => ['id', 'circ_lib'] },
2586               from => {
2587                 acp => {
2588                     acpm => {
2589                         field  => 'target_copy',
2590                         fkey   => 'id',
2591                         filter => { part => $partid }
2592                     },
2593                     acpl => { field => 'id', filter => { holdable => 't'}, fkey => 'location' },
2594                     ccs  => { field => 'id', filter => { holdable => 't'}, fkey => 'status'   }
2595                 }
2596             }, 
2597             where => {
2598                 '+acp' => { circulate => 't', deleted => 'f', holdable => 't', %org_filter }
2599             },
2600             distinct => 1
2601         }
2602     );
2603
2604     $logger->info("monopart possible found ".scalar(@$copies)." potential copies");
2605
2606     my $empty_ok;
2607     if (!@$copies) {
2608         $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_part_ok');
2609         $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2610
2611         return (
2612             0, 0, [
2613                 new OpenILS::Event(
2614                     "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2615                     "payload" => {"fail_part" => "no_ultimate_items"}
2616                 )
2617             ]
2618         ) unless $empty_ok;
2619
2620         return (1, 0);
2621     }
2622
2623     # -----------------------------------------------------------------------
2624     # sort the copies into buckets based on their circ_lib proximity to 
2625     # the patron's home_ou.  
2626     # -----------------------------------------------------------------------
2627
2628     my $home_org = $patron->home_ou;
2629     my $req_org = $request_lib->id;
2630
2631     $logger->info("prox cache $home_org " . $prox_cache{$home_org});
2632
2633     $prox_cache{$home_org} = 
2634         $e->search_actor_org_unit_proximity({from_org => $home_org})
2635         unless $prox_cache{$home_org};
2636     my $home_prox = $prox_cache{$home_org};
2637
2638     my %buckets;
2639     my %hash = map { ($_->to_org => $_->prox) } @$home_prox;
2640     push( @{$buckets{ $hash{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2641
2642     my @keys = sort { $a <=> $b } keys %buckets;
2643
2644
2645     if( $home_org ne $req_org ) {
2646       # -----------------------------------------------------------------------
2647       # shove the copies close to the request_lib into the primary buckets 
2648       # directly before the farthest away copies.  That way, they are not 
2649       # given priority, but they are checked before the farthest copies.
2650       # -----------------------------------------------------------------------
2651         $prox_cache{$req_org} = 
2652             $e->search_actor_org_unit_proximity({from_org => $req_org})
2653             unless $prox_cache{$req_org};
2654         my $req_prox = $prox_cache{$req_org};
2655
2656         my %buckets2;
2657         my %hash2 = map { ($_->to_org => $_->prox) } @$req_prox;
2658         push( @{$buckets2{ $hash2{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2659
2660         my $highest_key = $keys[@keys - 1];  # the farthest prox in the exising buckets
2661         my $new_key = $highest_key - 0.5; # right before the farthest prox
2662         my @keys2   = sort { $a <=> $b } keys %buckets2;
2663         for my $key (@keys2) {
2664             last if $key >= $highest_key;
2665             push( @{$buckets{$new_key}}, $_ ) for @{$buckets2{$key}};
2666         }
2667     }
2668
2669     @keys = sort { $a <=> $b } keys %buckets;
2670
2671     my $title;
2672     my %seen;
2673     my @status;
2674     OUTER: for my $key (@keys) {
2675       my @cps = @{$buckets{$key}};
2676
2677       $logger->info("looking at " . scalar(@{$buckets{$key}}). " copies in proximity bucket $key");
2678
2679       for my $copyid (@cps) {
2680
2681          next if $seen{$copyid};
2682          $seen{$copyid} = 1; # there could be dupes given the merged buckets
2683          my $copy = $e->retrieve_asset_copy($copyid);
2684          $logger->debug("looking at bucket_key=$key, copy $copyid : circ_lib = " . $copy->circ_lib);
2685
2686          unless($title) { # grab the title if we don't already have it
2687             my $vol = $e->retrieve_asset_call_number(
2688                [ $copy->call_number, { flesh => 1, flesh_fields => { bre => ['fixed_fields'], acn => ['record'] } } ] );
2689             $title = $vol->record;
2690          }
2691    
2692          @status = verify_copy_for_hold(
2693             $patron, $requestor, $title, $copy, $pickup_lib, $request_lib);
2694
2695          last OUTER if $status[0];
2696       }
2697     }
2698
2699     if (!$status[0]) {
2700         if (!defined($empty_ok)) {
2701             $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_part_ok');
2702             $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2703         }
2704
2705         return (1,0) if ($empty_ok);
2706     }
2707     return @status;
2708 }
2709
2710
2711 sub _check_volume_hold_is_possible {
2712         my( $vol, $title, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou ) = @_;
2713     my %org_filter = create_ranged_org_filter(new_editor(), $selection_ou, $depth);
2714         my $copies = new_editor->search_asset_copy({call_number => $vol->id, %org_filter});
2715         $logger->info("checking possibility of volume hold for volume ".$vol->id);
2716
2717     my $filter_copies = [];
2718     for my $copy (@$copies) {
2719         # ignore part-mapped copies for regular volume level holds
2720         push(@$filter_copies, $copy) unless
2721             new_editor->search_asset_copy_part_map({target_copy => $copy->id})->[0];
2722     }
2723     $copies = $filter_copies;
2724
2725     return (
2726         0, 0, [
2727             new OpenILS::Event(
2728                 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2729                 "payload" => {"fail_part" => "no_ultimate_items"}
2730             )
2731         ]
2732     ) unless @$copies;
2733
2734     my @status;
2735         for my $copy ( @$copies ) {
2736         @status = verify_copy_for_hold(
2737                         $patron, $requestor, $title, $copy, $pickup_lib, $request_lib );
2738         last if $status[0];
2739         }
2740         return @status;
2741 }
2742
2743
2744
2745 sub verify_copy_for_hold {
2746         my( $patron, $requestor, $title, $copy, $pickup_lib, $request_lib ) = @_;
2747         $logger->info("checking possibility of copy in hold request for copy ".$copy->id);
2748     my $permitted = OpenILS::Utils::PermitHold::permit_copy_hold(
2749                 {       patron                          => $patron, 
2750                         requestor                       => $requestor, 
2751                         copy                            => $copy,
2752                         title                           => $title, 
2753                         title_descriptor        => $title->fixed_fields, # this is fleshed into the title object
2754                         pickup_lib                      => $pickup_lib,
2755                         request_lib                     => $request_lib,
2756             new_hold            => 1,
2757             show_event_list     => 1
2758                 } 
2759         );
2760
2761     return (
2762         (not scalar @$permitted), # true if permitted is an empty arrayref
2763         (   # XXX This test is of very dubious value; someone should figure
2764             # out what if anything is checking this value
2765                 ($copy->circ_lib == $pickup_lib) and 
2766             ($copy->status == OILS_COPY_STATUS_AVAILABLE)
2767         ),
2768         $permitted
2769     );
2770 }
2771
2772
2773
2774 sub find_nearest_permitted_hold {
2775
2776     my $class  = shift;
2777     my $editor = shift;     # CStoreEditor object
2778     my $copy   = shift;     # copy to target
2779     my $user   = shift;     # staff
2780     my $check_only = shift; # do no updates, just see if the copy could fulfill a hold
2781       
2782     my $evt = OpenILS::Event->new('ACTION_HOLD_REQUEST_NOT_FOUND');
2783
2784     my $bc = $copy->barcode;
2785
2786         # find any existing holds that already target this copy
2787         my $old_holds = $editor->search_action_hold_request(
2788                 {       current_copy => $copy->id, 
2789                         cancel_time  => undef, 
2790                         capture_time => undef 
2791                 } 
2792         );
2793
2794         # hold->type "R" means we need this copy
2795         for my $h (@$old_holds) { return ($h) if $h->hold_type eq 'R'; }
2796
2797
2798     my $hold_stall_interval = $U->ou_ancestor_setting_value($user->ws_ou, OILS_SETTING_HOLD_SOFT_STALL);
2799
2800         $logger->info("circulator: searching for best hold at org ".$user->ws_ou.
2801         " and copy $bc with a hold stalling interval of ". ($hold_stall_interval || "(none)"));
2802
2803         my $fifo = $U->ou_ancestor_setting_value($user->ws_ou, 'circ.holds_fifo');
2804
2805         # search for what should be the best holds for this copy to fulfill
2806         my $best_holds = $U->storagereq(
2807         "open-ils.storage.action.hold_request.nearest_hold.atomic", 
2808                 $user->ws_ou, $copy->id, 10, $hold_stall_interval, $fifo );
2809
2810         unless(@$best_holds) {
2811
2812                 if( my $hold = $$old_holds[0] ) {
2813                         $logger->info("circulator: using existing pre-targeted hold ".$hold->id." in hold search");
2814                         return ($hold);
2815                 }
2816
2817                 $logger->info("circulator: no suitable holds found for copy $bc");
2818                 return (undef, $evt);
2819         }
2820
2821
2822         my $best_hold;
2823
2824         # for each potential hold, we have to run the permit script
2825         # to make sure the hold is actually permitted.
2826     my %reqr_cache;
2827     my %org_cache;
2828         for my $holdid (@$best_holds) {
2829                 next unless $holdid;
2830                 $logger->info("circulator: checking if hold $holdid is permitted for copy $bc");
2831
2832                 my $hold = $editor->retrieve_action_hold_request($holdid) or next;
2833                 my $reqr = $reqr_cache{$hold->requestor} || $editor->retrieve_actor_user($hold->requestor);
2834                 my $rlib = $org_cache{$hold->request_lib} || $editor->retrieve_actor_org_unit($hold->request_lib);
2835
2836                 $reqr_cache{$hold->requestor} = $reqr;
2837                 $org_cache{$hold->request_lib} = $rlib;
2838
2839                 # see if this hold is permitted
2840                 my $permitted = OpenILS::Utils::PermitHold::permit_copy_hold(
2841                         {       patron_id                       => $hold->usr,
2842                                 requestor                       => $reqr,
2843                                 copy                            => $copy,
2844                                 pickup_lib                      => $hold->pickup_lib,
2845                                 request_lib                     => $rlib,
2846                                 retarget                        => 1
2847                         } 
2848                 );
2849
2850                 if( $permitted ) {
2851                         $best_hold = $hold;
2852                         last;
2853                 }
2854         }
2855
2856
2857         unless( $best_hold ) { # no "good" permitted holds were found
2858                 if( my $hold = $$old_holds[0] ) { # can we return a pre-targeted hold?
2859                         $logger->info("circulator: using existing pre-targeted hold ".$hold->id." in hold search");
2860                         return ($hold);
2861                 }
2862
2863                 # we got nuthin
2864                 $logger->info("circulator: no suitable holds found for copy $bc");
2865                 return (undef, $evt);
2866         }
2867
2868         $logger->info("circulator: best hold ".$best_hold->id." found for copy $bc");
2869
2870         # indicate a permitted hold was found
2871         return $best_hold if $check_only;
2872
2873         # we've found a permitted hold.  we need to "grab" the copy 
2874         # to prevent re-targeted holds (next part) from re-grabbing the copy
2875         $best_hold->current_copy($copy->id);
2876         $editor->update_action_hold_request($best_hold) 
2877                 or return (undef, $editor->event);
2878
2879
2880     my @retarget;
2881
2882         # re-target any other holds that already target this copy
2883         for my $old_hold (@$old_holds) {
2884                 next if $old_hold->id eq $best_hold->id; # don't re-target the hold we want
2885                 $logger->info("circulator: clearing current_copy and prev_check_time on hold ".
2886             $old_hold->id." after a better hold [".$best_hold->id."] was found");
2887         $old_hold->clear_current_copy;
2888         $old_hold->clear_prev_check_time;
2889         $editor->update_action_hold_request($old_hold) 
2890             or return (undef, $editor->event);
2891         push(@retarget, $old_hold->id);
2892         }
2893
2894         return ($best_hold, undef, (@retarget) ? \@retarget : undef);
2895 }
2896
2897
2898
2899
2900
2901
2902 __PACKAGE__->register_method(
2903     method   => 'all_rec_holds',
2904     api_name => 'open-ils.circ.holds.retrieve_all_from_title',
2905 );
2906
2907 sub all_rec_holds {
2908         my( $self, $conn, $auth, $title_id, $args ) = @_;
2909
2910         my $e = new_editor(authtoken=>$auth);
2911         $e->checkauth or return $e->event;
2912         $e->allowed('VIEW_HOLD') or return $e->event;
2913
2914         $args ||= {};
2915     $args->{fulfillment_time} = undef; #  we don't want to see old fulfilled holds
2916         $args->{cancel_time} = undef;
2917
2918         my $resp = { volume_holds => [], copy_holds => [], recall_holds => [], force_holds => [], metarecord_holds => [], part_holds => [], issuance_holds => [] };
2919
2920     my $mr_map = $e->search_metabib_metarecord_source_map({source => $title_id})->[0];
2921     if($mr_map) {
2922         $resp->{metarecord_holds} = $e->search_action_hold_request(
2923             {   hold_type => OILS_HOLD_TYPE_METARECORD,
2924                 target => $mr_map->metarecord,
2925                 %$args 
2926             }, {idlist => 1}
2927         );
2928     }
2929
2930         $resp->{title_holds} = $e->search_action_hold_request(
2931                 { 
2932                         hold_type => OILS_HOLD_TYPE_TITLE, 
2933                         target => $title_id, 
2934                         %$args 
2935                 }, {idlist=>1} );
2936
2937     my $parts = $e->search_biblio_monograph_part(
2938         {
2939             record => $title_id
2940         }, {idlist=>1} );
2941
2942     if (@$parts) {
2943         $resp->{part_holds} = $e->search_action_hold_request(
2944             {
2945                 hold_type => OILS_HOLD_TYPE_MONOPART,
2946                 target => $parts,
2947                 %$args
2948             }, {idlist=>1} );
2949     }
2950
2951     my $subs = $e->search_serial_subscription(
2952         { record_entry => $title_id }, {idlist=>1});
2953
2954     if (@$subs) {
2955         my $issuances = $e->search_serial_issuance(
2956             {subscription => $subs}, {idlist=>1}
2957         );
2958
2959         if ($issuances) {
2960             $resp->{issuance_holds} = $e->search_action_hold_request(
2961                 {
2962                     hold_type => OILS_HOLD_TYPE_ISSUANCE,
2963                     target => $issuances,
2964                     %$args
2965                 }, {idlist=>1}
2966             );
2967         }
2968     }
2969
2970         my $vols = $e->search_asset_call_number(
2971                 { record => $title_id, deleted => 'f' }, {idlist=>1});
2972
2973         return $resp unless @$vols;
2974
2975         $resp->{volume_holds} = $e->search_action_hold_request(
2976                 { 
2977                         hold_type => OILS_HOLD_TYPE_VOLUME, 
2978                         target => $vols,
2979                         %$args }, 
2980                 {idlist=>1} );
2981
2982         my $copies = $e->search_asset_copy(
2983                 { call_number => $vols, deleted => 'f' }, {idlist=>1});
2984
2985         return $resp unless @$copies;
2986
2987         $resp->{copy_holds} = $e->search_action_hold_request(
2988                 { 
2989                         hold_type => OILS_HOLD_TYPE_COPY,
2990                         target => $copies,
2991                         %$args }, 
2992                 {idlist=>1} );
2993
2994         $resp->{recall_holds} = $e->search_action_hold_request(
2995                 { 
2996                         hold_type => OILS_HOLD_TYPE_RECALL,
2997                         target => $copies,
2998                         %$args }, 
2999                 {idlist=>1} );
3000
3001         $resp->{force_holds} = $e->search_action_hold_request(
3002                 { 
3003                         hold_type => OILS_HOLD_TYPE_FORCE,
3004                         target => $copies,
3005                         %$args }, 
3006                 {idlist=>1} );
3007
3008         return $resp;
3009 }
3010
3011
3012
3013
3014
3015 __PACKAGE__->register_method(
3016     method        => 'uber_hold',
3017     authoritative => 1,
3018     api_name      => 'open-ils.circ.hold.details.retrieve'
3019 );
3020
3021 sub uber_hold {
3022         my($self, $client, $auth, $hold_id, $args) = @_;
3023         my $e = new_editor(authtoken=>$auth);
3024         $e->checkauth or return $e->event;
3025     return uber_hold_impl($e, $hold_id, $args);
3026 }
3027
3028 __PACKAGE__->register_method(
3029     method        => 'batch_uber_hold',
3030     authoritative => 1,
3031     stream        => 1,
3032     api_name      => 'open-ils.circ.hold.details.batch.retrieve'
3033 );
3034
3035 sub batch_uber_hold {
3036         my($self, $client, $auth, $hold_ids, $args) = @_;
3037         my $e = new_editor(authtoken=>$auth);
3038         $e->checkauth or return $e->event;
3039     $client->respond(uber_hold_impl($e, $_, $args)) for @$hold_ids;
3040     return undef;
3041 }
3042
3043 sub uber_hold_impl {
3044     my($e, $hold_id, $args) = @_;
3045     $args ||= {};
3046
3047         my $hold = $e->retrieve_action_hold_request(
3048                 [
3049                         $hold_id,
3050                         {
3051                                 flesh => 1,
3052                                 flesh_fields => { ahr => [ 'current_copy', 'usr', 'notes' ] }
3053                         }
3054                 ]
3055         ) or return $e->event;
3056
3057     if($hold->usr->id ne $e->requestor->id) {
3058         # A user is allowed to see his/her own holds
3059             $e->allowed('VIEW_HOLD') or return $e->event;
3060         $hold->notes( # filter out any non-staff ("private") notes
3061             [ grep { !$U->is_true($_->staff) } @{$hold->notes} ] );
3062
3063     } else {
3064         # caller is asking for own hold, but may not have permission to view staff notes
3065             unless($e->allowed('VIEW_HOLD')) {
3066             $hold->notes( # filter out any staff notes
3067                 [ grep { $U->is_true($_->staff) } @{$hold->notes} ] );
3068         }
3069     }
3070
3071         my $user = $hold->usr;
3072         $hold->usr($user->id);
3073
3074
3075         my( $mvr, $volume, $copy, $issuance, $part, $bre ) = find_hold_mvr($e, $hold, $args->{suppress_mvr});
3076
3077         flesh_hold_notices([$hold], $e) unless $args->{suppress_notices};
3078         flesh_hold_transits([$hold]) unless $args->{suppress_transits};
3079
3080     my $details = retrieve_hold_queue_status_impl($e, $hold);
3081
3082     my $resp = {
3083         hold    => $hold,
3084         bre_id  => $bre->id,
3085         ($copy     ? (copy           => $copy)     : ()),
3086         ($volume   ? (volume         => $volume)   : ()),
3087         ($issuance ? (issuance       => $issuance) : ()),
3088         ($part     ? (part           => $part)     : ()),
3089         ($args->{include_bre}  ?  (bre => $bre)    : ()),
3090         ($args->{suppress_mvr} ?  () : (mvr => $mvr)),
3091         %$details
3092     };
3093
3094     unless($args->{suppress_patron_details}) {
3095             my $card = $e->retrieve_actor_card($user->card) or return $e->event;
3096         $resp->{patron_first}   = $user->first_given_name,
3097         $resp->{patron_last}    = $user->family_name,
3098         $resp->{patron_barcode} = $card->barcode,
3099         $resp->{patron_alias}   = $user->alias,
3100     };
3101
3102     return $resp;
3103 }
3104
3105
3106
3107 # -----------------------------------------------------
3108 # Returns the MVR object that represents what the
3109 # hold is all about
3110 # -----------------------------------------------------
3111 sub find_hold_mvr {
3112         my( $e, $hold, $no_mvr ) = @_;
3113
3114         my $tid;
3115         my $copy;
3116         my $volume;
3117     my $issuance;
3118     my $part;
3119
3120         if( $hold->hold_type eq OILS_HOLD_TYPE_METARECORD ) {
3121                 my $mr = $e->retrieve_metabib_metarecord($hold->target)
3122                         or return $e->event;
3123                 $tid = $mr->master_record;
3124
3125         } elsif( $hold->hold_type eq OILS_HOLD_TYPE_TITLE ) {
3126                 $tid = $hold->target;
3127
3128         } elsif( $hold->hold_type eq OILS_HOLD_TYPE_VOLUME ) {
3129                 $volume = $e->retrieve_asset_call_number($hold->target)
3130                         or return $e->event;
3131                 $tid = $volume->record;
3132
3133     } elsif( $hold->hold_type eq OILS_HOLD_TYPE_ISSUANCE ) {
3134         $issuance = $e->retrieve_serial_issuance([
3135             $hold->target,
3136             {flesh => 1, flesh_fields => {siss => [ qw/subscription/ ]}}
3137         ]) or return $e->event;
3138
3139         $tid = $issuance->subscription->record_entry;
3140
3141     } elsif( $hold->hold_type eq OILS_HOLD_TYPE_MONOPART ) {
3142         $part = $e->retrieve_biblio_monograph_part([
3143             $hold->target
3144         ]) or return $e->event;
3145
3146         $tid = $part->record;
3147
3148         } elsif( $hold->hold_type eq OILS_HOLD_TYPE_COPY || $hold->hold_type eq OILS_HOLD_TYPE_RECALL || $hold->hold_type eq OILS_HOLD_TYPE_FORCE ) {
3149                 $copy = $e->retrieve_asset_copy([
3150             $hold->target, 
3151             {flesh => 1, flesh_fields => {acp => ['call_number']}}
3152         ]) or return $e->event;
3153         
3154                 $volume = $copy->call_number;
3155                 $tid = $volume->record;
3156         }
3157
3158         if(!$copy and ref $hold->current_copy ) {
3159                 $copy = $hold->current_copy;
3160                 $hold->current_copy($copy->id);
3161         }
3162
3163         if(!$volume and $copy) {
3164                 $volume = $e->retrieve_asset_call_number($copy->call_number);
3165         }
3166
3167     # TODO return metarcord mvr for M holds
3168         my $title = $e->retrieve_biblio_record_entry($tid);
3169         return ( ($no_mvr) ? undef : $U->record_to_mvr($title), $volume, $copy, $issuance, $part, $title );
3170 }
3171
3172 __PACKAGE__->register_method(
3173     method    => 'clear_shelf_cache',
3174     api_name  => 'open-ils.circ.hold.clear_shelf.get_cache',
3175     stream    => 1,
3176     signature => {
3177         desc => q/
3178             Returns the holds processed with the given cache key
3179         /
3180     }
3181 );
3182
3183 sub clear_shelf_cache {
3184     my($self, $client, $auth, $cache_key, $chunk_size) = @_;
3185     my $e = new_editor(authtoken => $auth, xact => 1);
3186     return $e->die_event unless $e->checkauth and $e->allowed('VIEW_HOLD');
3187
3188     $chunk_size ||= 25;
3189     my $hold_data = OpenSRF::Utils::Cache->new('global')->get_cache($cache_key);
3190
3191     if (!$hold_data) {
3192         $logger->info("no hold data found in cache"); # XXX TODO return event
3193         $e->rollback;
3194         return undef;
3195     }
3196
3197     my $maximum = 0;
3198     foreach (keys %$hold_data) {
3199         $maximum += scalar(@{ $hold_data->{$_} });
3200     }
3201     $client->respond({"maximum" => $maximum, "progress" => 0});
3202
3203     for my $action (sort keys %$hold_data) {
3204         while (@{$hold_data->{$action}}) {
3205             my @hid_chunk = splice @{$hold_data->{$action}}, 0, $chunk_size;
3206
3207             my $result_chunk = $e->json_query({
3208                 "select" => {
3209                     "acp" => ["barcode"],
3210                     "au" => [qw/
3211                         first_given_name second_given_name family_name alias
3212                     /],
3213                     "acn" => ["label"],
3214                     "acnp" => [{column => "label", alias => "prefix"}],
3215                     "acns" => [{column => "label", alias => "suffix"}],
3216                     "bre" => ["marc"],
3217                     "acpl" => ["name"],
3218                     "ahr" => ["id"]
3219                 },
3220                 "from" => {
3221                     "ahr" => {
3222                         "acp" => {
3223                             "field" => "id", "fkey" => "current_copy",
3224                             "join" => {
3225                                 "acn" => {
3226                                     "field" => "id", "fkey" => "call_number",
3227                                     "join" => {
3228                                         "bre" => {
3229                                             "field" => "id", "fkey" => "record"
3230                                         },
3231                                         "acnp" => {
3232                                             "field" => "id", "fkey" => "prefix"
3233                                         },
3234                                         "acns" => {
3235                                             "field" => "id", "fkey" => "suffix"
3236                                         }
3237                                     }
3238                                 },
3239                                 "acpl" => {"field" => "id", "fkey" => "location"}
3240                             }
3241                         },
3242                         "au" => {"field" => "id", "fkey" => "usr"}
3243                     }
3244                 },
3245                 "where" => {"+ahr" => {"id" => \@hid_chunk}}
3246             }, {"substream" => 1}) or return $e->die_event;
3247
3248             $client->respond([
3249                 map {
3250                     +{"action" => $action, "hold_details" => $_}
3251                 } @$result_chunk
3252             ]);
3253         }
3254     }
3255
3256     $e->rollback;
3257     return undef;
3258 }
3259
3260
3261 __PACKAGE__->register_method(
3262     method    => 'clear_shelf_process',
3263     stream    => 1,
3264     api_name  => 'open-ils.circ.hold.clear_shelf.process',
3265     signature => {
3266         desc => q/
3267             1. Find all holds that have expired on the holds shelf
3268             2. Cancel the holds
3269             3. If a clear-shelf status is configured, put targeted copies into this status
3270             4. Divide copies into 3 groups: items to transit, items to reshelve, and items
3271                 that are needed for holds.  No subsequent action is taken on the holds
3272                 or items after grouping.
3273         /
3274     }
3275 );
3276
3277 sub clear_shelf_process {
3278         my($self, $client, $auth, $org_id, $match_copy) = @_;
3279
3280     my $current_copy = { '!=' => undef };
3281     $current_copy = { '=' => $match_copy } if $match_copy;
3282
3283         my $e = new_editor(authtoken=>$auth, xact => 1);
3284         $e->checkauth or return $e->die_event;
3285         my $cache = OpenSRF::Utils::Cache->new('global');
3286
3287     $org_id ||= $e->requestor->ws_ou;
3288         $e->allowed('UPDATE_HOLD', $org_id) or return $e->die_event;
3289
3290     my $copy_status = $U->ou_ancestor_setting_value($org_id, 'circ.holds.clear_shelf.copy_status');
3291
3292     my @hold_ids = $self->method_lookup(
3293         "open-ils.circ.captured_holds.id_list.expired_on_shelf.retrieve"
3294     )->run($auth, $org_id);
3295
3296     my @holds;
3297     my @canceled_holds; # newly canceled holds
3298     my $chunk_size = 25; # chunked status updates
3299     my $counter = 0;
3300     for my $hold_id (@hold_ids) {
3301
3302         $logger->info("Clear shelf processing hold $hold_id");
3303         
3304         my $hold = $e->retrieve_action_hold_request([
3305             $hold_id, {   
3306                 flesh => 1,
3307                 flesh_fields => {ahr => ['current_copy']}
3308             }
3309         ]);
3310
3311         if (!$hold->cancel_time) { # may be canceled but still on the holds shelf
3312             $hold->cancel_time('now');
3313             $hold->cancel_cause(2); # Hold Shelf expiration
3314             $e->update_action_hold_request($hold) or return $e->die_event;
3315             delete_hold_copy_maps($self, $e, $hold->id) and return $e->die_event;
3316             push(@canceled_holds, $hold_id);
3317         }
3318
3319         my $copy = $hold->current_copy;
3320
3321         if($copy_status or $copy_status == 0) {
3322             # if a clear-shelf copy status is defined, update the copy
3323             $copy->status($copy_status);
3324             $copy->edit_date('now');
3325             $copy->editor($e->requestor->id);
3326             $e->update_asset_copy($copy) or return $e->die_event;
3327         }
3328
3329         push(@holds, $hold);
3330         $client->respond({maximum => scalar(@holds), progress => $counter}) if ( (++$counter % $chunk_size) == 0);
3331     }
3332
3333     if ($e->commit) {
3334
3335         my %cache_data = (
3336             hold => [],
3337             transit => [],
3338             shelf => []
3339         );
3340
3341         for my $hold (@holds) {
3342
3343             my $copy = $hold->current_copy;
3344             my ($alt_hold) = __PACKAGE__->find_nearest_permitted_hold($e, $copy, $e->requestor, 1);
3345
3346             if($alt_hold and !$match_copy) {
3347
3348                 push(@{$cache_data{hold}}, $hold->id); # copy is needed for a hold
3349
3350             } elsif($copy->circ_lib != $e->requestor->ws_ou) {
3351
3352                 push(@{$cache_data{transit}}, $hold->id); # copy needs to transit
3353
3354             } else {
3355
3356                 push(@{$cache_data{shelf}}, $hold->id); # copy needs to go back to the shelf
3357             }
3358         }
3359
3360         my $cache_key = md5_hex(time . $$ . rand());
3361         $logger->info("clear_shelf_cache: storing under $cache_key");
3362         $cache->put_cache($cache_key, \%cache_data, 7200); # TODO: 2 hours.  configurable?
3363
3364         # tell the client we're done
3365         $client->respond_complete({cache_key => $cache_key});
3366
3367         # ------------
3368         # fire off the hold cancelation trigger and wait for response so don't flood the service
3369
3370         # refetch the holds to pick up the caclulated cancel_time, 
3371         # which may be needed by Action/Trigger
3372         $e->xact_begin;
3373         my $updated_holds = $e->search_action_hold_request({id => \@canceled_holds}, {substream => 1});
3374         $e->rollback;
3375
3376         $U->create_events_for_hook(
3377             'hold_request.cancel.expire_holds_shelf', 
3378             $_, $org_id, undef, undef, 1) for @$updated_holds;
3379
3380     } else {
3381         # tell the client we're done
3382         $client->respond_complete;
3383     }
3384 }
3385
3386 __PACKAGE__->register_method(
3387     method    => 'usr_hold_summary',
3388     api_name  => 'open-ils.circ.holds.user_summary',
3389     signature => q/
3390         Returns a summary of holds statuses for a given user
3391     /
3392 );
3393
3394 sub usr_hold_summary {
3395     my($self, $conn, $auth, $user_id) = @_;
3396
3397         my $e = new_editor(authtoken=>$auth);
3398         $e->checkauth or return $e->event;
3399         $e->allowed('VIEW_HOLD') or return $e->event;
3400
3401     my $holds = $e->search_action_hold_request(
3402         {  
3403             usr =>  $user_id , 
3404             fulfillment_time => undef,
3405             cancel_time      => undef,
3406         }
3407     );
3408
3409     my %summary = (1 => 0, 2 => 0, 3 => 0, 4 => 0);
3410     $summary{_hold_status($e, $_)} += 1 for @$holds;
3411     return \%summary;
3412 }
3413
3414
3415
3416 __PACKAGE__->register_method(
3417     method    => 'hold_has_copy_at',
3418     api_name  => 'open-ils.circ.hold.has_copy_at',
3419     signature => {
3420         desc   => 
3421                 'Returns the ID of the found copy and name of the shelving location if there is ' .
3422                 'an available copy at the specified org unit.  Returns empty hash otherwise.  '   .
3423                 'The anticipated use for this method is to determine whether an item is '         .
3424                 'available at the library where the user is placing the hold (or, alternatively, '.
3425                 'at the pickup library) to encourage bypassing the hold placement and just '      .
3426                 'checking out the item.' ,
3427         params => [
3428             { desc => 'Authentication Token', type => 'string' },
3429             { desc => 'Method Arguments.  Options include: hold_type, hold_target, org_unit.  ' 
3430                     . 'hold_type is the hold type code (T, V, C, M, ...).  '
3431                     . 'hold_target is the identifier of the hold target object.  ' 
3432                     . 'org_unit is org unit ID.', 
3433               type => 'object' 
3434             }
3435         ],
3436         return => { 
3437             desc => q/Result hash like { "copy" : copy_id, "location" : location_name }, empty hash on misses, event on error./,
3438             type => 'object' 
3439         }
3440     }
3441 );
3442
3443 sub hold_has_copy_at {
3444     my($self, $conn, $auth, $args) = @_;
3445
3446         my $e = new_editor(authtoken=>$auth);
3447         $e->checkauth or return $e->event;
3448
3449     my $hold_type   = $$args{hold_type};
3450     my $hold_target = $$args{hold_target};
3451     my $org_unit    = $$args{org_unit};
3452
3453     my $query = {
3454         select => {acp => ['id'], acpl => ['name']},
3455         from   => {
3456             acp => {
3457                 acpl => {field => 'id', filter => { holdable => 't'}, fkey => 'location'},
3458                 ccs  => {field => 'id', filter => { holdable => 't'}, fkey => 'status'  }
3459             }
3460         },
3461         where => {'+acp' => { circulate => 't', deleted => 'f', holdable => 't', circ_lib => $org_unit}},
3462         limit => 1
3463     };
3464
3465     if($hold_type eq 'C') {
3466
3467         $query->{where}->{'+acp'}->{id} = $hold_target;
3468
3469     } elsif($hold_type eq 'V') {
3470
3471         $query->{where}->{'+acp'}->{call_number} = $hold_target;
3472     
3473     } elsif($hold_type eq 'T') {
3474
3475         $query->{from}->{acp}->{acn} = {
3476             field  => 'id',
3477             fkey   => 'call_number',
3478             'join' => {
3479                 bre => {
3480                     field  => 'id',
3481                     filter => {id => $hold_target},
3482                     fkey   => 'record'
3483                 }
3484