3 -- If, for some reason, you need to reload this chunk of the schema
4 -- just use the following two statements to remove the tables before
5 -- running the rest of the file. See 950.data.seed-values.sql for
6 -- the one default entry to add back to config.hold_matrix_matchpoint.
8 DROP TABLE config.hold_matrix_matchpoint CASCADE;
9 DROP TABLE config.hold_matrix_test CASCADE;
17 -- ****** Which ruleset and tests to use *******
19 -- * Most specific range for org_unit and grp wins.
21 -- * circ_modifier match takes precidence over marc_type match, if circ_modifier is set here
23 -- * marc_type is first checked against the circ_as_type from the copy, then the item type from the marc record
25 -- * If neither circ_modifier nor marc_type is set (both are NULLABLE) then the entry defines the default
26 -- ruleset and tests for the OU + group (like BOOK in PINES)
31 CREATE TABLE config.hold_matrix_matchpoint (
32 id SERIAL PRIMARY KEY,
33 active BOOL NOT NULL DEFAULT TRUE,
34 strict_ou_match BOOL NOT NULL DEFAULT FALSE,
35 user_home_ou INT REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED, -- Set to the top OU for the matchpoint applicability range; we can use org_unit_prox to choose the "best"
36 request_ou INT REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED, -- Set to the top OU for the matchpoint applicability range; we can use org_unit_prox to choose the "best"
37 pickup_ou INT REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED, -- Set to the top OU for the matchpoint applicability range; we can use org_unit_prox to choose the "best"
38 item_owning_ou INT REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED, -- Set to the top OU for the matchpoint applicability range; we can use org_unit_prox to choose the "best"
39 item_circ_ou INT REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED, -- Set to the top OU for the matchpoint applicability range; we can use org_unit_prox to choose the "best"
40 usr_grp INT REFERENCES permission.grp_tree (id) DEFERRABLE INITIALLY DEFERRED, -- Set to the top applicable group from the group tree; will need descendents and prox functions for filtering
41 requestor_grp INT NOT NULL REFERENCES permission.grp_tree (id) DEFERRABLE INITIALLY DEFERRED, -- Set to the top applicable group from the group tree; will need descendents and prox functions for filtering
42 circ_modifier TEXT REFERENCES config.circ_modifier (code) DEFERRABLE INITIALLY DEFERRED,
43 marc_type TEXT REFERENCES config.item_type_map (code) DEFERRABLE INITIALLY DEFERRED,
44 marc_form TEXT REFERENCES config.item_form_map (code) DEFERRABLE INITIALLY DEFERRED,
45 marc_vr_format TEXT REFERENCES config.videorecording_format_map (code) DEFERRABLE INITIALLY DEFERRED,
48 holdable BOOL NOT NULL DEFAULT TRUE, -- Hard "can't hold" flag requiring an override
49 distance_is_from_owner BOOL NOT NULL DEFAULT FALSE, -- How to calculate transit_range. True means owning lib, false means copy circ lib
50 transit_range INT REFERENCES actor.org_unit_type (id) DEFERRABLE INITIALLY DEFERRED, -- Can circ inside range of cn.owner/cp.circ_lib at depth of the org_unit_type specified here
51 max_holds INT, -- Total hold requests must be less than this, NULL means skip (always pass)
52 include_frozen_holds BOOL NOT NULL DEFAULT TRUE, -- Include frozen hold requests in the count for max_holds test
53 stop_blocked_user BOOL NOT NULL DEFAULT FALSE, -- Stop users who cannot check out items from placing holds
54 age_hold_protect_rule INT REFERENCES config.rule_age_hold_protect (id) DEFERRABLE INITIALLY DEFERRED, -- still not sure we want to move this off the copy
55 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, ref_flag, juvenile_flag)
58 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$
60 current_requestor_group permission.grp_tree%ROWTYPE;
61 requestor_object actor.usr%ROWTYPE;
62 user_object actor.usr%ROWTYPE;
63 item_object asset.copy%ROWTYPE;
64 item_cn_object asset.call_number%ROWTYPE;
65 rec_descriptor metabib.rec_descriptor%ROWTYPE;
66 current_mp_weight FLOAT;
67 matchpoint_weight FLOAT;
69 current_mp config.hold_matrix_matchpoint%ROWTYPE;
70 matchpoint config.hold_matrix_matchpoint%ROWTYPE;
72 SELECT INTO user_object * FROM actor.usr WHERE id = match_user;
73 SELECT INTO requestor_object * FROM actor.usr WHERE id = match_requestor;
74 SELECT INTO item_object * FROM asset.copy WHERE id = match_item;
75 SELECT INTO item_cn_object * FROM asset.call_number WHERE id = item_object.call_number;
76 SELECT INTO rec_descriptor r.* FROM metabib.rec_descriptor r WHERE r.record = item_cn_object.record;
78 PERFORM * FROM config.internal_flag WHERE name = 'circ.holds.usr_not_requestor' AND enabled;
81 SELECT INTO current_requestor_group * FROM permission.grp_tree WHERE id = requestor_object.profile;
83 SELECT INTO current_requestor_group * FROM permission.grp_tree WHERE id = user_object.profile;
87 -- for each potential matchpoint for this ou and group ...
90 FROM config.hold_matrix_matchpoint m
91 WHERE m.requestor_grp = current_requestor_group.id AND m.active
92 ORDER BY CASE WHEN m.circ_modifier IS NOT NULL THEN 16 ELSE 0 END +
93 CASE WHEN m.juvenile_flag IS NOT NULL THEN 16 ELSE 0 END +
94 CASE WHEN m.marc_type IS NOT NULL THEN 8 ELSE 0 END +
95 CASE WHEN m.marc_form IS NOT NULL THEN 4 ELSE 0 END +
96 CASE WHEN m.marc_vr_format IS NOT NULL THEN 2 ELSE 0 END +
97 CASE WHEN m.ref_flag IS NOT NULL THEN 1 ELSE 0 END DESC LOOP
99 IF NOT current_mp.strict_ou_match THEN
100 current_mp_weight := 5.0;
102 current_mp_weight := 0.0;
105 IF current_mp.circ_modifier IS NOT NULL THEN
106 CONTINUE WHEN current_mp.circ_modifier <> item_object.circ_modifier OR item_object.circ_modifier IS NULL;
109 IF current_mp.marc_type IS NOT NULL THEN
110 IF item_object.circ_as_type IS NOT NULL THEN
111 CONTINUE WHEN current_mp.marc_type <> item_object.circ_as_type;
113 CONTINUE WHEN current_mp.marc_type <> rec_descriptor.item_type;
117 IF current_mp.marc_form IS NOT NULL THEN
118 CONTINUE WHEN current_mp.marc_form <> rec_descriptor.item_form;
121 IF current_mp.marc_vr_format IS NOT NULL THEN
122 CONTINUE WHEN current_mp.marc_vr_format <> rec_descriptor.vr_format;
125 IF current_mp.juvenile_flag IS NOT NULL THEN
126 CONTINUE WHEN current_mp.juvenile_flag <> user_object.juvenile;
129 IF current_mp.ref_flag IS NOT NULL THEN
130 CONTINUE WHEN current_mp.ref_flag <> item_object.ref;
134 -- caclulate the rule match weight
135 IF current_mp.item_owning_ou IS NOT NULL THEN
136 CONTINUE WHEN current_mp.item_owning_ou NOT IN (SELECT (actor.org_unit_ancestors(item_cn_object.owning_lib)).id);
137 IF NOT current_mp.strict_ou_match THEN
138 SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.item_owning_ou, item_cn_object.owning_lib)::FLOAT + 1.0)::FLOAT;
140 CONTINUE WHEN current_mp.item_owning_ou <> item_cn_object.owning_lib;
141 tmp_weight := CASE WHEN current_mp.item_owning_ou = item_cn_object.owning_lib THEN 1.0 ELSE 0.0 END;
143 current_mp_weight := current_mp_weight - tmp_weight;
146 IF current_mp.item_circ_ou IS NOT NULL THEN
147 CONTINUE WHEN current_mp.item_circ_ou NOT IN (SELECT (actor.org_unit_ancestors(item_object.circ_lib)).id);
148 IF NOT current_mp.strict_ou_match THEN
149 SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.item_circ_ou, item_object.circ_lib)::FLOAT + 1.0)::FLOAT;
151 CONTINUE WHEN current_mp.item_circ_ou <> item_object.circ_lib;
152 tmp_weight := CASE WHEN current_mp.item_circ_ou = item_object.circ_lib THEN 1.0 ELSE 0.0 END;
154 current_mp_weight := current_mp_weight - tmp_weight;
157 IF current_mp.pickup_ou IS NOT NULL THEN
158 CONTINUE WHEN current_mp.pickup_ou NOT IN (SELECT (actor.org_unit_ancestors(pickup_ou)).id);
159 IF NOT current_mp.strict_ou_match THEN
160 SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.pickup_ou, pickup_ou)::FLOAT + 1.0)::FLOAT;
162 CONTINUE WHEN current_mp.pickup_ou <> pickup_ou;
163 tmp_weight := CASE WHEN current_mp.pickup_ou = pickiup_ou THEN 1.0 ELSE 0.0 END;
165 current_mp_weight := current_mp_weight - tmp_weight;
168 IF current_mp.request_ou IS NOT NULL THEN
169 CONTINUE WHEN current_mp.request_ou NOT IN (SELECT (actor.org_unit_ancestors(request_ou)).id);
170 IF NOT current_mp.strict_ou_match THEN
171 SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.request_ou, request_ou)::FLOAT + 1.0)::FLOAT;
173 CONTINUE WHEN current_mp.request_ou <> request_ou;
174 tmp_weight := CASE WHEN current_mp.request_ou = request_ou THEN 1.0 ELSE 0.0 END;
176 current_mp_weight := current_mp_weight - tmp_weight;
179 IF current_mp.user_home_ou IS NOT NULL THEN
180 CONTINUE WHEN current_mp.user_home_ou NOT IN (SELECT (actor.org_unit_ancestors(user_object.home_ou)).id);
181 IF NOT current_mp.strict_ou_match THEN
182 SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.user_home_ou, user_object.home_ou)::FLOAT + 1.0)::FLOAT;
184 CONTINUE WHEN current_mp.user_home_ou <> user_object.home_ou;
185 tmp_weight := CASE WHEN current_mp.user_home_ou = user_object.home_ou THEN 1.0 ELSE 0.0 END;
187 current_mp_weight := current_mp_weight - tmp_weight;
190 -- set the matchpoint if we found the best one
191 IF matchpoint_weight IS NULL OR matchpoint_weight > current_mp_weight THEN
192 matchpoint = current_mp;
193 matchpoint_weight = current_mp_weight;
198 EXIT WHEN current_requestor_group.parent IS NULL OR matchpoint.id IS NOT NULL;
200 SELECT INTO current_requestor_group * FROM permission.grp_tree WHERE id = current_requestor_group.parent;
203 RETURN matchpoint.id;
205 $func$ LANGUAGE plpgsql;
208 CREATE OR REPLACE FUNCTION action.hold_request_permit_test( pickup_ou INT, request_ou INT, match_item BIGINT, match_user INT, match_requestor INT, retargetting BOOL ) RETURNS SETOF action.matrix_test_result AS $func$
211 user_object actor.usr%ROWTYPE;
212 age_protect_object config.rule_age_hold_protect%ROWTYPE;
213 standing_penalty config.standing_penalty%ROWTYPE;
214 transit_range_ou_type actor.org_unit_type%ROWTYPE;
215 transit_source actor.org_unit%ROWTYPE;
216 item_object asset.copy%ROWTYPE;
217 ou_skip actor.org_unit_setting%ROWTYPE;
218 result action.matrix_test_result;
219 hold_test config.hold_matrix_matchpoint%ROWTYPE;
221 hold_transit_prox INT;
222 frozen_hold_count INT;
223 context_org_list INT[];
226 SELECT INTO user_object * FROM actor.usr WHERE id = match_user;
227 SELECT INTO context_org_list ARRAY_ACCUM(id) FROM actor.org_unit_full_path( pickup_ou );
229 result.success := TRUE;
231 -- Fail if we couldn't find a user
232 IF user_object.id IS NULL THEN
233 result.fail_part := 'no_user';
234 result.success := FALSE;
240 SELECT INTO item_object * FROM asset.copy WHERE id = match_item;
242 -- Fail if we couldn't find a copy
243 IF item_object.id IS NULL THEN
244 result.fail_part := 'no_item';
245 result.success := FALSE;
251 SELECT INTO matchpoint_id action.find_hold_matrix_matchpoint(pickup_ou, request_ou, match_item, match_user, match_requestor);
252 result.matchpoint := matchpoint_id;
254 SELECT INTO ou_skip * FROM actor.org_unit_setting WHERE name = 'circ.holds.target_skip_me' AND org_unit = item_object.circ_lib;
256 -- Fail if the circ_lib for the item has circ.holds.target_skip_me set to true
257 IF ou_skip.id IS NOT NULL AND ou_skip.value = 'true' THEN
258 result.fail_part := 'circ.holds.target_skip_me';
259 result.success := FALSE;
265 -- Fail if user is barred
266 IF user_object.barred IS TRUE THEN
267 result.fail_part := 'actor.usr.barred';
268 result.success := FALSE;
274 -- Fail if we couldn't find any matchpoint (requires a default)
275 IF matchpoint_id IS NULL THEN
276 result.fail_part := 'no_matchpoint';
277 result.success := FALSE;
283 SELECT INTO hold_test * FROM config.hold_matrix_matchpoint WHERE id = matchpoint_id;
285 IF hold_test.holdable IS FALSE THEN
286 result.fail_part := 'config.hold_matrix_test.holdable';
287 result.success := FALSE;
292 IF hold_test.transit_range IS NOT NULL THEN
293 SELECT INTO transit_range_ou_type * FROM actor.org_unit_type WHERE id = hold_test.transit_range;
294 IF hold_test.distance_is_from_owner THEN
295 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;
297 SELECT INTO transit_source * FROM actor.org_unit WHERE id = item_object.circ_lib;
300 PERFORM * FROM actor.org_unit_descendants( transit_source.id, transit_range_ou_type.depth ) WHERE id = pickup_ou;
303 result.fail_part := 'transit_range';
304 result.success := FALSE;
310 FOR standing_penalty IN
311 SELECT DISTINCT csp.*
312 FROM actor.usr_standing_penalty usp
313 JOIN config.standing_penalty csp ON (csp.id = usp.standing_penalty)
314 WHERE usr = match_user
315 AND usp.org_unit IN ( SELECT * FROM explode_array(context_org_list) )
316 AND (usp.stop_date IS NULL or usp.stop_date > NOW())
317 AND csp.block_list LIKE '%HOLD%' LOOP
319 result.fail_part := standing_penalty.name;
320 result.success := FALSE;
325 IF hold_test.stop_blocked_user IS TRUE THEN
326 FOR standing_penalty IN
327 SELECT DISTINCT csp.*
328 FROM actor.usr_standing_penalty usp
329 JOIN config.standing_penalty csp ON (csp.id = usp.standing_penalty)
330 WHERE usr = match_user
331 AND usp.org_unit IN ( SELECT * FROM explode_array(context_org_list) )
332 AND (usp.stop_date IS NULL or usp.stop_date > NOW())
333 AND csp.block_list LIKE '%CIRC%' LOOP
335 result.fail_part := standing_penalty.name;
336 result.success := FALSE;
342 IF hold_test.max_holds IS NOT NULL AND NOT retargetting THEN
343 SELECT INTO hold_count COUNT(*)
344 FROM action.hold_request
345 WHERE usr = match_user
346 AND fulfillment_time IS NULL
347 AND cancel_time IS NULL
348 AND CASE WHEN hold_test.include_frozen_holds THEN TRUE ELSE frozen IS FALSE END;
350 IF hold_count >= hold_test.max_holds THEN
351 result.fail_part := 'config.hold_matrix_test.max_holds';
352 result.success := FALSE;
358 IF item_object.age_protect IS NOT NULL THEN
359 SELECT INTO age_protect_object * FROM config.rule_age_hold_protect WHERE id = item_object.age_protect;
361 IF item_object.create_date + age_protect_object.age > NOW() THEN
362 IF hold_test.distance_is_from_owner THEN
363 SELECT INTO hold_transit_prox prox FROM actor.org_unit_proximity WHERE from_org = item_cn_object.owning_lib AND to_org = pickup_ou;
365 SELECT INTO hold_transit_prox prox FROM actor.org_unit_proximity WHERE from_org = item_object.circ_lib AND to_org = pickup_ou;
368 IF hold_transit_prox > age_protect_object.prox THEN
369 result.fail_part := 'config.rule_age_hold_protect.prox';
370 result.success := FALSE;
383 $func$ LANGUAGE plpgsql;
385 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$
386 SELECT * FROM action.hold_request_permit_test( $1, $2, $3, $4, $5, FALSE );
389 CREATE OR REPLACE FUNCTION action.hold_retarget_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$
390 SELECT * FROM action.hold_request_permit_test( $1, $2, $3, $4, $5, TRUE );