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/;
31 my $apputils = "OpenILS::Application::AppUtils";
36 __PACKAGE__->register_method(
37 method => "create_hold",
38 api_name => "open-ils.circ.holds.create",
40 Create a new hold for an item. From a permissions perspective,
41 the login session is used as the 'requestor' of the hold.
42 The hold recipient is determined by the 'usr' setting within
45 First we verify the requestion has holds request permissions.
46 Then we verify that the recipient is allowed to make the given hold.
47 If not, we see if the requestor has "override" capabilities. If not,
48 a permission exception is returned. If permissions allow, we cycle
49 through the set of holds objects and create.
51 If the recipient does not have permission to place multiple holds
52 on a single title and said operation is attempted, a permission
57 __PACKAGE__->register_method(
58 method => "create_hold",
59 api_name => "open-ils.circ.holds.create.override",
61 If the recipient is not allowed to receive the requested hold,
62 call this method to attempt the override
63 @see open-ils.circ.holds.create
68 my( $self, $conn, $auth, @holds ) = @_;
69 my $e = new_editor(authtoken=>$auth, xact=>1);
70 return $e->event unless $e->checkauth;
72 my $override = 1 if $self->api_name =~ /override/;
74 my $holds = (ref($holds[0] eq 'ARRAY')) ? $holds[0] : [@holds];
78 for my $hold (@$holds) {
83 my $requestor = $e->requestor;
84 my $recipient = $requestor;
87 if( $requestor->id ne $hold->usr ) {
88 # Make sure the requestor is allowed to place holds for
89 # the recipient if they are not the same people
90 $recipient = $e->retrieve_actor_user($hold->usr) or return $e->event;
91 $e->allowed('REQUEST_HOLDS', $recipient->home_ou) or return $e->event;
94 # Now make sure the recipient is allowed to receive the specified hold
96 my $porg = $recipient->home_ou;
97 my $rid = $e->requestor->id;
98 my $t = $hold->hold_type;
100 # See if a duplicate hold already exists
102 usr => $recipient->id,
104 fulfillment_time => undef,
105 target => $hold->target,
106 cancel_time => undef,
109 $sargs->{holdable_formats} = $hold->holdable_formats if $t eq 'M';
111 my $existing = $e->search_action_hold_request($sargs);
112 push( @events, OpenILS::Event->new('HOLD_EXISTS')) if @$existing;
114 if( $t eq OILS_HOLD_TYPE_METARECORD )
115 { $pevt = $e->event unless $e->checkperm($rid, $porg, 'MR_HOLDS'); }
117 if( $t eq OILS_HOLD_TYPE_TITLE )
118 { $pevt = $e->event unless $e->checkperm($rid, $porg, 'TITLE_HOLDS'); }
120 if( $t eq OILS_HOLD_TYPE_VOLUME )
121 { $pevt = $e->event unless $e->checkperm($rid, $porg, 'VOLUME_HOLDS'); }
123 if( $t eq OILS_HOLD_TYPE_COPY )
124 { $pevt = $e->event unless $e->checkperm($rid, $porg, 'COPY_HOLDS'); }
126 return $pevt if $pevt;
130 for my $evt (@events) {
132 my $name = $evt->{textcode};
133 return $e->event unless $e->allowed("$name.override", $porg);
140 $hold->requestor($e->requestor->id);
141 $hold->selection_ou($recipient->home_ou) unless $hold->selection_ou;
142 $hold = $e->create_action_hold_request($hold) or return $e->event;
143 push( @copyholds, $hold ) if $hold->hold_type eq OILS_HOLD_TYPE_COPY;
148 # Go ahead and target the copy-level holds
150 'open-ils.storage.action.hold_request.copy_targeter',
151 undef, $_->id ) for @copyholds;
157 my( $self, $client, $login_session, @holds) = @_;
159 if(!@holds){return 0;}
160 my( $user, $evt ) = $apputils->checkses($login_session);
164 if(ref($holds[0]) eq 'ARRAY') {
166 } else { $holds = [ @holds ]; }
168 $logger->debug("Iterating over holds requests...");
170 for my $hold (@$holds) {
173 my $type = $hold->hold_type;
175 $logger->activity("User " . $user->id .
176 " creating new hold of type $type for user " . $hold->usr);
179 if($user->id ne $hold->usr) {
180 ( $recipient, $evt ) = $apputils->fetch_user($hold->usr);
190 # am I allowed to place holds for this user?
191 if($hold->requestor ne $hold->usr) {
192 $perm = _check_request_holds_perm($user->id, $user->home_ou);
193 if($perm) { return $perm; }
196 # is this user allowed to have holds of this type?
197 $perm = _check_holds_perm($type, $hold->requestor, $recipient->home_ou);
199 #if there is a requestor, see if the requestor has override privelages
200 if($hold->requestor ne $hold->usr) {
201 $perm = _check_request_holds_override($user->id, $user->home_ou);
202 if($perm) {return $perm;}
209 #enforce the fact that the login is the one requesting the hold
210 $hold->requestor($user->id);
211 $hold->selection_ou($recipient->home_ou) unless $hold->selection_ou;
213 my $resp = $apputils->simplereq(
215 'open-ils.storage.direct.action.hold_request.create', $hold );
218 return OpenSRF::EX::ERROR ("Error creating hold");
225 # makes sure that a user has permission to place the type of requested hold
226 # returns the Perm exception if not allowed, returns undef if all is well
227 sub _check_holds_perm {
228 my($type, $user_id, $org_id) = @_;
232 if($evt = $apputils->check_perms(
233 $user_id, $org_id, "MR_HOLDS")) {
237 } elsif ($type eq "T") {
238 if($evt = $apputils->check_perms(
239 $user_id, $org_id, "TITLE_HOLDS")) {
243 } elsif($type eq "V") {
244 if($evt = $apputils->check_perms(
245 $user_id, $org_id, "VOLUME_HOLDS")) {
249 } elsif($type eq "C") {
250 if($evt = $apputils->check_perms(
251 $user_id, $org_id, "COPY_HOLDS")) {
259 # tests if the given user is allowed to place holds on another's behalf
260 sub _check_request_holds_perm {
263 if(my $evt = $apputils->check_perms(
264 $user_id, $org_id, "REQUEST_HOLDS")) {
269 sub _check_request_holds_override {
272 if(my $evt = $apputils->check_perms(
273 $user_id, $org_id, "REQUEST_HOLDS_OVERRIDE")) {
278 __PACKAGE__->register_method(
279 method => "retrieve_holds_by_id",
280 api_name => "open-ils.circ.holds.retrieve_by_id",
282 Retrieve the hold, with hold transits attached, for the specified id The login session is the requestor and if the requestor is
283 different from the user, then the requestor must have VIEW_HOLD permissions.
287 sub retrieve_holds_by_id {
288 my($self, $client, $auth, $hold_id) = @_;
289 my $e = new_editor(authtoken=>$auth);
290 $e->checkauth or return $e->event;
291 $e->allowed('VIEW_HOLD') or return $e->event;
293 my $holds = $e->search_action_hold_request(
295 { id => $hold_id , fulfillment_time => undef },
296 { order_by => { ahr => "request_time" } }
300 flesh_hold_transits($holds);
301 flesh_hold_notices($holds, $e);
306 __PACKAGE__->register_method(
307 method => "retrieve_holds",
308 api_name => "open-ils.circ.holds.retrieve",
310 Retrieves all the holds, with hold transits attached, for the specified
311 user id. The login session is the requestor and if the requestor is
312 different from the user, then the requestor must have VIEW_HOLD permissions.
317 my($self, $client, $login_session, $user_id) = @_;
319 my( $user, $target, $evt ) = $apputils->checkses_requestor(
320 $login_session, $user_id, 'VIEW_HOLD' );
323 my $holds = $apputils->simplereq(
325 "open-ils.cstore.direct.action.hold_request.search.atomic",
328 fulfillment_time => undef,
329 cancel_time => undef,
331 { order_by => { ahr => "request_time" } }
334 for my $hold ( @$holds ) {
336 $apputils->simplereq(
338 "open-ils.cstore.direct.action.hold_transit_copy.search.atomic",
339 { hold => $hold->id },
340 { order_by => { ahtc => 'id desc' }, limit => 1 }
348 __PACKAGE__->register_method(
349 method => "retrieve_holds_by_pickup_lib",
350 api_name => "open-ils.circ.holds.retrieve_by_pickup_lib",
352 Retrieves all the holds, with hold transits attached, for the specified
357 sub retrieve_holds_by_pickup_lib {
358 my($self, $client, $login_session, $ou_id) = @_;
360 #FIXME -- put an appropriate permission check here
361 #my( $user, $target, $evt ) = $apputils->checkses_requestor(
362 # $login_session, $user_id, 'VIEW_HOLD' );
363 #return $evt if $evt;
365 my $holds = $apputils->simplereq(
367 "open-ils.cstore.direct.action.hold_request.search.atomic",
369 pickup_lib => $ou_id ,
370 fulfillment_time => undef,
373 { order_by => { ahr => "request_time" } });
376 flesh_hold_transits($holds);
381 __PACKAGE__->register_method(
382 method => "cancel_hold",
383 api_name => "open-ils.circ.hold.cancel",
385 Cancels the specified hold. The login session
386 is the requestor and if the requestor is different from the usr field
387 on the hold, the requestor must have CANCEL_HOLDS permissions.
388 the hold may be either the hold object or the hold id
392 my($self, $client, $auth, $holdid) = @_;
394 my $e = new_editor(authtoken=>$auth, xact=>1);
395 return $e->event unless $e->checkauth;
397 my $hold = $e->retrieve_action_hold_request($holdid)
400 if( $e->requestor->id ne $hold->usr ) {
401 return $e->event unless $e->allowed('CANCEL_HOLDS');
404 return 1 if $hold->cancel_time;
406 # If the hold is captured, reset the copy status
407 if( $hold->capture_time and $hold->current_copy ) {
409 my $copy = $e->retrieve_asset_copy($hold->current_copy)
412 if( $copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF ) {
413 $logger->info("setting copy to status 'reshelving' on hold cancel");
414 $copy->status(OILS_COPY_STATUS_RESHELVING);
415 $copy->editor($e->requestor->id);
416 $copy->edit_date('now');
417 $e->update_asset_copy($copy) or return $e->event;
421 $hold->cancel_time('now');
422 $e->update_action_hold_request($hold)
425 $self->delete_hold_copy_maps($e, $hold->id);
431 sub delete_hold_copy_maps {
436 my $maps = $editor->search_action_hold_copy_map({hold=>$holdid});
438 $editor->delete_action_hold_copy_map($_)
439 or return $editor->event;
445 __PACKAGE__->register_method(
446 method => "update_hold",
447 api_name => "open-ils.circ.hold.update",
449 Updates the specified hold. The login session
450 is the requestor and if the requestor is different from the usr field
451 on the hold, the requestor must have UPDATE_HOLDS permissions.
455 my($self, $client, $login_session, $hold) = @_;
457 my( $requestor, $target, $evt ) = $apputils->checkses_requestor(
458 $login_session, $hold->usr, 'UPDATE_HOLD' );
461 $logger->activity('User ' . $requestor->id .
462 ' updating hold ' . $hold->id . ' for user ' . $target->id );
464 return $U->storagereq(
465 "open-ils.storage.direct.action.hold_request.update", $hold );
469 __PACKAGE__->register_method(
470 method => "retrieve_hold_status",
471 api_name => "open-ils.circ.hold.status.retrieve",
473 Calculates the current status of the hold.
474 the requestor must have VIEW_HOLD permissions if the hold is for a user
475 other than the requestor.
476 Returns -1 on error (for now)
477 Returns 1 for 'waiting for copy to become available'
478 Returns 2 for 'waiting for copy capture'
479 Returns 3 for 'in transit'
480 Returns 4 for 'arrived'
483 sub retrieve_hold_status {
484 my($self, $client, $auth, $hold_id) = @_;
486 my $e = new_editor(authtoken => $auth);
487 return $e->event unless $e->checkauth;
488 my $hold = $e->retrieve_action_hold_request($hold_id)
491 if( $e->requestor->id != $hold->usr ) {
492 return $e->event unless $e->allowed('VIEW_HOLD');
495 return 1 unless $hold->current_copy;
496 return 2 unless $hold->capture_time;
498 my $copy = $e->retrieve_asset_copy($hold->current_copy)
501 return 3 if $copy->status == OILS_COPY_STATUS_IN_TRANSIT;
502 return 4 if $copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF;
512 __PACKAGE__->register_method(
513 method => "capture_copy",
514 api_name => "open-ils.circ.hold.capture_copy.barcode",
516 Captures a copy to fulfil a hold
517 Params is login session and copy barcode
518 Optional param is 'flesh'. If set, we also return the
519 relevant copy and title
520 login mus have COPY_CHECKIN permissions (since this is essentially
524 # XXX deprecate me XXX
527 my( $self, $client, $login_session, $params ) = @_;
528 my %params = %$params;
529 my $barcode = $params{barcode};
532 my( $user, $target, $copy, $hold, $evt );
534 ( $user, $evt ) = $apputils->checkses($login_session);
537 # am I allowed to checkin a copy?
538 $evt = $apputils->check_perms($user->id, $user->home_ou, "COPY_CHECKIN");
541 $logger->info("Capturing copy with barcode $barcode");
543 my $session = $apputils->start_db_session();
545 ($copy, $evt) = $apputils->fetch_copy_by_barcode($barcode);
548 $logger->debug("Capturing copy " . $copy->id);
550 #( $hold, $evt ) = _find_local_hold_for_copy($session, $copy, $user);
551 ( $hold, $evt ) = $self->find_nearest_permitted_hold($session, $copy, $user);
554 warn "Found hold " . $hold->id . "\n";
555 $logger->info("We found a hold " .$hold->id. "for capturing copy with barcode $barcode");
557 $hold->current_copy($copy->id);
558 $hold->capture_time("now");
561 my $stat = $session->request(
562 "open-ils.storage.direct.action.hold_request.update", $hold)->gather(1);
563 if(!$stat) { throw OpenSRF::EX::ERROR
564 ("Error updating hold request " . $copy->id); }
566 $copy->status(OILS_COPY_STATUS_ON_HOLDS_SHELF); #status on holds shelf
568 # if the staff member capturing this item is not at the pickup lib
569 if( $user->home_ou ne $hold->pickup_lib ) {
570 $self->_build_hold_transit( $login_session, $session, $hold, $user, $copy );
573 $copy->editor($user->id);
574 $copy->edit_date("now");
575 $stat = $session->request(
576 "open-ils.storage.direct.asset.copy.update", $copy )->gather(1);
577 if(!$stat) { throw OpenSRF::EX ("Error updating copy " . $copy->id); }
579 my $payload = { hold => $hold };
580 $payload->{copy} = $copy if $params{flesh_copy};
582 if($params{flesh_record}) {
584 ($record, $evt) = $apputils->fetch_record_by_copy( $copy->id );
586 $record = $apputils->record_to_mvr($record);
587 $payload->{record} = $record;
590 $apputils->commit_db_session($session);
592 return OpenILS::Event->new('ROUTE_ITEM',
593 route_to => $hold->pickup_lib, payload => $payload );
596 sub _build_hold_transit {
597 my( $self, $login_session, $session, $hold, $user, $copy ) = @_;
598 my $trans = Fieldmapper::action::hold_transit_copy->new;
600 $trans->hold($hold->id);
601 $trans->source($user->home_ou);
602 $trans->dest($hold->pickup_lib);
603 $trans->source_send_time("now");
604 $trans->target_copy($copy->id);
605 $trans->copy_status($copy->status);
607 my $meth = $self->method_lookup("open-ils.circ.hold_transit.create");
608 my ($stat) = $meth->run( $login_session, $trans, $session );
609 if(!$stat) { throw OpenSRF::EX ("Error creating new hold transit"); }
610 else { $copy->status(6); } #status in transit
615 __PACKAGE__->register_method(
616 method => "create_hold_transit",
617 api_name => "open-ils.circ.hold_transit.create",
619 Creates a new transit object
622 sub create_hold_transit {
623 my( $self, $client, $login_session, $transit, $session ) = @_;
625 my( $user, $evt ) = $apputils->checkses($login_session);
627 $evt = $apputils->check_perms($user->id, $user->home_ou, "CREATE_TRANSIT");
631 if($session) { $ses = $session; }
632 else { $ses = OpenSRF::AppSession->create("open-ils.storage"); }
634 return $ses->request(
635 "open-ils.storage.direct.action.hold_transit_copy.create", $transit )->gather(1);
641 sub find_local_hold {
642 my( $class, $session, $copy, $user ) = @_;
643 return $class->find_nearest_permitted_hold($session, $copy, $user);
651 sub fetch_open_hold_by_current_copy {
654 my $hold = $apputils->simplereq(
656 'open-ils.cstore.direct.action.hold_request.search.atomic',
657 { current_copy => $copyid , cancel_time => undef, fulfillment_time => undef });
658 return $hold->[0] if ref($hold);
662 sub fetch_related_holds {
665 return $apputils->simplereq(
667 'open-ils.cstore.direct.action.hold_request.search.atomic',
668 { current_copy => $copyid , cancel_time => undef, fulfillment_time => undef });
672 __PACKAGE__->register_method (
673 method => "hold_pull_list",
674 api_name => "open-ils.circ.hold_pull_list.retrieve",
676 Returns a list of hold ID's that need to be "pulled"
682 my( $self, $conn, $authtoken, $limit, $offset ) = @_;
683 my( $reqr, $evt ) = $U->checkses($authtoken);
686 my $org = $reqr->ws_ou || $reqr->home_ou;
687 # the perm locaiton shouldn't really matter here since holds
688 # will exist all over and VIEW_HOLDS should be universal
689 $evt = $U->check_perms($reqr->id, $org, 'VIEW_HOLD');
692 return $U->storagereq(
693 'open-ils.storage.direct.action.hold_request.pull_list.search.current_copy_circ_lib.atomic',
694 $org, $limit, $offset );
697 __PACKAGE__->register_method (
698 method => 'fetch_hold_notify',
699 api_name => 'open-ils.circ.hold_notification.retrieve_by_hold',
701 Returns a list of hold notification objects based on hold id.
702 @param authtoken The loggin session key
703 @param holdid The id of the hold whose notifications we want to retrieve
704 @return An array of hold notification objects, event on error.
708 sub fetch_hold_notify {
709 my( $self, $conn, $authtoken, $holdid ) = @_;
710 my( $requestor, $evt ) = $U->checkses($authtoken);
713 ($hold, $evt) = $U->fetch_hold($holdid);
715 ($patron, $evt) = $U->fetch_user($hold->usr);
718 $evt = $U->check_perms($requestor->id, $patron->home_ou, 'VIEW_HOLD_NOTIFICATION');
721 $logger->info("User ".$requestor->id." fetching hold notifications for hold $holdid");
722 return $U->cstorereq(
723 'open-ils.cstore.direct.action.hold_notification.search.atomic', {hold => $holdid} );
727 __PACKAGE__->register_method (
728 method => 'create_hold_notify',
729 api_name => 'open-ils.circ.hold_notification.create',
731 Creates a new hold notification object
732 @param authtoken The login session key
733 @param notification The hold notification object to create
734 @return ID of the new object on success, Event on error
737 sub create_hold_notify {
738 my( $self, $conn, $authtoken, $notification ) = @_;
739 my( $requestor, $evt ) = $U->checkses($authtoken);
742 ($hold, $evt) = $U->fetch_hold($notification->hold);
744 ($patron, $evt) = $U->fetch_user($hold->usr);
747 # XXX perm depth probably doesn't matter here -- should always be consortium level
748 $evt = $U->check_perms($requestor->id, $patron->home_ou, 'CREATE_HOLD_NOTIFICATION');
751 # Set the proper notifier
752 $notification->notify_staff($requestor->id);
753 my $id = $U->storagereq(
754 'open-ils.storage.direct.action.hold_notification.create', $notification );
755 return $U->DB_UPDATE_FAILED($notification) unless $id;
756 $logger->info("User ".$requestor->id." successfully created new hold notification $id");
761 __PACKAGE__->register_method(
762 method => 'reset_hold',
763 api_name => 'open-ils.circ.hold.reset',
765 Un-captures and un-targets a hold, essentially returning
766 it to the state it was in directly after it was placed,
767 then attempts to re-target the hold
768 @param authtoken The login session key
769 @param holdid The id of the hold
775 my( $self, $conn, $auth, $holdid ) = @_;
777 my ($hold, $evt) = $U->fetch_hold($holdid);
779 ($reqr, $evt) = $U->checksesperm($auth, 'UPDATE_HOLD'); # XXX stronger permission
781 $evt = $self->_reset_hold($reqr, $hold);
787 my ($self, $reqr, $hold) = @_;
789 my $e = new_editor(xact =>1, requestor => $reqr);
791 $logger->info("reseting hold ".$hold->id);
793 if( $hold->capture_time and $hold->current_copy ) {
795 my $copy = $e->retrieve_asset_copy($hold->current_copy)
798 if( $copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF ) {
799 $logger->info("setting copy to status 'reshelving' on hold retarget");
800 $copy->status(OILS_COPY_STATUS_RESHELVING);
801 $copy->editor($e->requestor->id);
802 $copy->edit_date('now');
803 $e->update_asset_copy($copy) or return $e->event;
805 } elsif( $copy->status == OILS_COPY_STATUS_IN_TRANSIT ) {
806 $logger->warn("reseting hold that is in transit: ".$hold->id);
811 $hold->clear_capture_time;
812 $hold->clear_current_copy;
814 $e->update_action_hold_request($hold) or return $e->event;
819 'open-ils.storage.action.hold_request.copy_targeter', undef, $hold->id );
825 __PACKAGE__->register_method(
826 method => 'fetch_open_title_holds',
827 api_name => 'open-ils.circ.open_holds.retrieve',
829 Returns a list ids of un-fulfilled holds for a given title id
830 @param authtoken The login session key
831 @param id the id of the item whose holds we want to retrieve
832 @param type The hold type - M, T, V, C
836 sub fetch_open_title_holds {
837 my( $self, $conn, $auth, $id, $type, $org ) = @_;
838 my $e = new_editor( authtoken => $auth );
839 return $e->event unless $e->checkauth;
842 $org ||= $e->requestor->ws_ou;
844 # return $e->search_action_hold_request(
845 # { target => $id, hold_type => $type, fulfillment_time => undef }, {idlist=>1});
847 # XXX make me return IDs in the future ^--
848 my $holds = $e->search_action_hold_request(
851 cancel_time => undef,
853 fulfillment_time => undef
857 flesh_hold_transits($holds);
862 sub flesh_hold_transits {
864 for my $hold ( @$holds ) {
866 $apputils->simplereq(
868 "open-ils.cstore.direct.action.hold_transit_copy.search.atomic",
869 { hold => $hold->id },
870 { order_by => { ahtc => 'id desc' }, limit => 1 }
876 sub flesh_hold_notices {
877 my( $holds, $e ) = @_;
880 for my $hold (@$holds) {
881 my $notices = $e->search_action_hold_notification(
883 { hold => $hold->id },
884 { order_by => { anh => { 'notify_time desc' } } },
889 $hold->notify_count(scalar(@$notices));
891 my $n = $e->retrieve_action_hold_notification($$notices[0])
893 $hold->notify_time($n->notify_time);
901 __PACKAGE__->register_method(
902 method => 'fetch_captured_holds',
903 api_name => 'open-ils.circ.captured_holds.on_shelf.retrieve',
905 Returns a list ids of un-fulfilled holds for a given title id
906 @param authtoken The login session key
907 @param org The org id of the location in question
910 sub fetch_captured_holds {
911 my( $self, $conn, $auth, $org ) = @_;
913 my $e = new_editor(authtoken => $auth);
914 return $e->event unless $e->checkauth;
915 return $e->event unless $e->allowed('VIEW_HOLD'); # XXX rely on editor perm
917 $org ||= $e->requestor->ws_ou;
919 my $holds = $e->search_action_hold_request(
921 capture_time => { "!=" => undef },
922 current_copy => { "!=" => undef },
923 fulfillment_time => undef,
925 cancel_time => undef,
930 for my $h (@$holds) {
931 my $copy = $e->retrieve_asset_copy($h->current_copy)
934 $copy->status == OILS_COPY_STATUS_ON_HOLDS_SHELF;
937 flesh_hold_transits(\@res);
938 flesh_hold_notices(\@res, $e);
946 __PACKAGE__->register_method(
947 method => "check_title_hold",
948 api_name => "open-ils.circ.title_hold.is_possible",
950 Determines if a hold were to be placed by a given user,
951 whether or not said hold would have any potential copies
953 @param authtoken The login session key
954 @param params A hash of named params including:
955 patronid - the id of the hold recipient
956 titleid (brn) - the id of the title to be held
957 depth - the hold range depth (defaults to 0)
960 sub check_title_hold {
961 my( $self, $client, $authtoken, $params ) = @_;
963 my %params = %$params;
964 my $titleid = $params{titleid} ||"";
965 my $mrid = $params{mrid} ||"";
966 my $depth = $params{depth} || 0;
967 my $pickup_lib = $params{pickup_lib};
968 my $hold_type = $params{hold_type} || 'T';
970 my $e = new_editor(authtoken=>$authtoken);
971 return $e->event unless $e->checkauth;
972 my $patron = $e->retrieve_actor_user($params{patronid})
975 if( $e->requestor->id ne $patron->id ) {
976 return $e->event unless
977 $e->allowed('VIEW_HOLD_PERMIT', $patron->home_ou);
980 return OpenILS::Event->new('PATRON_BARRED')
981 if $patron->barred and
982 ($patron->barred =~ /t/i or $patron->barred == 1);
984 my $rangelib = $params{range_lib} || $patron->home_ou;
986 my $request_lib = $e->retrieve_actor_org_unit($e->requestor->ws_ou)
989 if( $hold_type eq 'T' ) {
990 return _check_title_hold_is_possible(
991 $titleid, $rangelib, $depth, $request_lib, $patron, $e->requestor, $pickup_lib);
994 if( $hold_type eq 'M' ) {
995 my $maps = $e->search_metabib_source_map({metarecord=>$mrid});
996 my @recs = map { $_->source } @$maps;
997 for my $rec (@recs) {
998 return 1 if (_check_title_hold_is_possible(
999 $rec, $rangelib, $depth, $request_lib, $patron, $e->requestor, $pickup_lib));
1006 sub _check_title_hold_is_possible {
1007 my( $titleid, $rangelib, $depth, $request_lib, $patron, $requestor, $pickup_lib ) = @_;
1013 $logger->debug("Fetching ranged title tree for title $titleid, org $rangelib, depth $depth");
1015 while( $title = $U->storagereq(
1016 'open-ils.storage.biblio.record_entry.ranged_tree',
1017 $titleid, $rangelib, $depth, $limit, $offset ) ) {
1021 ref($title->call_numbers) and
1022 @{$title->call_numbers};
1024 for my $cn (@{$title->call_numbers}) {
1026 $logger->debug("Checking callnumber ".$cn->id." for hold fulfillment possibility");
1028 for my $copy (@{$cn->copies}) {
1030 $logger->debug("Checking copy ".$copy->id." for hold fulfillment possibility");
1032 return 1 if OpenILS::Utils::PermitHold::permit_copy_hold(
1033 { patron => $patron,
1034 requestor => $requestor,
1037 title_descriptor => $title->fixed_fields, # this is fleshed into the title object
1038 pickup_lib => $pickup_lib,
1039 request_lib => $request_lib
1043 $logger->debug("Copy ".$copy->id." for hold fulfillment possibility failed...");
1054 sub find_nearest_permitted_hold {
1057 my $session = shift;
1060 my $evt = OpenILS::Event->new('ACTION_HOLD_REQUEST_NOT_FOUND');
1062 # first see if this copy has already been selected to fulfill a hold
1063 my $hold = $session->request(
1064 "open-ils.storage.direct.action.hold_request.search_where",
1065 { current_copy => $copy->id, cancel_time => undef, capture_time => undef } )->gather(1);
1068 $logger->info("hold found which can be fulfilled by copy ".$copy->id);
1072 # We know this hold is permitted, so just return it
1073 return $hold if $hold;
1075 $logger->debug("searching for potential holds at org ".
1076 $user->ws_ou." and copy ".$copy->id);
1078 my $holds = $session->request(
1079 "open-ils.storage.action.hold_request.nearest_hold.atomic",
1080 $user->ws_ou, $copy->id, 5 )->gather(1);
1082 return (undef, $evt) unless @$holds;
1084 # for each potential hold, we have to run the permit script
1085 # to make sure the hold is actually permitted.
1087 for my $holdid (@$holds) {
1088 next unless $holdid;
1089 $logger->info("Checking if hold $holdid is permitted for user ".$user->id);
1091 my ($hold) = $U->fetch_hold($holdid);
1093 my ($reqr) = $U->fetch_user($hold->requestor);
1095 return ($hold) if OpenILS::Utils::PermitHold::permit_copy_hold(
1097 patron_id => $hold->usr,
1098 requestor => $reqr->id,
1100 pickup_lib => $hold->pickup_lib,
1101 request_lib => $hold->request_lib
1106 return (undef, $evt);
1110 __PACKAGE__->register_method(
1111 method => 'all_rec_holds',
1112 api_name => 'open-ils.circ.holds.retrieve_all_from_title',
1116 my( $self, $conn, $auth, $title_id, $args ) = @_;
1118 my $e = new_editor(authtoken=>$auth);
1119 $e->checkauth or return $e->event;
1120 $e->allowed('VIEW_HOLD') or return $e->event;
1122 $args ||= { fulfillment_time => undef };
1123 $args->{cancel_time} = undef;
1127 $resp->{title_holds} = $e->search_action_hold_request(
1129 hold_type => OILS_HOLD_TYPE_TITLE,
1130 target => $title_id,
1134 my $vols = $e->search_asset_call_number(
1135 { record => $title_id, deleted => 'f' }, {idlist=>1});
1137 $resp->{volume_holds} = (!@$vols) ? [] : $e->search_action_hold_request(
1139 hold_type => OILS_HOLD_TYPE_VOLUME,
1144 my $copies = $e->search_asset_copy(
1145 { call_number => $vols, deleted => 'f' }, {idlist=>1});
1147 $resp->{copy_holds} = (!@$copies) ? [] : $e->search_action_hold_request(
1149 hold_type => OILS_HOLD_TYPE_COPY,