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' }
425 desc => 'list of holds, event on error',
430 __PACKAGE__->register_method(
431 method => "retrieve_holds",
432 api_name => "open-ils.circ.holds.id_list.retrieve",
435 desc => "Retrieves all the hold IDs, for the specified user. $ses_is_req_note",
437 { desc => 'Authentication token', type => 'string' },
438 { desc => 'User ID', type => 'integer' }
441 desc => 'list of holds, event on error',
446 __PACKAGE__->register_method(
447 method => "retrieve_holds",
448 api_name => "open-ils.circ.holds.canceled.retrieve",
451 desc => "Retrieves all the cancelled holds for the specified user. $ses_is_req_note",
453 { desc => 'Authentication token', type => 'string' },
454 { desc => 'User ID', type => 'integer' }
457 desc => 'list of holds, event on error',
462 __PACKAGE__->register_method(
463 method => "retrieve_holds",
464 api_name => "open-ils.circ.holds.canceled.id_list.retrieve",
467 desc => "Retrieves list of cancelled hold IDs for the specified user. $ses_is_req_note",
469 { desc => 'Authentication token', type => 'string' },
470 { desc => 'User ID', type => 'integer' }
473 desc => 'list of hold IDs, event on error',
480 my ($self, $client, $auth, $user_id) = @_;
482 my $e = new_editor(authtoken=>$auth);
483 return $e->event unless $e->checkauth;
484 $user_id = $e->requestor->id unless defined $user_id;
486 my $notes_filter = {staff => 'f'};
487 my $user = $e->retrieve_actor_user($user_id) or return $e->event;
488 unless($user_id == $e->requestor->id) {
489 if($e->allowed('VIEW_HOLD', $user->home_ou)) {
490 $notes_filter = {staff => 't'}
492 my $allowed = OpenILS::Application::Actor::Friends->friend_perm_allowed(
493 $e, $user_id, $e->requestor->id, 'hold.view');
494 return $e->event unless $allowed;
497 # staff member looking at his/her own holds can see staff and non-staff notes
498 $notes_filter = {} if $e->allowed('VIEW_HOLD', $user->home_ou);
502 select => {ahr => ['id']},
504 where => {usr => $user_id, fulfillment_time => undef}
507 if($self->api_name =~ /canceled/) {
509 # Fetch the canceled holds
510 # order cancelled holds by cancel time, most recent first
512 $holds_query->{order_by} = [{class => 'ahr', field => 'cancel_time', direction => 'desc'}];
515 my $cancel_count = $U->ou_ancestor_setting_value(
516 $e->requestor->ws_ou, 'circ.holds.canceled.display_count', $e);
518 unless($cancel_count) {
519 $cancel_age = $U->ou_ancestor_setting_value(
520 $e->requestor->ws_ou, 'circ.holds.canceled.display_age', $e);
522 # if no settings are defined, default to last 10 cancelled holds
523 $cancel_count = 10 unless $cancel_age;
526 if($cancel_count) { # limit by count
528 $holds_query->{where}->{cancel_time} = {'!=' => undef};
529 $holds_query->{limit} = $cancel_count;
531 } elsif($cancel_age) { # limit by age
533 # find all of the canceled holds that were canceled within the configured time frame
534 my $date = DateTime->now->subtract(seconds => OpenSRF::Utils::interval_to_seconds($cancel_age));
535 $date = $U->epoch2ISO8601($date->epoch);
536 $holds_query->{where}->{cancel_time} = {'>=' => $date};
541 # order non-cancelled holds by ready-for-pickup, then active, followed by suspended
542 # "compare" sorts false values to the front. testing pickup_lib != current_shelf_lib
543 # will sort by pl = csl > pl != csl > followed by csl is null;
544 $holds_query->{order_by} = [
546 field => 'pickup_lib',
547 compare => {'!=' => {'+ahr' => 'current_shelf_lib'}}},
548 {class => 'ahr', field => 'shelf_time'},
549 {class => 'ahr', field => 'frozen'},
550 {class => 'ahr', field => 'request_time'}
553 $holds_query->{where}->{cancel_time} = undef;
556 my $hold_ids = $e->json_query($holds_query);
557 $hold_ids = [ map { $_->{id} } @$hold_ids ];
559 return $hold_ids if $self->api_name =~ /id_list/;
562 for my $hold_id ( @$hold_ids ) {
564 my $hold = $e->retrieve_action_hold_request($hold_id);
565 $hold->notes($e->search_action_hold_request_note({hold => $hold_id, %$notes_filter}));
568 $e->search_action_hold_transit_copy([
570 {order_by => {ahtc => 'source_send_time desc'}, limit => 1}])->[0]
580 __PACKAGE__->register_method(
581 method => 'user_hold_count',
582 api_name => 'open-ils.circ.hold.user.count'
585 sub user_hold_count {
586 my ( $self, $conn, $auth, $userid ) = @_;
587 my $e = new_editor( authtoken => $auth );
588 return $e->event unless $e->checkauth;
589 my $patron = $e->retrieve_actor_user($userid)
591 return $e->event unless $e->allowed( 'VIEW_HOLD', $patron->home_ou );
592 return __user_hold_count( $self, $e, $userid );
595 sub __user_hold_count {
596 my ( $self, $e, $userid ) = @_;
597 my $holds = $e->search_action_hold_request(
600 fulfillment_time => undef,
601 cancel_time => undef,
606 return scalar(@$holds);
610 __PACKAGE__->register_method(
611 method => "retrieve_holds_by_pickup_lib",
612 api_name => "open-ils.circ.holds.retrieve_by_pickup_lib",
614 "Retrieves all the holds, with hold transits attached, for the specified pickup_ou id."
617 __PACKAGE__->register_method(
618 method => "retrieve_holds_by_pickup_lib",
619 api_name => "open-ils.circ.holds.id_list.retrieve_by_pickup_lib",
620 notes => "Retrieves all the hold ids for the specified pickup_ou id. "
623 sub retrieve_holds_by_pickup_lib {
624 my ($self, $client, $login_session, $ou_id) = @_;
626 #FIXME -- put an appropriate permission check here
627 #my( $user, $target, $evt ) = $apputils->checkses_requestor(
628 # $login_session, $user_id, 'VIEW_HOLD' );
629 #return $evt if $evt;
631 my $holds = $apputils->simplereq(
633 "open-ils.cstore.direct.action.hold_request.search.atomic",
635 pickup_lib => $ou_id ,
636 fulfillment_time => undef,
639 { order_by => { ahr => "request_time" } }
642 if ( ! $self->api_name =~ /id_list/ ) {
643 flesh_hold_transits($holds);
647 return [ map { $_->id } @$holds ];
651 __PACKAGE__->register_method(
652 method => "uncancel_hold",
653 api_name => "open-ils.circ.hold.uncancel"
657 my($self, $client, $auth, $hold_id) = @_;
658 my $e = new_editor(authtoken=>$auth, xact=>1);
659 return $e->die_event unless $e->checkauth;
661 my $hold = $e->retrieve_action_hold_request($hold_id)
662 or return $e->die_event;
663 return $e->die_event unless $e->allowed('CANCEL_HOLDS', $hold->request_lib);
665 if ($hold->fulfillment_time) {
669 unless ($hold->cancel_time) {
674 # if configured to reset the request time, also reset the expire time
675 if($U->ou_ancestor_setting_value(
676 $hold->request_lib, 'circ.holds.uncancel.reset_request_time', $e)) {
678 $hold->request_time('now');
679 my $interval = $U->ou_ancestor_setting_value($hold->request_lib, OILS_SETTING_HOLD_EXPIRE);
681 my $date = DateTime->now->add(seconds => OpenSRF::Utils::interval_to_seconds($interval));
682 $hold->expire_time($U->epoch2ISO8601($date->epoch));
686 $hold->clear_cancel_time;
687 $hold->clear_cancel_cause;
688 $hold->clear_cancel_note;
689 $hold->clear_shelf_time;
690 $hold->clear_current_copy;
691 $hold->clear_capture_time;
692 $hold->clear_prev_check_time;
693 $hold->clear_shelf_expire_time;
694 $hold->clear_current_shelf_lib;
696 $e->update_action_hold_request($hold) or return $e->die_event;
699 $U->storagereq('open-ils.storage.action.hold_request.copy_targeter', undef, $hold_id);
705 __PACKAGE__->register_method(
706 method => "cancel_hold",
707 api_name => "open-ils.circ.hold.cancel",
709 desc => 'Cancels the specified hold. The login session is the requestor. If the requestor is different from the usr field ' .
710 'on the hold, the requestor must have CANCEL_HOLDS permissions. The hold may be either the hold object or the hold id',
712 {desc => 'Authentication token', type => 'string'},
713 {desc => 'Hold ID', type => 'number'},
714 {desc => 'Cause of Cancellation', type => 'string'},
715 {desc => 'Note', type => 'string'}
718 desc => '1 on success, event on error'
724 my($self, $client, $auth, $holdid, $cause, $note) = @_;
726 my $e = new_editor(authtoken=>$auth, xact=>1);
727 return $e->die_event unless $e->checkauth;
729 my $hold = $e->retrieve_action_hold_request($holdid)
730 or return $e->die_event;
732 if( $e->requestor->id ne $hold->usr ) {
733 return $e->die_event unless $e->allowed('CANCEL_HOLDS');
736 if ($hold->cancel_time) {
741 # If the hold is captured, reset the copy status
742 if( $hold->capture_time and $hold->current_copy ) {
744 my $copy = $e->retrieve_asset_copy($hold->current_copy)
745 or return $e->die_event;
747 if( $copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF ) {
748 $logger->info("canceling hold $holdid whose item is on the holds shelf");
749 # $logger->info("setting copy to status 'reshelving' on hold cancel");
750 # $copy->status(OILS_COPY_STATUS_RESHELVING);
751 # $copy->editor($e->requestor->id);
752 # $copy->edit_date('now');
753 # $e->update_asset_copy($copy) or return $e->event;
755 } elsif( $copy->status == OILS_COPY_STATUS_IN_TRANSIT ) {
758 $logger->warn("! canceling hold [$hid] that is in transit");
759 my $transid = $e->search_action_hold_transit_copy({hold=>$hold->id},{idlist=>1})->[0];
762 my $trans = $e->retrieve_action_transit_copy($transid);
763 # Leave the transit alive, but set the copy status to
764 # reshelving so it will be properly reshelved when it gets back home
766 $trans->copy_status( OILS_COPY_STATUS_RESHELVING );
767 $e->update_action_transit_copy($trans) or return $e->die_event;
773 $hold->cancel_time('now');
774 $hold->cancel_cause($cause);
775 $hold->cancel_note($note);
776 $e->update_action_hold_request($hold)
777 or return $e->die_event;
779 delete_hold_copy_maps($self, $e, $hold->id);
783 # re-fetch the hold to pick up the real cancel_time (not "now") for A/T
785 $hold = $e->retrieve_action_hold_request($hold->id) or return $e->die_event;
788 if ($e->requestor->id == $hold->usr) {
789 $U->create_events_for_hook('hold_request.cancel.patron', $hold, $hold->pickup_lib);
791 $U->create_events_for_hook('hold_request.cancel.staff', $hold, $hold->pickup_lib);
797 sub delete_hold_copy_maps {
802 my $maps = $editor->search_action_hold_copy_map({hold=>$holdid});
804 $editor->delete_action_hold_copy_map($_)
805 or return $editor->event;
811 my $update_hold_desc = 'The login session is the requestor. ' .
812 'If the requestor is different from the usr field on the hold, ' .
813 'the requestor must have UPDATE_HOLDS permissions. ' .
814 'If supplying a hash of hold data, "id" must be included. ' .
815 'The hash is ignored if a hold object is supplied, ' .
816 'so you should supply only one kind of hold data argument.' ;
818 __PACKAGE__->register_method(
819 method => "update_hold",
820 api_name => "open-ils.circ.hold.update",
822 desc => "Updates the specified hold. $update_hold_desc",
824 {desc => 'Authentication token', type => 'string'},
825 {desc => 'Hold Object', type => 'object'},
826 {desc => 'Hash of values to be applied', type => 'object'}
829 desc => 'Hold ID on success, event on error',
835 __PACKAGE__->register_method(
836 method => "batch_update_hold",
837 api_name => "open-ils.circ.hold.update.batch",
840 desc => "Updates the specified hold(s). $update_hold_desc",
842 {desc => 'Authentication token', type => 'string'},
843 {desc => 'Array of hold obejcts', type => 'array' },
844 {desc => 'Array of hashes of values to be applied', type => 'array' }
847 desc => 'Hold ID per success, event per error',
853 my($self, $client, $auth, $hold, $values) = @_;
854 my $e = new_editor(authtoken=>$auth, xact=>1);
855 return $e->die_event unless $e->checkauth;
856 my $resp = update_hold_impl($self, $e, $hold, $values);
857 if ($U->event_code($resp)) {
861 $e->commit; # FIXME: update_hold_impl already does $e->commit ??
865 sub batch_update_hold {
866 my($self, $client, $auth, $hold_list, $values_list) = @_;
867 my $e = new_editor(authtoken=>$auth);
868 return $e->die_event unless $e->checkauth;
870 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.
872 $values_list ||= []; # FIXME: either move this above $count declaration, or send an event if both lists undef. Probably the latter.
874 # FIXME: Failing over to [] guarantees warnings for "Use of unitialized value" in update_hold_impl call.
875 # FIXME: We should be sure we only call update_hold_impl with hold object OR hash, not both.
877 for my $idx (0..$count-1) {
879 my $resp = update_hold_impl($self, $e, $hold_list->[$idx], $values_list->[$idx]);
880 $e->xact_commit unless $U->event_code($resp);
881 $client->respond($resp);
885 return undef; # not in the register return type, assuming we should always have at least one list populated
888 sub update_hold_impl {
889 my($self, $e, $hold, $values) = @_;
891 my $need_retarget = 0;
894 $hold = $e->retrieve_action_hold_request($values->{id})
895 or return $e->die_event;
896 for my $k (keys %$values) {
897 # Outside of pickup_lib (covered by the first regex) I don't know when these would currently change.
898 # But hey, why not cover things that may happen later?
899 if ($k =~ '_(lib|ou)$' || $k eq 'target' || $k eq 'hold_type' || $k eq 'requestor' || $k eq 'selection_depth' || $k eq 'holdable_formats') {
900 if (defined $values->{$k} && defined $hold->$k() && $values->{$k} ne $hold->$k()) {
901 # Value changed? RETARGET!
903 } elsif (defined $hold->$k() != defined $values->{$k}) {
904 # Value being set or cleared? RETARGET!
908 if (defined $values->{$k}) {
909 $hold->$k($values->{$k});
911 my $f = "clear_$k"; $hold->$f();
916 my $orig_hold = $e->retrieve_action_hold_request($hold->id)
917 or return $e->die_event;
919 # don't allow the user to be changed
920 return OpenILS::Event->new('BAD_PARAMS') if $hold->usr != $orig_hold->usr;
922 if($hold->usr ne $e->requestor->id) {
923 # if the hold is for a different user, make sure the
924 # requestor has the appropriate permissions
925 my $usr = $e->retrieve_actor_user($hold->usr)
926 or return $e->die_event;
927 return $e->die_event unless $e->allowed('UPDATE_HOLD', $usr->home_ou);
931 # --------------------------------------------------------------
932 # Changing the request time is like playing God
933 # --------------------------------------------------------------
934 if($hold->request_time ne $orig_hold->request_time) {
935 return OpenILS::Event->new('BAD_PARAMS') if $hold->fulfillment_time;
936 return $e->die_event unless $e->allowed('UPDATE_HOLD_REQUEST_TIME', $hold->pickup_lib);
940 # --------------------------------------------------------------
941 # Code for making sure staff have appropriate permissons for cut_in_line
942 # This, as is, doesn't prevent a user from cutting their own holds in line
944 # --------------------------------------------------------------
945 if($U->is_true($hold->cut_in_line) ne $U->is_true($orig_hold->cut_in_line)) {
946 return $e->die_event unless $e->allowed('UPDATE_HOLD_REQUEST_TIME', $hold->pickup_lib);
950 # --------------------------------------------------------------
951 # Disallow hold suspencion if the hold is already captured.
952 # --------------------------------------------------------------
953 if ($U->is_true($hold->frozen) and not $U->is_true($orig_hold->frozen)) {
954 $hold_status = _hold_status($e, $hold);
955 if ($hold_status > 2 && $hold_status != 7) { # hold is captured
956 $logger->info("bypassing hold freeze on captured hold");
957 return OpenILS::Event->new('HOLD_SUSPEND_AFTER_CAPTURE');
962 # --------------------------------------------------------------
963 # if the hold is on the holds shelf or in transit and the pickup
964 # lib changes we need to create a new transit.
965 # --------------------------------------------------------------
966 if($orig_hold->pickup_lib ne $hold->pickup_lib) {
968 $hold_status = _hold_status($e, $hold) unless $hold_status;
970 if($hold_status == 3) { # in transit
972 return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_TRANSIT', $orig_hold->pickup_lib);
973 return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_TRANSIT', $hold->pickup_lib);
975 $logger->info("updating pickup lib for hold ".$hold->id." while already in transit");
977 # update the transit to reflect the new pickup location
978 my $transit = $e->search_action_hold_transit_copy(
979 {hold=>$hold->id, dest_recv_time => undef})->[0]
980 or return $e->die_event;
982 $transit->prev_dest($transit->dest); # mark the previous destination on the transit
983 $transit->dest($hold->pickup_lib);
984 $e->update_action_hold_transit_copy($transit) or return $e->die_event;
986 } elsif($hold_status == 4 or $hold_status == 5 or $hold_status == 8) { # on holds shelf
988 return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_HOLDS_SHELF', $orig_hold->pickup_lib);
989 return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_HOLDS_SHELF', $hold->pickup_lib);
991 $logger->info("updating pickup lib for hold ".$hold->id." while on holds shelf");
993 if ($hold->pickup_lib eq $orig_hold->current_shelf_lib) {
994 # This can happen if the pickup lib is changed while the hold is
995 # on the shelf, then changed back to the original pickup lib.
996 # Restore the original shelf_expire_time to prevent abuse.
997 set_hold_shelf_expire_time(undef, $hold, $e, $hold->shelf_time);
1000 # clear to prevent premature shelf expiration
1001 $hold->clear_shelf_expire_time;
1006 if($U->is_true($hold->frozen)) {
1007 $logger->info("clearing current_copy and check_time for frozen hold ".$hold->id);
1008 $hold->clear_current_copy;
1009 $hold->clear_prev_check_time;
1012 $e->update_action_hold_request($hold) or return $e->die_event;
1015 if(!$U->is_true($hold->frozen) && $U->is_true($orig_hold->frozen)) {
1016 $logger->info("Running targeter on activated hold ".$hold->id);
1017 $U->storagereq( 'open-ils.storage.action.hold_request.copy_targeter', undef, $hold->id );
1020 # a change to mint-condition changes the set of potential copies, so retarget the hold;
1021 if($U->is_true($hold->mint_condition) and !$U->is_true($orig_hold->mint_condition)) {
1022 _reset_hold($self, $e->requestor, $hold)
1023 } elsif($need_retarget && !defined $hold->capture_time()) { # If needed, retarget the hold due to changes
1025 'open-ils.storage.action.hold_request.copy_targeter', undef, $hold->id );
1031 # this does not update the hold in the DB. It only
1032 # sets the shelf_expire_time field on the hold object.
1033 # start_time is optional and defaults to 'now'
1034 sub set_hold_shelf_expire_time {
1035 my ($class, $hold, $editor, $start_time) = @_;
1037 my $shelf_expire = $U->ou_ancestor_setting_value(
1039 'circ.holds.default_shelf_expire_interval',
1043 return undef unless $shelf_expire;
1045 $start_time = ($start_time) ?
1046 DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($start_time)) :
1049 my $seconds = OpenSRF::Utils->interval_to_seconds($shelf_expire);
1050 my $expire_time = $start_time->add(seconds => $seconds);
1052 # if the shelf expire time overlaps with a pickup lib's
1053 # closed date, push it out to the first open date
1054 my $dateinfo = $U->storagereq(
1055 'open-ils.storage.actor.org_unit.closed_date.overlap',
1056 $hold->pickup_lib, $expire_time->strftime('%FT%T%z'));
1059 my $dt_parser = DateTime::Format::ISO8601->new;
1060 $expire_time = $dt_parser->parse_datetime(cleanse_ISO8601($dateinfo->{end}));
1062 # TODO: enable/disable time bump via setting?
1063 $expire_time->set(hour => '23', minute => '59', second => '59');
1065 $logger->info("circulator: shelf_expire_time overlaps".
1066 " with closed date, pushing expire time to $expire_time");
1069 $hold->shelf_expire_time($expire_time->strftime('%FT%T%z'));
1075 my($e, $orig_hold, $hold, $copy) = @_;
1076 my $src = $orig_hold->pickup_lib;
1077 my $dest = $hold->pickup_lib;
1079 $logger->info("putting hold into transit on pickup_lib update");
1081 my $transit = Fieldmapper::action::hold_transit_copy->new;
1082 $transit->hold($hold->id);
1083 $transit->source($src);
1084 $transit->dest($dest);
1085 $transit->target_copy($copy->id);
1086 $transit->source_send_time('now');
1087 $transit->copy_status(OILS_COPY_STATUS_ON_HOLDS_SHELF);
1089 $copy->status(OILS_COPY_STATUS_IN_TRANSIT);
1090 $copy->editor($e->requestor->id);
1091 $copy->edit_date('now');
1093 $e->create_action_hold_transit_copy($transit) or return $e->die_event;
1094 $e->update_asset_copy($copy) or return $e->die_event;
1098 # if the hold is frozen, this method ensures that the hold is not "targeted",
1099 # that is, it clears the current_copy and prev_check_time to essentiallly
1100 # reset the hold. If it is being activated, it runs the targeter in the background
1101 sub update_hold_if_frozen {
1102 my($self, $e, $hold, $orig_hold) = @_;
1103 return if $hold->capture_time;
1105 if($U->is_true($hold->frozen)) {
1106 $logger->info("clearing current_copy and check_time for frozen hold ".$hold->id);
1107 $hold->clear_current_copy;
1108 $hold->clear_prev_check_time;
1111 if($U->is_true($orig_hold->frozen)) {
1112 $logger->info("Running targeter on activated hold ".$hold->id);
1113 $U->storagereq( 'open-ils.storage.action.hold_request.copy_targeter', undef, $hold->id );
1118 __PACKAGE__->register_method(
1119 method => "hold_note_CUD",
1120 api_name => "open-ils.circ.hold_request.note.cud",
1122 desc => 'Create, update or delete a hold request note. If the operator (from Auth. token) '
1123 . 'is not the owner of the hold, the UPDATE_HOLD permission is required',
1125 { desc => 'Authentication token', type => 'string' },
1126 { desc => 'Hold note object', type => 'object' }
1129 desc => 'Returns the note ID, event on error'
1135 my($self, $conn, $auth, $note) = @_;
1137 my $e = new_editor(authtoken => $auth, xact => 1);
1138 return $e->die_event unless $e->checkauth;
1140 my $hold = $e->retrieve_action_hold_request($note->hold)
1141 or return $e->die_event;
1143 if($hold->usr ne $e->requestor->id) {
1144 my $usr = $e->retrieve_actor_user($hold->usr);
1145 return $e->die_event unless $e->allowed('UPDATE_HOLD', $usr->home_ou);
1146 $note->staff('t') if $note->isnew;
1150 $e->create_action_hold_request_note($note) or return $e->die_event;
1151 } elsif($note->ischanged) {
1152 $e->update_action_hold_request_note($note) or return $e->die_event;
1153 } elsif($note->isdeleted) {
1154 $e->delete_action_hold_request_note($note) or return $e->die_event;
1162 __PACKAGE__->register_method(
1163 method => "retrieve_hold_status",
1164 api_name => "open-ils.circ.hold.status.retrieve",
1166 desc => 'Calculates the current status of the hold. The requestor must have ' .
1167 'VIEW_HOLD permissions if the hold is for a user other than the requestor' ,
1169 { desc => 'Hold ID', type => 'number' }
1172 # type => 'number', # event sometimes
1173 desc => <<'END_OF_DESC'
1174 Returns event on error or:
1175 -1 on error (for now),
1176 1 for 'waiting for copy to become available',
1177 2 for 'waiting for copy capture',
1180 5 for 'hold-shelf-delay'
1183 8 for 'captured, on wrong hold shelf'
1189 sub retrieve_hold_status {
1190 my($self, $client, $auth, $hold_id) = @_;
1192 my $e = new_editor(authtoken => $auth);
1193 return $e->event unless $e->checkauth;
1194 my $hold = $e->retrieve_action_hold_request($hold_id)
1195 or return $e->event;
1197 if( $e->requestor->id != $hold->usr ) {
1198 return $e->event unless $e->allowed('VIEW_HOLD');
1201 return _hold_status($e, $hold);
1207 if ($hold->cancel_time) {
1210 if ($U->is_true($hold->frozen) && !$hold->capture_time) {
1213 if ($hold->current_shelf_lib and $hold->current_shelf_lib ne $hold->pickup_lib) {
1216 return 1 unless $hold->current_copy;
1217 return 2 unless $hold->capture_time;
1219 my $copy = $hold->current_copy;
1220 unless( ref $copy ) {
1221 $copy = $e->retrieve_asset_copy($hold->current_copy)
1222 or return $e->event;
1225 return 3 if $copy->status == OILS_COPY_STATUS_IN_TRANSIT;
1227 if($copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF) {
1229 my $hs_wait_interval = $U->ou_ancestor_setting_value($hold->pickup_lib, 'circ.hold_shelf_status_delay');
1230 return 4 unless $hs_wait_interval;
1232 # if a hold_shelf_status_delay interval is defined and start_time plus
1233 # the interval is greater than now, consider the hold to be in the virtual
1234 # "on its way to the holds shelf" status. Return 5.
1236 my $transit = $e->search_action_hold_transit_copy({hold => $hold->id})->[0];
1237 my $start_time = ($transit) ? $transit->dest_recv_time : $hold->capture_time;
1238 $start_time = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($start_time));
1239 my $end_time = $start_time->add(seconds => OpenSRF::Utils::interval_to_seconds($hs_wait_interval));
1241 return 5 if $end_time > DateTime->now;
1250 __PACKAGE__->register_method(
1251 method => "retrieve_hold_queue_stats",
1252 api_name => "open-ils.circ.hold.queue_stats.retrieve",
1254 desc => 'Returns summary data about the state of a hold',
1256 { desc => 'Authentication token', type => 'string'},
1257 { desc => 'Hold ID', type => 'number'},
1260 desc => q/Summary object with keys:
1261 total_holds : total holds in queue
1262 queue_position : current queue position
1263 potential_copies : number of potential copies for this hold
1264 estimated_wait : estimated wait time in days
1265 status : hold status
1266 -1 => error or unexpected state,
1267 1 => 'waiting for copy to become available',
1268 2 => 'waiting for copy capture',
1271 5 => 'hold-shelf-delay'
1278 sub retrieve_hold_queue_stats {
1279 my($self, $conn, $auth, $hold_id) = @_;
1280 my $e = new_editor(authtoken => $auth);
1281 return $e->event unless $e->checkauth;
1282 my $hold = $e->retrieve_action_hold_request($hold_id) or return $e->event;
1283 if($e->requestor->id != $hold->usr) {
1284 return $e->event unless $e->allowed('VIEW_HOLD');
1286 return retrieve_hold_queue_status_impl($e, $hold);
1289 sub retrieve_hold_queue_status_impl {
1293 # The holds queue is defined as the distinct set of holds that share at
1294 # least one potential copy with the context hold, plus any holds that
1295 # share the same hold type and target. The latter part exists to
1296 # accomodate holds that currently have no potential copies
1297 my $q_holds = $e->json_query({
1299 # fetch cut_in_line and request_time since they're in the order_by
1300 # and we're asking for distinct values
1301 select => {ahr => ['id', 'cut_in_line', 'request_time']},
1308 'field' => 'target_copy',
1309 'fkey' => 'target_copy'
1318 "field" => "cut_in_line",
1319 "transform" => "coalesce",
1321 "direction" => "desc"
1323 { "class" => "ahr", "field" => "request_time" }
1327 '+ahcm2' => { hold => $hold->id }
1331 if (!@$q_holds) { # none? maybe we don't have a map ...
1332 $q_holds = $e->json_query({
1333 select => {ahr => ['id', 'cut_in_line', 'request_time']},
1338 "field" => "cut_in_line",
1339 "transform" => "coalesce",
1341 "direction" => "desc"
1343 { "class" => "ahr", "field" => "request_time" }
1346 hold_type => $hold->hold_type,
1347 target => $hold->target
1354 for my $h (@$q_holds) {
1355 last if $h->{id} == $hold->id;
1359 my $hold_data = $e->json_query({
1361 acp => [ {column => 'id', transform => 'count', aggregate => 1, alias => 'count'} ],
1362 ccm => [ {column =>'avg_wait_time'} ]
1368 ccm => {type => 'left'}
1373 where => {'+ahcm' => {hold => $hold->id} }
1376 my $user_org = $e->json_query({select => {au => ['home_ou']}, from => 'au', where => {id => $hold->usr}})->[0]->{home_ou};
1378 my $default_wait = $U->ou_ancestor_setting_value($user_org, OILS_SETTING_HOLD_ESIMATE_WAIT_INTERVAL);
1379 my $min_wait = $U->ou_ancestor_setting_value($user_org, 'circ.holds.min_estimated_wait_interval');
1380 $min_wait = OpenSRF::Utils::interval_to_seconds($min_wait || '0 seconds');
1381 $default_wait ||= '0 seconds';
1383 # Estimated wait time is the average wait time across the set
1384 # of potential copies, divided by the number of potential copies
1385 # times the queue position.
1387 my $combined_secs = 0;
1388 my $num_potentials = 0;
1390 for my $wait_data (@$hold_data) {
1391 my $count += $wait_data->{count};
1392 $combined_secs += $count *
1393 OpenSRF::Utils::interval_to_seconds($wait_data->{avg_wait_time} || $default_wait);
1394 $num_potentials += $count;
1397 my $estimated_wait = -1;
1399 if($num_potentials) {
1400 my $avg_wait = $combined_secs / $num_potentials;
1401 $estimated_wait = $qpos * ($avg_wait / $num_potentials);
1402 $estimated_wait = $min_wait if $estimated_wait < $min_wait and $estimated_wait != -1;
1406 total_holds => scalar(@$q_holds),
1407 queue_position => $qpos,
1408 potential_copies => $num_potentials,
1409 status => _hold_status( $e, $hold ),
1410 estimated_wait => int($estimated_wait)
1415 sub fetch_open_hold_by_current_copy {
1418 my $hold = $apputils->simplereq(
1420 'open-ils.cstore.direct.action.hold_request.search.atomic',
1421 { current_copy => $copyid , cancel_time => undef, fulfillment_time => undef });
1422 return $hold->[0] if ref($hold);
1426 sub fetch_related_holds {
1429 return $apputils->simplereq(
1431 'open-ils.cstore.direct.action.hold_request.search.atomic',
1432 { current_copy => $copyid , cancel_time => undef, fulfillment_time => undef });
1436 __PACKAGE__->register_method(
1437 method => "hold_pull_list",
1438 api_name => "open-ils.circ.hold_pull_list.retrieve",
1440 desc => 'Returns (reference to) a list of holds that need to be "pulled" by a given location. ' .
1441 'The location is determined by the login session.',
1443 { desc => 'Limit (optional)', type => 'number'},
1444 { desc => 'Offset (optional)', type => 'number'},
1447 desc => 'reference to a list of holds, or event on failure',
1452 __PACKAGE__->register_method(
1453 method => "hold_pull_list",
1454 api_name => "open-ils.circ.hold_pull_list.id_list.retrieve",
1456 desc => 'Returns (reference to) a list of holds IDs that need to be "pulled" by a given location. ' .
1457 'The location is determined by the login session.',
1459 { desc => 'Limit (optional)', type => 'number'},
1460 { desc => 'Offset (optional)', type => 'number'},
1463 desc => 'reference to a list of holds, or event on failure',
1468 __PACKAGE__->register_method(
1469 method => "hold_pull_list",
1470 api_name => "open-ils.circ.hold_pull_list.retrieve.count",
1472 desc => 'Returns a count of holds that need to be "pulled" by a given location. ' .
1473 'The location is determined by the login session.',
1475 { desc => 'Limit (optional)', type => 'number'},
1476 { desc => 'Offset (optional)', type => 'number'},
1479 desc => 'Holds count (integer), or event on failure',
1486 sub hold_pull_list {
1487 my( $self, $conn, $authtoken, $limit, $offset ) = @_;
1488 my( $reqr, $evt ) = $U->checkses($authtoken);
1489 return $evt if $evt;
1491 my $org = $reqr->ws_ou || $reqr->home_ou;
1492 # the perm locaiton shouldn't really matter here since holds
1493 # will exist all over and VIEW_HOLDS should be universal
1494 $evt = $U->check_perms($reqr->id, $org, 'VIEW_HOLD');
1495 return $evt if $evt;
1497 if($self->api_name =~ /count/) {
1499 my $count = $U->storagereq(
1500 'open-ils.storage.direct.action.hold_request.pull_list.current_copy_circ_lib.status_filtered.count',
1501 $org, $limit, $offset );
1503 $logger->info("Grabbing pull list for org unit $org with $count items");
1506 } elsif( $self->api_name =~ /id_list/ ) {
1507 return $U->storagereq(
1508 'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib.status_filtered.atomic',
1509 $org, $limit, $offset );
1512 return $U->storagereq(
1513 'open-ils.storage.direct.action.hold_request.pull_list.search.current_copy_circ_lib.status_filtered.atomic',
1514 $org, $limit, $offset );
1518 __PACKAGE__->register_method(
1519 method => "print_hold_pull_list",
1520 api_name => "open-ils.circ.hold_pull_list.print",
1522 desc => 'Returns an HTML-formatted holds pull list',
1524 { desc => 'Authtoken', type => 'string'},
1525 { desc => 'Org unit ID. Optional, defaults to workstation org unit', type => 'number'},
1528 desc => 'HTML string',
1534 sub print_hold_pull_list {
1535 my($self, $client, $auth, $org_id) = @_;
1537 my $e = new_editor(authtoken=>$auth);
1538 return $e->event unless $e->checkauth;
1540 $org_id = (defined $org_id) ? $org_id : $e->requestor->ws_ou;
1541 return $e->event unless $e->allowed('VIEW_HOLD', $org_id);
1543 my $hold_ids = $U->storagereq(
1544 'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib.status_filtered.atomic',
1547 return undef unless @$hold_ids;
1549 $client->status(new OpenSRF::DomainObject::oilsContinueStatus);
1551 # Holds will /NOT/ be in order after this ...
1552 my $holds = $e->search_action_hold_request({id => $hold_ids}, {substream => 1});
1553 $client->status(new OpenSRF::DomainObject::oilsContinueStatus);
1555 # ... so we must resort.
1556 my $hold_map = +{map { $_->id => $_ } @$holds};
1557 my $sorted_holds = [];
1558 push @$sorted_holds, $hold_map->{$_} foreach @$hold_ids;
1560 return $U->fire_object_event(
1561 undef, "ahr.format.pull_list", $sorted_holds,
1562 $org_id, undef, undef, $client
1567 __PACKAGE__->register_method(
1568 method => "print_hold_pull_list_stream",
1570 api_name => "open-ils.circ.hold_pull_list.print.stream",
1572 desc => 'Returns a stream of fleshed holds',
1574 { desc => 'Authtoken', type => 'string'},
1575 { 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)',
1580 desc => 'A stream of fleshed holds',
1586 sub print_hold_pull_list_stream {
1587 my($self, $client, $auth, $params) = @_;
1589 my $e = new_editor(authtoken=>$auth);
1590 return $e->die_event unless $e->checkauth;
1592 delete($$params{org_id}) unless (int($$params{org_id}));
1593 delete($$params{limit}) unless (int($$params{limit}));
1594 delete($$params{offset}) unless (int($$params{offset}));
1595 delete($$params{chunk_size}) unless (int($$params{chunk_size}));
1596 delete($$params{chunk_size}) if ($$params{chunk_size} && $$params{chunk_size} > 50); # keep the size reasonable
1597 $$params{chunk_size} ||= 10;
1599 $$params{org_id} = (defined $$params{org_id}) ? $$params{org_id}: $e->requestor->ws_ou;
1600 return $e->die_event unless $e->allowed('VIEW_HOLD', $$params{org_id });
1603 if ($$params{sort} && @{ $$params{sort} }) {
1604 for my $s (@{ $$params{sort} }) {
1605 if ($s eq 'acplo.position') {
1607 "class" => "acplo", "field" => "position",
1608 "transform" => "coalesce", "params" => [999]
1610 } elsif ($s eq 'prefix') {
1611 push @$sort, {"class" => "acnp", "field" => "label_sortkey"};
1612 } elsif ($s eq 'call_number') {
1613 push @$sort, {"class" => "acn", "field" => "label_sortkey"};
1614 } elsif ($s eq 'suffix') {
1615 push @$sort, {"class" => "acns", "field" => "label_sortkey"};
1616 } elsif ($s eq 'request_time') {
1617 push @$sort, {"class" => "ahr", "field" => "request_time"};
1621 push @$sort, {"class" => "ahr", "field" => "request_time"};
1624 my $holds_ids = $e->json_query(
1626 "select" => {"ahr" => ["id"]},
1631 "fkey" => "current_copy",
1633 "circ_lib" => $$params{org_id}, "status" => [0,7]
1638 "fkey" => "call_number",
1652 "fkey" => "circ_lib",
1655 "location" => {"=" => {"+acp" => "location"}}
1664 "capture_time" => undef,
1665 "cancel_time" => undef,
1667 {"expire_time" => undef },
1668 {"expire_time" => {">" => "now"}}
1672 (@$sort ? (order_by => $sort) : ()),
1673 ($$params{limit} ? (limit => $$params{limit}) : ()),
1674 ($$params{offset} ? (offset => $$params{offset}) : ())
1675 }, {"substream" => 1}
1676 ) or return $e->die_event;
1678 $logger->info("about to stream back " . scalar(@$holds_ids) . " holds");
1681 for my $hid (@$holds_ids) {
1682 push @chunk, $e->retrieve_action_hold_request([
1686 "ahr" => ["usr", "current_copy"],
1688 "acp" => ["location", "call_number", "parts"],
1689 "acn" => ["record","prefix","suffix"]
1694 if (@chunk >= $$params{chunk_size}) {
1695 $client->respond( \@chunk );
1699 $client->respond_complete( \@chunk ) if (@chunk);
1706 __PACKAGE__->register_method(
1707 method => 'fetch_hold_notify',
1708 api_name => 'open-ils.circ.hold_notification.retrieve_by_hold',
1711 Returns a list of hold notification objects based on hold id.
1712 @param authtoken The loggin session key
1713 @param holdid The id of the hold whose notifications we want to retrieve
1714 @return An array of hold notification objects, event on error.
1718 sub fetch_hold_notify {
1719 my( $self, $conn, $authtoken, $holdid ) = @_;
1720 my( $requestor, $evt ) = $U->checkses($authtoken);
1721 return $evt if $evt;
1722 my ($hold, $patron);
1723 ($hold, $evt) = $U->fetch_hold($holdid);
1724 return $evt if $evt;
1725 ($patron, $evt) = $U->fetch_user($hold->usr);
1726 return $evt if $evt;
1728 $evt = $U->check_perms($requestor->id, $patron->home_ou, 'VIEW_HOLD_NOTIFICATION');
1729 return $evt if $evt;
1731 $logger->info("User ".$requestor->id." fetching hold notifications for hold $holdid");
1732 return $U->cstorereq(
1733 'open-ils.cstore.direct.action.hold_notification.search.atomic', {hold => $holdid} );
1737 __PACKAGE__->register_method(
1738 method => 'create_hold_notify',
1739 api_name => 'open-ils.circ.hold_notification.create',
1741 Creates a new hold notification object
1742 @param authtoken The login session key
1743 @param notification The hold notification object to create
1744 @return ID of the new object on success, Event on error
1748 sub create_hold_notify {
1749 my( $self, $conn, $auth, $note ) = @_;
1750 my $e = new_editor(authtoken=>$auth, xact=>1);
1751 return $e->die_event unless $e->checkauth;
1753 my $hold = $e->retrieve_action_hold_request($note->hold)
1754 or return $e->die_event;
1755 my $patron = $e->retrieve_actor_user($hold->usr)
1756 or return $e->die_event;
1758 return $e->die_event unless
1759 $e->allowed('CREATE_HOLD_NOTIFICATION', $patron->home_ou);
1761 $note->notify_staff($e->requestor->id);
1762 $e->create_action_hold_notification($note) or return $e->die_event;
1767 __PACKAGE__->register_method(
1768 method => 'create_hold_note',
1769 api_name => 'open-ils.circ.hold_note.create',
1771 Creates a new hold request note object
1772 @param authtoken The login session key
1773 @param note The hold note object to create
1774 @return ID of the new object on success, Event on error
1778 sub create_hold_note {
1779 my( $self, $conn, $auth, $note ) = @_;
1780 my $e = new_editor(authtoken=>$auth, xact=>1);
1781 return $e->die_event unless $e->checkauth;
1783 my $hold = $e->retrieve_action_hold_request($note->hold)
1784 or return $e->die_event;
1785 my $patron = $e->retrieve_actor_user($hold->usr)
1786 or return $e->die_event;
1788 return $e->die_event unless
1789 $e->allowed('UPDATE_HOLD', $patron->home_ou); # FIXME: Using permcrud perm listed in fm_IDL.xml for ahrn. Probably want something more specific
1791 $e->create_action_hold_request_note($note) or return $e->die_event;
1796 __PACKAGE__->register_method(
1797 method => 'reset_hold',
1798 api_name => 'open-ils.circ.hold.reset',
1800 Un-captures and un-targets a hold, essentially returning
1801 it to the state it was in directly after it was placed,
1802 then attempts to re-target the hold
1803 @param authtoken The login session key
1804 @param holdid The id of the hold
1810 my( $self, $conn, $auth, $holdid ) = @_;
1812 my ($hold, $evt) = $U->fetch_hold($holdid);
1813 return $evt if $evt;
1814 ($reqr, $evt) = $U->checksesperm($auth, 'UPDATE_HOLD');
1815 return $evt if $evt;
1816 $evt = _reset_hold($self, $reqr, $hold);
1817 return $evt if $evt;
1822 __PACKAGE__->register_method(
1823 method => 'reset_hold_batch',
1824 api_name => 'open-ils.circ.hold.reset.batch'
1827 sub reset_hold_batch {
1828 my($self, $conn, $auth, $hold_ids) = @_;
1830 my $e = new_editor(authtoken => $auth);
1831 return $e->event unless $e->checkauth;
1833 for my $hold_id ($hold_ids) {
1835 my $hold = $e->retrieve_action_hold_request(
1836 [$hold_id, {flesh => 1, flesh_fields => {ahr => ['usr']}}])
1837 or return $e->event;
1839 next unless $e->allowed('UPDATE_HOLD', $hold->usr->home_ou);
1840 _reset_hold($self, $e->requestor, $hold);
1848 my ($self, $reqr, $hold) = @_;
1850 my $e = new_editor(xact =>1, requestor => $reqr);
1852 $logger->info("reseting hold ".$hold->id);
1854 my $hid = $hold->id;
1856 if( $hold->capture_time and $hold->current_copy ) {
1858 my $copy = $e->retrieve_asset_copy($hold->current_copy)
1859 or return $e->die_event;
1861 if( $copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF ) {
1862 $logger->info("setting copy to status 'reshelving' on hold retarget");
1863 $copy->status(OILS_COPY_STATUS_RESHELVING);
1864 $copy->editor($e->requestor->id);
1865 $copy->edit_date('now');
1866 $e->update_asset_copy($copy) or return $e->die_event;
1868 } elsif( $copy->status == OILS_COPY_STATUS_IN_TRANSIT ) {
1870 # We don't want the copy to remain "in transit"
1871 $copy->status(OILS_COPY_STATUS_RESHELVING);
1872 $logger->warn("! reseting hold [$hid] that is in transit");
1873 my $transid = $e->search_action_hold_transit_copy({hold=>$hold->id},{idlist=>1})->[0];
1876 my $trans = $e->retrieve_action_transit_copy($transid);
1878 $logger->info("Aborting transit [$transid] on hold [$hid] reset...");
1879 my $evt = OpenILS::Application::Circ::Transit::__abort_transit($e, $trans, $copy, 1, 1);
1880 $logger->info("Transit abort completed with result $evt");
1881 unless ("$evt" eq 1) {
1890 $hold->clear_capture_time;
1891 $hold->clear_current_copy;
1892 $hold->clear_shelf_time;
1893 $hold->clear_shelf_expire_time;
1894 $hold->clear_current_shelf_lib;
1896 $e->update_action_hold_request($hold) or return $e->die_event;
1900 'open-ils.storage.action.hold_request.copy_targeter', undef, $hold->id );
1906 __PACKAGE__->register_method(
1907 method => 'fetch_open_title_holds',
1908 api_name => 'open-ils.circ.open_holds.retrieve',
1910 Returns a list ids of un-fulfilled holds for a given title id
1911 @param authtoken The login session key
1912 @param id the id of the item whose holds we want to retrieve
1913 @param type The hold type - M, T, I, V, C, F, R
1917 sub fetch_open_title_holds {
1918 my( $self, $conn, $auth, $id, $type, $org ) = @_;
1919 my $e = new_editor( authtoken => $auth );
1920 return $e->event unless $e->checkauth;
1923 $org ||= $e->requestor->ws_ou;
1925 # return $e->search_action_hold_request(
1926 # { target => $id, hold_type => $type, fulfillment_time => undef }, {idlist=>1});
1928 # XXX make me return IDs in the future ^--
1929 my $holds = $e->search_action_hold_request(
1932 cancel_time => undef,
1934 fulfillment_time => undef
1938 flesh_hold_transits($holds);
1943 sub flesh_hold_transits {
1945 for my $hold ( @$holds ) {
1947 $apputils->simplereq(
1949 "open-ils.cstore.direct.action.hold_transit_copy.search.atomic",
1950 { hold => $hold->id },
1951 { order_by => { ahtc => 'id desc' }, limit => 1 }
1957 sub flesh_hold_notices {
1958 my( $holds, $e ) = @_;
1959 $e ||= new_editor();
1961 for my $hold (@$holds) {
1962 my $notices = $e->search_action_hold_notification(
1964 { hold => $hold->id },
1965 { order_by => { anh => 'notify_time desc' } },
1970 $hold->notify_count(scalar(@$notices));
1972 my $n = $e->retrieve_action_hold_notification($$notices[0])
1973 or return $e->event;
1974 $hold->notify_time($n->notify_time);
1980 __PACKAGE__->register_method(
1981 method => 'fetch_captured_holds',
1982 api_name => 'open-ils.circ.captured_holds.on_shelf.retrieve',
1986 Returns a list of un-fulfilled holds (on the Holds Shelf) for a given title id
1987 @param authtoken The login session key
1988 @param org The org id of the location in question
1989 @param match_copy A specific copy to limit to
1993 __PACKAGE__->register_method(
1994 method => 'fetch_captured_holds',
1995 api_name => 'open-ils.circ.captured_holds.id_list.on_shelf.retrieve',
1999 Returns list ids of un-fulfilled holds (on the Holds Shelf) for a given title id
2000 @param authtoken The login session key
2001 @param org The org id of the location in question
2002 @param match_copy A specific copy to limit to
2006 __PACKAGE__->register_method(
2007 method => 'fetch_captured_holds',
2008 api_name => 'open-ils.circ.captured_holds.id_list.expired_on_shelf.retrieve',
2012 Returns list ids of shelf-expired un-fulfilled holds for a given title id
2013 @param authtoken The login session key
2014 @param org The org id of the location in question
2015 @param match_copy A specific copy to limit to
2020 sub fetch_captured_holds {
2021 my( $self, $conn, $auth, $org, $match_copy ) = @_;
2023 my $e = new_editor(authtoken => $auth);
2024 return $e->die_event unless $e->checkauth;
2025 return $e->die_event unless $e->allowed('VIEW_HOLD'); # XXX rely on editor perm
2027 $org ||= $e->requestor->ws_ou;
2029 my $current_copy = { '!=' => undef };
2030 $current_copy = { '=' => $match_copy } if $match_copy;
2033 select => { alhr => ['id'] },
2038 fkey => 'current_copy'
2043 '+acp' => { status => OILS_COPY_STATUS_ON_HOLDS_SHELF },
2045 capture_time => { "!=" => undef },
2046 current_copy => $current_copy,
2047 fulfillment_time => undef,
2048 current_shelf_lib => $org
2052 if($self->api_name =~ /expired/) {
2053 $query->{'where'}->{'+alhr'}->{'-or'} = {
2054 shelf_expire_time => { '<' => 'now'},
2055 cancel_time => { '!=' => undef },
2058 my $hold_ids = $e->json_query( $query );
2060 for my $hold_id (@$hold_ids) {
2061 if($self->api_name =~ /id_list/) {
2062 $conn->respond($hold_id->{id});
2066 $e->retrieve_action_hold_request([
2070 flesh_fields => {ahr => ['notifications', 'transit', 'notes']},
2071 order_by => {anh => 'notify_time desc'}
2081 __PACKAGE__->register_method(
2082 method => "print_expired_holds_stream",
2083 api_name => "open-ils.circ.captured_holds.expired.print.stream",
2087 sub print_expired_holds_stream {
2088 my ($self, $client, $auth, $params) = @_;
2090 # No need to check specific permissions: we're going to call another method
2091 # that will do that.
2092 my $e = new_editor("authtoken" => $auth);
2093 return $e->die_event unless $e->checkauth;
2095 delete($$params{org_id}) unless (int($$params{org_id}));
2096 delete($$params{limit}) unless (int($$params{limit}));
2097 delete($$params{offset}) unless (int($$params{offset}));
2098 delete($$params{chunk_size}) unless (int($$params{chunk_size}));
2099 delete($$params{chunk_size}) if ($$params{chunk_size} && $$params{chunk_size} > 50); # keep the size reasonable
2100 $$params{chunk_size} ||= 10;
2102 $$params{org_id} = (defined $$params{org_id}) ? $$params{org_id}: $e->requestor->ws_ou;
2104 my @hold_ids = $self->method_lookup(
2105 "open-ils.circ.captured_holds.id_list.expired_on_shelf.retrieve"
2106 )->run($auth, $params->{"org_id"});
2111 } elsif (defined $U->event_code($hold_ids[0])) {
2113 return $hold_ids[0];
2116 $logger->info("about to stream back up to " . scalar(@hold_ids) . " expired holds");
2119 my @hid_chunk = splice @hold_ids, 0, $params->{"chunk_size"};
2121 my $result_chunk = $e->json_query({
2123 "acp" => ["barcode"],
2125 first_given_name second_given_name family_name alias
2134 "field" => "id", "fkey" => "current_copy",
2137 "field" => "id", "fkey" => "call_number",
2140 "field" => "id", "fkey" => "record"
2144 "acpl" => {"field" => "id", "fkey" => "location"}
2147 "au" => {"field" => "id", "fkey" => "usr"}
2150 "where" => {"+ahr" => {"id" => \@hid_chunk}}
2151 }) or return $e->die_event;
2152 $client->respond($result_chunk);
2159 __PACKAGE__->register_method(
2160 method => "check_title_hold_batch",
2161 api_name => "open-ils.circ.title_hold.is_possible.batch",
2164 desc => '@see open-ils.circ.title_hold.is_possible.batch',
2166 { desc => 'Authentication token', type => 'string'},
2167 { desc => 'Array of Hash of named parameters', type => 'array'},
2170 desc => 'Array of response objects',
2176 sub check_title_hold_batch {
2177 my($self, $client, $authtoken, $param_list, $oargs) = @_;
2178 foreach (@$param_list) {
2179 my ($res) = $self->method_lookup('open-ils.circ.title_hold.is_possible')->run($authtoken, $_, $oargs);
2180 $client->respond($res);
2186 __PACKAGE__->register_method(
2187 method => "check_title_hold",
2188 api_name => "open-ils.circ.title_hold.is_possible",
2190 desc => 'Determines if a hold were to be placed by a given user, ' .
2191 'whether or not said hold would have any potential copies to fulfill it.' .
2192 'The named paramaters of the second argument include: ' .
2193 'patronid, titleid, volume_id, copy_id, mrid, depth, pickup_lib, hold_type, selection_ou. ' .
2194 'See perldoc ' . __PACKAGE__ . ' for more info on these fields.' ,
2196 { desc => 'Authentication token', type => 'string'},
2197 { desc => 'Hash of named parameters', type => 'object'},
2200 desc => 'List of new message IDs (empty if none)',
2206 =head3 check_title_hold (token, hash)
2208 The named fields in the hash are:
2210 patronid - ID of the hold recipient (required)
2211 depth - hold range depth (default 0)
2212 pickup_lib - destination for hold, fallback value for selection_ou
2213 selection_ou - ID of org_unit establishing hard and soft hold boundary settings
2214 issuanceid - ID of the issuance to be held, required for Issuance level hold
2215 partid - ID of the monograph part to be held, required for monograph part level hold
2216 titleid - ID (BRN) of the title to be held, required for Title level hold
2217 volume_id - required for Volume level hold
2218 copy_id - required for Copy level hold
2219 mrid - required for Meta-record level hold
2220 hold_type - T, C (or R or F), I, V or M for Title, Copy, Issuance, Volume or Meta-record (default "T")
2222 All key/value pairs are passed on to do_possibility_checks.
2226 # FIXME: better params checking. what other params are required, if any?
2227 # FIXME: 3 copies of values confusing: $x, $params->{x} and $params{x}
2228 # FIXME: for example, $depth gets a default value, but then $$params{depth} is still
2229 # used in conditionals, where it may be undefined, causing a warning.
2230 # FIXME: specify proper usage/interaction of selection_ou and pickup_lib
2232 sub check_title_hold {
2233 my( $self, $client, $authtoken, $params ) = @_;
2234 my $e = new_editor(authtoken=>$authtoken);
2235 return $e->event unless $e->checkauth;
2237 my %params = %$params;
2238 my $depth = $params{depth} || 0;
2239 my $selection_ou = $params{selection_ou} || $params{pickup_lib};
2240 my $oargs = $params{oargs} || {};
2242 if($oargs->{events}) {
2243 @{$oargs->{events}} = grep { $e->allowed($_ . '.override', $e->requestor->ws_ou); } @{$oargs->{events}};
2247 my $patron = $e->retrieve_actor_user($params{patronid})
2248 or return $e->event;
2250 if( $e->requestor->id ne $patron->id ) {
2251 return $e->event unless
2252 $e->allowed('VIEW_HOLD_PERMIT', $patron->home_ou);
2255 return OpenILS::Event->new('PATRON_BARRED') if $U->is_true($patron->barred);
2257 my $request_lib = $e->retrieve_actor_org_unit($e->requestor->ws_ou)
2258 or return $e->event;
2260 my $soft_boundary = $U->ou_ancestor_setting_value($selection_ou, OILS_SETTING_HOLD_SOFT_BOUNDARY);
2261 my $hard_boundary = $U->ou_ancestor_setting_value($selection_ou, OILS_SETTING_HOLD_HARD_BOUNDARY);
2264 my $return_depth = $hard_boundary; # default depth to return on success
2265 if(defined $soft_boundary and $depth < $soft_boundary) {
2266 # work up the tree and as soon as we find a potential copy, use that depth
2267 # also, make sure we don't go past the hard boundary if it exists
2269 # our min boundary is the greater of user-specified boundary or hard boundary
2270 my $min_depth = (defined $hard_boundary and $hard_boundary > $depth) ?
2271 $hard_boundary : $depth;
2273 my $depth = $soft_boundary;
2274 while($depth >= $min_depth) {
2275 $logger->info("performing hold possibility check with soft boundary $depth");
2276 @status = do_possibility_checks($e, $patron, $request_lib, $depth, %params);
2278 $return_depth = $depth;
2283 } elsif(defined $hard_boundary and $depth < $hard_boundary) {
2284 # there is no soft boundary, enforce the hard boundary if it exists
2285 $logger->info("performing hold possibility check with hard boundary $hard_boundary");
2286 @status = do_possibility_checks($e, $patron, $request_lib, $hard_boundary, %params);
2288 # no boundaries defined, fall back to user specifed boundary or no boundary
2289 $logger->info("performing hold possibility check with no boundary");
2290 @status = do_possibility_checks($e, $patron, $request_lib, $params{depth}, %params);
2293 my $place_unfillable = 0;
2294 $place_unfillable = 1 if $e->allowed('PLACE_UNFILLABLE_HOLD', $e->requestor->ws_ou);
2299 "depth" => $return_depth,
2300 "local_avail" => $status[1]
2302 } elsif ($status[2]) {
2303 my $n = scalar @{$status[2]};
2304 return {"success" => 0, "last_event" => $status[2]->[$n - 1], "age_protected_copy" => $status[3], "place_unfillable" => $place_unfillable};
2306 return {"success" => 0, "age_protected_copy" => $status[3], "place_unfillable" => $place_unfillable};
2312 sub do_possibility_checks {
2313 my($e, $patron, $request_lib, $depth, %params) = @_;
2315 my $issuanceid = $params{issuanceid} || "";
2316 my $partid = $params{partid} || "";
2317 my $titleid = $params{titleid} || "";
2318 my $volid = $params{volume_id};
2319 my $copyid = $params{copy_id};
2320 my $mrid = $params{mrid} || "";
2321 my $pickup_lib = $params{pickup_lib};
2322 my $hold_type = $params{hold_type} || 'T';
2323 my $selection_ou = $params{selection_ou} || $pickup_lib;
2324 my $holdable_formats = $params{holdable_formats};
2325 my $oargs = $params{oargs} || {};
2332 if( $hold_type eq OILS_HOLD_TYPE_FORCE || $hold_type eq OILS_HOLD_TYPE_RECALL || $hold_type eq OILS_HOLD_TYPE_COPY ) {
2334 return $e->event unless $copy = $e->retrieve_asset_copy($copyid);
2335 return $e->event unless $volume = $e->retrieve_asset_call_number($copy->call_number);
2336 return $e->event unless $title = $e->retrieve_biblio_record_entry($volume->record);
2338 return (1, 1, []) if( $hold_type eq OILS_HOLD_TYPE_RECALL || $hold_type eq OILS_HOLD_TYPE_FORCE);
2339 return verify_copy_for_hold(
2340 $patron, $e->requestor, $title, $copy, $pickup_lib, $request_lib, $oargs
2343 } elsif( $hold_type eq OILS_HOLD_TYPE_VOLUME ) {
2345 return $e->event unless $volume = $e->retrieve_asset_call_number($volid);
2346 return $e->event unless $title = $e->retrieve_biblio_record_entry($volume->record);
2348 return _check_volume_hold_is_possible(
2349 $volume, $title, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou, $oargs
2352 } elsif( $hold_type eq OILS_HOLD_TYPE_TITLE ) {
2354 return _check_title_hold_is_possible(
2355 $titleid, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou, undef, $oargs
2358 } elsif( $hold_type eq OILS_HOLD_TYPE_ISSUANCE ) {
2360 return _check_issuance_hold_is_possible(
2361 $issuanceid, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou, $oargs
2364 } elsif( $hold_type eq OILS_HOLD_TYPE_MONOPART ) {
2366 return _check_monopart_hold_is_possible(
2367 $partid, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou, $oargs
2370 } elsif( $hold_type eq OILS_HOLD_TYPE_METARECORD ) {
2372 my $maps = $e->search_metabib_metarecord_source_map({metarecord=>$mrid});
2373 my @recs = map { $_->source } @$maps;
2375 for my $rec (@recs) {
2376 @status = _check_title_hold_is_possible(
2377 $rec, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou, $holdable_formats, $oargs
2383 # else { Unrecognized hold_type ! } # FIXME: return error? or 0?
2387 sub create_ranged_org_filter {
2388 my($e, $selection_ou, $depth) = @_;
2390 # find the orgs from which this hold may be fulfilled,
2391 # based on the selection_ou and depth
2393 my $top_org = $e->search_actor_org_unit([
2394 {parent_ou => undef},
2395 {flesh=>1, flesh_fields=>{aou=>['ou_type']}}])->[0];
2398 return () if $depth == $top_org->ou_type->depth;
2400 my $org_list = $U->storagereq('open-ils.storage.actor.org_unit.descendants.atomic', $selection_ou, $depth);
2401 %org_filter = (circ_lib => []);
2402 push(@{$org_filter{circ_lib}}, $_->id) for @$org_list;
2404 $logger->info("hold org filter at depth $depth and selection_ou ".
2405 "$selection_ou created list of @{$org_filter{circ_lib}}");
2411 sub _check_title_hold_is_possible {
2412 my( $titleid, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou, $holdable_formats, $oargs ) = @_;
2414 my ($types, $formats, $lang);
2415 if (defined($holdable_formats)) {
2416 ($types, $formats, $lang) = split '-', $holdable_formats;
2419 my $e = new_editor();
2420 my %org_filter = create_ranged_org_filter($e, $selection_ou, $depth);
2422 # this monster will grab the id and circ_lib of all of the "holdable" copies for the given record
2423 my $copies = $e->json_query(
2425 select => { acp => ['id', 'circ_lib'] },
2430 fkey => 'call_number',
2434 filter => { id => $titleid },
2442 ( $types ? (item_type => [split '', $types]) : () ),
2443 ( $formats ? (item_form => [split '', $formats]) : () ),
2444 ( $lang ? (item_lang => $lang) : () )
2449 acpl => { field => 'id', filter => { holdable => 't'}, fkey => 'location' },
2450 ccs => { field => 'id', filter => { holdable => 't'}, fkey => 'status' },
2451 acpm => { field => 'target_copy', type => 'left' } # ignore part-linked copies
2455 '+acp' => { circulate => 't', deleted => 'f', holdable => 't', %org_filter },
2456 '+acpm' => { target_copy => undef } # ignore part-linked copies
2461 $logger->info("title possible found ".scalar(@$copies)." potential copies");
2465 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2466 "payload" => {"fail_part" => "no_ultimate_items"}
2471 # -----------------------------------------------------------------------
2472 # sort the copies into buckets based on their circ_lib proximity to
2473 # the patron's home_ou.
2474 # -----------------------------------------------------------------------
2476 my $home_org = $patron->home_ou;
2477 my $req_org = $request_lib->id;
2479 $logger->info("prox cache $home_org " . $prox_cache{$home_org});
2481 $prox_cache{$home_org} =
2482 $e->search_actor_org_unit_proximity({from_org => $home_org})
2483 unless $prox_cache{$home_org};
2484 my $home_prox = $prox_cache{$home_org};
2487 my %hash = map { ($_->to_org => $_->prox) } @$home_prox;
2488 push( @{$buckets{ $hash{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2490 my @keys = sort { $a <=> $b } keys %buckets;
2493 if( $home_org ne $req_org ) {
2494 # -----------------------------------------------------------------------
2495 # shove the copies close to the request_lib into the primary buckets
2496 # directly before the farthest away copies. That way, they are not
2497 # given priority, but they are checked before the farthest copies.
2498 # -----------------------------------------------------------------------
2499 $prox_cache{$req_org} =
2500 $e->search_actor_org_unit_proximity({from_org => $req_org})
2501 unless $prox_cache{$req_org};
2502 my $req_prox = $prox_cache{$req_org};
2505 my %hash2 = map { ($_->to_org => $_->prox) } @$req_prox;
2506 push( @{$buckets2{ $hash2{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2508 my $highest_key = $keys[@keys - 1]; # the farthest prox in the exising buckets
2509 my $new_key = $highest_key - 0.5; # right before the farthest prox
2510 my @keys2 = sort { $a <=> $b } keys %buckets2;
2511 for my $key (@keys2) {
2512 last if $key >= $highest_key;
2513 push( @{$buckets{$new_key}}, $_ ) for @{$buckets2{$key}};
2517 @keys = sort { $a <=> $b } keys %buckets;
2522 my $age_protect_only = 0;
2523 OUTER: for my $key (@keys) {
2524 my @cps = @{$buckets{$key}};
2526 $logger->info("looking at " . scalar(@{$buckets{$key}}). " copies in proximity bucket $key");
2528 for my $copyid (@cps) {
2530 next if $seen{$copyid};
2531 $seen{$copyid} = 1; # there could be dupes given the merged buckets
2532 my $copy = $e->retrieve_asset_copy($copyid);
2533 $logger->debug("looking at bucket_key=$key, copy $copyid : circ_lib = " . $copy->circ_lib);
2535 unless($title) { # grab the title if we don't already have it
2536 my $vol = $e->retrieve_asset_call_number(
2537 [ $copy->call_number, { flesh => 1, flesh_fields => { bre => ['fixed_fields'], acn => ['record'] } } ] );
2538 $title = $vol->record;
2541 @status = verify_copy_for_hold(
2542 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib, $oargs);
2544 $age_protect_only ||= $status[3];
2545 last OUTER if $status[0];
2549 $status[3] = $age_protect_only;
2553 sub _check_issuance_hold_is_possible {
2554 my( $issuanceid, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou, $oargs ) = @_;
2556 my $e = new_editor();
2557 my %org_filter = create_ranged_org_filter($e, $selection_ou, $depth);
2559 # this monster will grab the id and circ_lib of all of the "holdable" copies for the given record
2560 my $copies = $e->json_query(
2562 select => { acp => ['id', 'circ_lib'] },
2568 filter => { issuance => $issuanceid }
2570 acpl => { field => 'id', filter => { holdable => 't'}, fkey => 'location' },
2571 ccs => { field => 'id', filter => { holdable => 't'}, fkey => 'status' }
2575 '+acp' => { circulate => 't', deleted => 'f', holdable => 't', %org_filter }
2581 $logger->info("issuance possible found ".scalar(@$copies)." potential copies");
2585 $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_issuance_ok');
2586 $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2591 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2592 "payload" => {"fail_part" => "no_ultimate_items"}
2600 # -----------------------------------------------------------------------
2601 # sort the copies into buckets based on their circ_lib proximity to
2602 # the patron's home_ou.
2603 # -----------------------------------------------------------------------
2605 my $home_org = $patron->home_ou;
2606 my $req_org = $request_lib->id;
2608 $logger->info("prox cache $home_org " . $prox_cache{$home_org});
2610 $prox_cache{$home_org} =
2611 $e->search_actor_org_unit_proximity({from_org => $home_org})
2612 unless $prox_cache{$home_org};
2613 my $home_prox = $prox_cache{$home_org};
2616 my %hash = map { ($_->to_org => $_->prox) } @$home_prox;
2617 push( @{$buckets{ $hash{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2619 my @keys = sort { $a <=> $b } keys %buckets;
2622 if( $home_org ne $req_org ) {
2623 # -----------------------------------------------------------------------
2624 # shove the copies close to the request_lib into the primary buckets
2625 # directly before the farthest away copies. That way, they are not
2626 # given priority, but they are checked before the farthest copies.
2627 # -----------------------------------------------------------------------
2628 $prox_cache{$req_org} =
2629 $e->search_actor_org_unit_proximity({from_org => $req_org})
2630 unless $prox_cache{$req_org};
2631 my $req_prox = $prox_cache{$req_org};
2634 my %hash2 = map { ($_->to_org => $_->prox) } @$req_prox;
2635 push( @{$buckets2{ $hash2{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2637 my $highest_key = $keys[@keys - 1]; # the farthest prox in the exising buckets
2638 my $new_key = $highest_key - 0.5; # right before the farthest prox
2639 my @keys2 = sort { $a <=> $b } keys %buckets2;
2640 for my $key (@keys2) {
2641 last if $key >= $highest_key;
2642 push( @{$buckets{$new_key}}, $_ ) for @{$buckets2{$key}};
2646 @keys = sort { $a <=> $b } keys %buckets;
2651 my $age_protect_only = 0;
2652 OUTER: for my $key (@keys) {
2653 my @cps = @{$buckets{$key}};
2655 $logger->info("looking at " . scalar(@{$buckets{$key}}). " copies in proximity bucket $key");
2657 for my $copyid (@cps) {
2659 next if $seen{$copyid};
2660 $seen{$copyid} = 1; # there could be dupes given the merged buckets
2661 my $copy = $e->retrieve_asset_copy($copyid);
2662 $logger->debug("looking at bucket_key=$key, copy $copyid : circ_lib = " . $copy->circ_lib);
2664 unless($title) { # grab the title if we don't already have it
2665 my $vol = $e->retrieve_asset_call_number(
2666 [ $copy->call_number, { flesh => 1, flesh_fields => { bre => ['fixed_fields'], acn => ['record'] } } ] );
2667 $title = $vol->record;
2670 @status = verify_copy_for_hold(
2671 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib, $oargs);
2673 $age_protect_only ||= $status[3];
2674 last OUTER if $status[0];
2679 if (!defined($empty_ok)) {
2680 $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_issuance_ok');
2681 $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2684 return (1,0) if ($empty_ok);
2686 $status[3] = $age_protect_only;
2690 sub _check_monopart_hold_is_possible {
2691 my( $partid, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou, $oargs ) = @_;
2693 my $e = new_editor();
2694 my %org_filter = create_ranged_org_filter($e, $selection_ou, $depth);
2696 # this monster will grab the id and circ_lib of all of the "holdable" copies for the given record
2697 my $copies = $e->json_query(
2699 select => { acp => ['id', 'circ_lib'] },
2703 field => 'target_copy',
2705 filter => { part => $partid }
2707 acpl => { field => 'id', filter => { holdable => 't'}, fkey => 'location' },
2708 ccs => { field => 'id', filter => { holdable => 't'}, fkey => 'status' }
2712 '+acp' => { circulate => 't', deleted => 'f', holdable => 't', %org_filter }
2718 $logger->info("monopart possible found ".scalar(@$copies)." potential copies");
2722 $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_part_ok');
2723 $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2728 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2729 "payload" => {"fail_part" => "no_ultimate_items"}
2737 # -----------------------------------------------------------------------
2738 # sort the copies into buckets based on their circ_lib proximity to
2739 # the patron's home_ou.
2740 # -----------------------------------------------------------------------
2742 my $home_org = $patron->home_ou;
2743 my $req_org = $request_lib->id;
2745 $logger->info("prox cache $home_org " . $prox_cache{$home_org});
2747 $prox_cache{$home_org} =
2748 $e->search_actor_org_unit_proximity({from_org => $home_org})
2749 unless $prox_cache{$home_org};
2750 my $home_prox = $prox_cache{$home_org};
2753 my %hash = map { ($_->to_org => $_->prox) } @$home_prox;
2754 push( @{$buckets{ $hash{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2756 my @keys = sort { $a <=> $b } keys %buckets;
2759 if( $home_org ne $req_org ) {
2760 # -----------------------------------------------------------------------
2761 # shove the copies close to the request_lib into the primary buckets
2762 # directly before the farthest away copies. That way, they are not
2763 # given priority, but they are checked before the farthest copies.
2764 # -----------------------------------------------------------------------
2765 $prox_cache{$req_org} =
2766 $e->search_actor_org_unit_proximity({from_org => $req_org})
2767 unless $prox_cache{$req_org};
2768 my $req_prox = $prox_cache{$req_org};
2771 my %hash2 = map { ($_->to_org => $_->prox) } @$req_prox;
2772 push( @{$buckets2{ $hash2{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2774 my $highest_key = $keys[@keys - 1]; # the farthest prox in the exising buckets
2775 my $new_key = $highest_key - 0.5; # right before the farthest prox
2776 my @keys2 = sort { $a <=> $b } keys %buckets2;
2777 for my $key (@keys2) {
2778 last if $key >= $highest_key;
2779 push( @{$buckets{$new_key}}, $_ ) for @{$buckets2{$key}};
2783 @keys = sort { $a <=> $b } keys %buckets;
2788 my $age_protect_only = 0;
2789 OUTER: for my $key (@keys) {
2790 my @cps = @{$buckets{$key}};
2792 $logger->info("looking at " . scalar(@{$buckets{$key}}). " copies in proximity bucket $key");
2794 for my $copyid (@cps) {
2796 next if $seen{$copyid};
2797 $seen{$copyid} = 1; # there could be dupes given the merged buckets
2798 my $copy = $e->retrieve_asset_copy($copyid);
2799 $logger->debug("looking at bucket_key=$key, copy $copyid : circ_lib = " . $copy->circ_lib);
2801 unless($title) { # grab the title if we don't already have it
2802 my $vol = $e->retrieve_asset_call_number(
2803 [ $copy->call_number, { flesh => 1, flesh_fields => { bre => ['fixed_fields'], acn => ['record'] } } ] );
2804 $title = $vol->record;
2807 @status = verify_copy_for_hold(
2808 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib, $oargs);
2810 $age_protect_only ||= $status[3];
2811 last OUTER if $status[0];
2816 if (!defined($empty_ok)) {
2817 $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_part_ok');
2818 $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2821 return (1,0) if ($empty_ok);
2823 $status[3] = $age_protect_only;
2828 sub _check_volume_hold_is_possible {
2829 my( $vol, $title, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou, $oargs ) = @_;
2830 my %org_filter = create_ranged_org_filter(new_editor(), $selection_ou, $depth);
2831 my $copies = new_editor->search_asset_copy({call_number => $vol->id, %org_filter});
2832 $logger->info("checking possibility of volume hold for volume ".$vol->id);
2834 my $filter_copies = [];
2835 for my $copy (@$copies) {
2836 # ignore part-mapped copies for regular volume level holds
2837 push(@$filter_copies, $copy) unless
2838 new_editor->search_asset_copy_part_map({target_copy => $copy->id})->[0];
2840 $copies = $filter_copies;
2845 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2846 "payload" => {"fail_part" => "no_ultimate_items"}
2852 my $age_protect_only = 0;
2853 for my $copy ( @$copies ) {
2854 @status = verify_copy_for_hold(
2855 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib, $oargs );
2856 $age_protect_only ||= $status[3];
2859 $status[3] = $age_protect_only;
2865 sub verify_copy_for_hold {
2866 my( $patron, $requestor, $title, $copy, $pickup_lib, $request_lib, $oargs ) = @_;
2867 $oargs = {} unless defined $oargs;
2868 $logger->info("checking possibility of copy in hold request for copy ".$copy->id);
2869 my $permitted = OpenILS::Utils::PermitHold::permit_copy_hold(
2870 { patron => $patron,
2871 requestor => $requestor,
2874 title_descriptor => $title->fixed_fields, # this is fleshed into the title object
2875 pickup_lib => $pickup_lib,
2876 request_lib => $request_lib,
2878 show_event_list => 1
2883 my $permit_anyway = 0;
2884 foreach my $permit_event (@$permitted) {
2885 if (grep { $_ eq $permit_event->{textcode} } @{$oargs->{events}}) {
2890 $permitted = [] if $permit_anyway;
2892 my $age_protect_only = 0;
2893 if (@$permitted == 1 && @$permitted[0]->{textcode} eq 'ITEM_AGE_PROTECTED') {
2894 $age_protect_only = 1;
2898 (not scalar @$permitted), # true if permitted is an empty arrayref
2899 ( # XXX This test is of very dubious value; someone should figure
2900 # out what if anything is checking this value
2901 ($copy->circ_lib == $pickup_lib) and
2902 ($copy->status == OILS_COPY_STATUS_AVAILABLE)
2911 sub find_nearest_permitted_hold {
2914 my $editor = shift; # CStoreEditor object
2915 my $copy = shift; # copy to target
2916 my $user = shift; # staff
2917 my $check_only = shift; # do no updates, just see if the copy could fulfill a hold
2919 my $evt = OpenILS::Event->new('ACTION_HOLD_REQUEST_NOT_FOUND');
2921 my $bc = $copy->barcode;
2923 # find any existing holds that already target this copy
2924 my $old_holds = $editor->search_action_hold_request(
2925 { current_copy => $copy->id,
2926 cancel_time => undef,
2927 capture_time => undef
2931 my $hold_stall_interval = $U->ou_ancestor_setting_value($user->ws_ou, OILS_SETTING_HOLD_SOFT_STALL);
2933 $logger->info("circulator: searching for best hold at org ".$user->ws_ou.
2934 " and copy $bc with a hold stalling interval of ". ($hold_stall_interval || "(none)"));
2936 my $fifo = $U->ou_ancestor_setting_value($user->ws_ou, 'circ.holds_fifo');
2938 # search for what should be the best holds for this copy to fulfill
2939 my $best_holds = $U->storagereq(
2940 "open-ils.storage.action.hold_request.nearest_hold.atomic",
2941 $user->ws_ou, $copy->id, 100, $hold_stall_interval, $fifo );
2943 # Add any pre-targeted holds to the list too? Unless they are already there, anyway.
2945 for my $holdid (@$old_holds) {
2946 next unless $holdid;
2947 push(@$best_holds, $holdid) unless ( grep { ''.$holdid eq ''.$_ } @$best_holds );
2951 unless(@$best_holds) {
2952 $logger->info("circulator: no suitable holds found for copy $bc");
2953 return (undef, $evt);
2959 # for each potential hold, we have to run the permit script
2960 # to make sure the hold is actually permitted.
2963 for my $holdid (@$best_holds) {
2964 next unless $holdid;
2965 $logger->info("circulator: checking if hold $holdid is permitted for copy $bc");
2967 my $hold = $editor->retrieve_action_hold_request($holdid) or next;
2968 my $reqr = $reqr_cache{$hold->requestor} || $editor->retrieve_actor_user($hold->requestor);
2969 my $rlib = $org_cache{$hold->request_lib} || $editor->retrieve_actor_org_unit($hold->request_lib);
2971 $reqr_cache{$hold->requestor} = $reqr;
2972 $org_cache{$hold->request_lib} = $rlib;
2974 # see if this hold is permitted
2975 my $permitted = OpenILS::Utils::PermitHold::permit_copy_hold(
2976 { patron_id => $hold->usr,
2979 pickup_lib => $hold->pickup_lib,
2980 request_lib => $rlib,
2992 unless( $best_hold ) { # no "good" permitted holds were found
2994 $logger->info("circulator: no suitable holds found for copy $bc");
2995 return (undef, $evt);
2998 $logger->info("circulator: best hold ".$best_hold->id." found for copy $bc");
3000 # indicate a permitted hold was found
3001 return $best_hold if $check_only;
3003 # we've found a permitted hold. we need to "grab" the copy
3004 # to prevent re-targeted holds (next part) from re-grabbing the copy
3005 $best_hold->current_copy($copy->id);
3006 $editor->update_action_hold_request($best_hold)
3007 or return (undef, $editor->event);
3012 # re-target any other holds that already target this copy
3013 for my $old_hold (@$old_holds) {
3014 next if $old_hold->id eq $best_hold->id; # don't re-target the hold we want
3015 $logger->info("circulator: clearing current_copy and prev_check_time on hold ".
3016 $old_hold->id." after a better hold [".$best_hold->id."] was found");
3017 $old_hold->clear_current_copy;
3018 $old_hold->clear_prev_check_time;
3019 $editor->update_action_hold_request($old_hold)
3020 or return (undef, $editor->event);
3021 push(@retarget, $old_hold->id);
3024 return ($best_hold, undef, (@retarget) ? \@retarget : undef);
3032 __PACKAGE__->register_method(
3033 method => 'all_rec_holds',
3034 api_name => 'open-ils.circ.holds.retrieve_all_from_title',
3038 my( $self, $conn, $auth, $title_id, $args ) = @_;
3040 my $e = new_editor(authtoken=>$auth);
3041 $e->checkauth or return $e->event;
3042 $e->allowed('VIEW_HOLD') or return $e->event;
3045 $args->{fulfillment_time} = undef; # we don't want to see old fulfilled holds
3046 $args->{cancel_time} = undef;
3048 my $resp = { volume_holds => [], copy_holds => [], recall_holds => [], force_holds => [], metarecord_holds => [], part_holds => [], issuance_holds => [] };
3050 my $mr_map = $e->search_metabib_metarecord_source_map({source => $title_id})->[0];
3052 $resp->{metarecord_holds} = $e->search_action_hold_request(
3053 { hold_type => OILS_HOLD_TYPE_METARECORD,
3054 target => $mr_map->metarecord,
3060 $resp->{title_holds} = $e->search_action_hold_request(
3062 hold_type => OILS_HOLD_TYPE_TITLE,
3063 target => $title_id,
3067 my $parts = $e->search_biblio_monograph_part(
3073 $resp->{part_holds} = $e->search_action_hold_request(
3075 hold_type => OILS_HOLD_TYPE_MONOPART,
3081 my $subs = $e->search_serial_subscription(
3082 { record_entry => $title_id }, {idlist=>1});
3085 my $issuances = $e->search_serial_issuance(
3086 {subscription => $subs}, {idlist=>1}
3090 $resp->{issuance_holds} = $e->search_action_hold_request(
3092 hold_type => OILS_HOLD_TYPE_ISSUANCE,
3093 target => $issuances,
3100 my $vols = $e->search_asset_call_number(
3101 { record => $title_id, deleted => 'f' }, {idlist=>1});
3103 return $resp unless @$vols;
3105 $resp->{volume_holds} = $e->search_action_hold_request(
3107 hold_type => OILS_HOLD_TYPE_VOLUME,
3112 my $copies = $e->search_asset_copy(
3113 { call_number => $vols, deleted => 'f' }, {idlist=>1});
3115 return $resp unless @$copies;
3117 $resp->{copy_holds} = $e->search_action_hold_request(
3119 hold_type => OILS_HOLD_TYPE_COPY,
3124 $resp->{recall_holds} = $e->search_action_hold_request(
3126 hold_type => OILS_HOLD_TYPE_RECALL,
3131 $resp->{force_holds} = $e->search_action_hold_request(
3133 hold_type => OILS_HOLD_TYPE_FORCE,
3145 __PACKAGE__->register_method(
3146 method => 'uber_hold',
3148 api_name => 'open-ils.circ.hold.details.retrieve'
3152 my($self, $client, $auth, $hold_id, $args) = @_;
3153 my $e = new_editor(authtoken=>$auth);
3154 $e->checkauth or return $e->event;
3155 return uber_hold_impl($e, $hold_id, $args);
3158 __PACKAGE__->register_method(
3159 method => 'batch_uber_hold',
3162 api_name => 'open-ils.circ.hold.details.batch.retrieve'
3165 sub batch_uber_hold {
3166 my($self, $client, $auth, $hold_ids, $args) = @_;
3167 my $e = new_editor(authtoken=>$auth);
3168 $e->checkauth or return $e->event;
3169 $client->respond(uber_hold_impl($e, $_, $args)) for @$hold_ids;
3173 sub uber_hold_impl {
3174 my($e, $hold_id, $args) = @_;
3177 my $hold = $e->retrieve_action_hold_request(
3182 flesh_fields => { ahr => [ 'current_copy', 'usr', 'notes' ] }
3185 ) or return $e->event;
3187 if($hold->usr->id ne $e->requestor->id) {
3188 # A user is allowed to see his/her own holds
3189 $e->allowed('VIEW_HOLD') or return $e->event;
3190 $hold->notes( # filter out any non-staff ("private") notes
3191 [ grep { !$U->is_true($_->staff) } @{$hold->notes} ] );
3194 # caller is asking for own hold, but may not have permission to view staff notes
3195 unless($e->allowed('VIEW_HOLD')) {
3196 $hold->notes( # filter out any staff notes
3197 [ grep { $U->is_true($_->staff) } @{$hold->notes} ] );
3201 my $user = $hold->usr;
3202 $hold->usr($user->id);
3205 my( $mvr, $volume, $copy, $issuance, $part, $bre ) = find_hold_mvr($e, $hold, $args->{suppress_mvr});
3207 flesh_hold_notices([$hold], $e) unless $args->{suppress_notices};
3208 flesh_hold_transits([$hold]) unless $args->{suppress_transits};
3210 my $details = retrieve_hold_queue_status_impl($e, $hold);
3215 ($copy ? (copy => $copy) : ()),
3216 ($volume ? (volume => $volume) : ()),
3217 ($issuance ? (issuance => $issuance) : ()),
3218 ($part ? (part => $part) : ()),
3219 ($args->{include_bre} ? (bre => $bre) : ()),
3220 ($args->{suppress_mvr} ? () : (mvr => $mvr)),
3224 unless($args->{suppress_patron_details}) {
3225 my $card = $e->retrieve_actor_card($user->card) or return $e->event;
3226 $resp->{patron_first} = $user->first_given_name,
3227 $resp->{patron_last} = $user->family_name,
3228 $resp->{patron_barcode} = $card->barcode,
3229 $resp->{patron_alias} = $user->alias,
3237 # -----------------------------------------------------
3238 # Returns the MVR object that represents what the
3240 # -----------------------------------------------------
3242 my( $e, $hold, $no_mvr ) = @_;
3250 if( $hold->hold_type eq OILS_HOLD_TYPE_METARECORD ) {
3251 my $mr = $e->retrieve_metabib_metarecord($hold->target)
3252 or return $e->event;
3253 $tid = $mr->master_record;
3255 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_TITLE ) {
3256 $tid = $hold->target;
3258 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_VOLUME ) {
3259 $volume = $e->retrieve_asset_call_number($hold->target)
3260 or return $e->event;
3261 $tid = $volume->record;
3263 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_ISSUANCE ) {
3264 $issuance = $e->retrieve_serial_issuance([
3266 {flesh => 1, flesh_fields => {siss => [ qw/subscription/ ]}}
3267 ]) or return $e->event;
3269 $tid = $issuance->subscription->record_entry;
3271 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_MONOPART ) {
3272 $part = $e->retrieve_biblio_monograph_part([
3274 ]) or return $e->event;
3276 $tid = $part->record;
3278 } 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 ) {
3279 $copy = $e->retrieve_asset_copy([
3281 {flesh => 1, flesh_fields => {acp => ['call_number']}}
3282 ]) or return $e->event;
3284 $volume = $copy->call_number;
3285 $tid = $volume->record;
3288 if(!$copy and ref $hold->current_copy ) {
3289 $copy = $hold->current_copy;
3290 $hold->current_copy($copy->id);
3293 if(!$volume and $copy) {
3294 $volume = $e->retrieve_asset_call_number($copy->call_number);
3297 # TODO return metarcord mvr for M holds
3298 my $title = $e->retrieve_biblio_record_entry($tid);
3299 return ( ($no_mvr) ? undef : $U->record_to_mvr($title), $volume, $copy, $issuance, $part, $title );
3302 __PACKAGE__->register_method(
3303 method => 'clear_shelf_cache',
3304 api_name => 'open-ils.circ.hold.clear_shelf.get_cache',
3308 Returns the holds processed with the given cache key
3313 sub clear_shelf_cache {
3314 my($self, $client, $auth, $cache_key, $chunk_size) = @_;
3315 my $e = new_editor(authtoken => $auth, xact => 1);
3316 return $e->die_event unless $e->checkauth and $e->allowed('VIEW_HOLD');
3319 my $hold_data = OpenSRF::Utils::Cache->new('global')->get_cache($cache_key);
3322 $logger->info("no hold data found in cache"); # XXX TODO return event
3328 foreach (keys %$hold_data) {
3329 $maximum += scalar(@{ $hold_data->{$_} });
3331 $client->respond({"maximum" => $maximum, "progress" => 0});
3333 for my $action (sort keys %$hold_data) {
3334 while (@{$hold_data->{$action}}) {
3335 my @hid_chunk = splice @{$hold_data->{$action}}, 0, $chunk_size;
3337 my $result_chunk = $e->json_query({
3339 "acp" => ["barcode"],
3341 first_given_name second_given_name family_name alias
3344 "acnp" => [{column => "label", alias => "prefix"}],
3345 "acns" => [{column => "label", alias => "suffix"}],
3353 "field" => "id", "fkey" => "current_copy",
3356 "field" => "id", "fkey" => "call_number",
3359 "field" => "id", "fkey" => "record"
3362 "field" => "id", "fkey" => "prefix"
3365 "field" => "id", "fkey" => "suffix"
3369 "acpl" => {"field" => "id", "fkey" => "location"}
3372 "au" => {"field" => "id", "fkey" => "usr"}
3375 "where" => {"+ahr" => {"id" => \@hid_chunk}}
3376 }, {"substream" => 1}) or return $e->die_event;
3380 +{"action" => $action, "hold_details" => $_}
3391 __PACKAGE__->register_method(
3392 method => 'clear_shelf_process',
3394 api_name => 'open-ils.circ.hold.clear_shelf.process',
3397 1. Find all holds that have expired on the holds shelf
3399 3. If a clear-shelf status is configured, put targeted copies into this status
3400 4. Divide copies into 3 groups: items to transit, items to reshelve, and items
3401 that are needed for holds. No subsequent action is taken on the holds
3402 or items after grouping.
3407 sub clear_shelf_process {
3408 my($self, $client, $auth, $org_id, $match_copy) = @_;
3410 my $e = new_editor(authtoken=>$auth, xact => 1);
3411 $e->checkauth or return $e->die_event;
3412 my $cache = OpenSRF::Utils::Cache->new('global');
3414 $org_id ||= $e->requestor->ws_ou;
3415 $e->allowed('UPDATE_HOLD', $org_id) or return $e->die_event;
3417 my $copy_status = $U->ou_ancestor_setting_value($org_id, 'circ.holds.clear_shelf.copy_status');
3419 my @hold_ids = $self->method_lookup(
3420 "open-ils.circ.captured_holds.id_list.expired_on_shelf.retrieve"
3421 )->run($auth, $org_id, $match_copy);
3424 my @canceled_holds; # newly canceled holds
3425 my $chunk_size = 25; # chunked status updates
3427 for my $hold_id (@hold_ids) {
3429 $logger->info("Clear shelf processing hold $hold_id");
3431 my $hold = $e->retrieve_action_hold_request([
3434 flesh_fields => {ahr => ['current_copy']}
3438 if (!$hold->cancel_time) { # may be canceled but still on the holds shelf
3439 $hold->cancel_time('now');
3440 $hold->cancel_cause(2); # Hold Shelf expiration
3441 $e->update_action_hold_request($hold) or return $e->die_event;
3442 delete_hold_copy_maps($self, $e, $hold->id) and return $e->die_event;
3443 push(@canceled_holds, $hold_id);
3446 my $copy = $hold->current_copy;
3448 if($copy_status or $copy_status == 0) {
3449 # if a clear-shelf copy status is defined, update the copy
3450 $copy->status($copy_status);
3451 $copy->edit_date('now');
3452 $copy->editor($e->requestor->id);
3453 $e->update_asset_copy($copy) or return $e->die_event;
3456 push(@holds, $hold);
3457 $client->respond({maximum => scalar(@holds), progress => $counter}) if ( (++$counter % $chunk_size) == 0);
3468 for my $hold (@holds) {
3470 my $copy = $hold->current_copy;
3471 my ($alt_hold) = __PACKAGE__->find_nearest_permitted_hold($e, $copy, $e->requestor, 1);
3473 if($alt_hold and !$match_copy) {
3475 push(@{$cache_data{hold}}, $hold->id); # copy is needed for a hold
3477 } elsif($copy->circ_lib != $e->requestor->ws_ou) {
3479 push(@{$cache_data{transit}}, $hold->id); # copy needs to transit
3483 push(@{$cache_data{shelf}}, $hold->id); # copy needs to go back to the shelf
3487 my $cache_key = md5_hex(time . $$ . rand());
3488 $logger->info("clear_shelf_cache: storing under $cache_key");
3489 $cache->put_cache($cache_key, \%cache_data, 7200); # TODO: 2 hours. configurable?
3491 # tell the client we're done
3492 $client->respond_complete({cache_key => $cache_key});
3495 # fire off the hold cancelation trigger and wait for response so don't flood the service
3497 # refetch the holds to pick up the caclulated cancel_time,
3498 # which may be needed by Action/Trigger
3500 my $updated_holds = [];
3501 $updated_holds = $e->search_action_hold_request({id => \@canceled_holds}, {substream => 1}) if (@canceled_holds > 0);
3504 $U->create_events_for_hook(
3505 'hold_request.cancel.expire_holds_shelf',
3506 $_, $org_id, undef, undef, 1) for @$updated_holds;
3509 # tell the client we're done
3510 $client->respond_complete;
3514 __PACKAGE__->register_method(
3515 method => 'usr_hold_summary',
3516 api_name => 'open-ils.circ.holds.user_summary',
3518 Returns a summary of holds statuses for a given user
3522 sub usr_hold_summary {
3523 my($self, $conn, $auth, $user_id) = @_;
3525 my $e = new_editor(authtoken=>$auth);
3526 $e->checkauth or return $e->event;
3527 $e->allowed('VIEW_HOLD') or return $e->event;
3529 my $holds = $e->search_action_hold_request(
3532 fulfillment_time => undef,
3533 cancel_time => undef,
3537 my %summary = (1 => 0, 2 => 0, 3 => 0, 4 => 0);
3538 $summary{_hold_status($e, $_)} += 1 for @$holds;
3544 __PACKAGE__->register_method(
3545 method => 'hold_has_copy_at',
3546 api_name => 'open-ils.circ.hold.has_copy_at',
3549 'Returns the ID of the found copy and name of the shelving location if there is ' .
3550 'an available copy at the specified org unit. Returns empty hash otherwise. ' .
3551 'The anticipated use for this method is to determine whether an item is ' .
3552 'available at the library where the user is placing the hold (or, alternatively, '.
3553 'at the pickup library) to encourage bypassing the hold placement and just ' .
3554 'checking out the item.' ,
3556 { desc => 'Authentication Token', type => 'string' },
3557 { desc => 'Method Arguments. Options include: hold_type, hold_target, org_unit. '
3558 . 'hold_type is the hold type code (T, V, C, M, ...). '
3559 . 'hold_target is the identifier of the hold target object. '
3560 . 'org_unit is org unit ID.',
3565 desc => q/Result hash like { "copy" : copy_id, "location" : location_name }, empty hash on misses, event on error./,
3571 sub hold_has_copy_at {
3572 my($self, $conn, $auth, $args) = @_;
3574 my $e = new_editor(authtoken=>$auth);
3575 $e->checkauth or return $e->event;
3577 my $hold_type = $$args{hold_type};
3578 my $hold_target = $$args{hold_target};
3579 my $org_unit = $$args{org_unit};
3582 select => {acp => ['id'], acpl => ['name']},
3585 acpl => {field => 'id', filter => { holdable => 't'}, fkey => 'location'},
3586 ccs => {field => 'id', filter => { holdable => 't'}, fkey => 'status' }
3589 where => {'+acp' => { circulate => 't', deleted => 'f', holdable => 't', circ_lib => $org_unit, status => [0,7]}},
3593 if($hold_type eq 'C' or $hold_type eq 'F' or $hold_type eq 'R') {
3595 $query->{where}->{'+acp'}->{id} = $hold_target;
3597 } elsif($hold_type eq 'V') {
3599 $query->{where}->{'+acp'}->{call_number} = $hold_target;
3601 } elsif($hold_type eq 'P') {
3603 $query->{from}->{acp}->{acpm} = {
3604 field => 'target_copy',
3606 filter => {part => $hold_target},
3609 } elsif($hold_type eq 'I') {
3611 $query->{from}->{acp}->{sitem} = {
3614 filter => {issuance => $hold_target},
3617 } elsif($hold_type eq 'T') {
3619 $query->{from}->{acp}->{acn} = {
3621 fkey => 'call_number',
3625 filter => {id => $hold_target},
3633 $query->{from}->{acp}->{acn} = {
3635 fkey => 'call_number',
3644 filter => {metarecord => $hold_target},
3652 my $res = $e->json_query($query)->[0] or return {};
3653 return {copy => $res->{id}, location => $res->{name}} if $res;
3657 # returns true if the user already has an item checked out
3658 # that could be used to fulfill the requested hold.
3659 sub hold_item_is_checked_out {
3660 my($e, $user_id, $hold_type, $hold_target) = @_;
3663 select => {acp => ['id']},
3664 from => {acp => {}},
3668 in => { # copies for circs the user has checked out
3669 select => {circ => ['target_copy']},
3673 checkin_time => undef,
3675 {stop_fines => ["MAXFINES","LONGOVERDUE"]},
3676 {stop_fines => undef}
3686 if($hold_type eq 'C' || $hold_type eq 'R' || $hold_type eq 'F') {
3688 $query->{where}->{'+acp'}->{id}->{in}->{where}->{'target_copy'} = $hold_target;
3690 } elsif($hold_type eq 'V') {
3692 $query->{where}->{'+acp'}->{call_number} = $hold_target;
3694 } elsif($hold_type eq 'P') {
3696 $query->{from}->{acp}->{acpm} = {
3697 field => 'target_copy',
3699 filter => {part => $hold_target},
3702 } elsif($hold_type eq 'I') {
3704 $query->{from}->{acp}->{sitem} = {
3707 filter => {issuance => $hold_target},
3710 } elsif($hold_type eq 'T') {
3712 $query->{from}->{acp}->{acn} = {
3714 fkey => 'call_number',
3718 filter => {id => $hold_target},
3726 $query->{from}->{acp}->{acn} = {
3728 fkey => 'call_number',
3737 filter => {metarecord => $hold_target},
3745 return $e->json_query($query)->[0];
3748 __PACKAGE__->register_method(
3749 method => 'change_hold_title',
3750 api_name => 'open-ils.circ.hold.change_title',
3753 Updates all title level holds targeting the specified bibs to point a new bib./,
3755 { desc => 'Authentication Token', type => 'string' },
3756 { desc => 'New Target Bib Id', type => 'number' },
3757 { desc => 'Old Target Bib Ids', type => 'array' },
3759 return => { desc => '1 on success' }
3763 __PACKAGE__->register_method(
3764 method => 'change_hold_title_for_specific_holds',
3765 api_name => 'open-ils.circ.hold.change_title.specific_holds',
3768 Updates specified holds to target new bib./,
3770 { desc => 'Authentication Token', type => 'string' },
3771 { desc => 'New Target Bib Id', type => 'number' },
3772 { desc => 'Holds Ids for holds to update', type => 'array' },
3774 return => { desc => '1 on success' }
3779 sub change_hold_title {
3780 my( $self, $client, $auth, $new_bib_id, $bib_ids ) = @_;
3782 my $e = new_editor(authtoken=>$auth, xact=>1);
3783 return $e->die_event unless $e->checkauth;
3785 my $holds = $e->search_action_hold_request(
3788 cancel_time => undef,
3789 fulfillment_time => undef,
3795 flesh_fields => { ahr => ['usr'] }
3801 for my $hold (@$holds) {
3802 $e->allowed('UPDATE_HOLD', $hold->usr->home_ou) or return $e->die_event;
3803 $logger->info("Changing hold " . $hold->id . " target from " . $hold->target . " to $new_bib_id in title hold target change");
3804 $hold->target( $new_bib_id );
3805 $e->update_action_hold_request($hold) or return $e->die_event;
3810 _reset_hold($self, $e->requestor, $_) for @$holds;
3815 sub change_hold_title_for_specific_holds {
3816 my( $self, $client, $auth, $new_bib_id, $hold_ids ) = @_;
3818 my $e = new_editor(authtoken=>$auth, xact=>1);
3819 return $e->die_event unless $e->checkauth;
3821 my $holds = $e->search_action_hold_request(
3824 cancel_time => undef,
3825 fulfillment_time => undef,
3831 flesh_fields => { ahr => ['usr'] }
3837 for my $hold (@$holds) {
3838 $e->allowed('UPDATE_HOLD', $hold->usr->home_ou) or return $e->die_event;
3839 $logger->info("Changing hold " . $hold->id . " target from " . $hold->target . " to $new_bib_id in title hold target change");
3840 $hold->target( $new_bib_id );
3841 $e->update_action_hold_request($hold) or return $e->die_event;
3846 _reset_hold($self, $e->requestor, $_) for @$holds;
3851 __PACKAGE__->register_method(
3852 method => 'rec_hold_count',
3853 api_name => 'open-ils.circ.bre.holds.count',
3855 desc => q/Returns the total number of holds that target the
3856 selected bib record or its associated copies and call_numbers/,
3858 { desc => 'Bib ID', type => 'number' },
3860 return => {desc => 'Hold count', type => 'number'}
3864 __PACKAGE__->register_method(
3865 method => 'rec_hold_count',
3866 api_name => 'open-ils.circ.mmr.holds.count',
3868 desc => q/Returns the total number of holds that target the
3869 selected metarecord or its associated copies, call_numbers, and bib records/,
3871 { desc => 'Metarecord ID', type => 'number' },
3873 return => {desc => 'Hold count', type => 'number'}
3877 # XXX Need to add type I (and, soon, type P) holds to these counts
3878 sub rec_hold_count {
3879 my($self, $conn, $target_id) = @_;
3886 filter => {metarecord => $target_id}
3893 filter => { id => $target_id },
3898 if($self->api_name =~ /mmr/) {
3899 delete $bre_join->{bre}->{filter};
3900 $bre_join->{bre}->{join} = $mmr_join;
3906 fkey => 'call_number',
3912 select => {ahr => [{column => 'id', transform => 'count', alias => 'count'}]},
3916 cancel_time => undef,
3917 fulfillment_time => undef,
3921 hold_type => [qw/C F R/],
3924 select => {acp => ['id']},
3925 from => { acp => $cn_join }
3935 select => {acn => ['id']},
3936 from => {acn => $bre_join}
3944 target => $target_id
3952 if($self->api_name =~ /mmr/) {
3953 $query->{where}->{'+ahr'}->{'-or'}->[2] = {
3958 select => {bre => ['id']},
3959 from => {bre => $mmr_join}
3965 $query->{where}->{'+ahr'}->{'-or'}->[3] = {
3968 target => $target_id
3974 return new_editor()->json_query($query)->[0]->{count};