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 use OpenSRF::Utils::JSON;
40 my $apputils = "OpenILS::Application::AppUtils";
43 __PACKAGE__->register_method(
44 method => "test_and_create_hold_batch",
45 api_name => "open-ils.circ.holds.test_and_create.batch",
48 desc => q/This is for batch creating a set of holds where every field is identical except for the targets./,
50 { desc => 'Authentication token', type => 'string' },
51 { 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'},
52 { desc => 'Array of target ids', type => 'array' }
55 desc => 'Array of hold ID on success, -1 on missing arg, event (or ref to array of events) on error(s)',
60 __PACKAGE__->register_method(
61 method => "test_and_create_hold_batch",
62 api_name => "open-ils.circ.holds.test_and_create.batch.override",
65 desc => '@see open-ils.circ.holds.test_and_create.batch',
70 sub test_and_create_hold_batch {
71 my( $self, $conn, $auth, $params, $target_list, $oargs ) = @_;
74 if ($self->api_name =~ /override/) {
76 $oargs = { all => 1 } unless defined $oargs;
77 $$params{oargs} = $oargs; # for is_possible checking.
80 my $e = new_editor(authtoken=>$auth);
81 return $e->die_event unless $e->checkauth;
82 $$params{'requestor'} = $e->requestor->id;
85 if ($$params{'hold_type'} eq 'T') { $target_field = 'titleid'; }
86 elsif ($$params{'hold_type'} eq 'C') { $target_field = 'copy_id'; }
87 elsif ($$params{'hold_type'} eq 'R') { $target_field = 'copy_id'; }
88 elsif ($$params{'hold_type'} eq 'F') { $target_field = 'copy_id'; }
89 elsif ($$params{'hold_type'} eq 'I') { $target_field = 'issuanceid'; }
90 elsif ($$params{'hold_type'} eq 'V') { $target_field = 'volume_id'; }
91 elsif ($$params{'hold_type'} eq 'M') { $target_field = 'mrid'; }
92 elsif ($$params{'hold_type'} eq 'P') { $target_field = 'partid'; }
93 else { return undef; }
95 my $formats_map = delete $$params{holdable_formats_map};
97 foreach (@$target_list) {
98 $$params{$target_field} = $_;
100 # copy the requested formats from the target->formats map
101 # into the top-level formats attr for each hold
102 $$params{holdable_formats} = $formats_map->{$_};
105 ($res) = $self->method_lookup(
106 'open-ils.circ.title_hold.is_possible')->run($auth, $params, $override ? $oargs : {});
107 if ($res->{'success'} == 1) {
109 $params->{'depth'} = $res->{'depth'} if $res->{'depth'};
111 # Remove oargs from params so holds can be created.
112 if ($$params{oargs}) {
113 delete $$params{oargs};
116 my $ahr = construct_hold_request_object($params);
117 my ($res2) = $self->method_lookup(
119 ? 'open-ils.circ.holds.create.override'
120 : 'open-ils.circ.holds.create'
121 )->run($auth, $ahr, $oargs);
123 'target' => $$params{$target_field},
126 $conn->respond($res2);
129 'target' => $$params{$target_field},
132 $conn->respond($res);
138 sub construct_hold_request_object {
141 my $ahr = Fieldmapper::action::hold_request->new;
144 foreach my $field (keys %{ $params }) {
145 if ($field eq 'depth') { $ahr->selection_depth($$params{$field}); }
146 elsif ($field eq 'patronid') {
147 $ahr->usr($$params{$field}); }
148 elsif ($field eq 'titleid') { $ahr->target($$params{$field}); }
149 elsif ($field eq 'copy_id') { $ahr->target($$params{$field}); }
150 elsif ($field eq 'issuanceid') { $ahr->target($$params{$field}); }
151 elsif ($field eq 'volume_id') { $ahr->target($$params{$field}); }
152 elsif ($field eq 'mrid') { $ahr->target($$params{$field}); }
153 elsif ($field eq 'partid') { $ahr->target($$params{$field}); }
155 $ahr->$field($$params{$field});
161 __PACKAGE__->register_method(
162 method => "create_hold_batch",
163 api_name => "open-ils.circ.holds.create.batch",
166 desc => q/@see open-ils.circ.holds.create.batch/,
168 { desc => 'Authentication token', type => 'string' },
169 { desc => 'Array of hold objects', type => 'array' }
172 desc => 'Array of hold ID on success, -1 on missing arg, event (or ref to array of events) on error(s)',
177 __PACKAGE__->register_method(
178 method => "create_hold_batch",
179 api_name => "open-ils.circ.holds.create.override.batch",
182 desc => '@see open-ils.circ.holds.create.batch',
187 sub create_hold_batch {
188 my( $self, $conn, $auth, $hold_list, $oargs ) = @_;
189 (my $method = $self->api_name) =~ s/\.batch//og;
190 foreach (@$hold_list) {
191 my ($res) = $self->method_lookup($method)->run($auth, $_, $oargs);
192 $conn->respond($res);
198 __PACKAGE__->register_method(
199 method => "create_hold",
200 api_name => "open-ils.circ.holds.create",
202 desc => "Create a new hold for an item. From a permissions perspective, " .
203 "the login session is used as the 'requestor' of the hold. " .
204 "The hold recipient is determined by the 'usr' setting within the hold object. " .
205 'First we verify the requestor has holds request permissions. ' .
206 'Then we verify that the recipient is allowed to make the given hold. ' .
207 'If not, we see if the requestor has "override" capabilities. If not, ' .
208 'a permission exception is returned. If permissions allow, we cycle ' .
209 'through the set of holds objects and create. ' .
210 'If the recipient does not have permission to place multiple holds ' .
211 'on a single title and said operation is attempted, a permission ' .
212 'exception is returned',
214 { desc => 'Authentication token', type => 'string' },
215 { desc => 'Hold object for hold to be created',
216 type => 'object', class => 'ahr' }
219 desc => 'New ahr ID on success, -1 on missing arg, event (or ref to array of events) on error(s)',
224 __PACKAGE__->register_method(
225 method => "create_hold",
226 api_name => "open-ils.circ.holds.create.override",
227 notes => '@see open-ils.circ.holds.create',
229 desc => "If the recipient is not allowed to receive the requested hold, " .
230 "call this method to attempt the override",
232 { desc => 'Authentication token', type => 'string' },
234 desc => 'Hold object for hold to be created',
235 type => 'object', class => 'ahr'
239 desc => 'New hold (ahr) ID on success, -1 on missing arg, event (or ref to array of events) on error(s)',
245 my( $self, $conn, $auth, $hold, $oargs ) = @_;
246 return -1 unless $hold;
247 my $e = new_editor(authtoken=>$auth, xact=>1);
248 return $e->die_event unless $e->checkauth;
251 if ($self->api_name =~ /override/) {
253 $oargs = { all => 1 } unless defined $oargs;
258 my $requestor = $e->requestor;
259 my $recipient = $requestor;
261 if( $requestor->id ne $hold->usr ) {
262 # Make sure the requestor is allowed to place holds for
263 # the recipient if they are not the same people
264 $recipient = $e->retrieve_actor_user($hold->usr) or return $e->die_event;
265 $e->allowed('REQUEST_HOLDS', $recipient->home_ou) or return $e->die_event;
268 # If the related org setting tells us to, block if patron privs have expired
269 my $expire_setting = $U->ou_ancestor_setting_value($recipient->home_ou, OILS_SETTING_BLOCK_HOLD_FOR_EXPIRED_PATRON);
270 if ($expire_setting) {
271 my $expire = DateTime::Format::ISO8601->new->parse_datetime(
272 cleanse_ISO8601($recipient->expire_date));
274 push( @events, OpenILS::Event->new(
275 'PATRON_ACCOUNT_EXPIRED',
276 "payload" => {"fail_part" => "actor.usr.privs_expired"}
277 )) if( CORE::time > $expire->epoch ) ;
280 # Now make sure the recipient is allowed to receive the specified hold
281 my $porg = $recipient->home_ou;
282 my $rid = $e->requestor->id;
283 my $t = $hold->hold_type;
285 # See if a duplicate hold already exists
287 usr => $recipient->id,
289 fulfillment_time => undef,
290 target => $hold->target,
291 cancel_time => undef,
294 $sargs->{holdable_formats} = $hold->holdable_formats if $t eq 'M';
296 my $existing = $e->search_action_hold_request($sargs);
297 push( @events, OpenILS::Event->new('HOLD_EXISTS')) if @$existing;
299 my $checked_out = hold_item_is_checked_out($e, $recipient->id, $hold->hold_type, $hold->target);
300 push( @events, OpenILS::Event->new('HOLD_ITEM_CHECKED_OUT')) if $checked_out;
302 if ( $t eq OILS_HOLD_TYPE_METARECORD ) {
303 return $e->die_event unless $e->allowed('MR_HOLDS', $porg);
304 } elsif ( $t eq OILS_HOLD_TYPE_TITLE ) {
305 return $e->die_event unless $e->allowed('TITLE_HOLDS', $porg);
306 } elsif ( $t eq OILS_HOLD_TYPE_VOLUME ) {
307 return $e->die_event unless $e->allowed('VOLUME_HOLDS', $porg);
308 } elsif ( $t eq OILS_HOLD_TYPE_MONOPART ) {
309 return $e->die_event unless $e->allowed('TITLE_HOLDS', $porg);
310 } elsif ( $t eq OILS_HOLD_TYPE_ISSUANCE ) {
311 return $e->die_event unless $e->allowed('ISSUANCE_HOLDS', $porg);
312 } elsif ( $t eq OILS_HOLD_TYPE_COPY ) {
313 return $e->die_event unless $e->allowed('COPY_HOLDS', $porg);
314 } elsif ( $t eq OILS_HOLD_TYPE_FORCE || $t eq OILS_HOLD_TYPE_RECALL ) {
315 my $copy = $e->retrieve_asset_copy($hold->target)
316 or return $e->die_event;
317 if ( $t eq OILS_HOLD_TYPE_FORCE ) {
318 return $e->die_event unless $e->allowed('COPY_HOLDS_FORCE', $copy->circ_lib);
319 } elsif ( $t eq OILS_HOLD_TYPE_RECALL ) {
320 return $e->die_event unless $e->allowed('COPY_HOLDS_RECALL', $copy->circ_lib);
329 for my $evt (@events) {
331 my $name = $evt->{textcode};
332 if($oargs->{all} || grep { $_ eq $name } @{$oargs->{events}}) {
333 return $e->die_event unless $e->allowed("$name.override", $porg);
341 # Check for hold expiration in the past, and set it to empty string.
342 $hold->expire_time(undef) if ($hold->expire_time && $U->datecmp($hold->expire_time) == -1);
344 # set the configured expire time
345 unless($hold->expire_time) {
346 $hold->expire_time(calculate_expire_time($recipient->home_ou));
350 # if behind-the-desk pickup is supported at the hold pickup lib,
351 # set the value to the patron default, unless a value has already
352 # been applied. If it's not supported, force the value to false.
354 my $bdous = $U->ou_ancestor_setting_value(
356 'circ.holds.behind_desk_pickup_supported', $e);
359 if (!defined $hold->behind_desk) {
361 my $set = $e->search_actor_user_setting({
363 name => 'circ.holds_behind_desk'
366 $hold->behind_desk('t') if $set and
367 OpenSRF::Utils::JSON->JSON2perl($set->value);
370 # behind the desk not supported, force it to false
371 $hold->behind_desk('f');
374 $hold->requestor($e->requestor->id);
375 $hold->request_lib($e->requestor->ws_ou);
376 $hold->selection_ou($hold->pickup_lib) unless $hold->selection_ou;
377 $hold = $e->create_action_hold_request($hold) or return $e->die_event;
381 $conn->respond_complete($hold->id);
383 $U->simplereq('open-ils.hold-targeter',
384 'open-ils.hold-targeter.target', {hold => $hold->id}
385 ) unless $U->is_true($hold->frozen);
390 # makes sure that a user has permission to place the type of requested hold
391 # returns the Perm exception if not allowed, returns undef if all is well
392 sub _check_holds_perm {
393 my($type, $user_id, $org_id) = @_;
397 $evt = $apputils->check_perms($user_id, $org_id, "MR_HOLDS" );
398 } elsif ($type eq "T") {
399 $evt = $apputils->check_perms($user_id, $org_id, "TITLE_HOLDS" );
400 } elsif($type eq "V") {
401 $evt = $apputils->check_perms($user_id, $org_id, "VOLUME_HOLDS");
402 } elsif($type eq "C") {
403 $evt = $apputils->check_perms($user_id, $org_id, "COPY_HOLDS" );
410 # tests if the given user is allowed to place holds on another's behalf
411 sub _check_request_holds_perm {
414 if (my $evt = $apputils->check_perms(
415 $user_id, $org_id, "REQUEST_HOLDS")) {
420 my $ses_is_req_note = 'The login session is the requestor. If the requestor is different from the user, ' .
421 'then the requestor must have VIEW_HOLD permissions';
423 __PACKAGE__->register_method(
424 method => "retrieve_holds_by_id",
425 api_name => "open-ils.circ.holds.retrieve_by_id",
427 desc => "Retrieve the hold, with hold transits attached, for the specified ID. $ses_is_req_note",
429 { desc => 'Authentication token', type => 'string' },
430 { desc => 'Hold ID', type => 'number' }
433 desc => 'Hold object with transits attached, event on error',
439 sub retrieve_holds_by_id {
440 my($self, $client, $auth, $hold_id) = @_;
441 my $e = new_editor(authtoken=>$auth);
442 $e->checkauth or return $e->event;
443 $e->allowed('VIEW_HOLD') or return $e->event;
445 my $holds = $e->search_action_hold_request(
447 { id => $hold_id , fulfillment_time => undef },
449 order_by => { ahr => "request_time" },
451 flesh_fields => {ahr => ['notes']}
456 flesh_hold_transits($holds);
457 flesh_hold_notices($holds, $e);
462 __PACKAGE__->register_method(
463 method => "retrieve_holds",
464 api_name => "open-ils.circ.holds.retrieve",
466 desc => "Retrieves all the holds, with hold transits attached, for the specified user. $ses_is_req_note",
468 { desc => 'Authentication token', type => 'string' },
469 { desc => 'User ID', type => 'integer' },
470 { desc => 'Available Only', type => 'boolean' }
473 desc => 'list of holds, event on error',
478 __PACKAGE__->register_method(
479 method => "retrieve_holds",
480 api_name => "open-ils.circ.holds.id_list.retrieve",
483 desc => "Retrieves all the hold IDs, for the specified user. $ses_is_req_note",
485 { desc => 'Authentication token', type => 'string' },
486 { desc => 'User ID', type => 'integer' },
487 { desc => 'Available Only', type => 'boolean' }
490 desc => 'list of holds, event on error',
495 __PACKAGE__->register_method(
496 method => "retrieve_holds",
497 api_name => "open-ils.circ.holds.canceled.retrieve",
500 desc => "Retrieves all the cancelled holds for the specified user. $ses_is_req_note",
502 { desc => 'Authentication token', type => 'string' },
503 { desc => 'User ID', type => 'integer' }
506 desc => 'list of holds, event on error',
511 __PACKAGE__->register_method(
512 method => "retrieve_holds",
513 api_name => "open-ils.circ.holds.canceled.id_list.retrieve",
516 desc => "Retrieves list of cancelled hold IDs for the specified user. $ses_is_req_note",
518 { desc => 'Authentication token', type => 'string' },
519 { desc => 'User ID', type => 'integer' }
522 desc => 'list of hold IDs, event on error',
529 my ($self, $client, $auth, $user_id, $available) = @_;
531 my $e = new_editor(authtoken=>$auth);
532 return $e->event unless $e->checkauth;
533 $user_id = $e->requestor->id unless defined $user_id;
535 my $notes_filter = {staff => 'f'};
536 my $user = $e->retrieve_actor_user($user_id) or return $e->event;
537 unless($user_id == $e->requestor->id) {
538 if($e->allowed('VIEW_HOLD', $user->home_ou)) {
539 $notes_filter = {staff => 't'}
541 my $allowed = OpenILS::Application::Actor::Friends->friend_perm_allowed(
542 $e, $user_id, $e->requestor->id, 'hold.view');
543 return $e->event unless $allowed;
546 # staff member looking at his/her own holds can see staff and non-staff notes
547 $notes_filter = {} if $e->allowed('VIEW_HOLD', $user->home_ou);
551 select => {ahr => ['id']},
553 where => {usr => $user_id, fulfillment_time => undef}
556 if($self->api_name =~ /canceled/) {
558 # Fetch the canceled holds
559 # order cancelled holds by cancel time, most recent first
561 $holds_query->{order_by} = [{class => 'ahr', field => 'cancel_time', direction => 'desc'}];
564 my $cancel_count = $U->ou_ancestor_setting_value(
565 $e->requestor->ws_ou, 'circ.holds.canceled.display_count', $e);
567 unless($cancel_count) {
568 $cancel_age = $U->ou_ancestor_setting_value(
569 $e->requestor->ws_ou, 'circ.holds.canceled.display_age', $e);
571 # if no settings are defined, default to last 10 cancelled holds
572 $cancel_count = 10 unless $cancel_age;
575 if($cancel_count) { # limit by count
577 $holds_query->{where}->{cancel_time} = {'!=' => undef};
578 $holds_query->{limit} = $cancel_count;
580 } elsif($cancel_age) { # limit by age
582 # find all of the canceled holds that were canceled within the configured time frame
583 my $date = DateTime->now->subtract(seconds => OpenSRF::Utils::interval_to_seconds($cancel_age));
584 $date = $U->epoch2ISO8601($date->epoch);
585 $holds_query->{where}->{cancel_time} = {'>=' => $date};
590 # order non-cancelled holds by ready-for-pickup, then active, followed by suspended
591 # "compare" sorts false values to the front. testing pickup_lib != current_shelf_lib
592 # will sort by pl = csl > pl != csl > followed by csl is null;
593 $holds_query->{order_by} = [
595 field => 'pickup_lib',
596 compare => {'!=' => {'+ahr' => 'current_shelf_lib'}}},
597 {class => 'ahr', field => 'shelf_time'},
598 {class => 'ahr', field => 'frozen'},
599 {class => 'ahr', field => 'request_time'}
602 $holds_query->{where}->{cancel_time} = undef;
604 $holds_query->{where}->{shelf_time} = {'!=' => undef};
606 $holds_query->{where}->{pickup_lib} = {'=' => {'+ahr' => 'current_shelf_lib'}};
610 my $hold_ids = $e->json_query($holds_query);
611 $hold_ids = [ map { $_->{id} } @$hold_ids ];
613 return $hold_ids if $self->api_name =~ /id_list/;
616 for my $hold_id ( @$hold_ids ) {
618 my $hold = $e->retrieve_action_hold_request($hold_id);
619 $hold->notes($e->search_action_hold_request_note({hold => $hold_id, %$notes_filter}));
622 $e->search_action_hold_transit_copy([
624 {order_by => {ahtc => 'source_send_time desc'}, limit => 1}])->[0]
634 __PACKAGE__->register_method(
635 method => 'user_hold_count',
636 api_name => 'open-ils.circ.hold.user.count'
639 sub user_hold_count {
640 my ( $self, $conn, $auth, $userid ) = @_;
641 my $e = new_editor( authtoken => $auth );
642 return $e->event unless $e->checkauth;
643 my $patron = $e->retrieve_actor_user($userid)
645 return $e->event unless $e->allowed( 'VIEW_HOLD', $patron->home_ou );
646 return __user_hold_count( $self, $e, $userid );
649 sub __user_hold_count {
650 my ( $self, $e, $userid ) = @_;
651 my $holds = $e->search_action_hold_request(
654 fulfillment_time => undef,
655 cancel_time => undef,
660 return scalar(@$holds);
664 __PACKAGE__->register_method(
665 method => "retrieve_holds_by_pickup_lib",
666 api_name => "open-ils.circ.holds.retrieve_by_pickup_lib",
668 "Retrieves all the holds, with hold transits attached, for the specified pickup_ou id."
671 __PACKAGE__->register_method(
672 method => "retrieve_holds_by_pickup_lib",
673 api_name => "open-ils.circ.holds.id_list.retrieve_by_pickup_lib",
674 notes => "Retrieves all the hold ids for the specified pickup_ou id. "
677 sub retrieve_holds_by_pickup_lib {
678 my ($self, $client, $login_session, $ou_id) = @_;
680 #FIXME -- put an appropriate permission check here
681 #my( $user, $target, $evt ) = $apputils->checkses_requestor(
682 # $login_session, $user_id, 'VIEW_HOLD' );
683 #return $evt if $evt;
685 my $holds = $apputils->simplereq(
687 "open-ils.cstore.direct.action.hold_request.search.atomic",
689 pickup_lib => $ou_id ,
690 fulfillment_time => undef,
693 { order_by => { ahr => "request_time" } }
696 if ( ! $self->api_name =~ /id_list/ ) {
697 flesh_hold_transits($holds);
701 return [ map { $_->id } @$holds ];
705 __PACKAGE__->register_method(
706 method => "uncancel_hold",
707 api_name => "open-ils.circ.hold.uncancel"
711 my($self, $client, $auth, $hold_id) = @_;
712 my $e = new_editor(authtoken=>$auth, xact=>1);
713 return $e->die_event unless $e->checkauth;
715 my $hold = $e->retrieve_action_hold_request($hold_id)
716 or return $e->die_event;
717 return $e->die_event unless $e->allowed('CANCEL_HOLDS', $hold->request_lib);
719 if ($hold->fulfillment_time) {
723 unless ($hold->cancel_time) {
728 # if configured to reset the request time, also reset the expire time
729 if($U->ou_ancestor_setting_value(
730 $hold->request_lib, 'circ.holds.uncancel.reset_request_time', $e)) {
732 $hold->request_time('now');
733 $hold->expire_time(calculate_expire_time($hold->request_lib));
736 $hold->clear_cancel_time;
737 $hold->clear_cancel_cause;
738 $hold->clear_cancel_note;
739 $hold->clear_shelf_time;
740 $hold->clear_current_copy;
741 $hold->clear_capture_time;
742 $hold->clear_prev_check_time;
743 $hold->clear_shelf_expire_time;
744 $hold->clear_current_shelf_lib;
746 $e->update_action_hold_request($hold) or return $e->die_event;
749 $U->simplereq('open-ils.hold-targeter',
750 'open-ils.hold-targeter.target', {hold => $hold_id});
756 __PACKAGE__->register_method(
757 method => "cancel_hold",
758 api_name => "open-ils.circ.hold.cancel",
760 desc => 'Cancels the specified hold. The login session is the requestor. If the requestor is different from the usr field ' .
761 'on the hold, the requestor must have CANCEL_HOLDS permissions. The hold may be either the hold object or the hold id',
763 {desc => 'Authentication token', type => 'string'},
764 {desc => 'Hold ID', type => 'number'},
765 {desc => 'Cause of Cancellation', type => 'string'},
766 {desc => 'Note', type => 'string'}
769 desc => '1 on success, event on error'
775 my($self, $client, $auth, $holdid, $cause, $note) = @_;
777 my $e = new_editor(authtoken=>$auth, xact=>1);
778 return $e->die_event unless $e->checkauth;
780 my $hold = $e->retrieve_action_hold_request($holdid)
781 or return $e->die_event;
783 if( $e->requestor->id ne $hold->usr ) {
784 return $e->die_event unless $e->allowed('CANCEL_HOLDS');
787 if ($hold->cancel_time) {
792 # If the hold is captured, reset the copy status
793 if( $hold->capture_time and $hold->current_copy ) {
795 my $copy = $e->retrieve_asset_copy($hold->current_copy)
796 or return $e->die_event;
798 if( $copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF ) {
799 $logger->info("canceling hold $holdid whose item is on the holds shelf");
800 # $logger->info("setting copy to status 'reshelving' on hold cancel");
801 # $copy->status(OILS_COPY_STATUS_RESHELVING);
802 # $copy->editor($e->requestor->id);
803 # $copy->edit_date('now');
804 # $e->update_asset_copy($copy) or return $e->event;
806 } elsif( $copy->status == OILS_COPY_STATUS_IN_TRANSIT ) {
809 $logger->warn("! canceling hold [$hid] that is in transit");
810 my $transid = $e->search_action_hold_transit_copy({hold=>$hold->id},{idlist=>1})->[0];
813 my $trans = $e->retrieve_action_transit_copy($transid);
814 # Leave the transit alive, but set the copy status to
815 # reshelving so it will be properly reshelved when it gets back home
817 $trans->copy_status( OILS_COPY_STATUS_RESHELVING );
818 $e->update_action_transit_copy($trans) or return $e->die_event;
824 $hold->cancel_time('now');
825 $hold->cancel_cause($cause);
826 $hold->cancel_note($note);
827 $e->update_action_hold_request($hold)
828 or return $e->die_event;
832 # re-fetch the hold to pick up the real cancel_time (not "now") for A/T
834 $hold = $e->retrieve_action_hold_request($hold->id) or return $e->die_event;
837 if ($e->requestor->id == $hold->usr) {
838 $U->create_events_for_hook('hold_request.cancel.patron', $hold, $hold->pickup_lib);
840 $U->create_events_for_hook('hold_request.cancel.staff', $hold, $hold->pickup_lib);
846 my $update_hold_desc = 'The login session is the requestor. ' .
847 'If the requestor is different from the usr field on the hold, ' .
848 'the requestor must have UPDATE_HOLDS permissions. ' .
849 'If supplying a hash of hold data, "id" must be included. ' .
850 'The hash is ignored if a hold object is supplied, ' .
851 'so you should supply only one kind of hold data argument.' ;
853 __PACKAGE__->register_method(
854 method => "update_hold",
855 api_name => "open-ils.circ.hold.update",
857 desc => "Updates the specified hold. $update_hold_desc",
859 {desc => 'Authentication token', type => 'string'},
860 {desc => 'Hold Object', type => 'object'},
861 {desc => 'Hash of values to be applied', type => 'object'}
864 desc => 'Hold ID on success, event on error',
870 __PACKAGE__->register_method(
871 method => "batch_update_hold",
872 api_name => "open-ils.circ.hold.update.batch",
875 desc => "Updates the specified hold(s). $update_hold_desc",
877 {desc => 'Authentication token', type => 'string'},
878 {desc => 'Array of hold obejcts', type => 'array' },
879 {desc => 'Array of hashes of values to be applied', type => 'array' }
882 desc => 'Hold ID per success, event per error',
888 my($self, $client, $auth, $hold, $values) = @_;
889 my $e = new_editor(authtoken=>$auth, xact=>1);
890 return $e->die_event unless $e->checkauth;
891 my $resp = update_hold_impl($self, $e, $hold, $values);
892 if ($U->event_code($resp)) {
896 $e->commit; # FIXME: update_hold_impl already does $e->commit ??
900 sub batch_update_hold {
901 my($self, $client, $auth, $hold_list, $values_list) = @_;
902 my $e = new_editor(authtoken=>$auth);
903 return $e->die_event unless $e->checkauth;
905 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.
907 $values_list ||= []; # FIXME: either move this above $count declaration, or send an event if both lists undef. Probably the latter.
909 # FIXME: Failing over to [] guarantees warnings for "Use of unitialized value" in update_hold_impl call.
910 # FIXME: We should be sure we only call update_hold_impl with hold object OR hash, not both.
912 for my $idx (0..$count-1) {
914 my $resp = update_hold_impl($self, $e, $hold_list->[$idx], $values_list->[$idx]);
915 $e->xact_commit unless $U->event_code($resp);
916 $client->respond($resp);
920 return undef; # not in the register return type, assuming we should always have at least one list populated
923 sub update_hold_impl {
924 my($self, $e, $hold, $values) = @_;
926 my $need_retarget = 0;
929 $hold = $e->retrieve_action_hold_request($values->{id})
930 or return $e->die_event;
931 for my $k (keys %$values) {
932 # Outside of pickup_lib (covered by the first regex) I don't know when these would currently change.
933 # But hey, why not cover things that may happen later?
934 if ($k =~ '_(lib|ou)$' || $k eq 'target' || $k eq 'hold_type' || $k eq 'requestor' || $k eq 'selection_depth' || $k eq 'holdable_formats') {
935 if (defined $values->{$k} && defined $hold->$k() && $values->{$k} ne $hold->$k()) {
936 # Value changed? RETARGET!
938 } elsif (defined $hold->$k() != defined $values->{$k}) {
939 # Value being set or cleared? RETARGET!
943 if (defined $values->{$k}) {
944 $hold->$k($values->{$k});
946 my $f = "clear_$k"; $hold->$f();
951 my $orig_hold = $e->retrieve_action_hold_request($hold->id)
952 or return $e->die_event;
954 # don't allow the user to be changed
955 return OpenILS::Event->new('BAD_PARAMS') if $hold->usr != $orig_hold->usr;
957 if($hold->usr ne $e->requestor->id) {
958 # if the hold is for a different user, make sure the
959 # requestor has the appropriate permissions
960 my $usr = $e->retrieve_actor_user($hold->usr)
961 or return $e->die_event;
962 return $e->die_event unless $e->allowed('UPDATE_HOLD', $usr->home_ou);
966 # --------------------------------------------------------------
967 # Changing the request time is like playing God
968 # --------------------------------------------------------------
969 if($hold->request_time ne $orig_hold->request_time) {
970 return OpenILS::Event->new('BAD_PARAMS') if $hold->fulfillment_time;
971 return $e->die_event unless $e->allowed('UPDATE_HOLD_REQUEST_TIME', $hold->pickup_lib);
975 # --------------------------------------------------------------
976 # Code for making sure staff have appropriate permissons for cut_in_line
977 # This, as is, doesn't prevent a user from cutting their own holds in line
979 # --------------------------------------------------------------
980 if($U->is_true($hold->cut_in_line) ne $U->is_true($orig_hold->cut_in_line)) {
981 return $e->die_event unless $e->allowed('UPDATE_HOLD_REQUEST_TIME', $hold->pickup_lib);
985 # --------------------------------------------------------------
986 # Disallow hold suspencion if the hold is already captured.
987 # --------------------------------------------------------------
988 if ($U->is_true($hold->frozen) and not $U->is_true($orig_hold->frozen)) {
989 $hold_status = _hold_status($e, $hold);
990 if ($hold_status > 2 && $hold_status != 7) { # hold is captured
991 $logger->info("bypassing hold freeze on captured hold");
992 return OpenILS::Event->new('HOLD_SUSPEND_AFTER_CAPTURE');
997 # --------------------------------------------------------------
998 # if the hold is on the holds shelf or in transit and the pickup
999 # lib changes we need to create a new transit.
1000 # --------------------------------------------------------------
1001 if($orig_hold->pickup_lib ne $hold->pickup_lib) {
1003 $hold_status = _hold_status($e, $hold) unless $hold_status;
1005 if($hold_status == 3) { # in transit
1007 return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_TRANSIT', $orig_hold->pickup_lib);
1008 return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_TRANSIT', $hold->pickup_lib);
1010 $logger->info("updating pickup lib for hold ".$hold->id." while already in transit");
1012 # update the transit to reflect the new pickup location
1013 my $transit = $e->search_action_hold_transit_copy(
1014 {hold=>$hold->id, dest_recv_time => undef})->[0]
1015 or return $e->die_event;
1017 $transit->prev_dest($transit->dest); # mark the previous destination on the transit
1018 $transit->dest($hold->pickup_lib);
1019 $e->update_action_hold_transit_copy($transit) or return $e->die_event;
1021 } elsif($hold_status == 4 or $hold_status == 5 or $hold_status == 8) { # on holds shelf
1023 return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_HOLDS_SHELF', $orig_hold->pickup_lib);
1024 return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_HOLDS_SHELF', $hold->pickup_lib);
1026 $logger->info("updating pickup lib for hold ".$hold->id." while on holds shelf");
1028 if ($hold->pickup_lib eq $orig_hold->current_shelf_lib) {
1029 # This can happen if the pickup lib is changed while the hold is
1030 # on the shelf, then changed back to the original pickup lib.
1031 # Restore the original shelf_expire_time to prevent abuse.
1032 set_hold_shelf_expire_time(undef, $hold, $e, $hold->shelf_time);
1035 # clear to prevent premature shelf expiration
1036 $hold->clear_shelf_expire_time;
1041 if($U->is_true($hold->frozen)) {
1042 $logger->info("clearing current_copy and check_time for frozen hold ".$hold->id);
1043 $hold->clear_current_copy;
1044 $hold->clear_prev_check_time;
1045 # Clear expire_time to prevent frozen holds from expiring.
1046 $logger->info("clearing expire_time for frozen hold ".$hold->id);
1047 $hold->clear_expire_time;
1050 # If the hold_expire_time is in the past && is not equal to the
1051 # original expire_time, then reset the expire time to be in the
1053 if ($hold->expire_time && $U->datecmp($hold->expire_time) == -1 && $U->datecmp($hold->expire_time, $orig_hold->expire_time) != 0) {
1054 $hold->expire_time(calculate_expire_time($hold->request_lib));
1057 # If the hold is reactivated, reset the expire_time.
1058 if(!$U->is_true($hold->frozen) && $U->is_true($orig_hold->frozen)) {
1059 $logger->info("Reset expire_time on activated hold ".$hold->id);
1060 $hold->expire_time(calculate_expire_time($hold->request_lib));
1063 $e->update_action_hold_request($hold) or return $e->die_event;
1066 if(!$U->is_true($hold->frozen) && $U->is_true($orig_hold->frozen)) {
1067 $logger->info("Running targeter on activated hold ".$hold->id);
1068 $U->simplereq('open-ils.hold-targeter',
1069 'open-ils.hold-targeter.target', {hold => $hold->id});
1072 # a change to mint-condition changes the set of potential copies, so retarget the hold;
1073 if($U->is_true($hold->mint_condition) and !$U->is_true($orig_hold->mint_condition)) {
1074 _reset_hold($self, $e->requestor, $hold)
1075 } elsif($need_retarget && !defined $hold->capture_time()) { # If needed, retarget the hold due to changes
1076 $U->simplereq('open-ils.hold-targeter',
1077 'open-ils.hold-targeter.target', {hold => $hold->id});
1083 # this does not update the hold in the DB. It only
1084 # sets the shelf_expire_time field on the hold object.
1085 # start_time is optional and defaults to 'now'
1086 sub set_hold_shelf_expire_time {
1087 my ($class, $hold, $editor, $start_time) = @_;
1089 my $shelf_expire = $U->ou_ancestor_setting_value(
1091 'circ.holds.default_shelf_expire_interval',
1095 return undef unless $shelf_expire;
1097 $start_time = ($start_time) ?
1098 DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($start_time)) :
1099 DateTime->now(time_zone => 'local'); # without time_zone we get UTC ... yuck!
1101 my $seconds = OpenSRF::Utils->interval_to_seconds($shelf_expire);
1102 my $expire_time = $start_time->add(seconds => $seconds);
1104 # if the shelf expire time overlaps with a pickup lib's
1105 # closed date, push it out to the first open date
1106 my $dateinfo = $U->storagereq(
1107 'open-ils.storage.actor.org_unit.closed_date.overlap',
1108 $hold->pickup_lib, $expire_time->strftime('%FT%T%z'));
1111 my $dt_parser = DateTime::Format::ISO8601->new;
1112 $expire_time = $dt_parser->parse_datetime(cleanse_ISO8601($dateinfo->{end}));
1114 # TODO: enable/disable time bump via setting?
1115 $expire_time->set(hour => '23', minute => '59', second => '59');
1117 $logger->info("circulator: shelf_expire_time overlaps".
1118 " with closed date, pushing expire time to $expire_time");
1121 $hold->shelf_expire_time($expire_time->strftime('%FT%T%z'));
1127 my($e, $orig_hold, $hold, $copy) = @_;
1128 my $src = $orig_hold->pickup_lib;
1129 my $dest = $hold->pickup_lib;
1131 $logger->info("putting hold into transit on pickup_lib update");
1133 my $transit = Fieldmapper::action::hold_transit_copy->new;
1134 $transit->hold($hold->id);
1135 $transit->source($src);
1136 $transit->dest($dest);
1137 $transit->target_copy($copy->id);
1138 $transit->source_send_time('now');
1139 $transit->copy_status(OILS_COPY_STATUS_ON_HOLDS_SHELF);
1141 $copy->status(OILS_COPY_STATUS_IN_TRANSIT);
1142 $copy->editor($e->requestor->id);
1143 $copy->edit_date('now');
1145 $e->create_action_hold_transit_copy($transit) or return $e->die_event;
1146 $e->update_asset_copy($copy) or return $e->die_event;
1150 # if the hold is frozen, this method ensures that the hold is not "targeted",
1151 # that is, it clears the current_copy and prev_check_time to essentiallly
1152 # reset the hold. If it is being activated, it runs the targeter in the background
1153 sub update_hold_if_frozen {
1154 my($self, $e, $hold, $orig_hold) = @_;
1155 return if $hold->capture_time;
1157 if($U->is_true($hold->frozen)) {
1158 $logger->info("clearing current_copy and check_time for frozen hold ".$hold->id);
1159 $hold->clear_current_copy;
1160 $hold->clear_prev_check_time;
1163 if($U->is_true($orig_hold->frozen)) {
1164 $logger->info("Running targeter on activated hold ".$hold->id);
1165 $U->simplereq('open-ils.hold-targeter',
1166 'open-ils.hold-targeter.target', {hold => $hold->id});
1171 __PACKAGE__->register_method(
1172 method => "hold_note_CUD",
1173 api_name => "open-ils.circ.hold_request.note.cud",
1175 desc => 'Create, update or delete a hold request note. If the operator (from Auth. token) '
1176 . 'is not the owner of the hold, the UPDATE_HOLD permission is required',
1178 { desc => 'Authentication token', type => 'string' },
1179 { desc => 'Hold note object', type => 'object' }
1182 desc => 'Returns the note ID, event on error'
1188 my($self, $conn, $auth, $note) = @_;
1190 my $e = new_editor(authtoken => $auth, xact => 1);
1191 return $e->die_event unless $e->checkauth;
1193 my $hold = $e->retrieve_action_hold_request($note->hold)
1194 or return $e->die_event;
1196 if($hold->usr ne $e->requestor->id) {
1197 my $usr = $e->retrieve_actor_user($hold->usr);
1198 return $e->die_event unless $e->allowed('UPDATE_HOLD', $usr->home_ou);
1199 $note->staff('t') if $note->isnew;
1203 $e->create_action_hold_request_note($note) or return $e->die_event;
1204 } elsif($note->ischanged) {
1205 $e->update_action_hold_request_note($note) or return $e->die_event;
1206 } elsif($note->isdeleted) {
1207 $e->delete_action_hold_request_note($note) or return $e->die_event;
1215 __PACKAGE__->register_method(
1216 method => "retrieve_hold_status",
1217 api_name => "open-ils.circ.hold.status.retrieve",
1219 desc => 'Calculates the current status of the hold. The requestor must have ' .
1220 'VIEW_HOLD permissions if the hold is for a user other than the requestor' ,
1222 { desc => 'Hold ID', type => 'number' }
1225 # type => 'number', # event sometimes
1226 desc => <<'END_OF_DESC'
1227 Returns event on error or:
1228 -1 on error (for now),
1229 1 for 'waiting for copy to become available',
1230 2 for 'waiting for copy capture',
1233 5 for 'hold-shelf-delay'
1236 8 for 'captured, on wrong hold shelf'
1243 sub retrieve_hold_status {
1244 my($self, $client, $auth, $hold_id) = @_;
1246 my $e = new_editor(authtoken => $auth);
1247 return $e->event unless $e->checkauth;
1248 my $hold = $e->retrieve_action_hold_request($hold_id)
1249 or return $e->event;
1251 if( $e->requestor->id != $hold->usr ) {
1252 return $e->event unless $e->allowed('VIEW_HOLD');
1255 return _hold_status($e, $hold);
1261 if ($hold->cancel_time) {
1264 if ($U->is_true($hold->frozen) && !$hold->capture_time) {
1267 if ($hold->current_shelf_lib and $hold->current_shelf_lib ne $hold->pickup_lib) {
1270 if ($hold->fulfillment_time) {
1273 return 1 unless $hold->current_copy;
1274 return 2 unless $hold->capture_time;
1276 my $copy = $hold->current_copy;
1277 unless( ref $copy ) {
1278 $copy = $e->retrieve_asset_copy($hold->current_copy)
1279 or return $e->event;
1282 return 3 if $copy->status == OILS_COPY_STATUS_IN_TRANSIT;
1284 if($copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF) {
1286 my $hs_wait_interval = $U->ou_ancestor_setting_value($hold->pickup_lib, 'circ.hold_shelf_status_delay');
1287 return 4 unless $hs_wait_interval;
1289 # if a hold_shelf_status_delay interval is defined and start_time plus
1290 # the interval is greater than now, consider the hold to be in the virtual
1291 # "on its way to the holds shelf" status. Return 5.
1293 my $transit = $e->search_action_hold_transit_copy({
1295 target_copy => $copy->id,
1296 dest_recv_time => {'!=' => undef},
1298 my $start_time = ($transit) ? $transit->dest_recv_time : $hold->capture_time;
1299 $start_time = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($start_time));
1300 my $end_time = $start_time->add(seconds => OpenSRF::Utils::interval_to_seconds($hs_wait_interval));
1302 return 5 if $end_time > DateTime->now;
1311 __PACKAGE__->register_method(
1312 method => "retrieve_hold_queue_stats",
1313 api_name => "open-ils.circ.hold.queue_stats.retrieve",
1315 desc => 'Returns summary data about the state of a hold',
1317 { desc => 'Authentication token', type => 'string'},
1318 { desc => 'Hold ID', type => 'number'},
1321 desc => q/Summary object with keys:
1322 total_holds : total holds in queue
1323 queue_position : current queue position
1324 potential_copies : number of potential copies for this hold
1325 estimated_wait : estimated wait time in days
1326 status : hold status
1327 -1 => error or unexpected state,
1328 1 => 'waiting for copy to become available',
1329 2 => 'waiting for copy capture',
1332 5 => 'hold-shelf-delay'
1339 sub retrieve_hold_queue_stats {
1340 my($self, $conn, $auth, $hold_id) = @_;
1341 my $e = new_editor(authtoken => $auth);
1342 return $e->event unless $e->checkauth;
1343 my $hold = $e->retrieve_action_hold_request($hold_id) or return $e->event;
1344 if($e->requestor->id != $hold->usr) {
1345 return $e->event unless $e->allowed('VIEW_HOLD');
1347 return retrieve_hold_queue_status_impl($e, $hold);
1350 sub retrieve_hold_queue_status_impl {
1354 # The holds queue is defined as the distinct set of holds that share at
1355 # least one potential copy with the context hold, plus any holds that
1356 # share the same hold type and target. The latter part exists to
1357 # accomodate holds that currently have no potential copies
1358 my $q_holds = $e->json_query({
1360 # fetch cut_in_line and request_time since they're in the order_by
1361 # and we're asking for distinct values
1362 select => {ahr => ['id', 'cut_in_line', 'request_time']},
1366 select => { ahcm => ['hold'] },
1371 'field' => 'target_copy',
1372 'fkey' => 'target_copy'
1376 where => { '+ahcm2' => { hold => $hold->id } },
1383 "field" => "cut_in_line",
1384 "transform" => "coalesce",
1386 "direction" => "desc"
1388 { "class" => "ahr", "field" => "request_time" }
1393 if (!@$q_holds) { # none? maybe we don't have a map ...
1394 $q_holds = $e->json_query({
1395 select => {ahr => ['id', 'cut_in_line', 'request_time']},
1400 "field" => "cut_in_line",
1401 "transform" => "coalesce",
1403 "direction" => "desc"
1405 { "class" => "ahr", "field" => "request_time" }
1408 hold_type => $hold->hold_type,
1409 target => $hold->target,
1410 capture_time => undef,
1411 cancel_time => undef,
1413 {expire_time => undef },
1414 {expire_time => {'>' => 'now'}}
1422 for my $h (@$q_holds) {
1423 last if $h->{id} == $hold->id;
1427 my $hold_data = $e->json_query({
1429 acp => [ {column => 'id', transform => 'count', aggregate => 1, alias => 'count'} ],
1430 ccm => [ {column =>'avg_wait_time'} ]
1436 ccm => {type => 'left'}
1441 where => {'+ahcm' => {hold => $hold->id} }
1444 my $user_org = $e->json_query({select => {au => ['home_ou']}, from => 'au', where => {id => $hold->usr}})->[0]->{home_ou};
1446 my $default_wait = $U->ou_ancestor_setting_value(
1447 $user_org, OILS_SETTING_HOLD_ESIMATE_WAIT_INTERVAL, $e);
1448 my $min_wait = $U->ou_ancestor_setting_value(
1449 $user_org, 'circ.holds.min_estimated_wait_interval', $e);
1450 $min_wait = OpenSRF::Utils::interval_to_seconds($min_wait || '0 seconds');
1451 $default_wait ||= '0 seconds';
1453 # Estimated wait time is the average wait time across the set
1454 # of potential copies, divided by the number of potential copies
1455 # times the queue position.
1457 my $combined_secs = 0;
1458 my $num_potentials = 0;
1460 for my $wait_data (@$hold_data) {
1461 my $count += $wait_data->{count};
1462 $combined_secs += $count *
1463 OpenSRF::Utils::interval_to_seconds($wait_data->{avg_wait_time} || $default_wait);
1464 $num_potentials += $count;
1467 my $estimated_wait = -1;
1469 if($num_potentials) {
1470 my $avg_wait = $combined_secs / $num_potentials;
1471 $estimated_wait = $qpos * ($avg_wait / $num_potentials);
1472 $estimated_wait = $min_wait if $estimated_wait < $min_wait and $estimated_wait != -1;
1476 total_holds => scalar(@$q_holds),
1477 queue_position => $qpos,
1478 potential_copies => $num_potentials,
1479 status => _hold_status( $e, $hold ),
1480 estimated_wait => int($estimated_wait)
1485 sub fetch_open_hold_by_current_copy {
1488 my $hold = $apputils->simplereq(
1490 'open-ils.cstore.direct.action.hold_request.search.atomic',
1491 { current_copy => $copyid , cancel_time => undef, fulfillment_time => undef });
1492 return $hold->[0] if ref($hold);
1496 sub fetch_related_holds {
1499 return $apputils->simplereq(
1501 'open-ils.cstore.direct.action.hold_request.search.atomic',
1502 { current_copy => $copyid , cancel_time => undef, fulfillment_time => undef });
1506 __PACKAGE__->register_method(
1507 method => "hold_pull_list",
1508 api_name => "open-ils.circ.hold_pull_list.retrieve",
1510 desc => 'Returns (reference to) a list of holds that need to be "pulled" by a given location. ' .
1511 'The location is determined by the login session.',
1513 { desc => 'Limit (optional)', type => 'number'},
1514 { desc => 'Offset (optional)', type => 'number'},
1517 desc => 'reference to a list of holds, or event on failure',
1522 __PACKAGE__->register_method(
1523 method => "hold_pull_list",
1524 api_name => "open-ils.circ.hold_pull_list.id_list.retrieve",
1526 desc => 'Returns (reference to) a list of holds IDs that need to be "pulled" by a given location. ' .
1527 'The location is determined by the login session.',
1529 { desc => 'Limit (optional)', type => 'number'},
1530 { desc => 'Offset (optional)', type => 'number'},
1533 desc => 'reference to a list of holds, or event on failure',
1538 __PACKAGE__->register_method(
1539 method => "hold_pull_list",
1540 api_name => "open-ils.circ.hold_pull_list.retrieve.count",
1542 desc => 'Returns a count of holds that need to be "pulled" by a given location. ' .
1543 'The location is determined by the login session.',
1545 { desc => 'Limit (optional)', type => 'number'},
1546 { desc => 'Offset (optional)', type => 'number'},
1549 desc => 'Holds count (integer), or event on failure',
1555 __PACKAGE__->register_method(
1556 method => "hold_pull_list",
1558 # TODO: tag with api_level 2 once fully supported
1559 api_name => "open-ils.circ.hold_pull_list.fleshed.stream",
1561 desc => q/Returns a stream of fleshed holds that need to be
1562 "pulled" by a given location. The location is
1563 determined by the login session.
1564 This API calls always run in authoritative mode./,
1566 { desc => 'Limit (optional)', type => 'number'},
1567 { desc => 'Offset (optional)', type => 'number'},
1570 desc => 'Stream of holds holds, or event on failure',
1575 sub hold_pull_list {
1576 my( $self, $conn, $authtoken, $limit, $offset ) = @_;
1577 my( $reqr, $evt ) = $U->checkses($authtoken);
1578 return $evt if $evt;
1580 my $org = $reqr->ws_ou || $reqr->home_ou;
1581 # the perm locaiton shouldn't really matter here since holds
1582 # will exist all over and VIEW_HOLDS should be universal
1583 $evt = $U->check_perms($reqr->id, $org, 'VIEW_HOLD');
1584 return $evt if $evt;
1586 if($self->api_name =~ /count/) {
1588 my $count = $U->storagereq(
1589 'open-ils.storage.direct.action.hold_request.pull_list.current_copy_circ_lib.status_filtered.count',
1590 $org, $limit, $offset );
1592 $logger->info("Grabbing pull list for org unit $org with $count items");
1595 } elsif( $self->api_name =~ /id_list/ ) {
1597 'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib.status_filtered.atomic',
1598 $org, $limit, $offset );
1600 } elsif ($self->api_name =~ /fleshed/) {
1602 my $ids = $U->storagereq(
1603 'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib.status_filtered.atomic',
1604 $org, $limit, $offset );
1606 my $e = new_editor(xact => 1, requestor => $reqr);
1607 $conn->respond(uber_hold_impl($e, $_, {flesh_acpl => 1})) for @$ids;
1609 $conn->respond_complete;
1614 'open-ils.storage.direct.action.hold_request.pull_list.search.current_copy_circ_lib.status_filtered.atomic',
1615 $org, $limit, $offset );
1619 __PACKAGE__->register_method(
1620 method => "print_hold_pull_list",
1621 api_name => "open-ils.circ.hold_pull_list.print",
1623 desc => 'Returns an HTML-formatted holds pull list',
1625 { desc => 'Authtoken', type => 'string'},
1626 { desc => 'Org unit ID. Optional, defaults to workstation org unit', type => 'number'},
1629 desc => 'HTML string',
1635 sub print_hold_pull_list {
1636 my($self, $client, $auth, $org_id) = @_;
1638 my $e = new_editor(authtoken=>$auth);
1639 return $e->event unless $e->checkauth;
1641 $org_id = (defined $org_id) ? $org_id : $e->requestor->ws_ou;
1642 return $e->event unless $e->allowed('VIEW_HOLD', $org_id);
1644 my $hold_ids = $U->storagereq(
1645 'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib.status_filtered.atomic',
1648 return undef unless @$hold_ids;
1650 $client->status(new OpenSRF::DomainObject::oilsContinueStatus);
1652 # Holds will /NOT/ be in order after this ...
1653 my $holds = $e->search_action_hold_request({id => $hold_ids}, {substream => 1});
1654 $client->status(new OpenSRF::DomainObject::oilsContinueStatus);
1656 # ... so we must resort.
1657 my $hold_map = +{map { $_->id => $_ } @$holds};
1658 my $sorted_holds = [];
1659 push @$sorted_holds, $hold_map->{$_} foreach @$hold_ids;
1661 return $U->fire_object_event(
1662 undef, "ahr.format.pull_list", $sorted_holds,
1663 $org_id, undef, undef, $client
1668 __PACKAGE__->register_method(
1669 method => "print_hold_pull_list_stream",
1671 api_name => "open-ils.circ.hold_pull_list.print.stream",
1673 desc => 'Returns a stream of fleshed holds',
1675 { desc => 'Authtoken', type => 'string'},
1676 { 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)',
1681 desc => 'A stream of fleshed holds',
1687 sub print_hold_pull_list_stream {
1688 my($self, $client, $auth, $params) = @_;
1690 my $e = new_editor(authtoken=>$auth);
1691 return $e->die_event unless $e->checkauth;
1693 delete($$params{org_id}) unless (int($$params{org_id}));
1694 delete($$params{limit}) unless (int($$params{limit}));
1695 delete($$params{offset}) unless (int($$params{offset}));
1696 delete($$params{chunk_size}) unless (int($$params{chunk_size}));
1697 delete($$params{chunk_size}) if ($$params{chunk_size} && $$params{chunk_size} > 50); # keep the size reasonable
1698 $$params{chunk_size} ||= 10;
1699 $client->max_chunk_size($$params{chunk_size}) if (!$client->can('max_bundle_size') && $client->can('max_chunk_size'));
1701 $$params{org_id} = (defined $$params{org_id}) ? $$params{org_id}: $e->requestor->ws_ou;
1702 return $e->die_event unless $e->allowed('VIEW_HOLD', $$params{org_id });
1705 if ($$params{sort} && @{ $$params{sort} }) {
1706 for my $s (@{ $$params{sort} }) {
1707 if ($s eq 'acplo.position') {
1709 "class" => "acplo", "field" => "position",
1710 "transform" => "coalesce", "params" => [999]
1712 } elsif ($s eq 'prefix') {
1713 push @$sort, {"class" => "acnp", "field" => "label_sortkey"};
1714 } elsif ($s eq 'call_number') {
1715 push @$sort, {"class" => "acn", "field" => "label_sortkey"};
1716 } elsif ($s eq 'suffix') {
1717 push @$sort, {"class" => "acns", "field" => "label_sortkey"};
1718 } elsif ($s eq 'request_time') {
1719 push @$sort, {"class" => "ahr", "field" => "request_time"};
1723 push @$sort, {"class" => "ahr", "field" => "request_time"};
1726 my $holds_ids = $e->json_query(
1728 "select" => {"ahr" => ["id"]},
1733 "fkey" => "current_copy",
1735 "circ_lib" => $$params{org_id}, "status" => [0,7]
1740 "fkey" => "call_number",
1754 "fkey" => "circ_lib",
1757 "location" => {"=" => {"+acp" => "location"}}
1766 "capture_time" => undef,
1767 "cancel_time" => undef,
1769 {"expire_time" => undef },
1770 {"expire_time" => {">" => "now"}}
1774 (@$sort ? (order_by => $sort) : ()),
1775 ($$params{limit} ? (limit => $$params{limit}) : ()),
1776 ($$params{offset} ? (offset => $$params{offset}) : ())
1777 }, {"substream" => 1}
1778 ) or return $e->die_event;
1780 $logger->info("about to stream back " . scalar(@$holds_ids) . " holds");
1783 for my $hid (@$holds_ids) {
1784 push @chunk, $e->retrieve_action_hold_request([
1788 "ahr" => ["usr", "current_copy"],
1790 "acp" => ["location", "call_number", "parts"],
1791 "acn" => ["record","prefix","suffix"]
1796 if (@chunk >= $$params{chunk_size}) {
1797 $client->respond( \@chunk );
1801 $client->respond_complete( \@chunk ) if (@chunk);
1808 __PACKAGE__->register_method(
1809 method => 'fetch_hold_notify',
1810 api_name => 'open-ils.circ.hold_notification.retrieve_by_hold',
1813 Returns a list of hold notification objects based on hold id.
1814 @param authtoken The loggin session key
1815 @param holdid The id of the hold whose notifications we want to retrieve
1816 @return An array of hold notification objects, event on error.
1820 sub fetch_hold_notify {
1821 my( $self, $conn, $authtoken, $holdid ) = @_;
1822 my( $requestor, $evt ) = $U->checkses($authtoken);
1823 return $evt if $evt;
1824 my ($hold, $patron);
1825 ($hold, $evt) = $U->fetch_hold($holdid);
1826 return $evt if $evt;
1827 ($patron, $evt) = $U->fetch_user($hold->usr);
1828 return $evt if $evt;
1830 $evt = $U->check_perms($requestor->id, $patron->home_ou, 'VIEW_HOLD_NOTIFICATION');
1831 return $evt if $evt;
1833 $logger->info("User ".$requestor->id." fetching hold notifications for hold $holdid");
1834 return $U->cstorereq(
1835 'open-ils.cstore.direct.action.hold_notification.search.atomic', {hold => $holdid} );
1839 __PACKAGE__->register_method(
1840 method => 'create_hold_notify',
1841 api_name => 'open-ils.circ.hold_notification.create',
1843 Creates a new hold notification object
1844 @param authtoken The login session key
1845 @param notification The hold notification object to create
1846 @return ID of the new object on success, Event on error
1850 sub create_hold_notify {
1851 my( $self, $conn, $auth, $note ) = @_;
1852 my $e = new_editor(authtoken=>$auth, xact=>1);
1853 return $e->die_event unless $e->checkauth;
1855 my $hold = $e->retrieve_action_hold_request($note->hold)
1856 or return $e->die_event;
1857 my $patron = $e->retrieve_actor_user($hold->usr)
1858 or return $e->die_event;
1860 return $e->die_event unless
1861 $e->allowed('CREATE_HOLD_NOTIFICATION', $patron->home_ou);
1863 $note->notify_staff($e->requestor->id);
1864 $e->create_action_hold_notification($note) or return $e->die_event;
1869 __PACKAGE__->register_method(
1870 method => 'create_hold_note',
1871 api_name => 'open-ils.circ.hold_note.create',
1873 Creates a new hold request note object
1874 @param authtoken The login session key
1875 @param note The hold note object to create
1876 @return ID of the new object on success, Event on error
1880 sub create_hold_note {
1881 my( $self, $conn, $auth, $note ) = @_;
1882 my $e = new_editor(authtoken=>$auth, xact=>1);
1883 return $e->die_event unless $e->checkauth;
1885 my $hold = $e->retrieve_action_hold_request($note->hold)
1886 or return $e->die_event;
1887 my $patron = $e->retrieve_actor_user($hold->usr)
1888 or return $e->die_event;
1890 return $e->die_event unless
1891 $e->allowed('UPDATE_HOLD', $patron->home_ou); # FIXME: Using permcrud perm listed in fm_IDL.xml for ahrn. Probably want something more specific
1893 $e->create_action_hold_request_note($note) or return $e->die_event;
1898 __PACKAGE__->register_method(
1899 method => 'reset_hold',
1900 api_name => 'open-ils.circ.hold.reset',
1902 Un-captures and un-targets a hold, essentially returning
1903 it to the state it was in directly after it was placed,
1904 then attempts to re-target the hold
1905 @param authtoken The login session key
1906 @param holdid The id of the hold
1912 my( $self, $conn, $auth, $holdid ) = @_;
1914 my ($hold, $evt) = $U->fetch_hold($holdid);
1915 return $evt if $evt;
1916 ($reqr, $evt) = $U->checksesperm($auth, 'UPDATE_HOLD');
1917 return $evt if $evt;
1918 $evt = _reset_hold($self, $reqr, $hold);
1919 return $evt if $evt;
1924 __PACKAGE__->register_method(
1925 method => 'reset_hold_batch',
1926 api_name => 'open-ils.circ.hold.reset.batch'
1929 sub reset_hold_batch {
1930 my($self, $conn, $auth, $hold_ids) = @_;
1932 my $e = new_editor(authtoken => $auth);
1933 return $e->event unless $e->checkauth;
1935 for my $hold_id ($hold_ids) {
1937 my $hold = $e->retrieve_action_hold_request(
1938 [$hold_id, {flesh => 1, flesh_fields => {ahr => ['usr']}}])
1939 or return $e->event;
1941 next unless $e->allowed('UPDATE_HOLD', $hold->usr->home_ou);
1942 _reset_hold($self, $e->requestor, $hold);
1950 my ($self, $reqr, $hold) = @_;
1952 my $e = new_editor(xact =>1, requestor => $reqr);
1954 $logger->info("reseting hold ".$hold->id);
1956 my $hid = $hold->id;
1958 if( $hold->capture_time and $hold->current_copy ) {
1960 my $copy = $e->retrieve_asset_copy($hold->current_copy)
1961 or return $e->die_event;
1963 if( $copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF ) {
1964 $logger->info("setting copy to status 'reshelving' on hold retarget");
1965 $copy->status(OILS_COPY_STATUS_RESHELVING);
1966 $copy->editor($e->requestor->id);
1967 $copy->edit_date('now');
1968 $e->update_asset_copy($copy) or return $e->die_event;
1970 } elsif( $copy->status == OILS_COPY_STATUS_IN_TRANSIT ) {
1972 # We don't want the copy to remain "in transit"
1973 $copy->status(OILS_COPY_STATUS_RESHELVING);
1974 $logger->warn("! reseting hold [$hid] that is in transit");
1975 my $transid = $e->search_action_hold_transit_copy({hold=>$hold->id},{idlist=>1})->[0];
1978 my $trans = $e->retrieve_action_transit_copy($transid);
1980 $logger->info("Aborting transit [$transid] on hold [$hid] reset...");
1981 my $evt = OpenILS::Application::Circ::Transit::__abort_transit($e, $trans, $copy, 1, 1);
1982 $logger->info("Transit abort completed with result $evt");
1983 unless ("$evt" eq 1) {
1992 $hold->clear_capture_time;
1993 $hold->clear_current_copy;
1994 $hold->clear_shelf_time;
1995 $hold->clear_shelf_expire_time;
1996 $hold->clear_current_shelf_lib;
1998 $e->update_action_hold_request($hold) or return $e->die_event;
2001 $U->simplereq('open-ils.hold-targeter',
2002 'open-ils.hold-targeter.target', {hold => $hold->id});
2008 __PACKAGE__->register_method(
2009 method => 'fetch_open_title_holds',
2010 api_name => 'open-ils.circ.open_holds.retrieve',
2012 Returns a list ids of un-fulfilled holds for a given title id
2013 @param authtoken The login session key
2014 @param id the id of the item whose holds we want to retrieve
2015 @param type The hold type - M, T, I, V, C, F, R
2019 sub fetch_open_title_holds {
2020 my( $self, $conn, $auth, $id, $type, $org ) = @_;
2021 my $e = new_editor( authtoken => $auth );
2022 return $e->event unless $e->checkauth;
2025 $org ||= $e->requestor->ws_ou;
2027 # return $e->search_action_hold_request(
2028 # { target => $id, hold_type => $type, fulfillment_time => undef }, {idlist=>1});
2030 # XXX make me return IDs in the future ^--
2031 my $holds = $e->search_action_hold_request(
2034 cancel_time => undef,
2036 fulfillment_time => undef
2040 flesh_hold_transits($holds);
2045 sub flesh_hold_transits {
2047 for my $hold ( @$holds ) {
2049 $apputils->simplereq(
2051 "open-ils.cstore.direct.action.hold_transit_copy.search.atomic",
2052 { hold => $hold->id },
2053 { order_by => { ahtc => 'id desc' }, limit => 1 }
2059 sub flesh_hold_notices {
2060 my( $holds, $e ) = @_;
2061 $e ||= new_editor();
2063 for my $hold (@$holds) {
2064 my $notices = $e->search_action_hold_notification(
2066 { hold => $hold->id },
2067 { order_by => { anh => 'notify_time desc' } },
2072 $hold->notify_count(scalar(@$notices));
2074 my $n = $e->retrieve_action_hold_notification($$notices[0])
2075 or return $e->event;
2076 $hold->notify_time($n->notify_time);
2082 __PACKAGE__->register_method(
2083 method => 'fetch_captured_holds',
2084 api_name => 'open-ils.circ.captured_holds.on_shelf.retrieve',
2088 Returns a list of un-fulfilled holds (on the Holds Shelf) for a given title id
2089 @param authtoken The login session key
2090 @param org The org id of the location in question
2091 @param match_copy A specific copy to limit to
2095 __PACKAGE__->register_method(
2096 method => 'fetch_captured_holds',
2097 api_name => 'open-ils.circ.captured_holds.id_list.on_shelf.retrieve',
2101 Returns list ids of un-fulfilled holds (on the Holds Shelf) for a given title id
2102 @param authtoken The login session key
2103 @param org The org id of the location in question
2104 @param match_copy A specific copy to limit to
2108 __PACKAGE__->register_method(
2109 method => 'fetch_captured_holds',
2110 api_name => 'open-ils.circ.captured_holds.id_list.expired_on_shelf.retrieve',
2114 Returns list ids of shelf-expired un-fulfilled holds for a given title id
2115 @param authtoken The login session key
2116 @param org The org id of the location in question
2117 @param match_copy A specific copy to limit to
2121 __PACKAGE__->register_method(
2122 method => 'fetch_captured_holds',
2124 'open-ils.circ.captured_holds.expired_on_shelf_or_wrong_shelf.retrieve',
2128 Returns list of shelf-expired un-fulfilled holds OR wrong shelf holds
2129 for a given shelf lib
2133 __PACKAGE__->register_method(
2134 method => 'fetch_captured_holds',
2136 'open-ils.circ.captured_holds.id_list.expired_on_shelf_or_wrong_shelf.retrieve',
2140 Returns list of shelf-expired un-fulfilled holds OR wrong shelf holds
2141 for a given shelf lib
2146 sub fetch_captured_holds {
2147 my( $self, $conn, $auth, $org, $match_copy ) = @_;
2149 my $e = new_editor(authtoken => $auth);
2150 return $e->die_event unless $e->checkauth;
2151 return $e->die_event unless $e->allowed('VIEW_HOLD'); # XXX rely on editor perm
2153 $org ||= $e->requestor->ws_ou;
2155 my $current_copy = { '!=' => undef };
2156 $current_copy = { '=' => $match_copy } if $match_copy;
2159 select => { alhr => ['id'] },
2164 fkey => 'current_copy'
2169 '+acp' => { status => OILS_COPY_STATUS_ON_HOLDS_SHELF, deleted => 'f' },
2171 capture_time => { "!=" => undef },
2172 current_copy => $current_copy,
2173 fulfillment_time => undef,
2174 current_shelf_lib => $org
2178 if($self->api_name =~ /expired/) {
2179 $query->{'where'}->{'+alhr'}->{'-or'} = {
2180 shelf_expire_time => { '<' => 'today'},
2181 cancel_time => { '!=' => undef },
2184 my $hold_ids = $e->json_query( $query );
2186 if ($self->api_name =~ /wrong_shelf/) {
2187 # fetch holds whose current_shelf_lib is $org, but whose pickup
2188 # lib is some other org unit. Ignore already-retrieved holds.
2190 pickup_lib_changed_on_shelf_holds(
2191 $e, $org, [map {$_->{id}} @$hold_ids]);
2192 # match the layout of other items in $hold_ids
2193 push (@$hold_ids, {id => $_}) for @$wrong_shelf;
2197 for my $hold_id (@$hold_ids) {
2198 if($self->api_name =~ /id_list/) {
2199 $conn->respond($hold_id->{id});
2203 $e->retrieve_action_hold_request([
2207 flesh_fields => {ahr => ['notifications', 'transit', 'notes']},
2208 order_by => {anh => 'notify_time desc'}
2218 __PACKAGE__->register_method(
2219 method => "print_expired_holds_stream",
2220 api_name => "open-ils.circ.captured_holds.expired.print.stream",
2224 sub print_expired_holds_stream {
2225 my ($self, $client, $auth, $params) = @_;
2227 # No need to check specific permissions: we're going to call another method
2228 # that will do that.
2229 my $e = new_editor("authtoken" => $auth);
2230 return $e->die_event unless $e->checkauth;
2232 delete($$params{org_id}) unless (int($$params{org_id}));
2233 delete($$params{limit}) unless (int($$params{limit}));
2234 delete($$params{offset}) unless (int($$params{offset}));
2235 delete($$params{chunk_size}) unless (int($$params{chunk_size}));
2236 delete($$params{chunk_size}) if ($$params{chunk_size} && $$params{chunk_size} > 50); # keep the size reasonable
2237 $$params{chunk_size} ||= 10;
2238 $client->max_chunk_size($$params{chunk_size}) if (!$client->can('max_bundle_size') && $client->can('max_chunk_size'));
2240 $$params{org_id} = (defined $$params{org_id}) ? $$params{org_id}: $e->requestor->ws_ou;
2242 my @hold_ids = $self->method_lookup(
2243 "open-ils.circ.captured_holds.id_list.expired_on_shelf.retrieve"
2244 )->run($auth, $params->{"org_id"});
2249 } elsif (defined $U->event_code($hold_ids[0])) {
2251 return $hold_ids[0];
2254 $logger->info("about to stream back up to " . scalar(@hold_ids) . " expired holds");
2257 my @hid_chunk = splice @hold_ids, 0, $params->{"chunk_size"};
2259 my $result_chunk = $e->json_query({
2261 "acp" => ["barcode"],
2263 first_given_name second_given_name family_name alias
2272 "field" => "id", "fkey" => "current_copy",
2275 "field" => "id", "fkey" => "call_number",
2278 "field" => "id", "fkey" => "record"
2282 "acpl" => {"field" => "id", "fkey" => "location"}
2285 "au" => {"field" => "id", "fkey" => "usr"}
2288 "where" => {"+ahr" => {"id" => \@hid_chunk}}
2289 }) or return $e->die_event;
2290 $client->respond($result_chunk);
2297 __PACKAGE__->register_method(
2298 method => "check_title_hold_batch",
2299 api_name => "open-ils.circ.title_hold.is_possible.batch",
2302 desc => '@see open-ils.circ.title_hold.is_possible.batch',
2304 { desc => 'Authentication token', type => 'string'},
2305 { desc => 'Array of Hash of named parameters', type => 'array'},
2308 desc => 'Array of response objects',
2314 sub check_title_hold_batch {
2315 my($self, $client, $authtoken, $param_list, $oargs) = @_;
2316 foreach (@$param_list) {
2317 my ($res) = $self->method_lookup('open-ils.circ.title_hold.is_possible')->run($authtoken, $_, $oargs);
2318 $client->respond($res);
2324 __PACKAGE__->register_method(
2325 method => "check_title_hold",
2326 api_name => "open-ils.circ.title_hold.is_possible",
2328 desc => 'Determines if a hold were to be placed by a given user, ' .
2329 'whether or not said hold would have any potential copies to fulfill it.' .
2330 'The named paramaters of the second argument include: ' .
2331 'patronid, titleid, volume_id, copy_id, mrid, depth, pickup_lib, hold_type, selection_ou. ' .
2332 'See perldoc ' . __PACKAGE__ . ' for more info on these fields.' ,
2334 { desc => 'Authentication token', type => 'string'},
2335 { desc => 'Hash of named parameters', type => 'object'},
2338 desc => 'List of new message IDs (empty if none)',
2344 =head3 check_title_hold (token, hash)
2346 The named fields in the hash are:
2348 patronid - ID of the hold recipient (required)
2349 depth - hold range depth (default 0)
2350 pickup_lib - destination for hold, fallback value for selection_ou
2351 selection_ou - ID of org_unit establishing hard and soft hold boundary settings
2352 issuanceid - ID of the issuance to be held, required for Issuance level hold
2353 partid - ID of the monograph part to be held, required for monograph part level hold
2354 titleid - ID (BRN) of the title to be held, required for Title level hold
2355 volume_id - required for Volume level hold
2356 copy_id - required for Copy level hold
2357 mrid - required for Meta-record level hold
2358 hold_type - T, C (or R or F), I, V or M for Title, Copy, Issuance, Volume or Meta-record (default "T")
2360 All key/value pairs are passed on to do_possibility_checks.
2364 # FIXME: better params checking. what other params are required, if any?
2365 # FIXME: 3 copies of values confusing: $x, $params->{x} and $params{x}
2366 # FIXME: for example, $depth gets a default value, but then $$params{depth} is still
2367 # used in conditionals, where it may be undefined, causing a warning.
2368 # FIXME: specify proper usage/interaction of selection_ou and pickup_lib
2370 sub check_title_hold {
2371 my( $self, $client, $authtoken, $params ) = @_;
2372 my $e = new_editor(authtoken=>$authtoken);
2373 return $e->event unless $e->checkauth;
2375 my %params = %$params;
2376 my $depth = $params{depth} || 0;
2377 my $selection_ou = $params{selection_ou} || $params{pickup_lib};
2378 my $oargs = $params{oargs} || {};
2380 if($oargs->{events}) {
2381 @{$oargs->{events}} = grep { $e->allowed($_ . '.override', $e->requestor->ws_ou); } @{$oargs->{events}};
2385 my $patron = $e->retrieve_actor_user($params{patronid})
2386 or return $e->event;
2388 if( $e->requestor->id ne $patron->id ) {
2389 return $e->event unless
2390 $e->allowed('VIEW_HOLD_PERMIT', $patron->home_ou);
2393 return OpenILS::Event->new('PATRON_BARRED') if $U->is_true($patron->barred);
2395 my $request_lib = $e->retrieve_actor_org_unit($e->requestor->ws_ou)
2396 or return $e->event;
2398 my $soft_boundary = $U->ou_ancestor_setting_value($selection_ou, OILS_SETTING_HOLD_SOFT_BOUNDARY);
2399 my $hard_boundary = $U->ou_ancestor_setting_value($selection_ou, OILS_SETTING_HOLD_HARD_BOUNDARY);
2402 my $return_depth = $hard_boundary; # default depth to return on success
2403 if(defined $soft_boundary and $depth < $soft_boundary) {
2404 # work up the tree and as soon as we find a potential copy, use that depth
2405 # also, make sure we don't go past the hard boundary if it exists
2407 # our min boundary is the greater of user-specified boundary or hard boundary
2408 my $min_depth = (defined $hard_boundary and $hard_boundary > $depth) ?
2409 $hard_boundary : $depth;
2411 my $depth = $soft_boundary;
2412 while($depth >= $min_depth) {
2413 $logger->info("performing hold possibility check with soft boundary $depth");
2414 @status = do_possibility_checks($e, $patron, $request_lib, $depth, %params);
2416 $return_depth = $depth;
2421 } elsif(defined $hard_boundary and $depth < $hard_boundary) {
2422 # there is no soft boundary, enforce the hard boundary if it exists
2423 $logger->info("performing hold possibility check with hard boundary $hard_boundary");
2424 @status = do_possibility_checks($e, $patron, $request_lib, $hard_boundary, %params);
2426 # no boundaries defined, fall back to user specifed boundary or no boundary
2427 $logger->info("performing hold possibility check with no boundary");
2428 @status = do_possibility_checks($e, $patron, $request_lib, $params{depth}, %params);
2431 my $place_unfillable = 0;
2432 $place_unfillable = 1 if $e->allowed('PLACE_UNFILLABLE_HOLD', $e->requestor->ws_ou);
2437 "depth" => $return_depth,
2438 "local_avail" => $status[1]
2440 } elsif ($status[2]) {
2441 my $n = scalar @{$status[2]};
2442 return {"success" => 0, "last_event" => $status[2]->[$n - 1], "age_protected_copy" => $status[3], "place_unfillable" => $place_unfillable};
2444 return {"success" => 0, "age_protected_copy" => $status[3], "place_unfillable" => $place_unfillable};
2450 sub do_possibility_checks {
2451 my($e, $patron, $request_lib, $depth, %params) = @_;
2453 my $issuanceid = $params{issuanceid} || "";
2454 my $partid = $params{partid} || "";
2455 my $titleid = $params{titleid} || "";
2456 my $volid = $params{volume_id};
2457 my $copyid = $params{copy_id};
2458 my $mrid = $params{mrid} || "";
2459 my $pickup_lib = $params{pickup_lib};
2460 my $hold_type = $params{hold_type} || 'T';
2461 my $selection_ou = $params{selection_ou} || $pickup_lib;
2462 my $holdable_formats = $params{holdable_formats};
2463 my $oargs = $params{oargs} || {};
2470 if( $hold_type eq OILS_HOLD_TYPE_FORCE || $hold_type eq OILS_HOLD_TYPE_RECALL || $hold_type eq OILS_HOLD_TYPE_COPY ) {
2472 return $e->event unless $copy = $e->retrieve_asset_copy($copyid);
2473 return $e->event unless $volume = $e->retrieve_asset_call_number($copy->call_number);
2474 return $e->event unless $title = $e->retrieve_biblio_record_entry($volume->record);
2476 return (1, 1, []) if( $hold_type eq OILS_HOLD_TYPE_RECALL || $hold_type eq OILS_HOLD_TYPE_FORCE);
2477 return verify_copy_for_hold(
2478 $patron, $e->requestor, $title, $copy, $pickup_lib, $request_lib, $oargs
2481 } elsif( $hold_type eq OILS_HOLD_TYPE_VOLUME ) {
2483 return $e->event unless $volume = $e->retrieve_asset_call_number($volid);
2484 return $e->event unless $title = $e->retrieve_biblio_record_entry($volume->record);
2486 return _check_volume_hold_is_possible(
2487 $volume, $title, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou, $oargs
2490 } elsif( $hold_type eq OILS_HOLD_TYPE_TITLE ) {
2492 return _check_title_hold_is_possible(
2493 $titleid, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou, undef, $oargs
2496 } elsif( $hold_type eq OILS_HOLD_TYPE_ISSUANCE ) {
2498 return _check_issuance_hold_is_possible(
2499 $issuanceid, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou, $oargs
2502 } elsif( $hold_type eq OILS_HOLD_TYPE_MONOPART ) {
2504 return _check_monopart_hold_is_possible(
2505 $partid, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou, $oargs
2508 } elsif( $hold_type eq OILS_HOLD_TYPE_METARECORD ) {
2510 # pasing undef as the depth to filtered_records causes the depth
2511 # of the selection_ou to be used, which is not what we want here.
2514 my ($recs) = __PACKAGE__->method_lookup('open-ils.circ.holds.metarecord.filtered_records')->run($mrid, $holdable_formats, $selection_ou, $depth);
2516 for my $rec (@$recs) {
2517 @status = _check_title_hold_is_possible(
2518 $rec, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou, $holdable_formats, $oargs
2524 # else { Unrecognized hold_type ! } # FIXME: return error? or 0?
2527 sub MR_filter_records {
2534 my $opac_visible = shift;
2536 my $org_at_depth = defined($d) ? $U->org_unit_ancestor_at_depth($o, $d) : $o;
2537 return $U->storagereq(
2538 'open-ils.storage.metarecord.filtered_records.atomic',
2539 $m, $f, $org_at_depth, $opac_visible
2542 __PACKAGE__->register_method(
2543 method => 'MR_filter_records',
2544 api_name => 'open-ils.circ.holds.metarecord.filtered_records',
2549 sub create_ranged_org_filter {
2550 my($e, $selection_ou, $depth) = @_;
2552 # find the orgs from which this hold may be fulfilled,
2553 # based on the selection_ou and depth
2555 my $top_org = $e->search_actor_org_unit([
2556 {parent_ou => undef},
2557 {flesh=>1, flesh_fields=>{aou=>['ou_type']}}])->[0];
2560 return () if $depth == $top_org->ou_type->depth;
2562 my $org_list = $U->storagereq('open-ils.storage.actor.org_unit.descendants.atomic', $selection_ou, $depth);
2563 %org_filter = (circ_lib => []);
2564 push(@{$org_filter{circ_lib}}, $_->id) for @$org_list;
2566 $logger->info("hold org filter at depth $depth and selection_ou ".
2567 "$selection_ou created list of @{$org_filter{circ_lib}}");
2573 sub _check_title_hold_is_possible {
2574 my( $titleid, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou, $holdable_formats, $oargs ) = @_;
2575 # $holdable_formats is now unused. We pre-filter the MR's records.
2577 my $e = new_editor();
2578 my %org_filter = create_ranged_org_filter($e, $selection_ou, $depth);
2580 # this monster will grab the id and circ_lib of all of the "holdable" copies for the given record
2581 my $copies = $e->json_query(
2583 select => { acp => ['id', 'circ_lib'] },
2588 fkey => 'call_number',
2589 filter => { record => $titleid }
2593 filter => { holdable => 't', deleted => 'f' },
2596 ccs => { field => 'id', filter => { holdable => 't'}, fkey => 'status' },
2597 acpm => { field => 'target_copy', type => 'left' } # ignore part-linked copies
2601 '+acp' => { circulate => 't', deleted => 'f', holdable => 't', %org_filter },
2602 '+acpm' => { target_copy => undef } # ignore part-linked copies
2607 $logger->info("title possible found ".scalar(@$copies)." potential copies");
2611 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2612 "payload" => {"fail_part" => "no_ultimate_items"}
2617 # -----------------------------------------------------------------------
2618 # sort the copies into buckets based on their circ_lib proximity to
2619 # the patron's home_ou.
2620 # -----------------------------------------------------------------------
2622 my $home_org = $patron->home_ou;
2623 my $req_org = $request_lib->id;
2625 $prox_cache{$home_org} =
2626 $e->search_actor_org_unit_proximity({from_org => $home_org})
2627 unless $prox_cache{$home_org};
2628 my $home_prox = $prox_cache{$home_org};
2629 $logger->info("prox cache $home_org " . $prox_cache{$home_org});
2632 my %hash = map { ($_->to_org => $_->prox) } @$home_prox;
2633 push( @{$buckets{ $hash{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2635 my @keys = sort { $a <=> $b } keys %buckets;
2638 if( $home_org ne $req_org ) {
2639 # -----------------------------------------------------------------------
2640 # shove the copies close to the request_lib into the primary buckets
2641 # directly before the farthest away copies. That way, they are not
2642 # given priority, but they are checked before the farthest copies.
2643 # -----------------------------------------------------------------------
2644 $prox_cache{$req_org} =
2645 $e->search_actor_org_unit_proximity({from_org => $req_org})
2646 unless $prox_cache{$req_org};
2647 my $req_prox = $prox_cache{$req_org};
2650 my %hash2 = map { ($_->to_org => $_->prox) } @$req_prox;
2651 push( @{$buckets2{ $hash2{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2653 my $highest_key = $keys[@keys - 1]; # the farthest prox in the exising buckets
2654 my $new_key = $highest_key - 0.5; # right before the farthest prox
2655 my @keys2 = sort { $a <=> $b } keys %buckets2;
2656 for my $key (@keys2) {
2657 last if $key >= $highest_key;
2658 push( @{$buckets{$new_key}}, $_ ) for @{$buckets2{$key}};
2662 @keys = sort { $a <=> $b } keys %buckets;
2667 my $age_protect_only = 0;
2668 OUTER: for my $key (@keys) {
2669 my @cps = @{$buckets{$key}};
2671 $logger->info("looking at " . scalar(@{$buckets{$key}}). " copies in proximity bucket $key");
2673 for my $copyid (@cps) {
2675 next if $seen{$copyid};
2676 $seen{$copyid} = 1; # there could be dupes given the merged buckets
2677 my $copy = $e->retrieve_asset_copy($copyid);
2678 $logger->debug("looking at bucket_key=$key, copy $copyid : circ_lib = " . $copy->circ_lib);
2680 unless($title) { # grab the title if we don't already have it
2681 my $vol = $e->retrieve_asset_call_number(
2682 [ $copy->call_number, { flesh => 1, flesh_fields => { bre => ['fixed_fields'], acn => ['record'] } } ] );
2683 $title = $vol->record;
2686 @status = verify_copy_for_hold(
2687 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib, $oargs);
2689 $age_protect_only ||= $status[3];
2690 last OUTER if $status[0];
2694 $status[3] = $age_protect_only;
2698 sub _check_issuance_hold_is_possible {
2699 my( $issuanceid, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou, $oargs ) = @_;
2701 my $e = new_editor();
2702 my %org_filter = create_ranged_org_filter($e, $selection_ou, $depth);
2704 # this monster will grab the id and circ_lib of all of the "holdable" copies for the given record
2705 my $copies = $e->json_query(
2707 select => { acp => ['id', 'circ_lib'] },
2713 filter => { issuance => $issuanceid }
2717 filter => { holdable => 't', deleted => 'f' },
2720 ccs => { field => 'id', filter => { holdable => 't'}, fkey => 'status' }
2724 '+acp' => { circulate => 't', deleted => 'f', holdable => 't', %org_filter }
2730 $logger->info("issuance possible found ".scalar(@$copies)." potential copies");
2734 $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_issuance_ok');
2735 $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2740 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2741 "payload" => {"fail_part" => "no_ultimate_items"}
2749 # -----------------------------------------------------------------------
2750 # sort the copies into buckets based on their circ_lib proximity to
2751 # the patron's home_ou.
2752 # -----------------------------------------------------------------------
2754 my $home_org = $patron->home_ou;
2755 my $req_org = $request_lib->id;
2757 $prox_cache{$home_org} =
2758 $e->search_actor_org_unit_proximity({from_org => $home_org})
2759 unless $prox_cache{$home_org};
2760 my $home_prox = $prox_cache{$home_org};
2761 $logger->info("prox cache $home_org " . $prox_cache{$home_org});
2764 my %hash = map { ($_->to_org => $_->prox) } @$home_prox;
2765 push( @{$buckets{ $hash{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2767 my @keys = sort { $a <=> $b } keys %buckets;
2770 if( $home_org ne $req_org ) {
2771 # -----------------------------------------------------------------------
2772 # shove the copies close to the request_lib into the primary buckets
2773 # directly before the farthest away copies. That way, they are not
2774 # given priority, but they are checked before the farthest copies.
2775 # -----------------------------------------------------------------------
2776 $prox_cache{$req_org} =
2777 $e->search_actor_org_unit_proximity({from_org => $req_org})
2778 unless $prox_cache{$req_org};
2779 my $req_prox = $prox_cache{$req_org};
2782 my %hash2 = map { ($_->to_org => $_->prox) } @$req_prox;
2783 push( @{$buckets2{ $hash2{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2785 my $highest_key = $keys[@keys - 1]; # the farthest prox in the exising buckets
2786 my $new_key = $highest_key - 0.5; # right before the farthest prox
2787 my @keys2 = sort { $a <=> $b } keys %buckets2;
2788 for my $key (@keys2) {
2789 last if $key >= $highest_key;
2790 push( @{$buckets{$new_key}}, $_ ) for @{$buckets2{$key}};
2794 @keys = sort { $a <=> $b } keys %buckets;
2799 my $age_protect_only = 0;
2800 OUTER: for my $key (@keys) {
2801 my @cps = @{$buckets{$key}};
2803 $logger->info("looking at " . scalar(@{$buckets{$key}}). " copies in proximity bucket $key");
2805 for my $copyid (@cps) {
2807 next if $seen{$copyid};
2808 $seen{$copyid} = 1; # there could be dupes given the merged buckets
2809 my $copy = $e->retrieve_asset_copy($copyid);
2810 $logger->debug("looking at bucket_key=$key, copy $copyid : circ_lib = " . $copy->circ_lib);
2812 unless($title) { # grab the title if we don't already have it
2813 my $vol = $e->retrieve_asset_call_number(
2814 [ $copy->call_number, { flesh => 1, flesh_fields => { bre => ['fixed_fields'], acn => ['record'] } } ] );
2815 $title = $vol->record;
2818 @status = verify_copy_for_hold(
2819 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib, $oargs);
2821 $age_protect_only ||= $status[3];
2822 last OUTER if $status[0];
2827 if (!defined($empty_ok)) {
2828 $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_issuance_ok');
2829 $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2832 return (1,0) if ($empty_ok);
2834 $status[3] = $age_protect_only;
2838 sub _check_monopart_hold_is_possible {
2839 my( $partid, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou, $oargs ) = @_;
2841 my $e = new_editor();
2842 my %org_filter = create_ranged_org_filter($e, $selection_ou, $depth);
2844 # this monster will grab the id and circ_lib of all of the "holdable" copies for the given record
2845 my $copies = $e->json_query(
2847 select => { acp => ['id', 'circ_lib'] },
2851 field => 'target_copy',
2853 filter => { part => $partid }
2857 filter => { holdable => 't', deleted => 'f' },
2860 ccs => { field => 'id', filter => { holdable => 't'}, fkey => 'status' }
2864 '+acp' => { circulate => 't', deleted => 'f', holdable => 't', %org_filter }
2870 $logger->info("monopart possible found ".scalar(@$copies)." potential copies");
2874 $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_part_ok');
2875 $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2880 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2881 "payload" => {"fail_part" => "no_ultimate_items"}
2889 # -----------------------------------------------------------------------
2890 # sort the copies into buckets based on their circ_lib proximity to
2891 # the patron's home_ou.
2892 # -----------------------------------------------------------------------
2894 my $home_org = $patron->home_ou;
2895 my $req_org = $request_lib->id;
2897 $prox_cache{$home_org} =
2898 $e->search_actor_org_unit_proximity({from_org => $home_org})
2899 unless $prox_cache{$home_org};
2900 my $home_prox = $prox_cache{$home_org};
2901 $logger->info("prox cache $home_org " . $prox_cache{$home_org});
2904 my %hash = map { ($_->to_org => $_->prox) } @$home_prox;
2905 push( @{$buckets{ $hash{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2907 my @keys = sort { $a <=> $b } keys %buckets;
2910 if( $home_org ne $req_org ) {
2911 # -----------------------------------------------------------------------
2912 # shove the copies close to the request_lib into the primary buckets
2913 # directly before the farthest away copies. That way, they are not
2914 # given priority, but they are checked before the farthest copies.
2915 # -----------------------------------------------------------------------
2916 $prox_cache{$req_org} =
2917 $e->search_actor_org_unit_proximity({from_org => $req_org})
2918 unless $prox_cache{$req_org};
2919 my $req_prox = $prox_cache{$req_org};
2922 my %hash2 = map { ($_->to_org => $_->prox) } @$req_prox;
2923 push( @{$buckets2{ $hash2{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2925 my $highest_key = $keys[@keys - 1]; # the farthest prox in the exising buckets
2926 my $new_key = $highest_key - 0.5; # right before the farthest prox
2927 my @keys2 = sort { $a <=> $b } keys %buckets2;
2928 for my $key (@keys2) {
2929 last if $key >= $highest_key;
2930 push( @{$buckets{$new_key}}, $_ ) for @{$buckets2{$key}};
2934 @keys = sort { $a <=> $b } keys %buckets;
2939 my $age_protect_only = 0;
2940 OUTER: for my $key (@keys) {
2941 my @cps = @{$buckets{$key}};
2943 $logger->info("looking at " . scalar(@{$buckets{$key}}). " copies in proximity bucket $key");
2945 for my $copyid (@cps) {
2947 next if $seen{$copyid};
2948 $seen{$copyid} = 1; # there could be dupes given the merged buckets
2949 my $copy = $e->retrieve_asset_copy($copyid);
2950 $logger->debug("looking at bucket_key=$key, copy $copyid : circ_lib = " . $copy->circ_lib);
2952 unless($title) { # grab the title if we don't already have it
2953 my $vol = $e->retrieve_asset_call_number(
2954 [ $copy->call_number, { flesh => 1, flesh_fields => { bre => ['fixed_fields'], acn => ['record'] } } ] );
2955 $title = $vol->record;
2958 @status = verify_copy_for_hold(
2959 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib, $oargs);
2961 $age_protect_only ||= $status[3];
2962 last OUTER if $status[0];
2967 if (!defined($empty_ok)) {
2968 $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_part_ok');
2969 $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2972 return (1,0) if ($empty_ok);
2974 $status[3] = $age_protect_only;
2979 sub _check_volume_hold_is_possible {
2980 my( $vol, $title, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou, $oargs ) = @_;
2981 my %org_filter = create_ranged_org_filter(new_editor(), $selection_ou, $depth);
2982 my $copies = new_editor->search_asset_copy({call_number => $vol->id, %org_filter});
2983 $logger->info("checking possibility of volume hold for volume ".$vol->id);
2985 my $filter_copies = [];
2986 for my $copy (@$copies) {
2987 # ignore part-mapped copies for regular volume level holds
2988 push(@$filter_copies, $copy) unless
2989 new_editor->search_asset_copy_part_map({target_copy => $copy->id})->[0];
2991 $copies = $filter_copies;
2996 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2997 "payload" => {"fail_part" => "no_ultimate_items"}
3003 my $age_protect_only = 0;
3004 for my $copy ( @$copies ) {
3005 @status = verify_copy_for_hold(
3006 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib, $oargs );
3007 $age_protect_only ||= $status[3];
3010 $status[3] = $age_protect_only;
3016 sub verify_copy_for_hold {
3017 my( $patron, $requestor, $title, $copy, $pickup_lib, $request_lib, $oargs ) = @_;
3018 # $oargs should be undef unless we're overriding.
3019 $logger->info("checking possibility of copy in hold request for copy ".$copy->id);
3020 my $permitted = OpenILS::Utils::PermitHold::permit_copy_hold(
3023 requestor => $requestor,
3026 title_descriptor => $title->fixed_fields,
3027 pickup_lib => $pickup_lib,
3028 request_lib => $request_lib,
3030 show_event_list => 1
3034 # Check for override permissions on events.
3035 if ($oargs && $permitted && scalar @$permitted) {
3036 # Remove the events from permitted that we can override.
3037 if ($oargs->{events}) {
3038 foreach my $evt (@{$oargs->{events}}) {
3039 $permitted = [grep {$_->{textcode} ne $evt} @{$permitted}];
3042 # Now, we handle the override all case by checking remaining
3043 # events against override permissions.
3044 if (scalar @$permitted && $oargs->{all}) {
3045 # Pre-set events and failed members of oargs to empty
3046 # arrays, if they are not set, yet.
3047 $oargs->{events} = [] unless ($oargs->{events});
3048 $oargs->{failed} = [] unless ($oargs->{failed});
3049 # When we're done with these checks, we swap permitted
3050 # with a reference to @disallowed.
3051 my @disallowed = ();
3052 foreach my $evt (@{$permitted}) {
3053 # Check if we've already seen the event in this
3054 # session and it failed.
3055 if (grep {$_ eq $evt->{textcode}} @{$oargs->{failed}}) {
3056 push(@disallowed, $evt);
3058 # We have to check if the requestor has the
3059 # override permission.
3061 # AppUtils::check_user_perms returns the perm if
3062 # the user doesn't have it, undef if they do.
3063 if ($apputils->check_user_perms($requestor->id, $requestor->ws_ou, $evt->{textcode} . '.override')) {
3064 push(@disallowed, $evt);
3065 push(@{$oargs->{failed}}, $evt->{textcode});
3067 push(@{$oargs->{events}}, $evt->{textcode});
3071 $permitted = \@disallowed;
3075 my $age_protect_only = 0;
3076 if (@$permitted == 1 && @$permitted[0]->{textcode} eq 'ITEM_AGE_PROTECTED') {
3077 $age_protect_only = 1;
3081 (not scalar @$permitted), # true if permitted is an empty arrayref
3082 ( # XXX This test is of very dubious value; someone should figure
3083 # out what if anything is checking this value
3084 ($copy->circ_lib == $pickup_lib) and
3085 ($copy->status == OILS_COPY_STATUS_AVAILABLE)
3094 sub find_nearest_permitted_hold {
3097 my $editor = shift; # CStoreEditor object
3098 my $copy = shift; # copy to target
3099 my $user = shift; # staff
3100 my $check_only = shift; # do no updates, just see if the copy could fulfill a hold
3102 my $evt = OpenILS::Event->new('ACTION_HOLD_REQUEST_NOT_FOUND');
3104 my $bc = $copy->barcode;
3106 # find any existing holds that already target this copy
3107 my $old_holds = $editor->search_action_hold_request(
3108 { current_copy => $copy->id,
3109 cancel_time => undef,
3110 capture_time => undef
3114 my $hold_stall_interval = $U->ou_ancestor_setting_value($user->ws_ou, OILS_SETTING_HOLD_SOFT_STALL);
3116 $logger->info("circulator: searching for best hold at org ".$user->ws_ou.
3117 " and copy $bc with a hold stalling interval of ". ($hold_stall_interval || "(none)"));
3119 my $fifo = $U->ou_ancestor_setting_value($user->ws_ou, 'circ.holds_fifo');
3121 # the nearest_hold API call now needs this
3122 $copy->call_number($editor->retrieve_asset_call_number($copy->call_number))
3123 unless ref $copy->call_number;
3125 # search for what should be the best holds for this copy to fulfill
3126 my $best_holds = $U->storagereq(
3127 "open-ils.storage.action.hold_request.nearest_hold.atomic",
3128 $user->ws_ou, $copy, 100, $hold_stall_interval, $fifo );
3130 # Add any pre-targeted holds to the list too? Unless they are already there, anyway.
3132 for my $holdid (@$old_holds) {
3133 next unless $holdid;
3134 push(@$best_holds, $holdid) unless ( grep { ''.$holdid eq ''.$_ } @$best_holds );
3138 unless(@$best_holds) {
3139 $logger->info("circulator: no suitable holds found for copy $bc");
3140 return (undef, $evt);
3146 # for each potential hold, we have to run the permit script
3147 # to make sure the hold is actually permitted.
3150 for my $holdid (@$best_holds) {
3151 next unless $holdid;
3152 $logger->info("circulator: checking if hold $holdid is permitted for copy $bc");
3154 my $hold = $editor->retrieve_action_hold_request($holdid) or next;
3155 # Force and recall holds bypass all rules
3156 if ($hold->hold_type eq 'R' || $hold->hold_type eq 'F') {
3160 my $reqr = $reqr_cache{$hold->requestor} || $editor->retrieve_actor_user($hold->requestor);
3161 my $rlib = $org_cache{$hold->request_lib} || $editor->retrieve_actor_org_unit($hold->request_lib);
3163 $reqr_cache{$hold->requestor} = $reqr;
3164 $org_cache{$hold->request_lib} = $rlib;
3166 # see if this hold is permitted
3167 my $permitted = OpenILS::Utils::PermitHold::permit_copy_hold(
3169 patron_id => $hold->usr,
3172 pickup_lib => $hold->pickup_lib,
3173 request_lib => $rlib,
3185 unless( $best_hold ) { # no "good" permitted holds were found
3187 $logger->info("circulator: no suitable holds found for copy $bc");
3188 return (undef, $evt);
3191 $logger->info("circulator: best hold ".$best_hold->id." found for copy $bc");
3193 # indicate a permitted hold was found
3194 return $best_hold if $check_only;
3196 # we've found a permitted hold. we need to "grab" the copy
3197 # to prevent re-targeted holds (next part) from re-grabbing the copy
3198 $best_hold->current_copy($copy->id);
3199 $editor->update_action_hold_request($best_hold)
3200 or return (undef, $editor->event);
3205 # re-target any other holds that already target this copy
3206 for my $old_hold (@$old_holds) {
3207 next if $old_hold->id eq $best_hold->id; # don't re-target the hold we want
3208 $logger->info("circulator: clearing current_copy and prev_check_time on hold ".
3209 $old_hold->id." after a better hold [".$best_hold->id."] was found");
3210 $old_hold->clear_current_copy;
3211 $old_hold->clear_prev_check_time;
3212 $editor->update_action_hold_request($old_hold)
3213 or return (undef, $editor->event);
3214 push(@retarget, $old_hold->id);
3217 return ($best_hold, undef, (@retarget) ? \@retarget : undef);
3225 __PACKAGE__->register_method(
3226 method => 'all_rec_holds',
3227 api_name => 'open-ils.circ.holds.retrieve_all_from_title',
3231 my( $self, $conn, $auth, $title_id, $args ) = @_;
3233 my $e = new_editor(authtoken=>$auth);
3234 $e->checkauth or return $e->event;
3235 $e->allowed('VIEW_HOLD') or return $e->event;
3238 $args->{fulfillment_time} = undef; # we don't want to see old fulfilled holds
3239 $args->{cancel_time} = undef;
3242 metarecord_holds => []
3244 , volume_holds => []
3246 , recall_holds => []
3249 , issuance_holds => []
3252 my $mr_map = $e->search_metabib_metarecord_source_map({source => $title_id})->[0];
3254 $resp->{metarecord_holds} = $e->search_action_hold_request(
3255 { hold_type => OILS_HOLD_TYPE_METARECORD,
3256 target => $mr_map->metarecord,
3262 $resp->{title_holds} = $e->search_action_hold_request(
3264 hold_type => OILS_HOLD_TYPE_TITLE,
3265 target => $title_id,
3269 my $parts = $e->search_biblio_monograph_part(
3275 $resp->{part_holds} = $e->search_action_hold_request(
3277 hold_type => OILS_HOLD_TYPE_MONOPART,
3283 my $subs = $e->search_serial_subscription(
3284 { record_entry => $title_id }, {idlist=>1});
3287 my $issuances = $e->search_serial_issuance(
3288 {subscription => $subs}, {idlist=>1}
3292 $resp->{issuance_holds} = $e->search_action_hold_request(
3294 hold_type => OILS_HOLD_TYPE_ISSUANCE,
3295 target => $issuances,
3302 my $vols = $e->search_asset_call_number(
3303 { record => $title_id, deleted => 'f' }, {idlist=>1});
3305 return $resp unless @$vols;
3307 $resp->{volume_holds} = $e->search_action_hold_request(
3309 hold_type => OILS_HOLD_TYPE_VOLUME,
3314 my $copies = $e->search_asset_copy(
3315 { call_number => $vols, deleted => 'f' }, {idlist=>1});
3317 return $resp unless @$copies;
3319 $resp->{copy_holds} = $e->search_action_hold_request(
3321 hold_type => OILS_HOLD_TYPE_COPY,
3326 $resp->{recall_holds} = $e->search_action_hold_request(
3328 hold_type => OILS_HOLD_TYPE_RECALL,
3333 $resp->{force_holds} = $e->search_action_hold_request(
3335 hold_type => OILS_HOLD_TYPE_FORCE,
3347 __PACKAGE__->register_method(
3348 method => 'uber_hold',
3350 api_name => 'open-ils.circ.hold.details.retrieve'
3354 my($self, $client, $auth, $hold_id, $args) = @_;
3355 my $e = new_editor(authtoken=>$auth);
3356 $e->checkauth or return $e->event;
3357 return uber_hold_impl($e, $hold_id, $args);
3360 __PACKAGE__->register_method(
3361 method => 'batch_uber_hold',
3364 api_name => 'open-ils.circ.hold.details.batch.retrieve'
3367 sub batch_uber_hold {
3368 my($self, $client, $auth, $hold_ids, $args) = @_;
3369 my $e = new_editor(authtoken=>$auth);
3370 $e->checkauth or return $e->event;
3371 $client->respond(uber_hold_impl($e, $_, $args)) for @$hold_ids;
3375 sub uber_hold_impl {
3376 my($e, $hold_id, $args) = @_;
3379 my $hold = $e->retrieve_action_hold_request(
3384 flesh_fields => { ahr => [ 'current_copy', 'usr', 'notes' ] }
3387 ) or return $e->event;
3389 if($hold->usr->id ne $e->requestor->id) {
3390 # caller is asking for someone else's hold
3391 $e->allowed('VIEW_HOLD') or return $e->event;
3392 $hold->notes( # filter out any non-staff ("private") notes (unless marked as public)
3393 [ grep { $U->is_true($_->staff) or $U->is_true($_->pub) } @{$hold->notes} ] );
3396 # caller is asking for own hold, but may not have permission to view staff notes
3397 unless($e->allowed('VIEW_HOLD')) {
3398 $hold->notes( # filter out any staff notes (unless marked as public)
3399 [ grep { !$U->is_true($_->staff) or $U->is_true($_->pub) } @{$hold->notes} ] );
3403 my $user = $hold->usr;
3404 $hold->usr($user->id);
3407 my( $mvr, $volume, $copy, $issuance, $part, $bre ) = find_hold_mvr($e, $hold, $args->{suppress_mvr});
3409 flesh_hold_notices([$hold], $e) unless $args->{suppress_notices};
3410 flesh_hold_transits([$hold]) unless $args->{suppress_transits};
3412 my $details = retrieve_hold_queue_status_impl($e, $hold);
3417 ($copy ? (copy => $copy) : ()),
3418 ($volume ? (volume => $volume) : ()),
3419 ($issuance ? (issuance => $issuance) : ()),
3420 ($part ? (part => $part) : ()),
3421 ($args->{include_bre} ? (bre => $bre) : ()),
3422 ($args->{suppress_mvr} ? () : (mvr => $mvr)),
3426 $resp->{copy}->location(
3427 $e->retrieve_asset_copy_location($resp->{copy}->location))
3428 if $resp->{copy} and $args->{flesh_acpl};
3430 unless($args->{suppress_patron_details}) {
3431 my $card = $e->retrieve_actor_card($user->card) or return $e->event;
3432 $resp->{patron_first} = $user->first_given_name,
3433 $resp->{patron_last} = $user->family_name,
3434 $resp->{patron_barcode} = $card->barcode,
3435 $resp->{patron_alias} = $user->alias,
3443 # -----------------------------------------------------
3444 # Returns the MVR object that represents what the
3446 # -----------------------------------------------------
3448 my( $e, $hold, $no_mvr ) = @_;
3456 if( $hold->hold_type eq OILS_HOLD_TYPE_METARECORD ) {
3457 my $mr = $e->retrieve_metabib_metarecord($hold->target)
3458 or return $e->event;
3459 $tid = $mr->master_record;
3461 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_TITLE ) {
3462 $tid = $hold->target;
3464 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_VOLUME ) {
3465 $volume = $e->retrieve_asset_call_number($hold->target)
3466 or return $e->event;
3467 $tid = $volume->record;
3469 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_ISSUANCE ) {
3470 $issuance = $e->retrieve_serial_issuance([
3472 {flesh => 1, flesh_fields => {siss => [ qw/subscription/ ]}}
3473 ]) or return $e->event;
3475 $tid = $issuance->subscription->record_entry;
3477 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_MONOPART ) {
3478 $part = $e->retrieve_biblio_monograph_part([
3480 ]) or return $e->event;
3482 $tid = $part->record;
3484 } 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 ) {
3485 $copy = $e->retrieve_asset_copy([
3487 {flesh => 1, flesh_fields => {acp => ['call_number']}}
3488 ]) or return $e->event;
3490 $volume = $copy->call_number;
3491 $tid = $volume->record;
3494 if(!$copy and ref $hold->current_copy ) {
3495 $copy = $hold->current_copy;
3496 $hold->current_copy($copy->id);
3499 if(!$volume and $copy) {
3500 $volume = $e->retrieve_asset_call_number($copy->call_number);
3503 # TODO return metarcord mvr for M holds
3504 my $title = $e->retrieve_biblio_record_entry($tid);
3505 return ( ($no_mvr) ? undef : $U->record_to_mvr($title), $volume, $copy, $issuance, $part, $title );
3508 __PACKAGE__->register_method(
3509 method => 'clear_shelf_cache',
3510 api_name => 'open-ils.circ.hold.clear_shelf.get_cache',
3514 Returns the holds processed with the given cache key
3519 sub clear_shelf_cache {
3520 my($self, $client, $auth, $cache_key, $chunk_size) = @_;
3521 my $e = new_editor(authtoken => $auth, xact => 1);
3522 return $e->die_event unless $e->checkauth and $e->allowed('VIEW_HOLD');
3525 $client->max_chunk_size($chunk_size) if (!$client->can('max_bundle_size') && $client->can('max_chunk_size'));
3527 my $hold_data = OpenSRF::Utils::Cache->new('global')->get_cache($cache_key);
3530 $logger->info("no hold data found in cache"); # XXX TODO return event
3536 foreach (keys %$hold_data) {
3537 $maximum += scalar(@{ $hold_data->{$_} });
3539 $client->respond({"maximum" => $maximum, "progress" => 0});
3541 for my $action (sort keys %$hold_data) {
3542 while (@{$hold_data->{$action}}) {
3543 my @hid_chunk = splice @{$hold_data->{$action}}, 0, $chunk_size;
3545 my $result_chunk = $e->json_query({
3547 "acp" => ["barcode"],
3549 first_given_name second_given_name family_name alias
3552 "acnp" => [{column => "label", alias => "prefix"}],
3553 "acns" => [{column => "label", alias => "suffix"}],
3561 "field" => "id", "fkey" => "current_copy",
3564 "field" => "id", "fkey" => "call_number",
3567 "field" => "id", "fkey" => "record"
3570 "field" => "id", "fkey" => "prefix"
3573 "field" => "id", "fkey" => "suffix"
3577 "acpl" => {"field" => "id", "fkey" => "location"}
3580 "au" => {"field" => "id", "fkey" => "usr"}
3583 "where" => {"+ahr" => {"id" => \@hid_chunk}}
3584 }, {"substream" => 1}) or return $e->die_event;
3588 +{"action" => $action, "hold_details" => $_}
3599 __PACKAGE__->register_method(
3600 method => 'clear_shelf_process',
3602 api_name => 'open-ils.circ.hold.clear_shelf.process',
3605 1. Find all holds that have expired on the holds shelf
3607 3. If a clear-shelf status is configured, put targeted copies into this status
3608 4. Divide copies into 3 groups: items to transit, items to reshelve, and items
3609 that are needed for holds. No subsequent action is taken on the holds
3610 or items after grouping.
3615 sub clear_shelf_process {
3616 my($self, $client, $auth, $org_id, $match_copy, $chunk_size) = @_;
3618 my $e = new_editor(authtoken=>$auth);
3619 $e->checkauth or return $e->die_event;
3620 my $cache = OpenSRF::Utils::Cache->new('global');
3622 $org_id ||= $e->requestor->ws_ou;
3623 $e->allowed('UPDATE_HOLD', $org_id) or return $e->die_event;
3625 my $copy_status = $U->ou_ancestor_setting_value($org_id, 'circ.holds.clear_shelf.copy_status');
3627 my @hold_ids = $self->method_lookup(
3628 "open-ils.circ.captured_holds.id_list.expired_on_shelf.retrieve"
3629 )->run($auth, $org_id, $match_copy);
3634 my @canceled_holds; # newly canceled holds
3635 $chunk_size ||= 25; # chunked status updates
3636 $client->max_chunk_size($chunk_size) if (!$client->can('max_bundle_size') && $client->can('max_chunk_size'));
3639 for my $hold_id (@hold_ids) {
3641 $logger->info("Clear shelf processing hold $hold_id");
3643 my $hold = $e->retrieve_action_hold_request([
3646 flesh_fields => {ahr => ['current_copy']}
3650 if (!$hold->cancel_time) { # may be canceled but still on the holds shelf
3651 $hold->cancel_time('now');
3652 $hold->cancel_cause(2); # Hold Shelf expiration
3653 $e->update_action_hold_request($hold) or return $e->die_event;
3654 push(@canceled_holds, $hold_id);
3657 my $copy = $hold->current_copy;
3659 if($copy_status or $copy_status == 0) {
3660 # if a clear-shelf copy status is defined, update the copy
3661 $copy->status($copy_status);
3662 $copy->edit_date('now');
3663 $copy->editor($e->requestor->id);
3664 $e->update_asset_copy($copy) or return $e->die_event;
3667 push(@holds, $hold);
3668 $client->respond({maximum => scalar(@holds), progress => $counter}) if ( (++$counter % $chunk_size) == 0);
3677 pl_changed => pickup_lib_changed_on_shelf_holds($e, $org_id, \@hold_ids)
3680 for my $hold (@holds) {
3682 my $copy = $hold->current_copy;
3683 my ($alt_hold) = __PACKAGE__->find_nearest_permitted_hold($e, $copy, $e->requestor, 1);
3685 if($alt_hold and !$match_copy) {
3687 push(@{$cache_data{hold}}, $hold->id); # copy is needed for a hold
3689 } elsif($copy->circ_lib != $e->requestor->ws_ou) {
3691 push(@{$cache_data{transit}}, $hold->id); # copy needs to transit
3695 push(@{$cache_data{shelf}}, $hold->id); # copy needs to go back to the shelf
3699 my $cache_key = md5_hex(time . $$ . rand());
3700 $logger->info("clear_shelf_cache: storing under $cache_key");
3701 $cache->put_cache($cache_key, \%cache_data, 7200); # TODO: 2 hours. configurable?
3703 # tell the client we're done
3704 $client->respond_complete({cache_key => $cache_key});
3707 # fire off the hold cancelation trigger and wait for response so don't flood the service
3709 # refetch the holds to pick up the caclulated cancel_time,
3710 # which may be needed by Action/Trigger
3712 my $updated_holds = [];
3713 $updated_holds = $e->search_action_hold_request({id => \@canceled_holds}, {substream => 1}) if (@canceled_holds > 0);
3716 $U->create_events_for_hook(
3717 'hold_request.cancel.expire_holds_shelf',
3718 $_, $org_id, undef, undef, 1) for @$updated_holds;
3721 # tell the client we're done
3722 $client->respond_complete;
3726 # returns IDs for holds that are on the holds shelf but
3727 # have had their pickup_libs change while on the shelf.
3728 sub pickup_lib_changed_on_shelf_holds {
3731 my $ignore_holds = shift;
3732 $ignore_holds = [$ignore_holds] if !ref($ignore_holds);
3735 select => { alhr => ['id'] },
3740 fkey => 'current_copy'
3745 '+acp' => { status => OILS_COPY_STATUS_ON_HOLDS_SHELF },
3747 capture_time => { "!=" => undef },
3748 fulfillment_time => undef,
3749 current_shelf_lib => $org_id,
3750 pickup_lib => {'!=' => {'+alhr' => 'current_shelf_lib'}}
3755 $query->{where}->{'+alhr'}->{id} =
3756 {'not in' => $ignore_holds} if @$ignore_holds;
3758 my $hold_ids = $e->json_query($query);
3759 return [ map { $_->{id} } @$hold_ids ];
3762 __PACKAGE__->register_method(
3763 method => 'usr_hold_summary',
3764 api_name => 'open-ils.circ.holds.user_summary',
3766 Returns a summary of holds statuses for a given user
3770 sub usr_hold_summary {
3771 my($self, $conn, $auth, $user_id) = @_;
3773 my $e = new_editor(authtoken=>$auth);
3774 $e->checkauth or return $e->event;
3775 $e->allowed('VIEW_HOLD') or return $e->event;
3777 my $holds = $e->search_action_hold_request(
3780 fulfillment_time => undef,
3781 cancel_time => undef,
3785 my %summary = (1 => 0, 2 => 0, 3 => 0, 4 => 0);
3786 $summary{_hold_status($e, $_)} += 1 for @$holds;
3792 __PACKAGE__->register_method(
3793 method => 'hold_has_copy_at',
3794 api_name => 'open-ils.circ.hold.has_copy_at',
3797 'Returns the ID of the found copy and name of the shelving location if there is ' .
3798 'an available copy at the specified org unit. Returns empty hash otherwise. ' .
3799 'The anticipated use for this method is to determine whether an item is ' .
3800 'available at the library where the user is placing the hold (or, alternatively, '.
3801 'at the pickup library) to encourage bypassing the hold placement and just ' .
3802 'checking out the item.' ,
3804 { desc => 'Authentication Token', type => 'string' },
3805 { desc => 'Method Arguments. Options include: hold_type, hold_target, org_unit. '
3806 . 'hold_type is the hold type code (T, V, C, M, ...). '
3807 . 'hold_target is the identifier of the hold target object. '
3808 . 'org_unit is org unit ID.',
3813 desc => q/Result hash like { "copy" : copy_id, "location" : location_name }, empty hash on misses, event on error./,
3819 sub hold_has_copy_at {
3820 my($self, $conn, $auth, $args) = @_;
3822 my $e = new_editor(authtoken=>$auth);
3823 $e->checkauth or return $e->event;
3825 my $hold_type = $$args{hold_type};
3826 my $hold_target = $$args{hold_target};
3827 my $org_unit = $$args{org_unit};
3830 select => {acp => ['id'], acpl => ['name']},
3835 filter => { holdable => 't', deleted => 'f' },
3838 ccs => {field => 'id', filter => { holdable => 't'}, fkey => 'status' }
3841 where => {'+acp' => { circulate => 't', deleted => 'f', holdable => 't', circ_lib => $org_unit, status => [0,7]}},
3845 if($hold_type eq 'C' or $hold_type eq 'F' or $hold_type eq 'R') {
3847 $query->{where}->{'+acp'}->{id} = $hold_target;
3849 } elsif($hold_type eq 'V') {
3851 $query->{where}->{'+acp'}->{call_number} = $hold_target;
3853 } elsif($hold_type eq 'P') {
3855 $query->{from}->{acp}->{acpm} = {
3856 field => 'target_copy',
3858 filter => {part => $hold_target},
3861 } elsif($hold_type eq 'I') {
3863 $query->{from}->{acp}->{sitem} = {
3866 filter => {issuance => $hold_target},
3869 } elsif($hold_type eq 'T') {
3871 $query->{from}->{acp}->{acn} = {
3873 fkey => 'call_number',
3877 filter => {id => $hold_target},
3885 $query->{from}->{acp}->{acn} = {
3887 fkey => 'call_number',
3896 filter => {metarecord => $hold_target},
3904 my $res = $e->json_query($query)->[0] or return {};
3905 return {copy => $res->{id}, location => $res->{name}} if $res;
3909 # returns true if the user already has an item checked out
3910 # that could be used to fulfill the requested hold.
3911 sub hold_item_is_checked_out {
3912 my($e, $user_id, $hold_type, $hold_target) = @_;
3915 select => {acp => ['id']},
3916 from => {acp => {}},
3920 in => { # copies for circs the user has checked out
3921 select => {circ => ['target_copy']},
3925 checkin_time => undef,
3927 {stop_fines => ["MAXFINES","LONGOVERDUE"]},
3928 {stop_fines => undef}
3938 if($hold_type eq 'C' || $hold_type eq 'R' || $hold_type eq 'F') {
3940 $query->{where}->{'+acp'}->{id}->{in}->{where}->{'target_copy'} = $hold_target;
3942 } elsif($hold_type eq 'V') {
3944 $query->{where}->{'+acp'}->{call_number} = $hold_target;
3946 } elsif($hold_type eq 'P') {
3948 $query->{from}->{acp}->{acpm} = {
3949 field => 'target_copy',
3951 filter => {part => $hold_target},
3954 } elsif($hold_type eq 'I') {
3956 $query->{from}->{acp}->{sitem} = {
3959 filter => {issuance => $hold_target},
3962 } elsif($hold_type eq 'T') {
3964 $query->{from}->{acp}->{acn} = {
3966 fkey => 'call_number',
3970 filter => {id => $hold_target},
3978 $query->{from}->{acp}->{acn} = {
3980 fkey => 'call_number',
3989 filter => {metarecord => $hold_target},
3997 return $e->json_query($query)->[0];
4000 __PACKAGE__->register_method(
4001 method => 'change_hold_title',
4002 api_name => 'open-ils.circ.hold.change_title',
4005 Updates all title level holds targeting the specified bibs to point a new bib./,
4007 { desc => 'Authentication Token', type => 'string' },
4008 { desc => 'New Target Bib Id', type => 'number' },
4009 { desc => 'Old Target Bib Ids', type => 'array' },
4011 return => { desc => '1 on success' }
4015 __PACKAGE__->register_method(
4016 method => 'change_hold_title_for_specific_holds',
4017 api_name => 'open-ils.circ.hold.change_title.specific_holds',
4020 Updates specified holds to target new bib./,
4022 { desc => 'Authentication Token', type => 'string' },
4023 { desc => 'New Target Bib Id', type => 'number' },
4024 { desc => 'Holds Ids for holds to update', type => 'array' },
4026 return => { desc => '1 on success' }
4031 sub change_hold_title {
4032 my( $self, $client, $auth, $new_bib_id, $bib_ids ) = @_;
4034 my $e = new_editor(authtoken=>$auth, xact=>1);
4035 return $e->die_event unless $e->checkauth;
4037 my $holds = $e->search_action_hold_request(
4040 capture_time => undef,
4041 cancel_time => undef,
4042 fulfillment_time => undef,
4048 flesh_fields => { ahr => ['usr'] }
4054 for my $hold (@$holds) {
4055 $e->allowed('UPDATE_HOLD', $hold->usr->home_ou) or return $e->die_event;
4056 $logger->info("Changing hold " . $hold->id . " target from " . $hold->target . " to $new_bib_id in title hold target change");
4057 $hold->target( $new_bib_id );
4058 $e->update_action_hold_request($hold) or return $e->die_event;
4063 _reset_hold($self, $e->requestor, $_) for @$holds;
4068 sub change_hold_title_for_specific_holds {
4069 my( $self, $client, $auth, $new_bib_id, $hold_ids ) = @_;
4071 my $e = new_editor(authtoken=>$auth, xact=>1);
4072 return $e->die_event unless $e->checkauth;
4074 my $holds = $e->search_action_hold_request(
4077 capture_time => undef,
4078 cancel_time => undef,
4079 fulfillment_time => undef,
4085 flesh_fields => { ahr => ['usr'] }
4091 for my $hold (@$holds) {
4092 $e->allowed('UPDATE_HOLD', $hold->usr->home_ou) or return $e->die_event;
4093 $logger->info("Changing hold " . $hold->id . " target from " . $hold->target . " to $new_bib_id in title hold target change");
4094 $hold->target( $new_bib_id );
4095 $e->update_action_hold_request($hold) or return $e->die_event;
4100 _reset_hold($self, $e->requestor, $_) for @$holds;
4105 __PACKAGE__->register_method(
4106 method => 'rec_hold_count',
4107 api_name => 'open-ils.circ.bre.holds.count',
4109 desc => q/Returns the total number of holds that target the
4110 selected bib record or its associated copies and call_numbers/,
4112 { desc => 'Bib ID', type => 'number' },
4113 { desc => q/Optional arguments. Supported arguments include:
4114 "pickup_lib_descendant" -> limit holds to those whose pickup
4115 library is equal to or is a child of the provided org unit/,
4119 return => {desc => 'Hold count', type => 'number'}
4123 __PACKAGE__->register_method(
4124 method => 'rec_hold_count',
4125 api_name => 'open-ils.circ.mmr.holds.count',
4127 desc => q/Returns the total number of holds that target the
4128 selected metarecord or its associated copies, call_numbers, and bib records/,
4130 { desc => 'Metarecord ID', type => 'number' },
4132 return => {desc => 'Hold count', type => 'number'}
4136 # XXX Need to add type I holds to these counts
4137 sub rec_hold_count {
4138 my($self, $conn, $target_id, $args) = @_;
4145 filter => {metarecord => $target_id}
4152 filter => { id => $target_id },
4157 if($self->api_name =~ /mmr/) {
4158 delete $bre_join->{bre}->{filter};
4159 $bre_join->{bre}->{join} = $mmr_join;
4165 fkey => 'call_number',
4171 select => {ahr => [{column => 'id', transform => 'count', alias => 'count'}]},
4175 cancel_time => undef,
4176 fulfillment_time => undef,
4180 hold_type => [qw/C F R/],
4183 select => {acp => ['id']},
4184 from => { acp => $cn_join }
4194 select => {acn => ['id']},
4195 from => {acn => $bre_join}
4205 select => {bmp => ['id']},
4206 from => {bmp => $bre_join}
4214 target => $target_id
4222 if($self->api_name =~ /mmr/) {
4223 $query->{where}->{'+ahr'}->{'-or'}->[3] = {
4228 select => {bre => ['id']},
4229 from => {bre => $mmr_join}
4235 $query->{where}->{'+ahr'}->{'-or'}->[4] = {
4238 target => $target_id
4244 if (my $pld = $args->{pickup_lib_descendant}) {
4246 my $top_ou = new_editor()->search_actor_org_unit(
4247 {parent_ou => undef}
4248 )->[0]; # XXX Assumes single root node. Not alone in this...
4250 $query->{where}->{'+ahr'}->{pickup_lib} = {
4252 select => {aou => [{
4254 transform => 'actor.org_unit_descendants',
4255 result_field => 'id'
4258 where => {id => $pld}
4260 } if ($pld != $top_ou->id);
4264 return new_editor()->json_query($query)->[0]->{count};
4267 # A helper function to calculate a hold's expiration time at a given
4268 # org_unit. Takes the org_unit as an argument and returns either the
4269 # hold expire time as an ISO8601 string or undef if there is no hold
4270 # expiration interval set for the subject ou.
4271 sub calculate_expire_time
4274 my $interval = $U->ou_ancestor_setting_value($ou, OILS_SETTING_HOLD_EXPIRE);
4276 my $date = DateTime->now->add(seconds => OpenSRF::Utils::interval_to_seconds($interval));
4277 return $U->epoch2ISO8601($date->epoch);
4283 __PACKAGE__->register_method(
4284 method => 'mr_hold_filter_attrs',
4285 api_name => 'open-ils.circ.mmr.holds.filters',
4290 Returns the set of available formats and languages for the
4291 constituent records of the provided metarcord.
4292 If an array of hold IDs is also provided, information about
4293 each is returned as well. This information includes:
4294 1. a slightly easier to read version of holdable_formats
4295 2. attributes describing the set of format icons included
4296 in the set of desired, constituent records.
4299 {desc => 'Metarecord ID', type => 'number'},
4300 {desc => 'Context Org ID', type => 'number'},
4301 {desc => 'Hold ID List', type => 'array'},
4305 Stream of objects. The first will have a 'metarecord' key
4306 containing non-hold-specific metarecord information, subsequent
4307 responses will contain a 'hold' key containing hold-specific
4315 sub mr_hold_filter_attrs {
4316 my ($self, $client, $mr_id, $org_id, $hold_ids) = @_;
4317 my $e = new_editor();
4319 # by default, return MR / hold attributes for all constituent
4320 # records with holdable copies. If there is a hard boundary,
4321 # though, limit to records with copies within the boundary,
4322 # since anything outside the boundary can never be held.
4325 $org_depth = $U->ou_ancestor_setting_value(
4326 $org_id, OILS_SETTING_HOLD_HARD_BOUNDARY) || 0;
4329 # get all org-scoped records w/ holdable copies for this metarecord
4330 my ($bre_ids) = $self->method_lookup(
4331 'open-ils.circ.holds.metarecord.filtered_records')->run(
4332 $mr_id, undef, $org_id, $org_depth);
4334 my $item_lang_attr = 'item_lang'; # configurable?
4335 my $format_attr = $e->retrieve_config_global_flag(
4336 'opac.metarecord.holds.format_attr')->value;
4338 # helper sub for fetching ccvms for a batch of record IDs
4339 sub get_batch_ccvms {
4340 my ($e, $attr, $bre_ids) = @_;
4341 return [] unless $bre_ids and @$bre_ids;
4342 my $vals = $e->search_metabib_record_attr_flat({
4346 return [] unless @$vals;
4347 return $e->search_config_coded_value_map({
4349 code => [map {$_->value} @$vals]
4353 my $langs = get_batch_ccvms($e, $item_lang_attr, $bre_ids);
4354 my $formats = get_batch_ccvms($e, $format_attr, $bre_ids);
4359 formats => $formats,
4364 return unless $hold_ids;
4365 my $icon_attr = $e->retrieve_config_global_flag('opac.icon_attr');
4366 $icon_attr = $icon_attr ? $icon_attr->value : '';
4368 for my $hold_id (@$hold_ids) {
4369 my $hold = $e->retrieve_action_hold_request($hold_id)
4370 or return $e->event;
4372 next unless $hold->hold_type eq 'M';
4382 # collect the ccvm's for the selected formats / language
4383 # (i.e. the holdable formats) on the MR.
4384 # this assumes a two-key structure for format / language,
4385 # though no assumption is made about the keys themselves.
4386 my $hformats = OpenSRF::Utils::JSON->JSON2perl($hold->holdable_formats);
4388 my $format_vals = [];
4389 for my $val (values %$hformats) {
4390 # val is either a single ccvm or an array of them
4391 $val = [$val] unless ref $val eq 'ARRAY';
4392 for my $node (@$val) {
4393 push (@$lang_vals, $node->{_val})
4394 if $node->{_attr} eq $item_lang_attr;
4395 push (@$format_vals, $node->{_val})
4396 if $node->{_attr} eq $format_attr;
4400 # fetch the ccvm's for consistency with the {metarecord} blob
4401 $resp->{hold}{formats} = $e->search_config_coded_value_map({
4402 ctype => $format_attr, code => $format_vals});
4403 $resp->{hold}{langs} = $e->search_config_coded_value_map({
4404 ctype => $item_lang_attr, code => $lang_vals});
4406 # find all of the bib records within this metarcord whose
4407 # format / language match the holdable formats on the hold
4408 my ($bre_ids) = $self->method_lookup(
4409 'open-ils.circ.holds.metarecord.filtered_records')->run(
4410 $hold->target, $hold->holdable_formats,
4411 $hold->selection_ou, $hold->selection_depth);
4413 # now find all of the 'icon' attributes for the records
4414 $resp->{hold}{icons} = get_batch_ccvms($e, $icon_attr, $bre_ids);
4415 $client->respond($resp);
4421 __PACKAGE__->register_method(
4422 method => "copy_has_holds_count",
4423 api_name => "open-ils.circ.copy.has_holds_count",
4427 Returns the number of holds a paticular copy has
4430 { desc => 'Authentication Token', type => 'string'},
4431 { desc => 'Copy ID', type => 'number'}
4442 sub copy_has_holds_count {
4443 my( $self, $conn, $auth, $copyid ) = @_;
4444 my $e = new_editor(authtoken=>$auth);
4445 return $e->event unless $e->checkauth;
4447 if( $copyid && $copyid > 0 ) {
4448 my $meth = 'retrieve_action_has_holds_count';
4449 my $data = $e->$meth($copyid);
4451 return $data->count();