From: senator <senator@dcc99617-32d9-48b4-a31d-7c20da2025e4>
Date: Thu, 10 Jun 2010 15:34:34 +0000 (+0000)
Subject: Hold requests in the middle layer now bubble up more specific information to
X-Git-Url: https://old-git.evergreen-ils.org/?a=commitdiff_plain;h=252fcdd7e4262ac2db619443c2e53570dcd4fc31;p=contrib%2FConifer.git
Hold requests in the middle layer now bubble up more specific information to
the caller in the event of failure.
The caller can find an ilsevent in the response received from calling
open-ils.circ.title_hold.is_possible, and this event will have a fail_part
attribute in its payload that can be mapped either to a) the new entities
in opac.dtd or b) values of the name column of the database table
config.standing_penalty, depending on why a hold request failed.
git-svn-id: svn://svn.open-ils.org/ILS/trunk@16651 dcc99617-32d9-48b4-a31d-7c20da2025e4
---
diff --git a/Open-ILS/src/extras/ils_events.xml b/Open-ILS/src/extras/ils_events.xml
index b4cb739d10..c26a6fc823 100644
--- a/Open-ILS/src/extras/ils_events.xml
+++ b/Open-ILS/src/extras/ils_events.xml
@@ -734,6 +734,9 @@
<event code='1713' textcode='SURVEY_RESPONSES_EXIST'>
<desc xml:lang="en-US">Responses to this survey exist</desc>
</event>
+ <event code='1714' textcode='HIGH_LEVEL_HOLD_HAS_NO_COPIES'>
+ <desc xml:lang="en-US">A hold request at a higher level than copy has been attempted, but there are no copies that belonging to the higher-level unit.</desc>
+ </event>
<event code='2000' textcode='BAD_PARAMS'>
diff --git a/Open-ILS/src/perlmods/OpenILS/Application/Circ/Holds.pm b/Open-ILS/src/perlmods/OpenILS/Application/Circ/Holds.pm
index a1c6caed5e..2904cb0f49 100644
--- a/Open-ILS/src/perlmods/OpenILS/Application/Circ/Holds.pm
+++ b/Open-ILS/src/perlmods/OpenILS/Application/Circ/Holds.pm
@@ -1639,6 +1639,8 @@ sub check_title_hold {
my $soft_boundary = $U->ou_ancestor_setting_value($selection_ou, OILS_SETTING_HOLD_SOFT_BOUNDARY);
my $hard_boundary = $U->ou_ancestor_setting_value($selection_ou, OILS_SETTING_HOLD_HARD_BOUNDARY);
+ my @status = ();
+ my $return_depth = $hard_boundary; # default depth to return on success
if(defined $soft_boundary and $depth < $soft_boundary) {
# work up the tree and as soon as we find a potential copy, use that depth
# also, make sure we don't go past the hard boundary if it exists
@@ -1650,26 +1652,35 @@ sub check_title_hold {
my $depth = $soft_boundary;
while($depth >= $min_depth) {
$logger->info("performing hold possibility check with soft boundary $depth");
- my @status = do_possibility_checks($e, $patron, $request_lib, $depth, %params);
- return {success => 1, depth => $depth, local_avail => $status[1]} if $status[0];
+ @status = do_possibility_checks($e, $patron, $request_lib, $depth, %params);
+ if ($status[0]) {
+ $return_depth = $depth;
+ last;
+ }
$depth--;
}
} elsif(defined $hard_boundary and $depth < $hard_boundary) {
# there is no soft boundary, enforce the hard boundary if it exists
$logger->info("performing hold possibility check with hard boundary $hard_boundary");
- my @status = do_possibility_checks($e, $patron, $request_lib, $hard_boundary, %params);
- if($status[0]) {
- return {success => 1, depth => $hard_boundary, local_avail => $status[1]}
- }
+ @status = do_possibility_checks($e, $patron, $request_lib, $hard_boundary, %params);
} else {
# no boundaries defined, fall back to user specifed boundary or no boundary
$logger->info("performing hold possibility check with no boundary");
- my @status = do_possibility_checks($e, $patron, $request_lib, $params{depth}, %params);
- if($status[0]) {
- return {success => 1, depth => $hard_boundary, local_avail => $status[1]};
- }
+ @status = do_possibility_checks($e, $patron, $request_lib, $params{depth}, %params);
+ }
+
+ if ($status[0]) {
+ return {
+ "success" => 1,
+ "depth" => $return_depth,
+ "local_avail" => $status[1]
+ };
+ } elsif ($status[2]) {
+ my $n = scalar @{$status[2]};
+ return {"success" => 0, "last_event" => $status[2]->[$n - 1]};
+ } else {
+ return {"success" => 0};
}
- return {success => 0};
}
sub do_possibility_checks {
@@ -1717,12 +1728,14 @@ sub do_possibility_checks {
my $maps = $e->search_metabib_metarecord_source_map({metarecord=>$mrid});
my @recs = map { $_->source } @$maps;
+ my @status = ();
for my $rec (@recs) {
- my @status = _check_title_hold_is_possible(
- $rec, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou);
- return @status if $status[1];
+ @status = _check_title_hold_is_possible(
+ $rec, $depth, $request_lib, $patron, $e->requestor, $pickup_lib, $selection_ou
+ );
+ last if $status[1];
}
- return (0);
+ return @status;
}
# else { Unrecognized hold_type ! } # FIXME: return error? or 0?
}
@@ -1786,7 +1799,14 @@ sub _check_title_hold_is_possible {
);
$logger->info("title possible found ".scalar(@$copies)." potential copies");
- return (0) unless @$copies;
+ return (
+ 0, 0, [
+ new OpenILS::Event(
+ "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
+ "payload" => {"fail_part" => "no_ultimate_items"}
+ )
+ ]
+ ) unless @$copies;
# -----------------------------------------------------------------------
# sort the copies into buckets based on their circ_lib proximity to
@@ -1838,7 +1858,8 @@ sub _check_title_hold_is_possible {
my $title;
my %seen;
- for my $key (@keys) {
+ my @status;
+ OUTER: for my $key (@keys) {
my @cps = @{$buckets{$key}};
$logger->info("looking at " . scalar(@{$buckets{$key}}). " copies in proximity bucket $key");
@@ -1856,14 +1877,14 @@ sub _check_title_hold_is_possible {
$title = $vol->record;
}
- my @status = verify_copy_for_hold(
- $patron, $requestor, $title, $copy, $pickup_lib, $request_lib );
+ @status = verify_copy_for_hold(
+ $patron, $requestor, $title, $copy, $pickup_lib, $request_lib);
- return @status if $status[0];
+ last OUTER if $status[0];
}
}
- return (0);
+ return @status;
}
@@ -1872,12 +1893,23 @@ sub _check_volume_hold_is_possible {
my %org_filter = create_ranged_org_filter(new_editor(), $selection_ou, $depth);
my $copies = new_editor->search_asset_copy({call_number => $vol->id, %org_filter});
$logger->info("checking possibility of volume hold for volume ".$vol->id);
+
+ return (
+ 0, 0, [
+ new OpenILS::Event(
+ "HIGH_LEVEL_HOLD_HAS_NO_COPIES",
+ "payload" => {"fail_part" => "no_ultimate_items"}
+ )
+ ]
+ ) unless @$copies;
+
+ my @status;
for my $copy ( @$copies ) {
- my @status = verify_copy_for_hold(
+ @status = verify_copy_for_hold(
$patron, $requestor, $title, $copy, $pickup_lib, $request_lib );
- return @status if $status[0];
+ last if $status[0];
}
- return (0);
+ return @status;
}
@@ -1893,16 +1925,18 @@ sub verify_copy_for_hold {
title_descriptor => $title->fixed_fields, # this is fleshed into the title object
pickup_lib => $pickup_lib,
request_lib => $request_lib,
- new_hold => 1
+ new_hold => 1,
+ show_event_list => 1
}
);
return (
- $permitted,
+ (not scalar @$permitted), # true if permitted is an empty arrayref
(
($copy->circ_lib == $pickup_lib) and
($copy->status == OILS_COPY_STATUS_AVAILABLE)
- )
+ ),
+ $permitted
);
}
diff --git a/Open-ILS/src/perlmods/OpenILS/Utils/PermitHold.pm b/Open-ILS/src/perlmods/OpenILS/Utils/PermitHold.pm
index f0e6b74c68..b42c6d56ad 100644
--- a/Open-ILS/src/perlmods/OpenILS/Utils/PermitHold.pm
+++ b/Open-ILS/src/perlmods/OpenILS/Utils/PermitHold.pm
@@ -229,7 +229,13 @@ sub indb_hold_permit {
return 0;
}
- return [OpenILS::Event->new('NO_POLICY_MATCHPOINT')] unless @$results;
+ return [
+ new OpenILS::Event(
+ "NO_POLICY_MATCHPOINT",
+ "payload" => {"fail_part" => "no_matchpoint"}
+ )
+ ] unless @$results;
+
return [] if $U->is_true($results->[0]->{success});
return [
diff --git a/Open-ILS/web/opac/locale/en-US/opac.dtd b/Open-ILS/web/opac/locale/en-US/opac.dtd
index d5066caa52..62239f82c5 100644
--- a/Open-ILS/web/opac/locale/en-US/opac.dtd
+++ b/Open-ILS/web/opac/locale/en-US/opac.dtd
@@ -705,3 +705,20 @@ Ensure Caps-Lock is off and try again or contact your local library.">
<!ENTITY selfck.day5 "Saturday">
<!ENTITY selfck.day6 "Sunday">
+<!ENTITY circ.fail_part.actor.usr.barred "The patron is barred">
+<!ENTITY circ.fail_part.asset.copy.circulate "The item does not circulate">
+<!ENTITY circ.fail_part.asset.copy_location.circulate "Items from this shelving location do not circulate">
+<!ENTITY circ.fail_part.asset.copy.status "The item cannot circulate at this time">
+<!ENTITY circ.fail_part.circ.holds.target_skip_me "The item's circulation library does not fulfill holds">
+<!ENTITY circ.fail_part.config.circ_matrix_circ_mod_test "The patron has too many items of this type checked out">
+<!ENTITY circ.fail_part.config.circ_matrix_test.available_copy_hold_ratio "The available item-to-hold ratio is too low">
+<!ENTITY circ.fail_part.config.circ_matrix_test.circulate "Circulation rules reject this item as non-circulatable">
+<!ENTITY circ.fail_part.config.circ_matrix_test.total_copy_hold_ratio "The total item-to-hold ratio is too low">
+<!ENTITY circ.fail_part.config.hold_matrix_test.holdable "Hold rules reject this item as unholdable">
+<!ENTITY circ.fail_part.config.hold_matrix_test.max_holds "The patron has reached the maximum number of holds">
+<!ENTITY circ.fail_part.config.rule_age_hold_protect.prox "The item is too new to transit this far">
+<!ENTITY circ.fail_part.no_item "The system could not find this item">
+<!ENTITY circ.fail_part.no_ultimate_items "The system could not find any items to match this hold request">
+<!ENTITY circ.fail_part.no_matchpoint "System rules do not define how to handle this item">
+<!ENTITY circ.fail_part.no_user "The system could not find this patron">
+<!ENTITY circ.fail_part.transit_range "The item cannot transit this far">