3 -- NOTE: current config.item_type should get sip2_media_type and magnetic_media columns
5 -- New table needed to handle circ modifiers inside the DB. Will still require
6 -- central admin. The circ_modifier column on asset.copy will become an fkey to this table.
7 CREATE TABLE config.circ_modifier (
9 name TEXT UNIQUE NOT NULL,
10 description TEXT NOT NULL,
11 sip2_media_type TEXT NOT NULL,
12 magnetic_media BOOL NOT NULL DEFAULT TRUE,
13 avg_wait_time INTERVAL
18 INSERT INTO config.circ_modifier VALUES ( 'DVD', 'DVD', 'um ... DVDs', '001', FALSE );
19 INSERT INTO config.circ_modifier VALUES ( 'VIDEO', 'VIDEO', 'Tapes', '001', TRUE );
20 INSERT INTO config.circ_modifier VALUES ( 'BOOK', 'BOOK', 'Dead tree', '001', FALSE );
21 INSERT INTO config.circ_modifier VALUES ( 'CRAZY_ARL-ATH_SETTING', 'R2R_TAPE', 'reel2reel tape', '007', TRUE );
24 -- But, just to get us started, use this
27 UPDATE asset.copy SET circ_modifier = UPPER(circ_modifier) WHERE circ_modifier IS NOT NULL AND circ_modifier <> '';
28 UPDATE asset.copy SET circ_modifier = NULL WHERE circ_modifier = '';
30 INSERT INTO config.circ_modifier (code, name, description, sip2_media_type )
37 WHERE circ_modifier IS NOT NULL;
41 -- add an fkey pointing to the new circ mod table
42 ALTER TABLE asset.copy ADD CONSTRAINT circ_mod_fkey FOREIGN KEY (circ_modifier) REFERENCES config.circ_modifier (code) ON UPDATE CASCADE ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED;
46 ** Here we define the tables that make up the circ matrix. Conceptually, this implements
47 ** the "sparse matrix" that everyone talks about, instead of using traditional rules logic.
48 ** Physically, we cut the matrix up into separate tables (almost 3rd normal form!) that handle
49 ** different portions of the matrix. This wil simplify creation of the UI (I hope), and help the
50 ** developers focus on specific parts of the matrix.
53 CREATE TABLE config.circ_matrix_matchpoint (
54 id SERIAL PRIMARY KEY,
55 active BOOL NOT NULL DEFAULT TRUE,
57 org_unit INT NOT NULL 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"
58 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
59 circ_modifier TEXT REFERENCES config.circ_modifier (code) DEFERRABLE INITIALLY DEFERRED,
60 copy_location INT REFERENCES asset.copy_location (id) DEFERRABLE INITIALLY DEFERRED,
65 copy_circ_lib INT REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
66 copy_owning_lib INT REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
67 user_home_ou INT REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
71 usr_age_lower_bound INTERVAL,
72 usr_age_upper_bound INTERVAL,
75 circulate BOOL, -- Hard "can't circ" flag requiring an override
76 duration_rule INT REFERENCES config.rule_circ_duration (id) DEFERRABLE INITIALLY DEFERRED,
77 recurring_fine_rule INT REFERENCES config.rule_recurring_fine (id) DEFERRABLE INITIALLY DEFERRED,
78 max_fine_rule INT REFERENCES config.rule_max_fine (id) DEFERRABLE INITIALLY DEFERRED,
79 hard_due_date INT REFERENCES config.hard_due_date (id) DEFERRABLE INITIALLY DEFERRED,
80 renewals INT, -- Renewal count override
81 grace_period INTERVAL, -- Grace period override
82 script_test TEXT, -- javascript source
83 total_copy_hold_ratio FLOAT,
84 available_copy_hold_ratio FLOAT,
88 -- Nulls don't count for a constraint match, so we have to coalesce them into something that does.
89 CREATE UNIQUE INDEX ccmm_once_per_paramset ON config.circ_matrix_matchpoint (org_unit, grp, COALESCE(circ_modifier, ''), COALESCE(copy_location::TEXT, ''), COALESCE(marc_type, ''), COALESCE(marc_form, ''), COALESCE(marc_bib_level,''), COALESCE(marc_vr_format, ''), COALESCE(copy_circ_lib::TEXT, ''), COALESCE(copy_owning_lib::TEXT, ''), COALESCE(user_home_ou::TEXT, ''), COALESCE(ref_flag::TEXT, ''), COALESCE(juvenile_flag::TEXT, ''), COALESCE(is_renewal::TEXT, ''), COALESCE(usr_age_lower_bound::TEXT, ''), COALESCE(usr_age_upper_bound::TEXT, ''), COALESCE(item_age::TEXT, '')) WHERE active;
91 -- Limit groups for circ counting
92 CREATE TABLE config.circ_limit_group (
93 id SERIAL PRIMARY KEY,
94 name TEXT UNIQUE NOT NULL,
99 CREATE TABLE config.circ_limit_set (
100 id SERIAL PRIMARY KEY,
101 name TEXT UNIQUE NOT NULL,
102 owning_lib INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
103 items_out INT NOT NULL, -- Total current active circulations must be less than this. 0 means skip counting (always pass)
104 depth INT NOT NULL DEFAULT 0, -- Depth count starts at
105 global BOOL NOT NULL DEFAULT FALSE, -- If enabled, include everything below depth, otherwise ancestors/descendants only
109 -- Linkage between matchpoints and limit sets
110 CREATE TABLE config.circ_matrix_limit_set_map (
111 id SERIAL PRIMARY KEY,
112 matchpoint INT NOT NULL REFERENCES config.circ_matrix_matchpoint (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
113 limit_set INT NOT NULL REFERENCES config.circ_limit_set (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
114 fallthrough BOOL NOT NULL DEFAULT FALSE, -- If true fallthrough will grab this rule as it goes along
115 active BOOL NOT NULL DEFAULT TRUE,
116 CONSTRAINT circ_limit_set_once_per_matchpoint UNIQUE (matchpoint, limit_set)
119 -- Linkage between limit sets and circ mods
120 CREATE TABLE config.circ_limit_set_circ_mod_map (
121 id SERIAL PRIMARY KEY,
122 limit_set INT NOT NULL REFERENCES config.circ_limit_set (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
123 circ_mod TEXT NOT NULL REFERENCES config.circ_modifier (code) ON DELETE CASCADE ON UPDATE CASCADE DEFERRABLE INITIALLY DEFERRED,
124 CONSTRAINT cm_once_per_set UNIQUE (limit_set, circ_mod)
127 -- Linkage between limit sets and copy locations
128 CREATE TABLE config.circ_limit_set_copy_loc_map (
129 id SERIAL PRIMARY KEY,
130 limit_set INT NOT NULL REFERENCES config.circ_limit_set (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
131 copy_loc INT NOT NULL REFERENCES asset.copy_location (id) ON DELETE CASCADE ON UPDATE CASCADE DEFERRABLE INITIALLY DEFERRED,
132 CONSTRAINT cl_once_per_set UNIQUE (limit_set, copy_loc)
135 -- Linkage between limit sets and limit groups
136 CREATE TABLE config.circ_limit_set_group_map (
137 id SERIAL PRIMARY KEY,
138 limit_set INT NOT NULL REFERENCES config.circ_limit_set (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
139 limit_group INT NOT NULL REFERENCES config.circ_limit_group (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
140 check_only BOOL NOT NULL DEFAULT FALSE, -- If true, don't accumulate this limit_group for storing with the circulation
141 CONSTRAINT clg_once_per_set UNIQUE (limit_set, limit_group)
144 -- Linkage between limit groups and circulations
145 CREATE TABLE action.circulation_limit_group_map (
146 circ BIGINT NOT NULL REFERENCES action.circulation (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
147 limit_group INT NOT NULL REFERENCES config.circ_limit_group (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
148 PRIMARY KEY (circ, limit_group)
151 -- Function for populating the circ/limit group mappings
152 CREATE OR REPLACE FUNCTION action.link_circ_limit_groups ( BIGINT, INT[] ) RETURNS VOID AS $func$
153 INSERT INTO action.circulation_limit_group_map(circ, limit_group) SELECT $1, id FROM config.circ_limit_group WHERE id IN (SELECT * FROM UNNEST($2));
156 CREATE TYPE action.found_circ_matrix_matchpoint AS ( success BOOL, matchpoint config.circ_matrix_matchpoint, buildrows INT[] );
158 CREATE OR REPLACE FUNCTION action.find_circ_matrix_matchpoint( context_ou INT, item_object asset.copy, user_object actor.usr, renewal BOOL ) RETURNS action.found_circ_matrix_matchpoint AS $func$
160 cn_object asset.call_number%ROWTYPE;
161 rec_descriptor metabib.rec_descriptor%ROWTYPE;
162 cur_matchpoint config.circ_matrix_matchpoint%ROWTYPE;
163 matchpoint config.circ_matrix_matchpoint%ROWTYPE;
164 weights config.circ_matrix_weights%ROWTYPE;
166 my_item_age INTERVAL;
167 denominator NUMERIC(6,2);
169 result action.found_circ_matrix_matchpoint;
172 result.success = false;
175 SELECT INTO cn_object * FROM asset.call_number WHERE id = item_object.call_number;
176 SELECT INTO rec_descriptor * FROM metabib.rec_descriptor WHERE record = cn_object.record;
178 -- Pre-generate this so we only calc it once
179 IF user_object.dob IS NOT NULL THEN
180 SELECT INTO user_age age(user_object.dob);
184 SELECT INTO my_item_age age(coalesce(item_object.active_date, now()));
186 -- Grab the closest set circ weight setting.
187 SELECT INTO weights cw.*
188 FROM config.weight_assoc wa
189 JOIN config.circ_matrix_weights cw ON (cw.id = wa.circ_weights)
190 JOIN actor.org_unit_ancestors_distance( context_ou ) d ON (wa.org_unit = d.id)
195 -- No weights? Bad admin! Defaults to handle that anyway.
196 IF weights.id IS NULL THEN
198 weights.org_unit := 10.0;
199 weights.circ_modifier := 5.0;
200 weights.copy_location := 5.0;
201 weights.marc_type := 4.0;
202 weights.marc_form := 3.0;
203 weights.marc_bib_level := 2.0;
204 weights.marc_vr_format := 2.0;
205 weights.copy_circ_lib := 8.0;
206 weights.copy_owning_lib := 8.0;
207 weights.user_home_ou := 8.0;
208 weights.ref_flag := 1.0;
209 weights.juvenile_flag := 6.0;
210 weights.is_renewal := 7.0;
211 weights.usr_age_lower_bound := 0.0;
212 weights.usr_age_upper_bound := 0.0;
213 weights.item_age := 0.0;
216 -- Determine the max (expected) depth (+1) of the org tree and max depth of the permisson tree
217 -- If you break your org tree with funky parenting this may be wrong
218 -- Note: This CTE is duplicated in the find_hold_matrix_matchpoint function, and it may be a good idea to split it off to a function
219 -- We use one denominator for all tree-based checks for when permission groups and org units have the same weighting
220 WITH all_distance(distance) AS (
221 SELECT depth AS distance FROM actor.org_unit_type
223 SELECT distance AS distance FROM permission.grp_ancestors_distance((SELECT id FROM permission.grp_tree WHERE parent IS NULL))
225 SELECT INTO denominator MAX(distance) + 1 FROM all_distance;
227 -- Loop over all the potential matchpoints
228 FOR cur_matchpoint IN
230 FROM config.circ_matrix_matchpoint m
231 /*LEFT*/ JOIN permission.grp_ancestors_distance( user_object.profile ) upgad ON m.grp = upgad.id
232 /*LEFT*/ JOIN actor.org_unit_ancestors_distance( context_ou ) ctoua ON m.org_unit = ctoua.id
233 LEFT JOIN actor.org_unit_ancestors_distance( cn_object.owning_lib ) cnoua ON m.copy_owning_lib = cnoua.id
234 LEFT JOIN actor.org_unit_ancestors_distance( item_object.circ_lib ) iooua ON m.copy_circ_lib = iooua.id
235 LEFT JOIN actor.org_unit_ancestors_distance( user_object.home_ou ) uhoua ON m.user_home_ou = uhoua.id
238 -- AND (m.grp IS NULL OR upgad.id IS NOT NULL) -- Optional Permission Group?
240 -- AND (m.org_unit IS NULL OR ctoua.id IS NOT NULL) -- Optional Org Unit?
241 AND (m.copy_owning_lib IS NULL OR cnoua.id IS NOT NULL)
242 AND (m.copy_circ_lib IS NULL OR iooua.id IS NOT NULL)
243 AND (m.user_home_ou IS NULL OR uhoua.id IS NOT NULL)
245 AND (m.is_renewal IS NULL OR m.is_renewal = renewal)
246 -- Static User Checks
247 AND (m.juvenile_flag IS NULL OR m.juvenile_flag = user_object.juvenile)
248 AND (m.usr_age_lower_bound IS NULL OR (user_age IS NOT NULL AND m.usr_age_lower_bound < user_age))
249 AND (m.usr_age_upper_bound IS NULL OR (user_age IS NOT NULL AND m.usr_age_upper_bound > user_age))
250 -- Static Item Checks
251 AND (m.circ_modifier IS NULL OR m.circ_modifier = item_object.circ_modifier)
252 AND (m.copy_location IS NULL OR m.copy_location = item_object.location)
253 AND (m.marc_type IS NULL OR m.marc_type = COALESCE(item_object.circ_as_type, rec_descriptor.item_type))
254 AND (m.marc_form IS NULL OR m.marc_form = rec_descriptor.item_form)
255 AND (m.marc_bib_level IS NULL OR m.marc_bib_level = rec_descriptor.bib_level)
256 AND (m.marc_vr_format IS NULL OR m.marc_vr_format = rec_descriptor.vr_format)
257 AND (m.ref_flag IS NULL OR m.ref_flag = item_object.ref)
258 AND (m.item_age IS NULL OR (my_item_age IS NOT NULL AND m.item_age > my_item_age))
261 CASE WHEN upgad.distance IS NOT NULL THEN 2^(2*weights.grp - (upgad.distance/denominator)) ELSE 0.0 END +
263 CASE WHEN ctoua.distance IS NOT NULL THEN 2^(2*weights.org_unit - (ctoua.distance/denominator)) ELSE 0.0 END +
264 CASE WHEN cnoua.distance IS NOT NULL THEN 2^(2*weights.copy_owning_lib - (cnoua.distance/denominator)) ELSE 0.0 END +
265 CASE WHEN iooua.distance IS NOT NULL THEN 2^(2*weights.copy_circ_lib - (iooua.distance/denominator)) ELSE 0.0 END +
266 CASE WHEN uhoua.distance IS NOT NULL THEN 2^(2*weights.user_home_ou - (uhoua.distance/denominator)) ELSE 0.0 END +
267 -- Circ Type -- Note: 4^x is equiv to 2^(2*x)
268 CASE WHEN m.is_renewal IS NOT NULL THEN 4^weights.is_renewal ELSE 0.0 END +
269 -- Static User Checks
270 CASE WHEN m.juvenile_flag IS NOT NULL THEN 4^weights.juvenile_flag ELSE 0.0 END +
271 CASE WHEN m.usr_age_lower_bound IS NOT NULL THEN 4^weights.usr_age_lower_bound ELSE 0.0 END +
272 CASE WHEN m.usr_age_upper_bound IS NOT NULL THEN 4^weights.usr_age_upper_bound ELSE 0.0 END +
273 -- Static Item Checks
274 CASE WHEN m.circ_modifier IS NOT NULL THEN 4^weights.circ_modifier ELSE 0.0 END +
275 CASE WHEN m.copy_location IS NOT NULL THEN 4^weights.copy_location ELSE 0.0 END +
276 CASE WHEN m.marc_type IS NOT NULL THEN 4^weights.marc_type ELSE 0.0 END +
277 CASE WHEN m.marc_form IS NOT NULL THEN 4^weights.marc_form ELSE 0.0 END +
278 CASE WHEN m.marc_vr_format IS NOT NULL THEN 4^weights.marc_vr_format ELSE 0.0 END +
279 CASE WHEN m.ref_flag IS NOT NULL THEN 4^weights.ref_flag ELSE 0.0 END +
280 -- Item age has a slight adjustment to weight based on value.
281 -- This should ensure that a shorter age limit comes first when all else is equal.
282 -- NOTE: This assumes that intervals will normally be in days.
283 CASE WHEN m.item_age IS NOT NULL THEN 4^weights.item_age - 1 + 86400/EXTRACT(EPOCH FROM m.item_age) ELSE 0.0 END DESC,
284 -- Final sort on id, so that if two rules have the same sorting in the previous sort they have a defined order
285 -- This prevents "we changed the table order by updating a rule, and we started getting different results"
288 -- Record the full matching row list
289 row_list := row_list || cur_matchpoint.id;
291 -- No matchpoint yet?
292 IF matchpoint.id IS NULL THEN
293 -- Take the entire matchpoint as a starting point
294 matchpoint := cur_matchpoint;
295 CONTINUE; -- No need to look at this row any more.
298 -- Incomplete matchpoint?
299 IF matchpoint.circulate IS NULL THEN
300 matchpoint.circulate := cur_matchpoint.circulate;
302 IF matchpoint.duration_rule IS NULL THEN
303 matchpoint.duration_rule := cur_matchpoint.duration_rule;
305 IF matchpoint.recurring_fine_rule IS NULL THEN
306 matchpoint.recurring_fine_rule := cur_matchpoint.recurring_fine_rule;
308 IF matchpoint.max_fine_rule IS NULL THEN
309 matchpoint.max_fine_rule := cur_matchpoint.max_fine_rule;
311 IF matchpoint.hard_due_date IS NULL THEN
312 matchpoint.hard_due_date := cur_matchpoint.hard_due_date;
314 IF matchpoint.total_copy_hold_ratio IS NULL THEN
315 matchpoint.total_copy_hold_ratio := cur_matchpoint.total_copy_hold_ratio;
317 IF matchpoint.available_copy_hold_ratio IS NULL THEN
318 matchpoint.available_copy_hold_ratio := cur_matchpoint.available_copy_hold_ratio;
320 IF matchpoint.renewals IS NULL THEN
321 matchpoint.renewals := cur_matchpoint.renewals;
323 IF matchpoint.grace_period IS NULL THEN
324 matchpoint.grace_period := cur_matchpoint.grace_period;
328 -- Check required fields
329 IF matchpoint.circulate IS NOT NULL AND
330 matchpoint.duration_rule IS NOT NULL AND
331 matchpoint.recurring_fine_rule IS NOT NULL AND
332 matchpoint.max_fine_rule IS NOT NULL THEN
333 -- All there? We have a completed match.
334 result.success := true;
337 -- Include the assembled matchpoint, even if it isn't complete
338 result.matchpoint := matchpoint;
340 -- Include (for debugging) the full list of matching rows
341 result.buildrows := row_list;
343 -- Hand the result back to caller
346 $func$ LANGUAGE plpgsql;
348 -- Helper function - For manual calling, it can be easier to pass in IDs instead of objects
349 CREATE OR REPLACE FUNCTION action.find_circ_matrix_matchpoint( context_ou INT, match_item BIGINT, match_user INT, renewal BOOL ) RETURNS SETOF action.found_circ_matrix_matchpoint AS $func$
351 item_object asset.copy%ROWTYPE;
352 user_object actor.usr%ROWTYPE;
354 SELECT INTO item_object * FROM asset.copy WHERE id = match_item;
355 SELECT INTO user_object * FROM actor.usr WHERE id = match_user;
357 RETURN QUERY SELECT * FROM action.find_circ_matrix_matchpoint( context_ou, item_object, user_object, renewal );
359 $func$ LANGUAGE plpgsql;
361 CREATE TYPE action.hold_stats AS (
365 total_copy_ratio FLOAT,
366 available_copy_ratio FLOAT
369 CREATE OR REPLACE FUNCTION action.copy_related_hold_stats (copy_id BIGINT) RETURNS action.hold_stats AS $func$
371 output action.hold_stats%ROWTYPE;
374 available_count INT := 0;
375 hold_map_data RECORD;
378 output.hold_count := 0;
379 output.copy_count := 0;
380 output.available_count := 0;
382 SELECT COUNT( DISTINCT m.hold ) INTO hold_count
383 FROM action.hold_copy_map m
384 JOIN action.hold_request h ON (m.hold = h.id)
385 WHERE m.target_copy = copy_id
388 output.hold_count := hold_count;
390 IF output.hold_count > 0 THEN
392 SELECT DISTINCT m.target_copy,
394 FROM action.hold_copy_map m
395 JOIN asset.copy acp ON (m.target_copy = acp.id)
396 JOIN action.hold_request h ON (m.hold = h.id)
397 WHERE m.hold IN ( SELECT DISTINCT hold FROM action.hold_copy_map WHERE target_copy = copy_id ) AND NOT h.frozen
399 output.copy_count := output.copy_count + 1;
400 IF hold_map_data.status IN (0,7,12) THEN
401 output.available_count := output.available_count + 1;
404 output.total_copy_ratio = output.copy_count::FLOAT / output.hold_count::FLOAT;
405 output.available_copy_ratio = output.available_count::FLOAT / output.hold_count::FLOAT;
412 $func$ LANGUAGE PLPGSQL;
414 CREATE TYPE action.circ_matrix_test_result AS ( success BOOL, fail_part TEXT, buildrows INT[], matchpoint INT, circulate BOOL, duration_rule INT, recurring_fine_rule INT, max_fine_rule INT, hard_due_date INT, renewals INT, grace_period INTERVAL, limit_groups INT[] );
415 CREATE OR REPLACE FUNCTION action.item_user_circ_test( circ_ou INT, match_item BIGINT, match_user INT, renewal BOOL ) RETURNS SETOF action.circ_matrix_test_result AS $func$
417 user_object actor.usr%ROWTYPE;
418 standing_penalty config.standing_penalty%ROWTYPE;
419 item_object asset.copy%ROWTYPE;
420 item_status_object config.copy_status%ROWTYPE;
421 item_location_object asset.copy_location%ROWTYPE;
422 result action.circ_matrix_test_result;
423 circ_test action.found_circ_matrix_matchpoint;
424 circ_matchpoint config.circ_matrix_matchpoint%ROWTYPE;
425 circ_limit_set config.circ_limit_set%ROWTYPE;
426 hold_ratio action.hold_stats%ROWTYPE;
429 context_org_list INT[];
434 -- Assume success unless we hit a failure condition
435 result.success := TRUE;
437 -- Need user info to look up matchpoints
438 SELECT INTO user_object * FROM actor.usr WHERE id = match_user AND NOT deleted;
440 -- (Insta)Fail if we couldn't find the user
441 IF user_object.id IS NULL THEN
442 result.fail_part := 'no_user';
443 result.success := FALSE;
449 -- Need item info to look up matchpoints
450 SELECT INTO item_object * FROM asset.copy WHERE id = match_item AND NOT deleted;
452 -- (Insta)Fail if we couldn't find the item
453 IF item_object.id IS NULL THEN
454 result.fail_part := 'no_item';
455 result.success := FALSE;
461 SELECT INTO circ_test * FROM action.find_circ_matrix_matchpoint(circ_ou, item_object, user_object, renewal);
463 circ_matchpoint := circ_test.matchpoint;
464 result.matchpoint := circ_matchpoint.id;
465 result.circulate := circ_matchpoint.circulate;
466 result.duration_rule := circ_matchpoint.duration_rule;
467 result.recurring_fine_rule := circ_matchpoint.recurring_fine_rule;
468 result.max_fine_rule := circ_matchpoint.max_fine_rule;
469 result.hard_due_date := circ_matchpoint.hard_due_date;
470 result.renewals := circ_matchpoint.renewals;
471 result.grace_period := circ_matchpoint.grace_period;
472 result.buildrows := circ_test.buildrows;
474 -- (Insta)Fail if we couldn't find a matchpoint
475 IF circ_test.success = false THEN
476 result.fail_part := 'no_matchpoint';
477 result.success := FALSE;
483 -- All failures before this point are non-recoverable
484 -- Below this point are possibly overridable failures
486 -- Fail if the user is barred
487 IF user_object.barred IS TRUE THEN
488 result.fail_part := 'actor.usr.barred';
489 result.success := FALSE;
494 -- Fail if the item can't circulate
495 IF item_object.circulate IS FALSE THEN
496 result.fail_part := 'asset.copy.circulate';
497 result.success := FALSE;
502 -- Fail if the item isn't in a circulateable status on a non-renewal
503 IF NOT renewal AND item_object.status <> 8 AND item_object.status NOT IN (
504 (SELECT id FROM config.copy_status WHERE is_available) ) THEN
505 result.fail_part := 'asset.copy.status';
506 result.success := FALSE;
509 -- Alternately, fail if the item isn't checked out on a renewal
510 ELSIF renewal AND item_object.status <> 1 THEN
511 result.fail_part := 'asset.copy.status';
512 result.success := FALSE;
517 -- Fail if the item can't circulate because of the shelving location
518 SELECT INTO item_location_object * FROM asset.copy_location WHERE id = item_object.location;
519 IF item_location_object.circulate IS FALSE THEN
520 result.fail_part := 'asset.copy_location.circulate';
521 result.success := FALSE;
526 -- Use Circ OU for penalties and such
527 SELECT INTO context_org_list ARRAY_AGG(id) FROM actor.org_unit_full_path( circ_ou );
529 -- Proximity of user's home_ou to circ_ou to see if penalties should be ignored.
530 SELECT INTO home_prox prox FROM actor.org_unit_proximity WHERE from_org = user_object.home_ou AND to_org = circ_ou;
532 -- Proximity of user's home_ou to item circ_lib to see if penalties should be ignored.
533 SELECT INTO item_prox prox FROM actor.org_unit_proximity WHERE from_org = user_object.home_ou AND to_org = item_object.circ_lib;
536 penalty_type = '%RENEW%';
538 penalty_type = '%CIRC%';
541 FOR standing_penalty IN
542 SELECT DISTINCT csp.*
543 FROM actor.usr_standing_penalty usp
544 JOIN config.standing_penalty csp ON (csp.id = usp.standing_penalty)
545 WHERE usr = match_user
546 AND usp.org_unit IN ( SELECT * FROM unnest(context_org_list) )
547 AND (usp.stop_date IS NULL or usp.stop_date > NOW())
548 AND (csp.ignore_proximity IS NULL
549 OR csp.ignore_proximity < home_prox
550 OR csp.ignore_proximity < item_prox)
551 AND csp.block_list LIKE penalty_type LOOP
553 result.fail_part := standing_penalty.name;
554 result.success := FALSE;
559 -- Fail if the test is set to hard non-circulating
560 IF circ_matchpoint.circulate IS FALSE THEN
561 result.fail_part := 'config.circ_matrix_test.circulate';
562 result.success := FALSE;
567 -- Fail if the total copy-hold ratio is too low
568 IF circ_matchpoint.total_copy_hold_ratio IS NOT NULL THEN
569 SELECT INTO hold_ratio * FROM action.copy_related_hold_stats(match_item);
570 IF hold_ratio.total_copy_ratio IS NOT NULL AND hold_ratio.total_copy_ratio < circ_matchpoint.total_copy_hold_ratio THEN
571 result.fail_part := 'config.circ_matrix_test.total_copy_hold_ratio';
572 result.success := FALSE;
578 -- Fail if the available copy-hold ratio is too low
579 IF circ_matchpoint.available_copy_hold_ratio IS NOT NULL THEN
580 IF hold_ratio.hold_count IS NULL THEN
581 SELECT INTO hold_ratio * FROM action.copy_related_hold_stats(match_item);
583 IF hold_ratio.available_copy_ratio IS NOT NULL AND hold_ratio.available_copy_ratio < circ_matchpoint.available_copy_hold_ratio THEN
584 result.fail_part := 'config.circ_matrix_test.available_copy_hold_ratio';
585 result.success := FALSE;
591 -- Fail if the user has too many items out by defined limit sets
592 FOR circ_limit_set IN SELECT ccls.* FROM config.circ_limit_set ccls
593 JOIN config.circ_matrix_limit_set_map ccmlsm ON ccmlsm.limit_set = ccls.id
594 WHERE ccmlsm.active AND ( ccmlsm.matchpoint = circ_matchpoint.id OR
595 ( ccmlsm.matchpoint IN (SELECT * FROM unnest(result.buildrows)) AND ccmlsm.fallthrough )
597 IF circ_limit_set.items_out > 0 AND NOT renewal THEN
598 SELECT INTO context_org_list ARRAY_AGG(aou.id)
599 FROM actor.org_unit_full_path( circ_ou ) aou
600 JOIN actor.org_unit_type aout ON aou.ou_type = aout.id
601 WHERE aout.depth >= circ_limit_set.depth;
602 IF circ_limit_set.global THEN
603 WITH RECURSIVE descendant_depth AS (
606 FROM actor.org_unit ou
607 WHERE ou.id IN (SELECT * FROM unnest(context_org_list))
611 FROM actor.org_unit ou
612 JOIN descendant_depth ot ON (ot.id = ou.parent_ou)
613 ) SELECT INTO context_org_list ARRAY_AGG(ou.id) FROM actor.org_unit ou JOIN descendant_depth USING (id);
615 SELECT INTO items_out COUNT(DISTINCT circ.id)
616 FROM action.circulation circ
617 JOIN asset.copy copy ON (copy.id = circ.target_copy)
618 LEFT JOIN action.circulation_limit_group_map aclgm ON (circ.id = aclgm.circ)
619 WHERE circ.usr = match_user
620 AND circ.circ_lib IN (SELECT * FROM unnest(context_org_list))
621 AND circ.checkin_time IS NULL
622 AND circ.xact_finish IS NULL
623 AND (circ.stop_fines IN ('MAXFINES','LONGOVERDUE') OR circ.stop_fines IS NULL)
624 AND (copy.circ_modifier IN (SELECT circ_mod FROM config.circ_limit_set_circ_mod_map WHERE limit_set = circ_limit_set.id)
625 OR copy.location IN (SELECT copy_loc FROM config.circ_limit_set_copy_loc_map WHERE limit_set = circ_limit_set.id)
626 OR aclgm.limit_group IN (SELECT limit_group FROM config.circ_limit_set_group_map WHERE limit_set = circ_limit_set.id)
628 IF items_out >= circ_limit_set.items_out THEN
629 result.fail_part := 'config.circ_matrix_circ_mod_test';
630 result.success := FALSE;
635 SELECT INTO result.limit_groups result.limit_groups || ARRAY_AGG(limit_group) FROM config.circ_limit_set_group_map WHERE limit_set = circ_limit_set.id AND NOT check_only;
638 -- If we passed everything, return the successful matchpoint
645 $func$ LANGUAGE plpgsql;
647 CREATE OR REPLACE FUNCTION action.item_user_circ_test( INT, BIGINT, INT ) RETURNS SETOF action.circ_matrix_test_result AS $func$
648 SELECT * FROM action.item_user_circ_test( $1, $2, $3, FALSE );
651 CREATE OR REPLACE FUNCTION action.item_user_renew_test( INT, BIGINT, INT ) RETURNS SETOF action.circ_matrix_test_result AS $func$
652 SELECT * FROM action.item_user_circ_test( $1, $2, $3, TRUE );
655 CREATE OR REPLACE FUNCTION actor.calculate_system_penalties( match_user INT, context_org INT ) RETURNS SETOF actor.usr_standing_penalty AS $func$
657 user_object actor.usr%ROWTYPE;
658 new_sp_row actor.usr_standing_penalty%ROWTYPE;
659 existing_sp_row actor.usr_standing_penalty%ROWTYPE;
660 collections_fines permission.grp_penalty_threshold%ROWTYPE;
661 max_fines permission.grp_penalty_threshold%ROWTYPE;
662 max_overdue permission.grp_penalty_threshold%ROWTYPE;
663 max_items_out permission.grp_penalty_threshold%ROWTYPE;
664 max_lost permission.grp_penalty_threshold%ROWTYPE;
665 max_longoverdue permission.grp_penalty_threshold%ROWTYPE;
670 items_longoverdue INT;
671 context_org_list INT[];
672 current_fines NUMERIC(8,2) := 0.0;
673 tmp_fines NUMERIC(8,2);
676 tmp_org actor.org_unit%ROWTYPE;
677 tmp_penalty config.standing_penalty%ROWTYPE;
680 SELECT INTO user_object * FROM actor.usr WHERE id = match_user;
683 SELECT INTO tmp_org * FROM actor.org_unit WHERE id = context_org;
685 -- Fail if the user has a high fine balance
687 tmp_grp := user_object.profile;
689 SELECT * INTO max_fines FROM permission.grp_penalty_threshold WHERE grp = tmp_grp AND penalty = 1 AND org_unit = tmp_org.id;
691 IF max_fines.threshold IS NULL THEN
692 SELECT parent INTO tmp_grp FROM permission.grp_tree WHERE id = tmp_grp;
697 IF tmp_grp IS NULL THEN
702 IF max_fines.threshold IS NOT NULL OR tmp_org.parent_ou IS NULL THEN
706 SELECT * INTO tmp_org FROM actor.org_unit WHERE id = tmp_org.parent_ou;
710 IF max_fines.threshold IS NOT NULL THEN
714 FROM actor.usr_standing_penalty
715 WHERE usr = match_user
716 AND org_unit = max_fines.org_unit
717 AND (stop_date IS NULL or stop_date > NOW())
718 AND standing_penalty = 1;
720 SELECT INTO context_org_list ARRAY_AGG(id) FROM actor.org_unit_full_path( max_fines.org_unit );
722 SELECT SUM(f.balance_owed) INTO current_fines
723 FROM money.materialized_billable_xact_summary f
726 FROM booking.reservation r
727 WHERE r.usr = match_user
728 AND r.pickup_lib IN (SELECT * FROM unnest(context_org_list))
729 AND xact_finish IS NULL
733 WHERE g.usr = match_user
734 AND g.billing_location IN (SELECT * FROM unnest(context_org_list))
735 AND xact_finish IS NULL
738 FROM action.circulation circ
739 WHERE circ.usr = match_user
740 AND circ.circ_lib IN (SELECT * FROM unnest(context_org_list))
741 AND xact_finish IS NULL ) l USING (id);
743 IF current_fines >= max_fines.threshold THEN
744 new_sp_row.usr := match_user;
745 new_sp_row.org_unit := max_fines.org_unit;
746 new_sp_row.standing_penalty := 1;
747 RETURN NEXT new_sp_row;
751 -- Start over for max overdue
752 SELECT INTO tmp_org * FROM actor.org_unit WHERE id = context_org;
754 -- Fail if the user has too many overdue items
756 tmp_grp := user_object.profile;
759 SELECT * INTO max_overdue FROM permission.grp_penalty_threshold WHERE grp = tmp_grp AND penalty = 2 AND org_unit = tmp_org.id;
761 IF max_overdue.threshold IS NULL THEN
762 SELECT parent INTO tmp_grp FROM permission.grp_tree WHERE id = tmp_grp;
767 IF tmp_grp IS NULL THEN
772 IF max_overdue.threshold IS NOT NULL OR tmp_org.parent_ou IS NULL THEN
776 SELECT INTO tmp_org * FROM actor.org_unit WHERE id = tmp_org.parent_ou;
780 IF max_overdue.threshold IS NOT NULL THEN
784 FROM actor.usr_standing_penalty
785 WHERE usr = match_user
786 AND org_unit = max_overdue.org_unit
787 AND (stop_date IS NULL or stop_date > NOW())
788 AND standing_penalty = 2;
790 SELECT INTO items_overdue COUNT(*)
791 FROM action.circulation circ
792 JOIN actor.org_unit_full_path( max_overdue.org_unit ) fp ON (circ.circ_lib = fp.id)
793 WHERE circ.usr = match_user
794 AND circ.checkin_time IS NULL
795 AND circ.due_date < NOW()
796 AND (circ.stop_fines = 'MAXFINES' OR circ.stop_fines IS NULL);
798 IF items_overdue >= max_overdue.threshold::INT THEN
799 new_sp_row.usr := match_user;
800 new_sp_row.org_unit := max_overdue.org_unit;
801 new_sp_row.standing_penalty := 2;
802 RETURN NEXT new_sp_row;
806 -- Start over for max out
807 SELECT INTO tmp_org * FROM actor.org_unit WHERE id = context_org;
809 -- Fail if the user has too many checked out items
811 tmp_grp := user_object.profile;
813 SELECT * INTO max_items_out FROM permission.grp_penalty_threshold WHERE grp = tmp_grp AND penalty = 3 AND org_unit = tmp_org.id;
815 IF max_items_out.threshold IS NULL THEN
816 SELECT parent INTO tmp_grp FROM permission.grp_tree WHERE id = tmp_grp;
821 IF tmp_grp IS NULL THEN
826 IF max_items_out.threshold IS NOT NULL OR tmp_org.parent_ou IS NULL THEN
830 SELECT INTO tmp_org * FROM actor.org_unit WHERE id = tmp_org.parent_ou;
835 -- Fail if the user has too many items checked out
836 IF max_items_out.threshold IS NOT NULL THEN
840 FROM actor.usr_standing_penalty
841 WHERE usr = match_user
842 AND org_unit = max_items_out.org_unit
843 AND (stop_date IS NULL or stop_date > NOW())
844 AND standing_penalty = 3;
846 SELECT INTO items_out COUNT(*)
847 FROM action.circulation circ
848 JOIN actor.org_unit_full_path( max_items_out.org_unit ) fp ON (circ.circ_lib = fp.id)
849 WHERE circ.usr = match_user
850 AND circ.checkin_time IS NULL
851 AND (circ.stop_fines IN (
852 SELECT 'MAXFINES'::TEXT
854 SELECT 'LONGOVERDUE'::TEXT
860 WHEN (SELECT value FROM actor.org_unit_ancestor_setting('circ.tally_lost', circ.circ_lib)) ILIKE 'true' THEN 'true'
865 SELECT 'CLAIMSRETURNED'::TEXT
869 WHEN (SELECT value FROM actor.org_unit_ancestor_setting('circ.do_not_tally_claims_returned', circ.circ_lib)) ILIKE 'true' THEN 'true'
873 ) OR circ.stop_fines IS NULL)
874 AND xact_finish IS NULL;
876 IF items_out >= max_items_out.threshold::INT THEN
877 new_sp_row.usr := match_user;
878 new_sp_row.org_unit := max_items_out.org_unit;
879 new_sp_row.standing_penalty := 3;
880 RETURN NEXT new_sp_row;
884 -- Start over for max lost
885 SELECT INTO tmp_org * FROM actor.org_unit WHERE id = context_org;
887 -- Fail if the user has too many lost items
889 tmp_grp := user_object.profile;
892 SELECT * INTO max_lost FROM permission.grp_penalty_threshold WHERE grp = tmp_grp AND penalty = 5 AND org_unit = tmp_org.id;
894 IF max_lost.threshold IS NULL THEN
895 SELECT parent INTO tmp_grp FROM permission.grp_tree WHERE id = tmp_grp;
900 IF tmp_grp IS NULL THEN
905 IF max_lost.threshold IS NOT NULL OR tmp_org.parent_ou IS NULL THEN
909 SELECT INTO tmp_org * FROM actor.org_unit WHERE id = tmp_org.parent_ou;
913 IF max_lost.threshold IS NOT NULL THEN
917 FROM actor.usr_standing_penalty
918 WHERE usr = match_user
919 AND org_unit = max_lost.org_unit
920 AND (stop_date IS NULL or stop_date > NOW())
921 AND standing_penalty = 5;
923 SELECT INTO items_lost COUNT(*)
924 FROM action.circulation circ
925 JOIN actor.org_unit_full_path( max_lost.org_unit ) fp ON (circ.circ_lib = fp.id)
926 WHERE circ.usr = match_user
927 AND circ.checkin_time IS NULL
928 AND (circ.stop_fines = 'LOST')
929 AND xact_finish IS NULL;
931 IF items_lost >= max_lost.threshold::INT AND 0 < max_lost.threshold::INT THEN
932 new_sp_row.usr := match_user;
933 new_sp_row.org_unit := max_lost.org_unit;
934 new_sp_row.standing_penalty := 5;
935 RETURN NEXT new_sp_row;
939 -- Start over for max longoverdue
940 SELECT INTO tmp_org * FROM actor.org_unit WHERE id = context_org;
942 -- Fail if the user has too many longoverdue items
944 tmp_grp := user_object.profile;
947 SELECT * INTO max_longoverdue
948 FROM permission.grp_penalty_threshold
949 WHERE grp = tmp_grp AND
951 org_unit = tmp_org.id;
953 IF max_longoverdue.threshold IS NULL THEN
954 SELECT parent INTO tmp_grp
955 FROM permission.grp_tree WHERE id = tmp_grp;
960 IF tmp_grp IS NULL THEN
965 IF max_longoverdue.threshold IS NOT NULL
966 OR tmp_org.parent_ou IS NULL THEN
970 SELECT INTO tmp_org * FROM actor.org_unit WHERE id = tmp_org.parent_ou;
974 IF max_longoverdue.threshold IS NOT NULL THEN
978 FROM actor.usr_standing_penalty
979 WHERE usr = match_user
980 AND org_unit = max_longoverdue.org_unit
981 AND (stop_date IS NULL or stop_date > NOW())
982 AND standing_penalty = 35;
984 SELECT INTO items_longoverdue COUNT(*)
985 FROM action.circulation circ
986 JOIN actor.org_unit_full_path( max_longoverdue.org_unit ) fp
987 ON (circ.circ_lib = fp.id)
988 WHERE circ.usr = match_user
989 AND circ.checkin_time IS NULL
990 AND (circ.stop_fines = 'LONGOVERDUE')
991 AND xact_finish IS NULL;
993 IF items_longoverdue >= max_longoverdue.threshold::INT
994 AND 0 < max_longoverdue.threshold::INT THEN
995 new_sp_row.usr := match_user;
996 new_sp_row.org_unit := max_longoverdue.org_unit;
997 new_sp_row.standing_penalty := 35;
998 RETURN NEXT new_sp_row;
1003 -- Start over for collections warning
1004 SELECT INTO tmp_org * FROM actor.org_unit WHERE id = context_org;
1006 -- Fail if the user has a collections-level fine balance
1008 tmp_grp := user_object.profile;
1010 SELECT * INTO max_fines FROM permission.grp_penalty_threshold WHERE grp = tmp_grp AND penalty = 4 AND org_unit = tmp_org.id;
1012 IF max_fines.threshold IS NULL THEN
1013 SELECT parent INTO tmp_grp FROM permission.grp_tree WHERE id = tmp_grp;
1018 IF tmp_grp IS NULL THEN
1023 IF max_fines.threshold IS NOT NULL OR tmp_org.parent_ou IS NULL THEN
1027 SELECT * INTO tmp_org FROM actor.org_unit WHERE id = tmp_org.parent_ou;
1031 IF max_fines.threshold IS NOT NULL THEN
1035 FROM actor.usr_standing_penalty
1036 WHERE usr = match_user
1037 AND org_unit = max_fines.org_unit
1038 AND (stop_date IS NULL or stop_date > NOW())
1039 AND standing_penalty = 4;
1041 SELECT INTO context_org_list ARRAY_AGG(id) FROM actor.org_unit_full_path( max_fines.org_unit );
1043 SELECT SUM(f.balance_owed) INTO current_fines
1044 FROM money.materialized_billable_xact_summary f
1047 FROM booking.reservation r
1048 WHERE r.usr = match_user
1049 AND r.pickup_lib IN (SELECT * FROM unnest(context_org_list))
1050 AND r.xact_finish IS NULL
1053 FROM money.grocery g
1054 WHERE g.usr = match_user
1055 AND g.billing_location IN (SELECT * FROM unnest(context_org_list))
1056 AND g.xact_finish IS NULL
1059 FROM action.circulation circ
1060 WHERE circ.usr = match_user
1061 AND circ.circ_lib IN (SELECT * FROM unnest(context_org_list))
1062 AND circ.xact_finish IS NULL ) l USING (id);
1064 IF current_fines >= max_fines.threshold THEN
1065 new_sp_row.usr := match_user;
1066 new_sp_row.org_unit := max_fines.org_unit;
1067 new_sp_row.standing_penalty := 4;
1068 RETURN NEXT new_sp_row;
1072 -- Start over for in collections
1073 SELECT INTO tmp_org * FROM actor.org_unit WHERE id = context_org;
1075 -- Remove the in-collections penalty if the user has paid down enough
1076 -- This penalty is different, because this code is not responsible for creating
1077 -- new in-collections penalties, only for removing them
1079 tmp_grp := user_object.profile;
1081 SELECT * INTO max_fines FROM permission.grp_penalty_threshold WHERE grp = tmp_grp AND penalty = 30 AND org_unit = tmp_org.id;
1083 IF max_fines.threshold IS NULL THEN
1084 SELECT parent INTO tmp_grp FROM permission.grp_tree WHERE id = tmp_grp;
1089 IF tmp_grp IS NULL THEN
1094 IF max_fines.threshold IS NOT NULL OR tmp_org.parent_ou IS NULL THEN
1098 SELECT * INTO tmp_org FROM actor.org_unit WHERE id = tmp_org.parent_ou;
1102 IF max_fines.threshold IS NOT NULL THEN
1104 SELECT INTO context_org_list ARRAY_AGG(id) FROM actor.org_unit_full_path( max_fines.org_unit );
1106 -- first, see if the user had paid down to the threshold
1107 SELECT SUM(f.balance_owed) INTO current_fines
1108 FROM money.materialized_billable_xact_summary f
1111 FROM booking.reservation r
1112 WHERE r.usr = match_user
1113 AND r.pickup_lib IN (SELECT * FROM unnest(context_org_list))
1114 AND r.xact_finish IS NULL
1117 FROM money.grocery g
1118 WHERE g.usr = match_user
1119 AND g.billing_location IN (SELECT * FROM unnest(context_org_list))
1120 AND g.xact_finish IS NULL
1123 FROM action.circulation circ
1124 WHERE circ.usr = match_user
1125 AND circ.circ_lib IN (SELECT * FROM unnest(context_org_list))
1126 AND circ.xact_finish IS NULL ) l USING (id);
1128 IF current_fines IS NULL OR current_fines <= max_fines.threshold THEN
1129 -- patron has paid down enough
1131 SELECT INTO tmp_penalty * FROM config.standing_penalty WHERE id = 30;
1133 IF tmp_penalty.org_depth IS NOT NULL THEN
1135 -- since this code is not responsible for applying the penalty, it can't
1136 -- guarantee the current context org will match the org at which the penalty
1137 --- was applied. search up the org tree until we hit the configured penalty depth
1138 SELECT INTO tmp_org * FROM actor.org_unit WHERE id = context_org;
1139 SELECT INTO tmp_depth depth FROM actor.org_unit_type WHERE id = tmp_org.ou_type;
1141 WHILE tmp_depth >= tmp_penalty.org_depth LOOP
1145 FROM actor.usr_standing_penalty
1146 WHERE usr = match_user
1147 AND org_unit = tmp_org.id
1148 AND (stop_date IS NULL or stop_date > NOW())
1149 AND standing_penalty = 30;
1151 IF tmp_org.parent_ou IS NULL THEN
1155 SELECT * INTO tmp_org FROM actor.org_unit WHERE id = tmp_org.parent_ou;
1156 SELECT INTO tmp_depth depth FROM actor.org_unit_type WHERE id = tmp_org.ou_type;
1161 -- no penalty depth is defined, look for exact matches
1165 FROM actor.usr_standing_penalty
1166 WHERE usr = match_user
1167 AND org_unit = max_fines.org_unit
1168 AND (stop_date IS NULL or stop_date > NOW())
1169 AND standing_penalty = 30;
1178 $func$ LANGUAGE plpgsql;