5 -- ****** Which ruleset and tests to use *******
7 -- * Most specific range for org_unit and grp wins.
9 -- * circ_modifier match takes precidence over marc_type match, if circ_modifier is set here
11 -- * marc_type is first checked against the circ_as_type from the copy, then the item type from the marc record
13 -- * If neither circ_modifier nor marc_type is set (both are NULLABLE) then the entry defines the default
14 -- ruleset and tests for the OU + group (like BOOK in PINES)
19 CREATE TABLE config.hold_matrix_matchpoint (
20 id SERIAL PRIMARY KEY,
21 active BOOL NOT NULL DEFAULT TRUE,
22 user_home_ou INT REFERENCES actor.org_unit (id), -- Set to the top OU for the matchpoint applicability range; we can use org_unit_prox to choose the "best"
23 request_ou INT REFERENCES actor.org_unit (id), -- Set to the top OU for the matchpoint applicability range; we can use org_unit_prox to choose the "best"
24 pickup_ou INT REFERENCES actor.org_unit (id), -- Set to the top OU for the matchpoint applicability range; we can use org_unit_prox to choose the "best"
25 item_owning_ou INT REFERENCES actor.org_unit (id), -- Set to the top OU for the matchpoint applicability range; we can use org_unit_prox to choose the "best"
26 item_circ_ou INT REFERENCES actor.org_unit (id), -- Set to the top OU for the matchpoint applicability range; we can use org_unit_prox to choose the "best"
27 usr_grp INT REFERENCES permission.grp_tree (id), -- Set to the top applicable group from the group tree; will need decendents and prox functions for filtering
28 requestor_grp INT NOT NULL REFERENCES permission.grp_tree (id), -- Set to the top applicable group from the group tree; will need decendents and prox functions for filtering
29 circ_modifier TEXT REFERENCES config.circ_modifier (code),
30 marc_type TEXT REFERENCES config.item_type_map (code),
31 marc_form TEXT REFERENCES config.item_form_map (code),
32 marc_vr_format TEXT REFERENCES config.videorecording_format_map (code),
34 CONSTRAINT hous_once_per_grp_loc_mod_marc UNIQUE (user_home_ou, request_ou, pickup_ou, item_owning_ou, item_circ_ou, requestor_grp, usr_grp, circ_modifier, marc_type, marc_form, marc_vr_format)
37 INSERT INTO config.hold_matrix_matchpoint (requestor_grp) VALUES (1);
39 -- Tests to determine if hold against a specific copy is possible for a user at (and from) a location
40 CREATE TABLE config.hold_matrix_test (
41 matchpoint INT PRIMARY KEY REFERENCES config.hold_matrix_matchpoint (id),
42 holdable BOOL NOT NULL DEFAULT TRUE, -- Hard "can't hold" flag requiring an override
43 distance_is_from_owner BOOL NOT NULL DEFAULT FALSE, -- How to calculate transit_range. True means owning lib, false means copy circ lib
44 transit_range INT REFERENCES actor.org_unit_type (id), -- Can circ inside range of cn.owner/cp.circ_lib at depth of the org_unit_type specified here
45 max_holds INT, -- Total hold requests must be less than this, NULL means skip (always pass)
46 include_frozen_holds BOOL NOT NULL DEFAULT TRUE, -- Include frozen hold requests in the count for max_holds test
47 age_hold_protect_rule INT REFERENCES config.rule_age_hold_protect (id) -- still not sure we want to move this off the copy
50 CREATE OR REPLACE FUNCTION action.find_hold_matrix_matchpoint( pickup_ou INT, request_ou INT, match_item BIGINT, match_user INT, match_requestor INT ) RETURNS INT AS $func$
52 current_requestor_group permission.grp_tree%ROWTYPE;
53 root_ou actor.org_unit%ROWTYPE;
54 requestor_object actor.usr%ROWTYPE;
55 user_object actor.usr%ROWTYPE;
56 item_object asset.copy%ROWTYPE;
57 item_cn_object asset.call_number%ROWTYPE;
58 rec_descriptor metabib.rec_descriptor%ROWTYPE;
59 current_mp_weight FLOAT;
60 matchpoint_weight FLOAT;
62 current_mp config.hold_matrix_matchpoint%ROWTYPE;
63 matchpoint config.hold_matrix_matchpoint%ROWTYPE;
65 SELECT INTO root_ou * FROM actor.org_unit WHERE parent_ou IS NULL;
66 SELECT INTO user_object * FROM actor.usr WHERE id = match_user;
67 SELECT INTO requestor_object * FROM actor.usr WHERE id = match_requestor;
68 SELECT INTO item_object * FROM asset.copy WHERE id = match_item;
69 SELECT INTO item_cn_object * FROM asset.call_number WHERE id = item_object.call_number;
70 SELECT INTO rec_descriptor r.* FROM metabib.rec_descriptor r WHERE r.record = item_cn_object.record;
71 SELECT INTO current_requestor_group * FROM permission.grp_tree WHERE id = requestor_object.profile;
74 -- for each potential matchpoint for this ou and group ...
77 FROM config.hold_matrix_matchpoint m
78 WHERE m.requestor_grp = current_requestor_group.id AND m.active
79 ORDER BY CASE WHEN m.circ_modifier IS NOT NULL THEN 16 ELSE 0 END +
80 CASE WHEN m.marc_type IS NOT NULL THEN 8 ELSE 0 END +
81 CASE WHEN m.marc_form IS NOT NULL THEN 4 ELSE 0 END +
82 CASE WHEN m.marc_vr_format IS NOT NULL THEN 2 ELSE 0 END +
83 CASE WHEN m.ref_flag IS NOT NULL THEN 1 ELSE 0 END DESC LOOP
85 current_mp_weight := 5.0;
87 IF current_mp.circ_modifier IS NOT NULL THEN
88 CONTINUE WHEN current_mp.circ_modifier <> item_object.circ_modifier;
91 IF current_mp.marc_type IS NOT NULL THEN
92 IF item_object.circ_as_type IS NOT NULL THEN
93 CONTINUE WHEN current_mp.marc_type <> item_object.circ_as_type;
95 CONTINUE WHEN current_mp.marc_type <> rec_descriptor.item_type;
99 IF current_mp.marc_form IS NOT NULL THEN
100 CONTINUE WHEN current_mp.marc_form <> rec_descriptor.item_form;
103 IF current_mp.marc_vr_format IS NOT NULL THEN
104 CONTINUE WHEN current_mp.marc_vr_format <> rec_descriptor.vr_format;
107 IF current_mp.ref_flag IS NOT NULL THEN
108 CONTINUE WHEN current_mp.ref_flag <> item_object.ref;
112 -- caclulate the rule match weight
113 IF current_mp.item_owning_ou IS NOT NULL AND current_mp.item_owning_ou <> root_ou.id THEN
114 SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.item_owning_ou, item_cn_object.owning_lib)::FLOAT + 1.0)::FLOAT;
115 current_mp_weight := current_mp_weight - tmp_weight;
118 IF current_mp.item_circ_ou IS NOT NULL AND current_mp.item_circ_ou <> root_ou.id THEN
119 SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.item_circ_ou, item_object.circ_lib)::FLOAT + 1.0)::FLOAT;
120 current_mp_weight := current_mp_weight - tmp_weight;
123 IF current_mp.pickup_ou IS NOT NULL AND current_mp.pickup_ou <> root_ou.id THEN
124 SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.pickup_ou, pickup_ou)::FLOAT + 1.0)::FLOAT;
125 current_mp_weight := current_mp_weight - tmp_weight;
128 IF current_mp.request_ou IS NOT NULL AND current_mp.request_ou <> root_ou.id THEN
129 SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.request_ou, request_ou)::FLOAT + 1.0)::FLOAT;
130 current_mp_weight := current_mp_weight - tmp_weight;
133 IF current_mp.user_home_ou IS NOT NULL AND current_mp.user_home_ou <> root_ou.id THEN
134 SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.user_home_ou, user_object.home_ou)::FLOAT + 1.0)::FLOAT;
135 current_mp_weight := current_mp_weight - tmp_weight;
138 -- set the matchpoint if we found the best one
139 IF matchpoint_weight IS NULL OR matchpoint_weight > current_mp_weight THEN
140 matchpoint = current_mp;
141 matchpoint_weight = current_mp_weight;
146 EXIT WHEN current_requestor_group.parent IS NULL OR matchpoint.id IS NOT NULL;
148 SELECT INTO current_requestor_group * FROM permission.grp_tree WHERE id = current_requestor_group.parent;
151 RETURN matchpoint.id;
153 $func$ LANGUAGE plpgsql;
156 CREATE OR REPLACE FUNCTION action.hold_request_permit_test( pickup_ou INT, request_ou INT, match_item BIGINT, match_user INT, match_requestor INT ) RETURNS SETOF action.matrix_test_result AS $func$
159 user_object actor.usr%ROWTYPE;
160 age_protect_object config.rule_age_hold_protect%ROWTYPE;
161 transit_range_ou_type actor.org_unit_type%ROWTYPE;
162 transit_source actor.org_unit%ROWTYPE;
163 item_object asset.copy%ROWTYPE;
164 result action.matrix_test_result;
165 hold_test config.hold_matrix_test%ROWTYPE;
167 hold_transit_prox INT;
168 frozen_hold_count INT;
171 SELECT INTO user_object * FROM actor.usr WHERE id = match_user;
173 -- Fail if we couldn't find a user
174 IF user_object.id IS NULL THEN
175 result.fail_part := 'no_user';
176 result.success := FALSE;
182 SELECT INTO item_object * FROM asset.copy WHERE id = match_item;
184 -- Fail if we couldn't find a copy
185 IF item_object.id IS NULL THEN
186 result.fail_part := 'no_item';
187 result.success := FALSE;
193 SELECT INTO matchpoint_id action.find_hold_matrix_matchpoint(pickup_ou, request_ou, match_item, match_user, match_requestor);
195 -- Fail if we couldn't find any matchpoint (requires a default)
196 IF matchpoint_id IS NULL THEN
197 result.fail_part := 'no_matchpoint';
198 result.success := FALSE;
204 SELECT INTO hold_test * FROM config.hold_matrix_test WHERE matchpoint = matchpoint_id;
206 result.matchpoint := matchpoint_id;
207 result.success := TRUE;
209 IF hold_test.holdable IS FALSE THEN
210 result.fail_part := 'config.hold_matrix_test.holdable';
211 result.success := FALSE;
216 IF hold_test.transit_range IS NOT NULL THEN
217 SELECT INTO transit_range_ou_type * FROM actor.org_unit_type WHERE id = hold_test.transit_range;
218 IF hold_test.distance_is_from_owner THEN
219 SELECT INTO transit_source ou.* FROM actor.org_unit ou JOIN asset.call_number cn ON (cn.owning_lib = ou.id) WHERE cn.id = item_object.call_number;
221 SELECT INTO transit_source * FROM actor.org_unit WHERE id = item_object.circ_lib;
224 PERFORM * FROM actor.org_unit_descendants( transit_source.id, transit_range_ou_type.depth ) WHERE id = pickup_ou;
227 result.fail_part := 'transit_range';
228 result.success := FALSE;
234 IF hold_test.max_holds IS NOT NULL THEN
235 SELECT INTO hold_count COUNT(*)
236 FROM action.hold_request
237 WHERE usr = match_user
238 AND fulfillment_time IS NULL
239 AND cancel_time IS NULL
240 AND CASE WHEN hold_test.include_frozen_holds THEN TRUE ELSE frozen IS FALSE END;
242 IF items_out >= hold_test.max_holds THEN
243 result.fail_part := 'config.hold_matrix_test.max_holds';
244 result.success := FALSE;
250 IF item_object.age_protect IS NOT NULL THEN
251 SELECT INTO age_protect_object * FROM config.rule_age_hold_protect WHERE id = item_object.age_protect;
253 IF item_object.create_date + age_protect_object.age > NOW() THEN
254 IF hold_test.distance_is_from_owner THEN
255 SELECT INTO hold_transit_prox prox FROM actor.org_unit_prox WHERE from_org = item_cn_object.owning_lib AND to_org = pickup_ou;
257 SELECT INTO hold_transit_prox prox FROM actor.org_unit_prox WHERE from_org = item_object.circ_lib AND to_org = pickup_ou;
260 IF hold_transit_prox > age_protect_object.prox THEN
261 result.fail_part := 'config.rule_age_hold_protect.prox';
262 result.success := FALSE;
275 $func$ LANGUAGE plpgsql;