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
61 -- Nulls don't count for a constraint match, so we have to coalesce them into something that does.
62 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;
64 CREATE OR REPLACE FUNCTION action.find_hold_matrix_matchpoint(pickup_ou integer, request_ou integer, match_item bigint, match_user integer, match_requestor integer)
68 requestor_object actor.usr%ROWTYPE;
69 user_object actor.usr%ROWTYPE;
70 item_object asset.copy%ROWTYPE;
71 item_cn_object asset.call_number%ROWTYPE;
73 rec_descriptor metabib.rec_descriptor%ROWTYPE;
74 matchpoint config.hold_matrix_matchpoint%ROWTYPE;
75 weights config.hold_matrix_weights%ROWTYPE;
76 denominator NUMERIC(6,2);
77 v_pickup_ou ALIAS FOR pickup_ou;
78 v_request_ou ALIAS FOR request_ou;
80 SELECT INTO user_object * FROM actor.usr WHERE id = match_user;
81 SELECT INTO requestor_object * FROM actor.usr WHERE id = match_requestor;
82 SELECT INTO item_object * FROM asset.copy WHERE id = match_item;
83 SELECT INTO item_cn_object * FROM asset.call_number WHERE id = item_object.call_number;
84 SELECT INTO rec_descriptor * FROM metabib.rec_descriptor WHERE record = item_cn_object.record;
86 SELECT INTO my_item_age age(coalesce(item_object.active_date, now()));
88 -- The item's owner should probably be the one determining if the item is holdable
89 -- How to decide that is debatable. Decided to default to the circ library (where the item lives)
90 -- This flag will allow for setting it to the owning library (where the call number "lives")
91 PERFORM * FROM config.internal_flag WHERE name = 'circ.holds.weight_owner_not_circ' AND enabled;
93 -- Grab the closest set circ weight setting.
95 -- Default to circ library
96 SELECT INTO weights hw.*
97 FROM config.weight_assoc wa
98 JOIN config.hold_matrix_weights hw ON (hw.id = wa.hold_weights)
99 JOIN actor.org_unit_ancestors_distance( item_object.circ_lib ) d ON (wa.org_unit = d.id)
104 -- Flag is set, use owning library
105 SELECT INTO weights hw.*
106 FROM config.weight_assoc wa
107 JOIN config.hold_matrix_weights hw ON (hw.id = wa.hold_weights)
108 JOIN actor.org_unit_ancestors_distance( item_cn_object.owning_lib ) d ON (wa.org_unit = d.id)
114 -- No weights? Bad admin! Defaults to handle that anyway.
115 IF weights.id IS NULL THEN
116 weights.user_home_ou := 5.0;
117 weights.request_ou := 5.0;
118 weights.pickup_ou := 5.0;
119 weights.item_owning_ou := 5.0;
120 weights.item_circ_ou := 5.0;
121 weights.usr_grp := 7.0;
122 weights.requestor_grp := 8.0;
123 weights.circ_modifier := 4.0;
124 weights.marc_type := 3.0;
125 weights.marc_form := 2.0;
126 weights.marc_bib_level := 1.0;
127 weights.marc_vr_format := 1.0;
128 weights.juvenile_flag := 4.0;
129 weights.ref_flag := 0.0;
130 weights.item_age := 0.0;
133 -- Determine the max (expected) depth (+1) of the org tree and max depth of the permisson tree
134 -- If you break your org tree with funky parenting this may be wrong
135 -- 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
136 -- We use one denominator for all tree-based checks for when permission groups and org units have the same weighting
137 WITH all_distance(distance) AS (
138 SELECT depth AS distance FROM actor.org_unit_type
140 SELECT distance AS distance FROM permission.grp_ancestors_distance((SELECT id FROM permission.grp_tree WHERE parent IS NULL))
142 SELECT INTO denominator MAX(distance) + 1 FROM all_distance;
144 -- To ATTEMPT to make this work like it used to, make it reverse the user/requestor profile ids.
145 -- This may be better implemented as part of the upgrade script?
146 -- Set usr_grp = requestor_grp, requestor_grp = 1 or something when this flag is already set
147 -- Then remove this flag, of course.
148 PERFORM * FROM config.internal_flag WHERE name = 'circ.holds.usr_not_requestor' AND enabled;
151 -- Note: This, to me, is REALLY hacky. I put it in anyway.
152 -- If you can't tell, this is a single call swap on two variables.
153 SELECT INTO user_object.profile, requestor_object.profile
154 requestor_object.profile, user_object.profile;
157 -- Select the winning matchpoint into the matchpoint variable for returning
158 SELECT INTO matchpoint m.*
159 FROM config.hold_matrix_matchpoint m
160 /*LEFT*/ JOIN permission.grp_ancestors_distance( requestor_object.profile ) rpgad ON m.requestor_grp = rpgad.id
161 LEFT JOIN permission.grp_ancestors_distance( user_object.profile ) upgad ON m.usr_grp = upgad.id
162 LEFT JOIN actor.org_unit_ancestors_distance( v_pickup_ou ) puoua ON m.pickup_ou = puoua.id
163 LEFT JOIN actor.org_unit_ancestors_distance( v_request_ou ) rqoua ON m.request_ou = rqoua.id
164 LEFT JOIN actor.org_unit_ancestors_distance( item_cn_object.owning_lib ) cnoua ON m.item_owning_ou = cnoua.id
165 LEFT JOIN actor.org_unit_ancestors_distance( item_object.circ_lib ) iooua ON m.item_circ_ou = iooua.id
166 LEFT JOIN actor.org_unit_ancestors_distance( user_object.home_ou ) uhoua ON m.user_home_ou = uhoua.id
169 -- AND (m.requestor_grp IS NULL OR upgad.id IS NOT NULL) -- Optional Requestor Group?
170 AND (m.usr_grp IS NULL OR upgad.id IS NOT NULL)
172 AND (m.pickup_ou IS NULL OR (puoua.id IS NOT NULL AND (puoua.distance = 0 OR NOT m.strict_ou_match)))
173 AND (m.request_ou IS NULL OR (rqoua.id IS NOT NULL AND (rqoua.distance = 0 OR NOT m.strict_ou_match)))
174 AND (m.item_owning_ou IS NULL OR (cnoua.id IS NOT NULL AND (cnoua.distance = 0 OR NOT m.strict_ou_match)))
175 AND (m.item_circ_ou IS NULL OR (iooua.id IS NOT NULL AND (iooua.distance = 0 OR NOT m.strict_ou_match)))
176 AND (m.user_home_ou IS NULL OR (uhoua.id IS NOT NULL AND (uhoua.distance = 0 OR NOT m.strict_ou_match)))
177 -- Static User Checks
178 AND (m.juvenile_flag IS NULL OR m.juvenile_flag = user_object.juvenile)
179 -- Static Item Checks
180 AND (m.circ_modifier IS NULL OR m.circ_modifier = item_object.circ_modifier)
181 AND (m.marc_type IS NULL OR m.marc_type = COALESCE(item_object.circ_as_type, rec_descriptor.item_type))
182 AND (m.marc_form IS NULL OR m.marc_form = rec_descriptor.item_form)
183 AND (m.marc_bib_level IS NULL OR m.marc_bib_level = rec_descriptor.bib_level)
184 AND (m.marc_vr_format IS NULL OR m.marc_vr_format = rec_descriptor.vr_format)
185 AND (m.ref_flag IS NULL OR m.ref_flag = item_object.ref)
186 AND (m.item_age IS NULL OR (my_item_age IS NOT NULL AND m.item_age > my_item_age))
189 CASE WHEN rpgad.distance IS NOT NULL THEN 2^(2*weights.requestor_grp - (rpgad.distance/denominator)) ELSE 0.0 END +
190 CASE WHEN upgad.distance IS NOT NULL THEN 2^(2*weights.usr_grp - (upgad.distance/denominator)) ELSE 0.0 END +
192 CASE WHEN puoua.distance IS NOT NULL THEN 2^(2*weights.pickup_ou - (puoua.distance/denominator)) ELSE 0.0 END +
193 CASE WHEN rqoua.distance IS NOT NULL THEN 2^(2*weights.request_ou - (rqoua.distance/denominator)) ELSE 0.0 END +
194 CASE WHEN cnoua.distance IS NOT NULL THEN 2^(2*weights.item_owning_ou - (cnoua.distance/denominator)) ELSE 0.0 END +
195 CASE WHEN iooua.distance IS NOT NULL THEN 2^(2*weights.item_circ_ou - (iooua.distance/denominator)) ELSE 0.0 END +
196 CASE WHEN uhoua.distance IS NOT NULL THEN 2^(2*weights.user_home_ou - (uhoua.distance/denominator)) ELSE 0.0 END +
197 -- Static User Checks -- Note: 4^x is equiv to 2^(2*x)
198 CASE WHEN m.juvenile_flag IS NOT NULL THEN 4^weights.juvenile_flag ELSE 0.0 END +
199 -- Static Item Checks
200 CASE WHEN m.circ_modifier IS NOT NULL THEN 4^weights.circ_modifier ELSE 0.0 END +
201 CASE WHEN m.marc_type IS NOT NULL THEN 4^weights.marc_type ELSE 0.0 END +
202 CASE WHEN m.marc_form IS NOT NULL THEN 4^weights.marc_form ELSE 0.0 END +
203 CASE WHEN m.marc_vr_format IS NOT NULL THEN 4^weights.marc_vr_format ELSE 0.0 END +
204 CASE WHEN m.ref_flag IS NOT NULL THEN 4^weights.ref_flag ELSE 0.0 END +
205 -- Item age has a slight adjustment to weight based on value.
206 -- This should ensure that a shorter age limit comes first when all else is equal.
207 -- NOTE: This assumes that intervals will normally be in days.
208 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,
209 -- Final sort on id, so that if two rules have the same sorting in the previous sort they have a defined order
210 -- This prevents "we changed the table order by updating a rule, and we started getting different results"
213 -- Return just the ID for now
214 RETURN matchpoint.id;
216 $func$ LANGUAGE 'plpgsql';
218 CREATE TYPE action.matrix_test_result AS ( success BOOL, matchpoint INT, fail_part TEXT );
219 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$
222 user_object actor.usr%ROWTYPE;
223 age_protect_object config.rule_age_hold_protect%ROWTYPE;
224 standing_penalty config.standing_penalty%ROWTYPE;
225 transit_range_ou_type actor.org_unit_type%ROWTYPE;
226 transit_source actor.org_unit%ROWTYPE;
227 item_object asset.copy%ROWTYPE;
228 item_cn_object asset.call_number%ROWTYPE;
229 item_status_object config.copy_status%ROWTYPE;
230 item_location_object asset.copy_location%ROWTYPE;
231 ou_skip actor.org_unit_setting%ROWTYPE;
232 result action.matrix_test_result;
233 hold_test config.hold_matrix_matchpoint%ROWTYPE;
234 use_active_date TEXT;
235 age_protect_date TIMESTAMP WITH TIME ZONE;
237 hold_transit_prox INT;
238 frozen_hold_count INT;
239 context_org_list INT[];
242 v_pickup_ou ALIAS FOR pickup_ou;
243 v_request_ou ALIAS FOR request_ou;
247 SELECT INTO user_object * FROM actor.usr WHERE id = match_user;
248 SELECT INTO context_org_list ARRAY_AGG(id) FROM actor.org_unit_full_path( v_pickup_ou );
250 result.success := TRUE;
252 -- The HOLD penalty block only applies to new holds.
253 -- The CAPTURE penalty block applies to existing holds.
254 hold_penalty := 'HOLD';
256 hold_penalty := 'CAPTURE';
259 -- Fail if we couldn't find a user
260 IF user_object.id IS NULL THEN
261 result.fail_part := 'no_user';
262 result.success := FALSE;
268 SELECT INTO item_object * FROM asset.copy WHERE id = match_item;
270 -- Fail if we couldn't find a copy
271 IF item_object.id IS NULL THEN
272 result.fail_part := 'no_item';
273 result.success := FALSE;
279 SELECT INTO matchpoint_id action.find_hold_matrix_matchpoint(v_pickup_ou, v_request_ou, match_item, match_user, match_requestor);
280 result.matchpoint := matchpoint_id;
282 SELECT INTO ou_skip * FROM actor.org_unit_setting WHERE name = 'circ.holds.target_skip_me' AND org_unit = item_object.circ_lib;
284 -- Fail if the circ_lib for the item has circ.holds.target_skip_me set to true
285 IF ou_skip.id IS NOT NULL AND ou_skip.value = 'true' THEN
286 result.fail_part := 'circ.holds.target_skip_me';
287 result.success := FALSE;
293 -- Fail if user is barred
294 IF user_object.barred IS TRUE THEN
295 result.fail_part := 'actor.usr.barred';
296 result.success := FALSE;
302 SELECT INTO item_cn_object * FROM asset.call_number WHERE id = item_object.call_number;
303 SELECT INTO item_status_object * FROM config.copy_status WHERE id = item_object.status;
304 SELECT INTO item_location_object * FROM asset.copy_location WHERE id = item_object.location;
306 -- Fail if we couldn't find any matchpoint (requires a default)
307 IF matchpoint_id IS NULL THEN
308 result.fail_part := 'no_matchpoint';
309 result.success := FALSE;
315 SELECT INTO hold_test * FROM config.hold_matrix_matchpoint WHERE id = matchpoint_id;
317 IF hold_test.holdable IS FALSE THEN
318 result.fail_part := 'config.hold_matrix_test.holdable';
319 result.success := FALSE;
324 IF item_object.holdable IS FALSE THEN
325 result.fail_part := 'item.holdable';
326 result.success := FALSE;
331 IF item_status_object.holdable IS FALSE THEN
332 result.fail_part := 'status.holdable';
333 result.success := FALSE;
338 IF item_location_object.holdable IS FALSE THEN
339 result.fail_part := 'location.holdable';
340 result.success := FALSE;
345 IF hold_test.transit_range IS NOT NULL THEN
346 SELECT INTO transit_range_ou_type * FROM actor.org_unit_type WHERE id = hold_test.transit_range;
347 IF hold_test.distance_is_from_owner THEN
348 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;
350 SELECT INTO transit_source * FROM actor.org_unit WHERE id = item_object.circ_lib;
353 PERFORM * FROM actor.org_unit_descendants( transit_source.id, transit_range_ou_type.depth ) WHERE id = v_pickup_ou;
356 result.fail_part := 'transit_range';
357 result.success := FALSE;
363 -- Proximity of user's home_ou to the pickup_lib to see if penalty should be ignored.
364 SELECT INTO pickup_prox prox FROM actor.org_unit_proximity WHERE from_org = user_object.home_ou AND to_org = v_pickup_ou;
365 -- Proximity of user's home_ou to the items' lib to see if penalty should be ignored.
366 IF hold_test.distance_is_from_owner THEN
367 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;
369 SELECT INTO item_prox prox FROM actor.org_unit_proximity WHERE from_org = user_object.home_ou AND to_org = item_object.circ_lib;
372 FOR standing_penalty IN
373 SELECT DISTINCT csp.*
374 FROM actor.usr_standing_penalty usp
375 JOIN config.standing_penalty csp ON (csp.id = usp.standing_penalty)
376 WHERE usr = match_user
377 AND usp.org_unit IN ( SELECT * FROM unnest(context_org_list) )
378 AND (usp.stop_date IS NULL or usp.stop_date > NOW())
379 AND (csp.ignore_proximity IS NULL OR csp.ignore_proximity < item_prox
380 OR csp.ignore_proximity < pickup_prox)
381 AND csp.block_list LIKE '%' || hold_penalty || '%' LOOP
383 result.fail_part := standing_penalty.name;
384 result.success := FALSE;
389 IF hold_test.stop_blocked_user IS TRUE THEN
390 FOR standing_penalty IN
391 SELECT DISTINCT csp.*
392 FROM actor.usr_standing_penalty usp
393 JOIN config.standing_penalty csp ON (csp.id = usp.standing_penalty)
394 WHERE usr = match_user
395 AND usp.org_unit IN ( SELECT * FROM unnest(context_org_list) )
396 AND (usp.stop_date IS NULL or usp.stop_date > NOW())
397 AND csp.block_list LIKE '%CIRC%' LOOP
399 result.fail_part := standing_penalty.name;
400 result.success := FALSE;
406 IF hold_test.max_holds IS NOT NULL AND NOT retargetting THEN
407 SELECT INTO hold_count COUNT(*)
408 FROM action.hold_request
409 WHERE usr = match_user
410 AND fulfillment_time IS NULL
411 AND cancel_time IS NULL
412 AND CASE WHEN hold_test.include_frozen_holds THEN TRUE ELSE frozen IS FALSE END;
414 IF hold_count >= hold_test.max_holds THEN
415 result.fail_part := 'config.hold_matrix_test.max_holds';
416 result.success := FALSE;
422 IF item_object.age_protect IS NOT NULL THEN
423 SELECT INTO age_protect_object * FROM config.rule_age_hold_protect WHERE id = item_object.age_protect;
424 IF hold_test.distance_is_from_owner THEN
425 SELECT INTO use_active_date value FROM actor.org_unit_ancestor_setting('circ.holds.age_protect.active_date', item_cn_object.owning_lib);
427 SELECT INTO use_active_date value FROM actor.org_unit_ancestor_setting('circ.holds.age_protect.active_date', item_object.circ_lib);
429 IF use_active_date = 'true' THEN
430 age_protect_date := COALESCE(item_object.active_date, NOW());
432 age_protect_date := item_object.create_date;
434 IF age_protect_date + age_protect_object.age > NOW() THEN
435 IF hold_test.distance_is_from_owner THEN
436 SELECT INTO item_cn_object * FROM asset.call_number WHERE id = item_object.call_number;
437 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;
439 SELECT INTO hold_transit_prox prox FROM actor.org_unit_proximity WHERE from_org = item_object.circ_lib AND to_org = v_pickup_ou;
442 IF hold_transit_prox > age_protect_object.prox THEN
443 result.fail_part := 'config.rule_age_hold_protect.prox';
444 result.success := FALSE;
457 $func$ LANGUAGE plpgsql;
459 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$
460 SELECT * FROM action.hold_request_permit_test( $1, $2, $3, $4, $5, FALSE );
463 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$
464 SELECT * FROM action.hold_request_permit_test( $1, $2, $3, $4, $5, TRUE );