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 integer, request_ou integer, match_item bigint, match_user integer, match_requestor integer)
62 requestor_object actor.usr%ROWTYPE;
63 user_object actor.usr%ROWTYPE;
64 item_object asset.copy%ROWTYPE;
65 item_cn_object asset.call_number%ROWTYPE;
66 rec_descriptor metabib.rec_descriptor%ROWTYPE;
67 matchpoint config.hold_matrix_matchpoint%ROWTYPE;
68 weights config.hold_matrix_weights%ROWTYPE;
71 SELECT INTO user_object * FROM actor.usr WHERE id = match_user;
72 SELECT INTO requestor_object * FROM actor.usr WHERE id = match_requestor;
73 SELECT INTO item_object * FROM asset.copy WHERE id = match_item;
74 SELECT INTO item_cn_object * FROM asset.call_number WHERE id = item_object.call_number;
75 SELECT INTO rec_descriptor * FROM metabib.rec_descriptor WHERE record = item_cn_object.record;
77 -- The item's owner should probably be the one determining if the item is holdable
78 -- How to decide that is debatable. Decided to default to the circ library (where the item lives)
79 -- This flag will allow for setting it to the owning library (where the call number "lives")
80 PERFORM * FROM config.internal_flag WHERE name = 'circ.holds.weight_owner_not_circ' AND enabled;
82 -- Grab the closest set circ weight setting.
84 -- Default to circ library
85 SELECT INTO weights hw.*
86 FROM config.weight_assoc wa
87 JOIN config.hold_matrix_weights hw ON (hw.id = wa.hold_weights)
88 JOIN actor.org_unit_ancestors_distance( item_object.circ_lib ) d ON (wa.org_unit = d.id)
93 -- Flag is set, use owning library
94 SELECT INTO weights hw.*
95 FROM config.weight_assoc wa
96 JOIN config.hold_matrix_weights hw ON (hw.id = wa.hold_weights)
97 JOIN actor.org_unit_ancestors_distance( cn_object.owning_lib ) d ON (wa.org_unit = d.id)
103 -- No weights? Bad admin! Defaults to handle that anyway.
104 IF weights.id IS NULL THEN
105 weights.user_home_ou := 5;
106 weights.request_ou := 5;
107 weights.pickup_ou := 5;
108 weights.item_owning_ou := 5;
109 weights.item_circ_ou := 5;
110 weights.usr_grp := 7;
111 weights.requestor_grp := 8;
112 weights.circ_modifier := 4;
113 weights.marc_type := 3;
114 weights.marc_form := 2;
115 weights.marc_vr_format := 1;
116 weights.juvenile_flag := 4;
117 weights.ref_flag := 0;
120 -- Determine the max (expected) depth (+1) of the org tree and max depth of the permisson tree
121 -- If you break your org tree with funky parenting this may be wrong
122 -- Note: This CTE is duplicated in the find_circ_matrix_matchpoint function, and it may be a good idea to split it off to a function
123 -- We use one denominator for all tree-based checks for when permission groups and org units have the same weighting
124 WITH all_distance(distance) AS (
125 SELECT depth AS distance FROM actor.org_unit_type
127 SELECT distance AS distance FROM permission.grp_ancestors_distance((SELECT id FROM permission.grp_tree WHERE parent IS NULL))
129 SELECT INTO denominator MAX(distance) + 1 FROM all_distance;
131 -- To ATTEMPT to make this work like it used to, make it reverse the user/requestor profile ids.
132 -- This may be better implemented as part of the upgrade script?
133 -- Set usr_grp = requestor_grp, requestor_grp = 1 or something when this flag is already set
134 -- Then remove this flag, of course.
135 PERFORM * FROM config.internal_flag WHERE name = 'circ.holds.usr_not_requestor' AND enabled;
138 -- Note: This, to me, is REALLY hacky. I put it in anyway.
139 -- If you can't tell, this is a single call swap on two variables.
140 SELECT INTO user_object.profile, requestor_object.profile
141 requestor_object.profile, user_object.profile;
144 -- Select the winning matchpoint into the matchpoint variable for returning
145 SELECT INTO matchpoint m.*
146 FROM config.hold_matrix_matchpoint m
147 /*LEFT*/ JOIN permission.grp_ancestors_distance( requestor_object.profile ) rpgad ON m.requestor_grp = rpgad.id
148 LEFT JOIN permission.grp_ancestors_distance( user_object.profile ) upgad ON m.usr_grp = upgad.id
149 LEFT JOIN actor.org_unit_ancestors_distance( pickup_ou ) puoua ON m.pickup_ou = puoua.id
150 LEFT JOIN actor.org_unit_ancestors_distance( request_ou ) rqoua ON m.request_ou = rqoua.id
151 LEFT JOIN actor.org_unit_ancestors_distance( item_cn_object.owning_lib ) cnoua ON m.item_owning_ou = cnoua.id
152 LEFT JOIN actor.org_unit_ancestors_distance( item_object.circ_lib ) iooua ON m.item_circ_ou = iooua.id
153 LEFT JOIN actor.org_unit_ancestors_distance( user_object.home_ou ) uhoua ON m.user_home_ou = uhoua.id
156 -- AND (m.requestor_grp IS NULL OR upgad.id IS NOT NULL) -- Optional Requestor Group?
157 AND (m.usr_grp IS NULL OR upgad.id IS NOT NULL)
159 AND (m.pickup_ou IS NULL OR (puoua.id IS NOT NULL AND (puoua.distance = 0 OR NOT m.strict_ou_match)))
160 AND (m.request_ou IS NULL OR (rqoua.id IS NOT NULL AND (rqoua.distance = 0 OR NOT m.strict_ou_match)))
161 AND (m.item_owning_ou IS NULL OR (cnoua.id IS NOT NULL AND (cnoua.distance = 0 OR NOT m.strict_ou_match)))
162 AND (m.item_circ_ou IS NULL OR (iooua.id IS NOT NULL AND (iooua.distance = 0 OR NOT m.strict_ou_match)))
163 AND (m.user_home_ou IS NULL OR (uhoua.id IS NOT NULL AND (uhoua.distance = 0 OR NOT m.strict_ou_match)))
164 -- Static User Checks
165 AND (m.juvenile_flag IS NULL OR m.juvenile_flag = user_object.juvenile)
166 -- Static Item Checks
167 AND (m.circ_modifier IS NULL OR m.circ_modifier = item_object.circ_modifier)
168 AND (m.marc_type IS NULL OR m.marc_type = COALESCE(item_object.circ_as_type, rec_descriptor.item_type))
169 AND (m.marc_form IS NULL OR m.marc_form = rec_descriptor.item_form)
170 AND (m.marc_vr_format IS NULL OR m.marc_vr_format = rec_descriptor.vr_format)
171 AND (m.ref_flag IS NULL OR m.ref_flag = item_object.ref)
174 CASE WHEN rpgad.distance IS NOT NULL THEN 2^(2*weights.requestor_grp - (rpgad.distance/denominator)) ELSE 0 END +
175 CASE WHEN upgad.distance IS NOT NULL THEN 2^(2*weights.usr_grp - (upgad.distance/denominator)) ELSE 0 END +
177 CASE WHEN puoua.distance IS NOT NULL THEN 2^(2*weights.pickup_ou - (puoua.distance/denominator)) ELSE 0 END +
178 CASE WHEN rqoua.distance IS NOT NULL THEN 2^(2*weights.request_ou - (rqoua.distance/denominator)) ELSE 0 END +
179 CASE WHEN cnoua.distance IS NOT NULL THEN 2^(2*weights.item_owning_ou - (cnoua.distance/denominator)) ELSE 0 END +
180 CASE WHEN iooua.distance IS NOT NULL THEN 2^(2*weights.item_circ_ou - (iooua.distance/denominator)) ELSE 0 END +
181 CASE WHEN uhoua.distance IS NOT NULL THEN 2^(2*weights.user_home_ou - (uhoua.distance/denominator)) ELSE 0 END +
182 -- Static User Checks -- Note: 4^x is equiv to 2^(2*x)
183 CASE WHEN m.juvenile_flag IS NOT NULL THEN 4^weights.juvenile_flag ELSE 0 END +
184 -- Static Item Checks
185 CASE WHEN m.circ_modifier IS NOT NULL THEN 4^weights.circ_modifier ELSE 0 END +
186 CASE WHEN m.marc_type IS NOT NULL THEN 4^weights.marc_type ELSE 0 END +
187 CASE WHEN m.marc_form IS NOT NULL THEN 4^weights.marc_form ELSE 0 END +
188 CASE WHEN m.marc_vr_format IS NOT NULL THEN 4^weights.marc_vr_format ELSE 0 END +
189 CASE WHEN m.ref_flag IS NOT NULL THEN 4^weights.ref_flag ELSE 0 END DESC,
190 -- Final sort on id, so that if two rules have the same sorting in the previous sort they have a defined order
191 -- This prevents "we changed the table order by updating a rule, and we started getting different results"
194 -- Return just the ID for now
195 RETURN matchpoint.id;
197 $func$ LANGUAGE 'plpgsql';
199 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$
202 user_object actor.usr%ROWTYPE;
203 age_protect_object config.rule_age_hold_protect%ROWTYPE;
204 standing_penalty config.standing_penalty%ROWTYPE;
205 transit_range_ou_type actor.org_unit_type%ROWTYPE;
206 transit_source actor.org_unit%ROWTYPE;
207 item_object asset.copy%ROWTYPE;
208 ou_skip actor.org_unit_setting%ROWTYPE;
209 result action.matrix_test_result;
210 hold_test config.hold_matrix_matchpoint%ROWTYPE;
212 hold_transit_prox INT;
213 frozen_hold_count INT;
214 context_org_list INT[];
217 SELECT INTO user_object * FROM actor.usr WHERE id = match_user;
218 SELECT INTO context_org_list ARRAY_ACCUM(id) FROM actor.org_unit_full_path( pickup_ou );
220 result.success := TRUE;
222 -- Fail if we couldn't find a user
223 IF user_object.id IS NULL THEN
224 result.fail_part := 'no_user';
225 result.success := FALSE;
231 SELECT INTO item_object * FROM asset.copy WHERE id = match_item;
233 -- Fail if we couldn't find a copy
234 IF item_object.id IS NULL THEN
235 result.fail_part := 'no_item';
236 result.success := FALSE;
242 SELECT INTO matchpoint_id action.find_hold_matrix_matchpoint(pickup_ou, request_ou, match_item, match_user, match_requestor);
243 result.matchpoint := matchpoint_id;
245 SELECT INTO ou_skip * FROM actor.org_unit_setting WHERE name = 'circ.holds.target_skip_me' AND org_unit = item_object.circ_lib;
247 -- Fail if the circ_lib for the item has circ.holds.target_skip_me set to true
248 IF ou_skip.id IS NOT NULL AND ou_skip.value = 'true' THEN
249 result.fail_part := 'circ.holds.target_skip_me';
250 result.success := FALSE;
256 -- Fail if user is barred
257 IF user_object.barred IS TRUE THEN
258 result.fail_part := 'actor.usr.barred';
259 result.success := FALSE;
265 -- Fail if we couldn't find any matchpoint (requires a default)
266 IF matchpoint_id IS NULL THEN
267 result.fail_part := 'no_matchpoint';
268 result.success := FALSE;
274 SELECT INTO hold_test * FROM config.hold_matrix_matchpoint WHERE id = matchpoint_id;
276 IF hold_test.holdable IS FALSE THEN
277 result.fail_part := 'config.hold_matrix_test.holdable';
278 result.success := FALSE;
283 IF hold_test.transit_range IS NOT NULL THEN
284 SELECT INTO transit_range_ou_type * FROM actor.org_unit_type WHERE id = hold_test.transit_range;
285 IF hold_test.distance_is_from_owner THEN
286 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;
288 SELECT INTO transit_source * FROM actor.org_unit WHERE id = item_object.circ_lib;
291 PERFORM * FROM actor.org_unit_descendants( transit_source.id, transit_range_ou_type.depth ) WHERE id = pickup_ou;
294 result.fail_part := 'transit_range';
295 result.success := FALSE;
301 FOR standing_penalty IN
302 SELECT DISTINCT csp.*
303 FROM actor.usr_standing_penalty usp
304 JOIN config.standing_penalty csp ON (csp.id = usp.standing_penalty)
305 WHERE usr = match_user
306 AND usp.org_unit IN ( SELECT * FROM explode_array(context_org_list) )
307 AND (usp.stop_date IS NULL or usp.stop_date > NOW())
308 AND csp.block_list LIKE '%HOLD%' LOOP
310 result.fail_part := standing_penalty.name;
311 result.success := FALSE;
316 IF hold_test.stop_blocked_user IS TRUE THEN
317 FOR standing_penalty IN
318 SELECT DISTINCT csp.*
319 FROM actor.usr_standing_penalty usp
320 JOIN config.standing_penalty csp ON (csp.id = usp.standing_penalty)
321 WHERE usr = match_user
322 AND usp.org_unit IN ( SELECT * FROM explode_array(context_org_list) )
323 AND (usp.stop_date IS NULL or usp.stop_date > NOW())
324 AND csp.block_list LIKE '%CIRC%' LOOP
326 result.fail_part := standing_penalty.name;
327 result.success := FALSE;
333 IF hold_test.max_holds IS NOT NULL AND NOT retargetting THEN
334 SELECT INTO hold_count COUNT(*)
335 FROM action.hold_request
336 WHERE usr = match_user
337 AND fulfillment_time IS NULL
338 AND cancel_time IS NULL
339 AND CASE WHEN hold_test.include_frozen_holds THEN TRUE ELSE frozen IS FALSE END;
341 IF hold_count >= hold_test.max_holds THEN
342 result.fail_part := 'config.hold_matrix_test.max_holds';
343 result.success := FALSE;
349 IF item_object.age_protect IS NOT NULL THEN
350 SELECT INTO age_protect_object * FROM config.rule_age_hold_protect WHERE id = item_object.age_protect;
352 IF item_object.create_date + age_protect_object.age > NOW() THEN
353 IF hold_test.distance_is_from_owner THEN
354 SELECT INTO hold_transit_prox prox FROM actor.org_unit_proximity WHERE from_org = item_cn_object.owning_lib AND to_org = pickup_ou;
356 SELECT INTO hold_transit_prox prox FROM actor.org_unit_proximity WHERE from_org = item_object.circ_lib AND to_org = pickup_ou;
359 IF hold_transit_prox > age_protect_object.prox THEN
360 result.fail_part := 'config.rule_age_hold_protect.prox';
361 result.success := FALSE;
374 $func$ LANGUAGE plpgsql;
376 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$
377 SELECT * FROM action.hold_request_permit_test( $1, $2, $3, $4, $5, FALSE );
380 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$
381 SELECT * FROM action.hold_request_permit_test( $1, $2, $3, $4, $5, TRUE );