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";
43 __PACKAGE__->register_method(
44 method => "create_hold_batch",
45 api_name => "open-ils.circ.holds.create.batch",
48 desc => q/@see open-ils.circ.holds.create.batch/,
50 { desc => 'Authentication token', type => 'string' },
51 { desc => 'Array of hold objects', 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 => "create_hold_batch",
61 api_name => "open-ils.circ.holds.create.override.batch",
64 desc => '@see open-ils.circ.holds.create.batch',
69 sub create_hold_batch {
70 my( $self, $conn, $auth, $hold_list ) = @_;
71 (my $method = $self->api_name) =~ s/\.batch//og;
72 foreach (@$hold_list) {
73 my ($res) = $self->method_lookup($method)->run($auth, $_);
80 __PACKAGE__->register_method(
81 method => "create_hold",
82 api_name => "open-ils.circ.holds.create",
84 desc => "Create a new hold for an item. From a permissions perspective, " .
85 "the login session is used as the 'requestor' of the hold. " .
86 "The hold recipient is determined by the 'usr' setting within the hold object. " .
87 'First we verify the requestor has holds request permissions. ' .
88 'Then we verify that the recipient is allowed to make the given hold. ' .
89 'If not, we see if the requestor has "override" capabilities. If not, ' .
90 'a permission exception is returned. If permissions allow, we cycle ' .
91 'through the set of holds objects and create. ' .
92 'If the recipient does not have permission to place multiple holds ' .
93 'on a single title and said operation is attempted, a permission ' .
94 'exception is returned',
96 { desc => 'Authentication token', type => 'string' },
97 { desc => 'Hold object for hold to be created',
98 type => 'object', class => 'ahr' }
101 desc => 'New ahr ID on success, -1 on missing arg, event (or ref to array of events) on error(s)',
106 __PACKAGE__->register_method(
107 method => "create_hold",
108 api_name => "open-ils.circ.holds.create.override",
109 notes => '@see open-ils.circ.holds.create',
111 desc => "If the recipient is not allowed to receive the requested hold, " .
112 "call this method to attempt the override",
114 { desc => 'Authentication token', type => 'string' },
116 desc => 'Hold object for hold to be created',
117 type => 'object', class => 'ahr'
121 desc => 'New hold (ahr) ID on success, -1 on missing arg, event (or ref to array of events) on error(s)',
127 my( $self, $conn, $auth, $hold ) = @_;
128 return -1 unless $hold;
129 my $e = new_editor(authtoken=>$auth, xact=>1);
130 return $e->die_event unless $e->checkauth;
132 my $override = 1 if $self->api_name =~ /override/;
136 my $requestor = $e->requestor;
137 my $recipient = $requestor;
139 if( $requestor->id ne $hold->usr ) {
140 # Make sure the requestor is allowed to place holds for
141 # the recipient if they are not the same people
142 $recipient = $e->retrieve_actor_user($hold->usr) or return $e->die_event;
143 $e->allowed('REQUEST_HOLDS', $recipient->home_ou) or return $e->die_event;
146 # If the related org setting tells us to, block if patron privs have expired
147 my $expire_setting = $U->ou_ancestor_setting_value($recipient->home_ou, OILS_SETTING_BLOCK_HOLD_FOR_EXPIRED_PATRON);
148 if ($expire_setting) {
149 my $expire = DateTime::Format::ISO8601->new->parse_datetime(
150 cleanse_ISO8601($recipient->expire_date));
152 push( @events, OpenILS::Event->new(
153 'PATRON_ACCOUNT_EXPIRED',
154 "payload" => {"fail_part" => "actor.usr.privs_expired"}
155 )) if( CORE::time > $expire->epoch ) ;
158 # Now make sure the recipient is allowed to receive the specified hold
159 my $porg = $recipient->home_ou;
160 my $rid = $e->requestor->id;
161 my $t = $hold->hold_type;
163 # See if a duplicate hold already exists
165 usr => $recipient->id,
167 fulfillment_time => undef,
168 target => $hold->target,
169 cancel_time => undef,
172 $sargs->{holdable_formats} = $hold->holdable_formats if $t eq 'M';
174 my $existing = $e->search_action_hold_request($sargs);
175 push( @events, OpenILS::Event->new('HOLD_EXISTS')) if @$existing;
177 my $checked_out = hold_item_is_checked_out($e, $recipient->id, $hold->hold_type, $hold->target);
178 push( @events, OpenILS::Event->new('HOLD_ITEM_CHECKED_OUT')) if $checked_out;
180 if ( $t eq OILS_HOLD_TYPE_METARECORD ) {
181 return $e->die_event unless $e->allowed('MR_HOLDS', $porg);
182 } elsif ( $t eq OILS_HOLD_TYPE_TITLE ) {
183 return $e->die_event unless $e->allowed('TITLE_HOLDS', $porg);
184 } elsif ( $t eq OILS_HOLD_TYPE_VOLUME ) {
185 return $e->die_event unless $e->allowed('VOLUME_HOLDS', $porg);
186 } elsif ( $t eq OILS_HOLD_TYPE_MONOPART ) {
187 return $e->die_event unless $e->allowed('TITLE_HOLDS', $porg);
188 } elsif ( $t eq OILS_HOLD_TYPE_ISSUANCE ) {
189 return $e->die_event unless $e->allowed('ISSUANCE_HOLDS', $porg);
190 } elsif ( $t eq OILS_HOLD_TYPE_COPY ) {
191 return $e->die_event unless $e->allowed('COPY_HOLDS', $porg);
192 } elsif ( $t eq OILS_HOLD_TYPE_FORCE ) {
193 return $e->die_event unless $e->allowed('COPY_HOLDS', $porg);
194 } elsif ( $t eq OILS_HOLD_TYPE_RECALL ) {
195 return $e->die_event unless $e->allowed('COPY_HOLDS', $porg);
203 for my $evt (@events) {
205 my $name = $evt->{textcode};
206 return $e->die_event unless $e->allowed("$name.override", $porg);
210 # set the configured expire time
211 unless($hold->expire_time) {
212 my $interval = $U->ou_ancestor_setting_value($recipient->home_ou, OILS_SETTING_HOLD_EXPIRE);
214 my $date = DateTime->now->add(seconds => OpenSRF::Utils::interval_to_seconds($interval));
215 $hold->expire_time($U->epoch2ISO8601($date->epoch));
219 $hold->requestor($e->requestor->id);
220 $hold->request_lib($e->requestor->ws_ou);
221 $hold->selection_ou($hold->pickup_lib) unless $hold->selection_ou;
222 $hold = $e->create_action_hold_request($hold) or return $e->die_event;
226 $conn->respond_complete($hold->id);
229 'open-ils.storage.action.hold_request.copy_targeter',
230 undef, $hold->id ) unless $U->is_true($hold->frozen);
235 # makes sure that a user has permission to place the type of requested hold
236 # returns the Perm exception if not allowed, returns undef if all is well
237 sub _check_holds_perm {
238 my($type, $user_id, $org_id) = @_;
242 $evt = $apputils->check_perms($user_id, $org_id, "MR_HOLDS" );
243 } elsif ($type eq "T") {
244 $evt = $apputils->check_perms($user_id, $org_id, "TITLE_HOLDS" );
245 } elsif($type eq "V") {
246 $evt = $apputils->check_perms($user_id, $org_id, "VOLUME_HOLDS");
247 } elsif($type eq "C") {
248 $evt = $apputils->check_perms($user_id, $org_id, "COPY_HOLDS" );
255 # tests if the given user is allowed to place holds on another's behalf
256 sub _check_request_holds_perm {
259 if (my $evt = $apputils->check_perms(
260 $user_id, $org_id, "REQUEST_HOLDS")) {
265 my $ses_is_req_note = 'The login session is the requestor. If the requestor is different from the user, ' .
266 'then the requestor must have VIEW_HOLD permissions';
268 __PACKAGE__->register_method(
269 method => "retrieve_holds_by_id",
270 api_name => "open-ils.circ.holds.retrieve_by_id",
272 desc => "Retrieve the hold, with hold transits attached, for the specified ID. $ses_is_req_note",
274 { desc => 'Authentication token', type => 'string' },
275 { desc => 'Hold ID', type => 'number' }
278 desc => 'Hold object with transits attached, event on error',
284 sub retrieve_holds_by_id {
285 my($self, $client, $auth, $hold_id) = @_;
286 my $e = new_editor(authtoken=>$auth);
287 $e->checkauth or return $e->event;
288 $e->allowed('VIEW_HOLD') or return $e->event;
290 my $holds = $e->search_action_hold_request(
292 { id => $hold_id , fulfillment_time => undef },
294 order_by => { ahr => "request_time" },
296 flesh_fields => {ahr => ['notes']}
301 flesh_hold_transits($holds);
302 flesh_hold_notices($holds, $e);
307 __PACKAGE__->register_method(
308 method => "retrieve_holds",
309 api_name => "open-ils.circ.holds.retrieve",
311 desc => "Retrieves all the holds, with hold transits attached, for the specified user. $ses_is_req_note",
313 { desc => 'Authentication token', type => 'string' },
314 { desc => 'User ID', type => 'integer' }
317 desc => 'list of holds, event on error',
322 __PACKAGE__->register_method(
323 method => "retrieve_holds",
324 api_name => "open-ils.circ.holds.id_list.retrieve",
327 desc => "Retrieves all the hold IDs, for the specified user. $ses_is_req_note",
329 { desc => 'Authentication token', type => 'string' },
330 { desc => 'User ID', type => 'integer' }
333 desc => 'list of holds, event on error',
338 __PACKAGE__->register_method(
339 method => "retrieve_holds",
340 api_name => "open-ils.circ.holds.canceled.retrieve",
343 desc => "Retrieves all the cancelled holds for the specified user. $ses_is_req_note",
345 { desc => 'Authentication token', type => 'string' },
346 { desc => 'User ID', type => 'integer' }
349 desc => 'list of holds, event on error',
354 __PACKAGE__->register_method(
355 method => "retrieve_holds",
356 api_name => "open-ils.circ.holds.canceled.id_list.retrieve",
359 desc => "Retrieves list of cancelled hold IDs for the specified user. $ses_is_req_note",
361 { desc => 'Authentication token', type => 'string' },
362 { desc => 'User ID', type => 'integer' }
365 desc => 'list of hold IDs, event on error',
372 my ($self, $client, $auth, $user_id) = @_;
374 my $e = new_editor(authtoken=>$auth);
375 return $e->event unless $e->checkauth;
376 $user_id = $e->requestor->id unless defined $user_id;
378 my $notes_filter = {staff => 'f'};
379 my $user = $e->retrieve_actor_user($user_id) or return $e->event;
380 unless($user_id == $e->requestor->id) {
381 if($e->allowed('VIEW_HOLD', $user->home_ou)) {
382 $notes_filter = {staff => 't'}
384 my $allowed = OpenILS::Application::Actor::Friends->friend_perm_allowed(
385 $e, $user_id, $e->requestor->id, 'hold.view');
386 return $e->event unless $allowed;
389 # staff member looking at his/her own holds can see staff and non-staff notes
390 $notes_filter = {} if $e->allowed('VIEW_HOLD', $user->home_ou);
394 select => {ahr => ['id']},
396 where => {usr => $user_id, fulfillment_time => undef}
399 if($self->api_name =~ /canceled/) {
401 # Fetch the canceled holds
402 # order cancelled holds by cancel time, most recent first
404 $holds_query->{order_by} = [{class => 'ahr', field => 'cancel_time', direction => 'desc'}];
407 my $cancel_count = $U->ou_ancestor_setting_value(
408 $e->requestor->ws_ou, 'circ.holds.canceled.display_count', $e);
410 unless($cancel_count) {
411 $cancel_age = $U->ou_ancestor_setting_value(
412 $e->requestor->ws_ou, 'circ.holds.canceled.display_age', $e);
414 # if no settings are defined, default to last 10 cancelled holds
415 $cancel_count = 10 unless $cancel_age;
418 if($cancel_count) { # limit by count
420 $holds_query->{where}->{cancel_time} = {'!=' => undef};
421 $holds_query->{limit} = $cancel_count;
423 } elsif($cancel_age) { # limit by age
425 # find all of the canceled holds that were canceled within the configured time frame
426 my $date = DateTime->now->subtract(seconds => OpenSRF::Utils::interval_to_seconds($cancel_age));
427 $date = $U->epoch2ISO8601($date->epoch);
428 $holds_query->{where}->{cancel_time} = {'>=' => $date};
433 # order non-cancelled holds by ready-for-pickup, then active, followed by suspended
434 $holds_query->{order_by} = {ahr => ['shelf_time', 'frozen', 'request_time']};
435 $holds_query->{where}->{cancel_time} = undef;
438 my $hold_ids = $e->json_query($holds_query);
439 $hold_ids = [ map { $_->{id} } @$hold_ids ];
441 return $hold_ids if $self->api_name =~ /id_list/;
444 for my $hold_id ( @$hold_ids ) {
446 my $hold = $e->retrieve_action_hold_request($hold_id);
447 $hold->notes($e->search_action_hold_request_note({hold => $hold_id, %$notes_filter}));
450 $e->search_action_hold_transit_copy([
452 {order_by => {ahtc => 'source_send_time desc'}, limit => 1}])->[0]
462 __PACKAGE__->register_method(
463 method => 'user_hold_count',
464 api_name => 'open-ils.circ.hold.user.count'
467 sub user_hold_count {
468 my ( $self, $conn, $auth, $userid ) = @_;
469 my $e = new_editor( authtoken => $auth );
470 return $e->event unless $e->checkauth;
471 my $patron = $e->retrieve_actor_user($userid)
473 return $e->event unless $e->allowed( 'VIEW_HOLD', $patron->home_ou );
474 return __user_hold_count( $self, $e, $userid );
477 sub __user_hold_count {
478 my ( $self, $e, $userid ) = @_;
479 my $holds = $e->search_action_hold_request(
482 fulfillment_time => undef,
483 cancel_time => undef,
488 return scalar(@$holds);
492 __PACKAGE__->register_method(
493 method => "retrieve_holds_by_pickup_lib",
494 api_name => "open-ils.circ.holds.retrieve_by_pickup_lib",
496 "Retrieves all the holds, with hold transits attached, for the specified pickup_ou id."
499 __PACKAGE__->register_method(
500 method => "retrieve_holds_by_pickup_lib",
501 api_name => "open-ils.circ.holds.id_list.retrieve_by_pickup_lib",
502 notes => "Retrieves all the hold ids for the specified pickup_ou id. "
505 sub retrieve_holds_by_pickup_lib {
506 my ($self, $client, $login_session, $ou_id) = @_;
508 #FIXME -- put an appropriate permission check here
509 #my( $user, $target, $evt ) = $apputils->checkses_requestor(
510 # $login_session, $user_id, 'VIEW_HOLD' );
511 #return $evt if $evt;
513 my $holds = $apputils->simplereq(
515 "open-ils.cstore.direct.action.hold_request.search.atomic",
517 pickup_lib => $ou_id ,
518 fulfillment_time => undef,
521 { order_by => { ahr => "request_time" } }
524 if ( ! $self->api_name =~ /id_list/ ) {
525 flesh_hold_transits($holds);
529 return [ map { $_->id } @$holds ];
533 __PACKAGE__->register_method(
534 method => "uncancel_hold",
535 api_name => "open-ils.circ.hold.uncancel"
539 my($self, $client, $auth, $hold_id) = @_;
540 my $e = new_editor(authtoken=>$auth, xact=>1);
541 return $e->die_event unless $e->checkauth;
543 my $hold = $e->retrieve_action_hold_request($hold_id)
544 or return $e->die_event;
545 return $e->die_event unless $e->allowed('CANCEL_HOLDS', $hold->request_lib);
547 if ($hold->fulfillment_time) {
551 unless ($hold->cancel_time) {
556 # if configured to reset the request time, also reset the expire time
557 if($U->ou_ancestor_setting_value(
558 $hold->request_lib, 'circ.holds.uncancel.reset_request_time', $e)) {
560 $hold->request_time('now');
561 my $interval = $U->ou_ancestor_setting_value($hold->request_lib, OILS_SETTING_HOLD_EXPIRE);
563 my $date = DateTime->now->add(seconds => OpenSRF::Utils::interval_to_seconds($interval));
564 $hold->expire_time($U->epoch2ISO8601($date->epoch));
568 $hold->clear_cancel_time;
569 $hold->clear_cancel_cause;
570 $hold->clear_cancel_note;
571 $hold->clear_shelf_time;
572 $hold->clear_current_copy;
573 $hold->clear_capture_time;
574 $hold->clear_prev_check_time;
575 $hold->clear_shelf_expire_time;
577 $e->update_action_hold_request($hold) or return $e->die_event;
580 $U->storagereq('open-ils.storage.action.hold_request.copy_targeter', undef, $hold_id);
586 __PACKAGE__->register_method(
587 method => "cancel_hold",
588 api_name => "open-ils.circ.hold.cancel",
590 desc => 'Cancels the specified hold. The login session is the requestor. If the requestor is different from the usr field ' .
591 'on the hold, the requestor must have CANCEL_HOLDS permissions. The hold may be either the hold object or the hold id',
593 {desc => 'Authentication token', type => 'string'},
594 {desc => 'Hold ID', type => 'number'},
595 {desc => 'Cause of Cancellation', type => 'string'},
596 {desc => 'Note', type => 'string'}
599 desc => '1 on success, event on error'
605 my($self, $client, $auth, $holdid, $cause, $note) = @_;
607 my $e = new_editor(authtoken=>$auth, xact=>1);
608 return $e->die_event unless $e->checkauth;
610 my $hold = $e->retrieve_action_hold_request($holdid)
611 or return $e->die_event;
613 if( $e->requestor->id ne $hold->usr ) {
614 return $e->die_event unless $e->allowed('CANCEL_HOLDS');
617 if ($hold->cancel_time) {
622 # If the hold is captured, reset the copy status
623 if( $hold->capture_time and $hold->current_copy ) {
625 my $copy = $e->retrieve_asset_copy($hold->current_copy)
626 or return $e->die_event;
628 if( $copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF ) {
629 $logger->info("canceling hold $holdid whose item is on the holds shelf");
630 # $logger->info("setting copy to status 'reshelving' on hold cancel");
631 # $copy->status(OILS_COPY_STATUS_RESHELVING);
632 # $copy->editor($e->requestor->id);
633 # $copy->edit_date('now');
634 # $e->update_asset_copy($copy) or return $e->event;
636 } elsif( $copy->status == OILS_COPY_STATUS_IN_TRANSIT ) {
639 $logger->warn("! canceling hold [$hid] that is in transit");
640 my $transid = $e->search_action_hold_transit_copy({hold=>$hold->id},{idlist=>1})->[0];
643 my $trans = $e->retrieve_action_transit_copy($transid);
644 # Leave the transit alive, but set the copy status to
645 # reshelving so it will be properly reshelved when it gets back home
647 $trans->copy_status( OILS_COPY_STATUS_RESHELVING );
648 $e->update_action_transit_copy($trans) or return $e->die_event;
654 $hold->cancel_time('now');
655 $hold->cancel_cause($cause);
656 $hold->cancel_note($note);
657 $e->update_action_hold_request($hold)
658 or return $e->die_event;
660 delete_hold_copy_maps($self, $e, $hold->id);
664 $U->create_events_for_hook('hold_request.cancel.staff', $hold, $hold->pickup_lib)
665 if $e->requestor->id != $hold->usr;
670 sub delete_hold_copy_maps {
675 my $maps = $editor->search_action_hold_copy_map({hold=>$holdid});
677 $editor->delete_action_hold_copy_map($_)
678 or return $editor->event;
684 my $update_hold_desc = 'The login session is the requestor. ' .
685 'If the requestor is different from the usr field on the hold, ' .
686 'the requestor must have UPDATE_HOLDS permissions. ' .
687 'If supplying a hash of hold data, "id" must be included. ' .
688 'The hash is ignored if a hold object is supplied, ' .
689 'so you should supply only one kind of hold data argument.' ;
691 __PACKAGE__->register_method(
692 method => "update_hold",
693 api_name => "open-ils.circ.hold.update",
695 desc => "Updates the specified hold. $update_hold_desc",
697 {desc => 'Authentication token', type => 'string'},
698 {desc => 'Hold Object', type => 'object'},
699 {desc => 'Hash of values to be applied', type => 'object'}
702 desc => 'Hold ID on success, event on error',
708 __PACKAGE__->register_method(
709 method => "batch_update_hold",
710 api_name => "open-ils.circ.hold.update.batch",
713 desc => "Updates the specified hold(s). $update_hold_desc",
715 {desc => 'Authentication token', type => 'string'},
716 {desc => 'Array of hold obejcts', type => 'array' },
717 {desc => 'Array of hashes of values to be applied', type => 'array' }
720 desc => 'Hold ID per success, event per error',
726 my($self, $client, $auth, $hold, $values) = @_;
727 my $e = new_editor(authtoken=>$auth, xact=>1);
728 return $e->die_event unless $e->checkauth;
729 my $resp = update_hold_impl($self, $e, $hold, $values);
730 if ($U->event_code($resp)) {
734 $e->commit; # FIXME: update_hold_impl already does $e->commit ??
738 sub batch_update_hold {
739 my($self, $client, $auth, $hold_list, $values_list) = @_;
740 my $e = new_editor(authtoken=>$auth);
741 return $e->die_event unless $e->checkauth;
743 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.
745 $values_list ||= []; # FIXME: either move this above $count declaration, or send an event if both lists undef. Probably the latter.
747 # FIXME: Failing over to [] guarantees warnings for "Use of unitialized value" in update_hold_impl call.
748 # FIXME: We should be sure we only call update_hold_impl with hold object OR hash, not both.
750 for my $idx (0..$count-1) {
752 my $resp = update_hold_impl($self, $e, $hold_list->[$idx], $values_list->[$idx]);
753 $e->xact_commit unless $U->event_code($resp);
754 $client->respond($resp);
758 return undef; # not in the register return type, assuming we should always have at least one list populated
761 sub update_hold_impl {
762 my($self, $e, $hold, $values) = @_;
765 $hold = $e->retrieve_action_hold_request($values->{id})
766 or return $e->die_event;
767 for my $k (keys %$values) {
768 if (defined $values->{$k}) {
769 $hold->$k($values->{$k});
771 my $f = "clear_$k"; $hold->$f();
776 my $orig_hold = $e->retrieve_action_hold_request($hold->id)
777 or return $e->die_event;
779 # don't allow the user to be changed
780 return OpenILS::Event->new('BAD_PARAMS') if $hold->usr != $orig_hold->usr;
782 if($hold->usr ne $e->requestor->id) {
783 # if the hold is for a different user, make sure the
784 # requestor has the appropriate permissions
785 my $usr = $e->retrieve_actor_user($hold->usr)
786 or return $e->die_event;
787 return $e->die_event unless $e->allowed('UPDATE_HOLD', $usr->home_ou);
791 # --------------------------------------------------------------
792 # Changing the request time is like playing God
793 # --------------------------------------------------------------
794 if($hold->request_time ne $orig_hold->request_time) {
795 return OpenILS::Event->new('BAD_PARAMS') if $hold->fulfillment_time;
796 return $e->die_event unless $e->allowed('UPDATE_HOLD_REQUEST_TIME', $hold->pickup_lib);
799 # --------------------------------------------------------------
800 # if the hold is on the holds shelf or in transit and the pickup
801 # lib changes we need to create a new transit.
802 # --------------------------------------------------------------
803 if($orig_hold->pickup_lib ne $hold->pickup_lib) {
805 my $status = _hold_status($e, $hold);
807 if($status == 3) { # in transit
809 return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_TRANSIT', $orig_hold->pickup_lib);
810 return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_TRANSIT', $hold->pickup_lib);
812 $logger->info("updating pickup lib for hold ".$hold->id." while already in transit");
814 # update the transit to reflect the new pickup location
815 my $transit = $e->search_action_hold_transit_copy(
816 {hold=>$hold->id, dest_recv_time => undef})->[0]
817 or return $e->die_event;
819 $transit->prev_dest($transit->dest); # mark the previous destination on the transit
820 $transit->dest($hold->pickup_lib);
821 $e->update_action_hold_transit_copy($transit) or return $e->die_event;
823 } elsif($status == 4) { # on holds shelf
825 return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_HOLDS_SHELF', $orig_hold->pickup_lib);
826 return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_HOLDS_SHELF', $hold->pickup_lib);
828 $logger->info("updating pickup lib for hold ".$hold->id." while on holds shelf");
830 # create the new transit
831 my $evt = transit_hold($e, $orig_hold, $hold, $e->retrieve_asset_copy($hold->current_copy));
836 update_hold_if_frozen($self, $e, $hold, $orig_hold);
837 $e->update_action_hold_request($hold) or return $e->die_event;
840 # a change to mint-condition changes the set of potential copies, so retarget the hold;
841 if($U->is_true($hold->mint_condition) and !$U->is_true($orig_hold->mint_condition)) {
842 _reset_hold($self, $e->requestor, $hold)
849 my($e, $orig_hold, $hold, $copy) = @_;
850 my $src = $orig_hold->pickup_lib;
851 my $dest = $hold->pickup_lib;
853 $logger->info("putting hold into transit on pickup_lib update");
855 my $transit = Fieldmapper::action::hold_transit_copy->new;
856 $transit->hold($hold->id);
857 $transit->source($src);
858 $transit->dest($dest);
859 $transit->target_copy($copy->id);
860 $transit->source_send_time('now');
861 $transit->copy_status(OILS_COPY_STATUS_ON_HOLDS_SHELF);
863 $copy->status(OILS_COPY_STATUS_IN_TRANSIT);
864 $copy->editor($e->requestor->id);
865 $copy->edit_date('now');
867 $e->create_action_hold_transit_copy($transit) or return $e->die_event;
868 $e->update_asset_copy($copy) or return $e->die_event;
872 # if the hold is frozen, this method ensures that the hold is not "targeted",
873 # that is, it clears the current_copy and prev_check_time to essentiallly
874 # reset the hold. If it is being activated, it runs the targeter in the background
875 sub update_hold_if_frozen {
876 my($self, $e, $hold, $orig_hold) = @_;
877 return if $hold->capture_time;
879 if($U->is_true($hold->frozen)) {
880 $logger->info("clearing current_copy and check_time for frozen hold ".$hold->id);
881 $hold->clear_current_copy;
882 $hold->clear_prev_check_time;
885 if($U->is_true($orig_hold->frozen)) {
886 $logger->info("Running targeter on activated hold ".$hold->id);
887 $U->storagereq( 'open-ils.storage.action.hold_request.copy_targeter', undef, $hold->id );
892 __PACKAGE__->register_method(
893 method => "hold_note_CUD",
894 api_name => "open-ils.circ.hold_request.note.cud",
896 desc => 'Create, update or delete a hold request note. If the operator (from Auth. token) '
897 . 'is not the owner of the hold, the UPDATE_HOLD permission is required',
899 { desc => 'Authentication token', type => 'string' },
900 { desc => 'Hold note object', type => 'object' }
903 desc => 'Returns the note ID, event on error'
909 my($self, $conn, $auth, $note) = @_;
911 my $e = new_editor(authtoken => $auth, xact => 1);
912 return $e->die_event unless $e->checkauth;
914 my $hold = $e->retrieve_action_hold_request($note->hold)
915 or return $e->die_event;
917 if($hold->usr ne $e->requestor->id) {
918 my $usr = $e->retrieve_actor_user($hold->usr);
919 return $e->die_event unless $e->allowed('UPDATE_HOLD', $usr->home_ou);
920 $note->staff('t') if $note->isnew;
924 $e->create_action_hold_request_note($note) or return $e->die_event;
925 } elsif($note->ischanged) {
926 $e->update_action_hold_request_note($note) or return $e->die_event;
927 } elsif($note->isdeleted) {
928 $e->delete_action_hold_request_note($note) or return $e->die_event;
936 __PACKAGE__->register_method(
937 method => "retrieve_hold_status",
938 api_name => "open-ils.circ.hold.status.retrieve",
940 desc => 'Calculates the current status of the hold. The requestor must have ' .
941 'VIEW_HOLD permissions if the hold is for a user other than the requestor' ,
943 { desc => 'Hold ID', type => 'number' }
946 # type => 'number', # event sometimes
947 desc => <<'END_OF_DESC'
948 Returns event on error or:
949 -1 on error (for now),
950 1 for 'waiting for copy to become available',
951 2 for 'waiting for copy capture',
954 5 for 'hold-shelf-delay'
961 sub retrieve_hold_status {
962 my($self, $client, $auth, $hold_id) = @_;
964 my $e = new_editor(authtoken => $auth);
965 return $e->event unless $e->checkauth;
966 my $hold = $e->retrieve_action_hold_request($hold_id)
969 if( $e->requestor->id != $hold->usr ) {
970 return $e->event unless $e->allowed('VIEW_HOLD');
973 return _hold_status($e, $hold);
979 if ($hold->cancel_time) {
982 return 1 unless $hold->current_copy;
983 return 2 unless $hold->capture_time;
985 my $copy = $hold->current_copy;
986 unless( ref $copy ) {
987 $copy = $e->retrieve_asset_copy($hold->current_copy)
991 return 3 if $copy->status == OILS_COPY_STATUS_IN_TRANSIT;
993 if($copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF) {
995 my $hs_wait_interval = $U->ou_ancestor_setting_value($hold->pickup_lib, 'circ.hold_shelf_status_delay');
996 return 4 unless $hs_wait_interval;
998 # if a hold_shelf_status_delay interval is defined and start_time plus
999 # the interval is greater than now, consider the hold to be in the virtual
1000 # "on its way to the holds shelf" status. Return 5.
1002 my $transit = $e->search_action_hold_transit_copy({hold => $hold->id})->[0];
1003 my $start_time = ($transit) ? $transit->dest_recv_time : $hold->capture_time;
1004 $start_time = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($start_time));
1005 my $end_time = $start_time->add(seconds => OpenSRF::Utils::interval_to_seconds($hs_wait_interval));
1007 return 5 if $end_time > DateTime->now;
1016 __PACKAGE__->register_method(
1017 method => "retrieve_hold_queue_stats",
1018 api_name => "open-ils.circ.hold.queue_stats.retrieve",
1020 desc => 'Returns summary data about the state of a hold',
1022 { desc => 'Authentication token', type => 'string'},
1023 { desc => 'Hold ID', type => 'number'},
1026 desc => q/Summary object with keys:
1027 total_holds : total holds in queue
1028 queue_position : current queue position
1029 potential_copies : number of potential copies for this hold
1030 estimated_wait : estimated wait time in days
1031 status : hold status
1032 -1 => error or unexpected state,
1033 1 => 'waiting for copy to become available',
1034 2 => 'waiting for copy capture',
1037 5 => 'hold-shelf-delay'
1044 sub retrieve_hold_queue_stats {
1045 my($self, $conn, $auth, $hold_id) = @_;
1046 my $e = new_editor(authtoken => $auth);
1047 return $e->event unless $e->checkauth;
1048 my $hold = $e->retrieve_action_hold_request($hold_id) or return $e->event;
1049 if($e->requestor->id != $hold->usr) {
1050 return $e->event unless $e->allowed('VIEW_HOLD');
1052 return retrieve_hold_queue_status_impl($e, $hold);
1055 sub retrieve_hold_queue_status_impl {
1059 # The holds queue is defined as the distinct set of holds that share at
1060 # least one potential copy with the context hold, plus any holds that
1061 # share the same hold type and target. The latter part exists to
1062 # accomodate holds that currently have no potential copies
1063 my $q_holds = $e->json_query({
1065 # fetch cut_in_line and request_time since they're in the order_by
1066 # and we're asking for distinct values
1067 select => {ahr => ['id', 'cut_in_line', 'request_time']},
1074 'field' => 'target_copy',
1075 'fkey' => 'target_copy'
1084 "field" => "cut_in_line",
1085 "transform" => "coalesce",
1087 "direction" => "desc"
1089 { "class" => "ahr", "field" => "request_time" }
1093 '+ahcm2' => { hold => $hold->id }
1097 if (!@$q_holds) { # none? maybe we don't have a map ...
1098 $q_holds = $e->json_query({
1099 select => {ahr => ['id', 'cut_in_line', 'request_time']},
1104 "field" => "cut_in_line",
1105 "transform" => "coalesce",
1107 "direction" => "desc"
1109 { "class" => "ahr", "field" => "request_time" }
1112 hold_type => $hold->hold_type,
1113 target => $hold->target
1120 for my $h (@$q_holds) {
1121 last if $h->{id} == $hold->id;
1125 my $hold_data = $e->json_query({
1127 acp => [ {column => 'id', transform => 'count', aggregate => 1, alias => 'count'} ],
1128 ccm => [ {column =>'avg_wait_time'} ]
1134 ccm => {type => 'left'}
1139 where => {'+ahcm' => {hold => $hold->id} }
1142 my $user_org = $e->json_query({select => {au => ['home_ou']}, from => 'au', where => {id => $hold->usr}})->[0]->{home_ou};
1144 my $default_wait = $U->ou_ancestor_setting_value($user_org, OILS_SETTING_HOLD_ESIMATE_WAIT_INTERVAL);
1145 my $min_wait = $U->ou_ancestor_setting_value($user_org, 'circ.holds.min_estimated_wait_interval');
1146 $min_wait = OpenSRF::Utils::interval_to_seconds($min_wait || '0 seconds');
1147 $default_wait ||= '0 seconds';
1149 # Estimated wait time is the average wait time across the set
1150 # of potential copies, divided by the number of potential copies
1151 # times the queue position.
1153 my $combined_secs = 0;
1154 my $num_potentials = 0;
1156 for my $wait_data (@$hold_data) {
1157 my $count += $wait_data->{count};
1158 $combined_secs += $count *
1159 OpenSRF::Utils::interval_to_seconds($wait_data->{avg_wait_time} || $default_wait);
1160 $num_potentials += $count;
1163 my $estimated_wait = -1;
1165 if($num_potentials) {
1166 my $avg_wait = $combined_secs / $num_potentials;
1167 $estimated_wait = $qpos * ($avg_wait / $num_potentials);
1168 $estimated_wait = $min_wait if $estimated_wait < $min_wait and $estimated_wait != -1;
1172 total_holds => scalar(@$q_holds),
1173 queue_position => $qpos,
1174 potential_copies => $num_potentials,
1175 status => _hold_status( $e, $hold ),
1176 estimated_wait => int($estimated_wait)
1181 sub fetch_open_hold_by_current_copy {
1184 my $hold = $apputils->simplereq(
1186 'open-ils.cstore.direct.action.hold_request.search.atomic',
1187 { current_copy => $copyid , cancel_time => undef, fulfillment_time => undef });
1188 return $hold->[0] if ref($hold);
1192 sub fetch_related_holds {
1195 return $apputils->simplereq(
1197 'open-ils.cstore.direct.action.hold_request.search.atomic',
1198 { current_copy => $copyid , cancel_time => undef, fulfillment_time => undef });
1202 __PACKAGE__->register_method(
1203 method => "hold_pull_list",
1204 api_name => "open-ils.circ.hold_pull_list.retrieve",
1206 desc => 'Returns (reference to) a list of holds that need to be "pulled" by a given location. ' .
1207 'The location is determined by the login session.',
1209 { desc => 'Limit (optional)', type => 'number'},
1210 { desc => 'Offset (optional)', type => 'number'},
1213 desc => 'reference to a list of holds, or event on failure',
1218 __PACKAGE__->register_method(
1219 method => "hold_pull_list",
1220 api_name => "open-ils.circ.hold_pull_list.id_list.retrieve",
1222 desc => 'Returns (reference to) a list of holds IDs that need to be "pulled" by a given location. ' .
1223 'The location is determined by the login session.',
1225 { desc => 'Limit (optional)', type => 'number'},
1226 { desc => 'Offset (optional)', type => 'number'},
1229 desc => 'reference to a list of holds, or event on failure',
1234 __PACKAGE__->register_method(
1235 method => "hold_pull_list",
1236 api_name => "open-ils.circ.hold_pull_list.retrieve.count",
1238 desc => 'Returns a count of holds that need to be "pulled" by a given location. ' .
1239 'The location is determined by the login session.',
1241 { desc => 'Limit (optional)', type => 'number'},
1242 { desc => 'Offset (optional)', type => 'number'},
1245 desc => 'Holds count (integer), or event on failure',
1252 sub hold_pull_list {
1253 my( $self, $conn, $authtoken, $limit, $offset ) = @_;
1254 my( $reqr, $evt ) = $U->checkses($authtoken);
1255 return $evt if $evt;
1257 my $org = $reqr->ws_ou || $reqr->home_ou;
1258 # the perm locaiton shouldn't really matter here since holds
1259 # will exist all over and VIEW_HOLDS should be universal
1260 $evt = $U->check_perms($reqr->id, $org, 'VIEW_HOLD');
1261 return $evt if $evt;
1263 if($self->api_name =~ /count/) {
1265 my $count = $U->storagereq(
1266 'open-ils.storage.direct.action.hold_request.pull_list.current_copy_circ_lib.status_filtered.count',
1267 $org, $limit, $offset );
1269 $logger->info("Grabbing pull list for org unit $org with $count items");
1272 } elsif( $self->api_name =~ /id_list/ ) {
1273 return $U->storagereq(
1274 'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib.status_filtered.atomic',
1275 $org, $limit, $offset );
1278 return $U->storagereq(
1279 'open-ils.storage.direct.action.hold_request.pull_list.search.current_copy_circ_lib.status_filtered.atomic',
1280 $org, $limit, $offset );
1284 __PACKAGE__->register_method(
1285 method => "print_hold_pull_list",
1286 api_name => "open-ils.circ.hold_pull_list.print",
1288 desc => 'Returns an HTML-formatted holds pull list',
1290 { desc => 'Authtoken', type => 'string'},
1291 { desc => 'Org unit ID. Optional, defaults to workstation org unit', type => 'number'},
1294 desc => 'HTML string',
1300 sub print_hold_pull_list {
1301 my($self, $client, $auth, $org_id) = @_;
1303 my $e = new_editor(authtoken=>$auth);
1304 return $e->event unless $e->checkauth;
1306 $org_id = (defined $org_id) ? $org_id : $e->requestor->ws_ou;
1307 return $e->event unless $e->allowed('VIEW_HOLD', $org_id);
1309 my $hold_ids = $U->storagereq(
1310 'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib.status_filtered.atomic',
1313 return undef unless @$hold_ids;
1315 $client->status(new OpenSRF::DomainObject::oilsContinueStatus);
1317 # Holds will /NOT/ be in order after this ...
1318 my $holds = $e->search_action_hold_request({id => $hold_ids}, {substream => 1});
1319 $client->status(new OpenSRF::DomainObject::oilsContinueStatus);
1321 # ... so we must resort.
1322 my $hold_map = +{map { $_->id => $_ } @$holds};
1323 my $sorted_holds = [];
1324 push @$sorted_holds, $hold_map->{$_} foreach @$hold_ids;
1326 return $U->fire_object_event(
1327 undef, "ahr.format.pull_list", $sorted_holds,
1328 $org_id, undef, undef, $client
1333 __PACKAGE__->register_method(
1334 method => "print_hold_pull_list_stream",
1336 api_name => "open-ils.circ.hold_pull_list.print.stream",
1338 desc => 'Returns a stream of fleshed holds',
1340 { desc => 'Authtoken', type => 'string'},
1341 { desc => 'Hash of optional param: Org unit ID (defaults to workstation org unit), limit, offset, sort (array of: acplo.position, call_number, request_time)',
1346 desc => 'A stream of fleshed holds',
1352 sub print_hold_pull_list_stream {
1353 my($self, $client, $auth, $params) = @_;
1355 my $e = new_editor(authtoken=>$auth);
1356 return $e->die_event unless $e->checkauth;
1358 delete($$params{org_id}) unless (int($$params{org_id}));
1359 delete($$params{limit}) unless (int($$params{limit}));
1360 delete($$params{offset}) unless (int($$params{offset}));
1361 delete($$params{chunk_size}) unless (int($$params{chunk_size}));
1362 delete($$params{chunk_size}) if ($$params{chunk_size} && $$params{chunk_size} > 50); # keep the size reasonable
1363 $$params{chunk_size} ||= 10;
1365 $$params{org_id} = (defined $$params{org_id}) ? $$params{org_id}: $e->requestor->ws_ou;
1366 return $e->die_event unless $e->allowed('VIEW_HOLD', $$params{org_id });
1369 if ($$params{sort} && @{ $$params{sort} }) {
1370 for my $s (@{ $$params{sort} }) {
1371 if ($s eq 'acplo.position') {
1373 "class" => "acplo", "field" => "position",
1374 "transform" => "coalesce", "params" => [999]
1376 } elsif ($s eq 'call_number') {
1377 push @$sort, {"class" => "acn", "field" => "label"};
1378 } elsif ($s eq 'request_time') {
1379 push @$sort, {"class" => "ahr", "field" => "request_time"};
1383 push @$sort, {"class" => "ahr", "field" => "request_time"};
1386 my $holds_ids = $e->json_query(
1388 "select" => {"ahr" => ["id"]},
1393 "fkey" => "current_copy",
1395 "circ_lib" => $$params{org_id}, "status" => [0,7]
1400 "fkey" => "call_number"
1404 "fkey" => "circ_lib",
1407 "location" => {"=" => {"+acp" => "location"}}
1416 "capture_time" => undef,
1417 "cancel_time" => undef,
1419 {"expire_time" => undef },
1420 {"expire_time" => {">" => "now"}}
1424 (@$sort ? (order_by => $sort) : ()),
1425 ($$params{limit} ? (limit => $$params{limit}) : ()),
1426 ($$params{offset} ? (offset => $$params{offset}) : ())
1427 }, {"substream" => 1}
1428 ) or return $e->die_event;
1430 $logger->info("about to stream back " . scalar(@$holds_ids) . " holds");
1433 for my $hid (@$holds_ids) {
1434 push @chunk, $e->retrieve_action_hold_request([
1438 "ahr" => ["usr", "current_copy"],
1440 "acp" => ["location", "call_number"],
1446 if (@chunk >= $$params{chunk_size}) {
1447 $client->respond( \@chunk );
1451 $client->respond_complete( \@chunk ) if (@chunk);
1458 __PACKAGE__->register_method(
1459 method => 'fetch_hold_notify',
1460 api_name => 'open-ils.circ.hold_notification.retrieve_by_hold',
1463 Returns a list of hold notification objects based on hold id.
1464 @param authtoken The loggin session key
1465 @param holdid The id of the hold whose notifications we want to retrieve
1466 @return An array of hold notification objects, event on error.
1470 sub fetch_hold_notify {
1471 my( $self, $conn, $authtoken, $holdid ) = @_;
1472 my( $requestor, $evt ) = $U->checkses($authtoken);
1473 return $evt if $evt;
1474 my ($hold, $patron);
1475 ($hold, $evt) = $U->fetch_hold($holdid);
1476 return $evt if $evt;
1477 ($patron, $evt) = $U->fetch_user($hold->usr);
1478 return $evt if $evt;
1480 $evt = $U->check_perms($requestor->id, $patron->home_ou, 'VIEW_HOLD_NOTIFICATION');
1481 return $evt if $evt;
1483 $logger->info("User ".$requestor->id." fetching hold notifications for hold $holdid");
1484 return $U->cstorereq(
1485 'open-ils.cstore.direct.action.hold_notification.search.atomic', {hold => $holdid} );
1489 __PACKAGE__->register_method(
1490 method => 'create_hold_notify',
1491 api_name => 'open-ils.circ.hold_notification.create',
1493 Creates a new hold notification object
1494 @param authtoken The login session key
1495 @param notification The hold notification object to create
1496 @return ID of the new object on success, Event on error
1500 sub create_hold_notify {
1501 my( $self, $conn, $auth, $note ) = @_;
1502 my $e = new_editor(authtoken=>$auth, xact=>1);
1503 return $e->die_event unless $e->checkauth;
1505 my $hold = $e->retrieve_action_hold_request($note->hold)
1506 or return $e->die_event;
1507 my $patron = $e->retrieve_actor_user($hold->usr)
1508 or return $e->die_event;
1510 return $e->die_event unless
1511 $e->allowed('CREATE_HOLD_NOTIFICATION', $patron->home_ou);
1513 $note->notify_staff($e->requestor->id);
1514 $e->create_action_hold_notification($note) or return $e->die_event;
1519 __PACKAGE__->register_method(
1520 method => 'create_hold_note',
1521 api_name => 'open-ils.circ.hold_note.create',
1523 Creates a new hold request note object
1524 @param authtoken The login session key
1525 @param note The hold note object to create
1526 @return ID of the new object on success, Event on error
1530 sub create_hold_note {
1531 my( $self, $conn, $auth, $note ) = @_;
1532 my $e = new_editor(authtoken=>$auth, xact=>1);
1533 return $e->die_event unless $e->checkauth;
1535 my $hold = $e->retrieve_action_hold_request($note->hold)
1536 or return $e->die_event;
1537 my $patron = $e->retrieve_actor_user($hold->usr)
1538 or return $e->die_event;
1540 return $e->die_event unless
1541 $e->allowed('UPDATE_HOLD', $patron->home_ou); # FIXME: Using permcrud perm listed in fm_IDL.xml for ahrn. Probably want something more specific
1543 $e->create_action_hold_request_note($note) or return $e->die_event;
1548 __PACKAGE__->register_method(
1549 method => 'reset_hold',
1550 api_name => 'open-ils.circ.hold.reset',
1552 Un-captures and un-targets a hold, essentially returning
1553 it to the state it was in directly after it was placed,
1554 then attempts to re-target the hold
1555 @param authtoken The login session key
1556 @param holdid The id of the hold
1562 my( $self, $conn, $auth, $holdid ) = @_;
1564 my ($hold, $evt) = $U->fetch_hold($holdid);
1565 return $evt if $evt;
1566 ($reqr, $evt) = $U->checksesperm($auth, 'UPDATE_HOLD');
1567 return $evt if $evt;
1568 $evt = _reset_hold($self, $reqr, $hold);
1569 return $evt if $evt;
1574 __PACKAGE__->register_method(
1575 method => 'reset_hold_batch',
1576 api_name => 'open-ils.circ.hold.reset.batch'
1579 sub reset_hold_batch {
1580 my($self, $conn, $auth, $hold_ids) = @_;
1582 my $e = new_editor(authtoken => $auth);
1583 return $e->event unless $e->checkauth;
1585 for my $hold_id ($hold_ids) {
1587 my $hold = $e->retrieve_action_hold_request(
1588 [$hold_id, {flesh => 1, flesh_fields => {ahr => ['usr']}}])
1589 or return $e->event;
1591 next unless $e->allowed('UPDATE_HOLD', $hold->usr->home_ou);
1592 _reset_hold($self, $e->requestor, $hold);
1600 my ($self, $reqr, $hold) = @_;
1602 my $e = new_editor(xact =>1, requestor => $reqr);
1604 $logger->info("reseting hold ".$hold->id);
1606 my $hid = $hold->id;
1608 if( $hold->capture_time and $hold->current_copy ) {
1610 my $copy = $e->retrieve_asset_copy($hold->current_copy)
1611 or return $e->die_event;
1613 if( $copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF ) {
1614 $logger->info("setting copy to status 'reshelving' on hold retarget");
1615 $copy->status(OILS_COPY_STATUS_RESHELVING);
1616 $copy->editor($e->requestor->id);
1617 $copy->edit_date('now');
1618 $e->update_asset_copy($copy) or return $e->die_event;
1620 } elsif( $copy->status == OILS_COPY_STATUS_IN_TRANSIT ) {
1622 # We don't want the copy to remain "in transit"
1623 $copy->status(OILS_COPY_STATUS_RESHELVING);
1624 $logger->warn("! reseting hold [$hid] that is in transit");
1625 my $transid = $e->search_action_hold_transit_copy({hold=>$hold->id},{idlist=>1})->[0];
1628 my $trans = $e->retrieve_action_transit_copy($transid);
1630 $logger->info("Aborting transit [$transid] on hold [$hid] reset...");
1631 my $evt = OpenILS::Application::Circ::Transit::__abort_transit($e, $trans, $copy, 1);
1632 $logger->info("Transit abort completed with result $evt");
1633 unless ("$evt" eq 1) {
1642 $hold->clear_capture_time;
1643 $hold->clear_current_copy;
1644 $hold->clear_shelf_time;
1645 $hold->clear_shelf_expire_time;
1647 $e->update_action_hold_request($hold) or return $e->die_event;
1651 'open-ils.storage.action.hold_request.copy_targeter', undef, $hold->id );
1657 __PACKAGE__->register_method(
1658 method => 'fetch_open_title_holds',
1659 api_name => 'open-ils.circ.open_holds.retrieve',
1661 Returns a list ids of un-fulfilled holds for a given title id
1662 @param authtoken The login session key
1663 @param id the id of the item whose holds we want to retrieve
1664 @param type The hold type - M, T, I, V, C, F, R
1668 sub fetch_open_title_holds {
1669 my( $self, $conn, $auth, $id, $type, $org ) = @_;
1670 my $e = new_editor( authtoken => $auth );
1671 return $e->event unless $e->checkauth;
1674 $org ||= $e->requestor->ws_ou;
1676 # return $e->search_action_hold_request(
1677 # { target => $id, hold_type => $type, fulfillment_time => undef }, {idlist=>1});
1679 # XXX make me return IDs in the future ^--
1680 my $holds = $e->search_action_hold_request(
1683 cancel_time => undef,
1685 fulfillment_time => undef
1689 flesh_hold_transits($holds);
1694 sub flesh_hold_transits {
1696 for my $hold ( @$holds ) {
1698 $apputils->simplereq(
1700 "open-ils.cstore.direct.action.hold_transit_copy.search.atomic",
1701 { hold => $hold->id },
1702 { order_by => { ahtc => 'id desc' }, limit => 1 }
1708 sub flesh_hold_notices {
1709 my( $holds, $e ) = @_;
1710 $e ||= new_editor();
1712 for my $hold (@$holds) {
1713 my $notices = $e->search_action_hold_notification(
1715 { hold => $hold->id },
1716 { order_by => { anh => 'notify_time desc' } },
1721 $hold->notify_count(scalar(@$notices));
1723 my $n = $e->retrieve_action_hold_notification($$notices[0])
1724 or return $e->event;
1725 $hold->notify_time($n->notify_time);
1731 __PACKAGE__->register_method(
1732 method => 'fetch_captured_holds',
1733 api_name => 'open-ils.circ.captured_holds.on_shelf.retrieve',
1736 Returns a list of un-fulfilled holds (on the Holds Shelf) for a given title id
1737 @param authtoken The login session key
1738 @param org The org id of the location in question
1742 __PACKAGE__->register_method(
1743 method => 'fetch_captured_holds',
1744 api_name => 'open-ils.circ.captured_holds.id_list.on_shelf.retrieve',
1747 Returns list ids of un-fulfilled holds (on the Holds Shelf) for a given title id
1748 @param authtoken The login session key
1749 @param org The org id of the location in question
1753 __PACKAGE__->register_method(
1754 method => 'fetch_captured_holds',
1755 api_name => 'open-ils.circ.captured_holds.id_list.expired_on_shelf.retrieve',
1758 Returns list ids of shelf-expired un-fulfilled holds for a given title id
1759 @param authtoken The login session key
1760 @param org The org id of the location in question
1765 sub fetch_captured_holds {
1766 my( $self, $conn, $auth, $org ) = @_;
1768 my $e = new_editor(authtoken => $auth);
1769 return $e->die_event unless $e->checkauth;
1770 return $e->die_event unless $e->allowed('VIEW_HOLD'); # XXX rely on editor perm
1772 $org ||= $e->requestor->ws_ou;
1775 select => { ahr => ['id'] },
1780 fkey => 'current_copy'
1785 '+acp' => { status => OILS_COPY_STATUS_ON_HOLDS_SHELF },
1787 capture_time => { "!=" => undef },
1788 current_copy => { "!=" => undef },
1789 fulfillment_time => undef,
1791 cancel_time => undef,
1795 if($self->api_name =~ /expired/) {
1796 $query->{'where'}->{'+ahr'}->{'shelf_expire_time'} = {'<' => 'now'};
1797 $query->{'where'}->{'+ahr'}->{'shelf_time'} = {'!=' => undef};
1799 my $hold_ids = $e->json_query( $query );
1801 for my $hold_id (@$hold_ids) {
1802 if($self->api_name =~ /id_list/) {
1803 $conn->respond($hold_id->{id});
1807 $e->retrieve_action_hold_request([
1811 flesh_fields => {ahr => ['notifications', 'transit', 'notes']},
1812 order_by => {anh => 'notify_time desc'}
1822 __PACKAGE__->register_method(
1823 method => "print_expired_holds_stream",
1824 api_name => "open-ils.circ.captured_holds.expired.print.stream",
1828 sub print_expired_holds_stream {
1829 my ($self, $client, $auth, $params) = @_;
1831 # No need to check specific permissions: we're going to call another method
1832 # that will do that.
1833 my $e = new_editor("authtoken" => $auth);
1834 return $e->die_event unless $e->checkauth;
1836 delete($$params{org_id}) unless (int($$params{org_id}));
1837 delete($$params{limit}) unless (int($$params{limit}));
1838 delete($$params{offset}) unless (int($$params{offset}));
1839 delete($$params{chunk_size}) unless (int($$params{chunk_size}));
1840 delete($$params{chunk_size}) if ($$params{chunk_size} && $$params{chunk_size} > 50); # keep the size reasonable
1841 $$params{chunk_size} ||= 10;
1843 $$params{org_id} = (defined $$params{org_id}) ? $$params{org_id}: $e->requestor->ws_ou;
1845 my @hold_ids = $self->method_lookup(
1846 "open-ils.circ.captured_holds.id_list.expired_on_shelf.retrieve"
1847 )->run($auth, $params->{"org_id"});
1852 } elsif (defined $U->event_code($hold_ids[0])) {
1854 return $hold_ids[0];
1857 $logger->info("about to stream back up to " . scalar(@hold_ids) . " expired holds");
1860 my @hid_chunk = splice @hold_ids, 0, $params->{"chunk_size"};
1862 my $result_chunk = $e->json_query({
1864 "acp" => ["barcode"],
1866 first_given_name second_given_name family_name alias
1875 "field" => "id", "fkey" => "current_copy",
1878 "field" => "id", "fkey" => "call_number",
1881 "field" => "id", "fkey" => "record"
1885 "acpl" => {"field" => "id", "fkey" => "location"}
1888 "au" => {"field" => "id", "fkey" => "usr"}
1891 "where" => {"+ahr" => {"id" => \@hid_chunk}}
1892 }) or return $e->die_event;
1893 $client->respond($result_chunk);
1900 __PACKAGE__->register_method(
1901 method => "check_title_hold_batch",
1902 api_name => "open-ils.circ.title_hold.is_possible.batch",
1905 desc => '@see open-ils.circ.title_hold.is_possible.batch',
1907 { desc => 'Authentication token', type => 'string'},
1908 { desc => 'Array of Hash of named parameters', type => 'array'},
1911 desc => 'Array of response objects',
1917 sub check_title_hold_batch {
1918 my($self, $client, $authtoken, $param_list) = @_;
1919 foreach (@$param_list) {
1920 my ($res) = $self->method_lookup('open-ils.circ.title_hold.is_possible')->run($authtoken, $_);
1921 $client->respond($res);
1927 __PACKAGE__->register_method(
1928 method => "check_title_hold",
1929 api_name => "open-ils.circ.title_hold.is_possible",
1931 desc => 'Determines if a hold were to be placed by a given user, ' .
1932 'whether or not said hold would have any potential copies to fulfill it.' .
1933 'The named paramaters of the second argument include: ' .
1934 'patronid, titleid, volume_id, copy_id, mrid, depth, pickup_lib, hold_type, selection_ou. ' .
1935 'See perldoc ' . __PACKAGE__ . ' for more info on these fields.' ,
1937 { desc => 'Authentication token', type => 'string'},
1938 { desc => 'Hash of named parameters', type => 'object'},
1941 desc => 'List of new message IDs (empty if none)',
1947 =head3 check_title_hold (token, hash)
1949 The named fields in the hash are:
1951 patronid - ID of the hold recipient (required)
1952 depth - hold range depth (default 0)
1953 pickup_lib - destination for hold, fallback value for selection_ou
1954 selection_ou - ID of org_unit establishing hard and soft hold boundary settings
1955 issuanceid - ID of the issuance to be held, required for Issuance level hold
1956 partid - ID of the monograph part to be held, required for monograph part level hold
1957 titleid - ID (BRN) of the title to be held, required for Title level hold
1958 volume_id - required for Volume level hold
1959 copy_id - required for Copy level hold
1960 mrid - required for Meta-record level hold
1961 hold_type - T, C (or R or F), I, V or M for Title, Copy, Issuance, Volume or Meta-record (default "T")
1963 All key/value pairs are passed on to do_possibility_checks.
1967 # FIXME: better params checking. what other params are required, if any?
1968 # FIXME: 3 copies of values confusing: $x, $params->{x} and $params{x}
1969 # FIXME: for example, $depth gets a default value, but then $$params{depth} is still
1970 # used in conditionals, where it may be undefined, causing a warning.
1971 # FIXME: specify proper usage/interaction of selection_ou and pickup_lib
1973 sub check_title_hold {
1974 my( $self, $client, $authtoken, $params ) = @_;
1975 my $e = new_editor(authtoken=>$authtoken);
1976 return $e->event unless $e->checkauth;
1978 my %params = %$params;
1979 my $depth = $params{depth} || 0;
1980 my $selection_ou = $params{selection_ou} || $params{pickup_lib};
1982 my $patron = $e->retrieve_actor_user($params{patronid})
1983 or return $e->event;
1985 if( $e->requestor->id ne $patron->id ) {
1986 return $e->event unless
1987 $e->allowed('VIEW_HOLD_PERMIT', $patron->home_ou);
1990 return OpenILS::Event->new('PATRON_BARRED') if $U->is_true($patron->barred);
1992 my $request_lib = $e->retrieve_actor_org_unit($e->requestor->ws_ou)
1993 or return $e->event;
1995 my $soft_boundary = $U->ou_ancestor_setting_value($selection_ou, OILS_SETTING_HOLD_SOFT_BOUNDARY);
1996 my $hard_boundary = $U->ou_ancestor_setting_value($selection_ou, OILS_SETTING_HOLD_HARD_BOUNDARY);
1999 my $return_depth = $hard_boundary; # default depth to return on success
2000 if(defined $soft_boundary and $depth < $soft_boundary) {
2001 # work up the tree and as soon as we find a potential copy, use that depth
2002 # also, make sure we don't go past the hard boundary if it exists
2004 # our min boundary is the greater of user-specified boundary or hard boundary
2005 my $min_depth = (defined $hard_boundary and $hard_boundary > $depth) ?
2006 $hard_boundary : $depth;
2008 my $depth = $soft_boundary;
2009 while($depth >= $min_depth) {
2010 $logger->info("performing hold possibility check with soft boundary $depth");
2011 @status = do_possibility_checks($e, $patron, $request_lib, $depth, %params);
2013 $return_depth = $depth;
2018 } elsif(defined $hard_boundary and $depth < $hard_boundary) {
2019 # there is no soft boundary, enforce the hard boundary if it exists
2020 $logger->info("performing hold possibility check with hard boundary $hard_boundary");
2021 @status = do_possibility_checks($e, $patron, $request_lib, $hard_boundary, %params);
2023 # no boundaries defined, fall back to user specifed boundary or no boundary
2024 $logger->info("performing hold possibility check with no boundary");
2025 @status = do_possibility_checks($e, $patron, $request_lib, $params{depth}, %params);
2031 "depth" => $return_depth,
2032 "local_avail" => $status[1]
2034 } elsif ($status[2]) {
2035 my $n = scalar @{$status[2]};
2036 return {"success" => 0, "last_event" => $status[2]->[$n - 1]};
2038 return {"success" => 0};
2044 sub do_possibility_checks {
2045 my($e, $patron, $request_lib, $depth, %params) = @_;
2047 my $issuanceid = $params{issuanceid} || "";
2048 my $partid = $params{partid} || "";
2049 my $titleid = $params{titleid} || "";
2050 my $volid = $params{volume_id};
2051 my $copyid = $params{copy_id};
2052 my $mrid = $params{mrid} || "";
2053 my $pickup_lib = $params{pickup_lib};
2054 my $hold_type = $params{hold_type} || 'T';
2055 my $selection_ou = $params{selection_ou} || $pickup_lib;
2062 if( $hold_type eq OILS_HOLD_TYPE_FORCE || $hold_type eq OILS_HOLD_TYPE_RECALL || $hold_type eq OILS_HOLD_TYPE_COPY ) {
2064 return $e->event unless $copy = $e->retrieve_asset_copy($copyid);
2065 return $e->event unless $volume = $e->retrieve_asset_call_number($copy->call_number);
2066 return $e->event unless $title = $e->retrieve_biblio_record_entry($volume->record);
2068 return verify_copy_for_hold(
2069 $patron, $e->requestor, $title, $copy, $pickup_lib, $request_lib
2072 } elsif( $hold_type eq OILS_HOLD_TYPE_VOLUME ) {
2074 return $e->event unless $volume = $e->retrieve_asset_call_number($volid);
2075 return $e->event unless $title = $e->retrieve_biblio_record_entry($volume->record);
2077 return _check_volume_hold_is_possible(
2078 $volume, $title, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou
2081 } elsif( $hold_type eq OILS_HOLD_TYPE_TITLE ) {
2083 return _check_title_hold_is_possible(
2084 $titleid, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou
2087 } elsif( $hold_type eq OILS_HOLD_TYPE_ISSUANCE ) {
2089 return _check_issuance_hold_is_possible(
2090 $issuanceid, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou
2093 } elsif( $hold_type eq OILS_HOLD_TYPE_MONOPART ) {
2095 return _check_monopart_hold_is_possible(
2096 $partid, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou
2099 } elsif( $hold_type eq OILS_HOLD_TYPE_METARECORD ) {
2101 my $maps = $e->search_metabib_metarecord_source_map({metarecord=>$mrid});
2102 my @recs = map { $_->source } @$maps;
2104 for my $rec (@recs) {
2105 @status = _check_title_hold_is_possible(
2106 $rec, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou
2112 # else { Unrecognized hold_type ! } # FIXME: return error? or 0?
2116 sub create_ranged_org_filter {
2117 my($e, $selection_ou, $depth) = @_;
2119 # find the orgs from which this hold may be fulfilled,
2120 # based on the selection_ou and depth
2122 my $top_org = $e->search_actor_org_unit([
2123 {parent_ou => undef},
2124 {flesh=>1, flesh_fields=>{aou=>['ou_type']}}])->[0];
2127 return () if $depth == $top_org->ou_type->depth;
2129 my $org_list = $U->storagereq('open-ils.storage.actor.org_unit.descendants.atomic', $selection_ou, $depth);
2130 %org_filter = (circ_lib => []);
2131 push(@{$org_filter{circ_lib}}, $_->id) for @$org_list;
2133 $logger->info("hold org filter at depth $depth and selection_ou ".
2134 "$selection_ou created list of @{$org_filter{circ_lib}}");
2140 sub _check_title_hold_is_possible {
2141 my( $titleid, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou ) = @_;
2143 my $e = new_editor();
2144 my %org_filter = create_ranged_org_filter($e, $selection_ou, $depth);
2146 # this monster will grab the id and circ_lib of all of the "holdable" copies for the given record
2147 my $copies = $e->json_query(
2149 select => { acp => ['id', 'circ_lib'] },
2154 fkey => 'call_number',
2158 filter => { id => $titleid },
2163 acpl => { field => 'id', filter => { holdable => 't'}, fkey => 'location' },
2164 ccs => { field => 'id', filter => { holdable => 't'}, fkey => 'status' }
2168 '+acp' => { circulate => 't', deleted => 'f', holdable => 't', %org_filter }
2173 $logger->info("title possible found ".scalar(@$copies)." potential copies");
2177 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2178 "payload" => {"fail_part" => "no_ultimate_items"}
2183 # -----------------------------------------------------------------------
2184 # sort the copies into buckets based on their circ_lib proximity to
2185 # the patron's home_ou.
2186 # -----------------------------------------------------------------------
2188 my $home_org = $patron->home_ou;
2189 my $req_org = $request_lib->id;
2191 $logger->info("prox cache $home_org " . $prox_cache{$home_org});
2193 $prox_cache{$home_org} =
2194 $e->search_actor_org_unit_proximity({from_org => $home_org})
2195 unless $prox_cache{$home_org};
2196 my $home_prox = $prox_cache{$home_org};
2199 my %hash = map { ($_->to_org => $_->prox) } @$home_prox;
2200 push( @{$buckets{ $hash{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2202 my @keys = sort { $a <=> $b } keys %buckets;
2205 if( $home_org ne $req_org ) {
2206 # -----------------------------------------------------------------------
2207 # shove the copies close to the request_lib into the primary buckets
2208 # directly before the farthest away copies. That way, they are not
2209 # given priority, but they are checked before the farthest copies.
2210 # -----------------------------------------------------------------------
2211 $prox_cache{$req_org} =
2212 $e->search_actor_org_unit_proximity({from_org => $req_org})
2213 unless $prox_cache{$req_org};
2214 my $req_prox = $prox_cache{$req_org};
2217 my %hash2 = map { ($_->to_org => $_->prox) } @$req_prox;
2218 push( @{$buckets2{ $hash2{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2220 my $highest_key = $keys[@keys - 1]; # the farthest prox in the exising buckets
2221 my $new_key = $highest_key - 0.5; # right before the farthest prox
2222 my @keys2 = sort { $a <=> $b } keys %buckets2;
2223 for my $key (@keys2) {
2224 last if $key >= $highest_key;
2225 push( @{$buckets{$new_key}}, $_ ) for @{$buckets2{$key}};
2229 @keys = sort { $a <=> $b } keys %buckets;
2234 OUTER: for my $key (@keys) {
2235 my @cps = @{$buckets{$key}};
2237 $logger->info("looking at " . scalar(@{$buckets{$key}}). " copies in proximity bucket $key");
2239 for my $copyid (@cps) {
2241 next if $seen{$copyid};
2242 $seen{$copyid} = 1; # there could be dupes given the merged buckets
2243 my $copy = $e->retrieve_asset_copy($copyid);
2244 $logger->debug("looking at bucket_key=$key, copy $copyid : circ_lib = " . $copy->circ_lib);
2246 unless($title) { # grab the title if we don't already have it
2247 my $vol = $e->retrieve_asset_call_number(
2248 [ $copy->call_number, { flesh => 1, flesh_fields => { bre => ['fixed_fields'], acn => ['record'] } } ] );
2249 $title = $vol->record;
2252 @status = verify_copy_for_hold(
2253 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib);
2255 last OUTER if $status[0];
2262 sub _check_issuance_hold_is_possible {
2263 my( $issuanceid, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou ) = @_;
2265 my $e = new_editor();
2266 my %org_filter = create_ranged_org_filter($e, $selection_ou, $depth);
2268 # this monster will grab the id and circ_lib of all of the "holdable" copies for the given record
2269 my $copies = $e->json_query(
2271 select => { acp => ['id', 'circ_lib'] },
2277 filter => { issuance => $issuanceid }
2279 acpl => { field => 'id', filter => { holdable => 't'}, fkey => 'location' },
2280 ccs => { field => 'id', filter => { holdable => 't'}, fkey => 'status' }
2284 '+acp' => { circulate => 't', deleted => 'f', holdable => 't', %org_filter }
2290 $logger->info("issuance possible found ".scalar(@$copies)." potential copies");
2294 $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_issuance_ok');
2295 $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2300 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2301 "payload" => {"fail_part" => "no_ultimate_items"}
2309 # -----------------------------------------------------------------------
2310 # sort the copies into buckets based on their circ_lib proximity to
2311 # the patron's home_ou.
2312 # -----------------------------------------------------------------------
2314 my $home_org = $patron->home_ou;
2315 my $req_org = $request_lib->id;
2317 $logger->info("prox cache $home_org " . $prox_cache{$home_org});
2319 $prox_cache{$home_org} =
2320 $e->search_actor_org_unit_proximity({from_org => $home_org})
2321 unless $prox_cache{$home_org};
2322 my $home_prox = $prox_cache{$home_org};
2325 my %hash = map { ($_->to_org => $_->prox) } @$home_prox;
2326 push( @{$buckets{ $hash{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2328 my @keys = sort { $a <=> $b } keys %buckets;
2331 if( $home_org ne $req_org ) {
2332 # -----------------------------------------------------------------------
2333 # shove the copies close to the request_lib into the primary buckets
2334 # directly before the farthest away copies. That way, they are not
2335 # given priority, but they are checked before the farthest copies.
2336 # -----------------------------------------------------------------------
2337 $prox_cache{$req_org} =
2338 $e->search_actor_org_unit_proximity({from_org => $req_org})
2339 unless $prox_cache{$req_org};
2340 my $req_prox = $prox_cache{$req_org};
2343 my %hash2 = map { ($_->to_org => $_->prox) } @$req_prox;
2344 push( @{$buckets2{ $hash2{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2346 my $highest_key = $keys[@keys - 1]; # the farthest prox in the exising buckets
2347 my $new_key = $highest_key - 0.5; # right before the farthest prox
2348 my @keys2 = sort { $a <=> $b } keys %buckets2;
2349 for my $key (@keys2) {
2350 last if $key >= $highest_key;
2351 push( @{$buckets{$new_key}}, $_ ) for @{$buckets2{$key}};
2355 @keys = sort { $a <=> $b } keys %buckets;
2360 OUTER: for my $key (@keys) {
2361 my @cps = @{$buckets{$key}};
2363 $logger->info("looking at " . scalar(@{$buckets{$key}}). " copies in proximity bucket $key");
2365 for my $copyid (@cps) {
2367 next if $seen{$copyid};
2368 $seen{$copyid} = 1; # there could be dupes given the merged buckets
2369 my $copy = $e->retrieve_asset_copy($copyid);
2370 $logger->debug("looking at bucket_key=$key, copy $copyid : circ_lib = " . $copy->circ_lib);
2372 unless($title) { # grab the title if we don't already have it
2373 my $vol = $e->retrieve_asset_call_number(
2374 [ $copy->call_number, { flesh => 1, flesh_fields => { bre => ['fixed_fields'], acn => ['record'] } } ] );
2375 $title = $vol->record;
2378 @status = verify_copy_for_hold(
2379 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib);
2381 last OUTER if $status[0];
2386 if (!defined($empty_ok)) {
2387 $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_issuance_ok');
2388 $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2391 return (1,0) if ($empty_ok);
2396 sub _check_monopart_hold_is_possible {
2397 my( $partid, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou ) = @_;
2399 my $e = new_editor();
2400 my %org_filter = create_ranged_org_filter($e, $selection_ou, $depth);
2402 # this monster will grab the id and circ_lib of all of the "holdable" copies for the given record
2403 my $copies = $e->json_query(
2405 select => { acp => ['id', 'circ_lib'] },
2409 field => 'target_copy',
2411 filter => { part => $partid }
2413 acpl => { field => 'id', filter => { holdable => 't'}, fkey => 'location' },
2414 ccs => { field => 'id', filter => { holdable => 't'}, fkey => 'status' }
2418 '+acp' => { circulate => 't', deleted => 'f', holdable => 't', %org_filter }
2424 $logger->info("monopart possible found ".scalar(@$copies)." potential copies");
2428 $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_part_ok');
2429 $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2434 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2435 "payload" => {"fail_part" => "no_ultimate_items"}
2443 # -----------------------------------------------------------------------
2444 # sort the copies into buckets based on their circ_lib proximity to
2445 # the patron's home_ou.
2446 # -----------------------------------------------------------------------
2448 my $home_org = $patron->home_ou;
2449 my $req_org = $request_lib->id;
2451 $logger->info("prox cache $home_org " . $prox_cache{$home_org});
2453 $prox_cache{$home_org} =
2454 $e->search_actor_org_unit_proximity({from_org => $home_org})
2455 unless $prox_cache{$home_org};
2456 my $home_prox = $prox_cache{$home_org};
2459 my %hash = map { ($_->to_org => $_->prox) } @$home_prox;
2460 push( @{$buckets{ $hash{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2462 my @keys = sort { $a <=> $b } keys %buckets;
2465 if( $home_org ne $req_org ) {
2466 # -----------------------------------------------------------------------
2467 # shove the copies close to the request_lib into the primary buckets
2468 # directly before the farthest away copies. That way, they are not
2469 # given priority, but they are checked before the farthest copies.
2470 # -----------------------------------------------------------------------
2471 $prox_cache{$req_org} =
2472 $e->search_actor_org_unit_proximity({from_org => $req_org})
2473 unless $prox_cache{$req_org};
2474 my $req_prox = $prox_cache{$req_org};
2477 my %hash2 = map { ($_->to_org => $_->prox) } @$req_prox;
2478 push( @{$buckets2{ $hash2{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2480 my $highest_key = $keys[@keys - 1]; # the farthest prox in the exising buckets
2481 my $new_key = $highest_key - 0.5; # right before the farthest prox
2482 my @keys2 = sort { $a <=> $b } keys %buckets2;
2483 for my $key (@keys2) {
2484 last if $key >= $highest_key;
2485 push( @{$buckets{$new_key}}, $_ ) for @{$buckets2{$key}};
2489 @keys = sort { $a <=> $b } keys %buckets;
2494 OUTER: for my $key (@keys) {
2495 my @cps = @{$buckets{$key}};
2497 $logger->info("looking at " . scalar(@{$buckets{$key}}). " copies in proximity bucket $key");
2499 for my $copyid (@cps) {
2501 next if $seen{$copyid};
2502 $seen{$copyid} = 1; # there could be dupes given the merged buckets
2503 my $copy = $e->retrieve_asset_copy($copyid);
2504 $logger->debug("looking at bucket_key=$key, copy $copyid : circ_lib = " . $copy->circ_lib);
2506 unless($title) { # grab the title if we don't already have it
2507 my $vol = $e->retrieve_asset_call_number(
2508 [ $copy->call_number, { flesh => 1, flesh_fields => { bre => ['fixed_fields'], acn => ['record'] } } ] );
2509 $title = $vol->record;
2512 @status = verify_copy_for_hold(
2513 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib);
2515 last OUTER if $status[0];
2520 if (!defined($empty_ok)) {
2521 $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_part_ok');
2522 $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2525 return (1,0) if ($empty_ok);
2531 sub _check_volume_hold_is_possible {
2532 my( $vol, $title, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou ) = @_;
2533 my %org_filter = create_ranged_org_filter(new_editor(), $selection_ou, $depth);
2534 my $copies = new_editor->search_asset_copy({call_number => $vol->id, %org_filter});
2535 $logger->info("checking possibility of volume hold for volume ".$vol->id);
2540 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2541 "payload" => {"fail_part" => "no_ultimate_items"}
2547 for my $copy ( @$copies ) {
2548 @status = verify_copy_for_hold(
2549 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib );
2557 sub verify_copy_for_hold {
2558 my( $patron, $requestor, $title, $copy, $pickup_lib, $request_lib ) = @_;
2559 $logger->info("checking possibility of copy in hold request for copy ".$copy->id);
2560 my $permitted = OpenILS::Utils::PermitHold::permit_copy_hold(
2561 { patron => $patron,
2562 requestor => $requestor,
2565 title_descriptor => $title->fixed_fields, # this is fleshed into the title object
2566 pickup_lib => $pickup_lib,
2567 request_lib => $request_lib,
2569 show_event_list => 1
2574 (not scalar @$permitted), # true if permitted is an empty arrayref
2576 ($copy->circ_lib == $pickup_lib) and
2577 ($copy->status == OILS_COPY_STATUS_AVAILABLE)
2585 sub find_nearest_permitted_hold {
2588 my $editor = shift; # CStoreEditor object
2589 my $copy = shift; # copy to target
2590 my $user = shift; # staff
2591 my $check_only = shift; # do no updates, just see if the copy could fulfill a hold
2593 my $evt = OpenILS::Event->new('ACTION_HOLD_REQUEST_NOT_FOUND');
2595 my $bc = $copy->barcode;
2597 # find any existing holds that already target this copy
2598 my $old_holds = $editor->search_action_hold_request(
2599 { current_copy => $copy->id,
2600 cancel_time => undef,
2601 capture_time => undef
2605 # hold->type "R" means we need this copy
2606 for my $h (@$old_holds) { return ($h) if $h->hold_type eq 'R'; }
2609 my $hold_stall_interval = $U->ou_ancestor_setting_value($user->ws_ou, OILS_SETTING_HOLD_SOFT_STALL);
2611 $logger->info("circulator: searching for best hold at org ".$user->ws_ou.
2612 " and copy $bc with a hold stalling interval of ". ($hold_stall_interval || "(none)"));
2614 my $fifo = $U->ou_ancestor_setting_value($user->ws_ou, 'circ.holds_fifo');
2616 # search for what should be the best holds for this copy to fulfill
2617 my $best_holds = $U->storagereq(
2618 "open-ils.storage.action.hold_request.nearest_hold.atomic",
2619 $user->ws_ou, $copy->id, 10, $hold_stall_interval, $fifo );
2621 unless(@$best_holds) {
2623 if( my $hold = $$old_holds[0] ) {
2624 $logger->info("circulator: using existing pre-targeted hold ".$hold->id." in hold search");
2628 $logger->info("circulator: no suitable holds found for copy $bc");
2629 return (undef, $evt);
2635 # for each potential hold, we have to run the permit script
2636 # to make sure the hold is actually permitted.
2639 for my $holdid (@$best_holds) {
2640 next unless $holdid;
2641 $logger->info("circulator: checking if hold $holdid is permitted for copy $bc");
2643 my $hold = $editor->retrieve_action_hold_request($holdid) or next;
2644 my $reqr = $reqr_cache{$hold->requestor} || $editor->retrieve_actor_user($hold->requestor);
2645 my $rlib = $org_cache{$hold->request_lib} || $editor->retrieve_actor_org_unit($hold->request_lib);
2647 $reqr_cache{$hold->requestor} = $reqr;
2648 $org_cache{$hold->request_lib} = $rlib;
2650 # see if this hold is permitted
2651 my $permitted = OpenILS::Utils::PermitHold::permit_copy_hold(
2652 { patron_id => $hold->usr,
2655 pickup_lib => $hold->pickup_lib,
2656 request_lib => $rlib,
2668 unless( $best_hold ) { # no "good" permitted holds were found
2669 if( my $hold = $$old_holds[0] ) { # can we return a pre-targeted hold?
2670 $logger->info("circulator: using existing pre-targeted hold ".$hold->id." in hold search");
2675 $logger->info("circulator: no suitable holds found for copy $bc");
2676 return (undef, $evt);
2679 $logger->info("circulator: best hold ".$best_hold->id." found for copy $bc");
2681 # indicate a permitted hold was found
2682 return $best_hold if $check_only;
2684 # we've found a permitted hold. we need to "grab" the copy
2685 # to prevent re-targeted holds (next part) from re-grabbing the copy
2686 $best_hold->current_copy($copy->id);
2687 $editor->update_action_hold_request($best_hold)
2688 or return (undef, $editor->event);
2693 # re-target any other holds that already target this copy
2694 for my $old_hold (@$old_holds) {
2695 next if $old_hold->id eq $best_hold->id; # don't re-target the hold we want
2696 $logger->info("circulator: clearing current_copy and prev_check_time on hold ".
2697 $old_hold->id." after a better hold [".$best_hold->id."] was found");
2698 $old_hold->clear_current_copy;
2699 $old_hold->clear_prev_check_time;
2700 $editor->update_action_hold_request($old_hold)
2701 or return (undef, $editor->event);
2702 push(@retarget, $old_hold->id);
2705 return ($best_hold, undef, (@retarget) ? \@retarget : undef);
2713 __PACKAGE__->register_method(
2714 method => 'all_rec_holds',
2715 api_name => 'open-ils.circ.holds.retrieve_all_from_title',
2719 my( $self, $conn, $auth, $title_id, $args ) = @_;
2721 my $e = new_editor(authtoken=>$auth);
2722 $e->checkauth or return $e->event;
2723 $e->allowed('VIEW_HOLD') or return $e->event;
2726 $args->{fulfillment_time} = undef; # we don't want to see old fulfilled holds
2727 $args->{cancel_time} = undef;
2729 my $resp = { volume_holds => [], copy_holds => [], metarecord_holds => [] };
2731 my $mr_map = $e->search_metabib_metarecord_source_map({source => $title_id})->[0];
2733 $resp->{metarecord_holds} = $e->search_action_hold_request(
2734 { hold_type => OILS_HOLD_TYPE_METARECORD,
2735 target => $mr_map->metarecord,
2741 $resp->{title_holds} = $e->search_action_hold_request(
2743 hold_type => OILS_HOLD_TYPE_TITLE,
2744 target => $title_id,
2748 $resp->{part_holds} = $e->search_action_hold_request(
2750 hold_type => OILS_HOLD_TYPE_MONOPART,
2751 target => $title_id,
2755 my $subs = $e->search_serial_subscription(
2756 { record_entry => $title_id }, {idlist=>1});
2757 my $issuances = $e->search_serial_issuance(
2758 { subscription => $subs }, {idlist=>1});
2760 $resp->{issuance_holds} = $e->search_action_hold_request(
2762 hold_type => OILS_HOLD_TYPE_ISSUANCE,
2763 target => $issuances,
2767 my $vols = $e->search_asset_call_number(
2768 { record => $title_id, deleted => 'f' }, {idlist=>1});
2770 return $resp unless @$vols;
2772 $resp->{volume_holds} = $e->search_action_hold_request(
2774 hold_type => OILS_HOLD_TYPE_VOLUME,
2779 my $copies = $e->search_asset_copy(
2780 { call_number => $vols, deleted => 'f' }, {idlist=>1});
2782 return $resp unless @$copies;
2784 $resp->{copy_holds} = $e->search_action_hold_request(
2786 hold_type => OILS_HOLD_TYPE_COPY,
2798 __PACKAGE__->register_method(
2799 method => 'uber_hold',
2801 api_name => 'open-ils.circ.hold.details.retrieve'
2805 my($self, $client, $auth, $hold_id, $args) = @_;
2806 my $e = new_editor(authtoken=>$auth);
2807 $e->checkauth or return $e->event;
2808 return uber_hold_impl($e, $hold_id, $args);
2811 __PACKAGE__->register_method(
2812 method => 'batch_uber_hold',
2815 api_name => 'open-ils.circ.hold.details.batch.retrieve'
2818 sub batch_uber_hold {
2819 my($self, $client, $auth, $hold_ids, $args) = @_;
2820 my $e = new_editor(authtoken=>$auth);
2821 $e->checkauth or return $e->event;
2822 $client->respond(uber_hold_impl($e, $_, $args)) for @$hold_ids;
2826 sub uber_hold_impl {
2827 my($e, $hold_id, $args) = @_;
2830 my $hold = $e->retrieve_action_hold_request(
2835 flesh_fields => { ahr => [ 'current_copy', 'usr', 'notes' ] }
2838 ) or return $e->event;
2840 if($hold->usr->id ne $e->requestor->id) {
2841 # A user is allowed to see his/her own holds
2842 $e->allowed('VIEW_HOLD') or return $e->event;
2843 $hold->notes( # filter out any non-staff ("private") notes
2844 [ grep { !$U->is_true($_->staff) } @{$hold->notes} ] );
2847 # caller is asking for own hold, but may not have permission to view staff notes
2848 unless($e->allowed('VIEW_HOLD')) {
2849 $hold->notes( # filter out any staff notes
2850 [ grep { $U->is_true($_->staff) } @{$hold->notes} ] );
2854 my $user = $hold->usr;
2855 $hold->usr($user->id);
2858 my( $mvr, $volume, $copy, $issuance, $part, $bre ) = find_hold_mvr($e, $hold, $args->{suppress_mvr});
2860 flesh_hold_notices([$hold], $e) unless $args->{suppress_notices};
2861 flesh_hold_transits([$hold]) unless $args->{suppress_transits};
2863 my $details = retrieve_hold_queue_status_impl($e, $hold);
2867 ($copy ? (copy => $copy) : ()),
2868 ($volume ? (volume => $volume) : ()),
2869 ($issuance ? (issuance => $issuance) : ()),
2870 ($part ? (part => $part) : ()),
2871 ($args->{include_bre} ? (bre => $bre) : ()),
2872 ($args->{suppress_mvr} ? () : (mvr => $mvr)),
2876 unless($args->{suppress_patron_details}) {
2877 my $card = $e->retrieve_actor_card($user->card) or return $e->event;
2878 $resp->{patron_first} = $user->first_given_name,
2879 $resp->{patron_last} = $user->family_name,
2880 $resp->{patron_barcode} = $card->barcode,
2881 $resp->{patron_alias} = $user->alias,
2889 # -----------------------------------------------------
2890 # Returns the MVR object that represents what the
2892 # -----------------------------------------------------
2894 my( $e, $hold, $no_mvr ) = @_;
2902 if( $hold->hold_type eq OILS_HOLD_TYPE_METARECORD ) {
2903 my $mr = $e->retrieve_metabib_metarecord($hold->target)
2904 or return $e->event;
2905 $tid = $mr->master_record;
2907 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_TITLE ) {
2908 $tid = $hold->target;
2910 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_VOLUME ) {
2911 $volume = $e->retrieve_asset_call_number($hold->target)
2912 or return $e->event;
2913 $tid = $volume->record;
2915 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_ISSUANCE ) {
2916 $issuance = $e->retrieve_serial_issuance([
2918 {flesh => 1, flesh_fields => {siss => [ qw/subscription/ ]}}
2919 ]) or return $e->event;
2921 $tid = $issuance->subscription->record_entry;
2923 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_MONOPART ) {
2924 $part = $e->retrieve_biblio_monograph_part([
2926 ]) or return $e->event;
2928 $tid = $part->record;
2930 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_COPY ) {
2931 $copy = $e->retrieve_asset_copy([
2933 {flesh => 1, flesh_fields => {acp => ['call_number']}}
2934 ]) or return $e->event;
2936 $volume = $copy->call_number;
2937 $tid = $volume->record;
2940 if(!$copy and ref $hold->current_copy ) {
2941 $copy = $hold->current_copy;
2942 $hold->current_copy($copy->id);
2945 if(!$volume and $copy) {
2946 $volume = $e->retrieve_asset_call_number($copy->call_number);
2949 # TODO return metarcord mvr for M holds
2950 my $title = $e->retrieve_biblio_record_entry($tid);
2951 return ( ($no_mvr) ? undef : $U->record_to_mvr($title), $volume, $copy, $issuance, $part, $title );
2954 __PACKAGE__->register_method(
2955 method => 'clear_shelf_cache',
2956 api_name => 'open-ils.circ.hold.clear_shelf.get_cache',
2960 Returns the holds processed with the given cache key
2965 sub clear_shelf_cache {
2966 my($self, $client, $auth, $cache_key, $chunk_size) = @_;
2967 my $e = new_editor(authtoken => $auth, xact => 1);
2968 return $e->die_event unless $e->checkauth and $e->allowed('VIEW_HOLD');
2971 my $hold_data = OpenSRF::Utils::Cache->new('global')->get_cache($cache_key);
2974 $logger->info("no hold data found in cache"); # XXX TODO return event
2980 foreach (keys %$hold_data) {
2981 $maximum += scalar(@{ $hold_data->{$_} });
2983 $client->respond({"maximum" => $maximum, "progress" => 0});
2985 for my $action (sort keys %$hold_data) {
2986 while (@{$hold_data->{$action}}) {
2987 my @hid_chunk = splice @{$hold_data->{$action}}, 0, $chunk_size;
2989 my $result_chunk = $e->json_query({
2991 "acp" => ["barcode"],
2993 first_given_name second_given_name family_name alias
3003 "field" => "id", "fkey" => "current_copy",
3006 "field" => "id", "fkey" => "call_number",
3009 "field" => "id", "fkey" => "record"
3013 "acpl" => {"field" => "id", "fkey" => "location"}
3016 "au" => {"field" => "id", "fkey" => "usr"}
3019 "where" => {"+ahr" => {"id" => \@hid_chunk}}
3020 }, {"substream" => 1}) or return $e->die_event;
3024 +{"action" => $action, "hold_details" => $_}
3035 __PACKAGE__->register_method(
3036 method => 'clear_shelf_process',
3038 api_name => 'open-ils.circ.hold.clear_shelf.process',
3041 1. Find all holds that have expired on the holds shelf
3043 3. If a clear-shelf status is configured, put targeted copies into this status
3044 4. Divide copies into 3 groups: items to transit, items to reshelve, and items
3045 that are needed for holds. No subsequent action is taken on the holds
3046 or items after grouping.
3051 sub clear_shelf_process {
3052 my($self, $client, $auth, $org_id) = @_;
3054 my $e = new_editor(authtoken=>$auth, xact => 1);
3055 $e->checkauth or return $e->die_event;
3056 my $cache = OpenSRF::Utils::Cache->new('global');
3058 $org_id ||= $e->requestor->ws_ou;
3059 $e->allowed('UPDATE_HOLD', $org_id) or return $e->die_event;
3061 my $copy_status = $U->ou_ancestor_setting_value($org_id, 'circ.holds.clear_shelf.copy_status');
3063 # Find holds on the shelf that have been there too long
3064 my $hold_ids = $e->search_action_hold_request(
3065 { shelf_expire_time => {'<' => 'now'},
3066 pickup_lib => $org_id,
3067 cancel_time => undef,
3068 fulfillment_time => undef,
3069 shelf_time => {'!=' => undef},
3070 capture_time => {'!=' => undef},
3071 current_copy => {'!=' => undef},
3077 my $chunk_size = 25; # chunked status updates
3079 for my $hold_id (@$hold_ids) {
3081 $logger->info("Clear shelf processing hold $hold_id");
3083 my $hold = $e->retrieve_action_hold_request([
3086 flesh_fields => {ahr => ['current_copy']}
3090 $hold->cancel_time('now');
3091 $hold->cancel_cause(2); # Hold Shelf expiration
3092 $e->update_action_hold_request($hold) or return $e->die_event;
3093 delete_hold_copy_maps($self, $e, $hold->id) and return $e->die_event;
3095 my $copy = $hold->current_copy;
3097 if($copy_status or $copy_status == 0) {
3098 # if a clear-shelf copy status is defined, update the copy
3099 $copy->status($copy_status);
3100 $copy->edit_date('now');
3101 $copy->editor($e->requestor->id);
3102 $e->update_asset_copy($copy) or return $e->die_event;
3105 push(@holds, $hold);
3106 $client->respond({maximum => scalar(@holds), progress => $counter}) if ( (++$counter % $chunk_size) == 0);
3117 for my $hold (@holds) {
3119 my $copy = $hold->current_copy;
3120 my ($alt_hold) = __PACKAGE__->find_nearest_permitted_hold($e, $copy, $e->requestor, 1);
3124 push(@{$cache_data{hold}}, $hold->id); # copy is needed for a hold
3126 } elsif($copy->circ_lib != $e->requestor->ws_ou) {
3128 push(@{$cache_data{transit}}, $hold->id); # copy needs to transit
3132 push(@{$cache_data{shelf}}, $hold->id); # copy needs to go back to the shelf
3136 my $cache_key = md5_hex(time . $$ . rand());
3137 $logger->info("clear_shelf_cache: storing under $cache_key");
3138 $cache->put_cache($cache_key, \%cache_data, 7200); # TODO: 2 hours. configurable?
3140 # tell the client we're done
3141 $client->respond_complete({cache_key => $cache_key});
3143 # fire off the hold cancelation trigger and wait for response so don't flood the service
3144 $U->create_events_for_hook(
3145 'hold_request.cancel.expire_holds_shelf',
3146 $_, $org_id, undef, undef, 1) for @holds;
3149 # tell the client we're done
3150 $client->respond_complete;
3154 __PACKAGE__->register_method(
3155 method => 'usr_hold_summary',
3156 api_name => 'open-ils.circ.holds.user_summary',
3158 Returns a summary of holds statuses for a given user
3162 sub usr_hold_summary {
3163 my($self, $conn, $auth, $user_id) = @_;
3165 my $e = new_editor(authtoken=>$auth);
3166 $e->checkauth or return $e->event;
3167 $e->allowed('VIEW_HOLD') or return $e->event;
3169 my $holds = $e->search_action_hold_request(
3172 fulfillment_time => undef,
3173 cancel_time => undef,
3177 my %summary = (1 => 0, 2 => 0, 3 => 0, 4 => 0);
3178 $summary{_hold_status($e, $_)} += 1 for @$holds;
3184 __PACKAGE__->register_method(
3185 method => 'hold_has_copy_at',
3186 api_name => 'open-ils.circ.hold.has_copy_at',
3189 'Returns the ID of the found copy and name of the shelving location if there is ' .
3190 'an available copy at the specified org unit. Returns empty hash otherwise. ' .
3191 'The anticipated use for this method is to determine whether an item is ' .
3192 'available at the library where the user is placing the hold (or, alternatively, '.
3193 'at the pickup library) to encourage bypassing the hold placement and just ' .
3194 'checking out the item.' ,
3196 { desc => 'Authentication Token', type => 'string' },
3197 { desc => 'Method Arguments. Options include: hold_type, hold_target, org_unit. '
3198 . 'hold_type is the hold type code (T, V, C, M, ...). '
3199 . 'hold_target is the identifier of the hold target object. '
3200 . 'org_unit is org unit ID.',
3205 desc => q/Result hash like { "copy" : copy_id, "location" : location_name }, empty hash on misses, event on error./,
3211 sub hold_has_copy_at {
3212 my($self, $conn, $auth, $args) = @_;
3214 my $e = new_editor(authtoken=>$auth);
3215 $e->checkauth or return $e->event;
3217 my $hold_type = $$args{hold_type};
3218 my $hold_target = $$args{hold_target};
3219 my $org_unit = $$args{org_unit};
3222 select => {acp => ['id'], acpl => ['name']},
3225 acpl => {field => 'id', filter => { holdable => 't'}, fkey => 'location'},
3226 ccs => {field => 'id', filter => { holdable => 't'}, fkey => 'status' }
3229 where => {'+acp' => { circulate => 't', deleted => 'f', holdable => 't', circ_lib => $org_unit}},
3233 if($hold_type eq 'C') {
3235 $query->{where}->{'+acp'}->{id} = $hold_target;
3237 } elsif($hold_type eq 'V') {
3239 $query->{where}->{'+acp'}->{call_number} = $hold_target;
3241 } elsif($hold_type eq 'T') {
3243 $query->{from}->{acp}->{acn} = {
3245 fkey => 'call_number',
3249 filter => {id => $hold_target},
3257 $query->{from}->{acp}->{acn} = {
3259 fkey => 'call_number',
3268 filter => {metarecord => $hold_target},
3276 my $res = $e->json_query($query)->[0] or return {};
3277 return {copy => $res->{id}, location => $res->{name}} if $res;
3281 # returns true if the user already has an item checked out
3282 # that could be used to fulfill the requested hold.
3283 sub hold_item_is_checked_out {
3284 my($e, $user_id, $hold_type, $hold_target) = @_;
3287 select => {acp => ['id']},
3288 from => {acp => {}},
3292 in => { # copies for circs the user has checked out
3293 select => {circ => ['target_copy']},
3297 checkin_time => undef,
3299 {stop_fines => ["MAXFINES","LONGOVERDUE"]},
3300 {stop_fines => undef}
3310 if($hold_type eq 'C' || $hold_type eq 'R' || $hold_type eq 'F') {
3312 $query->{where}->{'+acp'}->{id}->{in}->{where}->{'target_copy'} = $hold_target;
3314 } elsif($hold_type eq 'V') {
3316 $query->{where}->{'+acp'}->{call_number} = $hold_target;
3318 } elsif($hold_type eq 'P') {
3320 $query->{from}->{acp}->{acpm} = {
3321 field => 'target_copy',
3323 filter => {part => $hold_target},
3326 } elsif($hold_type eq 'I') {
3328 $query->{from}->{acp}->{sitem} = {
3331 filter => {issuance => $hold_target},
3334 } elsif($hold_type eq 'T') {
3336 $query->{from}->{acp}->{acn} = {
3338 fkey => 'call_number',
3342 filter => {id => $hold_target},
3350 $query->{from}->{acp}->{acn} = {
3352 fkey => 'call_number',
3361 filter => {metarecord => $hold_target},
3369 return $e->json_query($query)->[0];
3372 __PACKAGE__->register_method(
3373 method => 'change_hold_title',
3374 api_name => 'open-ils.circ.hold.change_title',
3377 Updates all title level holds targeting the specified bibs to point a new bib./,
3379 { desc => 'Authentication Token', type => 'string' },
3380 { desc => 'New Target Bib Id', type => 'number' },
3381 { desc => 'Old Target Bib Ids', type => 'array' },
3383 return => { desc => '1 on success' }
3387 sub change_hold_title {
3388 my( $self, $client, $auth, $new_bib_id, $bib_ids ) = @_;
3390 my $e = new_editor(authtoken=>$auth, xact=>1);
3391 return $e->die_event unless $e->checkauth;
3393 my $holds = $e->search_action_hold_request(
3396 cancel_time => undef,
3397 fulfillment_time => undef,
3403 flesh_fields => { ahr => ['usr'] }
3409 for my $hold (@$holds) {
3410 $e->allowed('UPDATE_HOLD', $hold->usr->home_ou) or return $e->die_event;
3411 $logger->info("Changing hold " . $hold->id . " target from " . $hold->target . " to $new_bib_id in title hold target change");
3412 $hold->target( $new_bib_id );
3413 $e->update_action_hold_request($hold) or return $e->die_event;
3422 __PACKAGE__->register_method(
3423 method => 'rec_hold_count',
3424 api_name => 'open-ils.circ.bre.holds.count',
3426 desc => q/Returns the total number of holds that target the
3427 selected bib record or its associated copies and call_numbers/,
3429 { desc => 'Bib ID', type => 'number' },
3431 return => {desc => 'Hold count', type => 'number'}
3435 __PACKAGE__->register_method(
3436 method => 'rec_hold_count',
3437 api_name => 'open-ils.circ.mmr.holds.count',
3439 desc => q/Returns the total number of holds that target the
3440 selected metarecord or its associated copies, call_numbers, and bib records/,
3442 { desc => 'Metarecord ID', type => 'number' },
3444 return => {desc => 'Hold count', type => 'number'}
3448 # XXX Need to add type I (and, soon, type P) holds to these counts
3449 sub rec_hold_count {
3450 my($self, $conn, $target_id) = @_;
3457 filter => {metarecord => $target_id}
3464 filter => { id => $target_id },
3469 if($self->api_name =~ /mmr/) {
3470 delete $bre_join->{bre}->{filter};
3471 $bre_join->{bre}->{join} = $mmr_join;
3477 fkey => 'call_number',
3483 select => {ahr => [{column => 'id', transform => 'count', alias => 'count'}]},
3487 cancel_time => undef,
3488 fulfillment_time => undef,
3492 hold_type => [qw/C F R/],
3495 select => {acp => ['id']},
3496 from => { acp => $cn_join }
3506 select => {acn => ['id']},
3507 from => {acn => $bre_join}
3515 target => $target_id
3523 if($self->api_name =~ /mmr/) {
3524 $query->{where}->{'+ahr'}->{'-or'}->[2] = {
3529 select => {bre => ['id']},
3530 from => {bre => $mmr_join}
3536 $query->{where}->{'+ahr'}->{'-or'}->[3] = {
3539 target => $target_id
3545 return new_editor()->json_query($query)->[0]->{count};