2 * Copyright (C) 2005-2008 Equinox Software, Inc. / Georgia Public Library Service
3 * Mike Rylander <mrylander@gmail.com>
4 * Copyright (C) 2010 Laurentian University
5 * Dan Scott <dscott@laurentian.ca>
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
18 DROP SCHEMA IF EXISTS actor CASCADE;
22 COMMENT ON SCHEMA actor IS $$
23 Holds all tables pertaining to users and libraries (org units).
26 CREATE TABLE actor.usr (
27 id SERIAL PRIMARY KEY,
28 card INT UNIQUE, -- active card
29 profile INT NOT NULL, -- patron profile
30 usrname TEXT NOT NULL UNIQUE,
33 standing INT NOT NULL DEFAULT 1 REFERENCES config.standing (id) DEFERRABLE INITIALLY DEFERRED,
34 ident_type INT NOT NULL REFERENCES config.identification_type (id) DEFERRABLE INITIALLY DEFERRED,
36 ident_type2 INT REFERENCES config.identification_type (id) DEFERRABLE INITIALLY DEFERRED,
38 net_access_level INT NOT NULL DEFAULT 1 REFERENCES config.net_access_level (id) DEFERRABLE INITIALLY DEFERRED,
41 first_given_name TEXT NOT NULL,
42 second_given_name TEXT,
43 family_name TEXT NOT NULL,
47 pref_first_given_name TEXT,
48 pref_second_given_name TEXT,
49 pref_family_name TEXT,
52 name_kw_tsvector TSVECTOR,
61 active BOOL NOT NULL DEFAULT TRUE,
62 master_account BOOL NOT NULL DEFAULT FALSE,
63 super_user BOOL NOT NULL DEFAULT FALSE,
64 barred BOOL NOT NULL DEFAULT FALSE,
65 deleted BOOL NOT NULL DEFAULT FALSE,
66 juvenile BOOL NOT NULL DEFAULT FALSE,
67 usrgroup SERIAL NOT NULL,
68 claims_returned_count INT NOT NULL DEFAULT 0,
69 credit_forward_balance NUMERIC(6,2) NOT NULL DEFAULT 0.00,
70 last_xact_id TEXT NOT NULL DEFAULT 'none',
72 create_date TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT now(),
73 expire_date TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT (now() + '3 years'::INTERVAL),
74 claims_never_checked_out_count INT NOT NULL DEFAULT 0,
75 last_update_time TIMESTAMP WITH TIME ZONE
77 COMMENT ON TABLE actor.usr IS $$
80 This table contains the core User objects that describe both
81 staff members and patrons. The difference between the two
82 types of users is based on the user's permissions.
85 CREATE INDEX actor_usr_home_ou_idx ON actor.usr (home_ou);
86 CREATE INDEX actor_usr_usrgroup_idx ON actor.usr (usrgroup);
87 CREATE INDEX actor_usr_mailing_address_idx ON actor.usr (mailing_address);
88 CREATE INDEX actor_usr_billing_address_idx ON actor.usr (billing_address);
90 CREATE INDEX actor_usr_first_given_name_idx ON actor.usr (evergreen.lowercase(first_given_name));
91 CREATE INDEX actor_usr_second_given_name_idx ON actor.usr (evergreen.lowercase(second_given_name));
92 CREATE INDEX actor_usr_family_name_idx ON actor.usr (evergreen.lowercase(family_name));
93 CREATE INDEX actor_usr_first_given_name_unaccent_idx ON actor.usr (evergreen.unaccent_and_squash(first_given_name));
94 CREATE INDEX actor_usr_second_given_name_unaccent_idx ON actor.usr (evergreen.unaccent_and_squash(second_given_name));
95 CREATE INDEX actor_usr_family_name_unaccent_idx ON actor.usr (evergreen.unaccent_and_squash(family_name));
96 CREATE INDEX actor_usr_usrname_unaccent_idx ON actor.usr (evergreen.unaccent_and_squash(usrname));
97 CREATE INDEX actor_usr_guardian_idx ON actor.usr (evergreen.lowercase(guardian));
98 CREATE INDEX actor_usr_guardian_unaccent_idx ON actor.usr (evergreen.unaccent_and_squash(guardian));
100 CREATE INDEX actor_usr_pref_first_given_name_idx ON actor.usr (evergreen.lowercase(pref_first_given_name));
101 CREATE INDEX actor_usr_pref_second_given_name_idx ON actor.usr (evergreen.lowercase(pref_second_given_name));
102 CREATE INDEX actor_usr_pref_family_name_idx ON actor.usr (evergreen.lowercase(pref_family_name));
103 CREATE INDEX actor_usr_pref_first_given_name_unaccent_idx ON actor.usr (evergreen.unaccent_and_squash(pref_first_given_name));
104 CREATE INDEX actor_usr_pref_second_given_name_unaccent_idx ON actor.usr (evergreen.unaccent_and_squash(pref_second_given_name));
105 CREATE INDEX actor_usr_pref_family_name_unaccent_idx ON actor.usr (evergreen.unaccent_and_squash(pref_family_name));
107 CREATE INDEX actor_usr_usrname_idx ON actor.usr (evergreen.lowercase(usrname));
108 CREATE INDEX actor_usr_email_idx ON actor.usr (evergreen.lowercase(email));
110 CREATE INDEX actor_usr_day_phone_idx ON actor.usr (evergreen.lowercase(day_phone));
111 CREATE INDEX actor_usr_evening_phone_idx ON actor.usr (evergreen.lowercase(evening_phone));
112 CREATE INDEX actor_usr_other_phone_idx ON actor.usr (evergreen.lowercase(other_phone));
114 CREATE INDEX actor_usr_day_phone_idx_numeric ON actor.usr USING BTREE
115 (evergreen.lowercase(REGEXP_REPLACE(day_phone, '[^0-9]', '', 'g')));
117 CREATE INDEX actor_usr_evening_phone_idx_numeric ON actor.usr USING BTREE
118 (evergreen.lowercase(REGEXP_REPLACE(evening_phone, '[^0-9]', '', 'g')));
120 CREATE INDEX actor_usr_other_phone_idx_numeric ON actor.usr USING BTREE
121 (evergreen.lowercase(REGEXP_REPLACE(other_phone, '[^0-9]', '', 'g')));
123 CREATE INDEX actor_usr_ident_value_idx ON actor.usr (evergreen.lowercase(ident_value));
124 CREATE INDEX actor_usr_ident_value2_idx ON actor.usr (evergreen.lowercase(ident_value2));
126 CREATE FUNCTION actor.crypt_pw_insert () RETURNS TRIGGER AS $$
128 NEW.passwd = MD5( NEW.passwd );
133 CREATE FUNCTION actor.crypt_pw_update () RETURNS TRIGGER AS $$
135 IF NEW.passwd <> OLD.passwd THEN
136 NEW.passwd = MD5( NEW.passwd );
142 CREATE OR REPLACE FUNCTION actor.au_updated()
143 RETURNS TRIGGER AS $$
145 NEW.last_update_time := now();
150 CREATE TRIGGER au_update_trig
151 BEFORE INSERT OR UPDATE ON actor.usr
152 FOR EACH ROW EXECUTE PROCEDURE actor.au_updated();
154 CREATE TRIGGER actor_crypt_pw_update_trigger
155 BEFORE UPDATE ON actor.usr FOR EACH ROW
156 EXECUTE PROCEDURE actor.crypt_pw_update ();
158 CREATE TRIGGER actor_crypt_pw_insert_trigger
159 BEFORE INSERT ON actor.usr FOR EACH ROW
160 EXECUTE PROCEDURE actor.crypt_pw_insert ();
162 CREATE RULE protect_user_delete AS ON DELETE TO actor.usr DO INSTEAD UPDATE actor.usr SET deleted = TRUE WHERE OLD.id = actor.usr.id;
164 CREATE OR REPLACE FUNCTION actor.user_ingest_name_keywords()
165 RETURNS TRIGGER AS $func$
167 NEW.name_kw_tsvector := TO_TSVECTOR(
168 COALESCE(NEW.prefix, '') || ' ' ||
169 COALESCE(NEW.first_given_name, '') || ' ' ||
170 COALESCE(evergreen.unaccent_and_squash(NEW.first_given_name), '') || ' ' ||
171 COALESCE(NEW.second_given_name, '') || ' ' ||
172 COALESCE(evergreen.unaccent_and_squash(NEW.second_given_name), '') || ' ' ||
173 COALESCE(NEW.family_name, '') || ' ' ||
174 COALESCE(evergreen.unaccent_and_squash(NEW.family_name), '') || ' ' ||
175 COALESCE(NEW.suffix, '') || ' ' ||
176 COALESCE(NEW.pref_prefix, '') || ' ' ||
177 COALESCE(NEW.pref_first_given_name, '') || ' ' ||
178 COALESCE(evergreen.unaccent_and_squash(NEW.pref_first_given_name), '') || ' ' ||
179 COALESCE(NEW.pref_second_given_name, '') || ' ' ||
180 COALESCE(evergreen.unaccent_and_squash(NEW.pref_second_given_name), '') || ' ' ||
181 COALESCE(NEW.pref_family_name, '') || ' ' ||
182 COALESCE(evergreen.unaccent_and_squash(NEW.pref_family_name), '') || ' ' ||
183 COALESCE(NEW.pref_suffix, '') || ' ' ||
184 COALESCE(NEW.name_keywords, '')
188 $func$ LANGUAGE PLPGSQL;
190 -- Add after the batch upate above to avoid duplicate updates.
191 CREATE TRIGGER user_ingest_name_keywords_tgr
192 BEFORE INSERT OR UPDATE ON actor.usr
193 FOR EACH ROW EXECUTE PROCEDURE actor.user_ingest_name_keywords();
195 CREATE TABLE actor.usr_note (
196 id BIGSERIAL PRIMARY KEY,
197 usr BIGINT NOT NULL REFERENCES actor.usr ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
198 creator BIGINT NOT NULL REFERENCES actor.usr ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
199 create_date TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
200 pub BOOL NOT NULL DEFAULT FALSE,
204 CREATE INDEX actor_usr_note_usr_idx ON actor.usr_note (usr);
205 CREATE INDEX actor_usr_note_creator_idx ON actor.usr_note ( creator );
207 CREATE TABLE actor.usr_setting (
208 id BIGSERIAL PRIMARY KEY,
209 usr INT NOT NULL REFERENCES actor.usr ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
210 name TEXT NOT NULL REFERENCES config.usr_setting_type (name) ON DELETE CASCADE ON UPDATE CASCADE DEFERRABLE INITIALLY DEFERRED,
212 CONSTRAINT usr_once_per_key UNIQUE (usr,name)
214 COMMENT ON TABLE actor.usr_setting IS $$
217 This table contains any arbitrary settings that a client
218 program would like to save for a user.
221 CREATE INDEX actor_usr_setting_usr_idx ON actor.usr_setting (usr);
223 CREATE TABLE actor.stat_cat_sip_fields (
224 field CHAR(2) PRIMARY KEY,
226 one_only BOOL NOT NULL DEFAULT FALSE
228 COMMENT ON TABLE actor.stat_cat_sip_fields IS $$
229 Actor Statistical Category SIP Fields
231 Contains the list of valid SIP Field identifiers for
232 Statistical Categories.
235 CREATE TABLE actor.stat_cat (
236 id SERIAL PRIMARY KEY,
239 opac_visible BOOL NOT NULL DEFAULT FALSE,
240 usr_summary BOOL NOT NULL DEFAULT FALSE,
241 sip_field CHAR(2) REFERENCES actor.stat_cat_sip_fields(field) ON UPDATE CASCADE ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
243 checkout_archive BOOL NOT NULL DEFAULT FALSE,
244 required BOOL NOT NULL DEFAULT FALSE,
245 allow_freetext BOOL NOT NULL DEFAULT TRUE,
246 CONSTRAINT sc_once_per_owner UNIQUE (owner,name)
248 COMMENT ON TABLE actor.stat_cat IS $$
249 User Statistical Catagories
251 Local data collected about Users is placed into a Statistical
252 Catagory. Here's where those catagories are defined.
256 CREATE TABLE actor.stat_cat_entry (
257 id SERIAL PRIMARY KEY,
258 stat_cat INT NOT NULL,
261 CONSTRAINT sce_once_per_owner UNIQUE (stat_cat,owner,value)
263 COMMENT ON TABLE actor.stat_cat_entry IS $$
264 User Statistical Catagory Entries
266 Local data collected about Users is placed into a Statistical
267 Catagory. Each library can create entries into any of its own
268 stat_cats, its ancestors' stat_cats, or its descendants' stat_cats.
272 CREATE TABLE actor.stat_cat_entry_usr_map (
273 id BIGSERIAL PRIMARY KEY,
274 stat_cat_entry TEXT NOT NULL,
275 stat_cat INT NOT NULL,
276 target_usr INT NOT NULL,
277 CONSTRAINT sc_once_per_usr UNIQUE (target_usr,stat_cat)
279 COMMENT ON TABLE actor.stat_cat_entry_usr_map IS $$
280 Statistical Catagory Entry to User map
282 Records the stat_cat entries for each user.
285 CREATE INDEX actor_stat_cat_entry_usr_idx ON actor.stat_cat_entry_usr_map (target_usr);
287 CREATE FUNCTION actor.stat_cat_check() RETURNS trigger AS $func$
289 sipfield actor.stat_cat_sip_fields%ROWTYPE;
292 IF NEW.sip_field IS NOT NULL THEN
293 SELECT INTO sipfield * FROM actor.stat_cat_sip_fields WHERE field = NEW.sip_field;
294 IF sipfield.one_only THEN
295 SELECT INTO use_count count(id) FROM actor.stat_cat WHERE sip_field = NEW.sip_field AND id != NEW.id;
296 IF use_count > 0 THEN
297 RAISE EXCEPTION 'Sip field cannot be used twice';
303 $func$ LANGUAGE PLPGSQL;
305 CREATE TRIGGER actor_stat_cat_sip_update_trigger
306 BEFORE INSERT OR UPDATE ON actor.stat_cat FOR EACH ROW
307 EXECUTE PROCEDURE actor.stat_cat_check();
309 CREATE TABLE actor.card (
310 id SERIAL PRIMARY KEY,
311 usr INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
312 barcode TEXT NOT NULL UNIQUE,
313 active BOOL NOT NULL DEFAULT TRUE
315 COMMENT ON TABLE actor.card IS $$
318 Each User has one or more library cards. The current "main"
319 card is linked to here from the actor.usr table, and it is up
320 to the consortium policy whether more than one card can be
321 active for any one user at a given time.
324 CREATE INDEX actor_card_usr_idx ON actor.card (usr);
325 CREATE INDEX actor_card_barcode_evergreen_lowercase_idx ON actor.card (evergreen.lowercase(barcode));
327 CREATE TABLE actor.org_unit_type (
328 id SERIAL PRIMARY KEY,
330 opac_label TEXT NOT NULL,
332 parent INT REFERENCES actor.org_unit_type (id) DEFERRABLE INITIALLY DEFERRED,
333 can_have_vols BOOL NOT NULL DEFAULT TRUE,
334 can_have_users BOOL NOT NULL DEFAULT TRUE
336 CREATE INDEX actor_org_unit_type_parent_idx ON actor.org_unit_type (parent);
338 CREATE TABLE actor.org_unit (
339 id SERIAL PRIMARY KEY,
340 parent_ou INT REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
341 ou_type INT NOT NULL REFERENCES actor.org_unit_type (id) DEFERRABLE INITIALLY DEFERRED,
346 shortname TEXT NOT NULL UNIQUE,
347 name TEXT NOT NULL UNIQUE,
350 opac_visible BOOL NOT NULL DEFAULT TRUE,
351 fiscal_calendar INT NOT NULL DEFAULT 1 -- foreign key constraint to be added later
353 CREATE INDEX actor_org_unit_parent_ou_idx ON actor.org_unit (parent_ou);
354 CREATE INDEX actor_org_unit_ou_type_idx ON actor.org_unit (ou_type);
355 CREATE INDEX actor_org_unit_ill_address_idx ON actor.org_unit (ill_address);
356 CREATE INDEX actor_org_unit_billing_address_idx ON actor.org_unit (billing_address);
357 CREATE INDEX actor_org_unit_mailing_address_idx ON actor.org_unit (mailing_address);
358 CREATE INDEX actor_org_unit_holds_address_idx ON actor.org_unit (holds_address);
360 CREATE OR REPLACE FUNCTION actor.org_unit_parent_protect () RETURNS TRIGGER AS $$
362 current_aou actor.org_unit%ROWTYPE;
368 seen_ous := ARRAY[NEW.id];
370 IF (TG_OP = 'UPDATE') THEN
371 IF (NEW.parent_ou IS NOT DISTINCT FROM OLD.parent_ou) THEN
372 RETURN NEW; -- Doing an UPDATE with no change, just return it
377 IF current_aou.parent_ou IS NULL THEN -- Top of the org tree?
378 RETURN NEW; -- No loop. Carry on.
380 IF current_aou.parent_ou = ANY(seen_ous) THEN -- Parent is one we have seen?
381 RAISE 'OU LOOP: Saw % twice', current_aou.parent_ou; -- LOOP! ABORT!
384 SELECT INTO current_aou * FROM actor.org_unit WHERE id = current_aou.parent_ou;
385 seen_ous := seen_ous || current_aou.id;
386 depth_count := depth_count + 1;
387 IF depth_count = 100 THEN
388 RAISE 'OU CHECK TOO DEEP';
396 CREATE TRIGGER actor_org_unit_parent_protect_trigger
397 BEFORE INSERT OR UPDATE ON actor.org_unit FOR EACH ROW
398 EXECUTE PROCEDURE actor.org_unit_parent_protect ();
400 CREATE TABLE actor.org_lasso (
401 id SERIAL PRIMARY KEY,
405 CREATE TABLE actor.org_lasso_map (
406 id SERIAL PRIMARY KEY,
407 lasso INT NOT NULL REFERENCES actor.org_lasso (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
408 org_unit INT NOT NULL REFERENCES actor.org_unit (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED
410 CREATE UNIQUE INDEX ou_lasso_lasso_ou_idx ON actor.org_lasso_map (lasso, org_unit);
411 CREATE INDEX ou_lasso_org_unit_idx ON actor.org_lasso_map (org_unit);
413 CREATE TABLE actor.org_unit_proximity (
414 id BIGSERIAL PRIMARY KEY,
419 CREATE INDEX from_prox_idx ON actor.org_unit_proximity (from_org);
421 CREATE TABLE actor.stat_cat_entry_default (
422 id SERIAL PRIMARY KEY,
423 stat_cat_entry INT NOT NULL REFERENCES actor.stat_cat_entry(id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
424 stat_cat INT NOT NULL REFERENCES actor.stat_cat(id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
425 owner INT NOT NULL REFERENCES actor.org_unit(id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
426 CONSTRAINT sced_once_per_owner UNIQUE (stat_cat,owner)
428 COMMENT ON TABLE actor.stat_cat_entry_default IS $$
429 User Statistical Category Default Entry
431 A library may choose one of the stat_cat entries to be the
436 CREATE TABLE actor.org_unit_proximity_adjustment (
437 id SERIAL PRIMARY KEY,
438 item_circ_lib INT REFERENCES actor.org_unit (id),
439 item_owning_lib INT REFERENCES actor.org_unit (id),
440 copy_location INT, -- REFERENCES asset.copy_location (id),
441 hold_pickup_lib INT REFERENCES actor.org_unit (id),
442 hold_request_lib INT REFERENCES actor.org_unit (id),
443 pos INT NOT NULL DEFAULT 0,
444 absolute_adjustment BOOL NOT NULL DEFAULT FALSE,
445 prox_adjustment NUMERIC,
446 circ_mod TEXT, -- REFERENCES config.circ_modifier (code),
447 CONSTRAINT prox_adj_criterium CHECK (COALESCE(item_circ_lib::TEXT,item_owning_lib::TEXT,copy_location::TEXT,hold_pickup_lib::TEXT,hold_request_lib::TEXT,circ_mod) IS NOT NULL)
449 CREATE UNIQUE INDEX prox_adj_once_idx ON actor.org_unit_proximity_adjustment (
450 COALESCE(item_circ_lib, -1),
451 COALESCE(item_owning_lib, -1),
452 COALESCE(copy_location, -1),
453 COALESCE(hold_pickup_lib, -1),
454 COALESCE(hold_request_lib, -1),
455 COALESCE(circ_mod, ''),
458 CREATE INDEX prox_adj_circ_lib_idx ON actor.org_unit_proximity_adjustment (item_circ_lib);
459 CREATE INDEX prox_adj_owning_lib_idx ON actor.org_unit_proximity_adjustment (item_owning_lib);
460 CREATE INDEX prox_adj_copy_location_idx ON actor.org_unit_proximity_adjustment (copy_location);
461 CREATE INDEX prox_adj_pickup_lib_idx ON actor.org_unit_proximity_adjustment (hold_pickup_lib);
462 CREATE INDEX prox_adj_request_lib_idx ON actor.org_unit_proximity_adjustment (hold_request_lib);
463 CREATE INDEX prox_adj_circ_mod_idx ON actor.org_unit_proximity_adjustment (circ_mod);
465 CREATE TABLE actor.hours_of_operation (
466 id INT PRIMARY KEY REFERENCES actor.org_unit (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
467 dow_0_open TIME NOT NULL DEFAULT '09:00',
468 dow_0_close TIME NOT NULL DEFAULT '17:00',
469 dow_1_open TIME NOT NULL DEFAULT '09:00',
470 dow_1_close TIME NOT NULL DEFAULT '17:00',
471 dow_2_open TIME NOT NULL DEFAULT '09:00',
472 dow_2_close TIME NOT NULL DEFAULT '17:00',
473 dow_3_open TIME NOT NULL DEFAULT '09:00',
474 dow_3_close TIME NOT NULL DEFAULT '17:00',
475 dow_4_open TIME NOT NULL DEFAULT '09:00',
476 dow_4_close TIME NOT NULL DEFAULT '17:00',
477 dow_5_open TIME NOT NULL DEFAULT '09:00',
478 dow_5_close TIME NOT NULL DEFAULT '17:00',
479 dow_6_open TIME NOT NULL DEFAULT '09:00',
480 dow_6_close TIME NOT NULL DEFAULT '17:00'
482 COMMENT ON TABLE actor.hours_of_operation IS $$
483 When does this org_unit usually open and close? (Variations
484 are expressed in the actor.org_unit_closed table.)
486 COMMENT ON COLUMN actor.hours_of_operation.dow_0_open IS $$
487 When does this org_unit open on Monday?
489 COMMENT ON COLUMN actor.hours_of_operation.dow_0_close IS $$
490 When does this org_unit close on Monday?
492 COMMENT ON COLUMN actor.hours_of_operation.dow_1_open IS $$
493 When does this org_unit open on Tuesday?
495 COMMENT ON COLUMN actor.hours_of_operation.dow_1_close IS $$
496 When does this org_unit close on Tuesday?
498 COMMENT ON COLUMN actor.hours_of_operation.dow_2_open IS $$
499 When does this org_unit open on Wednesday?
501 COMMENT ON COLUMN actor.hours_of_operation.dow_2_close IS $$
502 When does this org_unit close on Wednesday?
504 COMMENT ON COLUMN actor.hours_of_operation.dow_3_open IS $$
505 When does this org_unit open on Thursday?
507 COMMENT ON COLUMN actor.hours_of_operation.dow_3_close IS $$
508 When does this org_unit close on Thursday?
510 COMMENT ON COLUMN actor.hours_of_operation.dow_4_open IS $$
511 When does this org_unit open on Friday?
513 COMMENT ON COLUMN actor.hours_of_operation.dow_4_close IS $$
514 When does this org_unit close on Friday?
516 COMMENT ON COLUMN actor.hours_of_operation.dow_5_open IS $$
517 When does this org_unit open on Saturday?
519 COMMENT ON COLUMN actor.hours_of_operation.dow_5_close IS $$
520 When does this org_unit close on Saturday?
522 COMMENT ON COLUMN actor.hours_of_operation.dow_6_open IS $$
523 When does this org_unit open on Sunday?
525 COMMENT ON COLUMN actor.hours_of_operation.dow_6_close IS $$
526 When does this org_unit close on Sunday?
529 CREATE TABLE actor.org_unit_closed (
530 id SERIAL PRIMARY KEY,
531 org_unit INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
532 close_start TIMESTAMP WITH TIME ZONE NOT NULL,
533 close_end TIMESTAMP WITH TIME ZONE NOT NULL,
534 full_day BOOLEAN NOT NULL DEFAULT FALSE,
535 multi_day BOOLEAN NOT NULL DEFAULT FALSE,
539 -- Workstation registration...
540 CREATE TABLE actor.workstation (
541 id SERIAL PRIMARY KEY,
542 name TEXT NOT NULL UNIQUE,
543 owning_lib INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED
546 CREATE TABLE actor.usr_org_unit_opt_in (
547 id SERIAL PRIMARY KEY,
548 org_unit INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
549 usr INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
550 staff INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
551 opt_in_ts TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
552 opt_in_ws INT NOT NULL REFERENCES actor.workstation (id) DEFERRABLE INITIALLY DEFERRED,
553 CONSTRAINT usr_opt_in_once_per_org_unit UNIQUE (usr,org_unit)
555 CREATE INDEX usr_org_unit_opt_in_staff_idx ON actor.usr_org_unit_opt_in ( staff );
557 CREATE TABLE actor.org_unit_setting (
558 id BIGSERIAL PRIMARY KEY,
559 org_unit INT NOT NULL REFERENCES actor.org_unit ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
560 name TEXT NOT NULL REFERENCES config.org_unit_setting_type DEFERRABLE INITIALLY DEFERRED,
562 CONSTRAINT ou_once_per_key UNIQUE (org_unit,name),
563 CONSTRAINT aous_must_be_json CHECK ( evergreen.is_json(value) )
565 COMMENT ON TABLE actor.org_unit_setting IS $$
568 This table contains any arbitrary settings that a client
569 program would like to save for an org unit.
572 CREATE INDEX actor_org_unit_setting_usr_idx ON actor.org_unit_setting (org_unit);
574 -- Log each change in oust to oustl, so admins can see what they messed up if someting stops working.
575 CREATE OR REPLACE FUNCTION ous_change_log() RETURNS TRIGGER AS $ous_change_log$
579 -- Check for which setting is being updated, and log it.
580 SELECT INTO original value FROM actor.org_unit_setting WHERE name = NEW.name AND org_unit = NEW.org_unit;
582 INSERT INTO config.org_unit_setting_type_log (org,original_value,new_value,field_name) VALUES (NEW.org_unit, original, NEW.value, NEW.name);
586 $ous_change_log$ LANGUAGE plpgsql;
588 CREATE TRIGGER log_ous_change
589 BEFORE INSERT OR UPDATE ON actor.org_unit_setting
590 FOR EACH ROW EXECUTE PROCEDURE ous_change_log();
592 CREATE OR REPLACE FUNCTION ous_delete_log() RETURNS TRIGGER AS $ous_delete_log$
596 -- Check for which setting is being updated, and log it.
597 SELECT INTO original value FROM actor.org_unit_setting WHERE name = OLD.name AND org_unit = OLD.org_unit;
599 INSERT INTO config.org_unit_setting_type_log (org,original_value,new_value,field_name) VALUES (OLD.org_unit, original, 'null', OLD.name);
603 $ous_delete_log$ LANGUAGE plpgsql;
605 CREATE TRIGGER log_ous_del
606 BEFORE DELETE ON actor.org_unit_setting
607 FOR EACH ROW EXECUTE PROCEDURE ous_delete_log();
612 CREATE TABLE actor.usr_address (
613 id SERIAL PRIMARY KEY,
614 valid BOOL NOT NULL DEFAULT TRUE,
615 within_city_limits BOOL NOT NULL DEFAULT TRUE,
616 address_type TEXT NOT NULL DEFAULT 'MAILING',
617 usr INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
618 street1 TEXT NOT NULL,
623 country TEXT NOT NULL,
624 post_code TEXT NOT NULL,
625 pending BOOL NOT NULL DEFAULT FALSE,
626 replaces INT REFERENCES actor.usr_address (id) DEFERRABLE INITIALLY DEFERRED
629 CREATE INDEX actor_usr_addr_usr_idx ON actor.usr_address (usr);
631 CREATE INDEX actor_usr_addr_street1_idx ON actor.usr_address (evergreen.lowercase(street1));
632 CREATE INDEX actor_usr_addr_street2_idx ON actor.usr_address (evergreen.lowercase(street2));
634 CREATE INDEX actor_usr_addr_city_idx ON actor.usr_address (evergreen.lowercase(city));
635 CREATE INDEX actor_usr_addr_state_idx ON actor.usr_address (evergreen.lowercase(state));
636 CREATE INDEX actor_usr_addr_post_code_idx ON actor.usr_address (evergreen.lowercase(post_code));
638 CREATE TABLE actor.usr_password_reset (
639 id SERIAL PRIMARY KEY,
641 usr BIGINT NOT NULL REFERENCES actor.usr(id) DEFERRABLE INITIALLY DEFERRED,
642 request_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
643 has_been_reset BOOL NOT NULL DEFAULT false
645 COMMENT ON TABLE actor.usr_password_reset IS $$
646 Self-serve password reset requests
648 CREATE UNIQUE INDEX actor_usr_password_reset_uuid_idx ON actor.usr_password_reset (uuid);
649 CREATE INDEX actor_usr_password_reset_usr_idx ON actor.usr_password_reset (usr);
650 CREATE INDEX actor_usr_password_reset_request_time_idx ON actor.usr_password_reset (request_time);
651 CREATE INDEX actor_usr_password_reset_has_been_reset_idx ON actor.usr_password_reset (has_been_reset);
653 CREATE TABLE actor.org_address (
654 id SERIAL PRIMARY KEY,
655 valid BOOL NOT NULL DEFAULT TRUE,
656 address_type TEXT NOT NULL DEFAULT 'MAILING',
657 org_unit INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
658 street1 TEXT NOT NULL,
663 country TEXT NOT NULL,
664 post_code TEXT NOT NULL,
668 CREATE INDEX actor_org_address_org_unit_idx ON actor.org_address (org_unit);
670 CREATE OR REPLACE FUNCTION public.first5 ( TEXT ) RETURNS TEXT AS $$
671 SELECT SUBSTRING( $1, 1, 5);
674 CREATE TABLE actor.usr_standing_penalty (
675 id SERIAL PRIMARY KEY,
676 org_unit INT NOT NULL REFERENCES actor.org_unit (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
677 usr INT NOT NULL REFERENCES actor.usr (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
678 standing_penalty INT NOT NULL REFERENCES config.standing_penalty (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
679 staff INT REFERENCES actor.usr (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
680 set_date TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
681 stop_date TIMESTAMP WITH TIME ZONE,
684 COMMENT ON TABLE actor.usr_standing_penalty IS $$
685 User standing penalties
688 CREATE INDEX actor_usr_standing_penalty_usr_idx ON actor.usr_standing_penalty (usr);
689 CREATE INDEX actor_usr_standing_penalty_staff_idx ON actor.usr_standing_penalty ( staff );
692 CREATE TABLE actor.usr_saved_search (
693 id SERIAL PRIMARY KEY,
694 owner INT NOT NULL REFERENCES actor.usr (id)
696 DEFERRABLE INITIALLY DEFERRED,
698 create_date TIMESTAMPTZ NOT NULL DEFAULT now(),
699 query_text TEXT NOT NULL,
700 query_type TEXT NOT NULL
701 CONSTRAINT valid_query_text CHECK (
702 query_type IN ( 'URL' )) DEFAULT 'URL',
703 -- we may add other types someday
705 CONSTRAINT valid_target CHECK (
706 target IN ( 'record', 'metarecord', 'callnumber' )),
707 CONSTRAINT name_once_per_user UNIQUE (owner, name)
710 CREATE TABLE actor.address_alert (
711 id SERIAL PRIMARY KEY,
712 owner INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
713 active BOOL NOT NULL DEFAULT TRUE,
714 match_all BOOL NOT NULL DEFAULT TRUE,
715 alert_message TEXT NOT NULL,
723 mailing_address BOOL NOT NULL DEFAULT FALSE,
724 billing_address BOOL NOT NULL DEFAULT FALSE
727 CREATE TABLE actor.usr_activity (
728 id BIGSERIAL PRIMARY KEY,
729 usr INT REFERENCES actor.usr (id) ON DELETE SET NULL,
730 etype INT NOT NULL REFERENCES config.usr_activity_type (id),
731 event_time TIMESTAMPTZ NOT NULL DEFAULT NOW()
733 CREATE INDEX usr_activity_usr_idx ON actor.usr_activity (usr);
735 CREATE TABLE actor.toolbar (
736 id BIGSERIAL PRIMARY KEY,
737 ws INT REFERENCES actor.workstation (id) ON DELETE CASCADE,
738 org INT REFERENCES actor.org_unit (id) ON DELETE CASCADE,
739 usr INT REFERENCES actor.usr (id) ON DELETE CASCADE,
741 layout TEXT NOT NULL,
742 CONSTRAINT only_one_type CHECK (
743 (ws IS NOT NULL AND COALESCE(org,usr) IS NULL) OR
744 (org IS NOT NULL AND COALESCE(ws,usr) IS NULL) OR
745 (usr IS NOT NULL AND COALESCE(org,ws) IS NULL)
747 CONSTRAINT layout_must_be_json CHECK ( is_json(layout) )
749 CREATE UNIQUE INDEX label_once_per_ws ON actor.toolbar (ws, label) WHERE ws IS NOT NULL;
750 CREATE UNIQUE INDEX label_once_per_org ON actor.toolbar (org, label) WHERE org IS NOT NULL;
751 CREATE UNIQUE INDEX label_once_per_usr ON actor.toolbar (usr, label) WHERE usr IS NOT NULL;
753 CREATE TYPE actor.org_unit_custom_tree_purpose AS ENUM ('opac');
754 CREATE TABLE actor.org_unit_custom_tree (
755 id SERIAL PRIMARY KEY,
756 active BOOLEAN DEFAULT FALSE,
757 purpose actor.org_unit_custom_tree_purpose NOT NULL DEFAULT 'opac' UNIQUE
760 CREATE TABLE actor.org_unit_custom_tree_node (
761 id SERIAL PRIMARY KEY,
762 tree INTEGER REFERENCES actor.org_unit_custom_tree (id) DEFERRABLE INITIALLY DEFERRED,
763 org_unit INTEGER NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
764 parent_node INTEGER REFERENCES actor.org_unit_custom_tree_node (id) DEFERRABLE INITIALLY DEFERRED,
765 sibling_order INTEGER NOT NULL DEFAULT 0,
766 CONSTRAINT aouctn_once_per_org UNIQUE (tree, org_unit)
769 CREATE TABLE actor.search_query (
770 id SERIAL PRIMARY KEY,
771 label TEXT NOT NULL, -- i18n
772 query_text TEXT NOT NULL -- QP text
775 CREATE TABLE actor.search_filter_group (
776 id SERIAL PRIMARY KEY,
777 owner INT NOT NULL REFERENCES actor.org_unit (id)
778 ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
779 code TEXT NOT NULL, -- for CGI, etc.
780 label TEXT NOT NULL, -- i18n
781 create_date TIMESTAMPTZ NOT NULL DEFAULT now(),
782 CONSTRAINT asfg_label_once_per_org UNIQUE (owner, label),
783 CONSTRAINT asfg_code_once_per_org UNIQUE (owner, code)
786 CREATE TABLE actor.search_filter_group_entry (
787 id SERIAL PRIMARY KEY,
788 grp INT NOT NULL REFERENCES actor.search_filter_group(id)
789 ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
790 pos INT NOT NULL DEFAULT 0,
791 query INT NOT NULL REFERENCES actor.search_query(id)
792 ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
793 CONSTRAINT asfge_query_once_per_group UNIQUE (grp, query)
796 CREATE TABLE actor.usr_message (
797 id SERIAL PRIMARY KEY,
798 usr INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
800 message TEXT NOT NULL,
801 create_date TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
802 deleted BOOL NOT NULL DEFAULT FALSE,
803 read_date TIMESTAMP WITH TIME ZONE,
804 sending_lib INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED
806 CREATE INDEX aum_usr ON actor.usr_message (usr);
808 CREATE RULE protect_usr_message_delete AS
809 ON DELETE TO actor.usr_message DO INSTEAD (
810 UPDATE actor.usr_message
812 WHERE OLD.id = actor.usr_message.id
815 CREATE FUNCTION actor.convert_usr_note_to_message () RETURNS TRIGGER AS $$
820 IF TG_OP = 'UPDATE' THEN
821 IF OLD.pub = TRUE THEN
826 SELECT INTO sending_ou aw.owning_lib
827 FROM auditor.get_audit_info() agai
828 JOIN actor.workstation aw ON (aw.id = agai.eg_ws);
829 IF sending_ou IS NULL THEN
830 SELECT INTO sending_ou home_ou
832 WHERE id = NEW.creator;
834 INSERT INTO actor.usr_message (usr, title, message, sending_lib)
835 VALUES (NEW.usr, NEW.title, NEW.value, sending_ou);
842 CREATE TRIGGER convert_usr_note_to_message_tgr
843 AFTER INSERT OR UPDATE ON actor.usr_note
844 FOR EACH ROW EXECUTE PROCEDURE actor.convert_usr_note_to_message();
846 -- limited view to ensure that a library user who somehow
847 -- manages to figure out how to access pcrud cannot change
848 -- the text of messages sent them
849 CREATE VIEW actor.usr_message_limited
850 AS SELECT * FROM actor.usr_message;
852 CREATE FUNCTION actor.restrict_usr_message_limited () RETURNS TRIGGER AS $$
854 IF TG_OP = 'UPDATE' THEN
855 UPDATE actor.usr_message
856 SET read_date = NEW.read_date,
857 deleted = NEW.deleted
865 CREATE TRIGGER restrict_usr_message_limited_tgr
866 INSTEAD OF UPDATE OR INSERT OR DELETE ON actor.usr_message_limited
867 FOR EACH ROW EXECUTE PROCEDURE actor.restrict_usr_message_limited();
869 CREATE TABLE actor.passwd_type (
870 code TEXT PRIMARY KEY,
871 name TEXT UNIQUE NOT NULL,
872 login BOOLEAN NOT NULL DEFAULT FALSE,
873 regex TEXT, -- pending
874 crypt_algo TEXT, -- e.g. 'bf'
876 -- gen_salt() iter count used with each new salt.
877 -- A non-NULL value for iter_count is our indication the
878 -- password is salted and encrypted via crypt()
879 iter_count INTEGER CHECK (iter_count IS NULL OR iter_count > 0)
882 CREATE TABLE actor.passwd (
883 id SERIAL PRIMARY KEY,
884 usr INTEGER NOT NULL REFERENCES actor.usr(id)
885 ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
886 salt TEXT, -- will be NULL for non-crypt'ed passwords
887 passwd TEXT NOT NULL,
888 passwd_type TEXT NOT NULL REFERENCES actor.passwd_type(code)
889 DEFERRABLE INITIALLY DEFERRED,
890 create_date TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
891 edit_date TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
892 CONSTRAINT passwd_type_once_per_user UNIQUE (usr, passwd_type)
895 CREATE OR REPLACE FUNCTION actor.create_salt(pw_type TEXT)
898 type_row actor.passwd_type%ROWTYPE;
900 /* Returns a new salt based on the passwd_type encryption settings.
901 * Returns NULL If the password type is not crypt()'ed.
904 SELECT INTO type_row * FROM actor.passwd_type WHERE code = pw_type;
907 RETURN EXCEPTION 'No such password type: %', pw_type;
910 IF type_row.iter_count IS NULL THEN
911 -- This password type is unsalted. That's OK.
915 RETURN gen_salt(type_row.crypt_algo, type_row.iter_count);
921 TODO: when a user changes their password in the application, the
922 app layer has access to the bare password. At that point, we have
923 the opportunity to store the new password without the MD5(MD5())
924 intermediate hashing. Do we care? We would need a way to indicate
925 which passwords have the legacy intermediate hashing and which don't
926 so the app layer would know whether it should perform the intermediate
927 hashing. In either event, with the exception of migrate_passwd(), the
928 DB functions know or care nothing about intermediate hashing. Every
929 password is just a value that may or may not be internally crypt'ed.
932 CREATE OR REPLACE FUNCTION actor.set_passwd(
933 pw_usr INTEGER, pw_type TEXT, new_pass TEXT, new_salt TEXT DEFAULT NULL)
934 RETURNS BOOLEAN AS $$
939 /* Sets the password value, creating a new actor.passwd row if needed.
940 * If the password type supports it, the new_pass value is crypt()'ed.
941 * For crypt'ed passwords, the salt comes from one of 3 places in order:
942 * new_salt (if present), existing salt (if present), newly created
946 IF new_salt IS NOT NULL THEN
949 pw_salt := actor.get_salt(pw_usr, pw_type);
951 IF pw_salt IS NULL THEN
952 /* We have no salt for this user + type. Assume they want a
953 * new salt. If this type is unsalted, create_salt() will
955 pw_salt := actor.create_salt(pw_type);
959 IF pw_salt IS NULL THEN
960 pw_text := new_pass; -- unsalted, use as-is.
962 pw_text := CRYPT(new_pass, pw_salt);
966 SET passwd = pw_text, salt = pw_salt, edit_date = NOW()
967 WHERE usr = pw_usr AND passwd_type = pw_type;
970 -- no password row exists for this user + type. Create one.
971 INSERT INTO actor.passwd (usr, passwd_type, salt, passwd)
972 VALUES (pw_usr, pw_type, pw_salt, pw_text);
979 CREATE OR REPLACE FUNCTION actor.get_salt(pw_usr INTEGER, pw_type TEXT)
983 type_row actor.passwd_type%ROWTYPE;
985 /* Returns the salt for the requested user + type. If the password
986 * type of "main" is requested and no password exists in actor.passwd,
987 * the user's existing password is migrated and the new salt is returned.
988 * Returns NULL if the password type is not crypt'ed (iter_count is NULL).
991 SELECT INTO pw_salt salt FROM actor.passwd
992 WHERE usr = pw_usr AND passwd_type = pw_type;
998 IF pw_type = 'main' THEN
999 -- Main password has not yet been migrated.
1000 -- Do it now and return the newly created salt.
1001 RETURN actor.migrate_passwd(pw_usr);
1004 -- We have no salt to return. actor.create_salt() needed.
1007 $$ LANGUAGE PLPGSQL;
1009 CREATE OR REPLACE FUNCTION
1010 actor.migrate_passwd(pw_usr INTEGER) RETURNS TEXT AS $$
1013 usr_row actor.usr%ROWTYPE;
1015 /* Migrates legacy actor.usr.passwd value to actor.passwd with
1016 * a password type 'main' and returns the new salt. For backwards
1017 * compatibility with existing CHAP-style API's, we perform a
1018 * layer of intermediate MD5(MD5()) hashing. This is intermediate
1019 * hashing is not required of other passwords.
1022 -- Avoid calling get_salt() here, because it may result in a
1023 -- migrate_passwd() call, creating a loop.
1024 SELECT INTO pw_salt salt FROM actor.passwd
1025 WHERE usr = pw_usr AND passwd_type = 'main';
1027 -- Only migrate passwords that have not already been migrated.
1032 SELECT INTO usr_row * FROM actor.usr WHERE id = pw_usr;
1034 pw_salt := actor.create_salt('main');
1036 PERFORM actor.set_passwd(
1037 pw_usr, 'main', MD5(pw_salt || usr_row.passwd), pw_salt);
1039 -- clear the existing password
1040 UPDATE actor.usr SET passwd = '' WHERE id = usr_row.id;
1044 $$ LANGUAGE PLPGSQL;
1046 CREATE OR REPLACE FUNCTION
1047 actor.verify_passwd(pw_usr INTEGER, pw_type TEXT, test_passwd TEXT)
1048 RETURNS BOOLEAN AS $$
1052 /* Returns TRUE if the password provided matches the in-db password.
1053 * If the password type is salted, we compare the output of CRYPT().
1054 * NOTE: test_passwd is MD5(salt || MD5(password)) for legacy
1058 SELECT INTO pw_salt salt FROM actor.passwd
1059 WHERE usr = pw_usr AND passwd_type = pw_type;
1066 IF pw_salt IS NULL THEN
1067 -- Password is unsalted, compare the un-CRYPT'ed values.
1069 SELECT TRUE FROM actor.passwd WHERE
1071 passwd_type = pw_type AND
1072 passwd = test_passwd
1077 SELECT TRUE FROM actor.passwd WHERE
1079 passwd_type = pw_type AND
1080 passwd = CRYPT(test_passwd, pw_salt)
1083 $$ STRICT LANGUAGE PLPGSQL;
1085 -- Remove all activity entries by activity type,
1086 -- except the most recent entry per user.
1087 CREATE OR REPLACE FUNCTION
1088 actor.purge_usr_activity_by_type(act_type INTEGER)
1093 FOR cur_usr IN SELECT DISTINCT(usr)
1094 FROM actor.usr_activity WHERE etype = act_type LOOP
1095 DELETE FROM actor.usr_activity WHERE id IN (
1097 FROM actor.usr_activity
1098 WHERE usr = cur_usr AND etype = act_type
1099 ORDER BY event_time DESC OFFSET 1
1103 END $$ LANGUAGE PLPGSQL;
1105 CREATE TABLE actor.workstation_setting (
1106 id SERIAL PRIMARY KEY,
1107 workstation INT NOT NULL REFERENCES actor.workstation (id)
1108 ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
1109 name TEXT NOT NULL REFERENCES config.workstation_setting_type (name)
1110 ON DELETE CASCADE ON UPDATE CASCADE DEFERRABLE INITIALLY DEFERRED,
1111 value JSON NOT NULL,
1112 CONSTRAINT ws_once_per_key UNIQUE (workstation, name)
1115 CREATE INDEX actor_workstation_setting_workstation_idx
1116 ON actor.workstation_setting (workstation);
1118 CREATE TYPE actor.cascade_setting_summary AS (
1121 has_org_setting BOOLEAN,
1122 has_user_setting BOOLEAN,
1123 has_workstation_setting BOOLEAN
1126 CREATE OR REPLACE FUNCTION actor.get_cascade_setting(
1127 setting_name TEXT, org_id INT, user_id INT, workstation_id INT)
1128 RETURNS actor.cascade_setting_summary AS
1132 summary actor.cascade_setting_summary;
1133 org_setting_type config.org_unit_setting_type%ROWTYPE;
1136 summary.name := setting_name;
1138 -- Collect the org setting type status first in case we exit early.
1139 -- The existance of an org setting type is not considered
1140 -- privileged information.
1141 SELECT INTO org_setting_type *
1142 FROM config.org_unit_setting_type WHERE name = setting_name;
1144 summary.has_org_setting := TRUE;
1146 summary.has_org_setting := FALSE;
1149 -- User and workstation settings have the same priority.
1150 -- Start with user settings since that's the simplest code path.
1151 -- The workstation_id is ignored if no user_id is provided.
1152 IF user_id IS NOT NULL THEN
1154 SELECT INTO summary.value value FROM actor.usr_setting
1155 WHERE usr = user_id AND name = setting_name;
1158 -- if we have a value, we have a setting type
1159 summary.has_user_setting := TRUE;
1161 IF workstation_id IS NOT NULL THEN
1162 -- Only inform the caller about the workstation
1163 -- setting type disposition when a workstation id is
1164 -- provided. Otherwise, it's NULL to indicate UNKNOWN.
1165 summary.has_workstation_setting := FALSE;
1171 -- no user setting value, but a setting type may exist
1172 SELECT INTO summary.has_user_setting EXISTS (
1173 SELECT TRUE FROM config.usr_setting_type
1174 WHERE name = setting_name
1177 IF workstation_id IS NOT NULL THEN
1179 IF NOT summary.has_user_setting THEN
1180 -- A workstation setting type may only exist when a user
1181 -- setting type does not.
1183 SELECT INTO summary.value value
1184 FROM actor.workstation_setting
1185 WHERE workstation = workstation_id AND name = setting_name;
1188 -- if we have a value, we have a setting type
1189 summary.has_workstation_setting := TRUE;
1193 -- no value, but a setting type may exist
1194 SELECT INTO summary.has_workstation_setting EXISTS (
1195 SELECT TRUE FROM config.workstation_setting_type
1196 WHERE name = setting_name
1200 -- Finally make use of the workstation to determine the org
1201 -- unit if none is provided.
1202 IF org_id IS NULL AND summary.has_org_setting THEN
1203 SELECT INTO org_id owning_lib
1204 FROM actor.workstation WHERE id = workstation_id;
1209 -- Some org unit settings are protected by a view permission.
1210 -- First see if we have any data that needs protecting, then
1211 -- check the permission if needed.
1213 IF NOT summary.has_org_setting THEN
1217 -- avoid putting the value into the summary until we confirm
1218 -- the value should be visible to the caller.
1219 SELECT INTO setting_value value
1220 FROM actor.org_unit_ancestor_setting(setting_name, org_id);
1223 -- No value found -- perm check is irrelevant.
1227 IF org_setting_type.view_perm IS NOT NULL THEN
1229 IF user_id IS NULL THEN
1230 RAISE NOTICE 'Perm check required but no user_id provided';
1234 IF NOT permission.usr_has_perm(
1235 user_id, (SELECT code FROM permission.perm_list
1236 WHERE id = org_setting_type.view_perm), org_id)
1238 RAISE NOTICE 'Perm check failed for user % on %',
1239 user_id, org_setting_type.view_perm;
1244 -- Perm check succeeded or was not necessary.
1245 summary.value := setting_value;
1248 $FUNC$ LANGUAGE PLPGSQL;
1251 CREATE OR REPLACE FUNCTION actor.get_cascade_setting_batch(
1252 setting_names TEXT[], org_id INT, user_id INT, workstation_id INT)
1253 RETURNS SETOF actor.cascade_setting_summary AS
1255 -- Returns a row per setting matching the setting name order. If no
1256 -- value is applied, NULL is returned to retain name-response ordering.
1259 summary actor.cascade_setting_summary;
1261 FOREACH setting_name IN ARRAY setting_names LOOP
1262 SELECT INTO summary * FROM actor.get_cascade_setting(
1263 setting_Name, org_id, user_id, workstation_id);
1264 RETURN NEXT summary;
1267 $FUNC$ LANGUAGE PLPGSQL;
1269 CREATE TABLE actor.usr_privacy_waiver (
1270 id BIGSERIAL PRIMARY KEY,
1271 usr BIGINT NOT NULL REFERENCES actor.usr(id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
1273 place_holds BOOL DEFAULT FALSE,
1274 pickup_holds BOOL DEFAULT FALSE,
1275 view_history BOOL DEFAULT FALSE,
1276 checkout_items BOOL DEFAULT FALSE
1278 CREATE INDEX actor_usr_privacy_waiver_usr_idx ON actor.usr_privacy_waiver (usr);