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 ) {
292 return $e->die_event unless $e->allowed('COPY_HOLDS', $porg);
293 } elsif ( $t eq OILS_HOLD_TYPE_RECALL ) {
294 return $e->die_event unless $e->allowed('COPY_HOLDS', $porg);
302 for my $evt (@events) {
304 my $name = $evt->{textcode};
305 return $e->die_event unless $e->allowed("$name.override", $porg);
309 # set the configured expire time
310 unless($hold->expire_time) {
311 my $interval = $U->ou_ancestor_setting_value($recipient->home_ou, OILS_SETTING_HOLD_EXPIRE);
313 my $date = DateTime->now->add(seconds => OpenSRF::Utils::interval_to_seconds($interval));
314 $hold->expire_time($U->epoch2ISO8601($date->epoch));
318 $hold->requestor($e->requestor->id);
319 $hold->request_lib($e->requestor->ws_ou);
320 $hold->selection_ou($hold->pickup_lib) unless $hold->selection_ou;
321 $hold = $e->create_action_hold_request($hold) or return $e->die_event;
325 $conn->respond_complete($hold->id);
328 'open-ils.storage.action.hold_request.copy_targeter',
329 undef, $hold->id ) unless $U->is_true($hold->frozen);
334 # makes sure that a user has permission to place the type of requested hold
335 # returns the Perm exception if not allowed, returns undef if all is well
336 sub _check_holds_perm {
337 my($type, $user_id, $org_id) = @_;
341 $evt = $apputils->check_perms($user_id, $org_id, "MR_HOLDS" );
342 } elsif ($type eq "T") {
343 $evt = $apputils->check_perms($user_id, $org_id, "TITLE_HOLDS" );
344 } elsif($type eq "V") {
345 $evt = $apputils->check_perms($user_id, $org_id, "VOLUME_HOLDS");
346 } elsif($type eq "C") {
347 $evt = $apputils->check_perms($user_id, $org_id, "COPY_HOLDS" );
354 # tests if the given user is allowed to place holds on another's behalf
355 sub _check_request_holds_perm {
358 if (my $evt = $apputils->check_perms(
359 $user_id, $org_id, "REQUEST_HOLDS")) {
364 my $ses_is_req_note = 'The login session is the requestor. If the requestor is different from the user, ' .
365 'then the requestor must have VIEW_HOLD permissions';
367 __PACKAGE__->register_method(
368 method => "retrieve_holds_by_id",
369 api_name => "open-ils.circ.holds.retrieve_by_id",
371 desc => "Retrieve the hold, with hold transits attached, for the specified ID. $ses_is_req_note",
373 { desc => 'Authentication token', type => 'string' },
374 { desc => 'Hold ID', type => 'number' }
377 desc => 'Hold object with transits attached, event on error',
383 sub retrieve_holds_by_id {
384 my($self, $client, $auth, $hold_id) = @_;
385 my $e = new_editor(authtoken=>$auth);
386 $e->checkauth or return $e->event;
387 $e->allowed('VIEW_HOLD') or return $e->event;
389 my $holds = $e->search_action_hold_request(
391 { id => $hold_id , fulfillment_time => undef },
393 order_by => { ahr => "request_time" },
395 flesh_fields => {ahr => ['notes']}
400 flesh_hold_transits($holds);
401 flesh_hold_notices($holds, $e);
406 __PACKAGE__->register_method(
407 method => "retrieve_holds",
408 api_name => "open-ils.circ.holds.retrieve",
410 desc => "Retrieves all the holds, with hold transits attached, for the specified user. $ses_is_req_note",
412 { desc => 'Authentication token', type => 'string' },
413 { desc => 'User ID', type => 'integer' }
416 desc => 'list of holds, event on error',
421 __PACKAGE__->register_method(
422 method => "retrieve_holds",
423 api_name => "open-ils.circ.holds.id_list.retrieve",
426 desc => "Retrieves all the hold IDs, for the specified user. $ses_is_req_note",
428 { desc => 'Authentication token', type => 'string' },
429 { desc => 'User ID', type => 'integer' }
432 desc => 'list of holds, event on error',
437 __PACKAGE__->register_method(
438 method => "retrieve_holds",
439 api_name => "open-ils.circ.holds.canceled.retrieve",
442 desc => "Retrieves all the cancelled holds for the specified user. $ses_is_req_note",
444 { desc => 'Authentication token', type => 'string' },
445 { desc => 'User ID', type => 'integer' }
448 desc => 'list of holds, event on error',
453 __PACKAGE__->register_method(
454 method => "retrieve_holds",
455 api_name => "open-ils.circ.holds.canceled.id_list.retrieve",
458 desc => "Retrieves list of cancelled hold IDs for the specified user. $ses_is_req_note",
460 { desc => 'Authentication token', type => 'string' },
461 { desc => 'User ID', type => 'integer' }
464 desc => 'list of hold IDs, event on error',
471 my ($self, $client, $auth, $user_id) = @_;
473 my $e = new_editor(authtoken=>$auth);
474 return $e->event unless $e->checkauth;
475 $user_id = $e->requestor->id unless defined $user_id;
477 my $notes_filter = {staff => 'f'};
478 my $user = $e->retrieve_actor_user($user_id) or return $e->event;
479 unless($user_id == $e->requestor->id) {
480 if($e->allowed('VIEW_HOLD', $user->home_ou)) {
481 $notes_filter = {staff => 't'}
483 my $allowed = OpenILS::Application::Actor::Friends->friend_perm_allowed(
484 $e, $user_id, $e->requestor->id, 'hold.view');
485 return $e->event unless $allowed;
488 # staff member looking at his/her own holds can see staff and non-staff notes
489 $notes_filter = {} if $e->allowed('VIEW_HOLD', $user->home_ou);
493 select => {ahr => ['id']},
495 where => {usr => $user_id, fulfillment_time => undef}
498 if($self->api_name =~ /canceled/) {
500 # Fetch the canceled holds
501 # order cancelled holds by cancel time, most recent first
503 $holds_query->{order_by} = [{class => 'ahr', field => 'cancel_time', direction => 'desc'}];
506 my $cancel_count = $U->ou_ancestor_setting_value(
507 $e->requestor->ws_ou, 'circ.holds.canceled.display_count', $e);
509 unless($cancel_count) {
510 $cancel_age = $U->ou_ancestor_setting_value(
511 $e->requestor->ws_ou, 'circ.holds.canceled.display_age', $e);
513 # if no settings are defined, default to last 10 cancelled holds
514 $cancel_count = 10 unless $cancel_age;
517 if($cancel_count) { # limit by count
519 $holds_query->{where}->{cancel_time} = {'!=' => undef};
520 $holds_query->{limit} = $cancel_count;
522 } elsif($cancel_age) { # limit by age
524 # find all of the canceled holds that were canceled within the configured time frame
525 my $date = DateTime->now->subtract(seconds => OpenSRF::Utils::interval_to_seconds($cancel_age));
526 $date = $U->epoch2ISO8601($date->epoch);
527 $holds_query->{where}->{cancel_time} = {'>=' => $date};
532 # order non-cancelled holds by ready-for-pickup, then active, followed by suspended
533 $holds_query->{order_by} = {ahr => ['shelf_time', 'frozen', 'request_time']};
534 $holds_query->{where}->{cancel_time} = undef;
537 my $hold_ids = $e->json_query($holds_query);
538 $hold_ids = [ map { $_->{id} } @$hold_ids ];
540 return $hold_ids if $self->api_name =~ /id_list/;
543 for my $hold_id ( @$hold_ids ) {
545 my $hold = $e->retrieve_action_hold_request($hold_id);
546 $hold->notes($e->search_action_hold_request_note({hold => $hold_id, %$notes_filter}));
549 $e->search_action_hold_transit_copy([
551 {order_by => {ahtc => 'source_send_time desc'}, limit => 1}])->[0]
561 __PACKAGE__->register_method(
562 method => 'user_hold_count',
563 api_name => 'open-ils.circ.hold.user.count'
566 sub user_hold_count {
567 my ( $self, $conn, $auth, $userid ) = @_;
568 my $e = new_editor( authtoken => $auth );
569 return $e->event unless $e->checkauth;
570 my $patron = $e->retrieve_actor_user($userid)
572 return $e->event unless $e->allowed( 'VIEW_HOLD', $patron->home_ou );
573 return __user_hold_count( $self, $e, $userid );
576 sub __user_hold_count {
577 my ( $self, $e, $userid ) = @_;
578 my $holds = $e->search_action_hold_request(
581 fulfillment_time => undef,
582 cancel_time => undef,
587 return scalar(@$holds);
591 __PACKAGE__->register_method(
592 method => "retrieve_holds_by_pickup_lib",
593 api_name => "open-ils.circ.holds.retrieve_by_pickup_lib",
595 "Retrieves all the holds, with hold transits attached, for the specified pickup_ou id."
598 __PACKAGE__->register_method(
599 method => "retrieve_holds_by_pickup_lib",
600 api_name => "open-ils.circ.holds.id_list.retrieve_by_pickup_lib",
601 notes => "Retrieves all the hold ids for the specified pickup_ou id. "
604 sub retrieve_holds_by_pickup_lib {
605 my ($self, $client, $login_session, $ou_id) = @_;
607 #FIXME -- put an appropriate permission check here
608 #my( $user, $target, $evt ) = $apputils->checkses_requestor(
609 # $login_session, $user_id, 'VIEW_HOLD' );
610 #return $evt if $evt;
612 my $holds = $apputils->simplereq(
614 "open-ils.cstore.direct.action.hold_request.search.atomic",
616 pickup_lib => $ou_id ,
617 fulfillment_time => undef,
620 { order_by => { ahr => "request_time" } }
623 if ( ! $self->api_name =~ /id_list/ ) {
624 flesh_hold_transits($holds);
628 return [ map { $_->id } @$holds ];
632 __PACKAGE__->register_method(
633 method => "uncancel_hold",
634 api_name => "open-ils.circ.hold.uncancel"
638 my($self, $client, $auth, $hold_id) = @_;
639 my $e = new_editor(authtoken=>$auth, xact=>1);
640 return $e->die_event unless $e->checkauth;
642 my $hold = $e->retrieve_action_hold_request($hold_id)
643 or return $e->die_event;
644 return $e->die_event unless $e->allowed('CANCEL_HOLDS', $hold->request_lib);
646 if ($hold->fulfillment_time) {
650 unless ($hold->cancel_time) {
655 # if configured to reset the request time, also reset the expire time
656 if($U->ou_ancestor_setting_value(
657 $hold->request_lib, 'circ.holds.uncancel.reset_request_time', $e)) {
659 $hold->request_time('now');
660 my $interval = $U->ou_ancestor_setting_value($hold->request_lib, OILS_SETTING_HOLD_EXPIRE);
662 my $date = DateTime->now->add(seconds => OpenSRF::Utils::interval_to_seconds($interval));
663 $hold->expire_time($U->epoch2ISO8601($date->epoch));
667 $hold->clear_cancel_time;
668 $hold->clear_cancel_cause;
669 $hold->clear_cancel_note;
670 $hold->clear_shelf_time;
671 $hold->clear_current_copy;
672 $hold->clear_capture_time;
673 $hold->clear_prev_check_time;
674 $hold->clear_shelf_expire_time;
676 $e->update_action_hold_request($hold) or return $e->die_event;
679 $U->storagereq('open-ils.storage.action.hold_request.copy_targeter', undef, $hold_id);
685 __PACKAGE__->register_method(
686 method => "cancel_hold",
687 api_name => "open-ils.circ.hold.cancel",
689 desc => 'Cancels the specified hold. The login session is the requestor. If the requestor is different from the usr field ' .
690 'on the hold, the requestor must have CANCEL_HOLDS permissions. The hold may be either the hold object or the hold id',
692 {desc => 'Authentication token', type => 'string'},
693 {desc => 'Hold ID', type => 'number'},
694 {desc => 'Cause of Cancellation', type => 'string'},
695 {desc => 'Note', type => 'string'}
698 desc => '1 on success, event on error'
704 my($self, $client, $auth, $holdid, $cause, $note) = @_;
706 my $e = new_editor(authtoken=>$auth, xact=>1);
707 return $e->die_event unless $e->checkauth;
709 my $hold = $e->retrieve_action_hold_request($holdid)
710 or return $e->die_event;
712 if( $e->requestor->id ne $hold->usr ) {
713 return $e->die_event unless $e->allowed('CANCEL_HOLDS');
716 if ($hold->cancel_time) {
721 # If the hold is captured, reset the copy status
722 if( $hold->capture_time and $hold->current_copy ) {
724 my $copy = $e->retrieve_asset_copy($hold->current_copy)
725 or return $e->die_event;
727 if( $copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF ) {
728 $logger->info("canceling hold $holdid whose item is on the holds shelf");
729 # $logger->info("setting copy to status 'reshelving' on hold cancel");
730 # $copy->status(OILS_COPY_STATUS_RESHELVING);
731 # $copy->editor($e->requestor->id);
732 # $copy->edit_date('now');
733 # $e->update_asset_copy($copy) or return $e->event;
735 } elsif( $copy->status == OILS_COPY_STATUS_IN_TRANSIT ) {
738 $logger->warn("! canceling hold [$hid] that is in transit");
739 my $transid = $e->search_action_hold_transit_copy({hold=>$hold->id},{idlist=>1})->[0];
742 my $trans = $e->retrieve_action_transit_copy($transid);
743 # Leave the transit alive, but set the copy status to
744 # reshelving so it will be properly reshelved when it gets back home
746 $trans->copy_status( OILS_COPY_STATUS_RESHELVING );
747 $e->update_action_transit_copy($trans) or return $e->die_event;
753 $hold->cancel_time('now');
754 $hold->cancel_cause($cause);
755 $hold->cancel_note($note);
756 $e->update_action_hold_request($hold)
757 or return $e->die_event;
759 delete_hold_copy_maps($self, $e, $hold->id);
763 $U->create_events_for_hook('hold_request.cancel.staff', $hold, $hold->pickup_lib)
764 if $e->requestor->id != $hold->usr;
769 sub delete_hold_copy_maps {
774 my $maps = $editor->search_action_hold_copy_map({hold=>$holdid});
776 $editor->delete_action_hold_copy_map($_)
777 or return $editor->event;
783 my $update_hold_desc = 'The login session is the requestor. ' .
784 'If the requestor is different from the usr field on the hold, ' .
785 'the requestor must have UPDATE_HOLDS permissions. ' .
786 'If supplying a hash of hold data, "id" must be included. ' .
787 'The hash is ignored if a hold object is supplied, ' .
788 'so you should supply only one kind of hold data argument.' ;
790 __PACKAGE__->register_method(
791 method => "update_hold",
792 api_name => "open-ils.circ.hold.update",
794 desc => "Updates the specified hold. $update_hold_desc",
796 {desc => 'Authentication token', type => 'string'},
797 {desc => 'Hold Object', type => 'object'},
798 {desc => 'Hash of values to be applied', type => 'object'}
801 desc => 'Hold ID on success, event on error',
807 __PACKAGE__->register_method(
808 method => "batch_update_hold",
809 api_name => "open-ils.circ.hold.update.batch",
812 desc => "Updates the specified hold(s). $update_hold_desc",
814 {desc => 'Authentication token', type => 'string'},
815 {desc => 'Array of hold obejcts', type => 'array' },
816 {desc => 'Array of hashes of values to be applied', type => 'array' }
819 desc => 'Hold ID per success, event per error',
825 my($self, $client, $auth, $hold, $values) = @_;
826 my $e = new_editor(authtoken=>$auth, xact=>1);
827 return $e->die_event unless $e->checkauth;
828 my $resp = update_hold_impl($self, $e, $hold, $values);
829 if ($U->event_code($resp)) {
833 $e->commit; # FIXME: update_hold_impl already does $e->commit ??
837 sub batch_update_hold {
838 my($self, $client, $auth, $hold_list, $values_list) = @_;
839 my $e = new_editor(authtoken=>$auth);
840 return $e->die_event unless $e->checkauth;
842 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.
844 $values_list ||= []; # FIXME: either move this above $count declaration, or send an event if both lists undef. Probably the latter.
846 # FIXME: Failing over to [] guarantees warnings for "Use of unitialized value" in update_hold_impl call.
847 # FIXME: We should be sure we only call update_hold_impl with hold object OR hash, not both.
849 for my $idx (0..$count-1) {
851 my $resp = update_hold_impl($self, $e, $hold_list->[$idx], $values_list->[$idx]);
852 $e->xact_commit unless $U->event_code($resp);
853 $client->respond($resp);
857 return undef; # not in the register return type, assuming we should always have at least one list populated
860 sub update_hold_impl {
861 my($self, $e, $hold, $values) = @_;
864 $hold = $e->retrieve_action_hold_request($values->{id})
865 or return $e->die_event;
866 for my $k (keys %$values) {
867 if (defined $values->{$k}) {
868 $hold->$k($values->{$k});
870 my $f = "clear_$k"; $hold->$f();
875 my $orig_hold = $e->retrieve_action_hold_request($hold->id)
876 or return $e->die_event;
878 # don't allow the user to be changed
879 return OpenILS::Event->new('BAD_PARAMS') if $hold->usr != $orig_hold->usr;
881 if($hold->usr ne $e->requestor->id) {
882 # if the hold is for a different user, make sure the
883 # requestor has the appropriate permissions
884 my $usr = $e->retrieve_actor_user($hold->usr)
885 or return $e->die_event;
886 return $e->die_event unless $e->allowed('UPDATE_HOLD', $usr->home_ou);
890 # --------------------------------------------------------------
891 # Changing the request time is like playing God
892 # --------------------------------------------------------------
893 if($hold->request_time ne $orig_hold->request_time) {
894 return OpenILS::Event->new('BAD_PARAMS') if $hold->fulfillment_time;
895 return $e->die_event unless $e->allowed('UPDATE_HOLD_REQUEST_TIME', $hold->pickup_lib);
899 # --------------------------------------------------------------
900 # Code for making sure staff have appropriate permissons for cut_in_line
901 # This, as is, doesn't prevent a user from cutting their own holds in line
903 # --------------------------------------------------------------
904 if($U->is_true($hold->cut_in_line) ne $U->is_true($orig_hold->cut_in_line)) {
905 return $e->die_event unless $e->allowed('UPDATE_HOLD_REQUEST_TIME', $hold->pickup_lib);
908 # --------------------------------------------------------------
909 # if the hold is on the holds shelf or in transit and the pickup
910 # lib changes we need to create a new transit.
911 # --------------------------------------------------------------
912 if($orig_hold->pickup_lib ne $hold->pickup_lib) {
914 my $status = _hold_status($e, $hold);
916 if($status == 3) { # in transit
918 return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_TRANSIT', $orig_hold->pickup_lib);
919 return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_TRANSIT', $hold->pickup_lib);
921 $logger->info("updating pickup lib for hold ".$hold->id." while already in transit");
923 # update the transit to reflect the new pickup location
924 my $transit = $e->search_action_hold_transit_copy(
925 {hold=>$hold->id, dest_recv_time => undef})->[0]
926 or return $e->die_event;
928 $transit->prev_dest($transit->dest); # mark the previous destination on the transit
929 $transit->dest($hold->pickup_lib);
930 $e->update_action_hold_transit_copy($transit) or return $e->die_event;
932 } elsif($status == 4) { # on holds shelf
934 return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_HOLDS_SHELF', $orig_hold->pickup_lib);
935 return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_HOLDS_SHELF', $hold->pickup_lib);
937 $logger->info("updating pickup lib for hold ".$hold->id." while on holds shelf");
939 # create the new transit
940 my $evt = transit_hold($e, $orig_hold, $hold, $e->retrieve_asset_copy($hold->current_copy));
945 update_hold_if_frozen($self, $e, $hold, $orig_hold);
946 $e->update_action_hold_request($hold) or return $e->die_event;
949 # a change to mint-condition changes the set of potential copies, so retarget the hold;
950 if($U->is_true($hold->mint_condition) and !$U->is_true($orig_hold->mint_condition)) {
951 _reset_hold($self, $e->requestor, $hold)
958 my($e, $orig_hold, $hold, $copy) = @_;
959 my $src = $orig_hold->pickup_lib;
960 my $dest = $hold->pickup_lib;
962 $logger->info("putting hold into transit on pickup_lib update");
964 my $transit = Fieldmapper::action::hold_transit_copy->new;
965 $transit->hold($hold->id);
966 $transit->source($src);
967 $transit->dest($dest);
968 $transit->target_copy($copy->id);
969 $transit->source_send_time('now');
970 $transit->copy_status(OILS_COPY_STATUS_ON_HOLDS_SHELF);
972 $copy->status(OILS_COPY_STATUS_IN_TRANSIT);
973 $copy->editor($e->requestor->id);
974 $copy->edit_date('now');
976 $e->create_action_hold_transit_copy($transit) or return $e->die_event;
977 $e->update_asset_copy($copy) or return $e->die_event;
981 # if the hold is frozen, this method ensures that the hold is not "targeted",
982 # that is, it clears the current_copy and prev_check_time to essentiallly
983 # reset the hold. If it is being activated, it runs the targeter in the background
984 sub update_hold_if_frozen {
985 my($self, $e, $hold, $orig_hold) = @_;
986 return if $hold->capture_time;
988 if($U->is_true($hold->frozen)) {
989 $logger->info("clearing current_copy and check_time for frozen hold ".$hold->id);
990 $hold->clear_current_copy;
991 $hold->clear_prev_check_time;
994 if($U->is_true($orig_hold->frozen)) {
995 $logger->info("Running targeter on activated hold ".$hold->id);
996 $U->storagereq( 'open-ils.storage.action.hold_request.copy_targeter', undef, $hold->id );
1001 __PACKAGE__->register_method(
1002 method => "hold_note_CUD",
1003 api_name => "open-ils.circ.hold_request.note.cud",
1005 desc => 'Create, update or delete a hold request note. If the operator (from Auth. token) '
1006 . 'is not the owner of the hold, the UPDATE_HOLD permission is required',
1008 { desc => 'Authentication token', type => 'string' },
1009 { desc => 'Hold note object', type => 'object' }
1012 desc => 'Returns the note ID, event on error'
1018 my($self, $conn, $auth, $note) = @_;
1020 my $e = new_editor(authtoken => $auth, xact => 1);
1021 return $e->die_event unless $e->checkauth;
1023 my $hold = $e->retrieve_action_hold_request($note->hold)
1024 or return $e->die_event;
1026 if($hold->usr ne $e->requestor->id) {
1027 my $usr = $e->retrieve_actor_user($hold->usr);
1028 return $e->die_event unless $e->allowed('UPDATE_HOLD', $usr->home_ou);
1029 $note->staff('t') if $note->isnew;
1033 $e->create_action_hold_request_note($note) or return $e->die_event;
1034 } elsif($note->ischanged) {
1035 $e->update_action_hold_request_note($note) or return $e->die_event;
1036 } elsif($note->isdeleted) {
1037 $e->delete_action_hold_request_note($note) or return $e->die_event;
1045 __PACKAGE__->register_method(
1046 method => "retrieve_hold_status",
1047 api_name => "open-ils.circ.hold.status.retrieve",
1049 desc => 'Calculates the current status of the hold. The requestor must have ' .
1050 'VIEW_HOLD permissions if the hold is for a user other than the requestor' ,
1052 { desc => 'Hold ID', type => 'number' }
1055 # type => 'number', # event sometimes
1056 desc => <<'END_OF_DESC'
1057 Returns event on error or:
1058 -1 on error (for now),
1059 1 for 'waiting for copy to become available',
1060 2 for 'waiting for copy capture',
1063 5 for 'hold-shelf-delay'
1070 sub retrieve_hold_status {
1071 my($self, $client, $auth, $hold_id) = @_;
1073 my $e = new_editor(authtoken => $auth);
1074 return $e->event unless $e->checkauth;
1075 my $hold = $e->retrieve_action_hold_request($hold_id)
1076 or return $e->event;
1078 if( $e->requestor->id != $hold->usr ) {
1079 return $e->event unless $e->allowed('VIEW_HOLD');
1082 return _hold_status($e, $hold);
1088 if ($hold->cancel_time) {
1091 return 1 unless $hold->current_copy;
1092 return 2 unless $hold->capture_time;
1094 my $copy = $hold->current_copy;
1095 unless( ref $copy ) {
1096 $copy = $e->retrieve_asset_copy($hold->current_copy)
1097 or return $e->event;
1100 return 3 if $copy->status == OILS_COPY_STATUS_IN_TRANSIT;
1102 if($copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF) {
1104 my $hs_wait_interval = $U->ou_ancestor_setting_value($hold->pickup_lib, 'circ.hold_shelf_status_delay');
1105 return 4 unless $hs_wait_interval;
1107 # if a hold_shelf_status_delay interval is defined and start_time plus
1108 # the interval is greater than now, consider the hold to be in the virtual
1109 # "on its way to the holds shelf" status. Return 5.
1111 my $transit = $e->search_action_hold_transit_copy({hold => $hold->id})->[0];
1112 my $start_time = ($transit) ? $transit->dest_recv_time : $hold->capture_time;
1113 $start_time = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($start_time));
1114 my $end_time = $start_time->add(seconds => OpenSRF::Utils::interval_to_seconds($hs_wait_interval));
1116 return 5 if $end_time > DateTime->now;
1125 __PACKAGE__->register_method(
1126 method => "retrieve_hold_queue_stats",
1127 api_name => "open-ils.circ.hold.queue_stats.retrieve",
1129 desc => 'Returns summary data about the state of a hold',
1131 { desc => 'Authentication token', type => 'string'},
1132 { desc => 'Hold ID', type => 'number'},
1135 desc => q/Summary object with keys:
1136 total_holds : total holds in queue
1137 queue_position : current queue position
1138 potential_copies : number of potential copies for this hold
1139 estimated_wait : estimated wait time in days
1140 status : hold status
1141 -1 => error or unexpected state,
1142 1 => 'waiting for copy to become available',
1143 2 => 'waiting for copy capture',
1146 5 => 'hold-shelf-delay'
1153 sub retrieve_hold_queue_stats {
1154 my($self, $conn, $auth, $hold_id) = @_;
1155 my $e = new_editor(authtoken => $auth);
1156 return $e->event unless $e->checkauth;
1157 my $hold = $e->retrieve_action_hold_request($hold_id) or return $e->event;
1158 if($e->requestor->id != $hold->usr) {
1159 return $e->event unless $e->allowed('VIEW_HOLD');
1161 return retrieve_hold_queue_status_impl($e, $hold);
1164 sub retrieve_hold_queue_status_impl {
1168 # The holds queue is defined as the distinct set of holds that share at
1169 # least one potential copy with the context hold, plus any holds that
1170 # share the same hold type and target. The latter part exists to
1171 # accomodate holds that currently have no potential copies
1172 my $q_holds = $e->json_query({
1174 # fetch cut_in_line and request_time since they're in the order_by
1175 # and we're asking for distinct values
1176 select => {ahr => ['id', 'cut_in_line', 'request_time']},
1183 'field' => 'target_copy',
1184 'fkey' => 'target_copy'
1193 "field" => "cut_in_line",
1194 "transform" => "coalesce",
1196 "direction" => "desc"
1198 { "class" => "ahr", "field" => "request_time" }
1202 '+ahcm2' => { hold => $hold->id }
1206 if (!@$q_holds) { # none? maybe we don't have a map ...
1207 $q_holds = $e->json_query({
1208 select => {ahr => ['id', 'cut_in_line', 'request_time']},
1213 "field" => "cut_in_line",
1214 "transform" => "coalesce",
1216 "direction" => "desc"
1218 { "class" => "ahr", "field" => "request_time" }
1221 hold_type => $hold->hold_type,
1222 target => $hold->target
1229 for my $h (@$q_holds) {
1230 last if $h->{id} == $hold->id;
1234 my $hold_data = $e->json_query({
1236 acp => [ {column => 'id', transform => 'count', aggregate => 1, alias => 'count'} ],
1237 ccm => [ {column =>'avg_wait_time'} ]
1243 ccm => {type => 'left'}
1248 where => {'+ahcm' => {hold => $hold->id} }
1251 my $user_org = $e->json_query({select => {au => ['home_ou']}, from => 'au', where => {id => $hold->usr}})->[0]->{home_ou};
1253 my $default_wait = $U->ou_ancestor_setting_value($user_org, OILS_SETTING_HOLD_ESIMATE_WAIT_INTERVAL);
1254 my $min_wait = $U->ou_ancestor_setting_value($user_org, 'circ.holds.min_estimated_wait_interval');
1255 $min_wait = OpenSRF::Utils::interval_to_seconds($min_wait || '0 seconds');
1256 $default_wait ||= '0 seconds';
1258 # Estimated wait time is the average wait time across the set
1259 # of potential copies, divided by the number of potential copies
1260 # times the queue position.
1262 my $combined_secs = 0;
1263 my $num_potentials = 0;
1265 for my $wait_data (@$hold_data) {
1266 my $count += $wait_data->{count};
1267 $combined_secs += $count *
1268 OpenSRF::Utils::interval_to_seconds($wait_data->{avg_wait_time} || $default_wait);
1269 $num_potentials += $count;
1272 my $estimated_wait = -1;
1274 if($num_potentials) {
1275 my $avg_wait = $combined_secs / $num_potentials;
1276 $estimated_wait = $qpos * ($avg_wait / $num_potentials);
1277 $estimated_wait = $min_wait if $estimated_wait < $min_wait and $estimated_wait != -1;
1281 total_holds => scalar(@$q_holds),
1282 queue_position => $qpos,
1283 potential_copies => $num_potentials,
1284 status => _hold_status( $e, $hold ),
1285 estimated_wait => int($estimated_wait)
1290 sub fetch_open_hold_by_current_copy {
1293 my $hold = $apputils->simplereq(
1295 'open-ils.cstore.direct.action.hold_request.search.atomic',
1296 { current_copy => $copyid , cancel_time => undef, fulfillment_time => undef });
1297 return $hold->[0] if ref($hold);
1301 sub fetch_related_holds {
1304 return $apputils->simplereq(
1306 'open-ils.cstore.direct.action.hold_request.search.atomic',
1307 { current_copy => $copyid , cancel_time => undef, fulfillment_time => undef });
1311 __PACKAGE__->register_method(
1312 method => "hold_pull_list",
1313 api_name => "open-ils.circ.hold_pull_list.retrieve",
1315 desc => 'Returns (reference to) a list of holds that need to be "pulled" by a given location. ' .
1316 'The location is determined by the login session.',
1318 { desc => 'Limit (optional)', type => 'number'},
1319 { desc => 'Offset (optional)', type => 'number'},
1322 desc => 'reference to a list of holds, or event on failure',
1327 __PACKAGE__->register_method(
1328 method => "hold_pull_list",
1329 api_name => "open-ils.circ.hold_pull_list.id_list.retrieve",
1331 desc => 'Returns (reference to) a list of holds IDs that need to be "pulled" by a given location. ' .
1332 'The location is determined by the login session.',
1334 { desc => 'Limit (optional)', type => 'number'},
1335 { desc => 'Offset (optional)', type => 'number'},
1338 desc => 'reference to a list of holds, or event on failure',
1343 __PACKAGE__->register_method(
1344 method => "hold_pull_list",
1345 api_name => "open-ils.circ.hold_pull_list.retrieve.count",
1347 desc => 'Returns a count of holds that need to be "pulled" by a given location. ' .
1348 'The location is determined by the login session.',
1350 { desc => 'Limit (optional)', type => 'number'},
1351 { desc => 'Offset (optional)', type => 'number'},
1354 desc => 'Holds count (integer), or event on failure',
1361 sub hold_pull_list {
1362 my( $self, $conn, $authtoken, $limit, $offset ) = @_;
1363 my( $reqr, $evt ) = $U->checkses($authtoken);
1364 return $evt if $evt;
1366 my $org = $reqr->ws_ou || $reqr->home_ou;
1367 # the perm locaiton shouldn't really matter here since holds
1368 # will exist all over and VIEW_HOLDS should be universal
1369 $evt = $U->check_perms($reqr->id, $org, 'VIEW_HOLD');
1370 return $evt if $evt;
1372 if($self->api_name =~ /count/) {
1374 my $count = $U->storagereq(
1375 'open-ils.storage.direct.action.hold_request.pull_list.current_copy_circ_lib.status_filtered.count',
1376 $org, $limit, $offset );
1378 $logger->info("Grabbing pull list for org unit $org with $count items");
1381 } elsif( $self->api_name =~ /id_list/ ) {
1382 return $U->storagereq(
1383 'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib.status_filtered.atomic',
1384 $org, $limit, $offset );
1387 return $U->storagereq(
1388 'open-ils.storage.direct.action.hold_request.pull_list.search.current_copy_circ_lib.status_filtered.atomic',
1389 $org, $limit, $offset );
1393 __PACKAGE__->register_method(
1394 method => "print_hold_pull_list",
1395 api_name => "open-ils.circ.hold_pull_list.print",
1397 desc => 'Returns an HTML-formatted holds pull list',
1399 { desc => 'Authtoken', type => 'string'},
1400 { desc => 'Org unit ID. Optional, defaults to workstation org unit', type => 'number'},
1403 desc => 'HTML string',
1409 sub print_hold_pull_list {
1410 my($self, $client, $auth, $org_id) = @_;
1412 my $e = new_editor(authtoken=>$auth);
1413 return $e->event unless $e->checkauth;
1415 $org_id = (defined $org_id) ? $org_id : $e->requestor->ws_ou;
1416 return $e->event unless $e->allowed('VIEW_HOLD', $org_id);
1418 my $hold_ids = $U->storagereq(
1419 'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib.status_filtered.atomic',
1422 return undef unless @$hold_ids;
1424 $client->status(new OpenSRF::DomainObject::oilsContinueStatus);
1426 # Holds will /NOT/ be in order after this ...
1427 my $holds = $e->search_action_hold_request({id => $hold_ids}, {substream => 1});
1428 $client->status(new OpenSRF::DomainObject::oilsContinueStatus);
1430 # ... so we must resort.
1431 my $hold_map = +{map { $_->id => $_ } @$holds};
1432 my $sorted_holds = [];
1433 push @$sorted_holds, $hold_map->{$_} foreach @$hold_ids;
1435 return $U->fire_object_event(
1436 undef, "ahr.format.pull_list", $sorted_holds,
1437 $org_id, undef, undef, $client
1442 __PACKAGE__->register_method(
1443 method => "print_hold_pull_list_stream",
1445 api_name => "open-ils.circ.hold_pull_list.print.stream",
1447 desc => 'Returns a stream of fleshed holds',
1449 { desc => 'Authtoken', type => 'string'},
1450 { 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)',
1455 desc => 'A stream of fleshed holds',
1461 sub print_hold_pull_list_stream {
1462 my($self, $client, $auth, $params) = @_;
1464 my $e = new_editor(authtoken=>$auth);
1465 return $e->die_event unless $e->checkauth;
1467 delete($$params{org_id}) unless (int($$params{org_id}));
1468 delete($$params{limit}) unless (int($$params{limit}));
1469 delete($$params{offset}) unless (int($$params{offset}));
1470 delete($$params{chunk_size}) unless (int($$params{chunk_size}));
1471 delete($$params{chunk_size}) if ($$params{chunk_size} && $$params{chunk_size} > 50); # keep the size reasonable
1472 $$params{chunk_size} ||= 10;
1474 $$params{org_id} = (defined $$params{org_id}) ? $$params{org_id}: $e->requestor->ws_ou;
1475 return $e->die_event unless $e->allowed('VIEW_HOLD', $$params{org_id });
1478 if ($$params{sort} && @{ $$params{sort} }) {
1479 for my $s (@{ $$params{sort} }) {
1480 if ($s eq 'acplo.position') {
1482 "class" => "acplo", "field" => "position",
1483 "transform" => "coalesce", "params" => [999]
1485 } elsif ($s eq 'prefix') {
1486 push @$sort, {"class" => "acnp", "field" => "label_sortkey"};
1487 } elsif ($s eq 'call_number') {
1488 push @$sort, {"class" => "acn", "field" => "label_sortkey"};
1489 } elsif ($s eq 'suffix') {
1490 push @$sort, {"class" => "acns", "field" => "label_sortkey"};
1491 } elsif ($s eq 'request_time') {
1492 push @$sort, {"class" => "ahr", "field" => "request_time"};
1496 push @$sort, {"class" => "ahr", "field" => "request_time"};
1499 my $holds_ids = $e->json_query(
1501 "select" => {"ahr" => ["id"]},
1506 "fkey" => "current_copy",
1508 "circ_lib" => $$params{org_id}, "status" => [0,7]
1513 "fkey" => "call_number",
1527 "fkey" => "circ_lib",
1530 "location" => {"=" => {"+acp" => "location"}}
1539 "capture_time" => undef,
1540 "cancel_time" => undef,
1542 {"expire_time" => undef },
1543 {"expire_time" => {">" => "now"}}
1547 (@$sort ? (order_by => $sort) : ()),
1548 ($$params{limit} ? (limit => $$params{limit}) : ()),
1549 ($$params{offset} ? (offset => $$params{offset}) : ())
1550 }, {"substream" => 1}
1551 ) or return $e->die_event;
1553 $logger->info("about to stream back " . scalar(@$holds_ids) . " holds");
1556 for my $hid (@$holds_ids) {
1557 push @chunk, $e->retrieve_action_hold_request([
1561 "ahr" => ["usr", "current_copy"],
1563 "acp" => ["location", "call_number", "parts"],
1564 "acn" => ["record","prefix","suffix"]
1569 if (@chunk >= $$params{chunk_size}) {
1570 $client->respond( \@chunk );
1574 $client->respond_complete( \@chunk ) if (@chunk);
1581 __PACKAGE__->register_method(
1582 method => 'fetch_hold_notify',
1583 api_name => 'open-ils.circ.hold_notification.retrieve_by_hold',
1586 Returns a list of hold notification objects based on hold id.
1587 @param authtoken The loggin session key
1588 @param holdid The id of the hold whose notifications we want to retrieve
1589 @return An array of hold notification objects, event on error.
1593 sub fetch_hold_notify {
1594 my( $self, $conn, $authtoken, $holdid ) = @_;
1595 my( $requestor, $evt ) = $U->checkses($authtoken);
1596 return $evt if $evt;
1597 my ($hold, $patron);
1598 ($hold, $evt) = $U->fetch_hold($holdid);
1599 return $evt if $evt;
1600 ($patron, $evt) = $U->fetch_user($hold->usr);
1601 return $evt if $evt;
1603 $evt = $U->check_perms($requestor->id, $patron->home_ou, 'VIEW_HOLD_NOTIFICATION');
1604 return $evt if $evt;
1606 $logger->info("User ".$requestor->id." fetching hold notifications for hold $holdid");
1607 return $U->cstorereq(
1608 'open-ils.cstore.direct.action.hold_notification.search.atomic', {hold => $holdid} );
1612 __PACKAGE__->register_method(
1613 method => 'create_hold_notify',
1614 api_name => 'open-ils.circ.hold_notification.create',
1616 Creates a new hold notification object
1617 @param authtoken The login session key
1618 @param notification The hold notification object to create
1619 @return ID of the new object on success, Event on error
1623 sub create_hold_notify {
1624 my( $self, $conn, $auth, $note ) = @_;
1625 my $e = new_editor(authtoken=>$auth, xact=>1);
1626 return $e->die_event unless $e->checkauth;
1628 my $hold = $e->retrieve_action_hold_request($note->hold)
1629 or return $e->die_event;
1630 my $patron = $e->retrieve_actor_user($hold->usr)
1631 or return $e->die_event;
1633 return $e->die_event unless
1634 $e->allowed('CREATE_HOLD_NOTIFICATION', $patron->home_ou);
1636 $note->notify_staff($e->requestor->id);
1637 $e->create_action_hold_notification($note) or return $e->die_event;
1642 __PACKAGE__->register_method(
1643 method => 'create_hold_note',
1644 api_name => 'open-ils.circ.hold_note.create',
1646 Creates a new hold request note object
1647 @param authtoken The login session key
1648 @param note The hold note object to create
1649 @return ID of the new object on success, Event on error
1653 sub create_hold_note {
1654 my( $self, $conn, $auth, $note ) = @_;
1655 my $e = new_editor(authtoken=>$auth, xact=>1);
1656 return $e->die_event unless $e->checkauth;
1658 my $hold = $e->retrieve_action_hold_request($note->hold)
1659 or return $e->die_event;
1660 my $patron = $e->retrieve_actor_user($hold->usr)
1661 or return $e->die_event;
1663 return $e->die_event unless
1664 $e->allowed('UPDATE_HOLD', $patron->home_ou); # FIXME: Using permcrud perm listed in fm_IDL.xml for ahrn. Probably want something more specific
1666 $e->create_action_hold_request_note($note) or return $e->die_event;
1671 __PACKAGE__->register_method(
1672 method => 'reset_hold',
1673 api_name => 'open-ils.circ.hold.reset',
1675 Un-captures and un-targets a hold, essentially returning
1676 it to the state it was in directly after it was placed,
1677 then attempts to re-target the hold
1678 @param authtoken The login session key
1679 @param holdid The id of the hold
1685 my( $self, $conn, $auth, $holdid ) = @_;
1687 my ($hold, $evt) = $U->fetch_hold($holdid);
1688 return $evt if $evt;
1689 ($reqr, $evt) = $U->checksesperm($auth, 'UPDATE_HOLD');
1690 return $evt if $evt;
1691 $evt = _reset_hold($self, $reqr, $hold);
1692 return $evt if $evt;
1697 __PACKAGE__->register_method(
1698 method => 'reset_hold_batch',
1699 api_name => 'open-ils.circ.hold.reset.batch'
1702 sub reset_hold_batch {
1703 my($self, $conn, $auth, $hold_ids) = @_;
1705 my $e = new_editor(authtoken => $auth);
1706 return $e->event unless $e->checkauth;
1708 for my $hold_id ($hold_ids) {
1710 my $hold = $e->retrieve_action_hold_request(
1711 [$hold_id, {flesh => 1, flesh_fields => {ahr => ['usr']}}])
1712 or return $e->event;
1714 next unless $e->allowed('UPDATE_HOLD', $hold->usr->home_ou);
1715 _reset_hold($self, $e->requestor, $hold);
1723 my ($self, $reqr, $hold) = @_;
1725 my $e = new_editor(xact =>1, requestor => $reqr);
1727 $logger->info("reseting hold ".$hold->id);
1729 my $hid = $hold->id;
1731 if( $hold->capture_time and $hold->current_copy ) {
1733 my $copy = $e->retrieve_asset_copy($hold->current_copy)
1734 or return $e->die_event;
1736 if( $copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF ) {
1737 $logger->info("setting copy to status 'reshelving' on hold retarget");
1738 $copy->status(OILS_COPY_STATUS_RESHELVING);
1739 $copy->editor($e->requestor->id);
1740 $copy->edit_date('now');
1741 $e->update_asset_copy($copy) or return $e->die_event;
1743 } elsif( $copy->status == OILS_COPY_STATUS_IN_TRANSIT ) {
1745 # We don't want the copy to remain "in transit"
1746 $copy->status(OILS_COPY_STATUS_RESHELVING);
1747 $logger->warn("! reseting hold [$hid] that is in transit");
1748 my $transid = $e->search_action_hold_transit_copy({hold=>$hold->id},{idlist=>1})->[0];
1751 my $trans = $e->retrieve_action_transit_copy($transid);
1753 $logger->info("Aborting transit [$transid] on hold [$hid] reset...");
1754 my $evt = OpenILS::Application::Circ::Transit::__abort_transit($e, $trans, $copy, 1);
1755 $logger->info("Transit abort completed with result $evt");
1756 unless ("$evt" eq 1) {
1765 $hold->clear_capture_time;
1766 $hold->clear_current_copy;
1767 $hold->clear_shelf_time;
1768 $hold->clear_shelf_expire_time;
1770 $e->update_action_hold_request($hold) or return $e->die_event;
1774 'open-ils.storage.action.hold_request.copy_targeter', undef, $hold->id );
1780 __PACKAGE__->register_method(
1781 method => 'fetch_open_title_holds',
1782 api_name => 'open-ils.circ.open_holds.retrieve',
1784 Returns a list ids of un-fulfilled holds for a given title id
1785 @param authtoken The login session key
1786 @param id the id of the item whose holds we want to retrieve
1787 @param type The hold type - M, T, I, V, C, F, R
1791 sub fetch_open_title_holds {
1792 my( $self, $conn, $auth, $id, $type, $org ) = @_;
1793 my $e = new_editor( authtoken => $auth );
1794 return $e->event unless $e->checkauth;
1797 $org ||= $e->requestor->ws_ou;
1799 # return $e->search_action_hold_request(
1800 # { target => $id, hold_type => $type, fulfillment_time => undef }, {idlist=>1});
1802 # XXX make me return IDs in the future ^--
1803 my $holds = $e->search_action_hold_request(
1806 cancel_time => undef,
1808 fulfillment_time => undef
1812 flesh_hold_transits($holds);
1817 sub flesh_hold_transits {
1819 for my $hold ( @$holds ) {
1821 $apputils->simplereq(
1823 "open-ils.cstore.direct.action.hold_transit_copy.search.atomic",
1824 { hold => $hold->id },
1825 { order_by => { ahtc => 'id desc' }, limit => 1 }
1831 sub flesh_hold_notices {
1832 my( $holds, $e ) = @_;
1833 $e ||= new_editor();
1835 for my $hold (@$holds) {
1836 my $notices = $e->search_action_hold_notification(
1838 { hold => $hold->id },
1839 { order_by => { anh => 'notify_time desc' } },
1844 $hold->notify_count(scalar(@$notices));
1846 my $n = $e->retrieve_action_hold_notification($$notices[0])
1847 or return $e->event;
1848 $hold->notify_time($n->notify_time);
1854 __PACKAGE__->register_method(
1855 method => 'fetch_captured_holds',
1856 api_name => 'open-ils.circ.captured_holds.on_shelf.retrieve',
1859 Returns a list of un-fulfilled holds (on the Holds Shelf) for a given title id
1860 @param authtoken The login session key
1861 @param org The org id of the location in question
1865 __PACKAGE__->register_method(
1866 method => 'fetch_captured_holds',
1867 api_name => 'open-ils.circ.captured_holds.id_list.on_shelf.retrieve',
1870 Returns list ids of un-fulfilled holds (on the Holds Shelf) for a given title id
1871 @param authtoken The login session key
1872 @param org The org id of the location in question
1876 __PACKAGE__->register_method(
1877 method => 'fetch_captured_holds',
1878 api_name => 'open-ils.circ.captured_holds.id_list.expired_on_shelf.retrieve',
1881 Returns list ids of shelf-expired un-fulfilled holds for a given title id
1882 @param authtoken The login session key
1883 @param org The org id of the location in question
1888 sub fetch_captured_holds {
1889 my( $self, $conn, $auth, $org ) = @_;
1891 my $e = new_editor(authtoken => $auth);
1892 return $e->die_event unless $e->checkauth;
1893 return $e->die_event unless $e->allowed('VIEW_HOLD'); # XXX rely on editor perm
1895 $org ||= $e->requestor->ws_ou;
1898 select => { ahr => ['id'] },
1903 fkey => 'current_copy'
1908 '+acp' => { status => OILS_COPY_STATUS_ON_HOLDS_SHELF },
1910 capture_time => { "!=" => undef },
1911 current_copy => { "!=" => undef },
1912 fulfillment_time => undef,
1914 cancel_time => undef,
1918 if($self->api_name =~ /expired/) {
1919 $query->{'where'}->{'+ahr'}->{'shelf_expire_time'} = {'<' => 'now'};
1920 $query->{'where'}->{'+ahr'}->{'shelf_time'} = {'!=' => undef};
1922 my $hold_ids = $e->json_query( $query );
1924 for my $hold_id (@$hold_ids) {
1925 if($self->api_name =~ /id_list/) {
1926 $conn->respond($hold_id->{id});
1930 $e->retrieve_action_hold_request([
1934 flesh_fields => {ahr => ['notifications', 'transit', 'notes']},
1935 order_by => {anh => 'notify_time desc'}
1945 __PACKAGE__->register_method(
1946 method => "print_expired_holds_stream",
1947 api_name => "open-ils.circ.captured_holds.expired.print.stream",
1951 sub print_expired_holds_stream {
1952 my ($self, $client, $auth, $params) = @_;
1954 # No need to check specific permissions: we're going to call another method
1955 # that will do that.
1956 my $e = new_editor("authtoken" => $auth);
1957 return $e->die_event unless $e->checkauth;
1959 delete($$params{org_id}) unless (int($$params{org_id}));
1960 delete($$params{limit}) unless (int($$params{limit}));
1961 delete($$params{offset}) unless (int($$params{offset}));
1962 delete($$params{chunk_size}) unless (int($$params{chunk_size}));
1963 delete($$params{chunk_size}) if ($$params{chunk_size} && $$params{chunk_size} > 50); # keep the size reasonable
1964 $$params{chunk_size} ||= 10;
1966 $$params{org_id} = (defined $$params{org_id}) ? $$params{org_id}: $e->requestor->ws_ou;
1968 my @hold_ids = $self->method_lookup(
1969 "open-ils.circ.captured_holds.id_list.expired_on_shelf.retrieve"
1970 )->run($auth, $params->{"org_id"});
1975 } elsif (defined $U->event_code($hold_ids[0])) {
1977 return $hold_ids[0];
1980 $logger->info("about to stream back up to " . scalar(@hold_ids) . " expired holds");
1983 my @hid_chunk = splice @hold_ids, 0, $params->{"chunk_size"};
1985 my $result_chunk = $e->json_query({
1987 "acp" => ["barcode"],
1989 first_given_name second_given_name family_name alias
1998 "field" => "id", "fkey" => "current_copy",
2001 "field" => "id", "fkey" => "call_number",
2004 "field" => "id", "fkey" => "record"
2008 "acpl" => {"field" => "id", "fkey" => "location"}
2011 "au" => {"field" => "id", "fkey" => "usr"}
2014 "where" => {"+ahr" => {"id" => \@hid_chunk}}
2015 }) or return $e->die_event;
2016 $client->respond($result_chunk);
2023 __PACKAGE__->register_method(
2024 method => "check_title_hold_batch",
2025 api_name => "open-ils.circ.title_hold.is_possible.batch",
2028 desc => '@see open-ils.circ.title_hold.is_possible.batch',
2030 { desc => 'Authentication token', type => 'string'},
2031 { desc => 'Array of Hash of named parameters', type => 'array'},
2034 desc => 'Array of response objects',
2040 sub check_title_hold_batch {
2041 my($self, $client, $authtoken, $param_list) = @_;
2042 foreach (@$param_list) {
2043 my ($res) = $self->method_lookup('open-ils.circ.title_hold.is_possible')->run($authtoken, $_);
2044 $client->respond($res);
2050 __PACKAGE__->register_method(
2051 method => "check_title_hold",
2052 api_name => "open-ils.circ.title_hold.is_possible",
2054 desc => 'Determines if a hold were to be placed by a given user, ' .
2055 'whether or not said hold would have any potential copies to fulfill it.' .
2056 'The named paramaters of the second argument include: ' .
2057 'patronid, titleid, volume_id, copy_id, mrid, depth, pickup_lib, hold_type, selection_ou. ' .
2058 'See perldoc ' . __PACKAGE__ . ' for more info on these fields.' ,
2060 { desc => 'Authentication token', type => 'string'},
2061 { desc => 'Hash of named parameters', type => 'object'},
2064 desc => 'List of new message IDs (empty if none)',
2070 =head3 check_title_hold (token, hash)
2072 The named fields in the hash are:
2074 patronid - ID of the hold recipient (required)
2075 depth - hold range depth (default 0)
2076 pickup_lib - destination for hold, fallback value for selection_ou
2077 selection_ou - ID of org_unit establishing hard and soft hold boundary settings
2078 issuanceid - ID of the issuance to be held, required for Issuance level hold
2079 partid - ID of the monograph part to be held, required for monograph part level hold
2080 titleid - ID (BRN) of the title to be held, required for Title level hold
2081 volume_id - required for Volume level hold
2082 copy_id - required for Copy level hold
2083 mrid - required for Meta-record level hold
2084 hold_type - T, C (or R or F), I, V or M for Title, Copy, Issuance, Volume or Meta-record (default "T")
2086 All key/value pairs are passed on to do_possibility_checks.
2090 # FIXME: better params checking. what other params are required, if any?
2091 # FIXME: 3 copies of values confusing: $x, $params->{x} and $params{x}
2092 # FIXME: for example, $depth gets a default value, but then $$params{depth} is still
2093 # used in conditionals, where it may be undefined, causing a warning.
2094 # FIXME: specify proper usage/interaction of selection_ou and pickup_lib
2096 sub check_title_hold {
2097 my( $self, $client, $authtoken, $params ) = @_;
2098 my $e = new_editor(authtoken=>$authtoken);
2099 return $e->event unless $e->checkauth;
2101 my %params = %$params;
2102 my $depth = $params{depth} || 0;
2103 my $selection_ou = $params{selection_ou} || $params{pickup_lib};
2105 my $patron = $e->retrieve_actor_user($params{patronid})
2106 or return $e->event;
2108 if( $e->requestor->id ne $patron->id ) {
2109 return $e->event unless
2110 $e->allowed('VIEW_HOLD_PERMIT', $patron->home_ou);
2113 return OpenILS::Event->new('PATRON_BARRED') if $U->is_true($patron->barred);
2115 my $request_lib = $e->retrieve_actor_org_unit($e->requestor->ws_ou)
2116 or return $e->event;
2118 my $soft_boundary = $U->ou_ancestor_setting_value($selection_ou, OILS_SETTING_HOLD_SOFT_BOUNDARY);
2119 my $hard_boundary = $U->ou_ancestor_setting_value($selection_ou, OILS_SETTING_HOLD_HARD_BOUNDARY);
2122 my $return_depth = $hard_boundary; # default depth to return on success
2123 if(defined $soft_boundary and $depth < $soft_boundary) {
2124 # work up the tree and as soon as we find a potential copy, use that depth
2125 # also, make sure we don't go past the hard boundary if it exists
2127 # our min boundary is the greater of user-specified boundary or hard boundary
2128 my $min_depth = (defined $hard_boundary and $hard_boundary > $depth) ?
2129 $hard_boundary : $depth;
2131 my $depth = $soft_boundary;
2132 while($depth >= $min_depth) {
2133 $logger->info("performing hold possibility check with soft boundary $depth");
2134 @status = do_possibility_checks($e, $patron, $request_lib, $depth, %params);
2136 $return_depth = $depth;
2141 } elsif(defined $hard_boundary and $depth < $hard_boundary) {
2142 # there is no soft boundary, enforce the hard boundary if it exists
2143 $logger->info("performing hold possibility check with hard boundary $hard_boundary");
2144 @status = do_possibility_checks($e, $patron, $request_lib, $hard_boundary, %params);
2146 # no boundaries defined, fall back to user specifed boundary or no boundary
2147 $logger->info("performing hold possibility check with no boundary");
2148 @status = do_possibility_checks($e, $patron, $request_lib, $params{depth}, %params);
2154 "depth" => $return_depth,
2155 "local_avail" => $status[1]
2157 } elsif ($status[2]) {
2158 my $n = scalar @{$status[2]};
2159 return {"success" => 0, "last_event" => $status[2]->[$n - 1]};
2161 return {"success" => 0};
2167 sub do_possibility_checks {
2168 my($e, $patron, $request_lib, $depth, %params) = @_;
2170 my $issuanceid = $params{issuanceid} || "";
2171 my $partid = $params{partid} || "";
2172 my $titleid = $params{titleid} || "";
2173 my $volid = $params{volume_id};
2174 my $copyid = $params{copy_id};
2175 my $mrid = $params{mrid} || "";
2176 my $pickup_lib = $params{pickup_lib};
2177 my $hold_type = $params{hold_type} || 'T';
2178 my $selection_ou = $params{selection_ou} || $pickup_lib;
2185 if( $hold_type eq OILS_HOLD_TYPE_FORCE || $hold_type eq OILS_HOLD_TYPE_RECALL || $hold_type eq OILS_HOLD_TYPE_COPY ) {
2187 return $e->event unless $copy = $e->retrieve_asset_copy($copyid);
2188 return $e->event unless $volume = $e->retrieve_asset_call_number($copy->call_number);
2189 return $e->event unless $title = $e->retrieve_biblio_record_entry($volume->record);
2191 return verify_copy_for_hold(
2192 $patron, $e->requestor, $title, $copy, $pickup_lib, $request_lib
2195 } elsif( $hold_type eq OILS_HOLD_TYPE_VOLUME ) {
2197 return $e->event unless $volume = $e->retrieve_asset_call_number($volid);
2198 return $e->event unless $title = $e->retrieve_biblio_record_entry($volume->record);
2200 return _check_volume_hold_is_possible(
2201 $volume, $title, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou
2204 } elsif( $hold_type eq OILS_HOLD_TYPE_TITLE ) {
2206 return _check_title_hold_is_possible(
2207 $titleid, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou
2210 } elsif( $hold_type eq OILS_HOLD_TYPE_ISSUANCE ) {
2212 return _check_issuance_hold_is_possible(
2213 $issuanceid, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou
2216 } elsif( $hold_type eq OILS_HOLD_TYPE_MONOPART ) {
2218 return _check_monopart_hold_is_possible(
2219 $partid, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou
2222 } elsif( $hold_type eq OILS_HOLD_TYPE_METARECORD ) {
2224 my $maps = $e->search_metabib_metarecord_source_map({metarecord=>$mrid});
2225 my @recs = map { $_->source } @$maps;
2227 for my $rec (@recs) {
2228 @status = _check_title_hold_is_possible(
2229 $rec, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou
2235 # else { Unrecognized hold_type ! } # FIXME: return error? or 0?
2239 sub create_ranged_org_filter {
2240 my($e, $selection_ou, $depth) = @_;
2242 # find the orgs from which this hold may be fulfilled,
2243 # based on the selection_ou and depth
2245 my $top_org = $e->search_actor_org_unit([
2246 {parent_ou => undef},
2247 {flesh=>1, flesh_fields=>{aou=>['ou_type']}}])->[0];
2250 return () if $depth == $top_org->ou_type->depth;
2252 my $org_list = $U->storagereq('open-ils.storage.actor.org_unit.descendants.atomic', $selection_ou, $depth);
2253 %org_filter = (circ_lib => []);
2254 push(@{$org_filter{circ_lib}}, $_->id) for @$org_list;
2256 $logger->info("hold org filter at depth $depth and selection_ou ".
2257 "$selection_ou created list of @{$org_filter{circ_lib}}");
2263 sub _check_title_hold_is_possible {
2264 my( $titleid, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou ) = @_;
2266 my $e = new_editor();
2267 my %org_filter = create_ranged_org_filter($e, $selection_ou, $depth);
2269 # this monster will grab the id and circ_lib of all of the "holdable" copies for the given record
2270 my $copies = $e->json_query(
2272 select => { acp => ['id', 'circ_lib'] },
2277 fkey => 'call_number',
2281 filter => { id => $titleid },
2286 acpl => { field => 'id', filter => { holdable => 't'}, fkey => 'location' },
2287 ccs => { field => 'id', filter => { holdable => 't'}, fkey => 'status' },
2288 acpm => { field => 'target_copy', type => 'left' } # ignore part-linked copies
2292 '+acp' => { circulate => 't', deleted => 'f', holdable => 't', %org_filter },
2293 '+acpm' => { target_copy => undef } # ignore part-linked copies
2298 $logger->info("title possible found ".scalar(@$copies)." potential copies");
2302 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2303 "payload" => {"fail_part" => "no_ultimate_items"}
2308 # -----------------------------------------------------------------------
2309 # sort the copies into buckets based on their circ_lib proximity to
2310 # the patron's home_ou.
2311 # -----------------------------------------------------------------------
2313 my $home_org = $patron->home_ou;
2314 my $req_org = $request_lib->id;
2316 $logger->info("prox cache $home_org " . $prox_cache{$home_org});
2318 $prox_cache{$home_org} =
2319 $e->search_actor_org_unit_proximity({from_org => $home_org})
2320 unless $prox_cache{$home_org};
2321 my $home_prox = $prox_cache{$home_org};
2324 my %hash = map { ($_->to_org => $_->prox) } @$home_prox;
2325 push( @{$buckets{ $hash{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2327 my @keys = sort { $a <=> $b } keys %buckets;
2330 if( $home_org ne $req_org ) {
2331 # -----------------------------------------------------------------------
2332 # shove the copies close to the request_lib into the primary buckets
2333 # directly before the farthest away copies. That way, they are not
2334 # given priority, but they are checked before the farthest copies.
2335 # -----------------------------------------------------------------------
2336 $prox_cache{$req_org} =
2337 $e->search_actor_org_unit_proximity({from_org => $req_org})
2338 unless $prox_cache{$req_org};
2339 my $req_prox = $prox_cache{$req_org};
2342 my %hash2 = map { ($_->to_org => $_->prox) } @$req_prox;
2343 push( @{$buckets2{ $hash2{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2345 my $highest_key = $keys[@keys - 1]; # the farthest prox in the exising buckets
2346 my $new_key = $highest_key - 0.5; # right before the farthest prox
2347 my @keys2 = sort { $a <=> $b } keys %buckets2;
2348 for my $key (@keys2) {
2349 last if $key >= $highest_key;
2350 push( @{$buckets{$new_key}}, $_ ) for @{$buckets2{$key}};
2354 @keys = sort { $a <=> $b } keys %buckets;
2359 OUTER: for my $key (@keys) {
2360 my @cps = @{$buckets{$key}};
2362 $logger->info("looking at " . scalar(@{$buckets{$key}}). " copies in proximity bucket $key");
2364 for my $copyid (@cps) {
2366 next if $seen{$copyid};
2367 $seen{$copyid} = 1; # there could be dupes given the merged buckets
2368 my $copy = $e->retrieve_asset_copy($copyid);
2369 $logger->debug("looking at bucket_key=$key, copy $copyid : circ_lib = " . $copy->circ_lib);
2371 unless($title) { # grab the title if we don't already have it
2372 my $vol = $e->retrieve_asset_call_number(
2373 [ $copy->call_number, { flesh => 1, flesh_fields => { bre => ['fixed_fields'], acn => ['record'] } } ] );
2374 $title = $vol->record;
2377 @status = verify_copy_for_hold(
2378 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib);
2380 last OUTER if $status[0];
2387 sub _check_issuance_hold_is_possible {
2388 my( $issuanceid, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou ) = @_;
2390 my $e = new_editor();
2391 my %org_filter = create_ranged_org_filter($e, $selection_ou, $depth);
2393 # this monster will grab the id and circ_lib of all of the "holdable" copies for the given record
2394 my $copies = $e->json_query(
2396 select => { acp => ['id', 'circ_lib'] },
2402 filter => { issuance => $issuanceid }
2404 acpl => { field => 'id', filter => { holdable => 't'}, fkey => 'location' },
2405 ccs => { field => 'id', filter => { holdable => 't'}, fkey => 'status' }
2409 '+acp' => { circulate => 't', deleted => 'f', holdable => 't', %org_filter }
2415 $logger->info("issuance possible found ".scalar(@$copies)." potential copies");
2419 $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_issuance_ok');
2420 $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2425 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2426 "payload" => {"fail_part" => "no_ultimate_items"}
2434 # -----------------------------------------------------------------------
2435 # sort the copies into buckets based on their circ_lib proximity to
2436 # the patron's home_ou.
2437 # -----------------------------------------------------------------------
2439 my $home_org = $patron->home_ou;
2440 my $req_org = $request_lib->id;
2442 $logger->info("prox cache $home_org " . $prox_cache{$home_org});
2444 $prox_cache{$home_org} =
2445 $e->search_actor_org_unit_proximity({from_org => $home_org})
2446 unless $prox_cache{$home_org};
2447 my $home_prox = $prox_cache{$home_org};
2450 my %hash = map { ($_->to_org => $_->prox) } @$home_prox;
2451 push( @{$buckets{ $hash{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2453 my @keys = sort { $a <=> $b } keys %buckets;
2456 if( $home_org ne $req_org ) {
2457 # -----------------------------------------------------------------------
2458 # shove the copies close to the request_lib into the primary buckets
2459 # directly before the farthest away copies. That way, they are not
2460 # given priority, but they are checked before the farthest copies.
2461 # -----------------------------------------------------------------------
2462 $prox_cache{$req_org} =
2463 $e->search_actor_org_unit_proximity({from_org => $req_org})
2464 unless $prox_cache{$req_org};
2465 my $req_prox = $prox_cache{$req_org};
2468 my %hash2 = map { ($_->to_org => $_->prox) } @$req_prox;
2469 push( @{$buckets2{ $hash2{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2471 my $highest_key = $keys[@keys - 1]; # the farthest prox in the exising buckets
2472 my $new_key = $highest_key - 0.5; # right before the farthest prox
2473 my @keys2 = sort { $a <=> $b } keys %buckets2;
2474 for my $key (@keys2) {
2475 last if $key >= $highest_key;
2476 push( @{$buckets{$new_key}}, $_ ) for @{$buckets2{$key}};
2480 @keys = sort { $a <=> $b } keys %buckets;
2485 OUTER: for my $key (@keys) {
2486 my @cps = @{$buckets{$key}};
2488 $logger->info("looking at " . scalar(@{$buckets{$key}}). " copies in proximity bucket $key");
2490 for my $copyid (@cps) {
2492 next if $seen{$copyid};
2493 $seen{$copyid} = 1; # there could be dupes given the merged buckets
2494 my $copy = $e->retrieve_asset_copy($copyid);
2495 $logger->debug("looking at bucket_key=$key, copy $copyid : circ_lib = " . $copy->circ_lib);
2497 unless($title) { # grab the title if we don't already have it
2498 my $vol = $e->retrieve_asset_call_number(
2499 [ $copy->call_number, { flesh => 1, flesh_fields => { bre => ['fixed_fields'], acn => ['record'] } } ] );
2500 $title = $vol->record;
2503 @status = verify_copy_for_hold(
2504 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib);
2506 last OUTER if $status[0];
2511 if (!defined($empty_ok)) {
2512 $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_issuance_ok');
2513 $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2516 return (1,0) if ($empty_ok);
2521 sub _check_monopart_hold_is_possible {
2522 my( $partid, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou ) = @_;
2524 my $e = new_editor();
2525 my %org_filter = create_ranged_org_filter($e, $selection_ou, $depth);
2527 # this monster will grab the id and circ_lib of all of the "holdable" copies for the given record
2528 my $copies = $e->json_query(
2530 select => { acp => ['id', 'circ_lib'] },
2534 field => 'target_copy',
2536 filter => { part => $partid }
2538 acpl => { field => 'id', filter => { holdable => 't'}, fkey => 'location' },
2539 ccs => { field => 'id', filter => { holdable => 't'}, fkey => 'status' }
2543 '+acp' => { circulate => 't', deleted => 'f', holdable => 't', %org_filter }
2549 $logger->info("monopart possible found ".scalar(@$copies)." potential copies");
2553 $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_part_ok');
2554 $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2559 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2560 "payload" => {"fail_part" => "no_ultimate_items"}
2568 # -----------------------------------------------------------------------
2569 # sort the copies into buckets based on their circ_lib proximity to
2570 # the patron's home_ou.
2571 # -----------------------------------------------------------------------
2573 my $home_org = $patron->home_ou;
2574 my $req_org = $request_lib->id;
2576 $logger->info("prox cache $home_org " . $prox_cache{$home_org});
2578 $prox_cache{$home_org} =
2579 $e->search_actor_org_unit_proximity({from_org => $home_org})
2580 unless $prox_cache{$home_org};
2581 my $home_prox = $prox_cache{$home_org};
2584 my %hash = map { ($_->to_org => $_->prox) } @$home_prox;
2585 push( @{$buckets{ $hash{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2587 my @keys = sort { $a <=> $b } keys %buckets;
2590 if( $home_org ne $req_org ) {
2591 # -----------------------------------------------------------------------
2592 # shove the copies close to the request_lib into the primary buckets
2593 # directly before the farthest away copies. That way, they are not
2594 # given priority, but they are checked before the farthest copies.
2595 # -----------------------------------------------------------------------
2596 $prox_cache{$req_org} =
2597 $e->search_actor_org_unit_proximity({from_org => $req_org})
2598 unless $prox_cache{$req_org};
2599 my $req_prox = $prox_cache{$req_org};
2602 my %hash2 = map { ($_->to_org => $_->prox) } @$req_prox;
2603 push( @{$buckets2{ $hash2{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2605 my $highest_key = $keys[@keys - 1]; # the farthest prox in the exising buckets
2606 my $new_key = $highest_key - 0.5; # right before the farthest prox
2607 my @keys2 = sort { $a <=> $b } keys %buckets2;
2608 for my $key (@keys2) {
2609 last if $key >= $highest_key;
2610 push( @{$buckets{$new_key}}, $_ ) for @{$buckets2{$key}};
2614 @keys = sort { $a <=> $b } keys %buckets;
2619 OUTER: for my $key (@keys) {
2620 my @cps = @{$buckets{$key}};
2622 $logger->info("looking at " . scalar(@{$buckets{$key}}). " copies in proximity bucket $key");
2624 for my $copyid (@cps) {
2626 next if $seen{$copyid};
2627 $seen{$copyid} = 1; # there could be dupes given the merged buckets
2628 my $copy = $e->retrieve_asset_copy($copyid);
2629 $logger->debug("looking at bucket_key=$key, copy $copyid : circ_lib = " . $copy->circ_lib);
2631 unless($title) { # grab the title if we don't already have it
2632 my $vol = $e->retrieve_asset_call_number(
2633 [ $copy->call_number, { flesh => 1, flesh_fields => { bre => ['fixed_fields'], acn => ['record'] } } ] );
2634 $title = $vol->record;
2637 @status = verify_copy_for_hold(
2638 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib);
2640 last OUTER if $status[0];
2645 if (!defined($empty_ok)) {
2646 $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_part_ok');
2647 $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2650 return (1,0) if ($empty_ok);
2656 sub _check_volume_hold_is_possible {
2657 my( $vol, $title, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou ) = @_;
2658 my %org_filter = create_ranged_org_filter(new_editor(), $selection_ou, $depth);
2659 my $copies = new_editor->search_asset_copy({call_number => $vol->id, %org_filter});
2660 $logger->info("checking possibility of volume hold for volume ".$vol->id);
2662 my $filter_copies = [];
2663 for my $copy (@$copies) {
2664 # ignore part-mapped copies for regular volume level holds
2665 push(@$filter_copies, $copy) unless
2666 new_editor->search_asset_copy_part_map({target_copy => $copy->id})->[0];
2668 $copies = $filter_copies;
2673 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2674 "payload" => {"fail_part" => "no_ultimate_items"}
2680 for my $copy ( @$copies ) {
2681 @status = verify_copy_for_hold(
2682 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib );
2690 sub verify_copy_for_hold {
2691 my( $patron, $requestor, $title, $copy, $pickup_lib, $request_lib ) = @_;
2692 $logger->info("checking possibility of copy in hold request for copy ".$copy->id);
2693 my $permitted = OpenILS::Utils::PermitHold::permit_copy_hold(
2694 { patron => $patron,
2695 requestor => $requestor,
2698 title_descriptor => $title->fixed_fields, # this is fleshed into the title object
2699 pickup_lib => $pickup_lib,
2700 request_lib => $request_lib,
2702 show_event_list => 1
2707 (not scalar @$permitted), # true if permitted is an empty arrayref
2709 ($copy->circ_lib == $pickup_lib) and
2710 ($copy->status == OILS_COPY_STATUS_AVAILABLE)
2718 sub find_nearest_permitted_hold {
2721 my $editor = shift; # CStoreEditor object
2722 my $copy = shift; # copy to target
2723 my $user = shift; # staff
2724 my $check_only = shift; # do no updates, just see if the copy could fulfill a hold
2726 my $evt = OpenILS::Event->new('ACTION_HOLD_REQUEST_NOT_FOUND');
2728 my $bc = $copy->barcode;
2730 # find any existing holds that already target this copy
2731 my $old_holds = $editor->search_action_hold_request(
2732 { current_copy => $copy->id,
2733 cancel_time => undef,
2734 capture_time => undef
2738 # hold->type "R" means we need this copy
2739 for my $h (@$old_holds) { return ($h) if $h->hold_type eq 'R'; }
2742 my $hold_stall_interval = $U->ou_ancestor_setting_value($user->ws_ou, OILS_SETTING_HOLD_SOFT_STALL);
2744 $logger->info("circulator: searching for best hold at org ".$user->ws_ou.
2745 " and copy $bc with a hold stalling interval of ". ($hold_stall_interval || "(none)"));
2747 my $fifo = $U->ou_ancestor_setting_value($user->ws_ou, 'circ.holds_fifo');
2749 # search for what should be the best holds for this copy to fulfill
2750 my $best_holds = $U->storagereq(
2751 "open-ils.storage.action.hold_request.nearest_hold.atomic",
2752 $user->ws_ou, $copy->id, 10, $hold_stall_interval, $fifo );
2754 unless(@$best_holds) {
2756 if( my $hold = $$old_holds[0] ) {
2757 $logger->info("circulator: using existing pre-targeted hold ".$hold->id." in hold search");
2761 $logger->info("circulator: no suitable holds found for copy $bc");
2762 return (undef, $evt);
2768 # for each potential hold, we have to run the permit script
2769 # to make sure the hold is actually permitted.
2772 for my $holdid (@$best_holds) {
2773 next unless $holdid;
2774 $logger->info("circulator: checking if hold $holdid is permitted for copy $bc");
2776 my $hold = $editor->retrieve_action_hold_request($holdid) or next;
2777 my $reqr = $reqr_cache{$hold->requestor} || $editor->retrieve_actor_user($hold->requestor);
2778 my $rlib = $org_cache{$hold->request_lib} || $editor->retrieve_actor_org_unit($hold->request_lib);
2780 $reqr_cache{$hold->requestor} = $reqr;
2781 $org_cache{$hold->request_lib} = $rlib;
2783 # see if this hold is permitted
2784 my $permitted = OpenILS::Utils::PermitHold::permit_copy_hold(
2785 { patron_id => $hold->usr,
2788 pickup_lib => $hold->pickup_lib,
2789 request_lib => $rlib,
2801 unless( $best_hold ) { # no "good" permitted holds were found
2802 if( my $hold = $$old_holds[0] ) { # can we return a pre-targeted hold?
2803 $logger->info("circulator: using existing pre-targeted hold ".$hold->id." in hold search");
2808 $logger->info("circulator: no suitable holds found for copy $bc");
2809 return (undef, $evt);
2812 $logger->info("circulator: best hold ".$best_hold->id." found for copy $bc");
2814 # indicate a permitted hold was found
2815 return $best_hold if $check_only;
2817 # we've found a permitted hold. we need to "grab" the copy
2818 # to prevent re-targeted holds (next part) from re-grabbing the copy
2819 $best_hold->current_copy($copy->id);
2820 $editor->update_action_hold_request($best_hold)
2821 or return (undef, $editor->event);
2826 # re-target any other holds that already target this copy
2827 for my $old_hold (@$old_holds) {
2828 next if $old_hold->id eq $best_hold->id; # don't re-target the hold we want
2829 $logger->info("circulator: clearing current_copy and prev_check_time on hold ".
2830 $old_hold->id." after a better hold [".$best_hold->id."] was found");
2831 $old_hold->clear_current_copy;
2832 $old_hold->clear_prev_check_time;
2833 $editor->update_action_hold_request($old_hold)
2834 or return (undef, $editor->event);
2835 push(@retarget, $old_hold->id);
2838 return ($best_hold, undef, (@retarget) ? \@retarget : undef);
2846 __PACKAGE__->register_method(
2847 method => 'all_rec_holds',
2848 api_name => 'open-ils.circ.holds.retrieve_all_from_title',
2852 my( $self, $conn, $auth, $title_id, $args ) = @_;
2854 my $e = new_editor(authtoken=>$auth);
2855 $e->checkauth or return $e->event;
2856 $e->allowed('VIEW_HOLD') or return $e->event;
2859 $args->{fulfillment_time} = undef; # we don't want to see old fulfilled holds
2860 $args->{cancel_time} = undef;
2862 my $resp = { volume_holds => [], copy_holds => [], recall_holds => [], force_holds => [], metarecord_holds => [], part_holds => [], issuance_holds => [] };
2864 my $mr_map = $e->search_metabib_metarecord_source_map({source => $title_id})->[0];
2866 $resp->{metarecord_holds} = $e->search_action_hold_request(
2867 { hold_type => OILS_HOLD_TYPE_METARECORD,
2868 target => $mr_map->metarecord,
2874 $resp->{title_holds} = $e->search_action_hold_request(
2876 hold_type => OILS_HOLD_TYPE_TITLE,
2877 target => $title_id,
2881 my $parts = $e->search_biblio_monograph_part(
2887 $resp->{part_holds} = $e->search_action_hold_request(
2889 hold_type => OILS_HOLD_TYPE_MONOPART,
2895 my $subs = $e->search_serial_subscription(
2896 { record_entry => $title_id }, {idlist=>1});
2899 my $issuances = $e->search_serial_issuance(
2900 {subscription => $subs}, {idlist=>1}
2904 $resp->{issuance_holds} = $e->search_action_hold_request(
2906 hold_type => OILS_HOLD_TYPE_ISSUANCE,
2907 target => $issuances,
2914 my $vols = $e->search_asset_call_number(
2915 { record => $title_id, deleted => 'f' }, {idlist=>1});
2917 return $resp unless @$vols;
2919 $resp->{volume_holds} = $e->search_action_hold_request(
2921 hold_type => OILS_HOLD_TYPE_VOLUME,
2926 my $copies = $e->search_asset_copy(
2927 { call_number => $vols, deleted => 'f' }, {idlist=>1});
2929 return $resp unless @$copies;
2931 $resp->{copy_holds} = $e->search_action_hold_request(
2933 hold_type => OILS_HOLD_TYPE_COPY,
2938 $resp->{recall_holds} = $e->search_action_hold_request(
2940 hold_type => OILS_HOLD_TYPE_RECALL,
2945 $resp->{force_holds} = $e->search_action_hold_request(
2947 hold_type => OILS_HOLD_TYPE_FORCE,
2959 __PACKAGE__->register_method(
2960 method => 'uber_hold',
2962 api_name => 'open-ils.circ.hold.details.retrieve'
2966 my($self, $client, $auth, $hold_id, $args) = @_;
2967 my $e = new_editor(authtoken=>$auth);
2968 $e->checkauth or return $e->event;
2969 return uber_hold_impl($e, $hold_id, $args);
2972 __PACKAGE__->register_method(
2973 method => 'batch_uber_hold',
2976 api_name => 'open-ils.circ.hold.details.batch.retrieve'
2979 sub batch_uber_hold {
2980 my($self, $client, $auth, $hold_ids, $args) = @_;
2981 my $e = new_editor(authtoken=>$auth);
2982 $e->checkauth or return $e->event;
2983 $client->respond(uber_hold_impl($e, $_, $args)) for @$hold_ids;
2987 sub uber_hold_impl {
2988 my($e, $hold_id, $args) = @_;
2991 my $hold = $e->retrieve_action_hold_request(
2996 flesh_fields => { ahr => [ 'current_copy', 'usr', 'notes' ] }
2999 ) or return $e->event;
3001 if($hold->usr->id ne $e->requestor->id) {
3002 # A user is allowed to see his/her own holds
3003 $e->allowed('VIEW_HOLD') or return $e->event;
3004 $hold->notes( # filter out any non-staff ("private") notes
3005 [ grep { !$U->is_true($_->staff) } @{$hold->notes} ] );
3008 # caller is asking for own hold, but may not have permission to view staff notes
3009 unless($e->allowed('VIEW_HOLD')) {
3010 $hold->notes( # filter out any staff notes
3011 [ grep { $U->is_true($_->staff) } @{$hold->notes} ] );
3015 my $user = $hold->usr;
3016 $hold->usr($user->id);
3019 my( $mvr, $volume, $copy, $issuance, $part, $bre ) = find_hold_mvr($e, $hold, $args->{suppress_mvr});
3021 flesh_hold_notices([$hold], $e) unless $args->{suppress_notices};
3022 flesh_hold_transits([$hold]) unless $args->{suppress_transits};
3024 my $details = retrieve_hold_queue_status_impl($e, $hold);
3028 ($copy ? (copy => $copy) : ()),
3029 ($volume ? (volume => $volume) : ()),
3030 ($issuance ? (issuance => $issuance) : ()),
3031 ($part ? (part => $part) : ()),
3032 ($args->{include_bre} ? (bre => $bre) : ()),
3033 ($args->{suppress_mvr} ? () : (mvr => $mvr)),
3037 unless($args->{suppress_patron_details}) {
3038 my $card = $e->retrieve_actor_card($user->card) or return $e->event;
3039 $resp->{patron_first} = $user->first_given_name,
3040 $resp->{patron_last} = $user->family_name,
3041 $resp->{patron_barcode} = $card->barcode,
3042 $resp->{patron_alias} = $user->alias,
3050 # -----------------------------------------------------
3051 # Returns the MVR object that represents what the
3053 # -----------------------------------------------------
3055 my( $e, $hold, $no_mvr ) = @_;
3063 if( $hold->hold_type eq OILS_HOLD_TYPE_METARECORD ) {
3064 my $mr = $e->retrieve_metabib_metarecord($hold->target)
3065 or return $e->event;
3066 $tid = $mr->master_record;
3068 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_TITLE ) {
3069 $tid = $hold->target;
3071 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_VOLUME ) {
3072 $volume = $e->retrieve_asset_call_number($hold->target)
3073 or return $e->event;
3074 $tid = $volume->record;
3076 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_ISSUANCE ) {
3077 $issuance = $e->retrieve_serial_issuance([
3079 {flesh => 1, flesh_fields => {siss => [ qw/subscription/ ]}}
3080 ]) or return $e->event;
3082 $tid = $issuance->subscription->record_entry;
3084 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_MONOPART ) {
3085 $part = $e->retrieve_biblio_monograph_part([
3087 ]) or return $e->event;
3089 $tid = $part->record;
3091 } 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 ) {
3092 $copy = $e->retrieve_asset_copy([
3094 {flesh => 1, flesh_fields => {acp => ['call_number']}}
3095 ]) or return $e->event;
3097 $volume = $copy->call_number;
3098 $tid = $volume->record;
3101 if(!$copy and ref $hold->current_copy ) {
3102 $copy = $hold->current_copy;
3103 $hold->current_copy($copy->id);
3106 if(!$volume and $copy) {
3107 $volume = $e->retrieve_asset_call_number($copy->call_number);
3110 # TODO return metarcord mvr for M holds
3111 my $title = $e->retrieve_biblio_record_entry($tid);
3112 return ( ($no_mvr) ? undef : $U->record_to_mvr($title), $volume, $copy, $issuance, $part, $title );
3115 __PACKAGE__->register_method(
3116 method => 'clear_shelf_cache',
3117 api_name => 'open-ils.circ.hold.clear_shelf.get_cache',
3121 Returns the holds processed with the given cache key
3126 sub clear_shelf_cache {
3127 my($self, $client, $auth, $cache_key, $chunk_size) = @_;
3128 my $e = new_editor(authtoken => $auth, xact => 1);
3129 return $e->die_event unless $e->checkauth and $e->allowed('VIEW_HOLD');
3132 my $hold_data = OpenSRF::Utils::Cache->new('global')->get_cache($cache_key);
3135 $logger->info("no hold data found in cache"); # XXX TODO return event
3141 foreach (keys %$hold_data) {
3142 $maximum += scalar(@{ $hold_data->{$_} });
3144 $client->respond({"maximum" => $maximum, "progress" => 0});
3146 for my $action (sort keys %$hold_data) {
3147 while (@{$hold_data->{$action}}) {
3148 my @hid_chunk = splice @{$hold_data->{$action}}, 0, $chunk_size;
3150 my $result_chunk = $e->json_query({
3152 "acp" => ["barcode"],
3154 first_given_name second_given_name family_name alias
3164 "field" => "id", "fkey" => "current_copy",
3167 "field" => "id", "fkey" => "call_number",
3170 "field" => "id", "fkey" => "record"
3174 "acpl" => {"field" => "id", "fkey" => "location"}
3177 "au" => {"field" => "id", "fkey" => "usr"}
3180 "where" => {"+ahr" => {"id" => \@hid_chunk}}
3181 }, {"substream" => 1}) or return $e->die_event;
3185 +{"action" => $action, "hold_details" => $_}
3196 __PACKAGE__->register_method(
3197 method => 'clear_shelf_process',
3199 api_name => 'open-ils.circ.hold.clear_shelf.process',
3202 1. Find all holds that have expired on the holds shelf
3204 3. If a clear-shelf status is configured, put targeted copies into this status
3205 4. Divide copies into 3 groups: items to transit, items to reshelve, and items
3206 that are needed for holds. No subsequent action is taken on the holds
3207 or items after grouping.
3212 sub clear_shelf_process {
3213 my($self, $client, $auth, $org_id) = @_;
3215 my $e = new_editor(authtoken=>$auth, xact => 1);
3216 $e->checkauth or return $e->die_event;
3217 my $cache = OpenSRF::Utils::Cache->new('global');
3219 $org_id ||= $e->requestor->ws_ou;
3220 $e->allowed('UPDATE_HOLD', $org_id) or return $e->die_event;
3222 my $copy_status = $U->ou_ancestor_setting_value($org_id, 'circ.holds.clear_shelf.copy_status');
3224 # Find holds on the shelf that have been there too long
3225 my $hold_ids = $e->search_action_hold_request(
3226 { shelf_expire_time => {'<' => 'now'},
3227 pickup_lib => $org_id,
3228 cancel_time => undef,
3229 fulfillment_time => undef,
3230 shelf_time => {'!=' => undef},
3231 capture_time => {'!=' => undef},
3232 current_copy => {'!=' => undef},
3238 my $chunk_size = 25; # chunked status updates
3240 for my $hold_id (@$hold_ids) {
3242 $logger->info("Clear shelf processing hold $hold_id");
3244 my $hold = $e->retrieve_action_hold_request([
3247 flesh_fields => {ahr => ['current_copy']}
3251 $hold->cancel_time('now');
3252 $hold->cancel_cause(2); # Hold Shelf expiration
3253 $e->update_action_hold_request($hold) or return $e->die_event;
3254 delete_hold_copy_maps($self, $e, $hold->id) and return $e->die_event;
3256 my $copy = $hold->current_copy;
3258 if($copy_status or $copy_status == 0) {
3259 # if a clear-shelf copy status is defined, update the copy
3260 $copy->status($copy_status);
3261 $copy->edit_date('now');
3262 $copy->editor($e->requestor->id);
3263 $e->update_asset_copy($copy) or return $e->die_event;
3266 push(@holds, $hold);
3267 $client->respond({maximum => scalar(@holds), progress => $counter}) if ( (++$counter % $chunk_size) == 0);
3278 for my $hold (@holds) {
3280 my $copy = $hold->current_copy;
3281 my ($alt_hold) = __PACKAGE__->find_nearest_permitted_hold($e, $copy, $e->requestor, 1);
3285 push(@{$cache_data{hold}}, $hold->id); # copy is needed for a hold
3287 } elsif($copy->circ_lib != $e->requestor->ws_ou) {
3289 push(@{$cache_data{transit}}, $hold->id); # copy needs to transit
3293 push(@{$cache_data{shelf}}, $hold->id); # copy needs to go back to the shelf
3297 my $cache_key = md5_hex(time . $$ . rand());
3298 $logger->info("clear_shelf_cache: storing under $cache_key");
3299 $cache->put_cache($cache_key, \%cache_data, 7200); # TODO: 2 hours. configurable?
3301 # tell the client we're done
3302 $client->respond_complete({cache_key => $cache_key});
3304 # fire off the hold cancelation trigger and wait for response so don't flood the service
3305 $U->create_events_for_hook(
3306 'hold_request.cancel.expire_holds_shelf',
3307 $_, $org_id, undef, undef, 1) for @holds;
3310 # tell the client we're done
3311 $client->respond_complete;
3315 __PACKAGE__->register_method(
3316 method => 'usr_hold_summary',
3317 api_name => 'open-ils.circ.holds.user_summary',
3319 Returns a summary of holds statuses for a given user
3323 sub usr_hold_summary {
3324 my($self, $conn, $auth, $user_id) = @_;
3326 my $e = new_editor(authtoken=>$auth);
3327 $e->checkauth or return $e->event;
3328 $e->allowed('VIEW_HOLD') or return $e->event;
3330 my $holds = $e->search_action_hold_request(
3333 fulfillment_time => undef,
3334 cancel_time => undef,
3338 my %summary = (1 => 0, 2 => 0, 3 => 0, 4 => 0);
3339 $summary{_hold_status($e, $_)} += 1 for @$holds;
3345 __PACKAGE__->register_method(
3346 method => 'hold_has_copy_at',
3347 api_name => 'open-ils.circ.hold.has_copy_at',
3350 'Returns the ID of the found copy and name of the shelving location if there is ' .
3351 'an available copy at the specified org unit. Returns empty hash otherwise. ' .
3352 'The anticipated use for this method is to determine whether an item is ' .
3353 'available at the library where the user is placing the hold (or, alternatively, '.
3354 'at the pickup library) to encourage bypassing the hold placement and just ' .
3355 'checking out the item.' ,
3357 { desc => 'Authentication Token', type => 'string' },
3358 { desc => 'Method Arguments. Options include: hold_type, hold_target, org_unit. '
3359 . 'hold_type is the hold type code (T, V, C, M, ...). '
3360 . 'hold_target is the identifier of the hold target object. '
3361 . 'org_unit is org unit ID.',
3366 desc => q/Result hash like { "copy" : copy_id, "location" : location_name }, empty hash on misses, event on error./,
3372 sub hold_has_copy_at {
3373 my($self, $conn, $auth, $args) = @_;
3375 my $e = new_editor(authtoken=>$auth);
3376 $e->checkauth or return $e->event;
3378 my $hold_type = $$args{hold_type};
3379 my $hold_target = $$args{hold_target};
3380 my $org_unit = $$args{org_unit};
3383 select => {acp => ['id'], acpl => ['name']},
3386 acpl => {field => 'id', filter => { holdable => 't'}, fkey => 'location'},
3387 ccs => {field => 'id', filter => { holdable => 't'}, fkey => 'status' }
3390 where => {'+acp' => { circulate => 't', deleted => 'f', holdable => 't', circ_lib => $org_unit}},
3394 if($hold_type eq 'C') {
3396 $query->{where}->{'+acp'}->{id} = $hold_target;
3398 } elsif($hold_type eq 'V') {
3400 $query->{where}->{'+acp'}->{call_number} = $hold_target;
3402 } elsif($hold_type eq 'T') {
3404 $query->{from}->{acp}->{acn} = {
3406 fkey => 'call_number',
3410 filter => {id => $hold_target},
3418 $query->{from}->{acp}->{acn} = {
3420 fkey => 'call_number',
3429 filter => {metarecord => $hold_target},
3437 my $res = $e->json_query($query)->[0] or return {};
3438 return {copy => $res->{id}, location => $res->{name}} if $res;
3442 # returns true if the user already has an item checked out
3443 # that could be used to fulfill the requested hold.
3444 sub hold_item_is_checked_out {
3445 my($e, $user_id, $hold_type, $hold_target) = @_;
3448 select => {acp => ['id']},
3449 from => {acp => {}},
3453 in => { # copies for circs the user has checked out
3454 select => {circ => ['target_copy']},
3458 checkin_time => undef,
3460 {stop_fines => ["MAXFINES","LONGOVERDUE"]},
3461 {stop_fines => undef}
3471 if($hold_type eq 'C' || $hold_type eq 'R' || $hold_type eq 'F') {
3473 $query->{where}->{'+acp'}->{id}->{in}->{where}->{'target_copy'} = $hold_target;
3475 } elsif($hold_type eq 'V') {
3477 $query->{where}->{'+acp'}->{call_number} = $hold_target;
3479 } elsif($hold_type eq 'P') {
3481 $query->{from}->{acp}->{acpm} = {
3482 field => 'target_copy',
3484 filter => {part => $hold_target},
3487 } elsif($hold_type eq 'I') {
3489 $query->{from}->{acp}->{sitem} = {
3492 filter => {issuance => $hold_target},
3495 } elsif($hold_type eq 'T') {
3497 $query->{from}->{acp}->{acn} = {
3499 fkey => 'call_number',
3503 filter => {id => $hold_target},
3511 $query->{from}->{acp}->{acn} = {
3513 fkey => 'call_number',
3522 filter => {metarecord => $hold_target},
3530 return $e->json_query($query)->[0];
3533 __PACKAGE__->register_method(
3534 method => 'change_hold_title',
3535 api_name => 'open-ils.circ.hold.change_title',
3538 Updates all title level holds targeting the specified bibs to point a new bib./,
3540 { desc => 'Authentication Token', type => 'string' },
3541 { desc => 'New Target Bib Id', type => 'number' },
3542 { desc => 'Old Target Bib Ids', type => 'array' },
3544 return => { desc => '1 on success' }
3548 __PACKAGE__->register_method(
3549 method => 'change_hold_title_for_specific_holds',
3550 api_name => 'open-ils.circ.hold.change_title.specific_holds',
3553 Updates specified holds to target new bib./,
3555 { desc => 'Authentication Token', type => 'string' },
3556 { desc => 'New Target Bib Id', type => 'number' },
3557 { desc => 'Holds Ids for holds to update', type => 'array' },
3559 return => { desc => '1 on success' }
3564 sub change_hold_title {
3565 my( $self, $client, $auth, $new_bib_id, $bib_ids ) = @_;
3567 my $e = new_editor(authtoken=>$auth, xact=>1);
3568 return $e->die_event unless $e->checkauth;
3570 my $holds = $e->search_action_hold_request(
3573 cancel_time => undef,
3574 fulfillment_time => undef,
3580 flesh_fields => { ahr => ['usr'] }
3586 for my $hold (@$holds) {
3587 $e->allowed('UPDATE_HOLD', $hold->usr->home_ou) or return $e->die_event;
3588 $logger->info("Changing hold " . $hold->id . " target from " . $hold->target . " to $new_bib_id in title hold target change");
3589 $hold->target( $new_bib_id );
3590 $e->update_action_hold_request($hold) or return $e->die_event;
3595 _reset_hold($self, $e->requestor, $_) for @$holds;
3600 sub change_hold_title_for_specific_holds {
3601 my( $self, $client, $auth, $new_bib_id, $hold_ids ) = @_;
3603 my $e = new_editor(authtoken=>$auth, xact=>1);
3604 return $e->die_event unless $e->checkauth;
3606 my $holds = $e->search_action_hold_request(
3609 cancel_time => undef,
3610 fulfillment_time => undef,
3616 flesh_fields => { ahr => ['usr'] }
3622 for my $hold (@$holds) {
3623 $e->allowed('UPDATE_HOLD', $hold->usr->home_ou) or return $e->die_event;
3624 $logger->info("Changing hold " . $hold->id . " target from " . $hold->target . " to $new_bib_id in title hold target change");
3625 $hold->target( $new_bib_id );
3626 $e->update_action_hold_request($hold) or return $e->die_event;
3631 _reset_hold($self, $e->requestor, $_) for @$holds;
3636 __PACKAGE__->register_method(
3637 method => 'rec_hold_count',
3638 api_name => 'open-ils.circ.bre.holds.count',
3640 desc => q/Returns the total number of holds that target the
3641 selected bib record or its associated copies and call_numbers/,
3643 { desc => 'Bib ID', type => 'number' },
3645 return => {desc => 'Hold count', type => 'number'}
3649 __PACKAGE__->register_method(
3650 method => 'rec_hold_count',
3651 api_name => 'open-ils.circ.mmr.holds.count',
3653 desc => q/Returns the total number of holds that target the
3654 selected metarecord or its associated copies, call_numbers, and bib records/,
3656 { desc => 'Metarecord ID', type => 'number' },
3658 return => {desc => 'Hold count', type => 'number'}
3662 # XXX Need to add type I (and, soon, type P) holds to these counts
3663 sub rec_hold_count {
3664 my($self, $conn, $target_id) = @_;
3671 filter => {metarecord => $target_id}
3678 filter => { id => $target_id },
3683 if($self->api_name =~ /mmr/) {
3684 delete $bre_join->{bre}->{filter};
3685 $bre_join->{bre}->{join} = $mmr_join;
3691 fkey => 'call_number',
3697 select => {ahr => [{column => 'id', transform => 'count', alias => 'count'}]},
3701 cancel_time => undef,
3702 fulfillment_time => undef,
3706 hold_type => [qw/C F R/],
3709 select => {acp => ['id']},
3710 from => { acp => $cn_join }
3720 select => {acn => ['id']},
3721 from => {acn => $bre_join}
3729 target => $target_id
3737 if($self->api_name =~ /mmr/) {
3738 $query->{where}->{'+ahr'}->{'-or'}->[2] = {
3743 select => {bre => ['id']},
3744 from => {bre => $mmr_join}
3750 $query->{where}->{'+ahr'}->{'-or'}->[3] = {
3753 target => $target_id
3759 return new_editor()->json_query($query)->[0]->{count};