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/OpenSRF::Application/;
19 use strict; use warnings;
20 use OpenILS::Application::AppUtils;
22 use OpenSRF::EX qw(:try);
25 use OpenSRF::Utils::Logger qw(:logger);
26 use OpenILS::Utils::CStoreEditor q/:funcs/;
27 use OpenILS::Utils::PermitHold;
28 use OpenSRF::Utils::SettingsClient;
29 use OpenILS::Const qw/:const/;
30 use OpenILS::Application::Circ::Transit;
32 my $apputils = "OpenILS::Application::AppUtils";
37 __PACKAGE__->register_method(
38 method => "create_hold",
39 api_name => "open-ils.circ.holds.create",
41 Create a new hold for an item. From a permissions perspective,
42 the login session is used as the 'requestor' of the hold.
43 The hold recipient is determined by the 'usr' setting within
46 First we verify the requestion has holds request permissions.
47 Then we verify that the recipient is allowed to make the given hold.
48 If not, we see if the requestor has "override" capabilities. If not,
49 a permission exception is returned. If permissions allow, we cycle
50 through the set of holds objects and create.
52 If the recipient does not have permission to place multiple holds
53 on a single title and said operation is attempted, a permission
58 __PACKAGE__->register_method(
59 method => "create_hold",
60 api_name => "open-ils.circ.holds.create.override",
62 If the recipient is not allowed to receive the requested hold,
63 call this method to attempt the override
64 @see open-ils.circ.holds.create
69 my( $self, $conn, $auth, @holds ) = @_;
70 my $e = new_editor(authtoken=>$auth, xact=>1);
71 return $e->event unless $e->checkauth;
73 my $override = 1 if $self->api_name =~ /override/;
75 my $holds = (ref($holds[0] eq 'ARRAY')) ? $holds[0] : [@holds];
79 for my $hold (@$holds) {
84 my $requestor = $e->requestor;
85 my $recipient = $requestor;
88 if( $requestor->id ne $hold->usr ) {
89 # Make sure the requestor is allowed to place holds for
90 # the recipient if they are not the same people
91 $recipient = $e->retrieve_actor_user($hold->usr) or return $e->event;
92 $e->allowed('REQUEST_HOLDS', $recipient->home_ou) or return $e->event;
95 # Now make sure the recipient is allowed to receive the specified hold
97 my $porg = $recipient->home_ou;
98 my $rid = $e->requestor->id;
99 my $t = $hold->hold_type;
101 # See if a duplicate hold already exists
103 usr => $recipient->id,
105 fulfillment_time => undef,
106 target => $hold->target,
107 cancel_time => undef,
110 $sargs->{holdable_formats} = $hold->holdable_formats if $t eq 'M';
112 my $existing = $e->search_action_hold_request($sargs);
113 push( @events, OpenILS::Event->new('HOLD_EXISTS')) if @$existing;
115 if( $t eq OILS_HOLD_TYPE_METARECORD )
116 { $pevt = $e->event unless $e->checkperm($rid, $porg, 'MR_HOLDS'); }
118 if( $t eq OILS_HOLD_TYPE_TITLE )
119 { $pevt = $e->event unless $e->checkperm($rid, $porg, 'TITLE_HOLDS'); }
121 if( $t eq OILS_HOLD_TYPE_VOLUME )
122 { $pevt = $e->event unless $e->checkperm($rid, $porg, 'VOLUME_HOLDS'); }
124 if( $t eq OILS_HOLD_TYPE_COPY )
125 { $pevt = $e->event unless $e->checkperm($rid, $porg, 'COPY_HOLDS'); }
127 return $pevt if $pevt;
131 for my $evt (@events) {
133 my $name = $evt->{textcode};
134 return $e->event unless $e->allowed("$name.override", $porg);
141 $hold->requestor($e->requestor->id);
142 $hold->request_lib($e->requestor->ws_ou);
143 $hold->selection_ou($recipient->home_ou) unless $hold->selection_ou;
144 $hold = $e->create_action_hold_request($hold) or return $e->event;
145 # push( @copyholds, $hold ) if $hold->hold_type eq OILS_HOLD_TYPE_COPY;
150 $conn->respond_complete(1);
152 # Go ahead and target the copy-level holds
154 'open-ils.storage.action.hold_request.copy_targeter',
155 undef, $_->id ) for @holds;
161 my( $self, $client, $login_session, @holds) = @_;
163 if(!@holds){return 0;}
164 my( $user, $evt ) = $apputils->checkses($login_session);
168 if(ref($holds[0]) eq 'ARRAY') {
170 } else { $holds = [ @holds ]; }
172 $logger->debug("Iterating over holds requests...");
174 for my $hold (@$holds) {
177 my $type = $hold->hold_type;
179 $logger->activity("User " . $user->id .
180 " creating new hold of type $type for user " . $hold->usr);
183 if($user->id ne $hold->usr) {
184 ( $recipient, $evt ) = $apputils->fetch_user($hold->usr);
194 # am I allowed to place holds for this user?
195 if($hold->requestor ne $hold->usr) {
196 $perm = _check_request_holds_perm($user->id, $user->home_ou);
197 if($perm) { return $perm; }
200 # is this user allowed to have holds of this type?
201 $perm = _check_holds_perm($type, $hold->requestor, $recipient->home_ou);
203 #if there is a requestor, see if the requestor has override privelages
204 if($hold->requestor ne $hold->usr) {
205 $perm = _check_request_holds_override($user->id, $user->home_ou);
206 if($perm) {return $perm;}
213 #enforce the fact that the login is the one requesting the hold
214 $hold->requestor($user->id);
215 $hold->selection_ou($recipient->home_ou) unless $hold->selection_ou;
217 my $resp = $apputils->simplereq(
219 'open-ils.storage.direct.action.hold_request.create', $hold );
222 return OpenSRF::EX::ERROR ("Error creating hold");
229 # makes sure that a user has permission to place the type of requested hold
230 # returns the Perm exception if not allowed, returns undef if all is well
231 sub _check_holds_perm {
232 my($type, $user_id, $org_id) = @_;
236 if($evt = $apputils->check_perms(
237 $user_id, $org_id, "MR_HOLDS")) {
241 } elsif ($type eq "T") {
242 if($evt = $apputils->check_perms(
243 $user_id, $org_id, "TITLE_HOLDS")) {
247 } elsif($type eq "V") {
248 if($evt = $apputils->check_perms(
249 $user_id, $org_id, "VOLUME_HOLDS")) {
253 } elsif($type eq "C") {
254 if($evt = $apputils->check_perms(
255 $user_id, $org_id, "COPY_HOLDS")) {
263 # tests if the given user is allowed to place holds on another's behalf
264 sub _check_request_holds_perm {
267 if(my $evt = $apputils->check_perms(
268 $user_id, $org_id, "REQUEST_HOLDS")) {
273 sub _check_request_holds_override {
276 if(my $evt = $apputils->check_perms(
277 $user_id, $org_id, "REQUEST_HOLDS_OVERRIDE")) {
282 __PACKAGE__->register_method(
283 method => "retrieve_holds_by_id",
284 api_name => "open-ils.circ.holds.retrieve_by_id",
286 Retrieve the hold, with hold transits attached, for the specified id The login session is the requestor and if the requestor is
287 different from the user, then the requestor must have VIEW_HOLD permissions.
291 sub retrieve_holds_by_id {
292 my($self, $client, $auth, $hold_id) = @_;
293 my $e = new_editor(authtoken=>$auth);
294 $e->checkauth or return $e->event;
295 $e->allowed('VIEW_HOLD') or return $e->event;
297 my $holds = $e->search_action_hold_request(
299 { id => $hold_id , fulfillment_time => undef },
300 { order_by => { ahr => "request_time" } }
304 flesh_hold_transits($holds);
305 flesh_hold_notices($holds, $e);
310 __PACKAGE__->register_method(
311 method => "retrieve_holds",
312 api_name => "open-ils.circ.holds.retrieve",
314 Retrieves all the holds, with hold transits attached, for the specified
315 user id. The login session is the requestor and if the requestor is
316 different from the user, then the requestor must have VIEW_HOLD permissions.
319 __PACKAGE__->register_method(
320 method => "retrieve_holds",
321 api_name => "open-ils.circ.holds.id_list.retrieve",
323 Retrieves all the hold ids for the specified
324 user id. The login session is the requestor and if the requestor is
325 different from the user, then the requestor must have VIEW_HOLD permissions.
329 my($self, $client, $login_session, $user_id) = @_;
331 my( $user, $target, $evt ) = $apputils->checkses_requestor(
332 $login_session, $user_id, 'VIEW_HOLD' );
335 my $holds = $apputils->simplereq(
337 "open-ils.cstore.direct.action.hold_request.search.atomic",
340 fulfillment_time => undef,
341 cancel_time => undef,
343 { order_by => { ahr => "request_time" } }
346 if( ! $self->api_name =~ /id_list/ ) {
347 for my $hold ( @$holds ) {
349 $apputils->simplereq(
351 "open-ils.cstore.direct.action.hold_transit_copy.search.atomic",
352 { hold => $hold->id },
353 { order_by => { ahtc => 'id desc' }, limit => 1 }
359 if( $self->api_name =~ /id_list/ ) {
360 return [ map { $_->id } @$holds ];
366 __PACKAGE__->register_method(
367 method => "retrieve_holds_by_pickup_lib",
368 api_name => "open-ils.circ.holds.retrieve_by_pickup_lib",
370 Retrieves all the holds, with hold transits attached, for the specified
374 __PACKAGE__->register_method(
375 method => "retrieve_holds_by_pickup_lib",
376 api_name => "open-ils.circ.holds.id_list.retrieve_by_pickup_lib",
378 Retrieves all the hold ids for the specified
382 sub retrieve_holds_by_pickup_lib {
383 my($self, $client, $login_session, $ou_id) = @_;
385 #FIXME -- put an appropriate permission check here
386 #my( $user, $target, $evt ) = $apputils->checkses_requestor(
387 # $login_session, $user_id, 'VIEW_HOLD' );
388 #return $evt if $evt;
390 my $holds = $apputils->simplereq(
392 "open-ils.cstore.direct.action.hold_request.search.atomic",
394 pickup_lib => $ou_id ,
395 fulfillment_time => undef,
398 { order_by => { ahr => "request_time" } });
401 if( ! $self->api_name =~ /id_list/ ) {
402 flesh_hold_transits($holds);
405 if( $self->api_name =~ /id_list/ ) {
406 return [ map { $_->id } @$holds ];
412 __PACKAGE__->register_method(
413 method => "cancel_hold",
414 api_name => "open-ils.circ.hold.cancel",
416 Cancels the specified hold. The login session
417 is the requestor and if the requestor is different from the usr field
418 on the hold, the requestor must have CANCEL_HOLDS permissions.
419 the hold may be either the hold object or the hold id
423 my($self, $client, $auth, $holdid) = @_;
425 my $e = new_editor(authtoken=>$auth, xact=>1);
426 return $e->event unless $e->checkauth;
428 my $hold = $e->retrieve_action_hold_request($holdid)
431 if( $e->requestor->id ne $hold->usr ) {
432 return $e->event unless $e->allowed('CANCEL_HOLDS');
435 return 1 if $hold->cancel_time;
437 # If the hold is captured, reset the copy status
438 if( $hold->capture_time and $hold->current_copy ) {
440 my $copy = $e->retrieve_asset_copy($hold->current_copy)
443 if( $copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF ) {
444 $logger->info("setting copy to status 'reshelving' on hold cancel");
445 $copy->status(OILS_COPY_STATUS_RESHELVING);
446 $copy->editor($e->requestor->id);
447 $copy->edit_date('now');
448 $e->update_asset_copy($copy) or return $e->event;
450 } elsif( $copy->status == OILS_COPY_STATUS_IN_TRANSIT ) {
453 $logger->warn("! canceling hold [$hid] that is in transit");
454 my $transid = $e->search_action_hold_transit_copy({hold=>$hold->id},{idlist=>1})->[0];
457 my $trans = $e->retrieve_action_transit_copy($transid);
458 # Leave the transit alive, but set the copy status to
459 # reshelving so it will be properly reshelved when it gets back home
461 $trans->copy_status( OILS_COPY_STATUS_RESHELVING );
462 $e->update_action_transit_copy($trans) or return $e->die_event;
469 $hold->cancel_time('now');
470 $e->update_action_hold_request($hold)
473 $self->delete_hold_copy_maps($e, $hold->id);
479 sub delete_hold_copy_maps {
484 my $maps = $editor->search_action_hold_copy_map({hold=>$holdid});
486 $editor->delete_action_hold_copy_map($_)
487 or return $editor->event;
493 __PACKAGE__->register_method(
494 method => "update_hold",
495 api_name => "open-ils.circ.hold.update",
497 Updates the specified hold. The login session
498 is the requestor and if the requestor is different from the usr field
499 on the hold, the requestor must have UPDATE_HOLDS permissions.
503 my($self, $client, $login_session, $hold) = @_;
505 my( $requestor, $target, $evt ) = $apputils->checkses_requestor(
506 $login_session, $hold->usr, 'UPDATE_HOLD' );
509 $logger->activity('User ' . $requestor->id .
510 ' updating hold ' . $hold->id . ' for user ' . $target->id );
512 return $U->storagereq(
513 "open-ils.storage.direct.action.hold_request.update", $hold );
517 __PACKAGE__->register_method(
518 method => "retrieve_hold_status",
519 api_name => "open-ils.circ.hold.status.retrieve",
521 Calculates the current status of the hold.
522 the requestor must have VIEW_HOLD permissions if the hold is for a user
523 other than the requestor.
524 Returns -1 on error (for now)
525 Returns 1 for 'waiting for copy to become available'
526 Returns 2 for 'waiting for copy capture'
527 Returns 3 for 'in transit'
528 Returns 4 for 'arrived'
531 sub retrieve_hold_status {
532 my($self, $client, $auth, $hold_id) = @_;
534 my $e = new_editor(authtoken => $auth);
535 return $e->event unless $e->checkauth;
536 my $hold = $e->retrieve_action_hold_request($hold_id)
539 if( $e->requestor->id != $hold->usr ) {
540 return $e->event unless $e->allowed('VIEW_HOLD');
543 return _hold_status($e, $hold);
549 return 1 unless $hold->current_copy;
550 return 2 unless $hold->capture_time;
552 my $copy = $hold->current_copy;
553 unless( ref $copy ) {
554 $copy = $e->retrieve_asset_copy($hold->current_copy)
558 return 3 if $copy->status == OILS_COPY_STATUS_IN_TRANSIT;
559 return 4 if $copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF;
567 sub find_local_hold {
568 my( $class, $session, $copy, $user ) = @_;
569 return $class->find_nearest_permitted_hold($session, $copy, $user);
573 sub fetch_open_hold_by_current_copy {
576 my $hold = $apputils->simplereq(
578 'open-ils.cstore.direct.action.hold_request.search.atomic',
579 { current_copy => $copyid , cancel_time => undef, fulfillment_time => undef });
580 return $hold->[0] if ref($hold);
584 sub fetch_related_holds {
587 return $apputils->simplereq(
589 'open-ils.cstore.direct.action.hold_request.search.atomic',
590 { current_copy => $copyid , cancel_time => undef, fulfillment_time => undef });
594 __PACKAGE__->register_method (
595 method => "hold_pull_list",
596 api_name => "open-ils.circ.hold_pull_list.retrieve",
598 Returns a list of holds that need to be "pulled"
603 __PACKAGE__->register_method (
604 method => "hold_pull_list",
605 api_name => "open-ils.circ.hold_pull_list.id_list.retrieve",
607 Returns a list of hold ID's that need to be "pulled"
614 my( $self, $conn, $authtoken, $limit, $offset ) = @_;
615 my( $reqr, $evt ) = $U->checkses($authtoken);
618 my $org = $reqr->ws_ou || $reqr->home_ou;
619 # the perm locaiton shouldn't really matter here since holds
620 # will exist all over and VIEW_HOLDS should be universal
621 $evt = $U->check_perms($reqr->id, $org, 'VIEW_HOLD');
624 if( $self->api_name =~ /id_list/ ) {
625 return $U->storagereq(
626 'open-ils.storage.direct.action.hold_request.pull_list.id_list.current_copy_circ_lib.atomic',
627 $org, $limit, $offset );
629 return $U->storagereq(
630 'open-ils.storage.direct.action.hold_request.pull_list.search.current_copy_circ_lib.atomic',
631 $org, $limit, $offset );
635 __PACKAGE__->register_method (
636 method => 'fetch_hold_notify',
637 api_name => 'open-ils.circ.hold_notification.retrieve_by_hold',
639 Returns a list of hold notification objects based on hold id.
640 @param authtoken The loggin session key
641 @param holdid The id of the hold whose notifications we want to retrieve
642 @return An array of hold notification objects, event on error.
646 sub fetch_hold_notify {
647 my( $self, $conn, $authtoken, $holdid ) = @_;
648 my( $requestor, $evt ) = $U->checkses($authtoken);
651 ($hold, $evt) = $U->fetch_hold($holdid);
653 ($patron, $evt) = $U->fetch_user($hold->usr);
656 $evt = $U->check_perms($requestor->id, $patron->home_ou, 'VIEW_HOLD_NOTIFICATION');
659 $logger->info("User ".$requestor->id." fetching hold notifications for hold $holdid");
660 return $U->cstorereq(
661 'open-ils.cstore.direct.action.hold_notification.search.atomic', {hold => $holdid} );
665 __PACKAGE__->register_method (
666 method => 'create_hold_notify',
667 api_name => 'open-ils.circ.hold_notification.create',
669 Creates a new hold notification object
670 @param authtoken The login session key
671 @param notification The hold notification object to create
672 @return ID of the new object on success, Event on error
675 sub create_hold_notify {
676 my( $self, $conn, $authtoken, $notification ) = @_;
677 my( $requestor, $evt ) = $U->checkses($authtoken);
680 ($hold, $evt) = $U->fetch_hold($notification->hold);
682 ($patron, $evt) = $U->fetch_user($hold->usr);
685 # XXX perm depth probably doesn't matter here -- should always be consortium level
686 $evt = $U->check_perms($requestor->id, $patron->home_ou, 'CREATE_HOLD_NOTIFICATION');
689 # Set the proper notifier
690 $notification->notify_staff($requestor->id);
691 my $id = $U->storagereq(
692 'open-ils.storage.direct.action.hold_notification.create', $notification );
693 return $U->DB_UPDATE_FAILED($notification) unless $id;
694 $logger->info("User ".$requestor->id." successfully created new hold notification $id");
699 __PACKAGE__->register_method(
700 method => 'reset_hold',
701 api_name => 'open-ils.circ.hold.reset',
703 Un-captures and un-targets a hold, essentially returning
704 it to the state it was in directly after it was placed,
705 then attempts to re-target the hold
706 @param authtoken The login session key
707 @param holdid The id of the hold
713 my( $self, $conn, $auth, $holdid ) = @_;
715 my ($hold, $evt) = $U->fetch_hold($holdid);
717 ($reqr, $evt) = $U->checksesperm($auth, 'UPDATE_HOLD'); # XXX stronger permission
719 $evt = $self->_reset_hold($reqr, $hold);
725 my ($self, $reqr, $hold) = @_;
727 my $e = new_editor(xact =>1, requestor => $reqr);
729 $logger->info("reseting hold ".$hold->id);
733 if( $hold->capture_time and $hold->current_copy ) {
735 my $copy = $e->retrieve_asset_copy($hold->current_copy)
738 if( $copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF ) {
739 $logger->info("setting copy to status 'reshelving' on hold retarget");
740 $copy->status(OILS_COPY_STATUS_RESHELVING);
741 $copy->editor($e->requestor->id);
742 $copy->edit_date('now');
743 $e->update_asset_copy($copy) or return $e->event;
745 } elsif( $copy->status == OILS_COPY_STATUS_IN_TRANSIT ) {
747 # We don't want the copy to remain "in transit"
748 $copy->status(OILS_COPY_STATUS_RESHELVING);
749 $logger->warn("! reseting hold [$hid] that is in transit");
750 my $transid = $e->search_action_hold_transit_copy({hold=>$hold->id},{idlist=>1})->[0];
753 my $trans = $e->retrieve_action_transit_copy($transid);
755 $logger->info("Aborting transit [$transid] on hold [$hid] reset...");
756 my $evt = OpenILS::Application::Circ::Transit::__abort_transit($e, $trans, $copy, 1);
757 $logger->info("Transit abort completed with result $evt");
758 return $evt unless "$evt" eq 1;
764 $hold->clear_capture_time;
765 $hold->clear_current_copy;
767 $e->update_action_hold_request($hold) or return $e->event;
771 'open-ils.storage.action.hold_request.copy_targeter', undef, $hold->id );
777 __PACKAGE__->register_method(
778 method => 'fetch_open_title_holds',
779 api_name => 'open-ils.circ.open_holds.retrieve',
781 Returns a list ids of un-fulfilled holds for a given title id
782 @param authtoken The login session key
783 @param id the id of the item whose holds we want to retrieve
784 @param type The hold type - M, T, V, C
788 sub fetch_open_title_holds {
789 my( $self, $conn, $auth, $id, $type, $org ) = @_;
790 my $e = new_editor( authtoken => $auth );
791 return $e->event unless $e->checkauth;
794 $org ||= $e->requestor->ws_ou;
796 # return $e->search_action_hold_request(
797 # { target => $id, hold_type => $type, fulfillment_time => undef }, {idlist=>1});
799 # XXX make me return IDs in the future ^--
800 my $holds = $e->search_action_hold_request(
803 cancel_time => undef,
805 fulfillment_time => undef
809 flesh_hold_transits($holds);
814 sub flesh_hold_transits {
816 for my $hold ( @$holds ) {
818 $apputils->simplereq(
820 "open-ils.cstore.direct.action.hold_transit_copy.search.atomic",
821 { hold => $hold->id },
822 { order_by => { ahtc => 'id desc' }, limit => 1 }
828 sub flesh_hold_notices {
829 my( $holds, $e ) = @_;
832 for my $hold (@$holds) {
833 my $notices = $e->search_action_hold_notification(
835 { hold => $hold->id },
836 { order_by => { anh => { 'notify_time desc' } } },
841 $hold->notify_count(scalar(@$notices));
843 my $n = $e->retrieve_action_hold_notification($$notices[0])
845 $hold->notify_time($n->notify_time);
853 __PACKAGE__->register_method(
854 method => 'fetch_captured_holds',
855 api_name => 'open-ils.circ.captured_holds.on_shelf.retrieve',
857 Returns a list of un-fulfilled holds for a given title id
858 @param authtoken The login session key
859 @param org The org id of the location in question
863 __PACKAGE__->register_method(
864 method => 'fetch_captured_holds',
865 api_name => 'open-ils.circ.captured_holds.id_list.on_shelf.retrieve',
867 Returns a list ids of un-fulfilled holds for a given title id
868 @param authtoken The login session key
869 @param org The org id of the location in question
873 sub fetch_captured_holds {
874 my( $self, $conn, $auth, $org ) = @_;
876 my $e = new_editor(authtoken => $auth);
877 return $e->event unless $e->checkauth;
878 return $e->event unless $e->allowed('VIEW_HOLD'); # XXX rely on editor perm
880 $org ||= $e->requestor->ws_ou;
882 my $holds = $e->search_action_hold_request(
884 capture_time => { "!=" => undef },
885 current_copy => { "!=" => undef },
886 fulfillment_time => undef,
888 cancel_time => undef,
893 for my $h (@$holds) {
894 my $copy = $e->retrieve_asset_copy($h->current_copy)
897 $copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF;
900 if( ! $self->api_name =~ /id_list/ ) {
901 flesh_hold_transits(\@res);
902 flesh_hold_notices(\@res, $e);
905 if( $self->api_name =~ /id_list/ ) {
906 return [ map { $_->id } @res ];
913 __PACKAGE__->register_method(
914 method => "check_title_hold",
915 api_name => "open-ils.circ.title_hold.is_possible",
917 Determines if a hold were to be placed by a given user,
918 whether or not said hold would have any potential copies
920 @param authtoken The login session key
921 @param params A hash of named params including:
922 patronid - the id of the hold recipient
923 titleid (brn) - the id of the title to be held
924 depth - the hold range depth (defaults to 0)
927 sub check_title_hold {
928 my( $self, $client, $authtoken, $params ) = @_;
930 my %params = %$params;
931 my $titleid = $params{titleid} ||"";
932 my $volid = $params{volume_id};
933 my $copyid = $params{copy_id};
934 my $mrid = $params{mrid} ||"";
935 my $depth = $params{depth} || 0;
936 my $pickup_lib = $params{pickup_lib};
937 my $hold_type = $params{hold_type} || 'T';
939 my $e = new_editor(authtoken=>$authtoken);
940 return $e->event unless $e->checkauth;
941 my $patron = $e->retrieve_actor_user($params{patronid})
944 if( $e->requestor->id ne $patron->id ) {
945 return $e->event unless
946 $e->allowed('VIEW_HOLD_PERMIT', $patron->home_ou);
949 return OpenILS::Event->new('PATRON_BARRED')
950 if $patron->barred and
951 ($patron->barred =~ /t/i or $patron->barred == 1);
953 my $rangelib = $params{range_lib} || $patron->home_ou;
955 my $request_lib = $e->retrieve_actor_org_unit($e->requestor->ws_ou)
958 $logger->info("checking hold possibility with type $hold_type");
964 if( $hold_type eq OILS_HOLD_TYPE_COPY ) {
966 $copy = $e->retrieve_asset_copy($copyid) or return $e->event;
967 $volume = $e->retrieve_asset_call_number($copy->call_number)
969 $title = $e->retrieve_biblio_record_entry($volume->record)
971 return verify_copy_for_hold(
972 $patron, $e->requestor, $title, $copy, $pickup_lib, $request_lib );
974 } elsif( $hold_type eq OILS_HOLD_TYPE_VOLUME ) {
976 $volume = $e->retrieve_asset_call_number($volid)
978 $title = $e->retrieve_biblio_record_entry($volume->record)
981 return _check_volume_hold_is_possible(
982 $volume, $title, $rangelib, $depth, $request_lib, $patron, $e->requestor, $pickup_lib);
984 } elsif( $hold_type eq OILS_HOLD_TYPE_TITLE ) {
986 return _check_title_hold_is_possible(
987 $titleid, $rangelib, $depth, $request_lib, $patron, $e->requestor, $pickup_lib);
989 } elsif( $hold_type eq OILS_HOLD_TYPE_METARECORD ) {
991 my $maps = $e->search_metabib_source_map({metarecord=>$mrid});
992 my @recs = map { $_->source } @$maps;
993 for my $rec (@recs) {
994 return 1 if (_check_title_hold_is_possible(
995 $rec, $rangelib, $depth, $request_lib, $patron, $e->requestor, $pickup_lib));
1003 sub _check_title_hold_is_possible {
1004 my( $titleid, $rangelib, $depth, $request_lib, $patron, $requestor, $pickup_lib ) = @_;
1010 $logger->debug("Fetching ranged title tree for title $titleid, org $rangelib, depth $depth");
1012 while( $title = $U->storagereq(
1013 'open-ils.storage.biblio.record_entry.ranged_tree',
1014 $titleid, $rangelib, $depth, $limit, $offset ) ) {
1018 ref($title->call_numbers) and
1019 @{$title->call_numbers};
1021 for my $cn (@{$title->call_numbers}) {
1023 $logger->debug("Checking callnumber ".$cn->id." for hold fulfillment possibility");
1025 for my $copy (@{$cn->copies}) {
1026 $logger->debug("Checking copy ".$copy->id." for hold fulfillment possibility");
1027 return 1 if verify_copy_for_hold(
1028 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib );
1029 $logger->debug("Copy ".$copy->id." for hold fulfillment possibility failed...");
1038 sub _check_volume_hold_is_possible {
1039 my( $vol, $title, $rangelib, $depth, $request_lib, $patron, $requestor, $pickup_lib ) = @_;
1040 my $copies = new_editor->search_asset_copy({call_number => $vol->id});
1041 $logger->info("checking possibility of volume hold for volume ".$vol->id);
1042 for my $copy ( @$copies ) {
1043 return 1 if verify_copy_for_hold(
1044 $patron, $requestor, $title, $copy, $pickup_lib, $request_lib );
1051 sub verify_copy_for_hold {
1052 my( $patron, $requestor, $title, $copy, $pickup_lib, $request_lib ) = @_;
1053 $logger->info("checking possibility of copy in hold request for copy ".$copy->id);
1054 return 1 if OpenILS::Utils::PermitHold::permit_copy_hold(
1055 { patron => $patron,
1056 requestor => $requestor,
1059 title_descriptor => $title->fixed_fields, # this is fleshed into the title object
1060 pickup_lib => $pickup_lib,
1061 request_lib => $request_lib
1069 sub find_nearest_permitted_hold {
1072 my $session = shift;
1075 my $evt = OpenILS::Event->new('ACTION_HOLD_REQUEST_NOT_FOUND');
1077 # first see if this copy has already been selected to fulfill a hold
1078 my $hold = $session->request(
1079 "open-ils.storage.direct.action.hold_request.search_where",
1080 { current_copy => $copy->id, cancel_time => undef, capture_time => undef } )->gather(1);
1083 $logger->info("hold found which can be fulfilled by copy ".$copy->id);
1087 # We know this hold is permitted, so just return it
1088 return $hold if $hold;
1090 $logger->debug("searching for potential holds at org ".
1091 $user->ws_ou." and copy ".$copy->id);
1093 my $holds = $session->request(
1094 "open-ils.storage.action.hold_request.nearest_hold.atomic",
1095 $user->ws_ou, $copy->id, 5 )->gather(1);
1097 return (undef, $evt) unless @$holds;
1099 # for each potential hold, we have to run the permit script
1100 # to make sure the hold is actually permitted.
1102 for my $holdid (@$holds) {
1103 next unless $holdid;
1104 $logger->info("Checking if hold $holdid is permitted for user ".$user->id);
1106 my ($hold) = $U->fetch_hold($holdid);
1108 my ($reqr) = $U->fetch_user($hold->requestor);
1110 my ($rlib) = $U->fetch_org_unit($hold->request_lib);
1112 return ($hold) if OpenILS::Utils::PermitHold::permit_copy_hold(
1114 patron_id => $hold->usr,
1115 requestor => $reqr->id,
1117 pickup_lib => $hold->pickup_lib,
1118 request_lib => $rlib,
1123 return (undef, $evt);
1131 __PACKAGE__->register_method(
1132 method => 'all_rec_holds',
1133 api_name => 'open-ils.circ.holds.retrieve_all_from_title',
1137 my( $self, $conn, $auth, $title_id, $args ) = @_;
1139 my $e = new_editor(authtoken=>$auth);
1140 $e->checkauth or return $e->event;
1141 $e->allowed('VIEW_HOLD') or return $e->event;
1143 $args ||= { fulfillment_time => undef };
1144 $args->{cancel_time} = undef;
1146 my $resp = { volume_holds => [], copy_holds => [] };
1148 $resp->{title_holds} = $e->search_action_hold_request(
1150 hold_type => OILS_HOLD_TYPE_TITLE,
1151 target => $title_id,
1155 my $vols = $e->search_asset_call_number(
1156 { record => $title_id, deleted => 'f' }, {idlist=>1});
1158 return $resp unless @$vols;
1160 $resp->{volume_holds} = $e->search_action_hold_request(
1162 hold_type => OILS_HOLD_TYPE_VOLUME,
1167 my $copies = $e->search_asset_copy(
1168 { call_number => $vols, deleted => 'f' }, {idlist=>1});
1170 return $resp unless @$copies;
1172 $resp->{copy_holds} = $e->search_action_hold_request(
1174 hold_type => OILS_HOLD_TYPE_COPY,
1186 __PACKAGE__->register_method(
1187 method => 'uber_hold',
1188 api_name => 'open-ils.circ.hold.details.retrieve'
1192 my($self, $client, $auth, $hold_id) = @_;
1193 my $e = new_editor(authtoken=>$auth);
1194 $e->checkauth or return $e->event;
1195 $e->allowed('VIEW_HOLD') or return $e->event;
1199 my $hold = $e->retrieve_action_hold_request(
1204 flesh_fields => { ahr => [ 'current_copy', 'usr' ] }
1207 ) or return $e->event;
1209 my $user = $hold->usr;
1210 $hold->usr($user->id);
1212 my $card = $e->retrieve_actor_card($user->card)
1213 or return $e->event;
1215 my( $mvr, $volume, $copy ) = find_hold_mvr($e, $hold);
1217 flesh_hold_notices([$hold], $e);
1218 flesh_hold_transits([$hold]);
1225 status => _hold_status($e, $hold),
1226 patron_first => $user->first_given_name,
1227 patron_last => $user->family_name,
1228 patron_barcode => $card->barcode,
1234 # -----------------------------------------------------
1235 # Returns the MVR object that represents what the
1237 # -----------------------------------------------------
1239 my( $e, $hold ) = @_;
1245 if( $hold->hold_type eq OILS_HOLD_TYPE_METARECORD ) {
1246 my $mr = $e->retrieve_metabib_metarecord($hold->target)
1247 or return $e->event;
1248 $tid = $mr->master_record;
1250 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_TITLE ) {
1251 $tid = $hold->target;
1253 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_VOLUME ) {
1254 $volume = $e->retrieve_asset_call_number($hold->target)
1255 or return $e->event;
1256 $tid = $volume->record;
1258 } elsif( $hold->hold_type eq OILS_HOLD_TYPE_COPY ) {
1259 $copy = $e->retrieve_asset_copy($hold->target)
1260 or return $e->event;
1261 $volume = $e->retrieve_asset_call_number($copy->call_number)
1262 or return $e->event;
1263 $tid = $volume->record;
1266 if(!$copy and ref $hold->current_copy ) {
1267 $copy = $hold->current_copy;
1268 $hold->current_copy($copy->id);
1271 if(!$volume and $copy) {
1272 $volume = $e->retrieve_asset_call_number($copy->call_number);
1275 my $title = $e->retrieve_biblio_record_entry($tid);
1276 return ( $U->record_to_mvr($title), $volume, $copy );