1 # ---------------------------------------------------------------
2 # Copyright (C) 2005 Georgia Public Library Service
3 # Bill Erickson <highfalutin@gmail.com>
5 # This program is free software; you can redistribute it and/or
6 # modify it under the terms of the GNU General Public License
7 # as published by the Free Software Foundation; either version 2
8 # of the License, or (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
14 # ---------------------------------------------------------------
17 package OpenILS::Application::Circ::Holds;
18 use base qw/OpenILS::Application/;
19 use strict; use warnings;
20 use OpenILS::Application::AppUtils;
23 use OpenSRF::EX qw(:try);
27 use OpenSRF::Utils::Logger qw(:logger);
28 use OpenILS::Utils::CStoreEditor q/:funcs/;
29 use OpenILS::Utils::PermitHold;
30 use OpenSRF::Utils::SettingsClient;
31 use OpenILS::Const qw/:const/;
32 use OpenILS::Application::Circ::Transit;
33 use OpenILS::Application::Actor::Friends;
35 use DateTime::Format::ISO8601;
36 use OpenSRF::Utils qw/:datetime/;
37 use Digest::MD5 qw(md5_hex);
38 use OpenSRF::Utils::Cache;
39 my $apputils = "OpenILS::Application::AppUtils";
42 __PACKAGE__->register_method(
43 method => "test_and_create_hold_batch",
44 api_name => "open-ils.circ.holds.test_and_create.batch",
47 desc => q/This is for batch creating a set of holds where every field is identical except for the targets./,
49 { desc => 'Authentication token', type => 'string' },
50 { desc => 'Hash of named parameters. Same as for open-ils.circ.title_hold.is_possible, though the pertinent target field is automatically populated based on the hold_type and the specified list of targets.', type => 'object'},
51 { desc => 'Array of target ids', type => 'array' }
54 desc => 'Array of hold ID on success, -1 on missing arg, event (or ref to array of events) on error(s)',
59 __PACKAGE__->register_method(
60 method => "test_and_create_hold_batch",
61 api_name => "open-ils.circ.holds.test_and_create.batch.override",
64 desc => '@see open-ils.circ.holds.test_and_create.batch',
69 sub test_and_create_hold_batch {
70 my( $self, $conn, $auth, $params, $target_list, $oargs ) = @_;
72 my $override = 1 if $self->api_name =~ /override/;
73 $oargs = { all => 1 } unless defined $oargs;
75 my $e = new_editor(authtoken=>$auth);
76 return $e->die_event unless $e->checkauth;
77 $$params{'requestor'} = $e->requestor->id;
80 if ($$params{'hold_type'} eq 'T') { $target_field = 'titleid'; }
81 elsif ($$params{'hold_type'} eq 'C') { $target_field = 'copy_id'; }
82 elsif ($$params{'hold_type'} eq 'R') { $target_field = 'copy_id'; }
83 elsif ($$params{'hold_type'} eq 'F') { $target_field = 'copy_id'; }
84 elsif ($$params{'hold_type'} eq 'I') { $target_field = 'issuanceid'; }
85 elsif ($$params{'hold_type'} eq 'V') { $target_field = 'volume_id'; }
86 elsif ($$params{'hold_type'} eq 'M') { $target_field = 'mrid'; }
87 elsif ($$params{'hold_type'} eq 'P') { $target_field = 'partid'; }
88 else { return undef; }
90 foreach (@$target_list) {
91 $$params{$target_field} = $_;
93 ($res) = $self->method_lookup(
94 'open-ils.circ.title_hold.is_possible')->run($auth, $params, $override ? $oargs : {});
95 if ($res->{'success'} == 1) {
96 my $ahr = construct_hold_request_object($params);
97 my ($res2) = $self->method_lookup(
99 ? 'open-ils.circ.holds.create.override'
100 : 'open-ils.circ.holds.create'
101 )->run($auth, $ahr, $oargs);
103 'target' => $$params{$target_field},
106 $conn->respond($res2);
109 'target' => $$params{$target_field},
112 $conn->respond($res);
118 sub construct_hold_request_object {
121 my $ahr = Fieldmapper::action::hold_request->new;
124 foreach my $field (keys %{ $params }) {
125 if ($field eq 'depth') { $ahr->selection_depth($$params{$field}); }
126 elsif ($field eq 'patronid') {
127 $ahr->usr($$params{$field}); }
128 elsif ($field eq 'titleid') { $ahr->target($$params{$field}); }
129 elsif ($field eq 'copy_id') { $ahr->target($$params{$field}); }
130 elsif ($field eq 'issuanceid') { $ahr->target($$params{$field}); }
131 elsif ($field eq 'volume_id') { $ahr->target($$params{$field}); }
132 elsif ($field eq 'mrid') { $ahr->target($$params{$field}); }
133 elsif ($field eq 'partid') { $ahr->target($$params{$field}); }
135 $ahr->$field($$params{$field});
141 __PACKAGE__->register_method(
142 method => "create_hold_batch",
143 api_name => "open-ils.circ.holds.create.batch",
146 desc => q/@see open-ils.circ.holds.create.batch/,
148 { desc => 'Authentication token', type => 'string' },
149 { desc => 'Array of hold objects', type => 'array' }
152 desc => 'Array of hold ID on success, -1 on missing arg, event (or ref to array of events) on error(s)',
157 __PACKAGE__->register_method(
158 method => "create_hold_batch",
159 api_name => "open-ils.circ.holds.create.override.batch",
162 desc => '@see open-ils.circ.holds.create.batch',
167 sub create_hold_batch {
168 my( $self, $conn, $auth, $hold_list, $oargs ) = @_;
169 (my $method = $self->api_name) =~ s/\.batch//og;
170 foreach (@$hold_list) {
171 my ($res) = $self->method_lookup($method)->run($auth, $_, $oargs);
172 $conn->respond($res);
178 __PACKAGE__->register_method(
179 method => "create_hold",
180 api_name => "open-ils.circ.holds.create",
182 desc => "Create a new hold for an item. From a permissions perspective, " .
183 "the login session is used as the 'requestor' of the hold. " .
184 "The hold recipient is determined by the 'usr' setting within the hold object. " .
185 'First we verify the requestor has holds request permissions. ' .
186 'Then we verify that the recipient is allowed to make the given hold. ' .
187 'If not, we see if the requestor has "override" capabilities. If not, ' .
188 'a permission exception is returned. If permissions allow, we cycle ' .
189 'through the set of holds objects and create. ' .
190 'If the recipient does not have permission to place multiple holds ' .
191 'on a single title and said operation is attempted, a permission ' .
192 'exception is returned',
194 { desc => 'Authentication token', type => 'string' },
195 { desc => 'Hold object for hold to be created',
196 type => 'object', class => 'ahr' }
199 desc => 'New ahr ID on success, -1 on missing arg, event (or ref to array of events) on error(s)',
204 __PACKAGE__->register_method(
205 method => "create_hold",
206 api_name => "open-ils.circ.holds.create.override",
207 notes => '@see open-ils.circ.holds.create',
209 desc => "If the recipient is not allowed to receive the requested hold, " .
210 "call this method to attempt the override",
212 { desc => 'Authentication token', type => 'string' },
214 desc => 'Hold object for hold to be created',
215 type => 'object', class => 'ahr'
219 desc => 'New hold (ahr) ID on success, -1 on missing arg, event (or ref to array of events) on error(s)',
225 my( $self, $conn, $auth, $hold, $oargs ) = @_;
226 return -1 unless $hold;
227 my $e = new_editor(authtoken=>$auth, xact=>1);
228 return $e->die_event unless $e->checkauth;
230 my $override = 1 if $self->api_name =~ /override/;
231 $oargs = { all => 1 } unless defined $oargs;
235 my $requestor = $e->requestor;
236 my $recipient = $requestor;
238 if( $requestor->id ne $hold->usr ) {
239 # Make sure the requestor is allowed to place holds for
240 # the recipient if they are not the same people
241 $recipient = $e->retrieve_actor_user($hold->usr) or return $e->die_event;
242 $e->allowed('REQUEST_HOLDS', $recipient->home_ou) or return $e->die_event;
245 # If the related org setting tells us to, block if patron privs have expired
246 my $expire_setting = $U->ou_ancestor_setting_value($recipient->home_ou, OILS_SETTING_BLOCK_HOLD_FOR_EXPIRED_PATRON);
247 if ($expire_setting) {
248 my $expire = DateTime::Format::ISO8601->new->parse_datetime(
249 cleanse_ISO8601($recipient->expire_date));
251 push( @events, OpenILS::Event->new(
252 'PATRON_ACCOUNT_EXPIRED',
253 "payload" => {"fail_part" => "actor.usr.privs_expired"}
254 )) if( CORE::time > $expire->epoch ) ;
257 # Now make sure the recipient is allowed to receive the specified hold
258 my $porg = $recipient->home_ou;
259 my $rid = $e->requestor->id;
260 my $t = $hold->hold_type;
262 # See if a duplicate hold already exists
264 usr => $recipient->id,
266 fulfillment_time => undef,
267 target => $hold->target,
268 cancel_time => undef,
271 $sargs->{holdable_formats} = $hold->holdable_formats if $t eq 'M';
273 my $existing = $e->search_action_hold_request($sargs);
274 push( @events, OpenILS::Event->new('HOLD_EXISTS')) if @$existing;
276 my $checked_out = hold_item_is_checked_out($e, $recipient->id, $hold->hold_type, $hold->target);
277 push( @events, OpenILS::Event->new('HOLD_ITEM_CHECKED_OUT')) if $checked_out;
279 if ( $t eq OILS_HOLD_TYPE_METARECORD ) {
280 return $e->die_event unless $e->allowed('MR_HOLDS', $porg);
281 } elsif ( $t eq OILS_HOLD_TYPE_TITLE ) {
282 return $e->die_event unless $e->allowed('TITLE_HOLDS', $porg);
283 } elsif ( $t eq OILS_HOLD_TYPE_VOLUME ) {
284 return $e->die_event unless $e->allowed('VOLUME_HOLDS', $porg);
285 } elsif ( $t eq OILS_HOLD_TYPE_MONOPART ) {
286 return $e->die_event unless $e->allowed('TITLE_HOLDS', $porg);
287 } elsif ( $t eq OILS_HOLD_TYPE_ISSUANCE ) {
288 return $e->die_event unless $e->allowed('ISSUANCE_HOLDS', $porg);
289 } elsif ( $t eq OILS_HOLD_TYPE_COPY ) {
290 return $e->die_event unless $e->allowed('COPY_HOLDS', $porg);
291 } elsif ( $t eq OILS_HOLD_TYPE_FORCE || $t eq OILS_HOLD_TYPE_RECALL ) {
292 my $copy = $e->retrieve_asset_copy($hold->target)
293 or return $e->die_event;
294 if ( $t eq OILS_HOLD_TYPE_FORCE ) {
295 return $e->die_event unless $e->allowed('COPY_HOLDS_FORCE', $copy->circ_lib);
296 } elsif ( $t eq OILS_HOLD_TYPE_RECALL ) {
297 return $e->die_event unless $e->allowed('COPY_HOLDS_RECALL', $copy->circ_lib);
306 for my $evt (@events) {
308 my $name = $evt->{textcode};
309 if($oargs->{all} || grep { $_ eq $name } @{$oargs->{events}}) {
310 return $e->die_event unless $e->allowed("$name.override", $porg);
318 # set the configured expire time
319 unless($hold->expire_time) {
320 my $interval = $U->ou_ancestor_setting_value($recipient->home_ou, OILS_SETTING_HOLD_EXPIRE);
322 my $date = DateTime->now->add(seconds => OpenSRF::Utils::interval_to_seconds($interval));
323 $hold->expire_time($U->epoch2ISO8601($date->epoch));
327 $hold->requestor($e->requestor->id);
328 $hold->request_lib($e->requestor->ws_ou);
329 $hold->selection_ou($hold->pickup_lib) unless $hold->selection_ou;
330 $hold = $e->create_action_hold_request($hold) or return $e->die_event;
334 $conn->respond_complete($hold->id);
337 'open-ils.storage.action.hold_request.copy_targeter',
338 undef, $hold->id ) unless $U->is_true($hold->frozen);
343 # makes sure that a user has permission to place the type of requested hold
344 # returns the Perm exception if not allowed, returns undef if all is well
345 sub _check_holds_perm {
346 my($type, $user_id, $org_id) = @_;
350 $evt = $apputils->check_perms($user_id, $org_id, "MR_HOLDS" );
351 } elsif ($type eq "T") {
352 $evt = $apputils->check_perms($user_id, $org_id, "TITLE_HOLDS" );
353 } elsif($type eq "V") {
354 $evt = $apputils->check_perms($user_id, $org_id, "VOLUME_HOLDS");
355 } elsif($type eq "C") {
356 $evt = $apputils->check_perms($user_id, $org_id, "COPY_HOLDS" );
363 # tests if the given user is allowed to place holds on another's behalf
364 sub _check_request_holds_perm {
367 if (my $evt = $apputils->check_perms(
368 $user_id, $org_id, "REQUEST_HOLDS")) {
373 my $ses_is_req_note = 'The login session is the requestor. If the requestor is different from the user, ' .
374 'then the requestor must have VIEW_HOLD permissions';
376 __PACKAGE__->register_method(
377 method => "retrieve_holds_by_id",
378 api_name => "open-ils.circ.holds.retrieve_by_id",
380 desc => "Retrieve the hold, with hold transits attached, for the specified ID. $ses_is_req_note",
382 { desc => 'Authentication token', type => 'string' },
383 { desc => 'Hold ID', type => 'number' }
386 desc => 'Hold object with transits attached, event on error',
392 sub retrieve_holds_by_id {
393 my($self, $client, $auth, $hold_id) = @_;
394 my $e = new_editor(authtoken=>$auth);
395 $e->checkauth or return $e->event;
396 $e->allowed('VIEW_HOLD') or return $e->event;
398 my $holds = $e->search_action_hold_request(
400 { id => $hold_id , fulfillment_time => undef },
402 order_by => { ahr => "request_time" },
404 flesh_fields => {ahr => ['notes']}
409 flesh_hold_transits($holds);
410 flesh_hold_notices($holds, $e);
415 __PACKAGE__->register_method(
416 method => "retrieve_holds",
417 api_name => "open-ils.circ.holds.retrieve",
419 desc => "Retrieves all the holds, with hold transits attached, for the specified user. $ses_is_req_note",
421 { desc => 'Authentication token', type => 'string' },
422 { desc => 'User ID', type => 'integer' },
423 { desc => 'Available Only', type => 'boolean' }
426 desc => 'list of holds, event on error',
431 __PACKAGE__->register_method(
432 method => "retrieve_holds",
433 api_name => "open-ils.circ.holds.id_list.retrieve",
436 desc => "Retrieves all the hold IDs, for the specified user. $ses_is_req_note",
438 { desc => 'Authentication token', type => 'string' },
439 { desc => 'User ID', type => 'integer' },
440 { desc => 'Available Only', type => 'boolean' }
443 desc => 'list of holds, event on error',
448 __PACKAGE__->register_method(
449 method => "retrieve_holds",
450 api_name => "open-ils.circ.holds.canceled.retrieve",
453 desc => "Retrieves all the cancelled holds for the specified user. $ses_is_req_note",
455 { desc => 'Authentication token', type => 'string' },
456 { desc => 'User ID', type => 'integer' }
459 desc => 'list of holds, event on error',
464 __PACKAGE__->register_method(
465 method => "retrieve_holds",
466 api_name => "open-ils.circ.holds.canceled.id_list.retrieve",
469 desc => "Retrieves list of cancelled hold IDs for the specified user. $ses_is_req_note",
471 { desc => 'Authentication token', type => 'string' },
472 { desc => 'User ID', type => 'integer' }
475 desc => 'list of hold IDs, event on error',
482 my ($self, $client, $auth, $user_id, $available) = @_;
484 my $e = new_editor(authtoken=>$auth);
485 return $e->event unless $e->checkauth;
486 $user_id = $e->requestor->id unless defined $user_id;
488 my $notes_filter = {staff => 'f'};
489 my $user = $e->retrieve_actor_user($user_id) or return $e->event;
490 unless($user_id == $e->requestor->id) {
491 if($e->allowed('VIEW_HOLD', $user->home_ou)) {
492 $notes_filter = {staff => 't'}
494 my $allowed = OpenILS::Application::Actor::Friends->friend_perm_allowed(
495 $e, $user_id, $e->requestor->id, 'hold.view');
496 return $e->event unless $allowed;
499 # staff member looking at his/her own holds can see staff and non-staff notes
500 $notes_filter = {} if $e->allowed('VIEW_HOLD', $user->home_ou);
504 select => {ahr => ['id']},
506 where => {usr => $user_id, fulfillment_time => undef}
509 if($self->api_name =~ /canceled/) {
511 # Fetch the canceled holds
512 # order cancelled holds by cancel time, most recent first
514 $holds_query->{order_by} = [{class => 'ahr', field => 'cancel_time', direction => 'desc'}];
517 my $cancel_count = $U->ou_ancestor_setting_value(
518 $e->requestor->ws_ou, 'circ.holds.canceled.display_count', $e);
520 unless($cancel_count) {
521 $cancel_age = $U->ou_ancestor_setting_value(
522 $e->requestor->ws_ou, 'circ.holds.canceled.display_age', $e);
524 # if no settings are defined, default to last 10 cancelled holds
525 $cancel_count = 10 unless $cancel_age;
528 if($cancel_count) { # limit by count
530 $holds_query->{where}->{cancel_time} = {'!=' => undef};
531 $holds_query->{limit} = $cancel_count;
533 } elsif($cancel_age) { # limit by age
535 # find all of the canceled holds that were canceled within the configured time frame
536 my $date = DateTime->now->subtract(seconds => OpenSRF::Utils::interval_to_seconds($cancel_age));
537 $date = $U->epoch2ISO8601($date->epoch);
538 $holds_query->{where}->{cancel_time} = {'>=' => $date};
543 # order non-cancelled holds by ready-for-pickup, then active, followed by suspended
544 # "compare" sorts false values to the front. testing pickup_lib != current_shelf_lib
545 # will sort by pl = csl > pl != csl > followed by csl is null;
546 $holds_query->{order_by} = [
548 field => 'pickup_lib',
549 compare => {'!=' => {'+ahr' => 'current_shelf_lib'}}},
550 {class => 'ahr', field => 'shelf_time'},
551 {class => 'ahr', field => 'frozen'},
552 {class => 'ahr', field => 'request_time'}
555 $holds_query->{where}->{cancel_time} = undef;
557 $holds_query->{where}->{shelf_time} = {'!=' => undef};
559 $holds_query->{where}->{pickup_lib} = {'+ahr' => 'current_shelf_lib'};
563 my $hold_ids = $e->json_query($holds_query);
564 $hold_ids = [ map { $_->{id} } @$hold_ids ];
566 return $hold_ids if $self->api_name =~ /id_list/;
569 for my $hold_id ( @$hold_ids ) {
571 my $hold = $e->retrieve_action_hold_request($hold_id);
572 $hold->notes($e->search_action_hold_request_note({hold => $hold_id, %$notes_filter}));
575 $e->search_action_hold_transit_copy([
577 {order_by => {ahtc => 'source_send_time desc'}, limit => 1}])->[0]
587 __PACKAGE__->register_method(
588 method => 'user_hold_count',
589 api_name => 'open-ils.circ.hold.user.count'
592 sub user_hold_count {
593 my ( $self, $conn, $auth, $userid ) = @_;
594 my $e = new_editor( authtoken => $auth );
595 return $e->event unless $e->checkauth;
596 my $patron = $e->retrieve_actor_user($userid)
598 return $e->event unless $e->allowed( 'VIEW_HOLD', $patron->home_ou );
599 return __user_hold_count( $self, $e, $userid );
602 sub __user_hold_count {
603 my ( $self, $e, $userid ) = @_;
604 my $holds = $e->search_action_hold_request(
607 fulfillment_time => undef,
608 cancel_time => undef,
613 return scalar(@$holds);
617 __PACKAGE__->register_method(
618 method => "retrieve_holds_by_pickup_lib",
619 api_name => "open-ils.circ.holds.retrieve_by_pickup_lib",
621 "Retrieves all the holds, with hold transits attached, for the specified pickup_ou id."
624 __PACKAGE__->register_method(
625 method => "retrieve_holds_by_pickup_lib",
626 api_name => "open-ils.circ.holds.id_list.retrieve_by_pickup_lib",
627 notes => "Retrieves all the hold ids for the specified pickup_ou id. "
630 sub retrieve_holds_by_pickup_lib {
631 my ($self, $client, $login_session, $ou_id) = @_;
633 #FIXME -- put an appropriate permission check here
634 #my( $user, $target, $evt ) = $apputils->checkses_requestor(
635 # $login_session, $user_id, 'VIEW_HOLD' );
636 #return $evt if $evt;
638 my $holds = $apputils->simplereq(
640 "open-ils.cstore.direct.action.hold_request.search.atomic",
642 pickup_lib => $ou_id ,
643 fulfillment_time => undef,
646 { order_by => { ahr => "request_time" } }
649 if ( ! $self->api_name =~ /id_list/ ) {
650 flesh_hold_transits($holds);
654 return [ map { $_->id } @$holds ];
658 __PACKAGE__->register_method(
659 method => "uncancel_hold",
660 api_name => "open-ils.circ.hold.uncancel"
664 my($self, $client, $auth, $hold_id) = @_;
665 my $e = new_editor(authtoken=>$auth, xact=>1);
666 return $e->die_event unless $e->checkauth;
668 my $hold = $e->retrieve_action_hold_request($hold_id)
669 or return $e->die_event;
670 return $e->die_event unless $e->allowed('CANCEL_HOLDS', $hold->request_lib);
672 if ($hold->fulfillment_time) {
676 unless ($hold->cancel_time) {
681 # if configured to reset the request time, also reset the expire time
682 if($U->ou_ancestor_setting_value(
683 $hold->request_lib, 'circ.holds.uncancel.reset_request_time', $e)) {
685 $hold->request_time('now');
686 my $interval = $U->ou_ancestor_setting_value($hold->request_lib, OILS_SETTING_HOLD_EXPIRE);
688 my $date = DateTime->now->add(seconds => OpenSRF::Utils::interval_to_seconds($interval));
689 $hold->expire_time($U->epoch2ISO8601($date->epoch));
693 $hold->clear_cancel_time;
694 $hold->clear_cancel_cause;
695 $hold->clear_cancel_note;
696 $hold->clear_shelf_time;
697 $hold->clear_current_copy;
698 $hold->clear_capture_time;
699 $hold->clear_prev_check_time;
700 $hold->clear_shelf_expire_time;
701 $hold->clear_current_shelf_lib;
703 $e->update_action_hold_request($hold) or return $e->die_event;
706 $U->storagereq('open-ils.storage.action.hold_request.copy_targeter', undef, $hold_id);
712 __PACKAGE__->register_method(
713 method => "cancel_hold",
714 api_name => "open-ils.circ.hold.cancel",
716 desc => 'Cancels the specified hold. The login session is the requestor. If the requestor is different from the usr field ' .
717 'on the hold, the requestor must have CANCEL_HOLDS permissions. The hold may be either the hold object or the hold id',
719 {desc => 'Authentication token', type => 'string'},
720 {desc => 'Hold ID', type => 'number'},
721 {desc => 'Cause of Cancellation', type => 'string'},
722 {desc => 'Note', type => 'string'}
725 desc => '1 on success, event on error'
731 my($self, $client, $auth, $holdid, $cause, $note) = @_;
733 my $e = new_editor(authtoken=>$auth, xact=>1);
734 return $e->die_event unless $e->checkauth;
736 my $hold = $e->retrieve_action_hold_request($holdid)
737 or return $e->die_event;
739 if( $e->requestor->id ne $hold->usr ) {
740 return $e->die_event unless $e->allowed('CANCEL_HOLDS');
743 if ($hold->cancel_time) {
748 # If the hold is captured, reset the copy status
749 if( $hold->capture_time and $hold->current_copy ) {
751 my $copy = $e->retrieve_asset_copy($hold->current_copy)
752 or return $e->die_event;
754 if( $copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF ) {
755 $logger->info("canceling hold $holdid whose item is on the holds shelf");
756 # $logger->info("setting copy to status 'reshelving' on hold cancel");
757 # $copy->status(OILS_COPY_STATUS_RESHELVING);
758 # $copy->editor($e->requestor->id);
759 # $copy->edit_date('now');
760 # $e->update_asset_copy($copy) or return $e->event;
762 } elsif( $copy->status == OILS_COPY_STATUS_IN_TRANSIT ) {
765 $logger->warn("! canceling hold [$hid] that is in transit");
766 my $transid = $e->search_action_hold_transit_copy({hold=>$hold->id},{idlist=>1})->[0];
769 my $trans = $e->retrieve_action_transit_copy($transid);
770 # Leave the transit alive, but set the copy status to
771 # reshelving so it will be properly reshelved when it gets back home
773 $trans->copy_status( OILS_COPY_STATUS_RESHELVING );
774 $e->update_action_transit_copy($trans) or return $e->die_event;
780 $hold->cancel_time('now');
781 $hold->cancel_cause($cause);
782 $hold->cancel_note($note);
783 $e->update_action_hold_request($hold)
784 or return $e->die_event;
786 delete_hold_copy_maps($self, $e, $hold->id);
790 # re-fetch the hold to pick up the real cancel_time (not "now") for A/T
792 $hold = $e->retrieve_action_hold_request($hold->id) or return $e->die_event;
795 if ($e->requestor->id == $hold->usr) {
796 $U->create_events_for_hook('hold_request.cancel.patron', $hold, $hold->pickup_lib);
798 $U->create_events_for_hook('hold_request.cancel.staff', $hold, $hold->pickup_lib);
804 sub delete_hold_copy_maps {
809 my $maps = $editor->search_action_hold_copy_map({hold=>$holdid});
811 $editor->delete_action_hold_copy_map($_)
812 or return $editor->event;
818 my $update_hold_desc = 'The login session is the requestor. ' .
819 'If the requestor is different from the usr field on the hold, ' .
820 'the requestor must have UPDATE_HOLDS permissions. ' .
821 'If supplying a hash of hold data, "id" must be included. ' .
822 'The hash is ignored if a hold object is supplied, ' .
823 'so you should supply only one kind of hold data argument.' ;
825 __PACKAGE__->register_method(
826 method => "update_hold",
827 api_name => "open-ils.circ.hold.update",
829 desc => "Updates the specified hold. $update_hold_desc",
831 {desc => 'Authentication token', type => 'string'},
832 {desc => 'Hold Object', type => 'object'},
833 {desc => 'Hash of values to be applied', type => 'object'}
836 desc => 'Hold ID on success, event on error',
842 __PACKAGE__->register_method(
843 method => "batch_update_hold",
844 api_name => "open-ils.circ.hold.update.batch",
847 desc => "Updates the specified hold(s). $update_hold_desc",
849 {desc => 'Authentication token', type => 'string'},
850 {desc => 'Array of hold obejcts', type => 'array' },
851 {desc => 'Array of hashes of values to be applied', type => 'array' }
854 desc => 'Hold ID per success, event per error',
860 my($self, $client, $auth, $hold, $values) = @_;
861 my $e = new_editor(authtoken=>$auth, xact=>1);
862 return $e->die_event unless $e->checkauth;
863 my $resp = update_hold_impl($self, $e, $hold, $values);
864 if ($U->event_code($resp)) {
868 $e->commit; # FIXME: update_hold_impl already does $e->commit ??
872 sub batch_update_hold {
873 my($self, $client, $auth, $hold_list, $values_list) = @_;
874 my $e = new_editor(authtoken=>$auth);
875 return $e->die_event unless $e->checkauth;
877 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.
879 $values_list ||= []; # FIXME: either move this above $count declaration, or send an event if both lists undef. Probably the latter.
881 # FIXME: Failing over to [] guarantees warnings for "Use of unitialized value" in update_hold_impl call.
882 # FIXME: We should be sure we only call update_hold_impl with hold object OR hash, not both.
884 for my $idx (0..$count-1) {
886 my $resp = update_hold_impl($self, $e, $hold_list->[$idx], $values_list->[$idx]);
887 $e->xact_commit unless $U->event_code($resp);
888 $client->respond($resp);
892 return undef; # not in the register return type, assuming we should always have at least one list populated
895 sub update_hold_impl {
896 my($self, $e, $hold, $values) = @_;
898 my $need_retarget = 0;
901 $hold = $e->retrieve_action_hold_request($values->{id})
902 or return $e->die_event;
903 for my $k (keys %$values) {
904 # Outside of pickup_lib (covered by the first regex) I don't know when these would currently change.
905 # But hey, why not cover things that may happen later?
906 if ($k =~ '_(lib|ou)$' || $k eq 'target' || $k eq 'hold_type' || $k eq 'requestor' || $k eq 'selection_depth' || $k eq 'holdable_formats') {
907 if (defined $values->{$k} && defined $hold->$k() && $values->{$k} ne $hold->$k()) {
908 # Value changed? RETARGET!
910 } elsif (defined $hold->$k() != defined $values->{$k}) {
911 # Value being set or cleared? RETARGET!
915 if (defined $values->{$k}) {
916 $hold->$k($values->{$k});
918 my $f = "clear_$k"; $hold->$f();
923 my $orig_hold = $e->retrieve_action_hold_request($hold->id)
924 or return $e->die_event;
926 # don't allow the user to be changed
927 return OpenILS::Event->new('BAD_PARAMS') if $hold->usr != $orig_hold->usr;
929 if($hold->usr ne $e->requestor->id) {
930 # if the hold is for a different user, make sure the
931 # requestor has the appropriate permissions
932 my $usr = $e->retrieve_actor_user($hold->usr)
933 or return $e->die_event;
934 return $e->die_event unless $e->allowed('UPDATE_HOLD', $usr->home_ou);
938 # --------------------------------------------------------------
939 # Changing the request time is like playing God
940 # --------------------------------------------------------------
941 if($hold->request_time ne $orig_hold->request_time) {
942 return OpenILS::Event->new('BAD_PARAMS') if $hold->fulfillment_time;
943 return $e->die_event unless $e->allowed('UPDATE_HOLD_REQUEST_TIME', $hold->pickup_lib);
947 # --------------------------------------------------------------
948 # Code for making sure staff have appropriate permissons for cut_in_line
949 # This, as is, doesn't prevent a user from cutting their own holds in line
951 # --------------------------------------------------------------
952 if($U->is_true($hold->cut_in_line) ne $U->is_true($orig_hold->cut_in_line)) {
953 return $e->die_event unless $e->allowed('UPDATE_HOLD_REQUEST_TIME', $hold->pickup_lib);
957 # --------------------------------------------------------------
958 # Disallow hold suspencion if the hold is already captured.
959 # --------------------------------------------------------------
960 if ($U->is_true($hold->frozen) and not $U->is_true($orig_hold->frozen)) {
961 $hold_status = _hold_status($e, $hold);
962 if ($hold_status > 2 && $hold_status != 7) { # hold is captured
963 $logger->info("bypassing hold freeze on captured hold");
964 return OpenILS::Event->new('HOLD_SUSPEND_AFTER_CAPTURE');
969 # --------------------------------------------------------------
970 # if the hold is on the holds shelf or in transit and the pickup
971 # lib changes we need to create a new transit.
972 # --------------------------------------------------------------
973 if($orig_hold->pickup_lib ne $hold->pickup_lib) {
975 $hold_status = _hold_status($e, $hold) unless $hold_status;
977 if($hold_status == 3) { # in transit
979 return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_TRANSIT', $orig_hold->pickup_lib);
980 return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_TRANSIT', $hold->pickup_lib);
982 $logger->info("updating pickup lib for hold ".$hold->id." while already in transit");
984 # update the transit to reflect the new pickup location
985 my $transit = $e->search_action_hold_transit_copy(
986 {hold=>$hold->id, dest_recv_time => undef})->[0]
987 or return $e->die_event;
989 $transit->prev_dest($transit->dest); # mark the previous destination on the transit
990 $transit->dest($hold->pickup_lib);
991 $e->update_action_hold_transit_copy($transit) or return $e->die_event;
993 } elsif($hold_status == 4 or $hold_status == 5 or $hold_status == 8) { # on holds shelf
995 return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_HOLDS_SHELF', $orig_hold->pickup_lib);
996 return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_HOLDS_SHELF', $hold->pickup_lib);
998 $logger->info("updating pickup lib for hold ".$hold->id." while on holds shelf");
1000 if ($hold->pickup_lib eq $orig_hold->current_shelf_lib) {
1001 # This can happen if the pickup lib is changed while the hold is
1002 # on the shelf, then changed back to the original pickup lib.
1003 # Restore the original shelf_expire_time to prevent abuse.
1004 set_hold_shelf_expire_time(undef, $hold, $e, $hold->shelf_time);
1007 # clear to prevent premature shelf expiration
1008 $hold->clear_shelf_expire_time;
1013 if($U->is_true($hold->frozen)) {
1014 $logger->info("clearing current_copy and check_time for frozen hold ".$hold->id);
1015 $hold->clear_current_copy;
1016 $hold->clear_prev_check_time;
1019 $e->update_action_hold_request($hold) or return $e->die_event;
1022 if(!$U->is_true($hold->frozen) && $U->is_true($orig_hold->frozen)) {
1023 $logger->info("Running targeter on activated hold ".$hold->id);
1024 $U->storagereq( 'open-ils.storage.action.hold_request.copy_targeter', undef, $hold->id );
1027 # a change to mint-condition changes the set of potential copies, so retarget the hold;
1028 if($U->is_true($hold->mint_condition) and !$U->is_true($orig_hold->mint_condition)) {
1029 _reset_hold($self, $e->requestor, $hold)
1030 } elsif($need_retarget && !defined $hold->capture_time()) { # If needed, retarget the hold due to changes
1032 'open-ils.storage.action.hold_request.copy_targeter', undef, $hold->id );
1038 # this does not update the hold in the DB. It only
1039 # sets the shelf_expire_time field on the hold object.
1040 # start_time is optional and defaults to 'now'
1041 sub set_hold_shelf_expire_time {
1042 my ($class, $hold, $editor, $start_time) = @_;
1044 my $shelf_expire = $U->ou_ancestor_setting_value(
1046 'circ.holds.default_shelf_expire_interval',
1050 return undef unless $shelf_expire;
1052 $start_time = ($start_time) ?
1053 DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($start_time)) :
1056 my $seconds = OpenSRF::Utils->interval_to_seconds($shelf_expire);
1057 my $expire_time = $start_time->add(seconds => $seconds);
1059 # if the shelf expire time overlaps with a pickup lib's
1060 # closed date, push it out to the first open date
1061 my $dateinfo = $U->storagereq(
1062 'open-ils.storage.actor.org_unit.closed_date.overlap',
1063 $hold->pickup_lib, $expire_time->strftime('%FT%T%z'));
1066 my $dt_parser = DateTime::Format::ISO8601->new;
1067 $expire_time = $dt_parser->parse_datetime(cleanse_ISO8601($dateinfo->{end}));
1069 # TODO: enable/disable time bump via setting?
1070 $expire_time->set(hour => '23', minute => '59', second => '59');
1072 $logger->info("circulator: shelf_expire_time overlaps".
1073 " with closed date, pushing expire time to $expire_time");
1076 $hold->shelf_expire_time($expire_time->strftime('%FT%T%z'));
1082 my($e, $orig_hold, $hold, $copy) = @_;
1083 my $src = $orig_hold->pickup_lib;
1084 my $dest = $hold->pickup_lib;
1086 $logger->info("putting hold into transit on pickup_lib update");
1088 my $transit = Fieldmapper::action::hold_transit_copy->new;
1089 $transit->hold($hold->id);
1090 $transit->source($src);
1091 $transit->dest($dest);
1092 $transit->target_copy($copy->id);
1093 $transit->source_send_time('now');
1094 $transit->copy_status(OILS_COPY_STATUS_ON_HOLDS_SHELF);
1096 $copy->status(OILS_COPY_STATUS_IN_TRANSIT);
1097 $copy->editor($e->requestor->id);
1098 $copy->edit_date('now');
1100 $e->create_action_hold_transit_copy($transit) or return $e->die_event;
1101 $e->update_asset_copy($copy) or return $e->die_event;
1105 # if the hold is frozen, this method ensures that the hold is not "targeted",
1106 # that is, it clears the current_copy and prev_check_time to essentiallly
1107 # reset the hold. If it is being activated, it runs the targeter in the background
1108 sub update_hold_if_frozen {
1109 my($self, $e, $hold, $orig_hold) = @_;
1110 return if $hold->capture_time;
1112 if($U->is_true($hold->frozen)) {
1113 $logger->info("clearing current_copy and check_time for frozen hold ".$hold->id);
1114 $hold->clear_current_copy;
1115 $hold->clear_prev_check_time;
1118 if($U->is_true($orig_hold->frozen)) {
1119 $logger->info("Running targeter on activated hold ".$hold->id);
1120 $U->storagereq( 'open-ils.storage.action.hold_request.copy_targeter', undef, $hold->id );
1125 __PACKAGE__->register_method(
1126 method => "hold_note_CUD",
1127 api_name => "open-ils.circ.hold_request.note.cud",
1129 desc => 'Create, update or delete a hold request note. If the operator (from Auth. token) '
1130 . 'is not the owner of the hold, the UPDATE_HOLD permission is required',
1132 { desc => 'Authentication token', type => 'string' },
1133 { desc => 'Hold note object', type => 'object' }
1136 desc => 'Returns the note ID, event on error'
1142 my($self, $conn, $auth, $note) = @_;
1144 my $e = new_editor(authtoken => $auth, xact => 1);
1145 return $e->die_event unless $e->checkauth;
1147 my $hold = $e->retrieve_action_hold_request($note->hold)
1148 or return $e->die_event;
1150 if($hold->usr ne $e->requestor->id) {
1151 my $usr = $e->retrieve_actor_user($hold->usr);
1152 return $e->die_event unless $e->allowed('UPDATE_HOLD', $usr->home_ou);
1153 $note->staff('t') if $note->isnew;
1157 $e->create_action_hold_request_note($note) or return $e->die_event;
1158 } elsif($note->ischanged) {
1159 $e->update_action_hold_request_note($note) or return $e->die_event;
1160 } elsif($note->isdeleted) {
1161 $e->delete_action_hold_request_note($note) or return $e->die_event;
1169 __PACKAGE__->register_method(
1170 method => "retrieve_hold_status",
1171 api_name => "open-ils.circ.hold.status.retrieve",
1173 desc => 'Calculates the current status of the hold. The requestor must have ' .
1174 'VIEW_HOLD permissions if the hold is for a user other than the requestor' ,
1176 { desc => 'Hold ID', type => 'number' }
1179 # type => 'number', # event sometimes
1180 desc => <<'END_OF_DESC'
1181 Returns event on error or:
1182 -1 on error (for now),
1183 1 for 'waiting for copy to become available',
1184 2 for 'waiting for copy capture',
1187 5 for 'hold-shelf-delay'
1190 8 for 'captured, on wrong hold shelf'
1196 sub retrieve_hold_status {
1197 my($self, $client, $auth, $hold_id) = @_;
1199 my $e = new_editor(authtoken => $auth);
1200 return $e->event unless $e->checkauth;
1201 my $hold = $e->retrieve_action_hold_request($hold_id)
1202 or return $e->event;
1204 if( $e->requestor->id != $hold->usr ) {
1205 return $e->event unless $e->allowed('VIEW_HOLD');
1208 return _hold_status($e, $hold);
1214 if ($hold->cancel_time) {
1217 if ($U->is_true($hold->frozen) && !$hold->capture_time) {
1220 if ($hold->current_shelf_lib and $hold->current_shelf_lib ne $hold->pickup_lib) {
1223 return 1 unless $hold->current_copy;
1224 return 2 unless $hold->capture_time;
1226 my $copy = $hold->current_copy;
1227 unless( ref $copy ) {
1228 $copy = $e->retrieve_asset_copy($hold->current_copy)
1229 or return $e->event;
1232 return 3 if $copy->status == OILS_COPY_STATUS_IN_TRANSIT;
1234 if($copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF) {
1236 my $hs_wait_interval = $U->ou_ancestor_setting_value($hold->pickup_lib, 'circ.hold_shelf_status_delay');
1237 return 4 unless $hs_wait_interval;
1239 # if a hold_shelf_status_delay interval is defined and start_time plus
1240 # the interval is greater than now, consider the hold to be in the virtual
1241 # "on its way to the holds shelf" status. Return 5.
1243 my $transit = $e->search_action_hold_transit_copy({hold => $hold->id})->[0];
1244 my $start_time = ($transit) ? $transit->dest_recv_time : $hold->capture_time;
1245 $start_time = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($start_time));
1246 my $end_time = $start_time->add(seconds => OpenSRF::Utils::interval_to_seconds($hs_wait_interval));
1248 return 5 if $end_time > DateTime->now;
1257 __PACKAGE__->register_method(
1258 method => "retrieve_hold_queue_stats",
1259 api_name => "open-ils.circ.hold.queue_stats.retrieve",
1261 desc => 'Returns summary data about the state of a hold',
1263 { desc => 'Authentication token', type => 'string'},
1264 { desc => 'Hold ID', type => 'number'},
1267 desc => q/Summary object with keys:
1268 total_holds : total holds in queue
1269 queue_position : current queue position
1270 potential_copies : number of potential copies for this hold
1271 estimated_wait : estimated wait time in days
1272 status : hold status
1273 -1 => error or unexpected state,
1274 1 => 'waiting for copy to become available',
1275 2 => 'waiting for copy capture',
1278 5 => 'hold-shelf-delay'
1285 sub retrieve_hold_queue_stats {
1286 my($self, $conn, $auth, $hold_id) = @_;
1287 my $e = new_editor(authtoken => $auth);
1288 return $e->event unless $e->checkauth;
1289 my $hold = $e->retrieve_action_hold_request($hold_id) or return $e->event;
1290 if($e->requestor->id != $hold->usr) {
1291 return $e->event unless $e->allowed('VIEW_HOLD');
1293 return retrieve_hold_queue_status_impl($e, $hold);
1296 sub retrieve_hold_queue_status_impl {
1300 # The holds queue is defined as the distinct set of holds that share at
1301 # least one potential copy with the context hold, plus any holds that
1302 # share the same hold type and target. The latter part exists to
1303 # accomodate holds that currently have no potential copies
1304 my $q_holds = $e->json_query({
1306 # fetch cut_in_line and request_time since they're in the order_by
1307 # and we're asking for distinct values
1308 select => {ahr => ['id', 'cut_in_line', 'request_time']},
1315 'field' => 'target_copy',
1316 'fkey' => 'target_copy'
1325 "field" => "cut_in_line",
1326 "transform" => "coalesce",
1328 "direction" => "desc"
1330 { "class" => "ahr", "field" => "request_time" }
1334 '+ahcm2' => { hold => $hold->id }
1338 if (!@$q_holds) { # none? maybe we don't have a map ...
1339 $q_holds = $e->json_query({
1340 select => {ahr => ['id', 'cut_in_line', 'request_time']},
1345 "field" => "cut_in_line",
1346 "transform" => "coalesce",
1348 "direction" => "desc"
1350 { "class" => "ahr", "field" => "request_time" }
1353 hold_type => $hold->hold_type,
1354 target => $hold->target
1361 for my $h (@$q_holds) {
1362 last if $h->{id} == $hold->id;
1366 my $hold_data = $e->json_query({
1368 acp => [ {column => 'id', transform => 'count', aggregate => 1, alias => 'count'} ],
1369 ccm => [ {column =>'avg_wait_time'} ]
1375 ccm => {type => 'left'}
1380 where => {'+ahcm' => {hold => $hold->id} }
1383 my $user_org = $e->json_query({select => {au => ['home_ou']}, from => 'au', where => {id => $hold->usr}})->[0]->{home_ou};
1385 my $default_wait = $U->ou_ancestor_setting_value($user_org, OILS_SETTING_HOLD_ESIMATE_WAIT_INTERVAL);
1386 my $min_wait = $U->ou_ancestor_setting_value($user_org, 'circ.holds.min_estimated_wait_interval');
1387 $min_wait = OpenSRF::Utils::interval_to_seconds($min_wait || '0 seconds');
1388 $default_wait ||= '0 seconds';
1390 # Estimated wait time is the average wait time across the set
1391 # of potential copies, divided by the number of potential copies
1392 # times the queue position.
1394 my $combined_secs = 0;
1395 my $num_potentials = 0;
1397 for my $wait_data (@$hold_data) {
1398 my $count += $wait_data->{count};
1399 $combined_secs += $count *
1400 OpenSRF::Utils::interval_to_seconds($wait_data->{avg_wait_time} || $default_wait);
1401 $num_potentials += $count;
1404 my $estimated_wait = -1;
1406 if($num_potentials) {
1407 my $avg_wait = $combined_secs / $num_potentials;
1408 $estimated_wait = $qpos * ($avg_wait / $num_potentials);
1409 $estimated_wait = $min_wait if $estimated_wait < $min_wait and $estimated_wait != -1;
1413 total_holds => scalar(@$q_holds),
1414 queue_position => $qpos,
1415 potential_copies => $num_potentials,
1416 status => _hold_status( $e, $hold ),
1417 estimated_wait => int($estimated_wait)
1422 sub fetch_open_hold_by_current_copy {
1425 my $hold = $apputils->simplereq(
1427 'open-ils.cstore.direct.action.hold_request.search.atomic',
1428 { current_copy => $copyid , cancel_time => undef, fulfillment_time => undef });
1429 return $hold->[0] if ref($hold);
1433 sub fetch_related_holds {
1436 return $apputils->simplereq(
1438 'open-ils.cstore.direct.action.hold_request.search.atomic',
1439 { current_copy => $copyid , cancel_time => undef, fulfillment_time => undef });
1443 __PACKAGE__->register_method(
1444 method => "hold_pull_list",
1445 api_name => "open-ils.circ.hold_pull_list.retrieve",
1447 desc => 'Returns (reference to) a list of holds that need to be "pulled" by a given location. ' .
1448 'The location is determined by the login session.',
1450 { desc => 'Limit (optional)', type => 'number'},
1451 { desc => 'Offset (optional)', type => 'number'},
1454 desc => 'reference to a list of holds, or event on failure',
1459 __PACKAGE__->register_method(
1460 method => "hold_pull_list",
1461 api_name => "open-ils.circ.hold_pull_list.id_list.retrieve",
1463 desc => 'Returns (reference to) a list of holds IDs that need to be "pulled" by a given location. ' .
1464 'The location is determined by the login session.',
1466 { desc => 'Limit (optional)', type => 'number'},
1467 { desc => 'Offset (optional)', type => 'number'},
1470 desc => 'reference to a list of holds, or event on failure',
1475 __PACKAGE__->register_method(
1476 method => "hold_pull_list",
1477 api_name => "open-ils.circ.hold_pull_list.retrieve.count",
1479 desc => 'Returns a count of holds that need to be "pulled" by a given location. ' .
1480 'The location is determined by the login session.',
1482 { desc => 'Limit (optional)', type => 'number'},
1483 { desc => 'Offset (optional)', type => 'number'},
1486 desc => 'Holds count (integer), or event on failure',
1493 sub hold_pull_list {
1494 my( $self, $conn, $authtoken, $limit, $offset ) = @_;
1495 my( $reqr, $evt ) = $U->checkses($authtoken);
1496 return $evt if $evt;
1498 my $org = $reqr->ws_ou || $reqr->home_ou;
1499 # the perm locaiton shouldn't really matter here since holds
1500 # will exist all over and VIEW_HOLDS should be universal
1501 $evt = $U->check_perms($reqr->id, $org, 'VIEW_HOLD');
1502 return $evt if $evt;
1504 if($self->api_name =~ /count/) {
1506 my $count = $U->storagereq(
1507 'open-ils.storage.direct.action.hold_request.pull_list.current_copy_circ_lib.status_filtered.count',
1508 $org, $limit, $offset );
1510 $logger->info("Grabbing pull list for org unit $org with $count items");
1513 } elsif( $self->api_name =~ /id_list/ ) {
1514 return $U->storagereq(
1515 'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib.status_filtered.atomic',
1516 $org, $limit, $offset );
1519 return $U->storagereq(
1520 'open-ils.storage.direct.action.hold_request.pull_list.search.current_copy_circ_lib.status_filtered.atomic',
1521 $org, $limit, $offset );
1525 __PACKAGE__->register_method(
1526 method => "print_hold_pull_list",
1527 api_name => "open-ils.circ.hold_pull_list.print",
1529 desc => 'Returns an HTML-formatted holds pull list',
1531 { desc => 'Authtoken', type => 'string'},
1532 { desc => 'Org unit ID. Optional, defaults to workstation org unit', type => 'number'},
1535 desc => 'HTML string',
1541 sub print_hold_pull_list {
1542 my($self, $client, $auth, $org_id) = @_;
1544 my $e = new_editor(authtoken=>$auth);
1545 return $e->event unless $e->checkauth;
1547 $org_id = (defined $org_id) ? $org_id : $e->requestor->ws_ou;
1548 return $e->event unless $e->allowed('VIEW_HOLD', $org_id);
1550 my $hold_ids = $U->storagereq(
1551 'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib.status_filtered.atomic',
1554 return undef unless @$hold_ids;
1556 $client->status(new OpenSRF::DomainObject::oilsContinueStatus);
1558 # Holds will /NOT/ be in order after this ...
1559 my $holds = $e->search_action_hold_request({id => $hold_ids}, {substream => 1});
1560 $client->status(new OpenSRF::DomainObject::oilsContinueStatus);
1562 # ... so we must resort.
1563 my $hold_map = +{map { $_->id => $_ } @$holds};
1564 my $sorted_holds = [];
1565 push @$sorted_holds, $hold_map->{$_} foreach @$hold_ids;
1567 return $U->fire_object_event(
1568 undef, "ahr.format.pull_list", $sorted_holds,
1569 $org_id, undef, undef, $client
1574 __PACKAGE__->register_method(
1575 method => "print_hold_pull_list_stream",
1577 api_name => "open-ils.circ.hold_pull_list.print.stream",
1579 desc => 'Returns a stream of fleshed holds',
1581 { desc => 'Authtoken', type => 'string'},
1582 { 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)',
1587 desc => 'A stream of fleshed holds',
1593 sub print_hold_pull_list_stream {
1594 my($self, $client, $auth, $params) = @_;
1596 my $e = new_editor(authtoken=>$auth);
1597 return $e->die_event unless $e->checkauth;
1599 delete($$params{org_id}) unless (int($$params{org_id}));
1600 delete($$params{limit}) unless (int($$params{limit}));
1601 delete($$params{offset}) unless (int($$params{offset}));
1602 delete($$params{chunk_size}) unless (int($$params{chunk_size}));
1603 delete($$params{chunk_size}) if ($$params{chunk_size} && $$params{chunk_size} > 50); # keep the size reasonable
1604 $$params{chunk_size} ||= 10;
1606 $$params{org_id} = (defined $$params{org_id}) ? $$params{org_id}: $e->requestor->ws_ou;
1607 return $e->die_event unless $e->allowed('VIEW_HOLD', $$params{org_id });
1610 if ($$params{sort} && @{ $$params{sort} }) {
1611 for my $s (@{ $$params{sort} }) {
1612 if ($s eq 'acplo.position') {
1614 "class" => "acplo", "field" => "position",
1615 "transform" => "coalesce", "params" => [999]
1617 } elsif ($s eq 'prefix') {
1618 push @$sort, {"class" => "acnp", "field" => "label_sortkey"};
1619 } elsif ($s eq 'call_number') {
1620 push @$sort, {"class" => "acn", "field" => "label_sortkey"};
1621 } elsif ($s eq 'suffix') {
1622 push @$sort, {"class" => "acns", "field" => "label_sortkey"};
1623 } elsif ($s eq 'request_time') {
1624 push @$sort, {"class" => "ahr", "field" => "request_time"};
1628 push @$sort, {"class" => "ahr", "field" => "request_time"};
1631 my $holds_ids = $e->json_query(
1633 "select" => {"ahr" => ["id"]},
1638 "fkey" => "current_copy",
1640 "circ_lib" => $$params{org_id}, "status" => [0,7]
1645 "fkey" => "call_number",
1659 "fkey" => "circ_lib",
1662 "location" => {"=" => {"+acp" => "location"}}
1671 "capture_time" => undef,
1672 "cancel_time" => undef,
1674 {"expire_time" => undef },
1675 {"expire_time" => {">" => "now"}}
1679 (@$sort ? (order_by => $sort) : ()),
1680 ($$params{limit} ? (limit => $$params{limit}) : ()),
1681 ($$params{offset} ? (offset => $$params{offset}) : ())
1682 }, {"substream" => 1}
1683 ) or return $e->die_event;
1685 $logger->info("about to stream back " . scalar(@$holds_ids) . " holds");
1688 for my $hid (@$holds_ids) {
1689 push @chunk, $e->retrieve_action_hold_request([
1693 "ahr" => ["usr", "current_copy"],
1695 "acp" => ["location", "call_number", "parts"],
1696 "acn" => ["record","prefix","suffix"]
1701 if (@chunk >= $$params{chunk_size}) {
1702 $client->respond( \@chunk );
1706 $client->respond_complete( \@chunk ) if (@chunk);
1713 __PACKAGE__->register_method(
1714 method => 'fetch_hold_notify',
1715 api_name => 'open-ils.circ.hold_notification.retrieve_by_hold',
1718 Returns a list of hold notification objects based on hold id.
1719 @param authtoken The loggin session key
1720 @param holdid The id of the hold whose notifications we want to retrieve
1721 @return An array of hold notification objects, event on error.
1725 sub fetch_hold_notify {
1726 my( $self, $conn, $authtoken, $holdid ) = @_;
1727 my( $requestor, $evt ) = $U->checkses($authtoken);
1728 return $evt if $evt;
1729 my ($hold, $patron);
1730 ($hold, $evt) = $U->fetch_hold($holdid);
1731 return $evt if $evt;
1732 ($patron, $evt) = $U->fetch_user($hold->usr);
1733 return $evt if $evt;
1735 $evt = $U->check_perms($requestor->id, $patron->home_ou, 'VIEW_HOLD_NOTIFICATION');
1736 return $evt if $evt;
1738 $logger->info("User ".$requestor->id." fetching hold notifications for hold $holdid");
1739 return $U->cstorereq(
1740 'open-ils.cstore.direct.action.hold_notification.search.atomic', {hold => $holdid} );
1744 __PACKAGE__->register_method(
1745 method => 'create_hold_notify',
1746 api_name => 'open-ils.circ.hold_notification.create',
1748 Creates a new hold notification object
1749 @param authtoken The login session key
1750 @param notification The hold notification object to create
1751 @return ID of the new object on success, Event on error
1755 sub create_hold_notify {
1756 my( $self, $conn, $auth, $note ) = @_;
1757 my $e = new_editor(authtoken=>$auth, xact=>1);
1758 return $e->die_event unless $e->checkauth;
1760 my $hold = $e->retrieve_action_hold_request($note->hold)
1761 or return $e->die_event;
1762 my $patron = $e->retrieve_actor_user($hold->usr)
1763 or return $e->die_event;
1765 return $e->die_event unless
1766 $e->allowed('CREATE_HOLD_NOTIFICATION', $patron->home_ou);
1768 $note->notify_staff($e->requestor->id);
1769 $e->create_action_hold_notification($note) or return $e->die_event;
1774 __PACKAGE__->register_method(
1775 method => 'create_hold_note',
1776 api_name => 'open-ils.circ.hold_note.create',
1778 Creates a new hold request note object
1779 @param authtoken The login session key
1780 @param note The hold note object to create
1781 @return ID of the new object on success, Event on error
1785 sub create_hold_note {
1786 my( $self, $conn, $auth, $note ) = @_;
1787 my $e = new_editor(authtoken=>$auth, xact=>1);
1788 return $e->die_event unless $e->checkauth;
1790 my $hold = $e->retrieve_action_hold_request($note->hold)
1791 or return $e->die_event;
1792 my $patron = $e->retrieve_actor_user($hold->usr)
1793 or return $e->die_event;
1795 return $e->die_event unless
1796 $e->allowed('UPDATE_HOLD', $patron->home_ou); # FIXME: Using permcrud perm listed in fm_IDL.xml for ahrn. Probably want something more specific
1798 $e->create_action_hold_request_note($note) or return $e->die_event;
1803 __PACKAGE__->register_method(
1804 method => 'reset_hold',
1805 api_name => 'open-ils.circ.hold.reset',
1807 Un-captures and un-targets a hold, essentially returning
1808 it to the state it was in directly after it was placed,
1809 then attempts to re-target the hold
1810 @param authtoken The login session key
1811 @param holdid The id of the hold
1817 my( $self, $conn, $auth, $holdid ) = @_;
1819 my ($hold, $evt) = $U->fetch_hold($holdid);
1820 return $evt if $evt;
1821 ($reqr, $evt) = $U->checksesperm($auth, 'UPDATE_HOLD');
1822 return $evt if $evt;
1823 $evt = _reset_hold($self, $reqr, $hold);
1824 return $evt if $evt;
1829 __PACKAGE__->register_method(
1830 method => 'reset_hold_batch',
1831 api_name => 'open-ils.circ.hold.reset.batch'
1834 sub reset_hold_batch {
1835 my($self, $conn, $auth, $hold_ids) = @_;
1837 my $e = new_editor(authtoken => $auth);
1838 return $e->event unless $e->checkauth;
1840 for my $hold_id ($hold_ids) {
1842 my $hold = $e->retrieve_action_hold_request(
1843 [$hold_id, {flesh => 1, flesh_fields => {ahr => ['usr']}}])
1844 or return $e->event;
1846 next unless $e->allowed('UPDATE_HOLD', $hold->usr->home_ou);
1847 _reset_hold($self, $e->requestor, $hold);
1855 my ($self, $reqr, $hold) = @_;
1857 my $e = new_editor(xact =>1, requestor => $reqr);
1859 $logger->info("reseting hold ".$hold->id);
1861 my $hid = $hold->id;
1863 if( $hold->capture_time and $hold->current_copy ) {
1865 my $copy = $e->retrieve_asset_copy($hold->current_copy)
1866 or return $e->die_event;
1868 if( $copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF ) {
1869 $logger->info("setting copy to status 'reshelving' on hold retarget");
1870 $copy->status(OILS_COPY_STATUS_RESHELVING);
1871 $copy->editor($e->requestor->id);
1872 $copy->edit_date('now');
1873 $e->update_asset_copy($copy) or return $e->die_event;
1875 } elsif( $copy->status == OILS_COPY_STATUS_IN_TRANSIT ) {
1877 # We don't want the copy to remain "in transit"
1878 $copy->status(OILS_COPY_STATUS_RESHELVING);
1879 $logger->warn("! reseting hold [$hid] that is in transit");
1880 my $transid = $e->search_action_hold_transit_copy({hold=>$hold->id},{idlist=>1})->[0];
1883 my $trans = $e->retrieve_action_transit_copy($transid);
1885 $logger->info("Aborting transit [$transid] on hold [$hid] reset...");
1886 my $evt = OpenILS::Application::Circ::Transit::__abort_transit($e, $trans, $copy, 1, 1);
1887 $logger->info("Transit abort completed with result $evt");
1888 unless ("$evt" eq 1) {
1897 $hold->clear_capture_time;
1898 $hold->clear_current_copy;
1899 $hold->clear_shelf_time;
1900 $hold->clear_shelf_expire_time;
1901 $hold->clear_current_shelf_lib;
1903 $e->update_action_hold_request($hold) or return $e->die_event;
1907 'open-ils.storage.action.hold_request.copy_targeter', undef, $hold->id );
1913 __PACKAGE__->register_method(
1914 method => 'fetch_open_title_holds',
1915 api_name => 'open-ils.circ.open_holds.retrieve',
1917 Returns a list ids of un-fulfilled holds for a given title id
1918 @param authtoken The login session key
1919 @param id the id of the item whose holds we want to retrieve
1920 @param type The hold type - M, T, I, V, C, F, R
1924 sub fetch_open_title_holds {
1925 my( $self, $conn, $auth, $id, $type, $org ) = @_;
1926 my $e = new_editor( authtoken => $auth );
1927 return $e->event unless $e->checkauth;
1930 $org ||= $e->requestor->ws_ou;
1932 # return $e->search_action_hold_request(
1933 # { target => $id, hold_type => $type, fulfillment_time => undef }, {idlist=>1});
1935 # XXX make me return IDs in the future ^--
1936 my $holds = $e->search_action_hold_request(
1939 cancel_time => undef,
1941 fulfillment_time => undef
1945 flesh_hold_transits($holds);
1950 sub flesh_hold_transits {
1952 for my $hold ( @$holds ) {
1954 $apputils->simplereq(
1956 "open-ils.cstore.direct.action.hold_transit_copy.search.atomic",
1957 { hold => $hold->id },
1958 { order_by => { ahtc => 'id desc' }, limit => 1 }
1964 sub flesh_hold_notices {
1965 my( $holds, $e ) = @_;
1966 $e ||= new_editor();
1968 for my $hold (@$holds) {
1969 my $notices = $e->search_action_hold_notification(
1971 { hold => $hold->id },
1972 { order_by => { anh => 'notify_time desc' } },
1977 $hold->notify_count(scalar(@$notices));
1979 my $n = $e->retrieve_action_hold_notification($$notices[0])
1980 or return $e->event;
1981 $hold->notify_time($n->notify_time);
1987 __PACKAGE__->register_method(
1988 method => 'fetch_captured_holds',
1989 api_name => 'open-ils.circ.captured_holds.on_shelf.retrieve',
1993 Returns a list of un-fulfilled holds (on the Holds Shelf) for a given title id
1994 @param authtoken The login session key
1995 @param org The org id of the location in question
1996 @param match_copy A specific copy to limit to
2000 __PACKAGE__->register_method(
2001 method => 'fetch_captured_holds',
2002 api_name => 'open-ils.circ.captured_holds.id_list.on_shelf.retrieve',
2006 Returns list ids of un-fulfilled holds (on the Holds Shelf) for a given title id
2007 @param authtoken The login session key
2008 @param org The org id of the location in question
2009 @param match_copy A specific copy to limit to
2013 __PACKAGE__->register_method(
2014 method => 'fetch_captured_holds',
2015 api_name => 'open-ils.circ.captured_holds.id_list.expired_on_shelf.retrieve',
2019 Returns list ids of shelf-expired un-fulfilled holds for a given title id
2020 @param authtoken The login session key
2021 @param org The org id of the location in question
2022 @param match_copy A specific copy to limit to
2027 sub fetch_captured_holds {
2028 my( $self, $conn, $auth, $org, $match_copy ) = @_;
2030 my $e = new_editor(authtoken => $auth);
2031 return $e->die_event unless $e->checkauth;
2032 return $e->die_event unless $e->allowed('VIEW_HOLD'); # XXX rely on editor perm
2034 $org ||= $e->requestor->ws_ou;
2036 my $current_copy = { '!=' => undef };
2037 $current_copy = { '=' => $match_copy } if $match_copy;
2040 select => { alhr => ['id'] },
2045 fkey => 'current_copy'
2050 '+acp' => { status => OILS_COPY_STATUS_ON_HOLDS_SHELF },
2052 capture_time => { "!=" => undef },
2053 current_copy => $current_copy,
2054 fulfillment_time => undef,
2055 current_shelf_lib => $org
2059 if($self->api_name =~ /expired/) {
2060 $query->{'where'}->{'+alhr'}->{'-or'} = {
2061 shelf_expire_time => { '<' => 'now'},
2062 cancel_time => { '!=' => undef },
2065 my $hold_ids = $e->json_query( $query );
2067 for my $hold_id (@$hold_ids) {
2068 if($self->api_name =~ /id_list/) {
2069 $conn->respond($hold_id->{id});
2073 $e->retrieve_action_hold_request([
2077 flesh_fields => {ahr => ['notifications', 'transit', 'notes']},
2078 order_by => {anh => 'notify_time desc'}
2088 __PACKAGE__->register_method(
2089 method => "print_expired_holds_stream",
2090 api_name => "open-ils.circ.captured_holds.expired.print.stream",
2094 sub print_expired_holds_stream {
2095 my ($self, $client, $auth, $params) = @_;
2097 # No need to check specific permissions: we're going to call another method
2098 # that will do that.
2099 my $e = new_editor("authtoken" => $auth);
2100 return $e->die_event unless $e->checkauth;
2102 delete($$params{org_id}) unless (int($$params{org_id}));
2103 delete($$params{limit}) unless (int($$params{limit}));
2104 delete($$params{offset}) unless (int($$params{offset}));
2105 delete($$params{chunk_size}) unless (int($$params{chunk_size}));
2106 delete($$params{chunk_size}) if ($$params{chunk_size} && $$params{chunk_size} > 50); # keep the size reasonable
2107 $$params{chunk_size} ||= 10;
2109 $$params{org_id} = (defined $$params{org_id}) ? $$params{org_id}: $e->requestor->ws_ou;
2111 my @hold_ids = $self->method_lookup(
2112 "open-ils.circ.captured_holds.id_list.expired_on_shelf.retrieve"
2113 )->run($auth, $params->{"org_id"});
2118 } elsif (defined $U->event_code($hold_ids[0])) {
2120 return $hold_ids[0];
2123 $logger->info("about to stream back up to " . scalar(@hold_ids) . " expired holds");
2126 my @hid_chunk = splice @hold_ids, 0, $params->{"chunk_size"};
2128 my $result_chunk = $e->json_query({
2130 "acp" => ["barcode"],
2132 first_given_name second_given_name family_name alias
2141 "field" => "id", "fkey" => "current_copy",
2144 "field" => "id", "fkey" => "call_number",
2147 "field" => "id", "fkey" => "record"
2151 "acpl" => {"field" => "id", "fkey" => "location"}
2154 "au" => {"field" => "id", "fkey" => "usr"}
2157 "where" => {"+ahr" => {"id" => \@hid_chunk}}
2158 }) or return $e->die_event;
2159 $client->respond($result_chunk);
2166 __PACKAGE__->register_method(
2167 method => "check_title_hold_batch",
2168 api_name => "open-ils.circ.title_hold.is_possible.batch",
2171 desc => '@see open-ils.circ.title_hold.is_possible.batch',
2173 { desc => 'Authentication token', type => 'string'},
2174 { desc => 'Array of Hash of named parameters', type => 'array'},
2177 desc => 'Array of response objects',
2183 sub check_title_hold_batch {
2184 my($self, $client, $authtoken, $param_list, $oargs) = @_;
2185 foreach (@$param_list) {
2186 my ($res) = $self->method_lookup('open-ils.circ.title_hold.is_possible')->run($authtoken, $_, $oargs);
2187 $client->respond($res);
2193 __PACKAGE__->register_method(
2194 method => "check_title_hold",
2195 api_name => "open-ils.circ.title_hold.is_possible",
2197 desc => 'Determines if a hold were to be placed by a given user, ' .
2198 'whether or not said hold would have any potential copies to fulfill it.' .
2199 'The named paramaters of the second argument include: ' .
2200 'patronid, titleid, volume_id, copy_id, mrid, depth, pickup_lib, hold_type, selection_ou. ' .
2201 'See perldoc ' . __PACKAGE__ . ' for more info on these fields.' ,
2203 { desc => 'Authentication token', type => 'string'},
2204 { desc => 'Hash of named parameters', type => 'object'},
2207 desc => 'List of new message IDs (empty if none)',
2213 =head3 check_title_hold (token, hash)
2215 The named fields in the hash are:
2217 patronid - ID of the hold recipient (required)
2218 depth - hold range depth (default 0)
2219 pickup_lib - destination for hold, fallback value for selection_ou
2220 selection_ou - ID of org_unit establishing hard and soft hold boundary settings
2221 issuanceid - ID of the issuance to be held, required for Issuance level hold
2222 partid - ID of the monograph part to be held, required for monograph part level hold
2223 titleid - ID (BRN) of the title to be held, required for Title level hold
2224 volume_id - required for Volume level hold
2225 copy_id - required for Copy level hold
2226 mrid - required for Meta-record level hold
2227 hold_type - T, C (or R or F), I, V or M for Title, Copy, Issuance, Volume or Meta-record (default "T")
2229 All key/value pairs are passed on to do_possibility_checks.
2233 # FIXME: better params checking. what other params are required, if any?
2234 # FIXME: 3 copies of values confusing: $x, $params->{x} and $params{x}
2235 # FIXME: for example, $depth gets a default value, but then $$params{depth} is still
2236 # used in conditionals, where it may be undefined, causing a warning.
2237 # FIXME: specify proper usage/interaction of selection_ou and pickup_lib
2239 sub check_title_hold {
2240 my( $self, $client, $authtoken, $params ) = @_;
2241 my $e = new_editor(authtoken=>$authtoken);
2242 return $e->event unless $e->checkauth;
2244 my %params = %$params;
2245 my $depth = $params{depth} || 0;
2246 my $selection_ou = $params{selection_ou} || $params{pickup_lib};
2247 my $oargs = $params{oargs} || {};
2249 if($oargs->{events}) {
2250 @{$oargs->{events}} = grep { $e->allowed($_ . '.override', $e->requestor->ws_ou); } @{$oargs->{events}};
2254 my $patron = $e->retrieve_actor_user($params{patronid})
2255 or return $e->event;
2257 if( $e->requestor->id ne $patron->id ) {
2258 return $e->event unless
2259 $e->allowed('VIEW_HOLD_PERMIT', $patron->home_ou);
2262 return OpenILS::Event->new('PATRON_BARRED') if $U->is_true($patron->barred);
2264 my $request_lib = $e->retrieve_actor_org_unit($e->requestor->ws_ou)
2265 or return $e->event;
2267 my $soft_boundary = $U->ou_ancestor_setting_value($selection_ou, OILS_SETTING_HOLD_SOFT_BOUNDARY);
2268 my $hard_boundary = $U->ou_ancestor_setting_value($selection_ou, OILS_SETTING_HOLD_HARD_BOUNDARY);
2271 my $return_depth = $hard_boundary; # default depth to return on success
2272 if(defined $soft_boundary and $depth < $soft_boundary) {
2273 # work up the tree and as soon as we find a potential copy, use that depth
2274 # also, make sure we don't go past the hard boundary if it exists
2276 # our min boundary is the greater of user-specified boundary or hard boundary
2277 my $min_depth = (defined $hard_boundary and $hard_boundary > $depth) ?
2278 $hard_boundary : $depth;
2280 my $depth = $soft_boundary;
2281 while($depth >= $min_depth) {
2282 $logger->info("performing hold possibility check with soft boundary $depth");
2283 @status = do_possibility_checks($e, $patron, $request_lib, $depth, %params);
2285 $return_depth = $depth;
2290 } elsif(defined $hard_boundary and $depth < $hard_boundary) {
2291 # there is no soft boundary, enforce the hard boundary if it exists
2292 $logger->info("performing hold possibility check with hard boundary $hard_boundary");
2293 @status = do_possibility_checks($e, $patron, $request_lib, $hard_boundary, %params);
2295 # no boundaries defined, fall back to user specifed boundary or no boundary
2296 $logger->info("performing hold possibility check with no boundary");
2297 @status = do_possibility_checks($e, $patron, $request_lib, $params{depth}, %params);
2300 my $place_unfillable = 0;
2301 $place_unfillable = 1 if $e->allowed('PLACE_UNFILLABLE_HOLD', $e->requestor->ws_ou);
2306 "depth" => $return_depth,
2307 "local_avail" => $status[1]
2309 } elsif ($status[2]) {
2310 my $n = scalar @{$status[2]};
2311 return {"success" => 0, "last_event" => $status[2]->[$n - 1], "age_protected_copy" => $status[3], "place_unfillable" => $place_unfillable};
2313 return {"success" => 0, "age_protected_copy" => $status[3], "place_unfillable" => $place_unfillable};
2319 sub do_possibility_checks {
2320 my($e, $patron, $request_lib, $depth, %params) = @_;
2322 my $issuanceid = $params{issuanceid} || "";
2323 my $partid = $params{partid} || "";
2324 my $titleid = $params{titleid} || "";
2325 my $volid = $params{volume_id};
2326 my $copyid = $params{copy_id};
2327 my $mrid = $params{mrid} || "";
2328 my $pickup_lib = $params{pickup_lib};
2329 my $hold_type = $params{hold_type} || 'T';
2330 my $selection_ou = $params{selection_ou} || $pickup_lib;
2331 my $holdable_formats = $params{holdable_formats};
2332 my $oargs = $params{oargs} || {};
2339 if( $hold_type eq OILS_HOLD_TYPE_FORCE || $hold_type eq OILS_HOLD_TYPE_RECALL || $hold_type eq OILS_HOLD_TYPE_COPY ) {
2341 return $e->event unless $copy = $e->retrieve_asset_copy($copyid);
2342 return $e->event unless $volume = $e->retrieve_asset_call_number($copy->call_number);
2343 return $e->event unless $title = $e->retrieve_biblio_record_entry($volume->record);
2345 return (1, 1, []) if( $hold_type eq OILS_HOLD_TYPE_RECALL || $hold_type eq OILS_HOLD_TYPE_FORCE);
2346 return verify_copy_for_hold(
2347 $patron, $e->requestor, $title, $copy, $pickup_lib, $request_lib, $oargs
2350 } elsif( $hold_type eq OILS_HOLD_TYPE_VOLUME ) {
2352 return $e->event unless $volume = $e->retrieve_asset_call_number($volid);
2353 return $e->event unless $title = $e->retrieve_biblio_record_entry($volume->record);
2355 return _check_volume_hold_is_possible(
2356 $volume, $title, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou, $oargs
2359 } elsif( $hold_type eq OILS_HOLD_TYPE_TITLE ) {
2361 return _check_title_hold_is_possible(
2362 $titleid, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou, undef, $oargs
2365 } elsif( $hold_type eq OILS_HOLD_TYPE_ISSUANCE ) {
2367 return _check_issuance_hold_is_possible(
2368 $issuanceid, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou, $oargs
2371 } elsif( $hold_type eq OILS_HOLD_TYPE_MONOPART ) {
2373 return _check_monopart_hold_is_possible(
2374 $partid, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou, $oargs
2377 } elsif( $hold_type eq OILS_HOLD_TYPE_METARECORD ) {
2379 my $maps = $e->search_metabib_metarecord_source_map({metarecord=>$mrid});
2380 my @recs = map { $_->source } @$maps;
2382 for my $rec (@recs) {
2383 @status = _check_title_hold_is_possible(
2384 $rec, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou, $holdable_formats, $oargs
2390 # else { Unrecognized hold_type ! } # FIXME: return error? or 0?
2394 sub create_ranged_org_filter {
2395 my($e, $selection_ou, $depth) = @_;
2397 # find the orgs from which this hold may be fulfilled,
2398 # based on the selection_ou and depth
2400 my $top_org = $e->search_actor_org_unit([
2401 {parent_ou => undef},
2402 {flesh=>1, flesh_fields=>{aou=>['ou_type']}}])->[0];
2405 return () if $depth == $top_org->ou_type->depth;
2407 my $org_list = $U->storagereq('open-ils.storage.actor.org_unit.descendants.atomic', $selection_ou, $depth);
2408 %org_filter = (circ_lib => []);
2409 push(@{$org_filter{circ_lib}}, $_->id) for @$org_list;
2411 $logger->info("hold org filter at depth $depth and selection_ou ".
2412 "$selection_ou created list of @{$org_filter{circ_lib}}");
2418 sub _check_title_hold_is_possible {
2419 my( $titleid, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou, $holdable_formats, $oargs ) = @_;
2421 my ($types, $formats, $lang);
2422 if (defined($holdable_formats)) {
2423 ($types, $formats, $lang) = split '-', $holdable_formats;
2426 my $e = new_editor();
2427 my %org_filter = create_ranged_org_filter($e, $selection_ou, $depth);
2429 # this monster will grab the id and circ_lib of all of the "holdable" copies for the given record
2430 my $copies = $e->json_query(
2432 select => { acp => ['id', 'circ_lib'] },
2437 fkey => 'call_number',
2441 filter => { id => $titleid },
2449 ( $types ? (item_type => [split '', $types]) : () ),
2450 ( $formats ? (item_form => [split '', $formats]) : () ),
2451 ( $lang ? (item_lang => $lang) : () )
2456 acpl => { field => 'id', filter => { holdable => 't'}, fkey => 'location' },
2457 ccs => { field => 'id', filter => { holdable => 't'}, fkey => 'status' },
2458 acpm => { field => 'target_copy', type => 'left' } # ignore part-linked copies
2462 '+acp' => { circulate => 't', deleted => 'f', holdable => 't', %org_filter },
2463 '+acpm' => { target_copy => undef } # ignore part-linked copies
2468 $logger->info("title possible found ".scalar(@$copies)." potential copies");
2472 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2473 "payload" => {"fail_part" => "no_ultimate_items"}
2478 # -----------------------------------------------------------------------
2479 # sort the copies into buckets based on their circ_lib proximity to
2480 # the patron's home_ou.
2481 # -----------------------------------------------------------------------
2483 my $home_org = $patron->home_ou;
2484 my $req_org = $request_lib->id;
2486 $logger->info("prox cache $home_org " . $prox_cache{$home_org});
2488 $prox_cache{$home_org} =
2489 $e->search_actor_org_unit_proximity({from_org => $home_org})
2490 unless $prox_cache{$home_org};
2491 my $home_prox = $prox_cache{$home_org};
2494 my %hash = map { ($_->to_org => $_->prox) } @$home_prox;
2495 push( @{$buckets{ $hash{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2497 my @keys = sort { $a <=> $b } keys %buckets;
2500 if( $home_org ne $req_org ) {
2501 # -----------------------------------------------------------------------
2502 # shove the copies close to the request_lib into the primary buckets
2503 # directly before the farthest away copies. That way, they are not
2504 # given priority, but they are checked before the farthest copies.
2505 # -----------------------------------------------------------------------
2506 $prox_cache{$req_org} =
2507 $e->search_actor_org_unit_proximity({from_org => $req_org})
2508 unless $prox_cache{$req_org};
2509 my $req_prox = $prox_cache{$req_org};
2512 my %hash2 = map { ($_->to_org => $_->prox) } @$req_prox;
2513 push( @{$buckets2{ $hash2{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2515 my $highest_key = $keys[@keys - 1]; # the farthest prox in the exising buckets
2516 my $new_key = $highest_key - 0.5; # right before the farthest prox
2517 my @keys2 = sort { $a <=> $b } keys %buckets2;
2518 for my $key (@keys2) {
2519 last if $key >= $highest_key;
2520 push( @{$buckets{$new_key}}, $_ ) for @{$buckets2{$key}};
2524 @keys = sort { $a <=> $b } keys %buckets;
2529 my $age_protect_only = 0;
2530 OUTER: for my $key (@keys) {
2531 my @cps = @{$buckets{$key}};
2533 $logger->info("looking at " . scalar(@{$buckets{$key}}). " copies in proximity bucket $key");
2535 for my $copyid (@cps) {
2537 next if $seen{$copyid};
2538 $seen{$copyid} = 1; # there could be dupes given the merged buckets
2539 my $copy = $e->retrieve_asset_copy($copyid);
2540 $logger->debug("looking at bucket_key=$key, copy $copyid : circ_lib = " . $copy->circ_lib);
2542 unless($title) { # grab the title if we don't already have it
2543 my $vol = $e->retrieve_asset_call_number(
2544 [ $copy->call_number, { flesh => 1, flesh_fields => { bre => ['fixed_fields'], acn => ['record'] } } ] );
2545 $title = $vol->record;
2548 @status = verify_copy_for_hold(
2549 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib, $oargs);
2551 $age_protect_only ||= $status[3];
2552 last OUTER if $status[0];
2556 $status[3] = $age_protect_only;
2560 sub _check_issuance_hold_is_possible {
2561 my( $issuanceid, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou, $oargs ) = @_;
2563 my $e = new_editor();
2564 my %org_filter = create_ranged_org_filter($e, $selection_ou, $depth);
2566 # this monster will grab the id and circ_lib of all of the "holdable" copies for the given record
2567 my $copies = $e->json_query(
2569 select => { acp => ['id', 'circ_lib'] },
2575 filter => { issuance => $issuanceid }
2577 acpl => { field => 'id', filter => { holdable => 't'}, fkey => 'location' },
2578 ccs => { field => 'id', filter => { holdable => 't'}, fkey => 'status' }
2582 '+acp' => { circulate => 't', deleted => 'f', holdable => 't', %org_filter }
2588 $logger->info("issuance possible found ".scalar(@$copies)." potential copies");
2592 $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_issuance_ok');
2593 $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2598 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2599 "payload" => {"fail_part" => "no_ultimate_items"}
2607 # -----------------------------------------------------------------------
2608 # sort the copies into buckets based on their circ_lib proximity to
2609 # the patron's home_ou.
2610 # -----------------------------------------------------------------------
2612 my $home_org = $patron->home_ou;
2613 my $req_org = $request_lib->id;
2615 $logger->info("prox cache $home_org " . $prox_cache{$home_org});
2617 $prox_cache{$home_org} =
2618 $e->search_actor_org_unit_proximity({from_org => $home_org})
2619 unless $prox_cache{$home_org};
2620 my $home_prox = $prox_cache{$home_org};
2623 my %hash = map { ($_->to_org => $_->prox) } @$home_prox;
2624 push( @{$buckets{ $hash{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2626 my @keys = sort { $a <=> $b } keys %buckets;
2629 if( $home_org ne $req_org ) {
2630 # -----------------------------------------------------------------------
2631 # shove the copies close to the request_lib into the primary buckets
2632 # directly before the farthest away copies. That way, they are not
2633 # given priority, but they are checked before the farthest copies.
2634 # -----------------------------------------------------------------------
2635 $prox_cache{$req_org} =
2636 $e->search_actor_org_unit_proximity({from_org => $req_org})
2637 unless $prox_cache{$req_org};
2638 my $req_prox = $prox_cache{$req_org};
2641 my %hash2 = map { ($_->to_org => $_->prox) } @$req_prox;
2642 push( @{$buckets2{ $hash2{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2644 my $highest_key = $keys[@keys - 1]; # the farthest prox in the exising buckets
2645 my $new_key = $highest_key - 0.5; # right before the farthest prox
2646 my @keys2 = sort { $a <=> $b } keys %buckets2;
2647 for my $key (@keys2) {
2648 last if $key >= $highest_key;
2649 push( @{$buckets{$new_key}}, $_ ) for @{$buckets2{$key}};
2653 @keys = sort { $a <=> $b } keys %buckets;
2658 my $age_protect_only = 0;
2659 OUTER: for my $key (@keys) {
2660 my @cps = @{$buckets{$key}};
2662 $logger->info("looking at " . scalar(@{$buckets{$key}}). " copies in proximity bucket $key");
2664 for my $copyid (@cps) {
2666 next if $seen{$copyid};
2667 $seen{$copyid} = 1; # there could be dupes given the merged buckets
2668 my $copy = $e->retrieve_asset_copy($copyid);
2669 $logger->debug("looking at bucket_key=$key, copy $copyid : circ_lib = " . $copy->circ_lib);
2671 unless($title) { # grab the title if we don't already have it
2672 my $vol = $e->retrieve_asset_call_number(
2673 [ $copy->call_number, { flesh => 1, flesh_fields => { bre => ['fixed_fields'], acn => ['record'] } } ] );
2674 $title = $vol->record;
2677 @status = verify_copy_for_hold(
2678 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib, $oargs);
2680 $age_protect_only ||= $status[3];
2681 last OUTER if $status[0];
2686 if (!defined($empty_ok)) {
2687 $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_issuance_ok');
2688 $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2691 return (1,0) if ($empty_ok);
2693 $status[3] = $age_protect_only;
2697 sub _check_monopart_hold_is_possible {
2698 my( $partid, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou, $oargs ) = @_;
2700 my $e = new_editor();
2701 my %org_filter = create_ranged_org_filter($e, $selection_ou, $depth);
2703 # this monster will grab the id and circ_lib of all of the "holdable" copies for the given record
2704 my $copies = $e->json_query(
2706 select => { acp => ['id', 'circ_lib'] },
2710 field => 'target_copy',
2712 filter => { part => $partid }
2714 acpl => { field => 'id', filter => { holdable => 't'}, fkey => 'location' },
2715 ccs => { field => 'id', filter => { holdable => 't'}, fkey => 'status' }
2719 '+acp' => { circulate => 't', deleted => 'f', holdable => 't', %org_filter }
2725 $logger->info("monopart possible found ".scalar(@$copies)." potential copies");
2729 $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_part_ok');
2730 $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2735 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2736 "payload" => {"fail_part" => "no_ultimate_items"}
2744 # -----------------------------------------------------------------------
2745 # sort the copies into buckets based on their circ_lib proximity to
2746 # the patron's home_ou.
2747 # -----------------------------------------------------------------------
2749 my $home_org = $patron->home_ou;
2750 my $req_org = $request_lib->id;
2752 $logger->info("prox cache $home_org " . $prox_cache{$home_org});
2754 $prox_cache{$home_org} =
2755 $e->search_actor_org_unit_proximity({from_org => $home_org})
2756 unless $prox_cache{$home_org};
2757 my $home_prox = $prox_cache{$home_org};
2760 my %hash = map { ($_->to_org => $_->prox) } @$home_prox;
2761 push( @{$buckets{ $hash{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2763 my @keys = sort { $a <=> $b } keys %buckets;
2766 if( $home_org ne $req_org ) {
2767 # -----------------------------------------------------------------------
2768 # shove the copies close to the request_lib into the primary buckets
2769 # directly before the farthest away copies. That way, they are not
2770 # given priority, but they are checked before the farthest copies.
2771 # -----------------------------------------------------------------------
2772 $prox_cache{$req_org} =
2773 $e->search_actor_org_unit_proximity({from_org => $req_org})
2774 unless $prox_cache{$req_org};
2775 my $req_prox = $prox_cache{$req_org};
2778 my %hash2 = map { ($_->to_org => $_->prox) } @$req_prox;
2779 push( @{$buckets2{ $hash2{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2781 my $highest_key = $keys[@keys - 1]; # the farthest prox in the exising buckets
2782 my $new_key = $highest_key - 0.5; # right before the farthest prox
2783 my @keys2 = sort { $a <=> $b } keys %buckets2;
2784 for my $key (@keys2) {
2785 last if $key >= $highest_key;
2786 push( @{$buckets{$new_key}}, $_ ) for @{$buckets2{$key}};
2790 @keys = sort { $a <=> $b } keys %buckets;
2795 my $age_protect_only = 0;
2796 OUTER: for my $key (@keys) {
2797 my @cps = @{$buckets{$key}};
2799 $logger->info("looking at " . scalar(@{$buckets{$key}}). " copies in proximity bucket $key");
2801 for my $copyid (@cps) {
2803 next if $seen{$copyid};
2804 $seen{$copyid} = 1; # there could be dupes given the merged buckets
2805 my $copy = $e->retrieve_asset_copy($copyid);
2806 $logger->debug("looking at bucket_key=$key, copy $copyid : circ_lib = " . $copy->circ_lib);
2808 unless($title) { # grab the title if we don't already have it
2809 my $vol = $e->retrieve_asset_call_number(
2810 [ $copy->call_number, { flesh => 1, flesh_fields => { bre => ['fixed_fields'], acn => ['record'] } } ] );
2811 $title = $vol->record;
2814 @status = verify_copy_for_hold(
2815 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib, $oargs);
2817 $age_protect_only ||= $status[3];
2818 last OUTER if $status[0];
2823 if (!defined($empty_ok)) {
2824 $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_part_ok');
2825 $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2828 return (1,0) if ($empty_ok);
2830 $status[3] = $age_protect_only;
2835 sub _check_volume_hold_is_possible {
2836 my( $vol, $title, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou, $oargs ) = @_;
2837 my %org_filter = create_ranged_org_filter(new_editor(), $selection_ou, $depth);
2838 my $copies = new_editor->search_asset_copy({call_number => $vol->id, %org_filter});
2839 $logger->info("checking possibility of volume hold for volume ".$vol->id);
2841 my $filter_copies = [];
2842 for my $copy (@$copies) {
2843 # ignore part-mapped copies for regular volume level holds
2844 push(@$filter_copies, $copy) unless
2845 new_editor->search_asset_copy_part_map({target_copy => $copy->id})->[0];
2847 $copies = $filter_copies;
2852 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2853 "payload" => {"fail_part" => "no_ultimate_items"}
2859 my $age_protect_only = 0;
2860 for my $copy ( @$copies ) {
2861 @status = verify_copy_for_hold(
2862 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib, $oargs );
2863 $age_protect_only ||= $status[3];
2866 $status[3] = $age_protect_only;
2872 sub verify_copy_for_hold {
2873 my( $patron, $requestor, $title, $copy, $pickup_lib, $request_lib, $oargs ) = @_;
2874 $oargs = {} unless defined $oargs;
2875 $logger->info("checking possibility of copy in hold request for copy ".$copy->id);
2876 my $permitted = OpenILS::Utils::PermitHold::permit_copy_hold(
2877 { patron => $patron,
2878 requestor => $requestor,
2881 title_descriptor => $title->fixed_fields, # this is fleshed into the title object
2882 pickup_lib => $pickup_lib,
2883 request_lib => $request_lib,
2885 show_event_list => 1
2890 my $permit_anyway = 0;
2891 foreach my $permit_event (@$permitted) {
2892 if (grep { $_ eq $permit_event->{textcode} } @{$oargs->{events}}) {
2897 $permitted = [] if $permit_anyway;
2899 my $age_protect_only = 0;
2900 if (@$permitted == 1 && @$permitted[0]->{textcode} eq 'ITEM_AGE_PROTECTED') {
2901 $age_protect_only = 1;
2905 (not scalar @$permitted), # true if permitted is an empty arrayref
2906 ( # XXX This test is of very dubious value; someone should figure
2907 # out what if anything is checking this value
2908 ($copy->circ_lib == $pickup_lib) and
2909 ($copy->status == OILS_COPY_STATUS_AVAILABLE)
2918 sub find_nearest_permitted_hold {
2921 my $editor = shift; # CStoreEditor object
2922 my $copy = shift; # copy to target
2923 my $user = shift; # staff
2924 my $check_only = shift; # do no updates, just see if the copy could fulfill a hold
2926 my $evt = OpenILS::Event->new('ACTION_HOLD_REQUEST_NOT_FOUND');
2928 my $bc = $copy->barcode;
2930 # find any existing holds that already target this copy
2931 my $old_holds = $editor->search_action_hold_request(
2932 { current_copy => $copy->id,
2933 cancel_time => undef,
2934 capture_time => undef
2938 my $hold_stall_interval = $U->ou_ancestor_setting_value($user->ws_ou, OILS_SETTING_HOLD_SOFT_STALL);
2940 $logger->info("circulator: searching for best hold at org ".$user->ws_ou.
2941 " and copy $bc with a hold stalling interval of ". ($hold_stall_interval || "(none)"));
2943 my $fifo = $U->ou_ancestor_setting_value($user->ws_ou, 'circ.holds_fifo');
2945 # search for what should be the best holds for this copy to fulfill
2946 my $best_holds = $U->storagereq(
2947 "open-ils.storage.action.hold_request.nearest_hold.atomic",
2948 $user->ws_ou, $copy->id, 100, $hold_stall_interval, $fifo );
2950 # Add any pre-targeted holds to the list too? Unless they are already there, anyway.
2952 for my $holdid (@$old_holds) {
2953 next unless $holdid;
2954 push(@$best_holds, $holdid) unless ( grep { ''.$holdid eq ''.$_ } @$best_holds );
2958 unless(@$best_holds) {
2959 $logger->info("circulator: no suitable holds found for copy $bc");
2960 return (undef, $evt);
2966 # for each potential hold, we have to run the permit script
2967 # to make sure the hold is actually permitted.
2970 for my $holdid (@$best_holds) {
2971 next unless $holdid;
2972 $logger->info("circulator: checking if hold $holdid is permitted for copy $bc");
2974 my $hold = $editor->retrieve_action_hold_request($holdid) or next;
2975 my $reqr = $reqr_cache{$hold->requestor} || $editor->retrieve_actor_user($hold->requestor);
2976 my $rlib = $org_cache{$hold->request_lib} || $editor->retrieve_actor_org_unit($hold->request_lib);
2978 $reqr_cache{$hold->requestor} = $reqr;
2979 $org_cache{$hold->request_lib} = $rlib;
2981 # see if this hold is permitted
2982 my $permitted = OpenILS::Utils::PermitHold::permit_copy_hold(
2983 { patron_id => $hold->usr,
2986 pickup_lib => $hold->pickup_lib,
2987 request_lib => $rlib,
2999 unless( $best_hold ) { # no "good" permitted holds were found
3001 $logger->info("circulator: no suitable holds found for copy $bc");
3002 return (undef, $evt);
3005 $logger->info("circulator: best hold ".$best_hold->id." found for copy $bc");
3007 # indicate a permitted hold was found
3008 return $best_hold if $check_only;
3010 # we've found a permitted hold. we need to "grab" the copy
3011 # to prevent re-targeted holds (next part) from re-grabbing the copy
3012 $best_hold->current_copy($copy->id);
3013 $editor->update_action_hold_request($best_hold)
3014 or return (undef, $editor->event);
3019 # re-target any other holds that already target this copy
3020 for my $old_hold (@$old_holds) {
3021 next if $old_hold->id eq $best_hold->id; # don't re-target the hold we want
3022 $logger->info("circulator: clearing current_copy and prev_check_time on hold ".
3023 $old_hold->id." after a better hold [".$best_hold->id."] was found");
3024 $old_hold->clear_current_copy;
3025 $old_hold->clear_prev_check_time;
3026 $editor->update_action_hold_request($old_hold)
3027 or return (undef, $editor->event);
3028 push(@retarget, $old_hold->id);
3031 return ($best_hold, undef, (@retarget) ? \@retarget : undef);
3039 __PACKAGE__->register_method(
3040 method => 'all_rec_holds',
3041 api_name => 'open-ils.circ.holds.retrieve_all_from_title',
3045 my( $self, $conn, $auth, $title_id, $args ) = @_;
3047 my $e = new_editor(authtoken=>$auth);
3048 $e->checkauth or return $e->event;
3049 $e->allowed('VIEW_HOLD') or return $e->event;
3052 $args->{fulfillment_time} = undef; # we don't want to see old fulfilled holds
3053 $args->{cancel_time} = undef;
3055 my $resp = { volume_holds => [], copy_holds => [], recall_holds => [], force_holds => [], metarecord_holds => [], part_holds => [], issuance_holds => [] };
3057 my $mr_map = $e->search_metabib_metarecord_source_map({source => $title_id})->[0];
3059 $resp->{metarecord_holds} = $e->search_action_hold_request(
3060 { hold_type => OILS_HOLD_TYPE_METARECORD,
3061 target => $mr_map->metarecord,
3067 $resp->{title_holds} = $e->search_action_hold_request(
3069 hold_type => OILS_HOLD_TYPE_TITLE,
3070 target => $title_id,
3074 my $parts = $e->search_biblio_monograph_part(
3080 $resp->{part_holds} = $e->search_action_hold_request(
3082 hold_type => OILS_HOLD_TYPE_MONOPART,
3088 my $subs = $e->search_serial_subscription(
3089 { record_entry => $title_id }, {idlist=>1});
3092 my $issuances = $e->search_serial_issuance(
3093 {subscription => $subs}, {idlist=>1}
3097 $resp->{issuance_holds} = $e->search_action_hold_request(
3099 hold_type => OILS_HOLD_TYPE_ISSUANCE,
3100 target => $issuances,
3107 my $vols = $e->search_asset_call_number(
3108 { record => $title_id, deleted => 'f' }, {idlist=>1});
3110 return $resp unless @$vols;
3112 $resp->{volume_holds} = $e->search_action_hold_request(
3114 hold_type => OILS_HOLD_TYPE_VOLUME,
3119 my $copies = $e->search_asset_copy(
3120 { call_number => $vols, deleted => 'f' }, {idlist=>1});
3122 return $resp unless @$copies;
3124 $resp->{copy_holds} = $e->search_action_hold_request(
3126 hold_type => OILS_HOLD_TYPE_COPY,
3131 $resp->{recall_holds} = $e->search_action_hold_request(
3133 hold_type => OILS_HOLD_TYPE_RECALL,
3138 $resp->{force_holds} = $e->search_action_hold_request(
3140 hold_type => OILS_HOLD_TYPE_FORCE,
3152 __PACKAGE__->register_method(
3153 method => 'uber_hold',
3155 api_name => 'open-ils.circ.hold.details.retrieve'
3159 my($self, $client, $auth, $hold_id, $args) = @_;
3160 my $e = new_editor(authtoken=>$auth);
3161 $e->checkauth or return $e->event;
3162 return uber_hold_impl($e, $hold_id, $args);
3165 __PACKAGE__->register_method(
3166 method => 'batch_uber_hold',
3169 api_name => 'open-ils.circ.hold.details.batch.retrieve'
3172 sub batch_uber_hold {
3173 my($self, $client, $auth, $hold_ids, $args) = @_;
3174 my $e = new_editor(authtoken=>$auth);
3175 $e->checkauth or return $e->event;
3176 $client->respond(uber_hold_impl($e, $_, $args)) for @$hold_ids;
3180 sub uber_hold_impl {
3181 my($e, $hold_id, $args) = @_;
3184 my $hold = $e->retrieve_action_hold_request(
3189 flesh_fields => { ahr => [ 'current_copy', 'usr', 'notes' ] }
3192 ) or return $e->event;
3194 if($hold->usr->id ne $e->requestor->id) {
3195 # A user is allowed to see his/her own holds
3196 $e->allowed('VIEW_HOLD') or return $e->event;
3197 $hold->notes( # filter out any non-staff ("private") notes
3198 [ grep { !$U->is_true($_->staff) } @{$hold->notes} ] );
3201 # caller is asking for own hold, but may not have permission to view staff notes
3202 unless($e->allowed('VIEW_HOLD')) {
3203 $hold->notes( # filter out any staff notes
3204 [ grep { $U->is_true($_->staff) } @{$hold->notes} ] );
3208 my $user = $hold->usr;
3209 $hold->usr($user->id);
3212 my( $mvr, $volume, $copy, $issuance, $part, $bre ) = find_hold_mvr($e, $hold, $args->{suppress_mvr});
3214 flesh_hold_notices([$hold], $e) unless $args->{suppress_notices};
3215 flesh_hold_transits([$hold]) unless $args->{suppress_transits};
3217 my $details = retrieve_hold_queue_status_impl($e, $hold);
3222 ($copy ? (copy => $copy) : ()),
3223 ($volume ? (volume => $volume) : ()),
3224 ($issuance ? (issuance => $issuance) : ()),
3225 ($part ? (part => $part) : ()),
3226 ($args->{include_bre} ? (bre => $bre) : ()),
3227 ($args->{suppress_mvr} ? () : (mvr => $mvr)),
3231 unless($args->{suppress_patron_details}) {
3232 my $card = $e->retrieve_actor_card($user->card) or return $e->event;
3233 $resp->{patron_first} = $user->first_given_name,
3234 $resp->{patron_last} = $user->family_name,
3235 $resp->{patron_barcode} = $card->barcode,
3236 $resp->{patron_alias} = $user->alias,
3244 # -----------------------------------------------------
3245 # Returns the MVR object that represents what the
3247 # -----------------------------------------------------
3249 my( $e, $hold, $no_mvr ) = @_;
3257 if( $hold->hold_type eq OILS_HOLD_TYPE_METARECORD ) {
3258 my $mr = $e->retrieve_metabib_metarecord($hold->target)
3259 or return $e->event;
3260 $tid = $mr->master_record;
3262 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_TITLE ) {
3263 $tid = $hold->target;
3265 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_VOLUME ) {
3266 $volume = $e->retrieve_asset_call_number($hold->target)
3267 or return $e->event;
3268 $tid = $volume->record;
3270 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_ISSUANCE ) {
3271 $issuance = $e->retrieve_serial_issuance([
3273 {flesh => 1, flesh_fields => {siss => [ qw/subscription/ ]}}
3274 ]) or return $e->event;
3276 $tid = $issuance->subscription->record_entry;
3278 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_MONOPART ) {
3279 $part = $e->retrieve_biblio_monograph_part([
3281 ]) or return $e->event;
3283 $tid = $part->record;
3285 } 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 ) {
3286 $copy = $e->retrieve_asset_copy([
3288 {flesh => 1, flesh_fields => {acp => ['call_number']}}
3289 ]) or return $e->event;
3291 $volume = $copy->call_number;
3292 $tid = $volume->record;
3295 if(!$copy and ref $hold->current_copy ) {
3296 $copy = $hold->current_copy;
3297 $hold->current_copy($copy->id);
3300 if(!$volume and $copy) {
3301 $volume = $e->retrieve_asset_call_number($copy->call_number);
3304 # TODO return metarcord mvr for M holds
3305 my $title = $e->retrieve_biblio_record_entry($tid);
3306 return ( ($no_mvr) ? undef : $U->record_to_mvr($title), $volume, $copy, $issuance, $part, $title );
3309 __PACKAGE__->register_method(
3310 method => 'clear_shelf_cache',
3311 api_name => 'open-ils.circ.hold.clear_shelf.get_cache',
3315 Returns the holds processed with the given cache key
3320 sub clear_shelf_cache {
3321 my($self, $client, $auth, $cache_key, $chunk_size) = @_;
3322 my $e = new_editor(authtoken => $auth, xact => 1);
3323 return $e->die_event unless $e->checkauth and $e->allowed('VIEW_HOLD');
3326 my $hold_data = OpenSRF::Utils::Cache->new('global')->get_cache($cache_key);
3329 $logger->info("no hold data found in cache"); # XXX TODO return event
3335 foreach (keys %$hold_data) {
3336 $maximum += scalar(@{ $hold_data->{$_} });
3338 $client->respond({"maximum" => $maximum, "progress" => 0});
3340 for my $action (sort keys %$hold_data) {
3341 while (@{$hold_data->{$action}}) {
3342 my @hid_chunk = splice @{$hold_data->{$action}}, 0, $chunk_size;
3344 my $result_chunk = $e->json_query({
3346 "acp" => ["barcode"],
3348 first_given_name second_given_name family_name alias
3351 "acnp" => [{column => "label", alias => "prefix"}],
3352 "acns" => [{column => "label", alias => "suffix"}],
3360 "field" => "id", "fkey" => "current_copy",
3363 "field" => "id", "fkey" => "call_number",
3366 "field" => "id", "fkey" => "record"
3369 "field" => "id", "fkey" => "prefix"
3372 "field" => "id", "fkey" => "suffix"
3376 "acpl" => {"field" => "id", "fkey" => "location"}
3379 "au" => {"field" => "id", "fkey" => "usr"}
3382 "where" => {"+ahr" => {"id" => \@hid_chunk}}
3383 }, {"substream" => 1}) or return $e->die_event;
3387 +{"action" => $action, "hold_details" => $_}
3398 __PACKAGE__->register_method(
3399 method => 'clear_shelf_process',
3401 api_name => 'open-ils.circ.hold.clear_shelf.process',
3404 1. Find all holds that have expired on the holds shelf
3406 3. If a clear-shelf status is configured, put targeted copies into this status
3407 4. Divide copies into 3 groups: items to transit, items to reshelve, and items
3408 that are needed for holds. No subsequent action is taken on the holds
3409 or items after grouping.
3414 sub clear_shelf_process {
3415 my($self, $client, $auth, $org_id, $match_copy) = @_;
3417 my $e = new_editor(authtoken=>$auth, xact => 1);
3418 $e->checkauth or return $e->die_event;
3419 my $cache = OpenSRF::Utils::Cache->new('global');
3421 $org_id ||= $e->requestor->ws_ou;
3422 $e->allowed('UPDATE_HOLD', $org_id) or return $e->die_event;
3424 my $copy_status = $U->ou_ancestor_setting_value($org_id, 'circ.holds.clear_shelf.copy_status');
3426 my @hold_ids = $self->method_lookup(
3427 "open-ils.circ.captured_holds.id_list.expired_on_shelf.retrieve"
3428 )->run($auth, $org_id, $match_copy);
3431 my @canceled_holds; # newly canceled holds
3432 my $chunk_size = 25; # chunked status updates
3434 for my $hold_id (@hold_ids) {
3436 $logger->info("Clear shelf processing hold $hold_id");
3438 my $hold = $e->retrieve_action_hold_request([
3441 flesh_fields => {ahr => ['current_copy']}
3445 if (!$hold->cancel_time) { # may be canceled but still on the holds shelf
3446 $hold->cancel_time('now');
3447 $hold->cancel_cause(2); # Hold Shelf expiration
3448 $e->update_action_hold_request($hold) or return $e->die_event;
3449 delete_hold_copy_maps($self, $e, $hold->id) and return $e->die_event;
3450 push(@canceled_holds, $hold_id);
3453 my $copy = $hold->current_copy;
3455 if($copy_status or $copy_status == 0) {
3456 # if a clear-shelf copy status is defined, update the copy
3457 $copy->status($copy_status);
3458 $copy->edit_date('now');
3459 $copy->editor($e->requestor->id);
3460 $e->update_asset_copy($copy) or return $e->die_event;
3463 push(@holds, $hold);
3464 $client->respond({maximum => scalar(@holds), progress => $counter}) if ( (++$counter % $chunk_size) == 0);
3475 for my $hold (@holds) {
3477 my $copy = $hold->current_copy;
3478 my ($alt_hold) = __PACKAGE__->find_nearest_permitted_hold($e, $copy, $e->requestor, 1);
3480 if($alt_hold and !$match_copy) {
3482 push(@{$cache_data{hold}}, $hold->id); # copy is needed for a hold
3484 } elsif($copy->circ_lib != $e->requestor->ws_ou) {
3486 push(@{$cache_data{transit}}, $hold->id); # copy needs to transit
3490 push(@{$cache_data{shelf}}, $hold->id); # copy needs to go back to the shelf
3494 my $cache_key = md5_hex(time . $$ . rand());
3495 $logger->info("clear_shelf_cache: storing under $cache_key");
3496 $cache->put_cache($cache_key, \%cache_data, 7200); # TODO: 2 hours. configurable?
3498 # tell the client we're done
3499 $client->respond_complete({cache_key => $cache_key});
3502 # fire off the hold cancelation trigger and wait for response so don't flood the service
3504 # refetch the holds to pick up the caclulated cancel_time,
3505 # which may be needed by Action/Trigger
3507 my $updated_holds = [];
3508 $updated_holds = $e->search_action_hold_request({id => \@canceled_holds}, {substream => 1}) if (@canceled_holds > 0);
3511 $U->create_events_for_hook(
3512 'hold_request.cancel.expire_holds_shelf',
3513 $_, $org_id, undef, undef, 1) for @$updated_holds;
3516 # tell the client we're done
3517 $client->respond_complete;
3521 __PACKAGE__->register_method(
3522 method => 'usr_hold_summary',
3523 api_name => 'open-ils.circ.holds.user_summary',
3525 Returns a summary of holds statuses for a given user
3529 sub usr_hold_summary {
3530 my($self, $conn, $auth, $user_id) = @_;
3532 my $e = new_editor(authtoken=>$auth);
3533 $e->checkauth or return $e->event;
3534 $e->allowed('VIEW_HOLD') or return $e->event;
3536 my $holds = $e->search_action_hold_request(
3539 fulfillment_time => undef,
3540 cancel_time => undef,
3544 my %summary = (1 => 0, 2 => 0, 3 => 0, 4 => 0);
3545 $summary{_hold_status($e, $_)} += 1 for @$holds;
3551 __PACKAGE__->register_method(
3552 method => 'hold_has_copy_at',
3553 api_name => 'open-ils.circ.hold.has_copy_at',
3556 'Returns the ID of the found copy and name of the shelving location if there is ' .
3557 'an available copy at the specified org unit. Returns empty hash otherwise. ' .
3558 'The anticipated use for this method is to determine whether an item is ' .
3559 'available at the library where the user is placing the hold (or, alternatively, '.
3560 'at the pickup library) to encourage bypassing the hold placement and just ' .
3561 'checking out the item.' ,
3563 { desc => 'Authentication Token', type => 'string' },
3564 { desc => 'Method Arguments. Options include: hold_type, hold_target, org_unit. '
3565 . 'hold_type is the hold type code (T, V, C, M, ...). '
3566 . 'hold_target is the identifier of the hold target object. '
3567 . 'org_unit is org unit ID.',
3572 desc => q/Result hash like { "copy" : copy_id, "location" : location_name }, empty hash on misses, event on error./,
3578 sub hold_has_copy_at {
3579 my($self, $conn, $auth, $args) = @_;
3581 my $e = new_editor(authtoken=>$auth);
3582 $e->checkauth or return $e->event;
3584 my $hold_type = $$args{hold_type};
3585 my $hold_target = $$args{hold_target};
3586 my $org_unit = $$args{org_unit};
3589 select => {acp => ['id'], acpl => ['name']},
3592 acpl => {field => 'id', filter => { holdable => 't'}, fkey => 'location'},
3593 ccs => {field => 'id', filter => { holdable => 't'}, fkey => 'status' }
3596 where => {'+acp' => { circulate => 't', deleted => 'f', holdable => 't', circ_lib => $org_unit, status => [0,7]}},
3600 if($hold_type eq 'C' or $hold_type eq 'F' or $hold_type eq 'R') {
3602 $query->{where}->{'+acp'}->{id} = $hold_target;
3604 } elsif($hold_type eq 'V') {
3606 $query->{where}->{'+acp'}->{call_number} = $hold_target;
3608 } elsif($hold_type eq 'P') {
3610 $query->{from}->{acp}->{acpm} = {
3611 field => 'target_copy',
3613 filter => {part => $hold_target},
3616 } elsif($hold_type eq 'I') {
3618 $query->{from}->{acp}->{sitem} = {
3621 filter => {issuance => $hold_target},
3624 } elsif($hold_type eq 'T') {
3626 $query->{from}->{acp}->{acn} = {
3628 fkey => 'call_number',
3632 filter => {id => $hold_target},
3640 $query->{from}->{acp}->{acn} = {
3642 fkey => 'call_number',
3651 filter => {metarecord => $hold_target},
3659 my $res = $e->json_query($query)->[0] or return {};
3660 return {copy => $res->{id}, location => $res->{name}} if $res;
3664 # returns true if the user already has an item checked out
3665 # that could be used to fulfill the requested hold.
3666 sub hold_item_is_checked_out {
3667 my($e, $user_id, $hold_type, $hold_target) = @_;
3670 select => {acp => ['id']},
3671 from => {acp => {}},
3675 in => { # copies for circs the user has checked out
3676 select => {circ => ['target_copy']},
3680 checkin_time => undef,
3682 {stop_fines => ["MAXFINES","LONGOVERDUE"]},
3683 {stop_fines => undef}
3693 if($hold_type eq 'C' || $hold_type eq 'R' || $hold_type eq 'F') {
3695 $query->{where}->{'+acp'}->{id}->{in}->{where}->{'target_copy'} = $hold_target;
3697 } elsif($hold_type eq 'V') {
3699 $query->{where}->{'+acp'}->{call_number} = $hold_target;
3701 } elsif($hold_type eq 'P') {
3703 $query->{from}->{acp}->{acpm} = {
3704 field => 'target_copy',
3706 filter => {part => $hold_target},
3709 } elsif($hold_type eq 'I') {
3711 $query->{from}->{acp}->{sitem} = {
3714 filter => {issuance => $hold_target},
3717 } elsif($hold_type eq 'T') {
3719 $query->{from}->{acp}->{acn} = {
3721 fkey => 'call_number',
3725 filter => {id => $hold_target},
3733 $query->{from}->{acp}->{acn} = {
3735 fkey => 'call_number',
3744 filter => {metarecord => $hold_target},
3752 return $e->json_query($query)->[0];
3755 __PACKAGE__->register_method(
3756 method => 'change_hold_title',
3757 api_name => 'open-ils.circ.hold.change_title',
3760 Updates all title level holds targeting the specified bibs to point a new bib./,
3762 { desc => 'Authentication Token', type => 'string' },
3763 { desc => 'New Target Bib Id', type => 'number' },
3764 { desc => 'Old Target Bib Ids', type => 'array' },
3766 return => { desc => '1 on success' }
3770 __PACKAGE__->register_method(
3771 method => 'change_hold_title_for_specific_holds',
3772 api_name => 'open-ils.circ.hold.change_title.specific_holds',
3775 Updates specified holds to target new bib./,
3777 { desc => 'Authentication Token', type => 'string' },
3778 { desc => 'New Target Bib Id', type => 'number' },
3779 { desc => 'Holds Ids for holds to update', type => 'array' },
3781 return => { desc => '1 on success' }
3786 sub change_hold_title {
3787 my( $self, $client, $auth, $new_bib_id, $bib_ids ) = @_;
3789 my $e = new_editor(authtoken=>$auth, xact=>1);
3790 return $e->die_event unless $e->checkauth;
3792 my $holds = $e->search_action_hold_request(
3795 cancel_time => undef,
3796 fulfillment_time => undef,
3802 flesh_fields => { ahr => ['usr'] }
3808 for my $hold (@$holds) {
3809 $e->allowed('UPDATE_HOLD', $hold->usr->home_ou) or return $e->die_event;
3810 $logger->info("Changing hold " . $hold->id . " target from " . $hold->target . " to $new_bib_id in title hold target change");
3811 $hold->target( $new_bib_id );
3812 $e->update_action_hold_request($hold) or return $e->die_event;
3817 _reset_hold($self, $e->requestor, $_) for @$holds;
3822 sub change_hold_title_for_specific_holds {
3823 my( $self, $client, $auth, $new_bib_id, $hold_ids ) = @_;
3825 my $e = new_editor(authtoken=>$auth, xact=>1);
3826 return $e->die_event unless $e->checkauth;
3828 my $holds = $e->search_action_hold_request(
3831 cancel_time => undef,
3832 fulfillment_time => undef,
3838 flesh_fields => { ahr => ['usr'] }
3844 for my $hold (@$holds) {
3845 $e->allowed('UPDATE_HOLD', $hold->usr->home_ou) or return $e->die_event;
3846 $logger->info("Changing hold " . $hold->id . " target from " . $hold->target . " to $new_bib_id in title hold target change");
3847 $hold->target( $new_bib_id );
3848 $e->update_action_hold_request($hold) or return $e->die_event;
3853 _reset_hold($self, $e->requestor, $_) for @$holds;
3858 __PACKAGE__->register_method(
3859 method => 'rec_hold_count',
3860 api_name => 'open-ils.circ.bre.holds.count',
3862 desc => q/Returns the total number of holds that target the
3863 selected bib record or its associated copies and call_numbers/,
3865 { desc => 'Bib ID', type => 'number' },
3867 return => {desc => 'Hold count', type => 'number'}
3871 __PACKAGE__->register_method(
3872 method => 'rec_hold_count',
3873 api_name => 'open-ils.circ.mmr.holds.count',
3875 desc => q/Returns the total number of holds that target the
3876 selected metarecord or its associated copies, call_numbers, and bib records/,
3878 { desc => 'Metarecord ID', type => 'number' },
3880 return => {desc => 'Hold count', type => 'number'}
3884 # XXX Need to add type I (and, soon, type P) holds to these counts
3885 sub rec_hold_count {
3886 my($self, $conn, $target_id) = @_;
3893 filter => {metarecord => $target_id}
3900 filter => { id => $target_id },
3905 if($self->api_name =~ /mmr/) {
3906 delete $bre_join->{bre}->{filter};
3907 $bre_join->{bre}->{join} = $mmr_join;
3913 fkey => 'call_number',
3919 select => {ahr => [{column => 'id', transform => 'count', alias => 'count'}]},
3923 cancel_time => undef,
3924 fulfillment_time => undef,
3928 hold_type => [qw/C F R/],
3931 select => {acp => ['id']},
3932 from => { acp => $cn_join }
3942 select => {acn => ['id']},
3943 from => {acn => $bre_join}
3951 target => $target_id
3959 if($self->api_name =~ /mmr/) {
3960 $query->{where}->{'+ahr'}->{'-or'}->[2] = {
3965 select => {bre => ['id']},
3966 from => {bre => $mmr_join}
3972 $query->{where}->{'+ahr'}->{'-or'}->[3] = {
3975 target => $target_id
3981 return new_editor()->json_query($query)->[0]->{count};