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);
800 # --------------------------------------------------------------
801 # Code for making sure staff have appropriate permissons for cut_in_line
802 # This, as is, doesn't prevent a user from cutting their own holds in line
804 # --------------------------------------------------------------
805 if($U->is_true($hold->cut_in_line) ne $U->is_true($orig_hold->cut_in_line)) {
806 return $e->die_event unless $e->allowed('UPDATE_HOLD_REQUEST_TIME', $hold->pickup_lib);
809 # --------------------------------------------------------------
810 # if the hold is on the holds shelf or in transit and the pickup
811 # lib changes we need to create a new transit.
812 # --------------------------------------------------------------
813 if($orig_hold->pickup_lib ne $hold->pickup_lib) {
815 my $status = _hold_status($e, $hold);
817 if($status == 3) { # in transit
819 return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_TRANSIT', $orig_hold->pickup_lib);
820 return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_TRANSIT', $hold->pickup_lib);
822 $logger->info("updating pickup lib for hold ".$hold->id." while already in transit");
824 # update the transit to reflect the new pickup location
825 my $transit = $e->search_action_hold_transit_copy(
826 {hold=>$hold->id, dest_recv_time => undef})->[0]
827 or return $e->die_event;
829 $transit->prev_dest($transit->dest); # mark the previous destination on the transit
830 $transit->dest($hold->pickup_lib);
831 $e->update_action_hold_transit_copy($transit) or return $e->die_event;
833 } elsif($status == 4) { # on holds shelf
835 return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_HOLDS_SHELF', $orig_hold->pickup_lib);
836 return $e->die_event unless $e->allowed('UPDATE_PICKUP_LIB_FROM_HOLDS_SHELF', $hold->pickup_lib);
838 $logger->info("updating pickup lib for hold ".$hold->id." while on holds shelf");
840 # create the new transit
841 my $evt = transit_hold($e, $orig_hold, $hold, $e->retrieve_asset_copy($hold->current_copy));
846 update_hold_if_frozen($self, $e, $hold, $orig_hold);
847 $e->update_action_hold_request($hold) or return $e->die_event;
850 # a change to mint-condition changes the set of potential copies, so retarget the hold;
851 if($U->is_true($hold->mint_condition) and !$U->is_true($orig_hold->mint_condition)) {
852 _reset_hold($self, $e->requestor, $hold)
859 my($e, $orig_hold, $hold, $copy) = @_;
860 my $src = $orig_hold->pickup_lib;
861 my $dest = $hold->pickup_lib;
863 $logger->info("putting hold into transit on pickup_lib update");
865 my $transit = Fieldmapper::action::hold_transit_copy->new;
866 $transit->hold($hold->id);
867 $transit->source($src);
868 $transit->dest($dest);
869 $transit->target_copy($copy->id);
870 $transit->source_send_time('now');
871 $transit->copy_status(OILS_COPY_STATUS_ON_HOLDS_SHELF);
873 $copy->status(OILS_COPY_STATUS_IN_TRANSIT);
874 $copy->editor($e->requestor->id);
875 $copy->edit_date('now');
877 $e->create_action_hold_transit_copy($transit) or return $e->die_event;
878 $e->update_asset_copy($copy) or return $e->die_event;
882 # if the hold is frozen, this method ensures that the hold is not "targeted",
883 # that is, it clears the current_copy and prev_check_time to essentiallly
884 # reset the hold. If it is being activated, it runs the targeter in the background
885 sub update_hold_if_frozen {
886 my($self, $e, $hold, $orig_hold) = @_;
887 return if $hold->capture_time;
889 if($U->is_true($hold->frozen)) {
890 $logger->info("clearing current_copy and check_time for frozen hold ".$hold->id);
891 $hold->clear_current_copy;
892 $hold->clear_prev_check_time;
895 if($U->is_true($orig_hold->frozen)) {
896 $logger->info("Running targeter on activated hold ".$hold->id);
897 $U->storagereq( 'open-ils.storage.action.hold_request.copy_targeter', undef, $hold->id );
902 __PACKAGE__->register_method(
903 method => "hold_note_CUD",
904 api_name => "open-ils.circ.hold_request.note.cud",
906 desc => 'Create, update or delete a hold request note. If the operator (from Auth. token) '
907 . 'is not the owner of the hold, the UPDATE_HOLD permission is required',
909 { desc => 'Authentication token', type => 'string' },
910 { desc => 'Hold note object', type => 'object' }
913 desc => 'Returns the note ID, event on error'
919 my($self, $conn, $auth, $note) = @_;
921 my $e = new_editor(authtoken => $auth, xact => 1);
922 return $e->die_event unless $e->checkauth;
924 my $hold = $e->retrieve_action_hold_request($note->hold)
925 or return $e->die_event;
927 if($hold->usr ne $e->requestor->id) {
928 my $usr = $e->retrieve_actor_user($hold->usr);
929 return $e->die_event unless $e->allowed('UPDATE_HOLD', $usr->home_ou);
930 $note->staff('t') if $note->isnew;
934 $e->create_action_hold_request_note($note) or return $e->die_event;
935 } elsif($note->ischanged) {
936 $e->update_action_hold_request_note($note) or return $e->die_event;
937 } elsif($note->isdeleted) {
938 $e->delete_action_hold_request_note($note) or return $e->die_event;
946 __PACKAGE__->register_method(
947 method => "retrieve_hold_status",
948 api_name => "open-ils.circ.hold.status.retrieve",
950 desc => 'Calculates the current status of the hold. The requestor must have ' .
951 'VIEW_HOLD permissions if the hold is for a user other than the requestor' ,
953 { desc => 'Hold ID', type => 'number' }
956 # type => 'number', # event sometimes
957 desc => <<'END_OF_DESC'
958 Returns event on error or:
959 -1 on error (for now),
960 1 for 'waiting for copy to become available',
961 2 for 'waiting for copy capture',
964 5 for 'hold-shelf-delay'
971 sub retrieve_hold_status {
972 my($self, $client, $auth, $hold_id) = @_;
974 my $e = new_editor(authtoken => $auth);
975 return $e->event unless $e->checkauth;
976 my $hold = $e->retrieve_action_hold_request($hold_id)
979 if( $e->requestor->id != $hold->usr ) {
980 return $e->event unless $e->allowed('VIEW_HOLD');
983 return _hold_status($e, $hold);
989 if ($hold->cancel_time) {
992 return 1 unless $hold->current_copy;
993 return 2 unless $hold->capture_time;
995 my $copy = $hold->current_copy;
996 unless( ref $copy ) {
997 $copy = $e->retrieve_asset_copy($hold->current_copy)
1001 return 3 if $copy->status == OILS_COPY_STATUS_IN_TRANSIT;
1003 if($copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF) {
1005 my $hs_wait_interval = $U->ou_ancestor_setting_value($hold->pickup_lib, 'circ.hold_shelf_status_delay');
1006 return 4 unless $hs_wait_interval;
1008 # if a hold_shelf_status_delay interval is defined and start_time plus
1009 # the interval is greater than now, consider the hold to be in the virtual
1010 # "on its way to the holds shelf" status. Return 5.
1012 my $transit = $e->search_action_hold_transit_copy({hold => $hold->id})->[0];
1013 my $start_time = ($transit) ? $transit->dest_recv_time : $hold->capture_time;
1014 $start_time = DateTime::Format::ISO8601->new->parse_datetime(cleanse_ISO8601($start_time));
1015 my $end_time = $start_time->add(seconds => OpenSRF::Utils::interval_to_seconds($hs_wait_interval));
1017 return 5 if $end_time > DateTime->now;
1026 __PACKAGE__->register_method(
1027 method => "retrieve_hold_queue_stats",
1028 api_name => "open-ils.circ.hold.queue_stats.retrieve",
1030 desc => 'Returns summary data about the state of a hold',
1032 { desc => 'Authentication token', type => 'string'},
1033 { desc => 'Hold ID', type => 'number'},
1036 desc => q/Summary object with keys:
1037 total_holds : total holds in queue
1038 queue_position : current queue position
1039 potential_copies : number of potential copies for this hold
1040 estimated_wait : estimated wait time in days
1041 status : hold status
1042 -1 => error or unexpected state,
1043 1 => 'waiting for copy to become available',
1044 2 => 'waiting for copy capture',
1047 5 => 'hold-shelf-delay'
1054 sub retrieve_hold_queue_stats {
1055 my($self, $conn, $auth, $hold_id) = @_;
1056 my $e = new_editor(authtoken => $auth);
1057 return $e->event unless $e->checkauth;
1058 my $hold = $e->retrieve_action_hold_request($hold_id) or return $e->event;
1059 if($e->requestor->id != $hold->usr) {
1060 return $e->event unless $e->allowed('VIEW_HOLD');
1062 return retrieve_hold_queue_status_impl($e, $hold);
1065 sub retrieve_hold_queue_status_impl {
1069 # The holds queue is defined as the distinct set of holds that share at
1070 # least one potential copy with the context hold, plus any holds that
1071 # share the same hold type and target. The latter part exists to
1072 # accomodate holds that currently have no potential copies
1073 my $q_holds = $e->json_query({
1075 # fetch cut_in_line and request_time since they're in the order_by
1076 # and we're asking for distinct values
1077 select => {ahr => ['id', 'cut_in_line', 'request_time']},
1084 'field' => 'target_copy',
1085 'fkey' => 'target_copy'
1094 "field" => "cut_in_line",
1095 "transform" => "coalesce",
1097 "direction" => "desc"
1099 { "class" => "ahr", "field" => "request_time" }
1103 '+ahcm2' => { hold => $hold->id }
1107 if (!@$q_holds) { # none? maybe we don't have a map ...
1108 $q_holds = $e->json_query({
1109 select => {ahr => ['id', 'cut_in_line', 'request_time']},
1114 "field" => "cut_in_line",
1115 "transform" => "coalesce",
1117 "direction" => "desc"
1119 { "class" => "ahr", "field" => "request_time" }
1122 hold_type => $hold->hold_type,
1123 target => $hold->target
1130 for my $h (@$q_holds) {
1131 last if $h->{id} == $hold->id;
1135 my $hold_data = $e->json_query({
1137 acp => [ {column => 'id', transform => 'count', aggregate => 1, alias => 'count'} ],
1138 ccm => [ {column =>'avg_wait_time'} ]
1144 ccm => {type => 'left'}
1149 where => {'+ahcm' => {hold => $hold->id} }
1152 my $user_org = $e->json_query({select => {au => ['home_ou']}, from => 'au', where => {id => $hold->usr}})->[0]->{home_ou};
1154 my $default_wait = $U->ou_ancestor_setting_value($user_org, OILS_SETTING_HOLD_ESIMATE_WAIT_INTERVAL);
1155 my $min_wait = $U->ou_ancestor_setting_value($user_org, 'circ.holds.min_estimated_wait_interval');
1156 $min_wait = OpenSRF::Utils::interval_to_seconds($min_wait || '0 seconds');
1157 $default_wait ||= '0 seconds';
1159 # Estimated wait time is the average wait time across the set
1160 # of potential copies, divided by the number of potential copies
1161 # times the queue position.
1163 my $combined_secs = 0;
1164 my $num_potentials = 0;
1166 for my $wait_data (@$hold_data) {
1167 my $count += $wait_data->{count};
1168 $combined_secs += $count *
1169 OpenSRF::Utils::interval_to_seconds($wait_data->{avg_wait_time} || $default_wait);
1170 $num_potentials += $count;
1173 my $estimated_wait = -1;
1175 if($num_potentials) {
1176 my $avg_wait = $combined_secs / $num_potentials;
1177 $estimated_wait = $qpos * ($avg_wait / $num_potentials);
1178 $estimated_wait = $min_wait if $estimated_wait < $min_wait and $estimated_wait != -1;
1182 total_holds => scalar(@$q_holds),
1183 queue_position => $qpos,
1184 potential_copies => $num_potentials,
1185 status => _hold_status( $e, $hold ),
1186 estimated_wait => int($estimated_wait)
1191 sub fetch_open_hold_by_current_copy {
1194 my $hold = $apputils->simplereq(
1196 'open-ils.cstore.direct.action.hold_request.search.atomic',
1197 { current_copy => $copyid , cancel_time => undef, fulfillment_time => undef });
1198 return $hold->[0] if ref($hold);
1202 sub fetch_related_holds {
1205 return $apputils->simplereq(
1207 'open-ils.cstore.direct.action.hold_request.search.atomic',
1208 { current_copy => $copyid , cancel_time => undef, fulfillment_time => undef });
1212 __PACKAGE__->register_method(
1213 method => "hold_pull_list",
1214 api_name => "open-ils.circ.hold_pull_list.retrieve",
1216 desc => 'Returns (reference to) a list of holds that need to be "pulled" by a given location. ' .
1217 'The location is determined by the login session.',
1219 { desc => 'Limit (optional)', type => 'number'},
1220 { desc => 'Offset (optional)', type => 'number'},
1223 desc => 'reference to a list of holds, or event on failure',
1228 __PACKAGE__->register_method(
1229 method => "hold_pull_list",
1230 api_name => "open-ils.circ.hold_pull_list.id_list.retrieve",
1232 desc => 'Returns (reference to) a list of holds IDs that need to be "pulled" by a given location. ' .
1233 'The location is determined by the login session.',
1235 { desc => 'Limit (optional)', type => 'number'},
1236 { desc => 'Offset (optional)', type => 'number'},
1239 desc => 'reference to a list of holds, or event on failure',
1244 __PACKAGE__->register_method(
1245 method => "hold_pull_list",
1246 api_name => "open-ils.circ.hold_pull_list.retrieve.count",
1248 desc => 'Returns a count of holds that need to be "pulled" by a given location. ' .
1249 'The location is determined by the login session.',
1251 { desc => 'Limit (optional)', type => 'number'},
1252 { desc => 'Offset (optional)', type => 'number'},
1255 desc => 'Holds count (integer), or event on failure',
1262 sub hold_pull_list {
1263 my( $self, $conn, $authtoken, $limit, $offset ) = @_;
1264 my( $reqr, $evt ) = $U->checkses($authtoken);
1265 return $evt if $evt;
1267 my $org = $reqr->ws_ou || $reqr->home_ou;
1268 # the perm locaiton shouldn't really matter here since holds
1269 # will exist all over and VIEW_HOLDS should be universal
1270 $evt = $U->check_perms($reqr->id, $org, 'VIEW_HOLD');
1271 return $evt if $evt;
1273 if($self->api_name =~ /count/) {
1275 my $count = $U->storagereq(
1276 'open-ils.storage.direct.action.hold_request.pull_list.current_copy_circ_lib.status_filtered.count',
1277 $org, $limit, $offset );
1279 $logger->info("Grabbing pull list for org unit $org with $count items");
1282 } elsif( $self->api_name =~ /id_list/ ) {
1283 return $U->storagereq(
1284 'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib.status_filtered.atomic',
1285 $org, $limit, $offset );
1288 return $U->storagereq(
1289 'open-ils.storage.direct.action.hold_request.pull_list.search.current_copy_circ_lib.status_filtered.atomic',
1290 $org, $limit, $offset );
1294 __PACKAGE__->register_method(
1295 method => "print_hold_pull_list",
1296 api_name => "open-ils.circ.hold_pull_list.print",
1298 desc => 'Returns an HTML-formatted holds pull list',
1300 { desc => 'Authtoken', type => 'string'},
1301 { desc => 'Org unit ID. Optional, defaults to workstation org unit', type => 'number'},
1304 desc => 'HTML string',
1310 sub print_hold_pull_list {
1311 my($self, $client, $auth, $org_id) = @_;
1313 my $e = new_editor(authtoken=>$auth);
1314 return $e->event unless $e->checkauth;
1316 $org_id = (defined $org_id) ? $org_id : $e->requestor->ws_ou;
1317 return $e->event unless $e->allowed('VIEW_HOLD', $org_id);
1319 my $hold_ids = $U->storagereq(
1320 'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib.status_filtered.atomic',
1323 return undef unless @$hold_ids;
1325 $client->status(new OpenSRF::DomainObject::oilsContinueStatus);
1327 # Holds will /NOT/ be in order after this ...
1328 my $holds = $e->search_action_hold_request({id => $hold_ids}, {substream => 1});
1329 $client->status(new OpenSRF::DomainObject::oilsContinueStatus);
1331 # ... so we must resort.
1332 my $hold_map = +{map { $_->id => $_ } @$holds};
1333 my $sorted_holds = [];
1334 push @$sorted_holds, $hold_map->{$_} foreach @$hold_ids;
1336 return $U->fire_object_event(
1337 undef, "ahr.format.pull_list", $sorted_holds,
1338 $org_id, undef, undef, $client
1343 __PACKAGE__->register_method(
1344 method => "print_hold_pull_list_stream",
1346 api_name => "open-ils.circ.hold_pull_list.print.stream",
1348 desc => 'Returns a stream of fleshed holds',
1350 { desc => 'Authtoken', type => 'string'},
1351 { desc => 'Hash of optional param: Org unit ID (defaults to workstation org unit), limit, offset, sort (array of: acplo.position, call_number, request_time)',
1356 desc => 'A stream of fleshed holds',
1362 sub print_hold_pull_list_stream {
1363 my($self, $client, $auth, $params) = @_;
1365 my $e = new_editor(authtoken=>$auth);
1366 return $e->die_event unless $e->checkauth;
1368 delete($$params{org_id}) unless (int($$params{org_id}));
1369 delete($$params{limit}) unless (int($$params{limit}));
1370 delete($$params{offset}) unless (int($$params{offset}));
1371 delete($$params{chunk_size}) unless (int($$params{chunk_size}));
1372 delete($$params{chunk_size}) if ($$params{chunk_size} && $$params{chunk_size} > 50); # keep the size reasonable
1373 $$params{chunk_size} ||= 10;
1375 $$params{org_id} = (defined $$params{org_id}) ? $$params{org_id}: $e->requestor->ws_ou;
1376 return $e->die_event unless $e->allowed('VIEW_HOLD', $$params{org_id });
1379 if ($$params{sort} && @{ $$params{sort} }) {
1380 for my $s (@{ $$params{sort} }) {
1381 if ($s eq 'acplo.position') {
1383 "class" => "acplo", "field" => "position",
1384 "transform" => "coalesce", "params" => [999]
1386 } elsif ($s eq 'call_number') {
1387 push @$sort, {"class" => "acn", "field" => "label"};
1388 } elsif ($s eq 'request_time') {
1389 push @$sort, {"class" => "ahr", "field" => "request_time"};
1393 push @$sort, {"class" => "ahr", "field" => "request_time"};
1396 my $holds_ids = $e->json_query(
1398 "select" => {"ahr" => ["id"]},
1403 "fkey" => "current_copy",
1405 "circ_lib" => $$params{org_id}, "status" => [0,7]
1410 "fkey" => "call_number"
1414 "fkey" => "circ_lib",
1417 "location" => {"=" => {"+acp" => "location"}}
1426 "capture_time" => undef,
1427 "cancel_time" => undef,
1429 {"expire_time" => undef },
1430 {"expire_time" => {">" => "now"}}
1434 (@$sort ? (order_by => $sort) : ()),
1435 ($$params{limit} ? (limit => $$params{limit}) : ()),
1436 ($$params{offset} ? (offset => $$params{offset}) : ())
1437 }, {"substream" => 1}
1438 ) or return $e->die_event;
1440 $logger->info("about to stream back " . scalar(@$holds_ids) . " holds");
1443 for my $hid (@$holds_ids) {
1444 push @chunk, $e->retrieve_action_hold_request([
1448 "ahr" => ["usr", "current_copy"],
1450 "acp" => ["location", "call_number"],
1456 if (@chunk >= $$params{chunk_size}) {
1457 $client->respond( \@chunk );
1461 $client->respond_complete( \@chunk ) if (@chunk);
1468 __PACKAGE__->register_method(
1469 method => 'fetch_hold_notify',
1470 api_name => 'open-ils.circ.hold_notification.retrieve_by_hold',
1473 Returns a list of hold notification objects based on hold id.
1474 @param authtoken The loggin session key
1475 @param holdid The id of the hold whose notifications we want to retrieve
1476 @return An array of hold notification objects, event on error.
1480 sub fetch_hold_notify {
1481 my( $self, $conn, $authtoken, $holdid ) = @_;
1482 my( $requestor, $evt ) = $U->checkses($authtoken);
1483 return $evt if $evt;
1484 my ($hold, $patron);
1485 ($hold, $evt) = $U->fetch_hold($holdid);
1486 return $evt if $evt;
1487 ($patron, $evt) = $U->fetch_user($hold->usr);
1488 return $evt if $evt;
1490 $evt = $U->check_perms($requestor->id, $patron->home_ou, 'VIEW_HOLD_NOTIFICATION');
1491 return $evt if $evt;
1493 $logger->info("User ".$requestor->id." fetching hold notifications for hold $holdid");
1494 return $U->cstorereq(
1495 'open-ils.cstore.direct.action.hold_notification.search.atomic', {hold => $holdid} );
1499 __PACKAGE__->register_method(
1500 method => 'create_hold_notify',
1501 api_name => 'open-ils.circ.hold_notification.create',
1503 Creates a new hold notification object
1504 @param authtoken The login session key
1505 @param notification The hold notification object to create
1506 @return ID of the new object on success, Event on error
1510 sub create_hold_notify {
1511 my( $self, $conn, $auth, $note ) = @_;
1512 my $e = new_editor(authtoken=>$auth, xact=>1);
1513 return $e->die_event unless $e->checkauth;
1515 my $hold = $e->retrieve_action_hold_request($note->hold)
1516 or return $e->die_event;
1517 my $patron = $e->retrieve_actor_user($hold->usr)
1518 or return $e->die_event;
1520 return $e->die_event unless
1521 $e->allowed('CREATE_HOLD_NOTIFICATION', $patron->home_ou);
1523 $note->notify_staff($e->requestor->id);
1524 $e->create_action_hold_notification($note) or return $e->die_event;
1529 __PACKAGE__->register_method(
1530 method => 'create_hold_note',
1531 api_name => 'open-ils.circ.hold_note.create',
1533 Creates a new hold request note object
1534 @param authtoken The login session key
1535 @param note The hold note object to create
1536 @return ID of the new object on success, Event on error
1540 sub create_hold_note {
1541 my( $self, $conn, $auth, $note ) = @_;
1542 my $e = new_editor(authtoken=>$auth, xact=>1);
1543 return $e->die_event unless $e->checkauth;
1545 my $hold = $e->retrieve_action_hold_request($note->hold)
1546 or return $e->die_event;
1547 my $patron = $e->retrieve_actor_user($hold->usr)
1548 or return $e->die_event;
1550 return $e->die_event unless
1551 $e->allowed('UPDATE_HOLD', $patron->home_ou); # FIXME: Using permcrud perm listed in fm_IDL.xml for ahrn. Probably want something more specific
1553 $e->create_action_hold_request_note($note) or return $e->die_event;
1558 __PACKAGE__->register_method(
1559 method => 'reset_hold',
1560 api_name => 'open-ils.circ.hold.reset',
1562 Un-captures and un-targets a hold, essentially returning
1563 it to the state it was in directly after it was placed,
1564 then attempts to re-target the hold
1565 @param authtoken The login session key
1566 @param holdid The id of the hold
1572 my( $self, $conn, $auth, $holdid ) = @_;
1574 my ($hold, $evt) = $U->fetch_hold($holdid);
1575 return $evt if $evt;
1576 ($reqr, $evt) = $U->checksesperm($auth, 'UPDATE_HOLD');
1577 return $evt if $evt;
1578 $evt = _reset_hold($self, $reqr, $hold);
1579 return $evt if $evt;
1584 __PACKAGE__->register_method(
1585 method => 'reset_hold_batch',
1586 api_name => 'open-ils.circ.hold.reset.batch'
1589 sub reset_hold_batch {
1590 my($self, $conn, $auth, $hold_ids) = @_;
1592 my $e = new_editor(authtoken => $auth);
1593 return $e->event unless $e->checkauth;
1595 for my $hold_id ($hold_ids) {
1597 my $hold = $e->retrieve_action_hold_request(
1598 [$hold_id, {flesh => 1, flesh_fields => {ahr => ['usr']}}])
1599 or return $e->event;
1601 next unless $e->allowed('UPDATE_HOLD', $hold->usr->home_ou);
1602 _reset_hold($self, $e->requestor, $hold);
1610 my ($self, $reqr, $hold) = @_;
1612 my $e = new_editor(xact =>1, requestor => $reqr);
1614 $logger->info("reseting hold ".$hold->id);
1616 my $hid = $hold->id;
1618 if( $hold->capture_time and $hold->current_copy ) {
1620 my $copy = $e->retrieve_asset_copy($hold->current_copy)
1621 or return $e->die_event;
1623 if( $copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF ) {
1624 $logger->info("setting copy to status 'reshelving' on hold retarget");
1625 $copy->status(OILS_COPY_STATUS_RESHELVING);
1626 $copy->editor($e->requestor->id);
1627 $copy->edit_date('now');
1628 $e->update_asset_copy($copy) or return $e->die_event;
1630 } elsif( $copy->status == OILS_COPY_STATUS_IN_TRANSIT ) {
1632 # We don't want the copy to remain "in transit"
1633 $copy->status(OILS_COPY_STATUS_RESHELVING);
1634 $logger->warn("! reseting hold [$hid] that is in transit");
1635 my $transid = $e->search_action_hold_transit_copy({hold=>$hold->id},{idlist=>1})->[0];
1638 my $trans = $e->retrieve_action_transit_copy($transid);
1640 $logger->info("Aborting transit [$transid] on hold [$hid] reset...");
1641 my $evt = OpenILS::Application::Circ::Transit::__abort_transit($e, $trans, $copy, 1);
1642 $logger->info("Transit abort completed with result $evt");
1643 unless ("$evt" eq 1) {
1652 $hold->clear_capture_time;
1653 $hold->clear_current_copy;
1654 $hold->clear_shelf_time;
1655 $hold->clear_shelf_expire_time;
1657 $e->update_action_hold_request($hold) or return $e->die_event;
1661 'open-ils.storage.action.hold_request.copy_targeter', undef, $hold->id );
1667 __PACKAGE__->register_method(
1668 method => 'fetch_open_title_holds',
1669 api_name => 'open-ils.circ.open_holds.retrieve',
1671 Returns a list ids of un-fulfilled holds for a given title id
1672 @param authtoken The login session key
1673 @param id the id of the item whose holds we want to retrieve
1674 @param type The hold type - M, T, I, V, C, F, R
1678 sub fetch_open_title_holds {
1679 my( $self, $conn, $auth, $id, $type, $org ) = @_;
1680 my $e = new_editor( authtoken => $auth );
1681 return $e->event unless $e->checkauth;
1684 $org ||= $e->requestor->ws_ou;
1686 # return $e->search_action_hold_request(
1687 # { target => $id, hold_type => $type, fulfillment_time => undef }, {idlist=>1});
1689 # XXX make me return IDs in the future ^--
1690 my $holds = $e->search_action_hold_request(
1693 cancel_time => undef,
1695 fulfillment_time => undef
1699 flesh_hold_transits($holds);
1704 sub flesh_hold_transits {
1706 for my $hold ( @$holds ) {
1708 $apputils->simplereq(
1710 "open-ils.cstore.direct.action.hold_transit_copy.search.atomic",
1711 { hold => $hold->id },
1712 { order_by => { ahtc => 'id desc' }, limit => 1 }
1718 sub flesh_hold_notices {
1719 my( $holds, $e ) = @_;
1720 $e ||= new_editor();
1722 for my $hold (@$holds) {
1723 my $notices = $e->search_action_hold_notification(
1725 { hold => $hold->id },
1726 { order_by => { anh => 'notify_time desc' } },
1731 $hold->notify_count(scalar(@$notices));
1733 my $n = $e->retrieve_action_hold_notification($$notices[0])
1734 or return $e->event;
1735 $hold->notify_time($n->notify_time);
1741 __PACKAGE__->register_method(
1742 method => 'fetch_captured_holds',
1743 api_name => 'open-ils.circ.captured_holds.on_shelf.retrieve',
1746 Returns a list of un-fulfilled holds (on the Holds Shelf) for a given title id
1747 @param authtoken The login session key
1748 @param org The org id of the location in question
1752 __PACKAGE__->register_method(
1753 method => 'fetch_captured_holds',
1754 api_name => 'open-ils.circ.captured_holds.id_list.on_shelf.retrieve',
1757 Returns list ids of un-fulfilled holds (on the Holds Shelf) for a given title id
1758 @param authtoken The login session key
1759 @param org The org id of the location in question
1763 __PACKAGE__->register_method(
1764 method => 'fetch_captured_holds',
1765 api_name => 'open-ils.circ.captured_holds.id_list.expired_on_shelf.retrieve',
1768 Returns list ids of shelf-expired un-fulfilled holds for a given title id
1769 @param authtoken The login session key
1770 @param org The org id of the location in question
1775 sub fetch_captured_holds {
1776 my( $self, $conn, $auth, $org ) = @_;
1778 my $e = new_editor(authtoken => $auth);
1779 return $e->die_event unless $e->checkauth;
1780 return $e->die_event unless $e->allowed('VIEW_HOLD'); # XXX rely on editor perm
1782 $org ||= $e->requestor->ws_ou;
1785 select => { ahr => ['id'] },
1790 fkey => 'current_copy'
1795 '+acp' => { status => OILS_COPY_STATUS_ON_HOLDS_SHELF },
1797 capture_time => { "!=" => undef },
1798 current_copy => { "!=" => undef },
1799 fulfillment_time => undef,
1801 cancel_time => undef,
1805 if($self->api_name =~ /expired/) {
1806 $query->{'where'}->{'+ahr'}->{'shelf_expire_time'} = {'<' => 'now'};
1807 $query->{'where'}->{'+ahr'}->{'shelf_time'} = {'!=' => undef};
1809 my $hold_ids = $e->json_query( $query );
1811 for my $hold_id (@$hold_ids) {
1812 if($self->api_name =~ /id_list/) {
1813 $conn->respond($hold_id->{id});
1817 $e->retrieve_action_hold_request([
1821 flesh_fields => {ahr => ['notifications', 'transit', 'notes']},
1822 order_by => {anh => 'notify_time desc'}
1832 __PACKAGE__->register_method(
1833 method => "print_expired_holds_stream",
1834 api_name => "open-ils.circ.captured_holds.expired.print.stream",
1838 sub print_expired_holds_stream {
1839 my ($self, $client, $auth, $params) = @_;
1841 # No need to check specific permissions: we're going to call another method
1842 # that will do that.
1843 my $e = new_editor("authtoken" => $auth);
1844 return $e->die_event unless $e->checkauth;
1846 delete($$params{org_id}) unless (int($$params{org_id}));
1847 delete($$params{limit}) unless (int($$params{limit}));
1848 delete($$params{offset}) unless (int($$params{offset}));
1849 delete($$params{chunk_size}) unless (int($$params{chunk_size}));
1850 delete($$params{chunk_size}) if ($$params{chunk_size} && $$params{chunk_size} > 50); # keep the size reasonable
1851 $$params{chunk_size} ||= 10;
1853 $$params{org_id} = (defined $$params{org_id}) ? $$params{org_id}: $e->requestor->ws_ou;
1855 my @hold_ids = $self->method_lookup(
1856 "open-ils.circ.captured_holds.id_list.expired_on_shelf.retrieve"
1857 )->run($auth, $params->{"org_id"});
1862 } elsif (defined $U->event_code($hold_ids[0])) {
1864 return $hold_ids[0];
1867 $logger->info("about to stream back up to " . scalar(@hold_ids) . " expired holds");
1870 my @hid_chunk = splice @hold_ids, 0, $params->{"chunk_size"};
1872 my $result_chunk = $e->json_query({
1874 "acp" => ["barcode"],
1876 first_given_name second_given_name family_name alias
1885 "field" => "id", "fkey" => "current_copy",
1888 "field" => "id", "fkey" => "call_number",
1891 "field" => "id", "fkey" => "record"
1895 "acpl" => {"field" => "id", "fkey" => "location"}
1898 "au" => {"field" => "id", "fkey" => "usr"}
1901 "where" => {"+ahr" => {"id" => \@hid_chunk}}
1902 }) or return $e->die_event;
1903 $client->respond($result_chunk);
1910 __PACKAGE__->register_method(
1911 method => "check_title_hold_batch",
1912 api_name => "open-ils.circ.title_hold.is_possible.batch",
1915 desc => '@see open-ils.circ.title_hold.is_possible.batch',
1917 { desc => 'Authentication token', type => 'string'},
1918 { desc => 'Array of Hash of named parameters', type => 'array'},
1921 desc => 'Array of response objects',
1927 sub check_title_hold_batch {
1928 my($self, $client, $authtoken, $param_list) = @_;
1929 foreach (@$param_list) {
1930 my ($res) = $self->method_lookup('open-ils.circ.title_hold.is_possible')->run($authtoken, $_);
1931 $client->respond($res);
1937 __PACKAGE__->register_method(
1938 method => "check_title_hold",
1939 api_name => "open-ils.circ.title_hold.is_possible",
1941 desc => 'Determines if a hold were to be placed by a given user, ' .
1942 'whether or not said hold would have any potential copies to fulfill it.' .
1943 'The named paramaters of the second argument include: ' .
1944 'patronid, titleid, volume_id, copy_id, mrid, depth, pickup_lib, hold_type, selection_ou. ' .
1945 'See perldoc ' . __PACKAGE__ . ' for more info on these fields.' ,
1947 { desc => 'Authentication token', type => 'string'},
1948 { desc => 'Hash of named parameters', type => 'object'},
1951 desc => 'List of new message IDs (empty if none)',
1957 =head3 check_title_hold (token, hash)
1959 The named fields in the hash are:
1961 patronid - ID of the hold recipient (required)
1962 depth - hold range depth (default 0)
1963 pickup_lib - destination for hold, fallback value for selection_ou
1964 selection_ou - ID of org_unit establishing hard and soft hold boundary settings
1965 issuanceid - ID of the issuance to be held, required for Issuance level hold
1966 partid - ID of the monograph part to be held, required for monograph part level hold
1967 titleid - ID (BRN) of the title to be held, required for Title level hold
1968 volume_id - required for Volume level hold
1969 copy_id - required for Copy level hold
1970 mrid - required for Meta-record level hold
1971 hold_type - T, C (or R or F), I, V or M for Title, Copy, Issuance, Volume or Meta-record (default "T")
1973 All key/value pairs are passed on to do_possibility_checks.
1977 # FIXME: better params checking. what other params are required, if any?
1978 # FIXME: 3 copies of values confusing: $x, $params->{x} and $params{x}
1979 # FIXME: for example, $depth gets a default value, but then $$params{depth} is still
1980 # used in conditionals, where it may be undefined, causing a warning.
1981 # FIXME: specify proper usage/interaction of selection_ou and pickup_lib
1983 sub check_title_hold {
1984 my( $self, $client, $authtoken, $params ) = @_;
1985 my $e = new_editor(authtoken=>$authtoken);
1986 return $e->event unless $e->checkauth;
1988 my %params = %$params;
1989 my $depth = $params{depth} || 0;
1990 my $selection_ou = $params{selection_ou} || $params{pickup_lib};
1992 my $patron = $e->retrieve_actor_user($params{patronid})
1993 or return $e->event;
1995 if( $e->requestor->id ne $patron->id ) {
1996 return $e->event unless
1997 $e->allowed('VIEW_HOLD_PERMIT', $patron->home_ou);
2000 return OpenILS::Event->new('PATRON_BARRED') if $U->is_true($patron->barred);
2002 my $request_lib = $e->retrieve_actor_org_unit($e->requestor->ws_ou)
2003 or return $e->event;
2005 my $soft_boundary = $U->ou_ancestor_setting_value($selection_ou, OILS_SETTING_HOLD_SOFT_BOUNDARY);
2006 my $hard_boundary = $U->ou_ancestor_setting_value($selection_ou, OILS_SETTING_HOLD_HARD_BOUNDARY);
2009 my $return_depth = $hard_boundary; # default depth to return on success
2010 if(defined $soft_boundary and $depth < $soft_boundary) {
2011 # work up the tree and as soon as we find a potential copy, use that depth
2012 # also, make sure we don't go past the hard boundary if it exists
2014 # our min boundary is the greater of user-specified boundary or hard boundary
2015 my $min_depth = (defined $hard_boundary and $hard_boundary > $depth) ?
2016 $hard_boundary : $depth;
2018 my $depth = $soft_boundary;
2019 while($depth >= $min_depth) {
2020 $logger->info("performing hold possibility check with soft boundary $depth");
2021 @status = do_possibility_checks($e, $patron, $request_lib, $depth, %params);
2023 $return_depth = $depth;
2028 } elsif(defined $hard_boundary and $depth < $hard_boundary) {
2029 # there is no soft boundary, enforce the hard boundary if it exists
2030 $logger->info("performing hold possibility check with hard boundary $hard_boundary");
2031 @status = do_possibility_checks($e, $patron, $request_lib, $hard_boundary, %params);
2033 # no boundaries defined, fall back to user specifed boundary or no boundary
2034 $logger->info("performing hold possibility check with no boundary");
2035 @status = do_possibility_checks($e, $patron, $request_lib, $params{depth}, %params);
2041 "depth" => $return_depth,
2042 "local_avail" => $status[1]
2044 } elsif ($status[2]) {
2045 my $n = scalar @{$status[2]};
2046 return {"success" => 0, "last_event" => $status[2]->[$n - 1]};
2048 return {"success" => 0};
2054 sub do_possibility_checks {
2055 my($e, $patron, $request_lib, $depth, %params) = @_;
2057 my $issuanceid = $params{issuanceid} || "";
2058 my $partid = $params{partid} || "";
2059 my $titleid = $params{titleid} || "";
2060 my $volid = $params{volume_id};
2061 my $copyid = $params{copy_id};
2062 my $mrid = $params{mrid} || "";
2063 my $pickup_lib = $params{pickup_lib};
2064 my $hold_type = $params{hold_type} || 'T';
2065 my $selection_ou = $params{selection_ou} || $pickup_lib;
2072 if( $hold_type eq OILS_HOLD_TYPE_FORCE || $hold_type eq OILS_HOLD_TYPE_RECALL || $hold_type eq OILS_HOLD_TYPE_COPY ) {
2074 return $e->event unless $copy = $e->retrieve_asset_copy($copyid);
2075 return $e->event unless $volume = $e->retrieve_asset_call_number($copy->call_number);
2076 return $e->event unless $title = $e->retrieve_biblio_record_entry($volume->record);
2078 return verify_copy_for_hold(
2079 $patron, $e->requestor, $title, $copy, $pickup_lib, $request_lib
2082 } elsif( $hold_type eq OILS_HOLD_TYPE_VOLUME ) {
2084 return $e->event unless $volume = $e->retrieve_asset_call_number($volid);
2085 return $e->event unless $title = $e->retrieve_biblio_record_entry($volume->record);
2087 return _check_volume_hold_is_possible(
2088 $volume, $title, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou
2091 } elsif( $hold_type eq OILS_HOLD_TYPE_TITLE ) {
2093 return _check_title_hold_is_possible(
2094 $titleid, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou
2097 } elsif( $hold_type eq OILS_HOLD_TYPE_ISSUANCE ) {
2099 return _check_issuance_hold_is_possible(
2100 $issuanceid, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou
2103 } elsif( $hold_type eq OILS_HOLD_TYPE_MONOPART ) {
2105 return _check_monopart_hold_is_possible(
2106 $partid, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou
2109 } elsif( $hold_type eq OILS_HOLD_TYPE_METARECORD ) {
2111 my $maps = $e->search_metabib_metarecord_source_map({metarecord=>$mrid});
2112 my @recs = map { $_->source } @$maps;
2114 for my $rec (@recs) {
2115 @status = _check_title_hold_is_possible(
2116 $rec, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou
2122 # else { Unrecognized hold_type ! } # FIXME: return error? or 0?
2126 sub create_ranged_org_filter {
2127 my($e, $selection_ou, $depth) = @_;
2129 # find the orgs from which this hold may be fulfilled,
2130 # based on the selection_ou and depth
2132 my $top_org = $e->search_actor_org_unit([
2133 {parent_ou => undef},
2134 {flesh=>1, flesh_fields=>{aou=>['ou_type']}}])->[0];
2137 return () if $depth == $top_org->ou_type->depth;
2139 my $org_list = $U->storagereq('open-ils.storage.actor.org_unit.descendants.atomic', $selection_ou, $depth);
2140 %org_filter = (circ_lib => []);
2141 push(@{$org_filter{circ_lib}}, $_->id) for @$org_list;
2143 $logger->info("hold org filter at depth $depth and selection_ou ".
2144 "$selection_ou created list of @{$org_filter{circ_lib}}");
2150 sub _check_title_hold_is_possible {
2151 my( $titleid, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou ) = @_;
2153 my $e = new_editor();
2154 my %org_filter = create_ranged_org_filter($e, $selection_ou, $depth);
2156 # this monster will grab the id and circ_lib of all of the "holdable" copies for the given record
2157 my $copies = $e->json_query(
2159 select => { acp => ['id', 'circ_lib'] },
2164 fkey => 'call_number',
2168 filter => { id => $titleid },
2173 acpl => { field => 'id', filter => { holdable => 't'}, fkey => 'location' },
2174 ccs => { field => 'id', filter => { holdable => 't'}, fkey => 'status' }
2178 '+acp' => { circulate => 't', deleted => 'f', holdable => 't', %org_filter }
2183 $logger->info("title possible found ".scalar(@$copies)." potential copies");
2187 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2188 "payload" => {"fail_part" => "no_ultimate_items"}
2193 # -----------------------------------------------------------------------
2194 # sort the copies into buckets based on their circ_lib proximity to
2195 # the patron's home_ou.
2196 # -----------------------------------------------------------------------
2198 my $home_org = $patron->home_ou;
2199 my $req_org = $request_lib->id;
2201 $logger->info("prox cache $home_org " . $prox_cache{$home_org});
2203 $prox_cache{$home_org} =
2204 $e->search_actor_org_unit_proximity({from_org => $home_org})
2205 unless $prox_cache{$home_org};
2206 my $home_prox = $prox_cache{$home_org};
2209 my %hash = map { ($_->to_org => $_->prox) } @$home_prox;
2210 push( @{$buckets{ $hash{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2212 my @keys = sort { $a <=> $b } keys %buckets;
2215 if( $home_org ne $req_org ) {
2216 # -----------------------------------------------------------------------
2217 # shove the copies close to the request_lib into the primary buckets
2218 # directly before the farthest away copies. That way, they are not
2219 # given priority, but they are checked before the farthest copies.
2220 # -----------------------------------------------------------------------
2221 $prox_cache{$req_org} =
2222 $e->search_actor_org_unit_proximity({from_org => $req_org})
2223 unless $prox_cache{$req_org};
2224 my $req_prox = $prox_cache{$req_org};
2227 my %hash2 = map { ($_->to_org => $_->prox) } @$req_prox;
2228 push( @{$buckets2{ $hash2{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2230 my $highest_key = $keys[@keys - 1]; # the farthest prox in the exising buckets
2231 my $new_key = $highest_key - 0.5; # right before the farthest prox
2232 my @keys2 = sort { $a <=> $b } keys %buckets2;
2233 for my $key (@keys2) {
2234 last if $key >= $highest_key;
2235 push( @{$buckets{$new_key}}, $_ ) for @{$buckets2{$key}};
2239 @keys = sort { $a <=> $b } keys %buckets;
2244 OUTER: for my $key (@keys) {
2245 my @cps = @{$buckets{$key}};
2247 $logger->info("looking at " . scalar(@{$buckets{$key}}). " copies in proximity bucket $key");
2249 for my $copyid (@cps) {
2251 next if $seen{$copyid};
2252 $seen{$copyid} = 1; # there could be dupes given the merged buckets
2253 my $copy = $e->retrieve_asset_copy($copyid);
2254 $logger->debug("looking at bucket_key=$key, copy $copyid : circ_lib = " . $copy->circ_lib);
2256 unless($title) { # grab the title if we don't already have it
2257 my $vol = $e->retrieve_asset_call_number(
2258 [ $copy->call_number, { flesh => 1, flesh_fields => { bre => ['fixed_fields'], acn => ['record'] } } ] );
2259 $title = $vol->record;
2262 @status = verify_copy_for_hold(
2263 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib);
2265 last OUTER if $status[0];
2272 sub _check_issuance_hold_is_possible {
2273 my( $issuanceid, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou ) = @_;
2275 my $e = new_editor();
2276 my %org_filter = create_ranged_org_filter($e, $selection_ou, $depth);
2278 # this monster will grab the id and circ_lib of all of the "holdable" copies for the given record
2279 my $copies = $e->json_query(
2281 select => { acp => ['id', 'circ_lib'] },
2287 filter => { issuance => $issuanceid }
2289 acpl => { field => 'id', filter => { holdable => 't'}, fkey => 'location' },
2290 ccs => { field => 'id', filter => { holdable => 't'}, fkey => 'status' }
2294 '+acp' => { circulate => 't', deleted => 'f', holdable => 't', %org_filter }
2300 $logger->info("issuance possible found ".scalar(@$copies)." potential copies");
2304 $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_issuance_ok');
2305 $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2310 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2311 "payload" => {"fail_part" => "no_ultimate_items"}
2319 # -----------------------------------------------------------------------
2320 # sort the copies into buckets based on their circ_lib proximity to
2321 # the patron's home_ou.
2322 # -----------------------------------------------------------------------
2324 my $home_org = $patron->home_ou;
2325 my $req_org = $request_lib->id;
2327 $logger->info("prox cache $home_org " . $prox_cache{$home_org});
2329 $prox_cache{$home_org} =
2330 $e->search_actor_org_unit_proximity({from_org => $home_org})
2331 unless $prox_cache{$home_org};
2332 my $home_prox = $prox_cache{$home_org};
2335 my %hash = map { ($_->to_org => $_->prox) } @$home_prox;
2336 push( @{$buckets{ $hash{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2338 my @keys = sort { $a <=> $b } keys %buckets;
2341 if( $home_org ne $req_org ) {
2342 # -----------------------------------------------------------------------
2343 # shove the copies close to the request_lib into the primary buckets
2344 # directly before the farthest away copies. That way, they are not
2345 # given priority, but they are checked before the farthest copies.
2346 # -----------------------------------------------------------------------
2347 $prox_cache{$req_org} =
2348 $e->search_actor_org_unit_proximity({from_org => $req_org})
2349 unless $prox_cache{$req_org};
2350 my $req_prox = $prox_cache{$req_org};
2353 my %hash2 = map { ($_->to_org => $_->prox) } @$req_prox;
2354 push( @{$buckets2{ $hash2{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2356 my $highest_key = $keys[@keys - 1]; # the farthest prox in the exising buckets
2357 my $new_key = $highest_key - 0.5; # right before the farthest prox
2358 my @keys2 = sort { $a <=> $b } keys %buckets2;
2359 for my $key (@keys2) {
2360 last if $key >= $highest_key;
2361 push( @{$buckets{$new_key}}, $_ ) for @{$buckets2{$key}};
2365 @keys = sort { $a <=> $b } keys %buckets;
2370 OUTER: for my $key (@keys) {
2371 my @cps = @{$buckets{$key}};
2373 $logger->info("looking at " . scalar(@{$buckets{$key}}). " copies in proximity bucket $key");
2375 for my $copyid (@cps) {
2377 next if $seen{$copyid};
2378 $seen{$copyid} = 1; # there could be dupes given the merged buckets
2379 my $copy = $e->retrieve_asset_copy($copyid);
2380 $logger->debug("looking at bucket_key=$key, copy $copyid : circ_lib = " . $copy->circ_lib);
2382 unless($title) { # grab the title if we don't already have it
2383 my $vol = $e->retrieve_asset_call_number(
2384 [ $copy->call_number, { flesh => 1, flesh_fields => { bre => ['fixed_fields'], acn => ['record'] } } ] );
2385 $title = $vol->record;
2388 @status = verify_copy_for_hold(
2389 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib);
2391 last OUTER if $status[0];
2396 if (!defined($empty_ok)) {
2397 $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_issuance_ok');
2398 $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2401 return (1,0) if ($empty_ok);
2406 sub _check_monopart_hold_is_possible {
2407 my( $partid, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou ) = @_;
2409 my $e = new_editor();
2410 my %org_filter = create_ranged_org_filter($e, $selection_ou, $depth);
2412 # this monster will grab the id and circ_lib of all of the "holdable" copies for the given record
2413 my $copies = $e->json_query(
2415 select => { acp => ['id', 'circ_lib'] },
2419 field => 'target_copy',
2421 filter => { part => $partid }
2423 acpl => { field => 'id', filter => { holdable => 't'}, fkey => 'location' },
2424 ccs => { field => 'id', filter => { holdable => 't'}, fkey => 'status' }
2428 '+acp' => { circulate => 't', deleted => 'f', holdable => 't', %org_filter }
2434 $logger->info("monopart possible found ".scalar(@$copies)." potential copies");
2438 $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_part_ok');
2439 $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2444 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2445 "payload" => {"fail_part" => "no_ultimate_items"}
2453 # -----------------------------------------------------------------------
2454 # sort the copies into buckets based on their circ_lib proximity to
2455 # the patron's home_ou.
2456 # -----------------------------------------------------------------------
2458 my $home_org = $patron->home_ou;
2459 my $req_org = $request_lib->id;
2461 $logger->info("prox cache $home_org " . $prox_cache{$home_org});
2463 $prox_cache{$home_org} =
2464 $e->search_actor_org_unit_proximity({from_org => $home_org})
2465 unless $prox_cache{$home_org};
2466 my $home_prox = $prox_cache{$home_org};
2469 my %hash = map { ($_->to_org => $_->prox) } @$home_prox;
2470 push( @{$buckets{ $hash{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2472 my @keys = sort { $a <=> $b } keys %buckets;
2475 if( $home_org ne $req_org ) {
2476 # -----------------------------------------------------------------------
2477 # shove the copies close to the request_lib into the primary buckets
2478 # directly before the farthest away copies. That way, they are not
2479 # given priority, but they are checked before the farthest copies.
2480 # -----------------------------------------------------------------------
2481 $prox_cache{$req_org} =
2482 $e->search_actor_org_unit_proximity({from_org => $req_org})
2483 unless $prox_cache{$req_org};
2484 my $req_prox = $prox_cache{$req_org};
2487 my %hash2 = map { ($_->to_org => $_->prox) } @$req_prox;
2488 push( @{$buckets2{ $hash2{$_->{circ_lib}} } }, $_->{id} ) for @$copies;
2490 my $highest_key = $keys[@keys - 1]; # the farthest prox in the exising buckets
2491 my $new_key = $highest_key - 0.5; # right before the farthest prox
2492 my @keys2 = sort { $a <=> $b } keys %buckets2;
2493 for my $key (@keys2) {
2494 last if $key >= $highest_key;
2495 push( @{$buckets{$new_key}}, $_ ) for @{$buckets2{$key}};
2499 @keys = sort { $a <=> $b } keys %buckets;
2504 OUTER: for my $key (@keys) {
2505 my @cps = @{$buckets{$key}};
2507 $logger->info("looking at " . scalar(@{$buckets{$key}}). " copies in proximity bucket $key");
2509 for my $copyid (@cps) {
2511 next if $seen{$copyid};
2512 $seen{$copyid} = 1; # there could be dupes given the merged buckets
2513 my $copy = $e->retrieve_asset_copy($copyid);
2514 $logger->debug("looking at bucket_key=$key, copy $copyid : circ_lib = " . $copy->circ_lib);
2516 unless($title) { # grab the title if we don't already have it
2517 my $vol = $e->retrieve_asset_call_number(
2518 [ $copy->call_number, { flesh => 1, flesh_fields => { bre => ['fixed_fields'], acn => ['record'] } } ] );
2519 $title = $vol->record;
2522 @status = verify_copy_for_hold(
2523 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib);
2525 last OUTER if $status[0];
2530 if (!defined($empty_ok)) {
2531 $empty_ok = $e->retrieve_config_global_flag('circ.holds.empty_part_ok');
2532 $empty_ok = ($empty_ok and $U->is_true($empty_ok->enabled));
2535 return (1,0) if ($empty_ok);
2541 sub _check_volume_hold_is_possible {
2542 my( $vol, $title, $depth, $request_lib, $patron, $requestor, $pickup_lib, $selection_ou ) = @_;
2543 my %org_filter = create_ranged_org_filter(new_editor(), $selection_ou, $depth);
2544 my $copies = new_editor->search_asset_copy({call_number => $vol->id, %org_filter});
2545 $logger->info("checking possibility of volume hold for volume ".$vol->id);
2550 "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
2551 "payload" => {"fail_part" => "no_ultimate_items"}
2557 for my $copy ( @$copies ) {
2558 @status = verify_copy_for_hold(
2559 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib );
2567 sub verify_copy_for_hold {
2568 my( $patron, $requestor, $title, $copy, $pickup_lib, $request_lib ) = @_;
2569 $logger->info("checking possibility of copy in hold request for copy ".$copy->id);
2570 my $permitted = OpenILS::Utils::PermitHold::permit_copy_hold(
2571 { patron => $patron,
2572 requestor => $requestor,
2575 title_descriptor => $title->fixed_fields, # this is fleshed into the title object
2576 pickup_lib => $pickup_lib,
2577 request_lib => $request_lib,
2579 show_event_list => 1
2584 (not scalar @$permitted), # true if permitted is an empty arrayref
2586 ($copy->circ_lib == $pickup_lib) and
2587 ($copy->status == OILS_COPY_STATUS_AVAILABLE)
2595 sub find_nearest_permitted_hold {
2598 my $editor = shift; # CStoreEditor object
2599 my $copy = shift; # copy to target
2600 my $user = shift; # staff
2601 my $check_only = shift; # do no updates, just see if the copy could fulfill a hold
2603 my $evt = OpenILS::Event->new('ACTION_HOLD_REQUEST_NOT_FOUND');
2605 my $bc = $copy->barcode;
2607 # find any existing holds that already target this copy
2608 my $old_holds = $editor->search_action_hold_request(
2609 { current_copy => $copy->id,
2610 cancel_time => undef,
2611 capture_time => undef
2615 # hold->type "R" means we need this copy
2616 for my $h (@$old_holds) { return ($h) if $h->hold_type eq 'R'; }
2619 my $hold_stall_interval = $U->ou_ancestor_setting_value($user->ws_ou, OILS_SETTING_HOLD_SOFT_STALL);
2621 $logger->info("circulator: searching for best hold at org ".$user->ws_ou.
2622 " and copy $bc with a hold stalling interval of ". ($hold_stall_interval || "(none)"));
2624 my $fifo = $U->ou_ancestor_setting_value($user->ws_ou, 'circ.holds_fifo');
2626 # search for what should be the best holds for this copy to fulfill
2627 my $best_holds = $U->storagereq(
2628 "open-ils.storage.action.hold_request.nearest_hold.atomic",
2629 $user->ws_ou, $copy->id, 10, $hold_stall_interval, $fifo );
2631 unless(@$best_holds) {
2633 if( my $hold = $$old_holds[0] ) {
2634 $logger->info("circulator: using existing pre-targeted hold ".$hold->id." in hold search");
2638 $logger->info("circulator: no suitable holds found for copy $bc");
2639 return (undef, $evt);
2645 # for each potential hold, we have to run the permit script
2646 # to make sure the hold is actually permitted.
2649 for my $holdid (@$best_holds) {
2650 next unless $holdid;
2651 $logger->info("circulator: checking if hold $holdid is permitted for copy $bc");
2653 my $hold = $editor->retrieve_action_hold_request($holdid) or next;
2654 my $reqr = $reqr_cache{$hold->requestor} || $editor->retrieve_actor_user($hold->requestor);
2655 my $rlib = $org_cache{$hold->request_lib} || $editor->retrieve_actor_org_unit($hold->request_lib);
2657 $reqr_cache{$hold->requestor} = $reqr;
2658 $org_cache{$hold->request_lib} = $rlib;
2660 # see if this hold is permitted
2661 my $permitted = OpenILS::Utils::PermitHold::permit_copy_hold(
2662 { patron_id => $hold->usr,
2665 pickup_lib => $hold->pickup_lib,
2666 request_lib => $rlib,
2678 unless( $best_hold ) { # no "good" permitted holds were found
2679 if( my $hold = $$old_holds[0] ) { # can we return a pre-targeted hold?
2680 $logger->info("circulator: using existing pre-targeted hold ".$hold->id." in hold search");
2685 $logger->info("circulator: no suitable holds found for copy $bc");
2686 return (undef, $evt);
2689 $logger->info("circulator: best hold ".$best_hold->id." found for copy $bc");
2691 # indicate a permitted hold was found
2692 return $best_hold if $check_only;
2694 # we've found a permitted hold. we need to "grab" the copy
2695 # to prevent re-targeted holds (next part) from re-grabbing the copy
2696 $best_hold->current_copy($copy->id);
2697 $editor->update_action_hold_request($best_hold)
2698 or return (undef, $editor->event);
2703 # re-target any other holds that already target this copy
2704 for my $old_hold (@$old_holds) {
2705 next if $old_hold->id eq $best_hold->id; # don't re-target the hold we want
2706 $logger->info("circulator: clearing current_copy and prev_check_time on hold ".
2707 $old_hold->id." after a better hold [".$best_hold->id."] was found");
2708 $old_hold->clear_current_copy;
2709 $old_hold->clear_prev_check_time;
2710 $editor->update_action_hold_request($old_hold)
2711 or return (undef, $editor->event);
2712 push(@retarget, $old_hold->id);
2715 return ($best_hold, undef, (@retarget) ? \@retarget : undef);
2723 __PACKAGE__->register_method(
2724 method => 'all_rec_holds',
2725 api_name => 'open-ils.circ.holds.retrieve_all_from_title',
2729 my( $self, $conn, $auth, $title_id, $args ) = @_;
2731 my $e = new_editor(authtoken=>$auth);
2732 $e->checkauth or return $e->event;
2733 $e->allowed('VIEW_HOLD') or return $e->event;
2736 $args->{fulfillment_time} = undef; # we don't want to see old fulfilled holds
2737 $args->{cancel_time} = undef;
2739 my $resp = { volume_holds => [], copy_holds => [], metarecord_holds => [] };
2741 my $mr_map = $e->search_metabib_metarecord_source_map({source => $title_id})->[0];
2743 $resp->{metarecord_holds} = $e->search_action_hold_request(
2744 { hold_type => OILS_HOLD_TYPE_METARECORD,
2745 target => $mr_map->metarecord,
2751 $resp->{title_holds} = $e->search_action_hold_request(
2753 hold_type => OILS_HOLD_TYPE_TITLE,
2754 target => $title_id,
2758 $resp->{part_holds} = $e->search_action_hold_request(
2760 hold_type => OILS_HOLD_TYPE_MONOPART,
2761 target => $title_id,
2765 my $subs = $e->search_serial_subscription(
2766 { record_entry => $title_id }, {idlist=>1});
2767 my $issuances = $e->search_serial_issuance(
2768 { subscription => $subs }, {idlist=>1});
2770 $resp->{issuance_holds} = $e->search_action_hold_request(
2772 hold_type => OILS_HOLD_TYPE_ISSUANCE,
2773 target => $issuances,
2777 my $vols = $e->search_asset_call_number(
2778 { record => $title_id, deleted => 'f' }, {idlist=>1});
2780 return $resp unless @$vols;
2782 $resp->{volume_holds} = $e->search_action_hold_request(
2784 hold_type => OILS_HOLD_TYPE_VOLUME,
2789 my $copies = $e->search_asset_copy(
2790 { call_number => $vols, deleted => 'f' }, {idlist=>1});
2792 return $resp unless @$copies;
2794 $resp->{copy_holds} = $e->search_action_hold_request(
2796 hold_type => OILS_HOLD_TYPE_COPY,
2808 __PACKAGE__->register_method(
2809 method => 'uber_hold',
2811 api_name => 'open-ils.circ.hold.details.retrieve'
2815 my($self, $client, $auth, $hold_id, $args) = @_;
2816 my $e = new_editor(authtoken=>$auth);
2817 $e->checkauth or return $e->event;
2818 return uber_hold_impl($e, $hold_id, $args);
2821 __PACKAGE__->register_method(
2822 method => 'batch_uber_hold',
2825 api_name => 'open-ils.circ.hold.details.batch.retrieve'
2828 sub batch_uber_hold {
2829 my($self, $client, $auth, $hold_ids, $args) = @_;
2830 my $e = new_editor(authtoken=>$auth);
2831 $e->checkauth or return $e->event;
2832 $client->respond(uber_hold_impl($e, $_, $args)) for @$hold_ids;
2836 sub uber_hold_impl {
2837 my($e, $hold_id, $args) = @_;
2840 my $hold = $e->retrieve_action_hold_request(
2845 flesh_fields => { ahr => [ 'current_copy', 'usr', 'notes' ] }
2848 ) or return $e->event;
2850 if($hold->usr->id ne $e->requestor->id) {
2851 # A user is allowed to see his/her own holds
2852 $e->allowed('VIEW_HOLD') or return $e->event;
2853 $hold->notes( # filter out any non-staff ("private") notes
2854 [ grep { !$U->is_true($_->staff) } @{$hold->notes} ] );
2857 # caller is asking for own hold, but may not have permission to view staff notes
2858 unless($e->allowed('VIEW_HOLD')) {
2859 $hold->notes( # filter out any staff notes
2860 [ grep { $U->is_true($_->staff) } @{$hold->notes} ] );
2864 my $user = $hold->usr;
2865 $hold->usr($user->id);
2868 my( $mvr, $volume, $copy, $issuance, $part, $bre ) = find_hold_mvr($e, $hold, $args->{suppress_mvr});
2870 flesh_hold_notices([$hold], $e) unless $args->{suppress_notices};
2871 flesh_hold_transits([$hold]) unless $args->{suppress_transits};
2873 my $details = retrieve_hold_queue_status_impl($e, $hold);
2877 ($copy ? (copy => $copy) : ()),
2878 ($volume ? (volume => $volume) : ()),
2879 ($issuance ? (issuance => $issuance) : ()),
2880 ($part ? (part => $part) : ()),
2881 ($args->{include_bre} ? (bre => $bre) : ()),
2882 ($args->{suppress_mvr} ? () : (mvr => $mvr)),
2886 unless($args->{suppress_patron_details}) {
2887 my $card = $e->retrieve_actor_card($user->card) or return $e->event;
2888 $resp->{patron_first} = $user->first_given_name,
2889 $resp->{patron_last} = $user->family_name,
2890 $resp->{patron_barcode} = $card->barcode,
2891 $resp->{patron_alias} = $user->alias,
2899 # -----------------------------------------------------
2900 # Returns the MVR object that represents what the
2902 # -----------------------------------------------------
2904 my( $e, $hold, $no_mvr ) = @_;
2912 if( $hold->hold_type eq OILS_HOLD_TYPE_METARECORD ) {
2913 my $mr = $e->retrieve_metabib_metarecord($hold->target)
2914 or return $e->event;
2915 $tid = $mr->master_record;
2917 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_TITLE ) {
2918 $tid = $hold->target;
2920 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_VOLUME ) {
2921 $volume = $e->retrieve_asset_call_number($hold->target)
2922 or return $e->event;
2923 $tid = $volume->record;
2925 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_ISSUANCE ) {
2926 $issuance = $e->retrieve_serial_issuance([
2928 {flesh => 1, flesh_fields => {siss => [ qw/subscription/ ]}}
2929 ]) or return $e->event;
2931 $tid = $issuance->subscription->record_entry;
2933 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_MONOPART ) {
2934 $part = $e->retrieve_biblio_monograph_part([
2936 ]) or return $e->event;
2938 $tid = $part->record;
2940 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_COPY ) {
2941 $copy = $e->retrieve_asset_copy([
2943 {flesh => 1, flesh_fields => {acp => ['call_number']}}
2944 ]) or return $e->event;
2946 $volume = $copy->call_number;
2947 $tid = $volume->record;
2950 if(!$copy and ref $hold->current_copy ) {
2951 $copy = $hold->current_copy;
2952 $hold->current_copy($copy->id);
2955 if(!$volume and $copy) {
2956 $volume = $e->retrieve_asset_call_number($copy->call_number);
2959 # TODO return metarcord mvr for M holds
2960 my $title = $e->retrieve_biblio_record_entry($tid);
2961 return ( ($no_mvr) ? undef : $U->record_to_mvr($title), $volume, $copy, $issuance, $part, $title );
2964 __PACKAGE__->register_method(
2965 method => 'clear_shelf_cache',
2966 api_name => 'open-ils.circ.hold.clear_shelf.get_cache',
2970 Returns the holds processed with the given cache key
2975 sub clear_shelf_cache {
2976 my($self, $client, $auth, $cache_key, $chunk_size) = @_;
2977 my $e = new_editor(authtoken => $auth, xact => 1);
2978 return $e->die_event unless $e->checkauth and $e->allowed('VIEW_HOLD');
2981 my $hold_data = OpenSRF::Utils::Cache->new('global')->get_cache($cache_key);
2984 $logger->info("no hold data found in cache"); # XXX TODO return event
2990 foreach (keys %$hold_data) {
2991 $maximum += scalar(@{ $hold_data->{$_} });
2993 $client->respond({"maximum" => $maximum, "progress" => 0});
2995 for my $action (sort keys %$hold_data) {
2996 while (@{$hold_data->{$action}}) {
2997 my @hid_chunk = splice @{$hold_data->{$action}}, 0, $chunk_size;
2999 my $result_chunk = $e->json_query({
3001 "acp" => ["barcode"],
3003 first_given_name second_given_name family_name alias
3013 "field" => "id", "fkey" => "current_copy",
3016 "field" => "id", "fkey" => "call_number",
3019 "field" => "id", "fkey" => "record"
3023 "acpl" => {"field" => "id", "fkey" => "location"}
3026 "au" => {"field" => "id", "fkey" => "usr"}
3029 "where" => {"+ahr" => {"id" => \@hid_chunk}}
3030 }, {"substream" => 1}) or return $e->die_event;
3034 +{"action" => $action, "hold_details" => $_}
3045 __PACKAGE__->register_method(
3046 method => 'clear_shelf_process',
3048 api_name => 'open-ils.circ.hold.clear_shelf.process',
3051 1. Find all holds that have expired on the holds shelf
3053 3. If a clear-shelf status is configured, put targeted copies into this status
3054 4. Divide copies into 3 groups: items to transit, items to reshelve, and items
3055 that are needed for holds. No subsequent action is taken on the holds
3056 or items after grouping.
3061 sub clear_shelf_process {
3062 my($self, $client, $auth, $org_id) = @_;
3064 my $e = new_editor(authtoken=>$auth, xact => 1);
3065 $e->checkauth or return $e->die_event;
3066 my $cache = OpenSRF::Utils::Cache->new('global');
3068 $org_id ||= $e->requestor->ws_ou;
3069 $e->allowed('UPDATE_HOLD', $org_id) or return $e->die_event;
3071 my $copy_status = $U->ou_ancestor_setting_value($org_id, 'circ.holds.clear_shelf.copy_status');
3073 # Find holds on the shelf that have been there too long
3074 my $hold_ids = $e->search_action_hold_request(
3075 { shelf_expire_time => {'<' => 'now'},
3076 pickup_lib => $org_id,
3077 cancel_time => undef,
3078 fulfillment_time => undef,
3079 shelf_time => {'!=' => undef},
3080 capture_time => {'!=' => undef},
3081 current_copy => {'!=' => undef},
3087 my $chunk_size = 25; # chunked status updates
3089 for my $hold_id (@$hold_ids) {
3091 $logger->info("Clear shelf processing hold $hold_id");
3093 my $hold = $e->retrieve_action_hold_request([
3096 flesh_fields => {ahr => ['current_copy']}
3100 $hold->cancel_time('now');
3101 $hold->cancel_cause(2); # Hold Shelf expiration
3102 $e->update_action_hold_request($hold) or return $e->die_event;
3103 delete_hold_copy_maps($self, $e, $hold->id) and return $e->die_event;
3105 my $copy = $hold->current_copy;
3107 if($copy_status or $copy_status == 0) {
3108 # if a clear-shelf copy status is defined, update the copy
3109 $copy->status($copy_status);
3110 $copy->edit_date('now');
3111 $copy->editor($e->requestor->id);
3112 $e->update_asset_copy($copy) or return $e->die_event;
3115 push(@holds, $hold);
3116 $client->respond({maximum => scalar(@holds), progress => $counter}) if ( (++$counter % $chunk_size) == 0);
3127 for my $hold (@holds) {
3129 my $copy = $hold->current_copy;
3130 my ($alt_hold) = __PACKAGE__->find_nearest_permitted_hold($e, $copy, $e->requestor, 1);
3134 push(@{$cache_data{hold}}, $hold->id); # copy is needed for a hold
3136 } elsif($copy->circ_lib != $e->requestor->ws_ou) {
3138 push(@{$cache_data{transit}}, $hold->id); # copy needs to transit
3142 push(@{$cache_data{shelf}}, $hold->id); # copy needs to go back to the shelf
3146 my $cache_key = md5_hex(time . $$ . rand());
3147 $logger->info("clear_shelf_cache: storing under $cache_key");
3148 $cache->put_cache($cache_key, \%cache_data, 7200); # TODO: 2 hours. configurable?
3150 # tell the client we're done
3151 $client->respond_complete({cache_key => $cache_key});
3153 # fire off the hold cancelation trigger and wait for response so don't flood the service
3154 $U->create_events_for_hook(
3155 'hold_request.cancel.expire_holds_shelf',
3156 $_, $org_id, undef, undef, 1) for @holds;
3159 # tell the client we're done
3160 $client->respond_complete;
3164 __PACKAGE__->register_method(
3165 method => 'usr_hold_summary',
3166 api_name => 'open-ils.circ.holds.user_summary',
3168 Returns a summary of holds statuses for a given user
3172 sub usr_hold_summary {
3173 my($self, $conn, $auth, $user_id) = @_;
3175 my $e = new_editor(authtoken=>$auth);
3176 $e->checkauth or return $e->event;
3177 $e->allowed('VIEW_HOLD') or return $e->event;
3179 my $holds = $e->search_action_hold_request(
3182 fulfillment_time => undef,
3183 cancel_time => undef,
3187 my %summary = (1 => 0, 2 => 0, 3 => 0, 4 => 0);
3188 $summary{_hold_status($e, $_)} += 1 for @$holds;
3194 __PACKAGE__->register_method(
3195 method => 'hold_has_copy_at',
3196 api_name => 'open-ils.circ.hold.has_copy_at',
3199 'Returns the ID of the found copy and name of the shelving location if there is ' .
3200 'an available copy at the specified org unit. Returns empty hash otherwise. ' .
3201 'The anticipated use for this method is to determine whether an item is ' .
3202 'available at the library where the user is placing the hold (or, alternatively, '.
3203 'at the pickup library) to encourage bypassing the hold placement and just ' .
3204 'checking out the item.' ,
3206 { desc => 'Authentication Token', type => 'string' },
3207 { desc => 'Method Arguments. Options include: hold_type, hold_target, org_unit. '
3208 . 'hold_type is the hold type code (T, V, C, M, ...). '
3209 . 'hold_target is the identifier of the hold target object. '
3210 . 'org_unit is org unit ID.',
3215 desc => q/Result hash like { "copy" : copy_id, "location" : location_name }, empty hash on misses, event on error./,
3221 sub hold_has_copy_at {
3222 my($self, $conn, $auth, $args) = @_;
3224 my $e = new_editor(authtoken=>$auth);
3225 $e->checkauth or return $e->event;
3227 my $hold_type = $$args{hold_type};
3228 my $hold_target = $$args{hold_target};
3229 my $org_unit = $$args{org_unit};
3232 select => {acp => ['id'], acpl => ['name']},
3235 acpl => {field => 'id', filter => { holdable => 't'}, fkey => 'location'},
3236 ccs => {field => 'id', filter => { holdable => 't'}, fkey => 'status' }
3239 where => {'+acp' => { circulate => 't', deleted => 'f', holdable => 't', circ_lib => $org_unit}},
3243 if($hold_type eq 'C') {
3245 $query->{where}->{'+acp'}->{id} = $hold_target;
3247 } elsif($hold_type eq 'V') {
3249 $query->{where}->{'+acp'}->{call_number} = $hold_target;
3251 } elsif($hold_type eq 'T') {
3253 $query->{from}->{acp}->{acn} = {
3255 fkey => 'call_number',
3259 filter => {id => $hold_target},
3267 $query->{from}->{acp}->{acn} = {
3269 fkey => 'call_number',
3278 filter => {metarecord => $hold_target},
3286 my $res = $e->json_query($query)->[0] or return {};
3287 return {copy => $res->{id}, location => $res->{name}} if $res;
3291 # returns true if the user already has an item checked out
3292 # that could be used to fulfill the requested hold.
3293 sub hold_item_is_checked_out {
3294 my($e, $user_id, $hold_type, $hold_target) = @_;
3297 select => {acp => ['id']},
3298 from => {acp => {}},
3302 in => { # copies for circs the user has checked out
3303 select => {circ => ['target_copy']},
3307 checkin_time => undef,
3309 {stop_fines => ["MAXFINES","LONGOVERDUE"]},
3310 {stop_fines => undef}
3320 if($hold_type eq 'C' || $hold_type eq 'R' || $hold_type eq 'F') {
3322 $query->{where}->{'+acp'}->{id}->{in}->{where}->{'target_copy'} = $hold_target;
3324 } elsif($hold_type eq 'V') {
3326 $query->{where}->{'+acp'}->{call_number} = $hold_target;
3328 } elsif($hold_type eq 'P') {
3330 $query->{from}->{acp}->{acpm} = {
3331 field => 'target_copy',
3333 filter => {part => $hold_target},
3336 } elsif($hold_type eq 'I') {
3338 $query->{from}->{acp}->{sitem} = {
3341 filter => {issuance => $hold_target},
3344 } elsif($hold_type eq 'T') {
3346 $query->{from}->{acp}->{acn} = {
3348 fkey => 'call_number',
3352 filter => {id => $hold_target},
3360 $query->{from}->{acp}->{acn} = {
3362 fkey => 'call_number',
3371 filter => {metarecord => $hold_target},
3379 return $e->json_query($query)->[0];
3382 __PACKAGE__->register_method(
3383 method => 'change_hold_title',
3384 api_name => 'open-ils.circ.hold.change_title',
3387 Updates all title level holds targeting the specified bibs to point a new bib./,
3389 { desc => 'Authentication Token', type => 'string' },
3390 { desc => 'New Target Bib Id', type => 'number' },
3391 { desc => 'Old Target Bib Ids', type => 'array' },
3393 return => { desc => '1 on success' }
3397 sub change_hold_title {
3398 my( $self, $client, $auth, $new_bib_id, $bib_ids ) = @_;
3400 my $e = new_editor(authtoken=>$auth, xact=>1);
3401 return $e->die_event unless $e->checkauth;
3403 my $holds = $e->search_action_hold_request(
3406 cancel_time => undef,
3407 fulfillment_time => undef,
3413 flesh_fields => { ahr => ['usr'] }
3419 for my $hold (@$holds) {
3420 $e->allowed('UPDATE_HOLD', $hold->usr->home_ou) or return $e->die_event;
3421 $logger->info("Changing hold " . $hold->id . " target from " . $hold->target . " to $new_bib_id in title hold target change");
3422 $hold->target( $new_bib_id );
3423 $e->update_action_hold_request($hold) or return $e->die_event;
3432 __PACKAGE__->register_method(
3433 method => 'rec_hold_count',
3434 api_name => 'open-ils.circ.bre.holds.count',
3436 desc => q/Returns the total number of holds that target the
3437 selected bib record or its associated copies and call_numbers/,
3439 { desc => 'Bib ID', type => 'number' },
3441 return => {desc => 'Hold count', type => 'number'}
3445 __PACKAGE__->register_method(
3446 method => 'rec_hold_count',
3447 api_name => 'open-ils.circ.mmr.holds.count',
3449 desc => q/Returns the total number of holds that target the
3450 selected metarecord or its associated copies, call_numbers, and bib records/,
3452 { desc => 'Metarecord ID', type => 'number' },
3454 return => {desc => 'Hold count', type => 'number'}
3458 # XXX Need to add type I (and, soon, type P) holds to these counts
3459 sub rec_hold_count {
3460 my($self, $conn, $target_id) = @_;
3467 filter => {metarecord => $target_id}
3474 filter => { id => $target_id },
3479 if($self->api_name =~ /mmr/) {
3480 delete $bre_join->{bre}->{filter};
3481 $bre_join->{bre}->{join} = $mmr_join;
3487 fkey => 'call_number',
3493 select => {ahr => [{column => 'id', transform => 'count', alias => 'count'}]},
3497 cancel_time => undef,
3498 fulfillment_time => undef,
3502 hold_type => [qw/C F R/],
3505 select => {acp => ['id']},
3506 from => { acp => $cn_join }
3516 select => {acn => ['id']},
3517 from => {acn => $bre_join}
3525 target => $target_id
3533 if($self->api_name =~ /mmr/) {
3534 $query->{where}->{'+ahr'}->{'-or'}->[2] = {
3539 select => {bre => ['id']},
3540 from => {bre => $mmr_join}
3546 $query->{where}->{'+ahr'}->{'-or'}->[3] = {
3549 target => $target_id
3555 return new_editor()->json_query($query)->[0]->{count};