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,
36 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"
37 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"
38 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"
39 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"
40 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"
41 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
42 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
43 circ_modifier TEXT REFERENCES config.circ_modifier (code) DEFERRABLE INITIALLY DEFERRED,
52 holdable BOOL NOT NULL DEFAULT TRUE, -- Hard "can't hold" flag requiring an override
53 distance_is_from_owner BOOL NOT NULL DEFAULT FALSE, -- How to calculate transit_range. True means owning lib, false means copy circ lib
54 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
55 max_holds INT, -- Total hold requests must be less than this, NULL means skip (always pass)
56 include_frozen_holds BOOL NOT NULL DEFAULT TRUE, -- Include frozen hold requests in the count for max_holds test
57 stop_blocked_user BOOL NOT NULL DEFAULT FALSE, -- Stop users who cannot check out items from placing holds
58 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
62 -- Nulls don't count for a constraint match, so we have to coalesce them into something that does.
63 CREATE UNIQUE INDEX chmm_once_per_paramset ON config.hold_matrix_matchpoint (COALESCE(user_home_ou::TEXT, ''), COALESCE(request_ou::TEXT, ''), COALESCE(pickup_ou::TEXT, ''), COALESCE(item_owning_ou::TEXT, ''), COALESCE(item_circ_ou::TEXT, ''), COALESCE(usr_grp::TEXT, ''), COALESCE(requestor_grp::TEXT, ''), COALESCE(circ_modifier, ''), COALESCE(marc_type, ''), COALESCE(marc_form, ''), COALESCE(marc_bib_level, ''), COALESCE(marc_vr_format, ''), COALESCE(juvenile_flag::TEXT, ''), COALESCE(ref_flag::TEXT, ''), COALESCE(item_age::TEXT, '')) WHERE active;
65 CREATE OR REPLACE FUNCTION action.find_hold_matrix_matchpoint(pickup_ou integer, request_ou integer, match_item bigint, match_user integer, match_requestor integer)
69 requestor_object actor.usr%ROWTYPE;
70 user_object actor.usr%ROWTYPE;
71 item_object asset.copy%ROWTYPE;
72 item_cn_object asset.call_number%ROWTYPE;
74 rec_descriptor metabib.rec_descriptor%ROWTYPE;
75 matchpoint config.hold_matrix_matchpoint%ROWTYPE;
76 weights config.hold_matrix_weights%ROWTYPE;
77 denominator NUMERIC(6,2);
78 v_pickup_ou ALIAS FOR pickup_ou;
79 v_request_ou ALIAS FOR request_ou;
81 SELECT INTO user_object * FROM actor.usr WHERE id = match_user;
82 SELECT INTO requestor_object * FROM actor.usr WHERE id = match_requestor;
83 SELECT INTO item_object * FROM asset.copy WHERE id = match_item;
84 SELECT INTO item_cn_object * FROM asset.call_number WHERE id = item_object.call_number;
85 SELECT INTO rec_descriptor * FROM metabib.rec_descriptor WHERE record = item_cn_object.record;
87 SELECT INTO my_item_age age(coalesce(item_object.active_date, now()));
89 -- The item's owner should probably be the one determining if the item is holdable
90 -- How to decide that is debatable. Decided to default to the circ library (where the item lives)
91 -- This flag will allow for setting it to the owning library (where the call number "lives")
92 PERFORM * FROM config.internal_flag WHERE name = 'circ.holds.weight_owner_not_circ' AND enabled;
94 -- Grab the closest set circ weight setting.
96 -- Default to circ library
97 SELECT INTO weights hw.*
98 FROM config.weight_assoc wa
99 JOIN config.hold_matrix_weights hw ON (hw.id = wa.hold_weights)
100 JOIN actor.org_unit_ancestors_distance( item_object.circ_lib ) d ON (wa.org_unit = d.id)
105 -- Flag is set, use owning library
106 SELECT INTO weights hw.*
107 FROM config.weight_assoc wa
108 JOIN config.hold_matrix_weights hw ON (hw.id = wa.hold_weights)
109 JOIN actor.org_unit_ancestors_distance( item_cn_object.owning_lib ) d ON (wa.org_unit = d.id)
115 -- No weights? Bad admin! Defaults to handle that anyway.
116 IF weights.id IS NULL THEN
117 weights.user_home_ou := 5.0;
118 weights.request_ou := 5.0;
119 weights.pickup_ou := 5.0;
120 weights.item_owning_ou := 5.0;
121 weights.item_circ_ou := 5.0;
122 weights.usr_grp := 7.0;
123 weights.requestor_grp := 8.0;
124 weights.circ_modifier := 4.0;
125 weights.marc_type := 3.0;
126 weights.marc_form := 2.0;
127 weights.marc_bib_level := 1.0;
128 weights.marc_vr_format := 1.0;
129 weights.juvenile_flag := 4.0;
130 weights.ref_flag := 0.0;
131 weights.item_age := 0.0;
134 -- Determine the max (expected) depth (+1) of the org tree and max depth of the permisson tree
135 -- If you break your org tree with funky parenting this may be wrong
136 -- 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
137 -- We use one denominator for all tree-based checks for when permission groups and org units have the same weighting
138 WITH all_distance(distance) AS (
139 SELECT depth AS distance FROM actor.org_unit_type
141 SELECT distance AS distance FROM permission.grp_ancestors_distance((SELECT id FROM permission.grp_tree WHERE parent IS NULL))
143 SELECT INTO denominator MAX(distance) + 1 FROM all_distance;
145 -- To ATTEMPT to make this work like it used to, make it reverse the user/requestor profile ids.
146 -- This may be better implemented as part of the upgrade script?
147 -- Set usr_grp = requestor_grp, requestor_grp = 1 or something when this flag is already set
148 -- Then remove this flag, of course.
149 PERFORM * FROM config.internal_flag WHERE name = 'circ.holds.usr_not_requestor' AND enabled;
152 -- Note: This, to me, is REALLY hacky. I put it in anyway.
153 -- If you can't tell, this is a single call swap on two variables.
154 SELECT INTO user_object.profile, requestor_object.profile
155 requestor_object.profile, user_object.profile;
158 -- Select the winning matchpoint into the matchpoint variable for returning
159 SELECT INTO matchpoint m.*
160 FROM config.hold_matrix_matchpoint m
161 /*LEFT*/ JOIN permission.grp_ancestors_distance( requestor_object.profile ) rpgad ON m.requestor_grp = rpgad.id
162 LEFT JOIN permission.grp_ancestors_distance( user_object.profile ) upgad ON m.usr_grp = upgad.id
163 LEFT JOIN actor.org_unit_ancestors_distance( v_pickup_ou ) puoua ON m.pickup_ou = puoua.id
164 LEFT JOIN actor.org_unit_ancestors_distance( v_request_ou ) rqoua ON m.request_ou = rqoua.id
165 LEFT JOIN actor.org_unit_ancestors_distance( item_cn_object.owning_lib ) cnoua ON m.item_owning_ou = cnoua.id
166 LEFT JOIN actor.org_unit_ancestors_distance( item_object.circ_lib ) iooua ON m.item_circ_ou = iooua.id
167 LEFT JOIN actor.org_unit_ancestors_distance( user_object.home_ou ) uhoua ON m.user_home_ou = uhoua.id
170 -- AND (m.requestor_grp IS NULL OR upgad.id IS NOT NULL) -- Optional Requestor Group?
171 AND (m.usr_grp IS NULL OR upgad.id IS NOT NULL)
173 AND (m.pickup_ou IS NULL OR (puoua.id IS NOT NULL AND (puoua.distance = 0 OR NOT m.strict_ou_match)))
174 AND (m.request_ou IS NULL OR (rqoua.id IS NOT NULL AND (rqoua.distance = 0 OR NOT m.strict_ou_match)))
175 AND (m.item_owning_ou IS NULL OR (cnoua.id IS NOT NULL AND (cnoua.distance = 0 OR NOT m.strict_ou_match)))
176 AND (m.item_circ_ou IS NULL OR (iooua.id IS NOT NULL AND (iooua.distance = 0 OR NOT m.strict_ou_match)))
177 AND (m.user_home_ou IS NULL OR (uhoua.id IS NOT NULL AND (uhoua.distance = 0 OR NOT m.strict_ou_match)))
178 -- Static User Checks
179 AND (m.juvenile_flag IS NULL OR m.juvenile_flag = user_object.juvenile)
180 -- Static Item Checks
181 AND (m.circ_modifier IS NULL OR m.circ_modifier = item_object.circ_modifier)
182 AND (m.marc_type IS NULL OR m.marc_type = COALESCE(item_object.circ_as_type, rec_descriptor.item_type))
183 AND (m.marc_form IS NULL OR m.marc_form = rec_descriptor.item_form)
184 AND (m.marc_bib_level IS NULL OR m.marc_bib_level = rec_descriptor.bib_level)
185 AND (m.marc_vr_format IS NULL OR m.marc_vr_format = rec_descriptor.vr_format)
186 AND (m.ref_flag IS NULL OR m.ref_flag = item_object.ref)
187 AND (m.item_age IS NULL OR (my_item_age IS NOT NULL AND m.item_age > my_item_age))
190 CASE WHEN rpgad.distance IS NOT NULL THEN 2^(2*weights.requestor_grp - (rpgad.distance/denominator)) ELSE 0.0 END +
191 CASE WHEN upgad.distance IS NOT NULL THEN 2^(2*weights.usr_grp - (upgad.distance/denominator)) ELSE 0.0 END +
193 CASE WHEN puoua.distance IS NOT NULL THEN 2^(2*weights.pickup_ou - (puoua.distance/denominator)) ELSE 0.0 END +
194 CASE WHEN rqoua.distance IS NOT NULL THEN 2^(2*weights.request_ou - (rqoua.distance/denominator)) ELSE 0.0 END +
195 CASE WHEN cnoua.distance IS NOT NULL THEN 2^(2*weights.item_owning_ou - (cnoua.distance/denominator)) ELSE 0.0 END +
196 CASE WHEN iooua.distance IS NOT NULL THEN 2^(2*weights.item_circ_ou - (iooua.distance/denominator)) ELSE 0.0 END +
197 CASE WHEN uhoua.distance IS NOT NULL THEN 2^(2*weights.user_home_ou - (uhoua.distance/denominator)) ELSE 0.0 END +
198 -- Static User Checks -- Note: 4^x is equiv to 2^(2*x)
199 CASE WHEN m.juvenile_flag IS NOT NULL THEN 4^weights.juvenile_flag ELSE 0.0 END +
200 -- Static Item Checks
201 CASE WHEN m.circ_modifier IS NOT NULL THEN 4^weights.circ_modifier ELSE 0.0 END +
202 CASE WHEN m.marc_type IS NOT NULL THEN 4^weights.marc_type ELSE 0.0 END +
203 CASE WHEN m.marc_form IS NOT NULL THEN 4^weights.marc_form ELSE 0.0 END +
204 CASE WHEN m.marc_vr_format IS NOT NULL THEN 4^weights.marc_vr_format ELSE 0.0 END +
205 CASE WHEN m.ref_flag IS NOT NULL THEN 4^weights.ref_flag ELSE 0.0 END +
206 -- Item age has a slight adjustment to weight based on value.
207 -- This should ensure that a shorter age limit comes first when all else is equal.
208 -- NOTE: This assumes that intervals will normally be in days.
209 CASE WHEN m.item_age IS NOT NULL THEN 4^weights.item_age - 86400/EXTRACT(EPOCH FROM m.item_age) ELSE 0.0 END DESC,
210 -- Final sort on id, so that if two rules have the same sorting in the previous sort they have a defined order
211 -- This prevents "we changed the table order by updating a rule, and we started getting different results"
214 -- Return just the ID for now
215 RETURN matchpoint.id;
217 $func$ LANGUAGE 'plpgsql';
219 CREATE TYPE action.matrix_test_result AS ( success BOOL, matchpoint INT, fail_part TEXT );
220 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$
223 user_object actor.usr%ROWTYPE;
224 age_protect_object config.rule_age_hold_protect%ROWTYPE;
225 standing_penalty config.standing_penalty%ROWTYPE;
226 transit_range_ou_type actor.org_unit_type%ROWTYPE;
227 transit_source actor.org_unit%ROWTYPE;
228 item_object asset.copy%ROWTYPE;
229 item_cn_object asset.call_number%ROWTYPE;
230 item_status_object config.copy_status%ROWTYPE;
231 item_location_object asset.copy_location%ROWTYPE;
232 ou_skip actor.org_unit_setting%ROWTYPE;
233 result action.matrix_test_result;
234 hold_test config.hold_matrix_matchpoint%ROWTYPE;
235 use_active_date TEXT;
236 age_protect_date TIMESTAMP WITH TIME ZONE;
238 hold_transit_prox INT;
239 frozen_hold_count INT;
240 context_org_list INT[];
243 v_pickup_ou ALIAS FOR pickup_ou;
244 v_request_ou ALIAS FOR request_ou;
248 SELECT INTO user_object * FROM actor.usr WHERE id = match_user;
249 SELECT INTO context_org_list ARRAY_AGG(id) FROM actor.org_unit_full_path( v_pickup_ou );
251 result.success := TRUE;
253 -- The HOLD penalty block only applies to new holds.
254 -- The CAPTURE penalty block applies to existing holds.
255 hold_penalty := 'HOLD';
257 hold_penalty := 'CAPTURE';
260 -- Fail if we couldn't find a user
261 IF user_object.id IS NULL THEN
262 result.fail_part := 'no_user';
263 result.success := FALSE;
269 SELECT INTO item_object * FROM asset.copy WHERE id = match_item;
271 -- Fail if we couldn't find a copy
272 IF item_object.id IS NULL THEN
273 result.fail_part := 'no_item';
274 result.success := FALSE;
280 SELECT INTO matchpoint_id action.find_hold_matrix_matchpoint(v_pickup_ou, v_request_ou, match_item, match_user, match_requestor);
281 result.matchpoint := matchpoint_id;
283 SELECT INTO ou_skip * FROM actor.org_unit_setting WHERE name = 'circ.holds.target_skip_me' AND org_unit = item_object.circ_lib;
285 -- Fail if the circ_lib for the item has circ.holds.target_skip_me set to true
286 IF ou_skip.id IS NOT NULL AND ou_skip.value = 'true' THEN
287 result.fail_part := 'circ.holds.target_skip_me';
288 result.success := FALSE;
294 -- Fail if user is barred
295 IF user_object.barred IS TRUE THEN
296 result.fail_part := 'actor.usr.barred';
297 result.success := FALSE;
303 SELECT INTO item_cn_object * FROM asset.call_number WHERE id = item_object.call_number;
304 SELECT INTO item_status_object * FROM config.copy_status WHERE id = item_object.status;
305 SELECT INTO item_location_object * FROM asset.copy_location WHERE id = item_object.location;
307 -- Fail if we couldn't find any matchpoint (requires a default)
308 IF matchpoint_id IS NULL THEN
309 result.fail_part := 'no_matchpoint';
310 result.success := FALSE;
316 SELECT INTO hold_test * FROM config.hold_matrix_matchpoint WHERE id = matchpoint_id;
318 IF hold_test.holdable IS FALSE THEN
319 result.fail_part := 'config.hold_matrix_test.holdable';
320 result.success := FALSE;
325 IF item_object.holdable IS FALSE THEN
326 result.fail_part := 'item.holdable';
327 result.success := FALSE;
332 IF item_status_object.holdable IS FALSE THEN
333 result.fail_part := 'status.holdable';
334 result.success := FALSE;
339 IF item_location_object.holdable IS FALSE THEN
340 result.fail_part := 'location.holdable';
341 result.success := FALSE;
346 IF hold_test.transit_range IS NOT NULL THEN
347 SELECT INTO transit_range_ou_type * FROM actor.org_unit_type WHERE id = hold_test.transit_range;
348 IF hold_test.distance_is_from_owner THEN
349 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;
351 SELECT INTO transit_source * FROM actor.org_unit WHERE id = item_object.circ_lib;
354 PERFORM * FROM actor.org_unit_descendants( transit_source.id, transit_range_ou_type.depth ) WHERE id = v_pickup_ou;
357 result.fail_part := 'transit_range';
358 result.success := FALSE;
364 -- Proximity of user's home_ou to the pickup_lib to see if penalty should be ignored.
365 SELECT INTO pickup_prox prox FROM actor.org_unit_proximity WHERE from_org = user_object.home_ou AND to_org = v_pickup_ou;
366 -- Proximity of user's home_ou to the items' lib to see if penalty should be ignored.
367 IF hold_test.distance_is_from_owner THEN
368 SELECT INTO item_prox prox FROM actor.org_unit_proximity WHERE from_org = user_object.home_ou AND to_org = item_cn_object.owning_lib;
370 SELECT INTO item_prox prox FROM actor.org_unit_proximity WHERE from_org = user_object.home_ou AND to_org = item_object.circ_lib;
373 FOR standing_penalty IN
374 SELECT DISTINCT csp.*
375 FROM actor.usr_standing_penalty usp
376 JOIN config.standing_penalty csp ON (csp.id = usp.standing_penalty)
377 WHERE usr = match_user
378 AND usp.org_unit IN ( SELECT * FROM unnest(context_org_list) )
379 AND (usp.stop_date IS NULL or usp.stop_date > NOW())
380 AND (csp.ignore_proximity IS NULL OR csp.ignore_proximity < item_prox
381 OR csp.ignore_proximity < pickup_prox)
382 AND csp.block_list LIKE '%' || hold_penalty || '%' LOOP
384 result.fail_part := standing_penalty.name;
385 result.success := FALSE;
390 IF hold_test.stop_blocked_user IS TRUE THEN
391 FOR standing_penalty IN
392 SELECT DISTINCT csp.*
393 FROM actor.usr_standing_penalty usp
394 JOIN config.standing_penalty csp ON (csp.id = usp.standing_penalty)
395 WHERE usr = match_user
396 AND usp.org_unit IN ( SELECT * FROM unnest(context_org_list) )
397 AND (usp.stop_date IS NULL or usp.stop_date > NOW())
398 AND csp.block_list LIKE '%CIRC%' LOOP
400 result.fail_part := standing_penalty.name;
401 result.success := FALSE;
407 IF hold_test.max_holds IS NOT NULL AND NOT retargetting THEN
408 SELECT INTO hold_count COUNT(*)
409 FROM action.hold_request
410 WHERE usr = match_user
411 AND fulfillment_time IS NULL
412 AND cancel_time IS NULL
413 AND CASE WHEN hold_test.include_frozen_holds THEN TRUE ELSE frozen IS FALSE END;
415 IF hold_count >= hold_test.max_holds THEN
416 result.fail_part := 'config.hold_matrix_test.max_holds';
417 result.success := FALSE;
423 IF item_object.age_protect IS NOT NULL THEN
424 SELECT INTO age_protect_object * FROM config.rule_age_hold_protect WHERE id = item_object.age_protect;
425 IF hold_test.distance_is_from_owner THEN
426 SELECT INTO use_active_date value FROM actor.org_unit_ancestor_setting('circ.holds.age_protect.active_date', item_cn_object.owning_lib);
428 SELECT INTO use_active_date value FROM actor.org_unit_ancestor_setting('circ.holds.age_protect.active_date', item_object.circ_lib);
430 IF use_active_date = 'true' THEN
431 age_protect_date := COALESCE(item_object.active_date, NOW());
433 age_protect_date := item_object.create_date;
435 IF age_protect_date + age_protect_object.age > NOW() THEN
436 IF hold_test.distance_is_from_owner THEN
437 SELECT INTO item_cn_object * FROM asset.call_number WHERE id = item_object.call_number;
438 SELECT INTO hold_transit_prox prox FROM actor.org_unit_proximity WHERE from_org = item_cn_object.owning_lib AND to_org = v_pickup_ou;
440 SELECT INTO hold_transit_prox prox FROM actor.org_unit_proximity WHERE from_org = item_object.circ_lib AND to_org = v_pickup_ou;
443 IF hold_transit_prox > age_protect_object.prox THEN
444 result.fail_part := 'config.rule_age_hold_protect.prox';
445 result.success := FALSE;
458 $func$ LANGUAGE plpgsql;
460 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$
461 SELECT * FROM action.hold_request_permit_test( $1, $2, $3, $4, $5, FALSE );
464 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$
465 SELECT * FROM action.hold_request_permit_test( $1, $2, $3, $4, $5, TRUE );