4 -- NOTE: current config.item_type should get sip2_media_type and magnetic_media columns
6 -- New table needed to handle circ modifiers inside the DB. Will still require
7 -- central admin. The circ_modifier column on asset.copy will become an fkey to this table.
8 CREATE TABLE config.circ_modifier (
10 name TEXT UNIQUE NOT NULL,
11 description TEXT NOT NULL,
12 sip2_media_type TEXT NOT NULL,
13 magnetic_media BOOL NOT NULL DEFAULT TRUE
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;
44 -- config table to hold the vr_format names
45 CREATE TABLE config.videorecording_format_map (
46 code TEXT PRIMARY KEY,
50 INSERT INTO config.videorecording_format_map VALUES ('a','Beta');
51 INSERT INTO config.videorecording_format_map VALUES ('b','VHS');
52 INSERT INTO config.videorecording_format_map VALUES ('c','U-matic');
53 INSERT INTO config.videorecording_format_map VALUES ('d','EIAJ');
54 INSERT INTO config.videorecording_format_map VALUES ('e','Type C');
55 INSERT INTO config.videorecording_format_map VALUES ('f','Quadruplex');
56 INSERT INTO config.videorecording_format_map VALUES ('g','Laserdisc');
57 INSERT INTO config.videorecording_format_map VALUES ('h','CED');
58 INSERT INTO config.videorecording_format_map VALUES ('i','Betacam');
59 INSERT INTO config.videorecording_format_map VALUES ('j','Betacam SP');
60 INSERT INTO config.videorecording_format_map VALUES ('k','Super-VHS');
61 INSERT INTO config.videorecording_format_map VALUES ('m','M-II');
62 INSERT INTO config.videorecording_format_map VALUES ('o','D-2');
63 INSERT INTO config.videorecording_format_map VALUES ('p','8 mm.');
64 INSERT INTO config.videorecording_format_map VALUES ('q','Hi-8 mm.');
65 INSERT INTO config.videorecording_format_map VALUES ('u','Unknown');
66 INSERT INTO config.videorecording_format_map VALUES ('v','DVD');
67 INSERT INTO config.videorecording_format_map VALUES ('z','Other');
72 ** Here we define the tables that make up the circ matrix. Conceptually, this implements
73 ** the "sparse matrix" that everyone talks about, instead of using traditional rules logic.
74 ** Physically, we cut the matrix up into separate tables (almost 3rd normal form!) that handle
75 ** different portions of the matrix. This wil simplify creation of the UI (I hope), and help the
76 ** developers focus on specific parts of the matrix.
81 -- ****** Which ruleset and tests to use *******
83 -- * Most specific range for org_unit and grp wins.
85 -- * circ_modifier match takes precidence over marc_type match, if circ_modifier is set here
87 -- * marc_type is first checked against the circ_as_type from the copy, then the item type from the marc record
89 -- * If neither circ_modifier nor marc_type is set (both are NULLABLE) then the entry defines the default
90 -- ruleset and tests for the OU + group (like BOOK in PINES)
93 CREATE TABLE config.circ_matrix_matchpoint (
94 id SERIAL PRIMARY KEY,
95 active BOOL NOT NULL DEFAULT TRUE,
96 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"
97 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
98 circ_modifier TEXT REFERENCES config.circ_modifier (code) DEFERRABLE INITIALLY DEFERRED,
99 marc_type TEXT REFERENCES config.item_type_map (code) DEFERRABLE INITIALLY DEFERRED,
100 marc_form TEXT REFERENCES config.item_form_map (code) DEFERRABLE INITIALLY DEFERRED,
101 marc_vr_format TEXT REFERENCES config.videorecording_format_map (code) DEFERRABLE INITIALLY DEFERRED,
103 usr_age_lower_bound INTERVAL,
104 usr_age_upper_bound INTERVAL,
105 CONSTRAINT ep_once_per_grp_loc_mod_marc UNIQUE (grp, org_unit, circ_modifier, marc_type, marc_form, marc_vr_format, ref_flag, usr_age_lower_bound, usr_age_upper_bound)
109 -- Tests to determine if circ can occur for this item at this location for this patron
110 CREATE TABLE config.circ_matrix_test (
111 matchpoint INT PRIMARY KEY NOT NULL REFERENCES config.circ_matrix_matchpoint (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
112 circulate BOOL NOT NULL DEFAULT TRUE, -- Hard "can't circ" flag requiring an override
113 max_items_out INT, -- Total current active circulations must be less than this, NULL means skip (always pass)
114 max_overdue INT, -- Total overdue active circulations must be less than this, NULL means skip (always pass)
115 max_fines NUMERIC(8,2), -- Total fines owed must be less than this, NULL means skip (always pass)
116 script_test TEXT -- filename or javascript source ??
119 -- Tests for max items out by circ_modifier
120 CREATE TABLE config.circ_matrix_circ_mod_test (
121 id SERIAL PRIMARY KEY,
122 matchpoint INT NOT NULL REFERENCES config.circ_matrix_matchpoint (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
123 items_out INT NOT NULL, -- Total current active circulations must be less than this, NULL means skip (always pass)
124 circ_mod TEXT NOT NULL REFERENCES config.circ_modifier (code) ON DELETE CASCADE ON UPDATE CASCADE DEFERRABLE INITIALLY DEFERRED-- circ_modifier type that the max out applies to
128 -- How to circ, assuming tests pass
129 CREATE TABLE config.circ_matrix_ruleset (
130 matchpoint INT PRIMARY KEY REFERENCES config.circ_matrix_matchpoint (id) DEFERRABLE INITIALLY DEFERRED,
131 duration_rule INT NOT NULL REFERENCES config.rule_circ_duration (id) DEFERRABLE INITIALLY DEFERRED,
132 recurring_fine_rule INT NOT NULL REFERENCES config.rule_recuring_fine (id) DEFERRABLE INITIALLY DEFERRED,
133 max_fine_rule INT NOT NULL REFERENCES config.rule_max_fine (id) DEFERRABLE INITIALLY DEFERRED
136 CREATE OR REPLACE FUNCTION action.find_circ_matrix_matchpoint( context_ou INT, match_item BIGINT, match_user INT ) RETURNS INT AS $func$
138 current_group permission.grp_tree%ROWTYPE;
139 user_object actor.usr%ROWTYPE;
140 item_object asset.copy%ROWTYPE;
141 rec_descriptor metabib.rec_descriptor%ROWTYPE;
142 current_mp config.circ_matrix_matchpoint%ROWTYPE;
143 matchpoint config.circ_matrix_matchpoint%ROWTYPE;
145 SELECT INTO user_object * FROM actor.usr WHERE id = match_user;
146 SELECT INTO item_object * FROM asset.copy WHERE id = match_item;
147 SELECT INTO rec_descriptor r.* FROM metabib.rec_descriptor r JOIN asset.call_number c USING (record) WHERE c.id = item_object.call_number;
148 SELECT INTO current_group * FROM permission.grp_tree WHERE id = user_object.profile;
151 -- for each potential matchpoint for this ou and group ...
154 FROM config.circ_matrix_matchpoint m
155 JOIN actor.org_unit_ancestors( context_ou ) d ON (m.org_unit = d.id)
156 LEFT JOIN actor.org_unit_proximity p ON (p.from_org = context_ou AND p.to_org = d.id)
157 WHERE m.grp = current_group.id AND m.active
158 ORDER BY CASE WHEN p.prox IS NULL THEN 999 ELSE p.prox END,
159 CASE WHEN m.circ_modifier IS NOT NULL THEN 32 ELSE 0 END +
160 CASE WHEN m.marc_type IS NOT NULL THEN 16 ELSE 0 END +
161 CASE WHEN m.marc_form IS NOT NULL THEN 8 ELSE 0 END +
162 CASE WHEN m.marc_vr_format IS NOT NULL THEN 4 ELSE 0 END +
163 CASE WHEN m.ref_flag IS NOT NULL THEN 2 ELSE 0 END +
164 CASE WHEN m.usr_age_lower_bound IS NOT NULL THEN 0.5 ELSE 0 END +
165 CASE WHEN m.usr_age_upper_bound IS NOT NULL THEN 0.5 ELSE 0 END DESC LOOP
167 IF current_mp.circ_modifier IS NOT NULL THEN
168 CONTINUE WHEN current_mp.circ_modifier <> item_object.circ_modifier;
171 IF current_mp.marc_type IS NOT NULL THEN
172 IF item_object.circ_as_type IS NOT NULL THEN
173 CONTINUE WHEN current_mp.marc_type <> item_object.circ_as_type;
175 CONTINUE WHEN current_mp.marc_type <> rec_descriptor.item_type;
179 IF current_mp.marc_form IS NOT NULL THEN
180 CONTINUE WHEN current_mp.marc_form <> rec_descriptor.item_form;
183 IF current_mp.marc_vr_format IS NOT NULL THEN
184 CONTINUE WHEN current_mp.marc_vr_format <> rec_descriptor.vr_format;
187 IF current_mp.ref_flag IS NOT NULL THEN
188 CONTINUE WHEN current_mp.ref_flag <> item_object.ref;
191 IF current_mp.usr_age_lower_bound IS NOT NULL THEN
192 CONTINUE WHEN user_object.dob IS NULL OR current_mp.usr_age_lower_bound < age(user_object.dob);
195 IF current_mp.usr_age_upper_bound IS NOT NULL THEN
196 CONTINUE WHEN user_object.dob IS NULL OR current_mp.usr_age_upper_bound > age(user_object.dob);
200 -- everything was undefined or matched
201 matchpoint = current_mp;
203 EXIT WHEN matchpoint.id IS NOT NULL;
206 EXIT WHEN current_group.parent IS NULL OR matchpoint.id IS NOT NULL;
208 SELECT INTO current_group * FROM permission.grp_tree WHERE id = current_group.parent;
211 RETURN matchpoint.id;
213 $func$ LANGUAGE plpgsql;
216 CREATE TYPE action.matrix_test_result AS ( success BOOL, matchpoint INT, fail_part TEXT );
217 CREATE OR REPLACE FUNCTION action.item_user_circ_test( circ_ou INT, match_item BIGINT, match_user INT, renewal BOOL ) RETURNS SETOF action.matrix_test_result AS $func$
220 user_object actor.usr%ROWTYPE;
221 item_object asset.copy%ROWTYPE;
222 item_status_object config.copy_status%ROWTYPE;
223 item_location_object asset.copy_location%ROWTYPE;
224 result action.matrix_test_result;
225 circ_test config.circ_matrix_test%ROWTYPE;
226 out_by_circ_mod config.circ_matrix_circ_mod_test%ROWTYPE;
229 current_fines NUMERIC(8,2) := 0.0;
230 tmp_fines NUMERIC(8,2);
234 result.success := TRUE;
236 -- Fail if the user is BARRED
237 SELECT INTO user_object * FROM actor.usr WHERE id = match_user;
239 -- Fail if we couldn't find a set of tests
240 IF user_object.id IS NULL THEN
241 result.fail_part := 'no_user';
242 result.success := FALSE;
248 IF user_object.barred IS TRUE THEN
249 result.fail_part := 'actor.usr.barred';
250 result.success := FALSE;
255 -- Fail if the item can't circulate
256 SELECT INTO item_object * FROM asset.copy WHERE id = match_item;
257 IF item_object.circulate IS FALSE THEN
258 result.fail_part := 'asset.copy.circulate';
259 result.success := FALSE;
264 -- Fail if the item isn't in a circulateable status on a non-renewal
265 IF NOT renewal AND item_object.status NOT IN ( 0, 7, 8 ) THEN
266 result.fail_part := 'asset.copy.status';
267 result.success := FALSE;
270 ELSIF renewal AND item_object.status <> 1 THEN
271 result.fail_part := 'asset.copy.status';
272 result.success := FALSE;
277 -- Fail if the item can't circulate because of the shelving location
278 SELECT INTO item_location_object * FROM asset.copy_location WHERE id = item_object.location;
279 IF item_location_object.circulate IS FALSE THEN
280 result.fail_part := 'asset.copy_location.circulate';
281 result.success := FALSE;
286 SELECT INTO matchpoint_id action.find_circ_matrix_matchpoint(circ_ou, match_item, match_user);
287 result.matchpoint := matchpoint_id;
289 -- Fail if we couldn't find a set of tests
290 IF result.matchpoint IS NULL THEN
291 result.fail_part := 'no_matchpoint';
292 result.success := FALSE;
297 -- Fail if the test is set to hard non-circulating
298 IF circ_test.circulate IS FALSE THEN
299 result.fail_part := 'config.circ_matrix_test.circulate';
300 result.success := FALSE;
305 -- Fail if the user has too many items checked out
306 IF circ_test.max_items_out IS NOT NULL THEN
307 SELECT INTO items_out COUNT(*)
308 FROM action.circulation
309 WHERE usr = match_user
310 AND checkin_time IS NULL
311 AND (stop_fines NOT IN ('LOST','CLAIMSRETURNED','LONGOVERDUE') OR stop_fines IS NULL);
312 IF items_out >= circ_test.max_items_out THEN
313 result.fail_part := 'config.circ_matrix_test.max_items_out';
314 result.success := FALSE;
320 -- Fail if the user has too many items with specific circ_modifiers checked out
321 FOR out_by_circ_mod IN SELECT * FROM config.circ_matrix_circ_mod_test WHERE matchpoint = matchpoint_id LOOP
322 SELECT INTO items_out COUNT(*)
323 FROM action.circulation circ
324 JOIN asset.copy cp ON (cp.id = circ.target_copy)
325 WHERE circ.usr = match_user
326 AND circ.checkin_time IS NULL
327 AND (circ.stop_fines NOT IN ('LOST','CLAIMSRETURNED','LONGOVERDUE') OR circ.stop_fines IS NULL)
328 AND cp.circ_modifier = out_by_circ_mod.circ_mod;
329 IF items_out >= out_by_circ_mod.items_out THEN
330 result.fail_part := 'config.circ_matrix_circ_mod_test';
331 result.success := FALSE;
337 -- Fail if the user has too many overdue items
338 IF circ_test.max_overdue IS NOT NULL THEN
339 SELECT INTO items_overdue COUNT(*)
340 FROM action.circulation
341 WHERE usr = match_user
342 AND checkin_time IS NULL
344 AND (stop_fines NOT IN ('LOST','CLAIMSRETURNED','LONGOVERDUE') OR stop_fines IS NULL);
345 IF items_overdue >= circ_test.max_overdue THEN
346 result.fail_part := 'config.circ_matrix_test.max_overdue';
347 result.success := FALSE;
353 -- Fail if the user has a high fine balance
354 IF circ_test.max_fines IS NOT NULL THEN
355 FOR tmp_xact IN SELECT id FROM money.billable_xact WHERE usr = match_usr AND xact_finish IS NULL LOOP
356 SELECT INTO tmp_fines SUM( amount ) FROM money.billing WHERE xact = tmp_xact AND NOT voided;
357 current_fines = current_fines + COALESCE(tmp_fines, 0.0);
358 SELECT INTO tmp_fines SUM( amount ) FROM money.payment WHERE xact = tmp_xact AND NOT voided;
359 current_fines = current_fines - COALESCE(tmp_fines, 0.0);
362 IF current_fines >= circ_test.max_overdue THEN
363 result.fail_part := 'config.circ_matrix_test.max_fines';
364 result.success := FALSE;
370 -- If we passed everything, return the successful matchpoint id
377 $func$ LANGUAGE plpgsql;
379 CREATE OR REPLACE FUNCTION action.item_user_circ_test( INT, BIGINT, INT ) RETURNS SETOF action.matrix_test_result AS $func$
380 SELECT * FROM action.item_user_circ_test( $1, $2, $3, FALSE );
383 CREATE OR REPLACE FUNCTION action.item_user_renew_test( INT, BIGINT, INT ) RETURNS SETOF action.matrix_test_result AS $func$
384 SELECT * FROM action.item_user_circ_test( $1, $2, $3, TRUE );