1 # ---------------------------------------------------------------
2 # Copyright (C) 2005 Georgia Public Library Service
3 # Bill Erickson <highfalutin@gmail.com>
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.
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 # ---------------------------------------------------------------
17 package OpenILS::Application::Circ::Holds;
18 use base qw/OpenILS::Application/;
19 use strict; use warnings;
20 use OpenILS::Application::AppUtils;
23 use OpenSRF::EX qw(:try);
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;
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";
42 __PACKAGE__->register_method(
43 method => "test_and_create_hold_batch",
44 api_name => "open-ils.circ.holds.test_and_create.batch",
47 desc => q/This is for batch creating a set of holds where every field is identical except for the targets./,
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' }
54 desc => 'Array of hold ID on success, -1 on missing arg, event (or ref to array of events) on error(s)',
59 __PACKAGE__->register_method(
60 method => "test_and_create_hold_batch",
61 api_name => "open-ils.circ.holds.test_and_create.batch.override",
64 desc => '@see open-ils.circ.holds.test_and_create.batch',
69 sub test_and_create_hold_batch {
70 my( $self, $conn, $auth, $params, $target_list ) = @_;
72 my $override = 1 if $self->api_name =~ /override/;
74 my $e = new_editor(authtoken=>$auth);
75 return $e->die_event unless $e->checkauth;
76 $$params{'requestor'} = $e->requestor->id;
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; }
89 foreach (@$target_list) {
90 $$params{$target_field} = $_;
93 ($res) = $self->method_lookup(
94 'open-ils.circ.title_hold.is_possible')->run($auth, $params);
96 if ($override || $res->{'success'} == 1) {
97 my $ahr = construct_hold_request_object($params);
98 my ($res2) = $self->method_lookup(
100 ? 'open-ils.circ.holds.create.override'
101 : 'open-ils.circ.holds.create'
104 'target' => $$params{$target_field},
107 $conn->respond($res2);
110 'target' => $$params{$target_field},
113 $conn->respond($res);
119 sub construct_hold_request_object {
122 my $ahr = Fieldmapper::action::hold_request->new;
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}); }
136 $ahr->$field($$params{$field});
142 __PACKAGE__->register_method(
143 method => "create_hold_batch",
144 api_name => "open-ils.circ.holds.create.batch",
147 desc => q/@see open-ils.circ.holds.create.batch/,
149 { desc => 'Authentication token', type => 'string' },
150 { desc => 'Array of hold objects', type => 'array' }
153 desc => 'Array of hold ID on success, -1 on missing arg, event (or ref to array of events) on error(s)',
158 __PACKAGE__->register_method(
159 method => "create_hold_batch",
160 api_name => "open-ils.circ.holds.create.override.batch",
163 desc => '@see open-ils.circ.holds.create.batch',
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);
179 __PACKAGE__->register_method(
180 method => "create_hold",
181 api_name => "open-ils.circ.holds.create",
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',
195 { desc => 'Authentication token', type => 'string' },
196 { desc => 'Hold object for hold to be created',
197 type => 'object', class => 'ahr' }
200 desc => 'New ahr ID on success, -1 on missing arg, event (or ref to array of events) on error(s)',
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',
210 desc => "If the recipient is not allowed to receive the requested hold, " .
211 "call this method to attempt the override",
213 { desc => 'Authentication token', type => 'string' },
215 desc => 'Hold object for hold to be created',
216 type => 'object', class => 'ahr'
220 desc => 'New hold (ahr) ID on success, -1 on missing arg, event (or ref to array of events) on error(s)',
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;
231 my $override = 1 if $self->api_name =~ /override/;
235 my $requestor = $e->requestor;
236 my $recipient = $requestor;
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;
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));
251 push( @events, OpenILS::Event->new(
252 'PATRON_ACCOUNT_EXPIRED',
253 "payload" => {"fail_part" => "actor.usr.privs_expired"}
254 )) if( CORE::time > $expire->epoch ) ;
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;
262 # See if a duplicate hold already exists
264 usr => $recipient->id,
266 fulfillment_time => undef,
267 target => $hold->target,
268 cancel_time => undef,
271 $sargs->{holdable_formats} = $hold->holdable_formats if $t eq 'M';
273 my $existing = $e->search_action_hold_request($sargs);
274 push( @events, OpenILS::Event->new('HOLD_EXISTS')) if @$existing;
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;
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 || $t eq OILS_HOLD_TYPE_RECALL ) {
292 my $copy = $e->retrieve_asset_copy($hold->target)
293 or return $e->die_event;
294 if ( $t eq OILS_HOLD_TYPE_FORCE ) {
295 return $e->die_event unless $e->allowed('COPY_HOLDS_FORCE', $copy->circ_lib);
296 } elsif ( $t eq OILS_HOLD_TYPE_RECALL ) {
297 return $e->die_event unless $e->allowed('COPY_HOLDS_RECALL', $copy->circ_lib);
306 for my $evt (@events) {
308 my $name = $evt->{textcode};
309 return $e->die_event unless $e->allowed("$name.override", $porg);
313 # set the configured expire time
314 unless($hold->expire_time) {
315 my $interval = $U->ou_ancestor_setting_value($recipient->home_ou, OILS_SETTING_HOLD_EXPIRE);
317 my $date = DateTime->now->add(seconds => OpenSRF::Utils::interval_to_seconds($interval));
318 $hold->expire_time($U->epoch2ISO8601($date->epoch));
322 $hold->requestor($e->requestor->id);
323 $hold->request_lib($e->requestor->ws_ou);
324 $hold->selection_ou($hold->pickup_lib) unless $hold->selection_ou;
325 $hold = $e->create_action_hold_request($hold) or return $e->die_event;
329 $conn->respond_complete($hold->id);
332 'open-ils.storage.action.hold_request.copy_targeter',
333 undef, $hold->id ) unless $U->is_true($hold->frozen);
338 # makes sure that a user has permission to place the type of requested hold
339 # returns the Perm exception if not allowed, returns undef if all is well
340 sub _check_holds_perm {
341 my($type, $user_id, $org_id) = @_;
345 $evt = $apputils->check_perms($user_id, $org_id, "MR_HOLDS" );
346 } elsif ($type eq "T") {
347 $evt = $apputils->check_perms($user_id, $org_id, "TITLE_HOLDS" );
348 } elsif($type eq "V") {
349 $evt = $apputils->check_perms($user_id, $org_id, "VOLUME_HOLDS");
350 } elsif($type eq "C") {
351 $evt = $apputils->check_perms($user_id, $org_id, "COPY_HOLDS" );
358 # tests if the given user is allowed to place holds on another's behalf
359 sub _check_request_holds_perm {
362 if (my $evt = $apputils->check_perms(
363 $user_id, $org_id, "REQUEST_HOLDS")) {
368 my $ses_is_req_note = 'The login session is the requestor. If the requestor is different from the user, ' .
369 'then the requestor must have VIEW_HOLD permissions';
371 __PACKAGE__->register_method(
372 method => "retrieve_holds_by_id",
373 api_name => "open-ils.circ.holds.retrieve_by_id",
375 desc => "Retrieve the hold, with hold transits attached, for the specified ID. $ses_is_req_note",
377 { desc => 'Authentication token', type => 'string' },
378 { desc => 'Hold ID', type => 'number' }
381 desc => 'Hold object with transits attached, event on error',
387 sub retrieve_holds_by_id {
388 my($self, $client, $auth, $hold_id) = @_;
389 my $e = new_editor(authtoken=>$auth);
390 $e->checkauth or return $e->event;
391 $e->allowed('VIEW_HOLD') or return $e->event;
393 my $holds = $e->search_action_hold_request(
395 { id => $hold_id , fulfillment_time => undef },
397 order_by => { ahr => "request_time" },
399 flesh_fields => {ahr => ['notes']}
404 flesh_hold_transits($holds);
405 flesh_hold_notices($holds, $e);
410 __PACKAGE__->register_method(
411 method => "retrieve_holds",
412 api_name => "open-ils.circ.holds.retrieve",
414 desc => "Retrieves all the holds, with hold transits attached, for the specified user. $ses_is_req_note",
416 { desc => 'Authentication token', type => 'string' },
417 { desc => 'User ID', type => 'integer' }
420 desc => 'list of holds, event on error',
425 __PACKAGE__->register_method(
426 method => "retrieve_holds",
427 api_name => "open-ils.circ.holds.id_list.retrieve",
430 desc => "Retrieves all the hold IDs, for the specified user. $ses_is_req_note",
432 { desc => 'Authentication token', type => 'string' },
433 { desc => 'User ID', type => 'integer' }
436 desc => 'list of holds, event on error',
441 __PACKAGE__->register_method(
442 method => "retrieve_holds",
443 api_name => "open-ils.circ.holds.canceled.retrieve",
446 desc => "Retrieves all the cancelled holds for the specified user. $ses_is_req_note",
448 { desc => 'Authentication token', type => 'string' },
449 { desc => 'User ID', type => 'integer' }
452 desc => 'list of holds, event on error',
457 __PACKAGE__->register_method(
458 method => "retrieve_holds",
459 api_name => "open-ils.circ.holds.canceled.id_list.retrieve",
462 desc => "Retrieves list of cancelled hold IDs for the specified user. $ses_is_req_note",
464 { desc => 'Authentication token', type => 'string' },
465 { desc => 'User ID', type => 'integer' }
468 desc => 'list of hold IDs, event on error',
475 my ($self, $client, $auth, $user_id) = @_;
477 my $e = new_editor(authtoken=>$auth);
478 return $e->event unless $e->checkauth;
479 $user_id = $e->requestor->id unless defined $user_id;
481 my $notes_filter = {staff => 'f'};
482 my $user = $e->retrieve_actor_user($user_id) or return $e->event;
483 unless($user_id == $e->requestor->id) {
484 if($e->allowed('VIEW_HOLD', $user->home_ou)) {
485 $notes_filter = {staff => 't'}
487 my $allowed = OpenILS::Application::Actor::Friends->friend_perm_allowed(
488 $e, $user_id, $e->requestor->id, 'hold.view');
489 return $e->event unless $allowed;
492 # staff member looking at his/her own holds can see staff and non-staff notes
493 $notes_filter = {} if $e->allowed('VIEW_HOLD', $user->home_ou);
497 select => {ahr => ['id']},
499 where => {usr => $user_id, fulfillment_time => undef}
502 if($self->api_name =~ /canceled/) {
504 # Fetch the canceled holds
505 # order cancelled holds by cancel time, most recent first
507 $holds_query->{order_by} = [{class => 'ahr', field => 'cancel_time', direction => 'desc'}];
510 my $cancel_count = $U->ou_ancestor_setting_value(
511 $e->requestor->ws_ou, 'circ.holds.canceled.display_count', $e);
513 unless($cancel_count) {
514 $cancel_age = $U->ou_ancestor_setting_value(
515 $e->requestor->ws_ou, 'circ.holds.canceled.display_age', $e);
517 # if no settings are defined, default to last 10 cancelled holds
518 $cancel_count = 10 unless $cancel_age;
521 if($cancel_count) { # limit by count
523 $holds_query->{where}->{cancel_time} = {'!=' => undef};
524 $holds_query->{limit} = $cancel_count;
526 } elsif($cancel_age) { # limit by age
528 # find all of the canceled holds that were canceled within the configured time frame
529 my $date = DateTime->now->subtract(seconds => OpenSRF::Utils::interval_to_seconds($cancel_age));
530 $date = $U->epoch2ISO8601($date->epoch);
531 $holds_query->{where}->{cancel_time} = {'>=' => $date};
536 # order non-cancelled holds by ready-for-pickup, then active, followed by suspended
537 # "compare" sorts false values to the front. testing pickup_lib != current_shelf_lib
538 # will sort by pl = csl > pl != csl > followed by csl is null;
539 $holds_query->{order_by} = [
541 field => 'pickup_lib',
542 compare => {'!=' => {'+ahr' => 'current_shelf_lib'}}},
543 {class => 'ahr', field => 'shelf_time'},
544 {class => 'ahr', field => 'frozen'},
545 {class => 'ahr', field => 'request_time'}
548 $holds_query->{where}->{cancel_time} = undef;
551 my $hold_ids = $e->json_query($holds_query);
552 $hold_ids = [ map { $_->{id} } @$hold_ids ];
554 return $hold_ids if $self->api_name =~ /id_list/;
557 for my $hold_id ( @$hold_ids ) {
559 my $hold = $e->retrieve_action_hold_request($hold_id);
560 $hold->notes($e->search_action_hold_request_note({hold => $hold_id, %$notes_filter}));
563 $e->search_action_hold_transit_copy([
565 {order_by => {ahtc => 'source_send_time desc'}, limit => 1}])->[0]
575 __PACKAGE__->register_method(
576 method => 'user_hold_count',
577 api_name => 'open-ils.circ.hold.user.count'
580 sub user_hold_count {
581 my ( $self, $conn, $auth, $userid ) = @_;
582 my $e = new_editor( authtoken => $auth );
583 return $e->event unless $e->checkauth;
584 my $patron = $e->retrieve_actor_user($userid)
586 return $e->event unless $e->allowed( 'VIEW_HOLD', $patron->home_ou );
587 return __user_hold_count( $self, $e, $userid );
590 sub __user_hold_count {
591 my ( $self, $e, $userid ) = @_;
592 my $holds = $e->search_action_hold_request(
595 fulfillment_time => undef,
596 cancel_time => undef,
601 return scalar(@$holds);
605 __PACKAGE__->register_method(
606 method => "retrieve_holds_by_pickup_lib",
607 api_name => "open-ils.circ.holds.retrieve_by_pickup_lib",
609 "Retrieves all the holds, with hold transits attached, for the specified pickup_ou id."
612 __PACKAGE__->register_method(
613 method => "retrieve_holds_by_pickup_lib",
614 api_name => "open-ils.circ.holds.id_list.retrieve_by_pickup_lib",
615 notes => "Retrieves all the hold ids for the specified pickup_ou id. "
618 sub retrieve_holds_by_pickup_lib {
619 my ($self, $client, $login_session, $ou_id) = @_;
621 #FIXME -- put an appropriate permission check here
622 #my( $user, $target, $evt ) = $apputils->checkses_requestor(
623 # $login_session, $user_id, 'VIEW_HOLD' );
624 #return $evt if $evt;
626 my $holds = $apputils->simplereq(
628 "open-ils.cstore.direct.action.hold_request.search.atomic",
630 pickup_lib => $ou_id ,
631 fulfillment_time => undef,
634 { order_by => { ahr => "request_time" } }
637 if ( ! $self->api_name =~ /id_list/ ) {
638 flesh_hold_transits($holds);
642 return [ map { $_->id } @$holds ];
646 __PACKAGE__->register_method(
647 method => "uncancel_hold",
648 api_name => "open-ils.circ.hold.uncancel"
652 my($self, $client, $auth, $hold_id) = @_;
653 my $e = new_editor(authtoken=>$auth, xact=>1);
654 return $e->die_event unless $e->checkauth;
656 my $hold = $e->retrieve_action_hold_request($hold_id)
657 or return $e->die_event;
658 return $e->die_event unless $e->allowed('CANCEL_HOLDS', $hold->request_lib);
660 if ($hold->fulfillment_time) {
664 unless ($hold->cancel_time) {
669 # if configured to reset the request time, also reset the expire time
670 if($U->ou_ancestor_setting_value(
671 $hold->request_lib, 'circ.holds.uncancel.reset_request_time', $e)) {
673 $hold->request_time('now');
674 my $interval = $U->ou_ancestor_setting_value($hold->request_lib, OILS_SETTING_HOLD_EXPIRE);
676 my $date = DateTime->now->add(seconds => OpenSRF::Utils::interval_to_seconds($interval));
677 $hold->expire_time($U->epoch2ISO8601($date->epoch));
681 $hold->clear_cancel_time;
682 $hold->clear_cancel_cause;
683 $hold->clear_cancel_note;
684 $hold->clear_shelf_time;
685 $hold->clear_current_copy;
686 $hold->clear_capture_time;
687 $hold->clear_prev_check_time;
688 $hold->clear_shelf_expire_time;
689 $hold->clear_current_shelf_lib;
691 $e->update_action_hold_request($hold) or return $e->die_event;
694 $U->storagereq('open-ils.storage.action.hold_request.copy_targeter', undef, $hold_id);
700 __PACKAGE__->register_method(
701 method => "cancel_hold",
702 api_name => "open-ils.circ.hold.cancel",
704 desc => 'Cancels the specified hold. The login session is the requestor. If the requestor is different from the usr field ' .
705 'on the hold, the requestor must have CANCEL_HOLDS permissions. The hold may be either the hold object or the hold id',
707 {desc => 'Authentication token', type => 'string'},
708 {desc => 'Hold ID', type => 'number'},
709 {desc => 'Cause of Cancellation', type => 'string'},
710 {desc => 'Note', type => 'string'}
713 desc => '1 on success, event on error'
719 my($self, $client, $auth, $holdid, $cause, $note) = @_;
721 my $e = new_editor(authtoken=>$auth, xact=>1);
722 return $e->die_event unless $e->checkauth;
724 my $hold = $e->retrieve_action_hold_request($holdid)
725 or return $e->die_event;
727 if( $e->requestor->id ne $hold->usr ) {
728 return $e->die_event unless $e->allowed('CANCEL_HOLDS');
731 if ($hold->cancel_time) {
736 # If the hold is captured, reset the copy status
737 if( $hold->capture_time and $hold->current_copy ) {
739 my $copy = $e->retrieve_asset_copy($hold->current_copy)
740 or return $e->die_event;
742 if( $copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF ) {
743 $logger->info("canceling hold $holdid whose item is on the holds shelf");
744 # $logger->info("setting copy to status 'reshelving' on hold cancel");
745 # $copy->status(OILS_COPY_STATUS_RESHELVING);
746 # $copy->editor($e->requestor->id);
747 # $copy->edit_date('now');
748 # $e->update_asset_copy($copy) or return $e->event;
750 } elsif( $copy->status == OILS_COPY_STATUS_IN_TRANSIT ) {
753 $logger->warn("! canceling hold [$hid] that is in transit");
754 my $transid = $e->search_action_hold_transit_copy({hold=>$hold->id},{idlist=>1})->[0];
757 my $trans = $e->retrieve_action_transit_copy($transid);
758 # Leave the transit alive, but set the copy status to
759 # reshelving so it will be properly reshelved when it gets back home
761 $trans->copy_status( OILS_COPY_STATUS_RESHELVING );
762 $e->update_action_transit_copy($trans) or return $e->die_event;
768 $hold->cancel_time('now');
769 $hold->cancel_cause($cause);
770 $hold->cancel_note($note);
771 $e->update_action_hold_request($hold)
772 or return $e->die_event;
774 delete_hold_copy_maps($self, $e, $hold->id);
778 # re-fetch the hold to pick up the real cancel_time (not "now") for A/T
780 $hold = $e->retrieve_action_hold_request($hold->id) or return $e->die_event;
783 if ($e->requestor->id == $hold->usr) {
784 $U->create_events_for_hook('hold_request.cancel.patron', $hold, $hold->pickup_lib);
786 $U->create_events_for_hook('hold_request.cancel.staff', $hold, $hold->pickup_lib);
792 sub delete_hold_copy_maps {
797 my $maps = $editor->search_action_hold_copy_map({hold=>$holdid});
799 $editor->delete_action_hold_copy_map($_)
800 or return $editor->event;
806 my $update_hold_desc = 'The login session is the requestor. ' .
807 'If the requestor is different from the usr field on the hold, ' .
808 'the requestor must have UPDATE_HOLDS permissions. ' .
809 'If supplying a hash of hold data, "id" must be included. ' .
810 'The hash is ignored if a hold object is supplied, ' .
811 'so you should supply only one kind of hold data argument.' ;
813 __PACKAGE__->register_method(
814 method => "update_hold",
815 api_name => "open-ils.circ.hold.update",
817 desc => "Updates the specified hold. $update_hold_desc",
819 {desc => 'Authentication token', type => 'string'},
820 {desc => 'Hold Object', type => 'object'},
821 {desc => 'Hash of values to be applied', type => 'object'}
824 desc => 'Hold ID on success, event on error',
830 __PACKAGE__->register_method(
831 method => "batch_update_hold",
832 api_name => "open-ils.circ.hold.update.batch",
835 desc => "Updates the specified hold(s). $update_hold_desc",
837 {desc => 'Authentication token', type => 'string'},
838 {desc => 'Array of hold obejcts', type => 'array' },
839 {desc => 'Array of hashes of values to be applied', type => 'array' }
842 desc => 'Hold ID per success, event per error',
848 my($self, $client, $auth, $hold, $values) = @_;
849 my $e = new_editor(authtoken=>$auth, xact=>1);
850 return $e->die_event unless $e->checkauth;
851 my $resp = update_hold_impl($self, $e, $hold, $values);
852 if ($U->event_code($resp)) {
856 $e->commit; # FIXME: update_hold_impl already does $e->commit ??
860 sub batch_update_hold {
861 my($self, $client, $auth, $hold_list, $values_list) = @_;
862 my $e = new_editor(authtoken=>$auth);
863 return $e->die_event unless $e->checkauth;
865 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.
867 $values_list ||= []; # FIXME: either move this above $count declaration, or send an event if both lists undef. Probably the latter.
869 # FIXME: Failing over to [] guarantees warnings for "Use of unitialized value" in update_hold_impl call.
870 # FIXME: We should be sure we only call update_hold_impl with hold object OR hash, not both.
872 for my $idx (0..$count-1) {
874 my $resp = update_hold_impl($self, $e, $hold_list->[$idx], $values_list->[$idx]);
875 $e->xact_commit unless $U->event_code($resp);
876 $client->respond($resp);
880 return undef; # not in the register return type, assuming we should always have at least one list populated
883 sub update_hold_impl {
884 my($self, $e, $hold, $values) = @_;
888 $hold = $e->retrieve_action_hold_request($values->{id})
889 or return $e->die_event;
890 for my $k (keys %$values) {
891 if (defined $values->{$k}) {
892 $hold->$k($values->{$k});
894 my $f = "clear_$k"; $hold->$f();
899 my $orig_hold = $e->retrieve_action_hold_request($hold->id)
900 or return $e->die_event;
902 # don't allow the user to be changed
903 return OpenILS::Event->new('BAD_PARAMS') if $hold->usr != $orig_hold->usr;
905 if($hold->usr ne $e->requestor->id) {
906 # if the hold is for a different user, make sure the
907 # requestor has the appropriate permissions
908 my $usr = $e->retrieve_actor_user($hold->usr)
909 or return $e->die_event;
910 return $e->die_event unless $e->allowed('UPDATE_HOLD', $usr->home_ou);
914 # --------------------------------------------------------------
915 # Changing the request time is like playing God
916 # --------------------------------------------------------------
917 if($hold->request_time ne $orig_hold->request_time) {
918 return OpenILS::Event->new('BAD_PARAMS') if $hold->fulfillment_time;
919 return $e->die_event unless $e->allowed('UPDATE_HOLD_REQUEST_TIME', $hold->pickup_lib);
923 # --------------------------------------------------------------
924 # Code for making sure staff have appropriate permissons for cut_in_line
925 # This, as is, doesn't prevent a user from cutting their own holds in line
927 # --------------------------------------------------------------
928 if($U->is_true($hold->cut_in_line) ne $U->is_true($orig_hold->cut_in_line)) {
929 return $e->die_event unless $e->allowed('UPDATE_HOLD_REQUEST_TIME', $hold->pickup_lib);
933 # --------------------------------------------------------------
934 # Disallow hold suspencion if the hold is already captured.
935 # --------------------------------------------------------------
936 if ($U->is_true($hold->frozen) and not $U->is_true($orig_hold->frozen)) {
937 $hold_status = _hold_status($e, $hold);
938 if ($hold_status > 2 && $hold_status != 7) { # hold is captured
939 $logger->info("bypassing hold freeze on captured hold");
940 return OpenILS::Event->new('HOLD_SUSPEND_AFTER_CAPTURE');
945 # --------------------------------------------------------------
946 # if the hold is on the holds shelf or in transit and the pickup
947 # lib changes we need to create a new transit.
948 # --------------------------------------------------------------
949 if($orig_hold->pickup_lib ne $hold->pickup_lib) {
951 $hold_status = _hold_status($e, $hold) unless $hold_status;
953 if($hold_status == 3) { # in transit
955 return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_TRANSIT', $orig_hold->pickup_lib);
956 return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_TRANSIT', $hold->pickup_lib);
958 $logger->info("updating pickup lib for hold ".$hold->id." while already in transit");
960 # update the transit to reflect the new pickup location
961 my $transit = $e->search_action_hold_transit_copy(
962 {hold=>$hold->id, dest_recv_time => undef})->[0]
963 or return $e->die_event;
965 $transit->prev_dest($transit->dest); # mark the previous destination on the transit
966 $transit->dest($hold->pickup_lib);
967 $e->update_action_hold_transit_copy($transit) or return $e->die_event;
969 } elsif($hold_status == 4 or $hold_status == 5 or $hold_status == 8) { # on holds shelf
971 return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_HOLDS_SHELF', $orig_hold->pickup_lib);
972 return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_HOLDS_SHELF', $hold->pickup_lib);
974 $logger->info("updating pickup lib for hold ".$hold->id." while on holds shelf");
976 if ($hold->pickup_lib eq $orig_hold->current_shelf_lib) {
977 # This can happen if the pickup lib is changed while the hold is
978 # on the shelf, then changed back to the original pickup lib.
979 # Restore the original shelf_expire_time to prevent abuse.
980 set_hold_shelf_expire_time(undef, $hold, $e, $hold->shelf_time);
983 # clear to prevent premature shelf expiration
984 $hold->clear_shelf_expire_time;
989 update_hold_if_frozen($self, $e, $hold, $orig_hold);
990 $e->update_action_hold_request($hold) or return $e->die_event;
993 # a change to mint-condition changes the set of potential copies, so retarget the hold;
994 if($U->is_true($hold->mint_condition) and !$U->is_true($orig_hold->mint_condition)) {
995 _reset_hold($self, $e->requestor, $hold)
1001 # this does not update the hold in the DB. It only
1002 # sets the shelf_expire_time field on the hold object.
1003 # start_time is optional and defaults to 'now'
1004 sub set_hold_shelf_expire_time {
1005 my ($class, $hold, $editor, $start_time) = @_;
1007 my $shelf_expire = $U->ou_ancestor_setting_value(
1009 'circ.holds.default_shelf_expire_interval',
1013 return undef unless $shelf_expire;
1015 $start_time = ($start_time) ?
1016 DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($start_time)) :
1019 my $seconds = OpenSRF::Utils->interval_to_seconds($shelf_expire);
1020 my $expire_time = $start_time->add(seconds => $seconds);
1022 # if the shelf expire time overlaps with a pickup lib's
1023 # closed date, push it out to the first open date
1024 my $dateinfo = $U->storagereq(
1025 'open-ils.storage.actor.org_unit.closed_date.overlap',
1026 $hold->pickup_lib, $expire_time->strftime('%FT%T%z'));
1029 my $dt_parser = DateTime::Format::ISO8601->new;
1030 $expire_time = $dt_parser->parse_datetime(cleanse_ISO8601($dateinfo->{end}));
1032 # TODO: enable/disable time bump via setting?
1033 $expire_time->set(hour => '23', minute => '59', second => '59');
1035 $logger->info("circulator: shelf_expire_time overlaps".
1036 " with closed date, pushing expire time to $expire_time");
1039 $hold->shelf_expire_time($expire_time->strftime('%FT%T%z'));
1045 my($e, $orig_hold, $hold, $copy) = @_;
1046 my $src = $orig_hold->pickup_lib;
1047 my $dest = $hold->pickup_lib;
1049 $logger->info("putting hold into transit on pickup_lib update");
1051 my $transit = Fieldmapper::action::hold_transit_copy->new;
1052 $transit->hold($hold->id);
1053 $transit->source($src);
1054 $transit->dest($dest);
1055 $transit->target_copy($copy->id);
1056 $transit->source_send_time('now');
1057 $transit->copy_status(OILS_COPY_STATUS_ON_HOLDS_SHELF);
1059 $copy->status(OILS_COPY_STATUS_IN_TRANSIT);
1060 $copy->editor($e->requestor->id);
1061 $copy->edit_date('now');
1063 $e->create_action_hold_transit_copy($transit) or return $e->die_event;
1064 $e->update_asset_copy($copy) or return $e->die_event;
1068 # if the hold is frozen, this method ensures that the hold is not "targeted",
1069 # that is, it clears the current_copy and prev_check_time to essentiallly
1070 # reset the hold. If it is being activated, it runs the targeter in the background
1071 sub update_hold_if_frozen {
1072 my($self, $e, $hold, $orig_hold) = @_;
1073 return if $hold->capture_time;
1075 if($U->is_true($hold->frozen)) {
1076 $logger->info("clearing current_copy and check_time for frozen hold ".$hold->id);
1077 $hold->clear_current_copy;
1078 $hold->clear_prev_check_time;
1081 if($U->is_true($orig_hold->frozen)) {
1082 $logger->info("Running targeter on activated hold ".$hold->id);
1083 $U->storagereq( 'open-ils.storage.action.hold_request.copy_targeter', undef, $hold->id );
1088 __PACKAGE__->register_method(
1089 method => "hold_note_CUD",
1090 api_name => "open-ils.circ.hold_request.note.cud",
1092 desc => 'Create, update or delete a hold request note. If the operator (from Auth. token) '
1093 . 'is not the owner of the hold, the UPDATE_HOLD permission is required',
1095 { desc => 'Authentication token', type => 'string' },
1096 { desc => 'Hold note object', type => 'object' }
1099 desc => 'Returns the note ID, event on error'
1105 my($self, $conn, $auth, $note) = @_;
1107 my $e = new_editor(authtoken => $auth, xact => 1);
1108 return $e->die_event unless $e->checkauth;
1110 my $hold = $e->retrieve_action_hold_request($note->hold)
1111 or return $e->die_event;
1113 if($hold->usr ne $e->requestor->id) {
1114 my $usr = $e->retrieve_actor_user($hold->usr);
1115 return $e->die_event unless $e->allowed('UPDATE_HOLD', $usr->home_ou);
1116 $note->staff('t') if $note->isnew;
1120 $e->create_action_hold_request_note($note) or return $e->die_event;
1121 } elsif($note->ischanged) {
1122 $e->update_action_hold_request_note($note) or return $e->die_event;
1123 } elsif($note->isdeleted) {
1124 $e->delete_action_hold_request_note($note) or return $e->die_event;
1132 __PACKAGE__->register_method(
1133 method => "retrieve_hold_status",
1134 api_name => "open-ils.circ.hold.status.retrieve",
1136 desc => 'Calculates the current status of the hold. The requestor must have ' .
1137 'VIEW_HOLD permissions if the hold is for a user other than the requestor' ,
1139 { desc => 'Hold ID', type => 'number' }
1142 # type => 'number', # event sometimes
1143 desc => <<'END_OF_DESC'
1144 Returns event on error or:
1145 -1 on error (for now),
1146 1 for 'waiting for copy to become available',
1147 2 for 'waiting for copy capture',
1150 5 for 'hold-shelf-delay'
1153 8 for 'captured, on wrong hold shelf'
1159 sub retrieve_hold_status {
1160 my($self, $client, $auth, $hold_id) = @_;
1162 my $e = new_editor(authtoken => $auth);
1163 return $e->event unless $e->checkauth;
1164 my $hold = $e->retrieve_action_hold_request($hold_id)
1165 or return $e->event;
1167 if( $e->requestor->id != $hold->usr ) {
1168 return $e->event unless $e->allowed('VIEW_HOLD');
1171 return _hold_status($e, $hold);
1177 if ($hold->cancel_time) {
1180 if ($U->is_true($hold->frozen) && !$hold->capture_time) {
1183 if ($hold->current_shelf_lib and $hold->current_shelf_lib ne $hold->pickup_lib) {
1186 return 1 unless $hold->current_copy;
1187 return 2 unless $hold->capture_time;
1189 my $copy = $hold->current_copy;
1190 unless( ref $copy ) {
1191 $copy = $e->retrieve_asset_copy($hold->current_copy)
1192 or return $e->event;
1195 return 3 if $copy->status == OILS_COPY_STATUS_IN_TRANSIT;
1197 if($copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF) {
1199 my $hs_wait_interval = $U->ou_ancestor_setting_value($hold->pickup_lib, 'circ.hold_shelf_status_delay');
1200 return 4 unless $hs_wait_interval;
1202 # if a hold_shelf_status_delay interval is defined and start_time plus
1203 # the interval is greater than now, consider the hold to be in the virtual
1204 # "on its way to the holds shelf" status. Return 5.
1206 my $transit = $e->search_action_hold_transit_copy({hold => $hold->id})->[0];
1207 my $start_time = ($transit) ? $transit->dest_recv_time : $hold->capture_time;
1208 $start_time = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($start_time));
1209 my $end_time = $start_time->add(seconds => OpenSRF::Utils::interval_to_seconds($hs_wait_interval));
1211 return 5 if $end_time > DateTime->now;
1220 __PACKAGE__->register_method(
1221 method => "retrieve_hold_queue_stats",
1222 api_name => "open-ils.circ.hold.queue_stats.retrieve",
1224 desc => 'Returns summary data about the state of a hold',
1226 { desc => 'Authentication token', type => 'string'},
1227 { desc => 'Hold ID', type => 'number'},
1230 desc => q/Summary object with keys:
1231 total_holds : total holds in queue
1232 queue_position : current queue position
1233 potential_copies : number of potential copies for this hold
1234 estimated_wait : estimated wait time in days
1235 status : hold status
1236 -1 => error or unexpected state,
1237 1 => 'waiting for copy to become available',
1238 2 => 'waiting for copy capture',
1241 5 => 'hold-shelf-delay'
1248 sub retrieve_hold_queue_stats {
1249 my($self, $conn, $auth, $hold_id) = @_;
1250 my $e = new_editor(authtoken => $auth);
1251 return $e->event unless $e->checkauth;
1252 my $hold = $e->retrieve_action_hold_request($hold_id) or return $e->event;
1253 if($e->requestor->id != $hold->usr) {
1254 return $e->event unless $e->allowed('VIEW_HOLD');
1256 return retrieve_hold_queue_status_impl($e, $hold);
1259 sub retrieve_hold_queue_status_impl {
1263 # The holds queue is defined as the distinct set of holds that share at
1264 # least one potential copy with the context hold, plus any holds that
1265 # share the same hold type and target. The latter part exists to
1266 # accomodate holds that currently have no potential copies
1267 my $q_holds = $e->json_query({
1269 # fetch cut_in_line and request_time since they're in the order_by
1270 # and we're asking for distinct values
1271 select => {ahr => ['id', 'cut_in_line', 'request_time']},
1278 'field' => 'target_copy',
1279 'fkey' => 'target_copy'
1288 "field" => "cut_in_line",
1289 "transform" => "coalesce",
1291 "direction" => "desc"
1293 { "class" => "ahr", "field" => "request_time" }
1297 '+ahcm2' => { hold => $hold->id }
1301 if (!@$q_holds) { # none? maybe we don't have a map ...
1302 $q_holds = $e->json_query({
1303 select => {ahr => ['id', 'cut_in_line', 'request_time']},
1308 "field" => "cut_in_line",
1309 "transform" => "coalesce",
1311 "direction" => "desc"
1313 { "class" => "ahr", "field" => "request_time" }
1316 hold_type => $hold->hold_type,
1317 target => $hold->target
1324 for my $h (@$q_holds) {
1325 last if $h->{id} == $hold->id;
1329 my $hold_data = $e->json_query({
1331 acp => [ {column => 'id', transform => 'count', aggregate => 1, alias => 'count'} ],
1332 ccm => [ {column =>'avg_wait_time'} ]
1338 ccm => {type => 'left'}
1343 where => {'+ahcm' => {hold => $hold->id} }
1346 my $user_org = $e->json_query({select => {au => ['home_ou']}, from => 'au', where => {id => $hold->usr}})->[0]->{home_ou};
1348 my $default_wait = $U->ou_ancestor_setting_value($user_org, OILS_SETTING_HOLD_ESIMATE_WAIT_INTERVAL);
1349 my $min_wait = $U->ou_ancestor_setting_value($user_org, 'circ.holds.min_estimated_wait_interval');
1350 $min_wait = OpenSRF::Utils::interval_to_seconds($min_wait || '0 seconds');
1351 $default_wait ||= '0 seconds';
1353 # Estimated wait time is the average wait time across the set
1354 # of potential copies, divided by the number of potential copies
1355 # times the queue position.
1357 my $combined_secs = 0;
1358 my $num_potentials = 0;
1360 for my $wait_data (@$hold_data) {
1361 my $count += $wait_data->{count};
1362 $combined_secs += $count *
1363 OpenSRF::Utils::interval_to_seconds($wait_data->{avg_wait_time} || $default_wait);
1364 $num_potentials += $count;
1367 my $estimated_wait = -1;
1369 if($num_potentials) {
1370 my $avg_wait = $combined_secs / $num_potentials;
1371 $estimated_wait = $qpos * ($avg_wait / $num_potentials);
1372 $estimated_wait = $min_wait if $estimated_wait < $min_wait and $estimated_wait != -1;
1376 total_holds => scalar(@$q_holds),
1377 queue_position => $qpos,
1378 potential_copies => $num_potentials,
1379 status => _hold_status( $e, $hold ),
1380 estimated_wait => int($estimated_wait)
1385 sub fetch_open_hold_by_current_copy {
1388 my $hold = $apputils->simplereq(
1390 'open-ils.cstore.direct.action.hold_request.search.atomic',
1391 { current_copy => $copyid , cancel_time => undef, fulfillment_time => undef });
1392 return $hold->[0] if ref($hold);
1396 sub fetch_related_holds {
1399 return $apputils->simplereq(
1401 'open-ils.cstore.direct.action.hold_request.search.atomic',
1402 { current_copy => $copyid , cancel_time => undef, fulfillment_time => undef });
1406 __PACKAGE__->register_method(
1407 method => "hold_pull_list",
1408 api_name => "open-ils.circ.hold_pull_list.retrieve",
1410 desc => 'Returns (reference to) a list of holds that need to be "pulled" by a given location. ' .
1411 'The location is determined by the login session.',
1413 { desc => 'Limit (optional)', type => 'number'},
1414 { desc => 'Offset (optional)', type => 'number'},
1417 desc => 'reference to a list of holds, or event on failure',
1422 __PACKAGE__->register_method(
1423 method => "hold_pull_list",
1424 api_name => "open-ils.circ.hold_pull_list.id_list.retrieve",
1426 desc => 'Returns (reference to) a list of holds IDs that need to be "pulled" by a given location. ' .
1427 'The location is determined by the login session.',
1429 { desc => 'Limit (optional)', type => 'number'},
1430 { desc => 'Offset (optional)', type => 'number'},
1433 desc => 'reference to a list of holds, or event on failure',
1438 __PACKAGE__->register_method(
1439 method => "hold_pull_list",
1440 api_name => "open-ils.circ.hold_pull_list.retrieve.count",
1442 desc => 'Returns a count of holds that need to be "pulled" by a given location. ' .
1443 'The location is determined by the login session.',
1445 { desc => 'Limit (optional)', type => 'number'},
1446 { desc => 'Offset (optional)', type => 'number'},
1449 desc => 'Holds count (integer), or event on failure',
1456 sub hold_pull_list {
1457 my( $self, $conn, $authtoken, $limit, $offset ) = @_;
1458 my( $reqr, $evt ) = $U->checkses($authtoken);
1459 return $evt if $evt;
1461 my $org = $reqr->ws_ou || $reqr->home_ou;
1462 # the perm locaiton shouldn't really matter here since holds
1463 # will exist all over and VIEW_HOLDS should be universal
1464 $evt = $U->check_perms($reqr->id, $org, 'VIEW_HOLD');
1465 return $evt if $evt;
1467 if($self->api_name =~ /count/) {
1469 my $count = $U->storagereq(
1470 'open-ils.storage.direct.action.hold_request.pull_list.current_copy_circ_lib.status_filtered.count',
1471 $org, $limit, $offset );
1473 $logger->info("Grabbing pull list for org unit $org with $count items");
1476 } elsif( $self->api_name =~ /id_list/ ) {
1477 return $U->storagereq(
1478 'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib.status_filtered.atomic',
1479 $org, $limit, $offset );
1482 return $U->storagereq(
1483 'open-ils.storage.direct.action.hold_request.pull_list.search.current_copy_circ_lib.status_filtered.atomic',
1484 $org, $limit, $offset );
1488 __PACKAGE__->register_method(
1489 method => "print_hold_pull_list",
1490 api_name => "open-ils.circ.hold_pull_list.print",
1492 desc => 'Returns an HTML-formatted holds pull list',
1494 { desc => 'Authtoken', type => 'string'},
1495 { desc => 'Org unit ID. Optional, defaults to workstation org unit', type => 'number'},
1498 desc => 'HTML string',
1504 sub print_hold_pull_list {
1505 my($self, $client, $auth, $org_id) = @_;
1507 my $e = new_editor(authtoken=>$auth);
1508 return $e->event unless $e->checkauth;
1510 $org_id = (defined $org_id) ? $org_id : $e->requestor->ws_ou;
1511 return $e->event unless $e->allowed('VIEW_HOLD', $org_id);
1513 my $hold_ids = $U->storagereq(
1514 'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib.status_filtered.atomic',
1517 return undef unless @$hold_ids;
1519 $client->status(new OpenSRF::DomainObject::oilsContinueStatus);
1521 # Holds will /NOT/ be in order after this ...
1522 my $holds = $e->search_action_hold_request({id => $hold_ids}, {substream => 1});
1523 $client->status(new OpenSRF::DomainObject::oilsContinueStatus);
1525 # ... so we must resort.
1526 my $hold_map = +{map { $_->id => $_ } @$holds};
1527 my $sorted_holds = [];
1528 push @$sorted_holds, $hold_map->{$_} foreach @$hold_ids;
1530 return $U->fire_object_event(
1531 undef, "ahr.format.pull_list", $sorted_holds,
1532 $org_id, undef, undef, $client
1537 __PACKAGE__->register_method(
1538 method => "print_hold_pull_list_stream",
1540 api_name => "open-ils.circ.hold_pull_list.print.stream",
1542 desc => 'Returns a stream of fleshed holds',
1544 { desc => 'Authtoken', type => 'string'},
1545 { 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)',
1550 desc => 'A stream of fleshed holds',
1556 sub print_hold_pull_list_stream {
1557 my($self, $client, $auth, $params) = @_;
1559 my $e = new_editor(authtoken=>$auth);
1560 return $e->die_event unless $e->checkauth;
1562 delete($$params{org_id}) unless (int($$params{org_id}));
1563 delete($$params{limit}) unless (int($$params{limit}));
1564 delete($$params{offset}) unless (int($$params{offset}));
1565 delete($$params{chunk_size}) unless (int($$params{chunk_size}));
1566 delete($$params{chunk_size}) if ($$params{chunk_size} && $$params{chunk_size} > 50); # keep the size reasonable
1567 $$params{chunk_size} ||= 10;
1569 $$params{org_id} = (defined $$params{org_id}) ? $$params{org_id}: $e->requestor->ws_ou;
1570 return $e->die_event unless $e->allowed('VIEW_HOLD', $$params{org_id });
1573 if ($$params{sort} && @{ $$params{sort} }) {
1574 for my $s (@{ $$params{sort} }) {
1575 if ($s eq 'acplo.position') {
1577 "class" => "acplo", "field" => "position",
1578 "transform" => "coalesce", "params" => [999]
1580 } elsif ($s eq 'prefix') {
1581 push @$sort, {"class" => "acnp", "field" => "label_sortkey"};
1582 } elsif ($s eq 'call_number') {
1583 push @$sort, {"class" => "acn", "field" => "label_sortkey"};
1584 } elsif ($s eq 'suffix') {
1585 push @$sort, {"class" => "acns", "field" => "label_sortkey"};
1586 } elsif ($s eq 'request_time') {
1587 push @$sort, {"class" => "ahr", "field" => "request_time"};
1591 push @$sort, {"class" => "ahr", "field" => "request_time"};
1594 my $holds_ids = $e->json_query(
1596 "select" => {"ahr" => ["id"]},
1601 "fkey" => "current_copy",
1603 "circ_lib" => $$params{org_id}, "status" => [0,7]
1608 "fkey" => "call_number",
1622 "fkey" => "circ_lib",
1625 "location" => {"=" => {"+acp" => "location"}}
1634 "capture_time" => undef,
1635 "cancel_time" => undef,
1637 {"expire_time" => undef },
1638 {"expire_time" => {">" => "now"}}
1642 (@$sort ? (order_by => $sort) : ()),
1643 ($$params{limit} ? (limit => $$params{limit}) : ()),
1644 ($$params{offset} ? (offset => $$params{offset}) : ())
1645 }, {"substream" => 1}
1646 ) or return $e->die_event;
1648 $logger->info("about to stream back " . scalar(@$holds_ids) . " holds");
1651 for my $hid (@$holds_ids) {
1652 push @chunk, $e->retrieve_action_hold_request([
1656 "ahr" => ["usr", "current_copy"],
1658 "acp" => ["location", "call_number", "parts"],
1659 "acn" => ["record","prefix","suffix"]
1664 if (@chunk >= $$params{chunk_size}) {
1665 $client->respond( \@chunk );
1669 $client->respond_complete( \@chunk ) if (@chunk);
1676 __PACKAGE__->register_method(
1677 method => 'fetch_hold_notify',
1678 api_name => 'open-ils.circ.hold_notification.retrieve_by_hold',
1681 Returns a list of hold notification objects based on hold id.
1682 @param authtoken The loggin session key
1683 @param holdid The id of the hold whose notifications we want to retrieve
1684 @return An array of hold notification objects, event on error.
1688 sub fetch_hold_notify {
1689 my( $self, $conn, $authtoken, $holdid ) = @_;
1690 my( $requestor, $evt ) = $U->checkses($authtoken);
1691 return $evt if $evt;
1692 my ($hold, $patron);
1693 ($hold, $evt) = $U->fetch_hold($holdid);
1694 return $evt if $evt;
1695 ($patron, $evt) = $U->fetch_user($hold->usr);
1696 return $evt if $evt;
1698 $evt = $U->check_perms($requestor->id, $patron->home_ou, 'VIEW_HOLD_NOTIFICATION');
1699 return $evt if $evt;
1701 $logger->info("User ".$requestor->id." fetching hold notifications for hold $holdid");
1702 return $U->cstorereq(
1703 'open-ils.cstore.direct.action.hold_notification.search.atomic', {hold => $holdid} );
1707 __PACKAGE__->register_method(
1708 method => 'create_hold_notify',
1709 api_name => 'open-ils.circ.hold_notification.create',
1711 Creates a new hold notification object
1712 @param authtoken The login session key
1713 @param notification The hold notification object to create
1714 @return ID of the new object on success, Event on error
1718 sub create_hold_notify {
1719 my( $self, $conn, $auth, $note ) = @_;
1720 my $e = new_editor(authtoken=>$auth, xact=>1);
1721 return $e->die_event unless $e->checkauth;
1723 my $hold = $e->retrieve_action_hold_request($note->hold)
1724 or return $e->die_event;
1725 my $patron = $e->retrieve_actor_user($hold->usr)
1726 or return $e->die_event;
1728 return $e->die_event unless
1729 $e->allowed('CREATE_HOLD_NOTIFICATION', $patron->home_ou);
1731 $note->notify_staff($e->requestor->id);
1732 $e->create_action_hold_notification($note) or return $e->die_event;
1737 __PACKAGE__->register_method(
1738 method => 'create_hold_note',
1739 api_name => 'open-ils.circ.hold_note.create',
1741 Creates a new hold request note object
1742 @param authtoken The login session key
1743 @param note The hold note object to create
1744 @return ID of the new object on success, Event on error
1748 sub create_hold_note {
1749 my( $self, $conn, $auth, $note ) = @_;
1750 my $e = new_editor(authtoken=>$auth, xact=>1);
1751 return $e->die_event unless $e->checkauth;
1753 my $hold = $e->retrieve_action_hold_request($note->hold)
1754 or return $e->die_event;
1755 my $patron = $e->retrieve_actor_user($hold->usr)
1756 or return $e->die_event;
1758 return $e->die_event unless
1759 $e->allowed('UPDATE_HOLD', $patron->home_ou); # FIXME: Using permcrud perm listed in fm_IDL.xml for ahrn. Probably want something more specific
1761 $e->create_action_hold_request_note($note) or return $e->die_event;
1766 __PACKAGE__->register_method(
1767 method => 'reset_hold',
1768 api_name => 'open-ils.circ.hold.reset',
1770 Un-captures and un-targets a hold, essentially returning
1771 it to the state it was in directly after it was placed,
1772 then attempts to re-target the hold
1773 @param authtoken The login session key
1774 @param holdid The id of the hold
1780 my( $self, $conn, $auth, $holdid ) = @_;
1782 my ($hold, $evt) = $U->fetch_hold($holdid);
1783 return $evt if $evt;
1784 ($reqr, $evt) = $U->checksesperm($auth, 'UPDATE_HOLD');
1785 return $evt if $evt;
1786 $evt = _reset_hold($self, $reqr, $hold);
1787 return $evt if $evt;
1792 __PACKAGE__->register_method(
1793 method => 'reset_hold_batch',
1794 api_name => 'open-ils.circ.hold.reset.batch'
1797 sub reset_hold_batch {
1798 my($self, $conn, $auth, $hold_ids) = @_;
1800 my $e = new_editor(authtoken => $auth);
1801 return $e->event unless $e->checkauth;
1803 for my $hold_id ($hold_ids) {
1805 my $hold = $e->retrieve_action_hold_request(
1806 [$hold_id, {flesh => 1, flesh_fields => {ahr => ['usr']}}])
1807 or return $e->event;
1809 next unless $e->allowed('UPDATE_HOLD', $hold->usr->home_ou);
1810 _reset_hold($self, $e->requestor, $hold);
1818 my ($self, $reqr, $hold) = @_;
1820 my $e = new_editor(xact =>1, requestor => $reqr);
1822 $logger->info("reseting hold ".$hold->id);
1824 my $hid = $hold->id;
1826 if( $hold->capture_time and $hold->current_copy ) {
1828 my $copy = $e->retrieve_asset_copy($hold->current_copy)
1829 or return $e->die_event;
1831 if( $copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF ) {
1832 $logger->info("setting copy to status 'reshelving' on hold retarget");
1833 $copy->status(OILS_COPY_STATUS_RESHELVING);
1834 $copy->editor($e->requestor->id);
1835 $copy->edit_date('now');
1836 $e->update_asset_copy($copy) or return $e->die_event;
1838 } elsif( $copy->status == OILS_COPY_STATUS_IN_TRANSIT ) {
1840 # We don't want the copy to remain "in transit"
1841 $copy->status(OILS_COPY_STATUS_RESHELVING);
1842 $logger->warn("! reseting hold [$hid] that is in transit");
1843 my $transid = $e->search_action_hold_transit_copy({hold=>$hold->id},{idlist=>1})->[0];
1846 my $trans = $e->retrieve_action_transit_copy($transid);
1848 $logger->info("Aborting transit [$transid] on hold [$hid] reset...");
1849 my $evt = OpenILS::Application::Circ::Transit::__abort_transit($e, $trans, $copy, 1);
1850 $logger->info("Transit abort completed with result $evt");
1851 unless ("$evt" eq 1) {
1860 $hold->clear_capture_time;
1861 $hold->clear_current_copy;
1862 $hold->clear_shelf_time;
1863 $hold->clear_shelf_expire_time;
1864 $hold->clear_current_shelf_lib;
1866 $e->update_action_hold_request($hold) or return $e->die_event;
1870 'open-ils.storage.action.hold_request.copy_targeter', undef, $hold->id );
1876 __PACKAGE__->register_method(
1877 method => 'fetch_open_title_holds',
1878 api_name => 'open-ils.circ.open_holds.retrieve',
1880 Returns a list ids of un-fulfilled holds for a given title id
1881 @param authtoken The login session key
1882 @param id the id of the item whose holds we want to retrieve
1883 @param type The hold type - M, T, I, V, C, F, R
1887 sub fetch_open_title_holds {
1888 my( $self, $conn, $auth, $id, $type, $org ) = @_;
1889 my $e = new_editor( authtoken => $auth );
1890 return $e->event unless $e->checkauth;
1893 $org ||= $e->requestor->ws_ou;
1895 # return $e->search_action_hold_request(
1896 # { target => $id, hold_type => $type, fulfillment_time => undef }, {idlist=>1});
1898 # XXX make me return IDs in the future ^--
1899 my $holds = $e->search_action_hold_request(
1902 cancel_time => undef,
1904 fulfillment_time => undef
1908 flesh_hold_transits($holds);
1913 sub flesh_hold_transits {
1915 for my $hold ( @$holds ) {
1917 $apputils->simplereq(
1919 "open-ils.cstore.direct.action.hold_transit_copy.search.atomic",
1920 { hold => $hold->id },
1921 { order_by => { ahtc => 'id desc' }, limit => 1 }
1927 sub flesh_hold_notices {
1928 my( $holds, $e ) = @_;
1929 $e ||= new_editor();
1931 for my $hold (@$holds) {
1932 my $notices = $e->search_action_hold_notification(
1934 { hold => $hold->id },
1935 { order_by => { anh => 'notify_time desc' } },
1940 $hold->notify_count(scalar(@$notices));
1942 my $n = $e->retrieve_action_hold_notification($$notices[0])
1943 or return $e->event;
1944 $hold->notify_time($n->notify_time);
1950 __PACKAGE__->register_method(
1951 method => 'fetch_captured_holds',
1952 api_name => 'open-ils.circ.captured_holds.on_shelf.retrieve',
1956 Returns a list of un-fulfilled holds (on the Holds Shelf) for a given title id
1957 @param authtoken The login session key
1958 @param org The org id of the location in question
1959 @param match_copy A specific copy to limit to
1963 __PACKAGE__->register_method(
1964 method => 'fetch_captured_holds',
1965 api_name => 'open-ils.circ.captured_holds.id_list.on_shelf.retrieve',
1969 Returns list ids of un-fulfilled holds (on the Holds Shelf) for a given title id
1970 @param authtoken The login session key
1971 @param org The org id of the location in question
1972 @param match_copy A specific copy to limit to
1976 __PACKAGE__->register_method(
1977 method => 'fetch_captured_holds',
1978 api_name => 'open-ils.circ.captured_holds.id_list.expired_on_shelf.retrieve',
1982 Returns list ids of shelf-expired un-fulfilled holds for a given title id
1983 @param authtoken The login session key
1984 @param org The org id of the location in question
1985 @param match_copy A specific copy to limit to
1990 sub fetch_captured_holds {
1991 my( $self, $conn, $auth, $org, $match_copy ) = @_;
1993 my $e = new_editor(authtoken => $auth);
1994 return $e->die_event unless $e->checkauth;
1995 return $e->die_event unless $e->allowed('VIEW_HOLD'); # XXX rely on editor perm
1997 $org ||= $e->requestor->ws_ou;
1999 my $current_copy = { '!=' => undef };
2000 $current_copy = { '=' => $match_copy } if $match_copy;
2003 select => { alhr => ['id'] },
2008 fkey => 'current_copy'
2013 '+acp' => { status => OILS_COPY_STATUS_ON_HOLDS_SHELF },
2015 capture_time => { "!=" => undef },
2016 current_copy => $current_copy,
2017 fulfillment_time => undef,
2018 current_shelf_lib => $org
2022 if($self->api_name =~ /expired/) {
2023 $query->{'where'}->{'+alhr'}->{'-or'} = {
2024 shelf_expire_time => { '<' => 'now'},
2025 cancel_time => { '!=' => undef },
2028 my $hold_ids = $e->json_query( $query );
2030 for my $hold_id (@$hold_ids) {
2031 if($self->api_name =~ /id_list/) {
2032 $conn->respond($hold_id->{id});
2036 $e->retrieve_action_hold_request([
2040 flesh_fields => {ahr => ['notifications', 'transit', 'notes']},
2041 order_by => {anh => 'notify_time desc'}
2051 __PACKAGE__->register_method(
2052 method => "print_expired_holds_stream",
2053 api_name => "open-ils.circ.captured_holds.expired.print.stream",
2057 sub print_expired_holds_stream {
2058 my ($self, $client, $auth, $params) = @_;
2060 # No need to check specific permissions: we're going to call another method
2061 # that will do that.
2062 my $e = new_editor("authtoken" => $auth);
2063 return $e->die_event unless $e->checkauth;
2065 delete($$params{org_id}) unless (int($$params{org_id}));
2066 delete($$params{limit}) unless (int($$params{limit}));
2067 delete($$params{offset}) unless (int($$params{offset}));
2068 delete($$params{chunk_size}) unless (int($$params{chunk_size}));
2069 delete($$params{chunk_size}) if ($$params{chunk_size} && $$params{chunk_size} > 50); # keep the size reasonable
2070 $$params{chunk_size} ||= 10;
2072 $$params{org_id} = (defined $$params{org_id}) ? $$params{org_id}: $e->requestor->ws_ou;
2074 my @hold_ids = $self->method_lookup(
2075 "open-ils.circ.captured_holds.id_list.expired_on_shelf.retrieve"
2076 )->run($auth, $params->{"org_id"});
2081 } elsif (defined $U->event_code($hold_ids[0])) {
2083 return $hold_ids[0];
2086 $logger->info("about to stream back up to " . scalar(@hold_ids) . " expired holds");
2089 my @hid_chunk = splice @hold_ids, 0, $params->{"chunk_size"};
2091 my $result_chunk = $e->json_query({
2093 "acp" => ["barcode"],
2095 first_given_name second_given_name family_name alias
2104 "field" => "id", "fkey" => "current_copy",
2107 "field" => "id", "fkey" => "call_number",
2110 "field" => "id", "fkey" => "record"
2114 "acpl" => {"field" => "id", "fkey" => "location"}
2117 "au" => {"field" => "id", "fkey" => "usr"}
2120 "where" => {"+ahr" => {"id" => \@hid_chunk}}
2121 }) or return $e->die_event;
2122 $client->respond($result_chunk);
2129 __PACKAGE__->register_method(
2130 method => "check_title_hold_batch",
2131 api_name => "open-ils.circ.title_hold.is_possible.batch",
2134 desc => '@see open-ils.circ.title_hold.is_possible.batch',
2136 { desc => 'Authentication token', type => 'string'},
2137 { desc => 'Array of Hash of named parameters', type => 'array'},
2140 desc => 'Array of response objects',
2146 sub check_title_hold_batch {
2147 my($self, $client, $authtoken, $param_list) = @_;
2148 foreach (@$param_list) {
2149 my ($res) = $self->method_lookup('open-ils.circ.title_hold.is_possible')->run($authtoken, $_);
2150 $client->respond($res);
2156 __PACKAGE__->register_method(
2157 method => "check_title_hold",
2158 api_name => "open-ils.circ.title_hold.is_possible",
2160 desc => 'Determines if a hold were to be placed by a given user, ' .
2161 'whether or not said hold would have any potential copies to fulfill it.' .
2162 'The named paramaters of the second argument include: ' .
2163 'patronid, titleid, volume_id, copy_id, mrid, depth, pickup_lib, hold_type, selection_ou. ' .
2164 'See perldoc ' . __PACKAGE__ . ' for more info on these fields.' ,
2166 { desc => 'Authentication token', type => 'string'},
2167 { desc => 'Hash of named parameters', type => 'object'},
2170 desc => 'List of new message IDs (empty if none)',
2176 =head3 check_title_hold (token, hash)
2178 The named fields in the hash are:
2180 patronid - ID of the hold recipient (required)
2181 depth - hold range depth (default 0)
2182 pickup_lib - destination for hold, fallback value for selection_ou
2183 selection_ou - ID of org_unit establishing hard and soft hold boundary settings
2184 issuanceid - ID of the issuance to be held, required for Issuance level hold
2185 partid - ID of the monograph part to be held, required for monograph part level hold
2186 titleid - ID (BRN) of the title to be held, required for Title level hold
2187 volume_id - required for Volume level hold
2188 copy_id - required for Copy level hold
2189 mrid - required for Meta-record level hold
2190 hold_type - T, C (or R or F), I, V or M for Title, Copy, Issuance, Volume or Meta-record (default "T")
2192 All key/value pairs are passed on to do_possibility_checks.
2196 # FIXME: better params checking. what other params are required, if any?
2197 # FIXME: 3 copies of values confusing: $x, $params->{x} and $params{x}
2198 # FIXME: for example, $depth gets a default value, but then $$params{depth} is still
2199 # used in conditionals, where it may be undefined, causing a warning.
2200 # FIXME: specify proper usage/interaction of selection_ou and pickup_lib
2202 sub check_title_hold {
2203 my( $self, $client, $authtoken, $params ) = @_;
2204 my $e = new_editor(authtoken=>$authtoken);
2205 return $e->event unless $e->checkauth;
2207 my %params = %$params;
2208 my $depth = $params{depth} || 0;
2209 my $selection_ou = $params{selection_ou} || $params{pickup_lib};
2211 my $patron = $e->retrieve_actor_user($params{patronid})
2212 or return $e->event;
2214 if( $e->requestor->id ne $patron->id ) {
2215 return $e->event unless
2216 $e->allowed('VIEW_HOLD_PERMIT', $patron->home_ou);
2219 return OpenILS::Event->new('PATRON_BARRED') if $U->is_true($patron->barred);
2221 my $request_lib = $e->retrieve_actor_org_unit($e->requestor->ws_ou)
2222 or return $e->event;
2224 my $soft_boundary = $U->ou_ancestor_setting_value($selection_ou, OILS_SETTING_HOLD_SOFT_BOUNDARY);
2225 my $hard_boundary = $U->ou_ancestor_setting_value($selection_ou, OILS_SETTING_HOLD_HARD_BOUNDARY);
2228 my $return_depth = $hard_boundary; # default depth to return on success
2229 if(defined $soft_boundary and $depth < $soft_boundary) {
2230 # work up the tree and as soon as we find a potential copy, use that depth
2231 # also, make sure we don't go past the hard boundary if it exists
2233 # our min boundary is the greater of user-specified boundary or hard boundary
2234 my $min_depth = (defined $hard_boundary and $hard_boundary > $depth) ?
2235 $hard_boundary : $depth;
2237 my $depth = $soft_boundary;
2238 while($depth >= $min_depth) {
2239 $logger->info("performing hold possibility check with soft boundary $depth");
2240 @status = do_possibility_checks($e, $patron, $request_lib, $depth, %params);
2242 $return_depth = $depth;
2247 } elsif(defined $hard_boundary and $depth < $hard_boundary) {
2248 # there is no soft boundary, enforce the hard boundary if it exists
2249 $logger->info("performing hold possibility check with hard boundary $hard_boundary");
2250 @status = do_possibility_checks($e, $patron, $request_lib, $hard_boundary, %params);
2252 # no boundaries defined, fall back to user specifed boundary or no boundary
2253 $logger->info("performing hold possibility check with no boundary");
2254 @status = do_possibility_checks($e, $patron, $request_lib, $params{depth}, %params);
2260 "depth" => $return_depth,
2261 "local_avail" => $status[1]
2263 } elsif ($status[2]) {
2264 my $n = scalar @{$status[2]};
2265 return {"success" => 0, "last_event" => $status[2]->[$n - 1], "age_protected_copy" => $status[3]};
2267 return {"success" => 0, "age_protected_copy" => $status[3]};
2273 sub do_possibility_checks {
2274 my($e, $patron, $request_lib, $depth, %params) = @_;
2276 my $issuanceid = $params{issuanceid} || "";
2277 my $partid = $params{partid} || "";
2278 my $titleid = $params{titleid} || "";
2279 my $volid = $params{volume_id};
2280 my $copyid = $params{copy_id};
2281 my $mrid = $params{mrid} || "";
2282 my $pickup_lib = $params{pickup_lib};
2283 my $hold_type = $params{hold_type} || 'T';
2284 my $selection_ou = $params{selection_ou} || $pickup_lib;
2285 my $holdable_formats = $params{holdable_formats};
2292 if( $hold_type eq OILS_HOLD_TYPE_FORCE || $hold_type eq OILS_HOLD_TYPE_RECALL || $hold_type eq OILS_HOLD_TYPE_COPY ) {
2294 return $e->event unless $copy = $e->retrieve_asset_copy($copyid);
2295 return $e->event unless $volume = $e->retrieve_asset_call_number($copy->call_number);
2296 return $e->event unless $title = $e->retrieve_biblio_record_entry($volume->record);
2298 return (1, 1, []) if( $hold_type eq OILS_HOLD_TYPE_RECALL || $hold_type eq OILS_HOLD_TYPE_FORCE);
2299 return verify_copy_for_hold(
2300 $patron, $e->requestor, $title, $copy, $pickup_lib, $request_lib
2303 } elsif( $hold_type eq OILS_HOLD_TYPE_VOLUME ) {
2305 return $e->event unless $volume = $e->retrieve_asset_call_number($volid);
2306 return $e->event unless $title = $e->retrieve_biblio_record_entry($volume->record);
2308 return _check_volume_hold_is_possible(
2309 $volume, $title, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou
2312 } elsif( $hold_type eq OILS_HOLD_TYPE_TITLE ) {
2314 return _check_title_hold_is_possible(
2315 $titleid, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou
2318 } elsif( $hold_type eq OILS_HOLD_TYPE_ISSUANCE ) {
2320 return _check_issuance_hold_is_possible(
2321 $issuanceid, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou
2324 } elsif( $hold_type eq OILS_HOLD_TYPE_MONOPART ) {
2326 return _check_monopart_hold_is_possible(
2327 $partid, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou
2330 } elsif( $hold_type eq OILS_HOLD_TYPE_METARECORD ) {
2332 my $maps = $e->search_metabib_metarecord_source_map({metarecord=>$mrid});
2333 my @recs = map { $_->source } @$maps;
2335 for my $rec (@recs) {
2336 @status = _check_title_hold_is_possible(
2337 $rec, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou, $holdable_formats
2343 # else { Unrecognized hold_type ! } # FIXME: return error? or 0?
2347 sub create_ranged_org_filter {
2348 my($e, $selection_ou, $depth) = @_;
2350 # find the orgs from which this hold may be fulfilled,
2351 # based on the selection_ou and depth
2353 my $top_org = $e->search_actor_org_unit([
2354 {parent_ou => undef},
2355 {flesh=>1, flesh_fields=>{aou=>['ou_type']}}])->[0];
2358 return () if $depth == $top_org->ou_type->depth;
2360 my $org_list = $U->storagereq('open-ils.storage.actor.org_unit.descendants.atomic', $selection_ou, $depth);
2361 %org_filter = (circ_lib => []);
2362 push(@{$org_filter{circ_lib}}, $_->id) for @$org_list;
2364 $logger->info("hold org filter at depth $depth and selection_ou ".
2365 "$selection_ou created list of @{$org_filter{circ_lib}}");
2371 sub _check_title_hold_is_possible {
2372 my( $titleid, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou, $holdable_formats ) = @_;
2374 my ($types, $formats, $lang);
2375 if (defined($holdable_formats)) {
2376 ($types, $formats, $lang) = split '-', $holdable_formats;
2379 my $e = new_editor();
2380 my %org_filter = create_ranged_org_filter($e, $selection_ou, $depth);
2382 # this monster will grab the id and circ_lib of all of the "holdable" copies for the given record
2383 my $copies = $e->json_query(
2385 select => { acp => ['id', 'circ_lib'] },
2390 fkey => 'call_number',
2394 filter => { id => $titleid },
2402 ( $types ? (item_type => [split '', $types]) : () ),
2403 ( $formats ? (item_form => [split '', $formats]) : () ),
2404 ( $lang ? (item_lang => $lang) : () )
2409 acpl => { field => 'id', filter => { holdable => 't'}, fkey => 'location' },
2410 ccs => { field => 'id', filter => { holdable => 't'}, fkey => 'status' },
2411 acpm => { field => 'target_copy', type => 'left' } # ignore part-linked copies
2415 '+acp' => { circulate => 't', deleted => 'f', holdable => 't', %org_filter },
2416 '+acpm' => { target_copy => undef } # ignore part-linked copies
2421 $logger->info("title possible found ".scalar(@$copies)." potential copies");
2425 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2426 "payload" => {"fail_part" => "no_ultimate_items"}
2431 # -----------------------------------------------------------------------
2432 # sort the copies into buckets based on their circ_lib proximity to
2433 # the patron's home_ou.
2434 # -----------------------------------------------------------------------
2436 my $home_org = $patron->home_ou;
2437 my $req_org = $request_lib->id;
2439 $logger->info("prox cache $home_org " . $prox_cache{$home_org});
2441 $prox_cache{$home_org} =
2442 $e->search_actor_org_unit_proximity({from_org => $home_org})
2443 unless $prox_cache{$home_org};
2444 my $home_prox = $prox_cache{$home_org};
2447 my %hash = map { ($_->to_org => $_->prox) } @$home_prox;
2448 push( @{$buckets{ $hash{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2450 my @keys = sort { $a <=> $b } keys %buckets;
2453 if( $home_org ne $req_org ) {
2454 # -----------------------------------------------------------------------
2455 # shove the copies close to the request_lib into the primary buckets
2456 # directly before the farthest away copies. That way, they are not
2457 # given priority, but they are checked before the farthest copies.
2458 # -----------------------------------------------------------------------
2459 $prox_cache{$req_org} =
2460 $e->search_actor_org_unit_proximity({from_org => $req_org})
2461 unless $prox_cache{$req_org};
2462 my $req_prox = $prox_cache{$req_org};
2465 my %hash2 = map { ($_->to_org => $_->prox) } @$req_prox;
2466 push( @{$buckets2{ $hash2{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2468 my $highest_key = $keys[@keys - 1]; # the farthest prox in the exising buckets
2469 my $new_key = $highest_key - 0.5; # right before the farthest prox
2470 my @keys2 = sort { $a <=> $b } keys %buckets2;
2471 for my $key (@keys2) {
2472 last if $key >= $highest_key;
2473 push( @{$buckets{$new_key}}, $_ ) for @{$buckets2{$key}};
2477 @keys = sort { $a <=> $b } keys %buckets;
2482 my $age_protect_only = 0;
2483 OUTER: for my $key (@keys) {
2484 my @cps = @{$buckets{$key}};
2486 $logger->info("looking at " . scalar(@{$buckets{$key}}). " copies in proximity bucket $key");
2488 for my $copyid (@cps) {
2490 next if $seen{$copyid};
2491 $seen{$copyid} = 1; # there could be dupes given the merged buckets
2492 my $copy = $e->retrieve_asset_copy($copyid);
2493 $logger->debug("looking at bucket_key=$key, copy $copyid : circ_lib = " . $copy->circ_lib);
2495 unless($title) { # grab the title if we don't already have it
2496 my $vol = $e->retrieve_asset_call_number(
2497 [ $copy->call_number, { flesh => 1, flesh_fields => { bre => ['fixed_fields'], acn => ['record'] } } ] );
2498 $title = $vol->record;
2501 @status = verify_copy_for_hold(
2502 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib);
2504 $age_protect_only ||= $status[3];
2505 last OUTER if $status[0];
2509 $status[3] = $age_protect_only;
2513 sub _check_issuance_hold_is_possible {
2514 my( $issuanceid, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou ) = @_;
2516 my $e = new_editor();
2517 my %org_filter = create_ranged_org_filter($e, $selection_ou, $depth);
2519 # this monster will grab the id and circ_lib of all of the "holdable" copies for the given record
2520 my $copies = $e->json_query(
2522 select => { acp => ['id', 'circ_lib'] },
2528 filter => { issuance => $issuanceid }
2530 acpl => { field => 'id', filter => { holdable => 't'}, fkey => 'location' },
2531 ccs => { field => 'id', filter => { holdable => 't'}, fkey => 'status' }
2535 '+acp' => { circulate => 't', deleted => 'f', holdable => 't', %org_filter }
2541 $logger->info("issuance possible found ".scalar(@$copies)." potential copies");
2545 $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_issuance_ok');
2546 $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2551 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2552 "payload" => {"fail_part" => "no_ultimate_items"}
2560 # -----------------------------------------------------------------------
2561 # sort the copies into buckets based on their circ_lib proximity to
2562 # the patron's home_ou.
2563 # -----------------------------------------------------------------------
2565 my $home_org = $patron->home_ou;
2566 my $req_org = $request_lib->id;
2568 $logger->info("prox cache $home_org " . $prox_cache{$home_org});
2570 $prox_cache{$home_org} =
2571 $e->search_actor_org_unit_proximity({from_org => $home_org})
2572 unless $prox_cache{$home_org};
2573 my $home_prox = $prox_cache{$home_org};
2576 my %hash = map { ($_->to_org => $_->prox) } @$home_prox;
2577 push( @{$buckets{ $hash{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2579 my @keys = sort { $a <=> $b } keys %buckets;
2582 if( $home_org ne $req_org ) {
2583 # -----------------------------------------------------------------------
2584 # shove the copies close to the request_lib into the primary buckets
2585 # directly before the farthest away copies. That way, they are not
2586 # given priority, but they are checked before the farthest copies.
2587 # -----------------------------------------------------------------------
2588 $prox_cache{$req_org} =
2589 $e->search_actor_org_unit_proximity({from_org => $req_org})
2590 unless $prox_cache{$req_org};
2591 my $req_prox = $prox_cache{$req_org};
2594 my %hash2 = map { ($_->to_org => $_->prox) } @$req_prox;
2595 push( @{$buckets2{ $hash2{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2597 my $highest_key = $keys[@keys - 1]; # the farthest prox in the exising buckets
2598 my $new_key = $highest_key - 0.5; # right before the farthest prox
2599 my @keys2 = sort { $a <=> $b } keys %buckets2;
2600 for my $key (@keys2) {
2601 last if $key >= $highest_key;
2602 push( @{$buckets{$new_key}}, $_ ) for @{$buckets2{$key}};
2606 @keys = sort { $a <=> $b } keys %buckets;
2611 my $age_protect_only = 0;
2612 OUTER: for my $key (@keys) {
2613 my @cps = @{$buckets{$key}};
2615 $logger->info("looking at " . scalar(@{$buckets{$key}}). " copies in proximity bucket $key");
2617 for my $copyid (@cps) {
2619 next if $seen{$copyid};
2620 $seen{$copyid} = 1; # there could be dupes given the merged buckets
2621 my $copy = $e->retrieve_asset_copy($copyid);
2622 $logger->debug("looking at bucket_key=$key, copy $copyid : circ_lib = " . $copy->circ_lib);
2624 unless($title) { # grab the title if we don't already have it
2625 my $vol = $e->retrieve_asset_call_number(
2626 [ $copy->call_number, { flesh => 1, flesh_fields => { bre => ['fixed_fields'], acn => ['record'] } } ] );
2627 $title = $vol->record;
2630 @status = verify_copy_for_hold(
2631 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib);
2633 $age_protect_only ||= $status[3];
2634 last OUTER if $status[0];
2639 if (!defined($empty_ok)) {
2640 $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_issuance_ok');
2641 $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2644 return (1,0) if ($empty_ok);
2646 $status[3] = $age_protect_only;
2650 sub _check_monopart_hold_is_possible {
2651 my( $partid, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou ) = @_;
2653 my $e = new_editor();
2654 my %org_filter = create_ranged_org_filter($e, $selection_ou, $depth);
2656 # this monster will grab the id and circ_lib of all of the "holdable" copies for the given record
2657 my $copies = $e->json_query(
2659 select => { acp => ['id', 'circ_lib'] },
2663 field => 'target_copy',
2665 filter => { part => $partid }
2667 acpl => { field => 'id', filter => { holdable => 't'}, fkey => 'location' },
2668 ccs => { field => 'id', filter => { holdable => 't'}, fkey => 'status' }
2672 '+acp' => { circulate => 't', deleted => 'f', holdable => 't', %org_filter }
2678 $logger->info("monopart possible found ".scalar(@$copies)." potential copies");
2682 $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_part_ok');
2683 $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2688 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2689 "payload" => {"fail_part" => "no_ultimate_items"}
2697 # -----------------------------------------------------------------------
2698 # sort the copies into buckets based on their circ_lib proximity to
2699 # the patron's home_ou.
2700 # -----------------------------------------------------------------------
2702 my $home_org = $patron->home_ou;
2703 my $req_org = $request_lib->id;
2705 $logger->info("prox cache $home_org " . $prox_cache{$home_org});
2707 $prox_cache{$home_org} =
2708 $e->search_actor_org_unit_proximity({from_org => $home_org})
2709 unless $prox_cache{$home_org};
2710 my $home_prox = $prox_cache{$home_org};
2713 my %hash = map { ($_->to_org => $_->prox) } @$home_prox;
2714 push( @{$buckets{ $hash{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2716 my @keys = sort { $a <=> $b } keys %buckets;
2719 if( $home_org ne $req_org ) {
2720 # -----------------------------------------------------------------------
2721 # shove the copies close to the request_lib into the primary buckets
2722 # directly before the farthest away copies. That way, they are not
2723 # given priority, but they are checked before the farthest copies.
2724 # -----------------------------------------------------------------------
2725 $prox_cache{$req_org} =
2726 $e->search_actor_org_unit_proximity({from_org => $req_org})
2727 unless $prox_cache{$req_org};
2728 my $req_prox = $prox_cache{$req_org};
2731 my %hash2 = map { ($_->to_org => $_->prox) } @$req_prox;
2732 push( @{$buckets2{ $hash2{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2734 my $highest_key = $keys[@keys - 1]; # the farthest prox in the exising buckets
2735 my $new_key = $highest_key - 0.5; # right before the farthest prox
2736 my @keys2 = sort { $a <=> $b } keys %buckets2;
2737 for my $key (@keys2) {
2738 last if $key >= $highest_key;
2739 push( @{$buckets{$new_key}}, $_ ) for @{$buckets2{$key}};
2743 @keys = sort { $a <=> $b } keys %buckets;
2748 my $age_protect_only = 0;
2749 OUTER: for my $key (@keys) {
2750 my @cps = @{$buckets{$key}};
2752 $logger->info("looking at " . scalar(@{$buckets{$key}}). " copies in proximity bucket $key");
2754 for my $copyid (@cps) {
2756 next if $seen{$copyid};
2757 $seen{$copyid} = 1; # there could be dupes given the merged buckets
2758 my $copy = $e->retrieve_asset_copy($copyid);
2759 $logger->debug("looking at bucket_key=$key, copy $copyid : circ_lib = " . $copy->circ_lib);
2761 unless($title) { # grab the title if we don't already have it
2762 my $vol = $e->retrieve_asset_call_number(
2763 [ $copy->call_number, { flesh => 1, flesh_fields => { bre => ['fixed_fields'], acn => ['record'] } } ] );
2764 $title = $vol->record;
2767 @status = verify_copy_for_hold(
2768 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib);
2770 $age_protect_only ||= $status[3];
2771 last OUTER if $status[0];
2776 if (!defined($empty_ok)) {
2777 $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_part_ok');
2778 $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2781 return (1,0) if ($empty_ok);
2783 $status[3] = $age_protect_only;
2788 sub _check_volume_hold_is_possible {
2789 my( $vol, $title, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou ) = @_;
2790 my %org_filter = create_ranged_org_filter(new_editor(), $selection_ou, $depth);
2791 my $copies = new_editor->search_asset_copy({call_number => $vol->id, %org_filter});
2792 $logger->info("checking possibility of volume hold for volume ".$vol->id);
2794 my $filter_copies = [];
2795 for my $copy (@$copies) {
2796 # ignore part-mapped copies for regular volume level holds
2797 push(@$filter_copies, $copy) unless
2798 new_editor->search_asset_copy_part_map({target_copy => $copy->id})->[0];
2800 $copies = $filter_copies;
2805 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2806 "payload" => {"fail_part" => "no_ultimate_items"}
2812 my $age_protect_only = 0;
2813 for my $copy ( @$copies ) {
2814 @status = verify_copy_for_hold(
2815 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib );
2816 $age_protect_only ||= $status[3];
2819 $status[3] = $age_protect_only;
2825 sub verify_copy_for_hold {
2826 my( $patron, $requestor, $title, $copy, $pickup_lib, $request_lib ) = @_;
2827 $logger->info("checking possibility of copy in hold request for copy ".$copy->id);
2828 my $permitted = OpenILS::Utils::PermitHold::permit_copy_hold(
2829 { patron => $patron,
2830 requestor => $requestor,
2833 title_descriptor => $title->fixed_fields, # this is fleshed into the title object
2834 pickup_lib => $pickup_lib,
2835 request_lib => $request_lib,
2837 show_event_list => 1
2840 my $age_protect_only = 0;
2841 if (@$permitted == 1 && @$permitted[0]->{textcode} eq 'ITEM_AGE_PROTECTED') {
2842 $age_protect_only = 1;
2846 (not scalar @$permitted), # true if permitted is an empty arrayref
2847 ( # XXX This test is of very dubious value; someone should figure
2848 # out what if anything is checking this value
2849 ($copy->circ_lib == $pickup_lib) and
2850 ($copy->status == OILS_COPY_STATUS_AVAILABLE)
2859 sub find_nearest_permitted_hold {
2862 my $editor = shift; # CStoreEditor object
2863 my $copy = shift; # copy to target
2864 my $user = shift; # staff
2865 my $check_only = shift; # do no updates, just see if the copy could fulfill a hold
2867 my $evt = OpenILS::Event->new('ACTION_HOLD_REQUEST_NOT_FOUND');
2869 my $bc = $copy->barcode;
2871 # find any existing holds that already target this copy
2872 my $old_holds = $editor->search_action_hold_request(
2873 { current_copy => $copy->id,
2874 cancel_time => undef,
2875 capture_time => undef
2879 my $hold_stall_interval = $U->ou_ancestor_setting_value($user->ws_ou, OILS_SETTING_HOLD_SOFT_STALL);
2881 $logger->info("circulator: searching for best hold at org ".$user->ws_ou.
2882 " and copy $bc with a hold stalling interval of ". ($hold_stall_interval || "(none)"));
2884 my $fifo = $U->ou_ancestor_setting_value($user->ws_ou, 'circ.holds_fifo');
2886 # search for what should be the best holds for this copy to fulfill
2887 my $best_holds = $U->storagereq(
2888 "open-ils.storage.action.hold_request.nearest_hold.atomic",
2889 $user->ws_ou, $copy->id, 10, $hold_stall_interval, $fifo );
2891 unless(@$best_holds) {
2893 if( my $hold = $$old_holds[0] ) {
2894 $logger->info("circulator: using existing pre-targeted hold ".$hold->id." in hold search");
2898 $logger->info("circulator: no suitable holds found for copy $bc");
2899 return (undef, $evt);
2905 # for each potential hold, we have to run the permit script
2906 # to make sure the hold is actually permitted.
2909 for my $holdid (@$best_holds) {
2910 next unless $holdid;
2911 $logger->info("circulator: checking if hold $holdid is permitted for copy $bc");
2913 my $hold = $editor->retrieve_action_hold_request($holdid) or next;
2914 my $reqr = $reqr_cache{$hold->requestor} || $editor->retrieve_actor_user($hold->requestor);
2915 my $rlib = $org_cache{$hold->request_lib} || $editor->retrieve_actor_org_unit($hold->request_lib);
2917 $reqr_cache{$hold->requestor} = $reqr;
2918 $org_cache{$hold->request_lib} = $rlib;
2920 # see if this hold is permitted
2921 my $permitted = OpenILS::Utils::PermitHold::permit_copy_hold(
2922 { patron_id => $hold->usr,
2925 pickup_lib => $hold->pickup_lib,
2926 request_lib => $rlib,
2938 unless( $best_hold ) { # no "good" permitted holds were found
2939 if( my $hold = $$old_holds[0] ) { # can we return a pre-targeted hold?
2940 $logger->info("circulator: using existing pre-targeted hold ".$hold->id." in hold search");
2945 $logger->info("circulator: no suitable holds found for copy $bc");
2946 return (undef, $evt);
2949 $logger->info("circulator: best hold ".$best_hold->id." found for copy $bc");
2951 # indicate a permitted hold was found
2952 return $best_hold if $check_only;
2954 # we've found a permitted hold. we need to "grab" the copy
2955 # to prevent re-targeted holds (next part) from re-grabbing the copy
2956 $best_hold->current_copy($copy->id);
2957 $editor->update_action_hold_request($best_hold)
2958 or return (undef, $editor->event);
2963 # re-target any other holds that already target this copy
2964 for my $old_hold (@$old_holds) {
2965 next if $old_hold->id eq $best_hold->id; # don't re-target the hold we want
2966 $logger->info("circulator: clearing current_copy and prev_check_time on hold ".
2967 $old_hold->id." after a better hold [".$best_hold->id."] was found");
2968 $old_hold->clear_current_copy;
2969 $old_hold->clear_prev_check_time;
2970 $editor->update_action_hold_request($old_hold)
2971 or return (undef, $editor->event);
2972 push(@retarget, $old_hold->id);
2975 return ($best_hold, undef, (@retarget) ? \@retarget : undef);
2983 __PACKAGE__->register_method(
2984 method => 'all_rec_holds',
2985 api_name => 'open-ils.circ.holds.retrieve_all_from_title',
2989 my( $self, $conn, $auth, $title_id, $args ) = @_;
2991 my $e = new_editor(authtoken=>$auth);
2992 $e->checkauth or return $e->event;
2993 $e->allowed('VIEW_HOLD') or return $e->event;
2996 $args->{fulfillment_time} = undef; # we don't want to see old fulfilled holds
2997 $args->{cancel_time} = undef;
2999 my $resp = { volume_holds => [], copy_holds => [], recall_holds => [], force_holds => [], metarecord_holds => [], part_holds => [], issuance_holds => [] };
3001 my $mr_map = $e->search_metabib_metarecord_source_map({source => $title_id})->[0];
3003 $resp->{metarecord_holds} = $e->search_action_hold_request(
3004 { hold_type => OILS_HOLD_TYPE_METARECORD,
3005 target => $mr_map->metarecord,
3011 $resp->{title_holds} = $e->search_action_hold_request(
3013 hold_type => OILS_HOLD_TYPE_TITLE,
3014 target => $title_id,
3018 my $parts = $e->search_biblio_monograph_part(
3024 $resp->{part_holds} = $e->search_action_hold_request(
3026 hold_type => OILS_HOLD_TYPE_MONOPART,
3032 my $subs = $e->search_serial_subscription(
3033 { record_entry => $title_id }, {idlist=>1});
3036 my $issuances = $e->search_serial_issuance(
3037 {subscription => $subs}, {idlist=>1}
3041 $resp->{issuance_holds} = $e->search_action_hold_request(
3043 hold_type => OILS_HOLD_TYPE_ISSUANCE,
3044 target => $issuances,
3051 my $vols = $e->search_asset_call_number(
3052 { record => $title_id, deleted => 'f' }, {idlist=>1});
3054 return $resp unless @$vols;
3056 $resp->{volume_holds} = $e->search_action_hold_request(
3058 hold_type => OILS_HOLD_TYPE_VOLUME,
3063 my $copies = $e->search_asset_copy(
3064 { call_number => $vols, deleted => 'f' }, {idlist=>1});
3066 return $resp unless @$copies;
3068 $resp->{copy_holds} = $e->search_action_hold_request(
3070 hold_type => OILS_HOLD_TYPE_COPY,
3075 $resp->{recall_holds} = $e->search_action_hold_request(
3077 hold_type => OILS_HOLD_TYPE_RECALL,
3082 $resp->{force_holds} = $e->search_action_hold_request(
3084 hold_type => OILS_HOLD_TYPE_FORCE,
3096 __PACKAGE__->register_method(
3097 method => 'uber_hold',
3099 api_name => 'open-ils.circ.hold.details.retrieve'
3103 my($self, $client, $auth, $hold_id, $args) = @_;
3104 my $e = new_editor(authtoken=>$auth);
3105 $e->checkauth or return $e->event;
3106 return uber_hold_impl($e, $hold_id, $args);
3109 __PACKAGE__->register_method(
3110 method => 'batch_uber_hold',
3113 api_name => 'open-ils.circ.hold.details.batch.retrieve'
3116 sub batch_uber_hold {
3117 my($self, $client, $auth, $hold_ids, $args) = @_;
3118 my $e = new_editor(authtoken=>$auth);
3119 $e->checkauth or return $e->event;
3120 $client->respond(uber_hold_impl($e, $_, $args)) for @$hold_ids;
3124 sub uber_hold_impl {
3125 my($e, $hold_id, $args) = @_;
3128 my $hold = $e->retrieve_action_hold_request(
3133 flesh_fields => { ahr => [ 'current_copy', 'usr', 'notes' ] }
3136 ) or return $e->event;
3138 if($hold->usr->id ne $e->requestor->id) {
3139 # A user is allowed to see his/her own holds
3140 $e->allowed('VIEW_HOLD') or return $e->event;
3141 $hold->notes( # filter out any non-staff ("private") notes
3142 [ grep { !$U->is_true($_->staff) } @{$hold->notes} ] );
3145 # caller is asking for own hold, but may not have permission to view staff notes
3146 unless($e->allowed('VIEW_HOLD')) {
3147 $hold->notes( # filter out any staff notes
3148 [ grep { $U->is_true($_->staff) } @{$hold->notes} ] );
3152 my $user = $hold->usr;
3153 $hold->usr($user->id);
3156 my( $mvr, $volume, $copy, $issuance, $part, $bre ) = find_hold_mvr($e, $hold, $args->{suppress_mvr});
3158 flesh_hold_notices([$hold], $e) unless $args->{suppress_notices};
3159 flesh_hold_transits([$hold]) unless $args->{suppress_transits};
3161 my $details = retrieve_hold_queue_status_impl($e, $hold);
3166 ($copy ? (copy => $copy) : ()),
3167 ($volume ? (volume => $volume) : ()),
3168 ($issuance ? (issuance => $issuance) : ()),
3169 ($part ? (part => $part) : ()),
3170 ($args->{include_bre} ? (bre => $bre) : ()),
3171 ($args->{suppress_mvr} ? () : (mvr => $mvr)),
3175 unless($args->{suppress_patron_details}) {
3176 my $card = $e->retrieve_actor_card($user->card) or return $e->event;
3177 $resp->{patron_first} = $user->first_given_name,
3178 $resp->{patron_last} = $user->family_name,
3179 $resp->{patron_barcode} = $card->barcode,
3180 $resp->{patron_alias} = $user->alias,
3188 # -----------------------------------------------------
3189 # Returns the MVR object that represents what the
3191 # -----------------------------------------------------
3193 my( $e, $hold, $no_mvr ) = @_;
3201 if( $hold->hold_type eq OILS_HOLD_TYPE_METARECORD ) {
3202 my $mr = $e->retrieve_metabib_metarecord($hold->target)
3203 or return $e->event;
3204 $tid = $mr->master_record;
3206 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_TITLE ) {
3207 $tid = $hold->target;
3209 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_VOLUME ) {
3210 $volume = $e->retrieve_asset_call_number($hold->target)
3211 or return $e->event;
3212 $tid = $volume->record;
3214 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_ISSUANCE ) {
3215 $issuance = $e->retrieve_serial_issuance([
3217 {flesh => 1, flesh_fields => {siss => [ qw/subscription/ ]}}
3218 ]) or return $e->event;
3220 $tid = $issuance->subscription->record_entry;
3222 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_MONOPART ) {
3223 $part = $e->retrieve_biblio_monograph_part([
3225 ]) or return $e->event;
3227 $tid = $part->record;
3229 } 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 ) {
3230 $copy = $e->retrieve_asset_copy([
3232 {flesh => 1, flesh_fields => {acp => ['call_number']}}
3233 ]) or return $e->event;
3235 $volume = $copy->call_number;
3236 $tid = $volume->record;
3239 if(!$copy and ref $hold->current_copy ) {
3240 $copy = $hold->current_copy;
3241 $hold->current_copy($copy->id);
3244 if(!$volume and $copy) {
3245 $volume = $e->retrieve_asset_call_number($copy->call_number);
3248 # TODO return metarcord mvr for M holds
3249 my $title = $e->retrieve_biblio_record_entry($tid);
3250 return ( ($no_mvr) ? undef : $U->record_to_mvr($title), $volume, $copy, $issuance, $part, $title );
3253 __PACKAGE__->register_method(
3254 method => 'clear_shelf_cache',
3255 api_name => 'open-ils.circ.hold.clear_shelf.get_cache',
3259 Returns the holds processed with the given cache key
3264 sub clear_shelf_cache {
3265 my($self, $client, $auth, $cache_key, $chunk_size) = @_;
3266 my $e = new_editor(authtoken => $auth, xact => 1);
3267 return $e->die_event unless $e->checkauth and $e->allowed('VIEW_HOLD');
3270 my $hold_data = OpenSRF::Utils::Cache->new('global')->get_cache($cache_key);
3273 $logger->info("no hold data found in cache"); # XXX TODO return event
3279 foreach (keys %$hold_data) {
3280 $maximum += scalar(@{ $hold_data->{$_} });
3282 $client->respond({"maximum" => $maximum, "progress" => 0});
3284 for my $action (sort keys %$hold_data) {
3285 while (@{$hold_data->{$action}}) {
3286 my @hid_chunk = splice @{$hold_data->{$action}}, 0, $chunk_size;
3288 my $result_chunk = $e->json_query({
3290 "acp" => ["barcode"],
3292 first_given_name second_given_name family_name alias
3295 "acnp" => [{column => "label", alias => "prefix"}],
3296 "acns" => [{column => "label", alias => "suffix"}],
3304 "field" => "id", "fkey" => "current_copy",
3307 "field" => "id", "fkey" => "call_number",
3310 "field" => "id", "fkey" => "record"
3313 "field" => "id", "fkey" => "prefix"
3316 "field" => "id", "fkey" => "suffix"
3320 "acpl" => {"field" => "id", "fkey" => "location"}
3323 "au" => {"field" => "id", "fkey" => "usr"}
3326 "where" => {"+ahr" => {"id" => \@hid_chunk}}
3327 }, {"substream" => 1}) or return $e->die_event;
3331 +{"action" => $action, "hold_details" => $_}
3342 __PACKAGE__->register_method(
3343 method => 'clear_shelf_process',
3345 api_name => 'open-ils.circ.hold.clear_shelf.process',
3348 1. Find all holds that have expired on the holds shelf
3350 3. If a clear-shelf status is configured, put targeted copies into this status
3351 4. Divide copies into 3 groups: items to transit, items to reshelve, and items
3352 that are needed for holds. No subsequent action is taken on the holds
3353 or items after grouping.
3358 sub clear_shelf_process {
3359 my($self, $client, $auth, $org_id, $match_copy) = @_;
3361 my $e = new_editor(authtoken=>$auth, xact => 1);
3362 $e->checkauth or return $e->die_event;
3363 my $cache = OpenSRF::Utils::Cache->new('global');
3365 $org_id ||= $e->requestor->ws_ou;
3366 $e->allowed('UPDATE_HOLD', $org_id) or return $e->die_event;
3368 my $copy_status = $U->ou_ancestor_setting_value($org_id, 'circ.holds.clear_shelf.copy_status');
3370 my @hold_ids = $self->method_lookup(
3371 "open-ils.circ.captured_holds.id_list.expired_on_shelf.retrieve"
3372 )->run($auth, $org_id, $match_copy);
3375 my @canceled_holds; # newly canceled holds
3376 my $chunk_size = 25; # chunked status updates
3378 for my $hold_id (@hold_ids) {
3380 $logger->info("Clear shelf processing hold $hold_id");
3382 my $hold = $e->retrieve_action_hold_request([
3385 flesh_fields => {ahr => ['current_copy']}
3389 if (!$hold->cancel_time) { # may be canceled but still on the holds shelf
3390 $hold->cancel_time('now');
3391 $hold->cancel_cause(2); # Hold Shelf expiration
3392 $e->update_action_hold_request($hold) or return $e->die_event;
3393 delete_hold_copy_maps($self, $e, $hold->id) and return $e->die_event;
3394 push(@canceled_holds, $hold_id);
3397 my $copy = $hold->current_copy;
3399 if($copy_status or $copy_status == 0) {
3400 # if a clear-shelf copy status is defined, update the copy
3401 $copy->status($copy_status);
3402 $copy->edit_date('now');
3403 $copy->editor($e->requestor->id);
3404 $e->update_asset_copy($copy) or return $e->die_event;
3407 push(@holds, $hold);
3408 $client->respond({maximum => scalar(@holds), progress => $counter}) if ( (++$counter % $chunk_size) == 0);
3419 for my $hold (@holds) {
3421 my $copy = $hold->current_copy;
3422 my ($alt_hold) = __PACKAGE__->find_nearest_permitted_hold($e, $copy, $e->requestor, 1);
3424 if($alt_hold and !$match_copy) {
3426 push(@{$cache_data{hold}}, $hold->id); # copy is needed for a hold
3428 } elsif($copy->circ_lib != $e->requestor->ws_ou) {
3430 push(@{$cache_data{transit}}, $hold->id); # copy needs to transit
3434 push(@{$cache_data{shelf}}, $hold->id); # copy needs to go back to the shelf
3438 my $cache_key = md5_hex(time . $$ . rand());
3439 $logger->info("clear_shelf_cache: storing under $cache_key");
3440 $cache->put_cache($cache_key, \%cache_data, 7200); # TODO: 2 hours. configurable?
3442 # tell the client we're done
3443 $client->respond_complete({cache_key => $cache_key});
3446 # fire off the hold cancelation trigger and wait for response so don't flood the service
3448 # refetch the holds to pick up the caclulated cancel_time,
3449 # which may be needed by Action/Trigger
3451 my $updated_holds = [];
3452 $updated_holds = $e->search_action_hold_request({id => \@canceled_holds}, {substream => 1}) if (@canceled_holds > 0);
3455 $U->create_events_for_hook(
3456 'hold_request.cancel.expire_holds_shelf',
3457 $_, $org_id, undef, undef, 1) for @$updated_holds;
3460 # tell the client we're done
3461 $client->respond_complete;
3465 __PACKAGE__->register_method(
3466 method => 'usr_hold_summary',
3467 api_name => 'open-ils.circ.holds.user_summary',
3469 Returns a summary of holds statuses for a given user
3473 sub usr_hold_summary {
3474 my($self, $conn, $auth, $user_id) = @_;
3476 my $e = new_editor(authtoken=>$auth);
3477 $e->checkauth or return $e->event;
3478 $e->allowed('VIEW_HOLD') or return $e->event;
3480 my $holds = $e->search_action_hold_request(
3483 fulfillment_time => undef,
3484 cancel_time => undef,
3488 my %summary = (1 => 0, 2 => 0, 3 => 0, 4 => 0);
3489 $summary{_hold_status($e, $_)} += 1 for @$holds;
3495 __PACKAGE__->register_method(
3496 method => 'hold_has_copy_at',
3497 api_name => 'open-ils.circ.hold.has_copy_at',
3500 'Returns the ID of the found copy and name of the shelving location if there is ' .
3501 'an available copy at the specified org unit. Returns empty hash otherwise. ' .
3502 'The anticipated use for this method is to determine whether an item is ' .
3503 'available at the library where the user is placing the hold (or, alternatively, '.
3504 'at the pickup library) to encourage bypassing the hold placement and just ' .
3505 'checking out the item.' ,
3507 { desc => 'Authentication Token', type => 'string' },
3508 { desc => 'Method Arguments. Options include: hold_type, hold_target, org_unit. '
3509 . 'hold_type is the hold type code (T, V, C, M, ...). '
3510 . 'hold_target is the identifier of the hold target object. '
3511 . 'org_unit is org unit ID.',
3516 desc => q/Result hash like { "copy" : copy_id, "location" : location_name }, empty hash on misses, event on error./,
3522 sub hold_has_copy_at {
3523 my($self, $conn, $auth, $args) = @_;
3525 my $e = new_editor(authtoken=>$auth);
3526 $e->checkauth or return $e->event;
3528 my $hold_type = $$args{hold_type};
3529 my $hold_target = $$args{hold_target};
3530 my $org_unit = $$args{org_unit};
3533 select => {acp => ['id'], acpl => ['name']},
3536 acpl => {field => 'id', filter => { holdable => 't'}, fkey => 'location'},
3537 ccs => {field => 'id', filter => { holdable => 't'}, fkey => 'status' }
3540 where => {'+acp' => { circulate => 't', deleted => 'f', holdable => 't', circ_lib => $org_unit}},
3544 if($hold_type eq 'C' or $hold_type eq 'F' or $hold_type eq 'R') {
3546 $query->{where}->{'+acp'}->{id} = $hold_target;
3548 } elsif($hold_type eq 'V') {
3550 $query->{where}->{'+acp'}->{call_number} = $hold_target;
3552 } elsif($hold_type eq 'T') {
3554 $query->{from}->{acp}->{acn} = {
3556 fkey => 'call_number',
3560 filter => {id => $hold_target},
3568 $query->{from}->{acp}->{acn} = {
3570 fkey => 'call_number',
3579 filter => {metarecord => $hold_target},
3587 my $res = $e->json_query($query)->[0] or return {};
3588 return {copy => $res->{id}, location => $res->{name}} if $res;
3592 # returns true if the user already has an item checked out
3593 # that could be used to fulfill the requested hold.
3594 sub hold_item_is_checked_out {
3595 my($e, $user_id, $hold_type, $hold_target) = @_;
3598 select => {acp => ['id']},
3599 from => {acp => {}},
3603 in => { # copies for circs the user has checked out
3604 select => {circ => ['target_copy']},
3608 checkin_time => undef,
3610 {stop_fines => ["MAXFINES","LONGOVERDUE"]},
3611 {stop_fines => undef}
3621 if($hold_type eq 'C' || $hold_type eq 'R' || $hold_type eq 'F') {
3623 $query->{where}->{'+acp'}->{id}->{in}->{where}->{'target_copy'} = $hold_target;
3625 } elsif($hold_type eq 'V') {
3627 $query->{where}->{'+acp'}->{call_number} = $hold_target;
3629 } elsif($hold_type eq 'P') {
3631 $query->{from}->{acp}->{acpm} = {
3632 field => 'target_copy',
3634 filter => {part => $hold_target},
3637 } elsif($hold_type eq 'I') {
3639 $query->{from}->{acp}->{sitem} = {
3642 filter => {issuance => $hold_target},
3645 } elsif($hold_type eq 'T') {
3647 $query->{from}->{acp}->{acn} = {
3649 fkey => 'call_number',
3653 filter => {id => $hold_target},
3661 $query->{from}->{acp}->{acn} = {
3663 fkey => 'call_number',
3672 filter => {metarecord => $hold_target},
3680 return $e->json_query($query)->[0];
3683 __PACKAGE__->register_method(
3684 method => 'change_hold_title',
3685 api_name => 'open-ils.circ.hold.change_title',
3688 Updates all title level holds targeting the specified bibs to point a new bib./,
3690 { desc => 'Authentication Token', type => 'string' },
3691 { desc => 'New Target Bib Id', type => 'number' },
3692 { desc => 'Old Target Bib Ids', type => 'array' },
3694 return => { desc => '1 on success' }
3698 __PACKAGE__->register_method(
3699 method => 'change_hold_title_for_specific_holds',
3700 api_name => 'open-ils.circ.hold.change_title.specific_holds',
3703 Updates specified holds to target new bib./,
3705 { desc => 'Authentication Token', type => 'string' },
3706 { desc => 'New Target Bib Id', type => 'number' },
3707 { desc => 'Holds Ids for holds to update', type => 'array' },
3709 return => { desc => '1 on success' }
3714 sub change_hold_title {
3715 my( $self, $client, $auth, $new_bib_id, $bib_ids ) = @_;
3717 my $e = new_editor(authtoken=>$auth, xact=>1);
3718 return $e->die_event unless $e->checkauth;
3720 my $holds = $e->search_action_hold_request(
3723 cancel_time => undef,
3724 fulfillment_time => undef,
3730 flesh_fields => { ahr => ['usr'] }
3736 for my $hold (@$holds) {
3737 $e->allowed('UPDATE_HOLD', $hold->usr->home_ou) or return $e->die_event;
3738 $logger->info("Changing hold " . $hold->id . " target from " . $hold->target . " to $new_bib_id in title hold target change");
3739 $hold->target( $new_bib_id );
3740 $e->update_action_hold_request($hold) or return $e->die_event;
3745 _reset_hold($self, $e->requestor, $_) for @$holds;
3750 sub change_hold_title_for_specific_holds {
3751 my( $self, $client, $auth, $new_bib_id, $hold_ids ) = @_;
3753 my $e = new_editor(authtoken=>$auth, xact=>1);
3754 return $e->die_event unless $e->checkauth;
3756 my $holds = $e->search_action_hold_request(
3759 cancel_time => undef,
3760 fulfillment_time => undef,
3766 flesh_fields => { ahr => ['usr'] }
3772 for my $hold (@$holds) {
3773 $e->allowed('UPDATE_HOLD', $hold->usr->home_ou) or return $e->die_event;
3774 $logger->info("Changing hold " . $hold->id . " target from " . $hold->target . " to $new_bib_id in title hold target change");
3775 $hold->target( $new_bib_id );
3776 $e->update_action_hold_request($hold) or return $e->die_event;
3781 _reset_hold($self, $e->requestor, $_) for @$holds;
3786 __PACKAGE__->register_method(
3787 method => 'rec_hold_count',
3788 api_name => 'open-ils.circ.bre.holds.count',
3790 desc => q/Returns the total number of holds that target the
3791 selected bib record or its associated copies and call_numbers/,
3793 { desc => 'Bib ID', type => 'number' },
3795 return => {desc => 'Hold count', type => 'number'}
3799 __PACKAGE__->register_method(
3800 method => 'rec_hold_count',
3801 api_name => 'open-ils.circ.mmr.holds.count',
3803 desc => q/Returns the total number of holds that target the
3804 selected metarecord or its associated copies, call_numbers, and bib records/,
3806 { desc => 'Metarecord ID', type => 'number' },
3808 return => {desc => 'Hold count', type => 'number'}
3812 # XXX Need to add type I (and, soon, type P) holds to these counts
3813 sub rec_hold_count {
3814 my($self, $conn, $target_id) = @_;
3821 filter => {metarecord => $target_id}
3828 filter => { id => $target_id },
3833 if($self->api_name =~ /mmr/) {
3834 delete $bre_join->{bre}->{filter};
3835 $bre_join->{bre}->{join} = $mmr_join;
3841 fkey => 'call_number',
3847 select => {ahr => [{column => 'id', transform => 'count', alias => 'count'}]},
3851 cancel_time => undef,
3852 fulfillment_time => undef,
3856 hold_type => [qw/C F R/],
3859 select => {acp => ['id']},
3860 from => { acp => $cn_join }
3870 select => {acn => ['id']},
3871 from => {acn => $bre_join}
3879 target => $target_id
3887 if($self->api_name =~ /mmr/) {
3888 $query->{where}->{'+ahr'}->{'-or'}->[2] = {
3893 select => {bre => ['id']},
3894 from => {bre => $mmr_join}
3900 $query->{where}->{'+ahr'}->{'-or'}->[3] = {
3903 target => $target_id
3909 return new_editor()->json_query($query)->[0]->{count};