2 * Copyright (C) 2004-2008 Georgia Public Library Service
3 * Copyright (C) 2007-2008 Equinox Software, Inc.
4 * Mike Rylander <miker@esilibrary.com>
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
18 DROP SCHEMA IF EXISTS action CASCADE;
24 CREATE TABLE action.in_house_use (
25 id SERIAL PRIMARY KEY,
26 item BIGINT NOT NULL, -- REFERENCES asset.copy (id) DEFERRABLE INITIALLY DEFERRED, -- XXX could be an serial.issuance
27 staff INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
28 org_unit INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
29 use_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
31 CREATE INDEX action_in_house_use_staff_idx ON action.in_house_use ( staff );
33 CREATE TABLE action.non_cataloged_circulation (
34 id SERIAL PRIMARY KEY,
35 patron INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
36 staff INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
37 circ_lib INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
38 item_type INT NOT NULL REFERENCES config.non_cataloged_type (id) DEFERRABLE INITIALLY DEFERRED,
39 circ_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
41 CREATE INDEX action_non_cat_circ_patron_idx ON action.non_cataloged_circulation ( patron );
42 CREATE INDEX action_non_cat_circ_staff_idx ON action.non_cataloged_circulation ( staff );
44 CREATE TABLE action.non_cat_in_house_use (
45 id SERIAL PRIMARY KEY,
46 item_type BIGINT NOT NULL REFERENCES config.non_cataloged_type(id) DEFERRABLE INITIALLY DEFERRED,
47 staff INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
48 org_unit INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
49 use_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
51 CREATE INDEX non_cat_in_house_use_staff_idx ON action.non_cat_in_house_use ( staff );
53 CREATE TABLE action.survey (
54 id SERIAL PRIMARY KEY,
55 owner INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
56 start_date TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
57 end_date TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW() + '10 years'::INTERVAL,
58 usr_summary BOOL NOT NULL DEFAULT FALSE,
59 opac BOOL NOT NULL DEFAULT FALSE,
60 poll BOOL NOT NULL DEFAULT FALSE,
61 required BOOL NOT NULL DEFAULT FALSE,
63 description TEXT NOT NULL
65 CREATE UNIQUE INDEX asv_once_per_owner_idx ON action.survey (owner,name);
67 CREATE TABLE action.survey_question (
68 id SERIAL PRIMARY KEY,
69 survey INT NOT NULL REFERENCES action.survey DEFERRABLE INITIALLY DEFERRED,
70 question TEXT NOT NULL
73 CREATE TABLE action.survey_answer (
74 id SERIAL PRIMARY KEY,
75 question INT NOT NULL REFERENCES action.survey_question DEFERRABLE INITIALLY DEFERRED,
79 CREATE SEQUENCE action.survey_response_group_id_seq;
81 CREATE TABLE action.survey_response (
82 id BIGSERIAL PRIMARY KEY,
83 response_group_id INT,
84 usr INT, -- REFERENCES actor.usr
85 survey INT NOT NULL REFERENCES action.survey DEFERRABLE INITIALLY DEFERRED,
86 question INT NOT NULL REFERENCES action.survey_question DEFERRABLE INITIALLY DEFERRED,
87 answer INT NOT NULL REFERENCES action.survey_answer DEFERRABLE INITIALLY DEFERRED,
88 answer_date TIMESTAMP WITH TIME ZONE,
89 effective_date TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
91 CREATE INDEX action_survey_response_usr_idx ON action.survey_response ( usr );
93 CREATE OR REPLACE FUNCTION action.survey_response_answer_date_fixup () RETURNS TRIGGER AS '
95 NEW.answer_date := NOW();
99 CREATE TRIGGER action_survey_response_answer_date_fixup_tgr
100 BEFORE INSERT ON action.survey_response
102 EXECUTE PROCEDURE action.survey_response_answer_date_fixup ();
104 CREATE TABLE action.archive_actor_stat_cat (
105 id BIGSERIAL PRIMARY KEY,
106 xact BIGINT NOT NULL, -- action.circulation (+aged/all)
107 stat_cat INT NOT NULL,
111 CREATE TABLE action.archive_asset_stat_cat (
112 id BIGSERIAL PRIMARY KEY,
113 xact BIGINT NOT NULL, -- action.circulation (+aged/all)
114 stat_cat INT NOT NULL,
119 CREATE TABLE action.circulation (
120 target_copy BIGINT NOT NULL, -- asset.copy.id
121 circ_lib INT NOT NULL, -- actor.org_unit.id
122 circ_staff INT NOT NULL, -- actor.usr.id
123 checkin_staff INT, -- actor.usr.id
124 checkin_lib INT, -- actor.org_unit.id
125 renewal_remaining INT NOT NULL, -- derived from "circ duration" rule
126 grace_period INTERVAL NOT NULL, -- derived from "circ fine" rule
127 due_date TIMESTAMP WITH TIME ZONE,
128 stop_fines_time TIMESTAMP WITH TIME ZONE,
129 checkin_time TIMESTAMP WITH TIME ZONE,
130 create_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
131 duration INTERVAL, -- derived from "circ duration" rule
132 fine_interval INTERVAL NOT NULL DEFAULT '1 day'::INTERVAL, -- derived from "circ fine" rule
133 recurring_fine NUMERIC(6,2), -- derived from "circ fine" rule
134 max_fine NUMERIC(6,2), -- derived from "max fine" rule
135 phone_renewal BOOL NOT NULL DEFAULT FALSE,
136 desk_renewal BOOL NOT NULL DEFAULT FALSE,
137 opac_renewal BOOL NOT NULL DEFAULT FALSE,
138 duration_rule TEXT NOT NULL, -- name of "circ duration" rule
139 recurring_fine_rule TEXT NOT NULL, -- name of "circ fine" rule
140 max_fine_rule TEXT NOT NULL, -- name of "max fine" rule
141 stop_fines TEXT CHECK (stop_fines IN (
142 'CHECKIN','CLAIMSRETURNED','LOST','MAXFINES','RENEW','LONGOVERDUE','CLAIMSNEVERCHECKEDOUT')),
143 workstation INT REFERENCES actor.workstation(id)
145 DEFERRABLE INITIALLY DEFERRED,
146 checkin_workstation INT REFERENCES actor.workstation(id)
148 DEFERRABLE INITIALLY DEFERRED,
149 copy_location INT NOT NULL DEFAULT 1 REFERENCES asset.copy_location (id) DEFERRABLE INITIALLY DEFERRED,
150 checkin_scan_time TIMESTAMP WITH TIME ZONE,
151 auto_renewal BOOLEAN,
152 auto_renewal_remaining INTEGER
153 ) INHERITS (money.billable_xact);
154 ALTER TABLE action.circulation ADD PRIMARY KEY (id);
155 ALTER TABLE action.circulation
156 ADD COLUMN parent_circ BIGINT
157 REFERENCES action.circulation( id )
158 DEFERRABLE INITIALLY DEFERRED;
159 CREATE INDEX circ_open_xacts_idx ON action.circulation (usr) WHERE xact_finish IS NULL;
160 CREATE INDEX circ_outstanding_idx ON action.circulation (usr) WHERE checkin_time IS NULL;
161 CREATE INDEX circ_checkin_time ON "action".circulation (checkin_time) WHERE checkin_time IS NOT NULL;
162 CREATE INDEX circ_circ_lib_idx ON "action".circulation (circ_lib);
163 CREATE INDEX circ_open_date_idx ON "action".circulation (xact_start) WHERE xact_finish IS NULL;
164 CREATE INDEX circ_all_usr_idx ON action.circulation ( usr );
165 CREATE INDEX circ_circ_staff_idx ON action.circulation ( circ_staff );
166 CREATE INDEX circ_checkin_staff_idx ON action.circulation ( checkin_staff );
167 CREATE INDEX action_circulation_target_copy_idx ON action.circulation (target_copy);
168 CREATE UNIQUE INDEX circ_parent_idx ON action.circulation ( parent_circ ) WHERE parent_circ IS NOT NULL;
169 CREATE UNIQUE INDEX only_one_concurrent_checkout_per_copy ON action.circulation(target_copy) WHERE checkin_time IS NULL;
171 CREATE TRIGGER action_circulation_target_copy_trig AFTER INSERT OR UPDATE ON action.circulation FOR EACH ROW EXECUTE PROCEDURE evergreen.fake_fkey_tgr('target_copy');
173 CREATE TRIGGER mat_summary_create_tgr AFTER INSERT ON action.circulation FOR EACH ROW EXECUTE PROCEDURE money.mat_summary_create ('circulation');
174 CREATE TRIGGER mat_summary_change_tgr AFTER UPDATE ON action.circulation FOR EACH ROW EXECUTE PROCEDURE money.mat_summary_update ();
175 CREATE TRIGGER mat_summary_remove_tgr AFTER DELETE ON action.circulation FOR EACH ROW EXECUTE PROCEDURE money.mat_summary_delete ();
177 CREATE OR REPLACE FUNCTION action.push_circ_due_time () RETURNS TRIGGER AS $$
179 proper_tz TEXT := COALESCE(
182 FROM actor.org_unit_ancestor_setting('lib.timezone',NEW.circ_lib)
185 CURRENT_SETTING('timezone')
189 IF (EXTRACT(EPOCH FROM NEW.duration)::INT % EXTRACT(EPOCH FROM '1 day'::INTERVAL)::INT) = 0 -- day-granular duration
190 AND SUBSTRING((NEW.due_date AT TIME ZONE proper_tz)::TIME::TEXT FROM 1 FOR 8) <> '23:59:59' THEN -- has not yet been pushed
191 NEW.due_date = ((NEW.due_date AT TIME ZONE proper_tz)::DATE + '1 day'::INTERVAL - '1 second'::INTERVAL) || ' ' || proper_tz;
198 CREATE TRIGGER push_due_date_tgr BEFORE INSERT OR UPDATE ON action.circulation FOR EACH ROW EXECUTE PROCEDURE action.push_circ_due_time();
200 CREATE OR REPLACE FUNCTION action.fill_circ_copy_location () RETURNS TRIGGER AS $$
202 SELECT INTO NEW.copy_location location FROM asset.copy WHERE id = NEW.target_copy;
207 CREATE TRIGGER fill_circ_copy_location_tgr BEFORE INSERT ON action.circulation FOR EACH ROW EXECUTE PROCEDURE action.fill_circ_copy_location();
209 CREATE OR REPLACE FUNCTION action.archive_stat_cats () RETURNS TRIGGER AS $$
211 INSERT INTO action.archive_actor_stat_cat(xact, stat_cat, value)
212 SELECT NEW.id, asceum.stat_cat, asceum.stat_cat_entry
213 FROM actor.stat_cat_entry_usr_map asceum
214 JOIN actor.stat_cat sc ON asceum.stat_cat = sc.id
215 WHERE NEW.usr = asceum.target_usr AND sc.checkout_archive;
216 INSERT INTO action.archive_asset_stat_cat(xact, stat_cat, value)
217 SELECT NEW.id, ascecm.stat_cat, asce.value
218 FROM asset.stat_cat_entry_copy_map ascecm
219 JOIN asset.stat_cat sc ON ascecm.stat_cat = sc.id
220 JOIN asset.stat_cat_entry asce ON ascecm.stat_cat_entry = asce.id
221 WHERE NEW.target_copy = ascecm.owning_copy AND sc.checkout_archive;
226 CREATE TRIGGER archive_stat_cats_tgr AFTER INSERT ON action.circulation FOR EACH ROW EXECUTE PROCEDURE action.archive_stat_cats();
228 CREATE TABLE action.aged_circulation (
230 usr_home_ou INT NOT NULL,
231 usr_profile INT NOT NULL,
233 copy_call_number INT NOT NULL,
234 copy_owning_lib INT NOT NULL,
235 copy_circ_lib INT NOT NULL,
236 copy_bib_record BIGINT NOT NULL,
237 LIKE action.circulation
240 ALTER TABLE action.aged_circulation ADD PRIMARY KEY (id);
241 ALTER TABLE action.aged_circulation DROP COLUMN usr;
242 CREATE INDEX aged_circ_circ_lib_idx ON "action".aged_circulation (circ_lib);
243 CREATE INDEX aged_circ_start_idx ON "action".aged_circulation (xact_start);
244 CREATE INDEX aged_circ_copy_circ_lib_idx ON "action".aged_circulation (copy_circ_lib);
245 CREATE INDEX aged_circ_copy_owning_lib_idx ON "action".aged_circulation (copy_owning_lib);
246 CREATE INDEX aged_circ_copy_location_idx ON "action".aged_circulation (copy_location);
247 CREATE INDEX action_aged_circulation_target_copy_idx ON action.aged_circulation (target_copy);
248 CREATE INDEX action_aged_circulation_parent_circ_idx ON action.aged_circulation (parent_circ);
250 CREATE OR REPLACE VIEW action.all_circulation AS
251 SELECT id,usr_post_code, usr_home_ou, usr_profile, usr_birth_year, copy_call_number, copy_location,
252 copy_owning_lib, copy_circ_lib, copy_bib_record, xact_start, xact_finish, target_copy,
253 circ_lib, circ_staff, checkin_staff, checkin_lib, renewal_remaining, grace_period, due_date,
254 stop_fines_time, checkin_time, create_time, duration, fine_interval, recurring_fine,
255 max_fine, phone_renewal, desk_renewal, opac_renewal, duration_rule, recurring_fine_rule,
256 max_fine_rule, stop_fines, workstation, checkin_workstation, checkin_scan_time, parent_circ,
257 auto_renewal, auto_renewal_remaining,
259 FROM action.aged_circulation
261 SELECT DISTINCT circ.id,COALESCE(a.post_code,b.post_code) AS usr_post_code, p.home_ou AS usr_home_ou, p.profile AS usr_profile, EXTRACT(YEAR FROM p.dob)::INT AS usr_birth_year,
262 cp.call_number AS copy_call_number, circ.copy_location, cn.owning_lib AS copy_owning_lib, cp.circ_lib AS copy_circ_lib,
263 cn.record AS copy_bib_record, circ.xact_start, circ.xact_finish, circ.target_copy, circ.circ_lib, circ.circ_staff, circ.checkin_staff,
264 circ.checkin_lib, circ.renewal_remaining, circ.grace_period, circ.due_date, circ.stop_fines_time, circ.checkin_time, circ.create_time, circ.duration,
265 circ.fine_interval, circ.recurring_fine, circ.max_fine, circ.phone_renewal, circ.desk_renewal, circ.opac_renewal, circ.duration_rule,
266 circ.recurring_fine_rule, circ.max_fine_rule, circ.stop_fines, circ.workstation, circ.checkin_workstation, circ.checkin_scan_time,
267 circ.parent_circ, circ.auto_renewal, circ.auto_renewal_remaining, circ.usr
268 FROM action.circulation circ
269 JOIN asset.copy cp ON (circ.target_copy = cp.id)
270 JOIN asset.call_number cn ON (cp.call_number = cn.id)
271 JOIN actor.usr p ON (circ.usr = p.id)
272 LEFT JOIN actor.usr_address a ON (p.mailing_address = a.id)
273 LEFT JOIN actor.usr_address b ON (p.billing_address = b.id);
275 CREATE OR REPLACE VIEW action.all_circulation_slim AS
276 SELECT * FROM action.circulation
311 auto_renewal_remaining,
313 FROM action.aged_circulation
318 CREATE OR REPLACE FUNCTION action.age_circ_on_delete () RETURNS TRIGGER AS $$
323 -- If there are any renewals for this circulation, don't archive or delete
324 -- it yet. We'll do so later, when we archive and delete the renewals.
326 SELECT 'Y' INTO found
327 FROM action.circulation
328 WHERE parent_circ = OLD.id
332 RETURN NULL; -- don't delete
335 -- Archive a copy of the old row to action.aged_circulation
337 INSERT INTO action.aged_circulation
338 (id,usr_post_code, usr_home_ou, usr_profile, usr_birth_year, copy_call_number, copy_location,
339 copy_owning_lib, copy_circ_lib, copy_bib_record, xact_start, xact_finish, target_copy,
340 circ_lib, circ_staff, checkin_staff, checkin_lib, renewal_remaining, grace_period, due_date,
341 stop_fines_time, checkin_time, create_time, duration, fine_interval, recurring_fine,
342 max_fine, phone_renewal, desk_renewal, opac_renewal, duration_rule, recurring_fine_rule,
343 max_fine_rule, stop_fines, workstation, checkin_workstation, checkin_scan_time, parent_circ)
345 id,usr_post_code, usr_home_ou, usr_profile, usr_birth_year, copy_call_number, copy_location,
346 copy_owning_lib, copy_circ_lib, copy_bib_record, xact_start, xact_finish, target_copy,
347 circ_lib, circ_staff, checkin_staff, checkin_lib, renewal_remaining, grace_period, due_date,
348 stop_fines_time, checkin_time, create_time, duration, fine_interval, recurring_fine,
349 max_fine, phone_renewal, desk_renewal, opac_renewal, duration_rule, recurring_fine_rule,
350 max_fine_rule, stop_fines, workstation, checkin_workstation, checkin_scan_time, parent_circ
351 FROM action.all_circulation WHERE id = OLD.id;
355 $$ LANGUAGE 'plpgsql';
357 CREATE TRIGGER action_circulation_aging_tgr
358 BEFORE DELETE ON action.circulation
360 EXECUTE PROCEDURE action.age_circ_on_delete ();
363 CREATE OR REPLACE FUNCTION action.age_parent_circ_on_delete () RETURNS TRIGGER AS $$
366 -- Having deleted a renewal, we can delete the original circulation (or a previous
367 -- renewal, if that's what parent_circ is pointing to). That deletion will trigger
368 -- deletion of any prior parents, etc. recursively.
370 IF OLD.parent_circ IS NOT NULL THEN
371 DELETE FROM action.circulation
372 WHERE id = OLD.parent_circ;
377 $$ LANGUAGE 'plpgsql';
379 CREATE TRIGGER age_parent_circ
380 AFTER DELETE ON action.circulation
382 EXECUTE PROCEDURE action.age_parent_circ_on_delete ();
385 CREATE OR REPLACE VIEW action.open_circulation AS
387 FROM action.circulation
388 WHERE checkin_time IS NULL
392 CREATE OR REPLACE VIEW action.billable_circulations AS
394 FROM action.circulation
395 WHERE xact_finish IS NULL;
397 CREATE OR REPLACE FUNCTION action.circulation_claims_returned () RETURNS TRIGGER AS $$
399 IF OLD.stop_fines IS NULL OR OLD.stop_fines <> NEW.stop_fines THEN
400 IF NEW.stop_fines = 'CLAIMSRETURNED' THEN
401 UPDATE actor.usr SET claims_returned_count = claims_returned_count + 1 WHERE id = NEW.usr;
403 IF NEW.stop_fines = 'CLAIMSNEVERCHECKEDOUT' THEN
404 UPDATE actor.usr SET claims_never_checked_out_count = claims_never_checked_out_count + 1 WHERE id = NEW.usr;
406 IF NEW.stop_fines = 'LOST' THEN
407 UPDATE asset.copy SET status = 3 WHERE id = NEW.target_copy;
412 $$ LANGUAGE 'plpgsql';
413 CREATE TRIGGER action_circulation_stop_fines_tgr
414 BEFORE UPDATE ON action.circulation
416 EXECUTE PROCEDURE action.circulation_claims_returned ();
418 CREATE TABLE action.hold_request_cancel_cause (
419 id SERIAL PRIMARY KEY,
423 CREATE TABLE action.hold_request (
424 id SERIAL PRIMARY KEY,
425 request_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
426 capture_time TIMESTAMP WITH TIME ZONE,
427 fulfillment_time TIMESTAMP WITH TIME ZONE,
428 checkin_time TIMESTAMP WITH TIME ZONE,
429 return_time TIMESTAMP WITH TIME ZONE,
430 prev_check_time TIMESTAMP WITH TIME ZONE,
431 expire_time TIMESTAMP WITH TIME ZONE,
432 cancel_time TIMESTAMP WITH TIME ZONE,
433 cancel_cause INT REFERENCES action.hold_request_cancel_cause (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
435 target BIGINT NOT NULL, -- see hold_type
436 current_copy BIGINT, -- REFERENCES asset.copy (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED, -- XXX could be an serial.unit now...
437 fulfillment_staff INT REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
438 fulfillment_lib INT REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
439 request_lib INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
440 requestor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
441 usr INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
442 selection_ou INT NOT NULL,
443 selection_depth INT NOT NULL DEFAULT 0,
444 pickup_lib INT NOT NULL REFERENCES actor.org_unit DEFERRABLE INITIALLY DEFERRED,
445 hold_type TEXT NOT NULL, -- CHECK (hold_type IN ('M','T','V','C')), -- XXX constraint too constraining...
446 holdable_formats TEXT,
448 email_notify BOOL NOT NULL DEFAULT FALSE,
450 sms_carrier INT REFERENCES config.sms_carrier (id),
451 frozen BOOL NOT NULL DEFAULT FALSE,
452 thaw_date TIMESTAMP WITH TIME ZONE,
453 shelf_time TIMESTAMP WITH TIME ZONE,
455 mint_condition BOOL NOT NULL DEFAULT TRUE,
456 shelf_expire_time TIMESTAMPTZ,
457 current_shelf_lib INT REFERENCES actor.org_unit DEFERRABLE INITIALLY DEFERRED,
458 behind_desk BOOLEAN NOT NULL DEFAULT FALSE
460 ALTER TABLE action.hold_request ADD CONSTRAINT sms_check CHECK (
462 OR sms_carrier IS NOT NULL -- and implied sms_notify IS NOT NULL
466 CREATE OR REPLACE FUNCTION action.hold_request_clear_map () RETURNS TRIGGER AS $$
468 DELETE FROM action.hold_copy_map WHERE hold = NEW.id;
473 CREATE TRIGGER hold_request_clear_map_tgr
474 AFTER UPDATE ON action.hold_request
477 (NEW.cancel_time IS NOT NULL AND OLD.cancel_time IS NULL)
478 OR (NEW.fulfillment_time IS NOT NULL AND OLD.fulfillment_time IS NULL)
480 EXECUTE PROCEDURE action.hold_request_clear_map();
482 CREATE INDEX hold_request_target_idx ON action.hold_request (target);
483 CREATE INDEX hold_request_usr_idx ON action.hold_request (usr);
484 CREATE INDEX hold_request_pickup_lib_idx ON action.hold_request (pickup_lib);
485 CREATE INDEX hold_request_current_copy_idx ON action.hold_request (current_copy);
486 CREATE INDEX hold_request_prev_check_time_idx ON action.hold_request (prev_check_time);
487 CREATE INDEX hold_request_fulfillment_staff_idx ON action.hold_request ( fulfillment_staff );
488 CREATE INDEX hold_request_requestor_idx ON action.hold_request ( requestor );
489 CREATE INDEX hold_request_open_idx ON action.hold_request (id) WHERE cancel_time IS NULL AND fulfillment_time IS NULL;
490 CREATE INDEX hold_request_current_copy_before_cap_idx ON action.hold_request (current_copy) WHERE capture_time IS NULL AND cancel_time IS NULL;
491 CREATE UNIQUE INDEX hold_request_capture_protect_idx ON action.hold_request (current_copy) WHERE current_copy IS NOT NULL AND capture_time IS NOT NULL AND cancel_time IS NULL AND fulfillment_time IS NULL;
492 CREATE INDEX hold_request_copy_capture_time_idx ON action.hold_request (current_copy,capture_time);
493 CREATE INDEX hold_request_open_captured_shelf_lib_idx ON action.hold_request (current_shelf_lib) WHERE capture_time IS NOT NULL AND fulfillment_time IS NULL AND (pickup_lib <> current_shelf_lib);
494 CREATE INDEX hold_fulfillment_time_idx ON action.hold_request (fulfillment_time) WHERE fulfillment_time IS NOT NULL;
495 CREATE INDEX hold_request_time_idx ON action.hold_request (request_time);
498 CREATE TABLE action.hold_request_note (
500 id BIGSERIAL PRIMARY KEY,
501 hold BIGINT NOT NULL REFERENCES action.hold_request (id)
503 DEFERRABLE INITIALLY DEFERRED,
506 slip BOOL NOT NULL DEFAULT FALSE,
507 pub BOOL NOT NULL DEFAULT FALSE,
508 staff BOOL NOT NULL DEFAULT FALSE -- created by staff
511 CREATE INDEX ahrn_hold_idx ON action.hold_request_note (hold);
514 CREATE TABLE action.hold_notification (
515 id SERIAL PRIMARY KEY,
516 hold INT NOT NULL REFERENCES action.hold_request (id)
518 DEFERRABLE INITIALLY DEFERRED,
519 notify_staff INT REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
520 notify_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
521 method TEXT NOT NULL, -- email address or phone number
524 CREATE INDEX ahn_hold_idx ON action.hold_notification (hold);
525 CREATE INDEX ahn_notify_staff_idx ON action.hold_notification ( notify_staff );
527 CREATE TABLE action.hold_copy_map (
528 id BIGSERIAL PRIMARY KEY,
529 hold INT NOT NULL REFERENCES action.hold_request (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
530 target_copy BIGINT NOT NULL, -- REFERENCES asset.copy (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED, -- XXX could be an serial.issuance
532 CONSTRAINT copy_once_per_hold UNIQUE (hold,target_copy)
534 -- CREATE INDEX acm_hold_idx ON action.hold_copy_map (hold);
535 CREATE INDEX acm_copy_idx ON action.hold_copy_map (target_copy);
537 CREATE OR REPLACE FUNCTION
538 action.hold_request_regen_copy_maps(
539 hold_id INTEGER, copy_ids INTEGER[]) RETURNS VOID AS $$
540 DELETE FROM action.hold_copy_map WHERE hold = $1;
541 INSERT INTO action.hold_copy_map (hold, target_copy) SELECT $1, UNNEST($2);
544 CREATE TABLE action.transit_copy (
545 id SERIAL PRIMARY KEY,
546 source_send_time TIMESTAMP WITH TIME ZONE,
547 dest_recv_time TIMESTAMP WITH TIME ZONE,
548 target_copy BIGINT NOT NULL, -- REFERENCES asset.copy (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED, -- XXX could be an serial.issuance
549 source INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
550 dest INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
551 prev_hop INT REFERENCES action.transit_copy (id) DEFERRABLE INITIALLY DEFERRED,
552 copy_status INT NOT NULL REFERENCES config.copy_status (id) DEFERRABLE INITIALLY DEFERRED,
553 persistant_transfer BOOL NOT NULL DEFAULT FALSE,
554 prev_dest INT REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
555 cancel_time TIMESTAMP WITH TIME ZONE
557 CREATE INDEX active_transit_dest_idx ON "action".transit_copy (dest);
558 CREATE INDEX active_transit_source_idx ON "action".transit_copy (source);
559 CREATE INDEX active_transit_cp_idx ON "action".transit_copy (target_copy);
562 CREATE TABLE action.hold_transit_copy (
563 hold INT REFERENCES action.hold_request (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED
564 ) INHERITS (action.transit_copy);
565 ALTER TABLE action.hold_transit_copy ADD PRIMARY KEY (id);
566 -- ALTER TABLE action.hold_transit_copy ADD CONSTRAINT ahtc_tc_fkey FOREIGN KEY (target_copy) REFERENCES asset.copy (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED; -- XXX could be an serial.issuance
567 CREATE INDEX active_hold_transit_dest_idx ON "action".hold_transit_copy (dest);
568 CREATE INDEX active_hold_transit_source_idx ON "action".hold_transit_copy (source);
569 CREATE INDEX active_hold_transit_cp_idx ON "action".hold_transit_copy (target_copy);
570 CREATE INDEX hold_transit_copy_hold_idx on action.hold_transit_copy (hold);
573 CREATE TABLE action.unfulfilled_hold_list (
574 id BIGSERIAL PRIMARY KEY,
575 current_copy BIGINT NOT NULL,
577 circ_lib INT NOT NULL,
578 fail_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
580 CREATE INDEX uhr_hold_idx ON action.unfulfilled_hold_list (hold);
582 CREATE OR REPLACE VIEW action.unfulfilled_hold_loops AS
586 FROM action.unfulfilled_hold_list u
587 JOIN asset.copy c ON (c.id = u.current_copy)
590 CREATE OR REPLACE VIEW action.unfulfilled_hold_min_loop AS
593 FROM action.unfulfilled_hold_loops
596 CREATE OR REPLACE VIEW action.unfulfilled_hold_innermost_loop AS
598 FROM action.unfulfilled_hold_loops l
599 JOIN action.unfulfilled_hold_min_loop m USING (hold)
600 WHERE l.count = m.min;
602 CREATE VIEW action.unfulfilled_hold_max_loop AS
605 FROM action.unfulfilled_hold_loops
609 CREATE TABLE action.aged_hold_request (
611 usr_home_ou INT NOT NULL,
612 usr_profile INT NOT NULL,
614 staff_placed BOOLEAN NOT NULL,
615 LIKE action.hold_request
617 ALTER TABLE action.aged_hold_request
618 ADD PRIMARY KEY (id),
620 DROP COLUMN requestor,
621 DROP COLUMN sms_carrier,
622 ALTER COLUMN phone_notify TYPE BOOLEAN
623 USING CASE WHEN phone_notify IS NULL OR phone_notify = '' THEN FALSE ELSE TRUE END,
624 ALTER COLUMN sms_notify TYPE BOOLEAN
625 USING CASE WHEN sms_notify IS NULL OR sms_notify = '' THEN FALSE ELSE TRUE END,
626 ALTER COLUMN phone_notify SET NOT NULL,
627 ALTER COLUMN sms_notify SET NOT NULL;
628 CREATE INDEX aged_hold_request_target_idx ON action.aged_hold_request (target);
629 CREATE INDEX aged_hold_request_pickup_lib_idx ON action.aged_hold_request (pickup_lib);
630 CREATE INDEX aged_hold_request_current_copy_idx ON action.aged_hold_request (current_copy);
631 CREATE INDEX aged_hold_request_fulfillment_staff_idx ON action.aged_hold_request ( fulfillment_staff );
633 CREATE OR REPLACE VIEW action.all_hold_request AS
635 COALESCE(a.post_code, b.post_code) AS usr_post_code,
636 p.home_ou AS usr_home_ou,
637 p.profile AS usr_profile,
638 EXTRACT(YEAR FROM p.dob)::INT AS usr_birth_year,
639 CAST(ahr.requestor <> ahr.usr AS BOOLEAN) AS staff_placed,
643 ahr.fulfillment_time,
653 ahr.fulfillment_staff,
660 ahr.holdable_formats,
662 WHEN ahr.phone_notify IS NULL THEN FALSE
663 WHEN ahr.phone_notify = '' THEN FALSE
668 WHEN ahr.sms_notify IS NULL THEN FALSE
669 WHEN ahr.sms_notify = '' THEN FALSE
677 ahr.shelf_expire_time,
678 ahr.current_shelf_lib,
680 FROM action.hold_request ahr
681 JOIN actor.usr p ON (ahr.usr = p.id)
682 LEFT JOIN actor.usr_address a ON (p.mailing_address = a.id)
683 LEFT JOIN actor.usr_address b ON (p.billing_address = b.id)
723 FROM action.aged_hold_request;
725 CREATE OR REPLACE FUNCTION action.age_hold_on_delete () RETURNS TRIGGER AS $$
728 -- Archive a copy of the old row to action.aged_hold_request
730 INSERT INTO action.aged_hold_request
806 FROM action.all_hold_request WHERE id = OLD.id;
810 $$ LANGUAGE 'plpgsql';
812 CREATE TRIGGER action_hold_request_aging_tgr
813 BEFORE DELETE ON action.hold_request
815 EXECUTE PROCEDURE action.age_hold_on_delete ();
817 CREATE TABLE action.fieldset_group (
818 id SERIAL PRIMARY KEY,
820 create_time TIMESTAMPTZ NOT NULL DEFAULT NOW(),
821 complete_time TIMESTAMPTZ,
822 container INT, -- Points to a container of some type ...
823 container_type TEXT, -- One of 'biblio_record_entry', 'user', 'call_number', 'copy'
824 can_rollback BOOL DEFAULT TRUE,
825 rollback_group INT REFERENCES action.fieldset_group (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
826 rollback_time TIMESTAMPTZ,
827 creator INT NOT NULL REFERENCES actor.usr (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
828 owning_lib INT NOT NULL REFERENCES actor.org_unit (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED
831 CREATE TABLE action.fieldset (
832 id SERIAL PRIMARY KEY,
833 fieldset_group INT REFERENCES action.fieldset_group (id)
834 ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
835 owner INT NOT NULL REFERENCES actor.usr (id)
836 DEFERRABLE INITIALLY DEFERRED,
837 owning_lib INT NOT NULL REFERENCES actor.org_unit (id)
838 DEFERRABLE INITIALLY DEFERRED,
840 CONSTRAINT valid_status CHECK ( status in
841 ( 'PENDING', 'APPLIED', 'ERROR' )),
842 creation_time TIMESTAMPTZ NOT NULL DEFAULT NOW(),
843 scheduled_time TIMESTAMPTZ,
844 applied_time TIMESTAMPTZ,
845 classname TEXT NOT NULL, -- an IDL class name
848 stored_query INT REFERENCES query.stored_query (id)
849 DEFERRABLE INITIALLY DEFERRED,
851 CONSTRAINT lib_name_unique UNIQUE (owning_lib, name),
852 CONSTRAINT fieldset_one_or_the_other CHECK (
853 (stored_query IS NOT NULL AND pkey_value IS NULL) OR
854 (pkey_value IS NOT NULL AND stored_query IS NULL)
856 -- the CHECK constraint means we can update the fields for a single
857 -- row without all the extra overhead involved in a query
860 CREATE INDEX action_fieldset_sched_time_idx ON action.fieldset( scheduled_time );
861 CREATE INDEX action_owner_idx ON action.fieldset( owner );
864 CREATE TABLE action.fieldset_col_val (
865 id SERIAL PRIMARY KEY,
866 fieldset INT NOT NULL REFERENCES action.fieldset
868 DEFERRABLE INITIALLY DEFERRED,
869 col TEXT NOT NULL, -- "field" from the idl ... the column on the table
870 val TEXT, -- value for the column ... NULL means, well, NULL
871 CONSTRAINT fieldset_col_once_per_set UNIQUE (fieldset, col)
875 -- represents a circ chain summary
876 CREATE TYPE action.circ_chain_summary AS (
878 start_time TIMESTAMP WITH TIME ZONE,
879 checkout_workstation TEXT,
880 last_renewal_time TIMESTAMP WITH TIME ZONE, -- NULL if no renewals
881 last_stop_fines TEXT,
882 last_stop_fines_time TIMESTAMP WITH TIME ZONE,
883 last_renewal_workstation TEXT, -- NULL if no renewals
884 last_checkin_workstation TEXT,
885 last_checkin_time TIMESTAMP WITH TIME ZONE,
886 last_checkin_scan_time TIMESTAMP WITH TIME ZONE
890 CREATE OR REPLACE FUNCTION action.circ_chain ( ctx_circ_id BIGINT ) RETURNS SETOF action.circulation AS $$
892 tmp_circ action.circulation%ROWTYPE;
893 circ_0 action.circulation%ROWTYPE;
896 SELECT INTO tmp_circ * FROM action.circulation WHERE id = ctx_circ_id;
898 IF tmp_circ IS NULL THEN
899 RETURN NEXT tmp_circ;
903 -- find the front of the chain
905 SELECT INTO tmp_circ * FROM action.circulation WHERE id = tmp_circ.parent_circ;
906 IF tmp_circ IS NULL THEN
912 -- now send the circs to the caller, oldest to newest
915 IF tmp_circ IS NULL THEN
918 RETURN NEXT tmp_circ;
919 SELECT INTO tmp_circ * FROM action.circulation WHERE parent_circ = tmp_circ.id;
923 $$ LANGUAGE 'plpgsql';
925 CREATE OR REPLACE FUNCTION action.summarize_circ_chain ( ctx_circ_id BIGINT ) RETURNS action.circ_chain_summary AS $$
929 -- first circ in the chain
930 circ_0 action.circulation%ROWTYPE;
932 -- last circ in the chain
933 circ_n action.circulation%ROWTYPE;
935 -- circ chain under construction
936 chain action.circ_chain_summary;
937 tmp_circ action.circulation%ROWTYPE;
941 chain.num_circs := 0;
942 FOR tmp_circ IN SELECT * FROM action.circ_chain(ctx_circ_id) LOOP
944 IF chain.num_circs = 0 THEN
948 chain.num_circs := chain.num_circs + 1;
952 chain.start_time := circ_0.xact_start;
953 chain.last_stop_fines := circ_n.stop_fines;
954 chain.last_stop_fines_time := circ_n.stop_fines_time;
955 chain.last_checkin_time := circ_n.checkin_time;
956 chain.last_checkin_scan_time := circ_n.checkin_scan_time;
957 SELECT INTO chain.checkout_workstation name FROM actor.workstation WHERE id = circ_0.workstation;
958 SELECT INTO chain.last_checkin_workstation name FROM actor.workstation WHERE id = circ_n.checkin_workstation;
960 IF chain.num_circs > 1 THEN
961 chain.last_renewal_time := circ_n.xact_start;
962 SELECT INTO chain.last_renewal_workstation name FROM actor.workstation WHERE id = circ_n.workstation;
968 $$ LANGUAGE 'plpgsql';
970 -- same as action.circ_chain, but returns action.all_circulation
971 -- rows which may include aged circulations.
972 CREATE OR REPLACE FUNCTION action.all_circ_chain (ctx_circ_id INTEGER)
973 RETURNS SETOF action.all_circulation_slim AS $$
975 tmp_circ action.all_circulation_slim%ROWTYPE;
976 circ_0 action.all_circulation_slim%ROWTYPE;
979 SELECT INTO tmp_circ * FROM action.all_circulation_slim WHERE id = ctx_circ_id;
981 IF tmp_circ IS NULL THEN
982 RETURN NEXT tmp_circ;
986 -- find the front of the chain
988 SELECT INTO tmp_circ * FROM action.all_circulation_slim
989 WHERE id = tmp_circ.parent_circ;
990 IF tmp_circ IS NULL THEN
996 -- now send the circs to the caller, oldest to newest
999 IF tmp_circ IS NULL THEN
1002 RETURN NEXT tmp_circ;
1003 SELECT INTO tmp_circ * FROM action.all_circulation_slim
1004 WHERE parent_circ = tmp_circ.id;
1008 $$ LANGUAGE 'plpgsql';
1010 -- same as action.summarize_circ_chain, but returns data collected
1011 -- from action.all_circulation, which may include aged circulations.
1012 CREATE OR REPLACE FUNCTION action.summarize_all_circ_chain
1013 (ctx_circ_id INTEGER) RETURNS action.circ_chain_summary AS $$
1017 -- first circ in the chain
1018 circ_0 action.all_circulation_slim%ROWTYPE;
1020 -- last circ in the chain
1021 circ_n action.all_circulation_slim%ROWTYPE;
1023 -- circ chain under construction
1024 chain action.circ_chain_summary;
1025 tmp_circ action.all_circulation_slim%ROWTYPE;
1029 chain.num_circs := 0;
1030 FOR tmp_circ IN SELECT * FROM action.all_circ_chain(ctx_circ_id) LOOP
1032 IF chain.num_circs = 0 THEN
1036 chain.num_circs := chain.num_circs + 1;
1040 chain.start_time := circ_0.xact_start;
1041 chain.last_stop_fines := circ_n.stop_fines;
1042 chain.last_stop_fines_time := circ_n.stop_fines_time;
1043 chain.last_checkin_time := circ_n.checkin_time;
1044 chain.last_checkin_scan_time := circ_n.checkin_scan_time;
1045 SELECT INTO chain.checkout_workstation name FROM actor.workstation WHERE id = circ_0.workstation;
1046 SELECT INTO chain.last_checkin_workstation name FROM actor.workstation WHERE id = circ_n.checkin_workstation;
1048 IF chain.num_circs > 1 THEN
1049 chain.last_renewal_time := circ_n.xact_start;
1050 SELECT INTO chain.last_renewal_workstation name FROM actor.workstation WHERE id = circ_n.workstation;
1056 $$ LANGUAGE 'plpgsql';
1058 CREATE OR REPLACE FUNCTION action.usr_visible_holds (usr_id INT) RETURNS SETOF action.hold_request AS $func$
1060 h action.hold_request%ROWTYPE;
1063 usr_view_count actor.usr_setting%ROWTYPE;
1064 usr_view_age actor.usr_setting%ROWTYPE;
1065 usr_view_start actor.usr_setting%ROWTYPE;
1067 SELECT * INTO usr_view_count FROM actor.usr_setting WHERE usr = usr_id AND name = 'history.hold.retention_count';
1068 SELECT * INTO usr_view_age FROM actor.usr_setting WHERE usr = usr_id AND name = 'history.hold.retention_age';
1069 SELECT * INTO usr_view_start FROM actor.usr_setting WHERE usr = usr_id AND name = 'history.hold.retention_start';
1073 FROM action.hold_request
1075 AND fulfillment_time IS NULL
1076 AND cancel_time IS NULL
1077 ORDER BY request_time DESC
1082 IF usr_view_start.value IS NULL THEN
1086 IF usr_view_age.value IS NOT NULL THEN
1087 -- User opted in and supplied a retention age
1088 IF oils_json_to_text(usr_view_age.value)::INTERVAL > AGE(NOW(), oils_json_to_text(usr_view_start.value)::TIMESTAMPTZ) THEN
1089 view_age := AGE(NOW(), oils_json_to_text(usr_view_start.value)::TIMESTAMPTZ);
1091 view_age := oils_json_to_text(usr_view_age.value)::INTERVAL;
1095 view_age := AGE(NOW(), oils_json_to_text(usr_view_start.value)::TIMESTAMPTZ);
1098 IF usr_view_count.value IS NOT NULL THEN
1099 view_count := oils_json_to_text(usr_view_count.value)::INT;
1104 -- show some fulfilled/canceled holds
1107 FROM action.hold_request
1109 AND ( fulfillment_time IS NOT NULL OR cancel_time IS NOT NULL )
1110 AND COALESCE(fulfillment_time, cancel_time) > NOW() - view_age
1111 ORDER BY COALESCE(fulfillment_time, cancel_time) DESC
1119 $func$ LANGUAGE PLPGSQL;
1121 CREATE OR REPLACE FUNCTION action.purge_circulations () RETURNS INT AS $func$
1123 org_keep_age INTERVAL;
1124 org_use_last BOOL = false;
1125 org_age_is_min BOOL = false;
1131 circ_chain_head action.circulation%ROWTYPE;
1132 circ_chain_tail action.circulation%ROWTYPE;
1137 last_finished TIMESTAMP WITH TIME ZONE;
1142 SELECT value::INTERVAL INTO org_keep_age FROM config.global_flag WHERE name = 'history.circ.retention_age' AND enabled;
1144 SELECT value::INT INTO org_keep_count FROM config.global_flag WHERE name = 'history.circ.retention_count' AND enabled;
1145 IF org_keep_count IS NULL THEN
1146 RETURN count_purged; -- Gimme a count to keep, or I keep them all, forever
1149 SELECT enabled INTO org_use_last FROM config.global_flag WHERE name = 'history.circ.retention_uses_last_finished';
1150 SELECT enabled INTO org_age_is_min FROM config.global_flag WHERE name = 'history.circ.retention_age_is_min';
1152 -- First, find copies with more than keep_count non-renewal circs
1155 COUNT(*) AS total_real_circs
1156 FROM action.circulation
1157 WHERE parent_circ IS NULL
1158 AND xact_finish IS NOT NULL
1159 GROUP BY target_copy
1160 HAVING COUNT(*) > org_keep_count
1162 -- And, for those, select circs that are finished and older than keep_age
1163 FOR circ_chain_head IN
1164 -- For reference, the subquery uses a window function to order the circs newest to oldest and number them
1165 -- The outer query then uses that information to skip the most recent set the library wants to keep
1166 -- End result is we don't care what order they come out in, as they are all potentials for deletion.
1167 SELECT ac.* FROM action.circulation ac JOIN (
1168 SELECT rank() OVER (ORDER BY xact_start DESC), ac.id
1169 FROM action.circulation ac
1170 WHERE ac.target_copy = target_acp.target_copy
1171 AND ac.parent_circ IS NULL
1172 ORDER BY ac.xact_start ) ranked USING (id)
1173 WHERE ranked.rank > org_keep_count
1176 SELECT * INTO circ_chain_tail FROM action.circ_chain(circ_chain_head.id) ORDER BY xact_start DESC LIMIT 1;
1177 SELECT COUNT(CASE WHEN xact_finish IS NULL THEN 1 ELSE NULL END), MAX(xact_finish) INTO num_incomplete, last_finished FROM action.circ_chain(circ_chain_head.id);
1178 CONTINUE WHEN circ_chain_tail.xact_finish IS NULL OR num_incomplete > 0;
1180 IF NOT org_use_last THEN
1181 last_finished := circ_chain_tail.xact_finish;
1184 keep_age := COALESCE( org_keep_age, '2000 years'::INTERVAL );
1186 IF org_age_is_min THEN
1187 keep_age := GREATEST( keep_age, org_keep_age );
1190 CONTINUE WHEN AGE(NOW(), last_finished) < keep_age;
1192 -- We've passed the purging tests, purge the circ chain starting at the end
1193 -- A trigger should auto-purge the rest of the chain.
1194 DELETE FROM action.circulation WHERE id = circ_chain_tail.id;
1196 count_purged := count_purged + 1;
1201 return count_purged;
1203 $func$ LANGUAGE PLPGSQL;
1205 CREATE OR REPLACE FUNCTION action.purge_holds() RETURNS INT AS $func$
1207 current_hold RECORD;
1213 user_start TIMESTAMPTZ;
1218 SELECT INTO cgf_d value::INTERVAL FROM config.global_flag WHERE name = 'history.hold.retention_age' AND enabled;
1219 SELECT INTO cgf_f value::INTERVAL FROM config.global_flag WHERE name = 'history.hold.retention_age_fulfilled' AND enabled;
1220 SELECT INTO cgf_c value::INTERVAL FROM config.global_flag WHERE name = 'history.hold.retention_age_canceled' AND enabled;
1223 rank() OVER (PARTITION BY usr ORDER BY COALESCE(fulfillment_time, cancel_time) DESC),
1224 cgf_cs.value::INTERVAL as cgf_cs,
1227 action.hold_request ahr
1228 LEFT JOIN config.global_flag cgf_cs ON (ahr.cancel_cause IS NOT NULL AND cgf_cs.name = 'history.hold.retention_age_canceled_' || ahr.cancel_cause AND cgf_cs.enabled)
1230 (fulfillment_time IS NOT NULL OR cancel_time IS NOT NULL)
1232 IF prev_usr IS NULL OR prev_usr != current_hold.usr THEN
1233 prev_usr := current_hold.usr;
1234 SELECT INTO user_start oils_json_to_text(value)::TIMESTAMPTZ FROM actor.usr_setting WHERE usr = prev_usr AND name = 'history.hold.retention_start';
1235 SELECT INTO user_age oils_json_to_text(value)::INTERVAL FROM actor.usr_setting WHERE usr = prev_usr AND name = 'history.hold.retention_age';
1236 SELECT INTO user_count oils_json_to_text(value)::INT FROM actor.usr_setting WHERE usr = prev_usr AND name = 'history.hold.retention_count';
1237 IF user_start IS NOT NULL THEN
1238 user_age := LEAST(user_age, AGE(NOW(), user_start));
1240 IF user_count IS NULL THEN
1241 user_count := 1000; -- Assumption based on the user visible holds routine
1244 -- Library keep age trumps user keep anything, for purposes of being able to hold on to things when staff canceled and such.
1245 IF current_hold.fulfillment_time IS NOT NULL AND current_hold.fulfillment_time > NOW() - COALESCE(cgf_f, cgf_d) THEN
1248 IF current_hold.cancel_time IS NOT NULL AND current_hold.cancel_time > NOW() - COALESCE(current_hold.cgf_cs, cgf_c, cgf_d) THEN
1252 -- User keep age needs combining with count. If too old AND within the count, keep!
1253 IF user_start IS NOT NULL AND COALESCE(current_hold.fulfillment_time, current_hold.cancel_time) > NOW() - user_age AND current_hold.rank <= user_count THEN
1257 -- All checks should have passed, delete!
1258 DELETE FROM action.hold_request WHERE id = current_hold.id;
1259 purged_holds := purged_holds + 1;
1261 RETURN purged_holds;
1263 $func$ LANGUAGE plpgsql;
1265 CREATE OR REPLACE FUNCTION action.apply_fieldset(
1266 fieldset_id IN INT, -- id from action.fieldset
1267 table_name IN TEXT, -- table to be updated
1268 pkey_name IN TEXT, -- name of primary key column in that table
1269 query IN TEXT -- query constructed by qstore (for query-based
1270 -- fieldsets only; otherwise null
1286 fs_obj action.fieldset%ROWTYPE;
1287 fs_group action.fieldset_group%ROWTYPE;
1291 IF fieldset_id IS NULL THEN
1292 RETURN 'Fieldset ID parameter is NULL';
1294 IF table_name IS NULL THEN
1295 RETURN 'Table name parameter is NULL';
1297 IF pkey_name IS NULL THEN
1298 RETURN 'Primary key name parameter is NULL';
1303 quote_literal( pkey_value )
1313 -- Build the WHERE clause. This differs according to whether it's a
1314 -- single-row fieldset or a query-based fieldset.
1316 IF query IS NULL AND fs_pkey_value IS NULL THEN
1317 RETURN 'Incomplete fieldset: neither a primary key nor a query available';
1318 ELSIF query IS NOT NULL AND fs_pkey_value IS NULL THEN
1319 fs_query := rtrim( query, ';' );
1320 where_clause := 'WHERE ' || pkey_name || ' IN ( '
1321 || fs_query || ' )';
1322 ELSIF query IS NULL AND fs_pkey_value IS NOT NULL THEN
1323 where_clause := 'WHERE ' || pkey_name || ' = ';
1324 IF pkey_name = 'id' THEN
1325 where_clause := where_clause || fs_pkey_value;
1326 ELSIF pkey_name = 'code' THEN
1327 where_clause := where_clause || quote_literal(fs_pkey_value);
1329 RETURN 'Only know how to handle "id" and "code" pkeys currently, received ' || pkey_name;
1331 ELSE -- both are not null
1332 RETURN 'Ambiguous fieldset: both a primary key and a query provided';
1335 IF fs_status IS NULL THEN
1336 RETURN 'No fieldset found for id = ' || fieldset_id;
1337 ELSIF fs_status = 'APPLIED' THEN
1338 RETURN 'Fieldset ' || fieldset_id || ' has already been applied';
1341 SELECT * INTO fs_obj FROM action.fieldset WHERE id = fieldset_id;
1342 SELECT * INTO fs_group FROM action.fieldset_group WHERE id = fs_obj.fieldset_group;
1344 IF fs_group.can_rollback THEN
1345 -- This is part of a non-rollback group. We need to record the current values for future rollback.
1347 INSERT INTO action.fieldset_group (can_rollback, name, creator, owning_lib, container, container_type)
1348 VALUES (FALSE, 'ROLLBACK: '|| fs_group.name, fs_group.creator, fs_group.owning_lib, fs_group.container, fs_group.container_type);
1350 fsg_id := CURRVAL('action.fieldset_group_id_seq');
1352 FOR rb_row IN EXECUTE 'SELECT * FROM ' || table_name || ' ' || where_clause LOOP
1353 IF pkey_name = 'id' THEN
1354 fs_pkey_value := rb_row.id;
1355 ELSIF pkey_name = 'code' THEN
1356 fs_pkey_value := rb_row.code;
1358 RETURN 'Only know how to handle "id" and "code" pkeys currently, received ' || pkey_name;
1360 INSERT INTO action.fieldset (fieldset_group,owner,owning_lib,status,classname,name,pkey_value)
1361 VALUES (fsg_id, fs_obj.owner, fs_obj.owning_lib, 'PENDING', fs_obj.classname, fs_obj.name || ' ROLLBACK FOR ' || fs_pkey_value, fs_pkey_value);
1363 fs_id := CURRVAL('action.fieldset_id_seq');
1367 FROM action.fieldset_col_val
1368 WHERE fieldset = fieldset_id
1370 EXECUTE 'INSERT INTO action.fieldset_col_val (fieldset, col, val) ' ||
1371 'SELECT '|| fs_id || ', '||quote_literal(cv.col)||', '||cv.col||' FROM '||table_name||' WHERE '||pkey_name||' = '||fs_pkey_value;
1376 statement := 'UPDATE ' || table_name || ' SET';
1382 FROM action.fieldset_col_val
1383 WHERE fieldset = fieldset_id
1385 statement := statement || sep || ' ' || cv.col
1386 || ' = ' || coalesce( quote_literal( cv.val ), 'NULL' );
1391 RETURN 'Fieldset ' || fieldset_id || ' has no column values defined';
1393 statement := statement || ' ' || where_clause;
1396 -- Execute the update
1400 GET DIAGNOSTICS update_count = ROW_COUNT;
1402 IF update_count = 0 THEN
1403 RAISE data_exception;
1406 IF fsg_id IS NOT NULL THEN
1407 UPDATE action.fieldset_group SET rollback_group = fsg_id WHERE id = fs_group.id;
1410 IF fs_group.id IS NOT NULL THEN
1411 UPDATE action.fieldset_group SET complete_time = now() WHERE id = fs_group.id;
1414 UPDATE action.fieldset SET status = 'APPLIED', applied_time = now() WHERE id = fieldset_id;
1416 EXCEPTION WHEN data_exception THEN
1417 msg := 'No eligible rows found for fieldset ' || fieldset_id;
1418 UPDATE action.fieldset SET status = 'ERROR', applied_time = now() WHERE id = fieldset_id;
1425 EXCEPTION WHEN OTHERS THEN
1426 msg := 'Unable to apply fieldset ' || fieldset_id || ': ' || sqlerrm;
1427 UPDATE action.fieldset SET status = 'ERROR', applied_time = now() WHERE id = fieldset_id;
1431 $$ LANGUAGE plpgsql;
1433 COMMENT ON FUNCTION action.apply_fieldset( INT, TEXT, TEXT, TEXT ) IS $$
1434 Applies a specified fieldset, using a supplied table name and primary
1435 key name. The query parameter should be non-null only for
1436 query-based fieldsets.
1438 Returns NULL if successful, or an error message if not.
1441 CREATE OR REPLACE FUNCTION action.hold_copy_calculated_proximity(
1444 copy_context_ou INT DEFAULT NULL
1445 -- TODO maybe? hold_context_ou INT DEFAULT NULL. This would optionally
1446 -- support an "ahprox" measurement: adjust prox between copy circ lib and
1447 -- hold request lib, but I'm unsure whether to use this theoretical
1448 -- argument only in the baseline calculation or later in the other
1449 -- queries in this function.
1450 ) RETURNS NUMERIC AS $f$
1452 aoupa actor.org_unit_proximity_adjustment%ROWTYPE;
1453 ahr action.hold_request%ROWTYPE;
1454 acp asset.copy%ROWTYPE;
1455 acn asset.call_number%ROWTYPE;
1456 acl asset.copy_location%ROWTYPE;
1457 baseline_prox NUMERIC;
1467 SELECT * INTO ahr FROM action.hold_request WHERE id = ahr_id;
1468 SELECT * INTO acp FROM asset.copy WHERE id = acp_id;
1469 SELECT * INTO acn FROM asset.call_number WHERE id = acp.call_number;
1470 SELECT * INTO acl FROM asset.copy_location WHERE id = acp.location;
1472 IF copy_context_ou IS NULL THEN
1473 copy_context_ou := acp.circ_lib;
1476 -- First, gather the baseline proximity of "here" to pickup lib
1477 SELECT prox INTO baseline_prox FROM actor.org_unit_proximity WHERE from_org = copy_context_ou AND to_org = ahr.pickup_lib;
1479 -- Find any absolute adjustments, and set the baseline prox to that
1480 SELECT adj.* INTO aoupa
1481 FROM actor.org_unit_proximity_adjustment adj
1482 LEFT JOIN actor.org_unit_ancestors_distance(copy_context_ou) acp_cl ON (acp_cl.id = adj.item_circ_lib)
1483 LEFT JOIN actor.org_unit_ancestors_distance(acn.owning_lib) acn_ol ON (acn_ol.id = adj.item_owning_lib)
1484 LEFT JOIN actor.org_unit_ancestors_distance(acl.owning_lib) acl_ol ON (acl_ol.id = adj.copy_location)
1485 LEFT JOIN actor.org_unit_ancestors_distance(ahr.pickup_lib) ahr_pl ON (ahr_pl.id = adj.hold_pickup_lib)
1486 LEFT JOIN actor.org_unit_ancestors_distance(ahr.request_lib) ahr_rl ON (ahr_rl.id = adj.hold_request_lib)
1487 WHERE (adj.circ_mod IS NULL OR adj.circ_mod = acp.circ_modifier) AND
1488 (adj.item_circ_lib IS NULL OR adj.item_circ_lib = acp_cl.id) AND
1489 (adj.item_owning_lib IS NULL OR adj.item_owning_lib = acn_ol.id) AND
1490 (adj.copy_location IS NULL OR adj.copy_location = acl_ol.id) AND
1491 (adj.hold_pickup_lib IS NULL OR adj.hold_pickup_lib = ahr_pl.id) AND
1492 (adj.hold_request_lib IS NULL OR adj.hold_request_lib = ahr_rl.id) AND
1493 absolute_adjustment AND
1494 COALESCE(acp_cl.id, acn_ol.id, acl_ol.id, ahr_pl.id, ahr_rl.id) IS NOT NULL
1496 COALESCE(acp_cl.distance,999)
1497 + COALESCE(acn_ol.distance,999)
1498 + COALESCE(acl_ol.distance,999)
1499 + COALESCE(ahr_pl.distance,999)
1500 + COALESCE(ahr_rl.distance,999),
1505 baseline_prox := aoupa.prox_adjustment;
1508 -- Now find any relative adjustments, and change the baseline prox based on them
1511 FROM actor.org_unit_proximity_adjustment adj
1512 LEFT JOIN actor.org_unit_ancestors_distance(copy_context_ou) acp_cl ON (acp_cl.id = adj.item_circ_lib)
1513 LEFT JOIN actor.org_unit_ancestors_distance(acn.owning_lib) acn_ol ON (acn_ol.id = adj.item_owning_lib)
1514 LEFT JOIN actor.org_unit_ancestors_distance(acl.owning_lib) acl_ol ON (acn_ol.id = adj.copy_location)
1515 LEFT JOIN actor.org_unit_ancestors_distance(ahr.pickup_lib) ahr_pl ON (ahr_pl.id = adj.hold_pickup_lib)
1516 LEFT JOIN actor.org_unit_ancestors_distance(ahr.request_lib) ahr_rl ON (ahr_rl.id = adj.hold_request_lib)
1517 WHERE (adj.circ_mod IS NULL OR adj.circ_mod = acp.circ_modifier) AND
1518 (adj.item_circ_lib IS NULL OR adj.item_circ_lib = acp_cl.id) AND
1519 (adj.item_owning_lib IS NULL OR adj.item_owning_lib = acn_ol.id) AND
1520 (adj.copy_location IS NULL OR adj.copy_location = acl_ol.id) AND
1521 (adj.hold_pickup_lib IS NULL OR adj.hold_pickup_lib = ahr_pl.id) AND
1522 (adj.hold_request_lib IS NULL OR adj.hold_request_lib = ahr_rl.id) AND
1523 NOT absolute_adjustment AND
1524 COALESCE(acp_cl.id, acn_ol.id, acl_ol.id, ahr_pl.id, ahr_rl.id) IS NOT NULL
1526 baseline_prox := baseline_prox + aoupa.prox_adjustment;
1529 RETURN baseline_prox;
1531 $f$ LANGUAGE PLPGSQL;
1533 CREATE OR REPLACE FUNCTION action.hold_copy_calculated_proximity_update () RETURNS TRIGGER AS $f$
1535 NEW.proximity := action.hold_copy_calculated_proximity(NEW.hold,NEW.target_copy);
1538 $f$ LANGUAGE PLPGSQL;
1540 CREATE TRIGGER hold_copy_proximity_update_tgr BEFORE INSERT OR UPDATE ON action.hold_copy_map FOR EACH ROW EXECUTE PROCEDURE action.hold_copy_calculated_proximity_update ();
1542 CREATE TABLE action.usr_circ_history (
1543 id BIGSERIAL PRIMARY KEY,
1544 usr INTEGER NOT NULL REFERENCES actor.usr(id)
1545 DEFERRABLE INITIALLY DEFERRED,
1546 xact_start TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
1547 target_copy BIGINT NOT NULL, -- asset.copy.id / serial.unit.id
1548 due_date TIMESTAMP WITH TIME ZONE NOT NULL,
1549 checkin_time TIMESTAMP WITH TIME ZONE,
1550 source_circ BIGINT REFERENCES action.circulation(id)
1551 ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED
1554 CREATE INDEX action_usr_circ_history_usr_idx ON action.usr_circ_history ( usr );
1555 CREATE INDEX action_usr_circ_history_source_circ_idx ON action.usr_circ_history ( source_circ );
1557 CREATE TRIGGER action_usr_circ_history_target_copy_trig
1558 AFTER INSERT OR UPDATE ON action.usr_circ_history
1559 FOR EACH ROW EXECUTE PROCEDURE evergreen.fake_fkey_tgr('target_copy');
1561 CREATE OR REPLACE FUNCTION action.maintain_usr_circ_history()
1562 RETURNS TRIGGER AS $FUNK$
1568 -- Any retention value signifies history is enabled.
1569 -- This assumes that clearing these values via external
1570 -- process deletes the action.usr_circ_history rows.
1571 -- TODO: replace these settings w/ a single bool setting?
1572 PERFORM 1 FROM actor.usr_setting
1573 WHERE usr = NEW.usr AND value IS NOT NULL AND name IN (
1574 'history.circ.retention_age',
1575 'history.circ.retention_start'
1582 IF TG_OP = 'INSERT' AND NEW.parent_circ IS NULL THEN
1583 -- Starting a new circulation. Insert the history row.
1584 INSERT INTO action.usr_circ_history
1585 (usr, xact_start, target_copy, due_date, source_circ)
1597 -- find the first and last circs in the circ chain
1598 -- for the currently modified circ.
1599 FOR cur_circ IN SELECT id FROM action.circ_chain(NEW.id) LOOP
1600 IF first_circ IS NULL THEN
1601 first_circ := cur_circ;
1604 -- Allow the loop to continue so that at as the loop
1605 -- completes cur_circ points to the final circulation.
1608 IF NEW.id <> cur_circ THEN
1609 -- Modifying an intermediate circ. Ignore it.
1613 -- Update the due_date/checkin_time on the history row if the current
1614 -- circ is the last circ in the chain and an update is warranted.
1616 UPDATE action.usr_circ_history
1618 due_date = NEW.due_date,
1619 checkin_time = NEW.checkin_time
1621 source_circ = first_circ
1623 due_date <> NEW.due_date OR (
1624 (checkin_time IS NULL AND NEW.checkin_time IS NOT NULL) OR
1625 (checkin_time IS NOT NULL AND NEW.checkin_time IS NULL) OR
1626 (checkin_time <> NEW.checkin_time)
1631 $FUNK$ LANGUAGE PLPGSQL;
1633 CREATE TRIGGER maintain_usr_circ_history_tgr
1634 AFTER INSERT OR UPDATE ON action.circulation
1635 FOR EACH ROW EXECUTE PROCEDURE action.maintain_usr_circ_history();
1637 CREATE OR REPLACE VIEW action.all_circulation_combined_types AS
1638 SELECT acirc.id AS id,
1643 ac_acirc.circ_modifier AS item_type,
1644 'regular_circ'::text AS circ_type
1645 FROM action.circulation acirc,
1647 WHERE acirc.target_copy = ac_acirc.id
1649 SELECT ancc.id::BIGINT AS id,
1650 ancc.circ_time AS xact_start,
1652 ancc.staff AS circ_staff,
1653 ancc.circ_time AS create_time,
1654 cnct_ancc.name AS item_type,
1655 'non-cat_circ'::text AS circ_type
1656 FROM action.non_cataloged_circulation ancc,
1657 config.non_cataloged_type cnct_ancc
1658 WHERE ancc.item_type = cnct_ancc.id
1660 SELECT aihu.id::BIGINT AS id,
1661 aihu.use_time AS xact_start,
1662 aihu.org_unit AS circ_lib,
1663 aihu.staff AS circ_staff,
1664 aihu.use_time AS create_time,
1665 ac_aihu.circ_modifier AS item_type,
1666 'in-house_use'::text AS circ_type
1667 FROM action.in_house_use aihu,
1669 WHERE aihu.item = ac_aihu.id
1671 SELECT ancihu.id::BIGINT AS id,
1672 ancihu.use_time AS xact_start,
1673 ancihu.org_unit AS circ_lib,
1674 ancihu.staff AS circ_staff,
1675 ancihu.use_time AS create_time,
1676 cnct_ancihu.name AS item_type,
1677 'non-cat_circ'::text AS circ_type
1678 FROM action.non_cat_in_house_use ancihu,
1679 config.non_cataloged_type cnct_ancihu
1680 WHERE ancihu.item_type = cnct_ancihu.id
1682 SELECT aacirc.id AS id,
1687 ac_aacirc.circ_modifier AS item_type,
1688 'aged_circ'::text AS circ_type
1689 FROM action.aged_circulation aacirc,
1690 asset.copy ac_aacirc
1691 WHERE aacirc.target_copy = ac_aacirc.id;