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 NOT NULL DEFAULT FALSE,
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
317 CREATE OR REPLACE FUNCTION action.age_circ_on_delete () RETURNS TRIGGER AS $$
322 -- If there are any renewals for this circulation, don't archive or delete
323 -- it yet. We'll do so later, when we archive and delete the renewals.
325 SELECT 'Y' INTO found
326 FROM action.circulation
327 WHERE parent_circ = OLD.id
331 RETURN NULL; -- don't delete
334 -- Archive a copy of the old row to action.aged_circulation
336 INSERT INTO action.aged_circulation
337 (id,usr_post_code, usr_home_ou, usr_profile, usr_birth_year, copy_call_number, copy_location,
338 copy_owning_lib, copy_circ_lib, copy_bib_record, xact_start, xact_finish, target_copy,
339 circ_lib, circ_staff, checkin_staff, checkin_lib, renewal_remaining, grace_period, due_date,
340 stop_fines_time, checkin_time, create_time, duration, fine_interval, recurring_fine,
341 max_fine, phone_renewal, desk_renewal, opac_renewal, duration_rule, recurring_fine_rule,
342 max_fine_rule, stop_fines, workstation, checkin_workstation, checkin_scan_time, parent_circ,
343 auto_renewal, auto_renewal_remaining)
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 auto_renewal, auto_renewal_remaining
352 FROM action.all_circulation WHERE id = OLD.id;
354 -- Migrate billings and payments to aged tables
356 SELECT 'Y' INTO found FROM config.global_flag
357 WHERE name = 'history.money.age_with_circs' AND enabled;
360 PERFORM money.age_billings_and_payments_for_xact(OLD.id);
365 $$ LANGUAGE 'plpgsql';
367 CREATE TRIGGER action_circulation_aging_tgr
368 BEFORE DELETE ON action.circulation
370 EXECUTE PROCEDURE action.age_circ_on_delete ();
373 CREATE OR REPLACE FUNCTION action.age_parent_circ_on_delete () RETURNS TRIGGER AS $$
376 -- Having deleted a renewal, we can delete the original circulation (or a previous
377 -- renewal, if that's what parent_circ is pointing to). That deletion will trigger
378 -- deletion of any prior parents, etc. recursively.
380 IF OLD.parent_circ IS NOT NULL THEN
381 DELETE FROM action.circulation
382 WHERE id = OLD.parent_circ;
387 $$ LANGUAGE 'plpgsql';
389 CREATE TRIGGER age_parent_circ
390 AFTER DELETE ON action.circulation
392 EXECUTE PROCEDURE action.age_parent_circ_on_delete ();
395 CREATE OR REPLACE VIEW action.open_circulation AS
397 FROM action.circulation
398 WHERE checkin_time IS NULL
402 CREATE OR REPLACE VIEW action.billable_circulations AS
404 FROM action.circulation
405 WHERE xact_finish IS NULL;
407 CREATE OR REPLACE FUNCTION action.circulation_claims_returned () RETURNS TRIGGER AS $$
409 IF OLD.stop_fines IS NULL OR OLD.stop_fines <> NEW.stop_fines THEN
410 IF NEW.stop_fines = 'CLAIMSRETURNED' THEN
411 UPDATE actor.usr SET claims_returned_count = claims_returned_count + 1 WHERE id = NEW.usr;
413 IF NEW.stop_fines = 'CLAIMSNEVERCHECKEDOUT' THEN
414 UPDATE actor.usr SET claims_never_checked_out_count = claims_never_checked_out_count + 1 WHERE id = NEW.usr;
416 IF NEW.stop_fines = 'LOST' THEN
417 UPDATE asset.copy SET status = 3 WHERE id = NEW.target_copy;
422 $$ LANGUAGE 'plpgsql';
423 CREATE TRIGGER action_circulation_stop_fines_tgr
424 BEFORE UPDATE ON action.circulation
426 EXECUTE PROCEDURE action.circulation_claims_returned ();
428 CREATE TABLE action.hold_request_cancel_cause (
429 id SERIAL PRIMARY KEY,
433 CREATE TABLE action.hold_request (
434 id SERIAL PRIMARY KEY,
435 request_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
436 capture_time TIMESTAMP WITH TIME ZONE,
437 fulfillment_time TIMESTAMP WITH TIME ZONE,
438 checkin_time TIMESTAMP WITH TIME ZONE,
439 return_time TIMESTAMP WITH TIME ZONE,
440 prev_check_time TIMESTAMP WITH TIME ZONE,
441 expire_time TIMESTAMP WITH TIME ZONE,
442 cancel_time TIMESTAMP WITH TIME ZONE,
443 cancel_cause INT REFERENCES action.hold_request_cancel_cause (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
445 target BIGINT NOT NULL, -- see hold_type
446 current_copy BIGINT, -- REFERENCES asset.copy (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED, -- XXX could be an serial.unit now...
447 fulfillment_staff INT REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
448 fulfillment_lib INT REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
449 request_lib INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
450 requestor INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
451 usr INT NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
452 selection_ou INT NOT NULL,
453 selection_depth INT NOT NULL DEFAULT 0,
454 pickup_lib INT NOT NULL REFERENCES actor.org_unit DEFERRABLE INITIALLY DEFERRED,
455 hold_type TEXT REFERENCES config.hold_type (hold_type) DEFERRABLE INITIALLY DEFERRED,
456 holdable_formats TEXT,
458 email_notify BOOL NOT NULL DEFAULT FALSE,
460 sms_carrier INT REFERENCES config.sms_carrier (id),
461 frozen BOOL NOT NULL DEFAULT FALSE,
462 thaw_date TIMESTAMP WITH TIME ZONE,
463 shelf_time TIMESTAMP WITH TIME ZONE,
465 mint_condition BOOL NOT NULL DEFAULT TRUE,
466 shelf_expire_time TIMESTAMPTZ,
467 current_shelf_lib INT REFERENCES actor.org_unit DEFERRABLE INITIALLY DEFERRED,
468 behind_desk BOOLEAN NOT NULL DEFAULT FALSE
470 ALTER TABLE action.hold_request ADD CONSTRAINT sms_check CHECK (
472 OR sms_carrier IS NOT NULL -- and implied sms_notify IS NOT NULL
476 CREATE OR REPLACE FUNCTION action.hold_request_clear_map () RETURNS TRIGGER AS $$
478 DELETE FROM action.hold_copy_map WHERE hold = NEW.id;
483 CREATE TRIGGER hold_request_clear_map_tgr
484 AFTER UPDATE ON action.hold_request
487 (NEW.cancel_time IS NOT NULL AND OLD.cancel_time IS NULL)
488 OR (NEW.fulfillment_time IS NOT NULL AND OLD.fulfillment_time IS NULL)
490 EXECUTE PROCEDURE action.hold_request_clear_map();
492 CREATE INDEX hold_request_target_idx ON action.hold_request (target);
493 CREATE INDEX hold_request_usr_idx ON action.hold_request (usr);
494 CREATE INDEX hold_request_pickup_lib_idx ON action.hold_request (pickup_lib);
495 CREATE INDEX hold_request_current_copy_idx ON action.hold_request (current_copy);
496 CREATE INDEX hold_request_prev_check_time_idx ON action.hold_request (prev_check_time);
497 CREATE INDEX hold_request_fulfillment_staff_idx ON action.hold_request ( fulfillment_staff );
498 CREATE INDEX hold_request_requestor_idx ON action.hold_request ( requestor );
499 CREATE INDEX hold_request_open_idx ON action.hold_request (id) WHERE cancel_time IS NULL AND fulfillment_time IS NULL;
500 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;
501 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;
502 CREATE INDEX hold_request_copy_capture_time_idx ON action.hold_request (current_copy,capture_time);
503 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);
504 CREATE INDEX hold_fulfillment_time_idx ON action.hold_request (fulfillment_time) WHERE fulfillment_time IS NOT NULL;
505 CREATE INDEX hold_request_time_idx ON action.hold_request (request_time);
508 CREATE TABLE action.hold_request_note (
510 id BIGSERIAL PRIMARY KEY,
511 hold BIGINT NOT NULL REFERENCES action.hold_request (id)
513 DEFERRABLE INITIALLY DEFERRED,
516 slip BOOL NOT NULL DEFAULT FALSE,
517 pub BOOL NOT NULL DEFAULT FALSE,
518 staff BOOL NOT NULL DEFAULT FALSE -- created by staff
521 CREATE INDEX ahrn_hold_idx ON action.hold_request_note (hold);
524 CREATE TABLE action.hold_notification (
525 id SERIAL PRIMARY KEY,
526 hold INT NOT NULL REFERENCES action.hold_request (id)
528 DEFERRABLE INITIALLY DEFERRED,
529 notify_staff INT REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
530 notify_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
531 method TEXT NOT NULL, -- email address or phone number
534 CREATE INDEX ahn_hold_idx ON action.hold_notification (hold);
535 CREATE INDEX ahn_notify_staff_idx ON action.hold_notification ( notify_staff );
537 CREATE TABLE action.hold_copy_map (
538 id BIGSERIAL PRIMARY KEY,
539 hold INT NOT NULL REFERENCES action.hold_request (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
540 target_copy BIGINT NOT NULL, -- REFERENCES asset.copy (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED, -- XXX could be an serial.issuance
542 CONSTRAINT copy_once_per_hold UNIQUE (hold,target_copy)
544 -- CREATE INDEX acm_hold_idx ON action.hold_copy_map (hold);
545 CREATE INDEX acm_copy_idx ON action.hold_copy_map (target_copy);
547 CREATE OR REPLACE FUNCTION
548 action.hold_request_regen_copy_maps(
549 hold_id INTEGER, copy_ids INTEGER[]) RETURNS VOID AS $$
550 DELETE FROM action.hold_copy_map WHERE hold = $1;
551 INSERT INTO action.hold_copy_map (hold, target_copy) SELECT $1, UNNEST($2);
554 CREATE TABLE action.transit_copy (
555 id SERIAL PRIMARY KEY,
556 source_send_time TIMESTAMP WITH TIME ZONE,
557 dest_recv_time TIMESTAMP WITH TIME ZONE,
558 target_copy BIGINT NOT NULL, -- REFERENCES asset.copy (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED, -- XXX could be an serial.issuance
559 source INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
560 dest INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
561 prev_hop INT REFERENCES action.transit_copy (id) DEFERRABLE INITIALLY DEFERRED,
562 copy_status INT NOT NULL REFERENCES config.copy_status (id) DEFERRABLE INITIALLY DEFERRED,
563 persistant_transfer BOOL NOT NULL DEFAULT FALSE,
564 prev_dest INT REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
565 cancel_time TIMESTAMP WITH TIME ZONE
567 CREATE INDEX active_transit_dest_idx ON "action".transit_copy (dest);
568 CREATE INDEX active_transit_source_idx ON "action".transit_copy (source);
569 CREATE INDEX active_transit_cp_idx ON "action".transit_copy (target_copy);
570 CREATE INDEX active_transit_for_copy ON action.transit_copy (target_copy)
571 WHERE dest_recv_time IS NULL AND cancel_time IS NULL;
573 -- Check for duplicate transits across all transit types
574 CREATE OR REPLACE FUNCTION action.copy_transit_is_unique()
575 RETURNS TRIGGER AS $func$
577 PERFORM * FROM action.transit_copy
578 WHERE target_copy = NEW.target_copy
579 AND dest_recv_time IS NULL
580 AND cancel_time IS NULL;
583 RAISE EXCEPTION 'Copy id=% is already in transit', NEW.target_copy;
587 $func$ LANGUAGE PLPGSQL STABLE;
589 CREATE CONSTRAINT TRIGGER transit_copy_is_unique_check
590 AFTER INSERT ON action.transit_copy
591 FOR EACH ROW EXECUTE PROCEDURE action.copy_transit_is_unique();
593 CREATE TABLE action.hold_transit_copy (
594 hold INT REFERENCES action.hold_request (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED
595 ) INHERITS (action.transit_copy);
596 ALTER TABLE action.hold_transit_copy ADD PRIMARY KEY (id);
597 -- 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
598 CREATE INDEX active_hold_transit_dest_idx ON "action".hold_transit_copy (dest);
599 CREATE INDEX active_hold_transit_source_idx ON "action".hold_transit_copy (source);
600 CREATE INDEX active_hold_transit_cp_idx ON "action".hold_transit_copy (target_copy);
601 CREATE INDEX hold_transit_copy_hold_idx on action.hold_transit_copy (hold);
603 CREATE CONSTRAINT TRIGGER hold_transit_copy_is_unique_check
604 AFTER INSERT ON action.hold_transit_copy
605 FOR EACH ROW EXECUTE PROCEDURE action.copy_transit_is_unique();
608 CREATE TABLE action.unfulfilled_hold_list (
609 id BIGSERIAL PRIMARY KEY,
610 current_copy BIGINT NOT NULL,
612 circ_lib INT NOT NULL,
613 fail_time TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
615 CREATE INDEX uhr_hold_idx ON action.unfulfilled_hold_list (hold);
617 CREATE OR REPLACE VIEW action.unfulfilled_hold_loops AS
621 FROM action.unfulfilled_hold_list u
622 JOIN asset.copy c ON (c.id = u.current_copy)
625 CREATE OR REPLACE VIEW action.unfulfilled_hold_min_loop AS
628 FROM action.unfulfilled_hold_loops
631 CREATE OR REPLACE VIEW action.unfulfilled_hold_innermost_loop AS
633 FROM action.unfulfilled_hold_loops l
634 JOIN action.unfulfilled_hold_min_loop m USING (hold)
635 WHERE l.count = m.min;
637 CREATE VIEW action.unfulfilled_hold_max_loop AS
640 FROM action.unfulfilled_hold_loops
644 CREATE TABLE action.aged_hold_request (
646 usr_home_ou INT NOT NULL,
647 usr_profile INT NOT NULL,
649 staff_placed BOOLEAN NOT NULL,
650 LIKE action.hold_request
652 ALTER TABLE action.aged_hold_request
653 ADD PRIMARY KEY (id),
655 DROP COLUMN requestor,
656 DROP COLUMN sms_carrier,
657 ALTER COLUMN phone_notify TYPE BOOLEAN
658 USING CASE WHEN phone_notify IS NULL OR phone_notify = '' THEN FALSE ELSE TRUE END,
659 ALTER COLUMN sms_notify TYPE BOOLEAN
660 USING CASE WHEN sms_notify IS NULL OR sms_notify = '' THEN FALSE ELSE TRUE END,
661 ALTER COLUMN phone_notify SET NOT NULL,
662 ALTER COLUMN sms_notify SET NOT NULL;
663 CREATE INDEX aged_hold_request_target_idx ON action.aged_hold_request (target);
664 CREATE INDEX aged_hold_request_pickup_lib_idx ON action.aged_hold_request (pickup_lib);
665 CREATE INDEX aged_hold_request_current_copy_idx ON action.aged_hold_request (current_copy);
666 CREATE INDEX aged_hold_request_fulfillment_staff_idx ON action.aged_hold_request ( fulfillment_staff );
668 CREATE OR REPLACE VIEW action.all_hold_request AS
670 COALESCE(a.post_code, b.post_code) AS usr_post_code,
671 p.home_ou AS usr_home_ou,
672 p.profile AS usr_profile,
673 EXTRACT(YEAR FROM p.dob)::INT AS usr_birth_year,
674 CAST(ahr.requestor <> ahr.usr AS BOOLEAN) AS staff_placed,
678 ahr.fulfillment_time,
688 ahr.fulfillment_staff,
695 ahr.holdable_formats,
697 WHEN ahr.phone_notify IS NULL THEN FALSE
698 WHEN ahr.phone_notify = '' THEN FALSE
703 WHEN ahr.sms_notify IS NULL THEN FALSE
704 WHEN ahr.sms_notify = '' THEN FALSE
712 ahr.shelf_expire_time,
713 ahr.current_shelf_lib,
715 FROM action.hold_request ahr
716 JOIN actor.usr p ON (ahr.usr = p.id)
717 LEFT JOIN actor.usr_address a ON (p.mailing_address = a.id)
718 LEFT JOIN actor.usr_address b ON (p.billing_address = b.id)
758 FROM action.aged_hold_request;
760 CREATE OR REPLACE FUNCTION action.age_hold_on_delete () RETURNS TRIGGER AS $$
763 -- Archive a copy of the old row to action.aged_hold_request
765 INSERT INTO action.aged_hold_request
841 FROM action.all_hold_request WHERE id = OLD.id;
845 $$ LANGUAGE 'plpgsql';
847 CREATE TRIGGER action_hold_request_aging_tgr
848 BEFORE DELETE ON action.hold_request
850 EXECUTE PROCEDURE action.age_hold_on_delete ();
852 CREATE TABLE action.fieldset_group (
853 id SERIAL PRIMARY KEY,
855 create_time TIMESTAMPTZ NOT NULL DEFAULT NOW(),
856 complete_time TIMESTAMPTZ,
857 container INT, -- Points to a container of some type ...
858 container_type TEXT, -- One of 'biblio_record_entry', 'user', 'call_number', 'copy'
859 can_rollback BOOL DEFAULT TRUE,
860 rollback_group INT REFERENCES action.fieldset_group (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
861 rollback_time TIMESTAMPTZ,
862 creator INT NOT NULL REFERENCES actor.usr (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
863 owning_lib INT NOT NULL REFERENCES actor.org_unit (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED
866 CREATE TABLE action.fieldset (
867 id SERIAL PRIMARY KEY,
868 fieldset_group INT REFERENCES action.fieldset_group (id)
869 ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
870 owner INT NOT NULL REFERENCES actor.usr (id)
871 DEFERRABLE INITIALLY DEFERRED,
872 owning_lib INT NOT NULL REFERENCES actor.org_unit (id)
873 DEFERRABLE INITIALLY DEFERRED,
875 CONSTRAINT valid_status CHECK ( status in
876 ( 'PENDING', 'APPLIED', 'ERROR' )),
877 creation_time TIMESTAMPTZ NOT NULL DEFAULT NOW(),
878 scheduled_time TIMESTAMPTZ,
879 applied_time TIMESTAMPTZ,
880 classname TEXT NOT NULL, -- an IDL class name
883 stored_query INT REFERENCES query.stored_query (id)
884 DEFERRABLE INITIALLY DEFERRED,
886 CONSTRAINT lib_name_unique UNIQUE (owning_lib, name),
887 CONSTRAINT fieldset_one_or_the_other CHECK (
888 (stored_query IS NOT NULL AND pkey_value IS NULL) OR
889 (pkey_value IS NOT NULL AND stored_query IS NULL)
891 -- the CHECK constraint means we can update the fields for a single
892 -- row without all the extra overhead involved in a query
895 CREATE INDEX action_fieldset_sched_time_idx ON action.fieldset( scheduled_time );
896 CREATE INDEX action_owner_idx ON action.fieldset( owner );
899 CREATE TABLE action.fieldset_col_val (
900 id SERIAL PRIMARY KEY,
901 fieldset INT NOT NULL REFERENCES action.fieldset
903 DEFERRABLE INITIALLY DEFERRED,
904 col TEXT NOT NULL, -- "field" from the idl ... the column on the table
905 val TEXT, -- value for the column ... NULL means, well, NULL
906 CONSTRAINT fieldset_col_once_per_set UNIQUE (fieldset, col)
910 -- represents a circ chain summary
911 CREATE TYPE action.circ_chain_summary AS (
913 start_time TIMESTAMP WITH TIME ZONE,
914 checkout_workstation TEXT,
915 last_renewal_time TIMESTAMP WITH TIME ZONE, -- NULL if no renewals
916 last_stop_fines TEXT,
917 last_stop_fines_time TIMESTAMP WITH TIME ZONE,
918 last_renewal_workstation TEXT, -- NULL if no renewals
919 last_checkin_workstation TEXT,
920 last_checkin_time TIMESTAMP WITH TIME ZONE,
921 last_checkin_scan_time TIMESTAMP WITH TIME ZONE
925 CREATE OR REPLACE FUNCTION action.circ_chain ( ctx_circ_id BIGINT ) RETURNS SETOF action.circulation AS $$
927 tmp_circ action.circulation%ROWTYPE;
928 circ_0 action.circulation%ROWTYPE;
931 SELECT INTO tmp_circ * FROM action.circulation WHERE id = ctx_circ_id;
933 IF tmp_circ IS NULL THEN
934 RETURN NEXT tmp_circ;
938 -- find the front of the chain
940 SELECT INTO tmp_circ * FROM action.circulation WHERE id = tmp_circ.parent_circ;
941 IF tmp_circ IS NULL THEN
947 -- now send the circs to the caller, oldest to newest
950 IF tmp_circ IS NULL THEN
953 RETURN NEXT tmp_circ;
954 SELECT INTO tmp_circ * FROM action.circulation WHERE parent_circ = tmp_circ.id;
958 $$ LANGUAGE 'plpgsql';
960 CREATE OR REPLACE FUNCTION action.summarize_circ_chain ( ctx_circ_id BIGINT ) RETURNS action.circ_chain_summary AS $$
964 -- first circ in the chain
965 circ_0 action.circulation%ROWTYPE;
967 -- last circ in the chain
968 circ_n action.circulation%ROWTYPE;
970 -- circ chain under construction
971 chain action.circ_chain_summary;
972 tmp_circ action.circulation%ROWTYPE;
976 chain.num_circs := 0;
977 FOR tmp_circ IN SELECT * FROM action.circ_chain(ctx_circ_id) LOOP
979 IF chain.num_circs = 0 THEN
983 chain.num_circs := chain.num_circs + 1;
987 chain.start_time := circ_0.xact_start;
988 chain.last_stop_fines := circ_n.stop_fines;
989 chain.last_stop_fines_time := circ_n.stop_fines_time;
990 chain.last_checkin_time := circ_n.checkin_time;
991 chain.last_checkin_scan_time := circ_n.checkin_scan_time;
992 SELECT INTO chain.checkout_workstation name FROM actor.workstation WHERE id = circ_0.workstation;
993 SELECT INTO chain.last_checkin_workstation name FROM actor.workstation WHERE id = circ_n.checkin_workstation;
995 IF chain.num_circs > 1 THEN
996 chain.last_renewal_time := circ_n.xact_start;
997 SELECT INTO chain.last_renewal_workstation name FROM actor.workstation WHERE id = circ_n.workstation;
1003 $$ LANGUAGE 'plpgsql';
1005 -- same as action.circ_chain, but returns action.all_circulation
1006 -- rows which may include aged circulations.
1007 CREATE OR REPLACE FUNCTION action.all_circ_chain (ctx_circ_id INTEGER)
1008 RETURNS SETOF action.all_circulation_slim AS $$
1010 tmp_circ action.all_circulation_slim%ROWTYPE;
1011 circ_0 action.all_circulation_slim%ROWTYPE;
1014 SELECT INTO tmp_circ * FROM action.all_circulation_slim WHERE id = ctx_circ_id;
1016 IF tmp_circ IS NULL THEN
1017 RETURN NEXT tmp_circ;
1021 -- find the front of the chain
1023 SELECT INTO tmp_circ * FROM action.all_circulation_slim
1024 WHERE id = tmp_circ.parent_circ;
1025 IF tmp_circ IS NULL THEN
1031 -- now send the circs to the caller, oldest to newest
1034 IF tmp_circ IS NULL THEN
1037 RETURN NEXT tmp_circ;
1038 SELECT INTO tmp_circ * FROM action.all_circulation_slim
1039 WHERE parent_circ = tmp_circ.id;
1043 $$ LANGUAGE 'plpgsql';
1045 -- same as action.summarize_circ_chain, but returns data collected
1046 -- from action.all_circulation, which may include aged circulations.
1047 CREATE OR REPLACE FUNCTION action.summarize_all_circ_chain
1048 (ctx_circ_id INTEGER) RETURNS action.circ_chain_summary AS $$
1052 -- first circ in the chain
1053 circ_0 action.all_circulation_slim%ROWTYPE;
1055 -- last circ in the chain
1056 circ_n action.all_circulation_slim%ROWTYPE;
1058 -- circ chain under construction
1059 chain action.circ_chain_summary;
1060 tmp_circ action.all_circulation_slim%ROWTYPE;
1064 chain.num_circs := 0;
1065 FOR tmp_circ IN SELECT * FROM action.all_circ_chain(ctx_circ_id) LOOP
1067 IF chain.num_circs = 0 THEN
1071 chain.num_circs := chain.num_circs + 1;
1075 chain.start_time := circ_0.xact_start;
1076 chain.last_stop_fines := circ_n.stop_fines;
1077 chain.last_stop_fines_time := circ_n.stop_fines_time;
1078 chain.last_checkin_time := circ_n.checkin_time;
1079 chain.last_checkin_scan_time := circ_n.checkin_scan_time;
1080 SELECT INTO chain.checkout_workstation name FROM actor.workstation WHERE id = circ_0.workstation;
1081 SELECT INTO chain.last_checkin_workstation name FROM actor.workstation WHERE id = circ_n.checkin_workstation;
1083 IF chain.num_circs > 1 THEN
1084 chain.last_renewal_time := circ_n.xact_start;
1085 SELECT INTO chain.last_renewal_workstation name FROM actor.workstation WHERE id = circ_n.workstation;
1091 $$ LANGUAGE 'plpgsql';
1093 CREATE OR REPLACE FUNCTION action.usr_visible_holds (usr_id INT) RETURNS SETOF action.hold_request AS $func$
1095 h action.hold_request%ROWTYPE;
1098 usr_view_count actor.usr_setting%ROWTYPE;
1099 usr_view_age actor.usr_setting%ROWTYPE;
1100 usr_view_start actor.usr_setting%ROWTYPE;
1102 SELECT * INTO usr_view_count FROM actor.usr_setting WHERE usr = usr_id AND name = 'history.hold.retention_count';
1103 SELECT * INTO usr_view_age FROM actor.usr_setting WHERE usr = usr_id AND name = 'history.hold.retention_age';
1104 SELECT * INTO usr_view_start FROM actor.usr_setting WHERE usr = usr_id AND name = 'history.hold.retention_start';
1108 FROM action.hold_request
1110 AND fulfillment_time IS NULL
1111 AND cancel_time IS NULL
1112 ORDER BY request_time DESC
1117 IF usr_view_start.value IS NULL THEN
1121 IF usr_view_age.value IS NOT NULL THEN
1122 -- User opted in and supplied a retention age
1123 IF oils_json_to_text(usr_view_age.value)::INTERVAL > AGE(NOW(), oils_json_to_text(usr_view_start.value)::TIMESTAMPTZ) THEN
1124 view_age := AGE(NOW(), oils_json_to_text(usr_view_start.value)::TIMESTAMPTZ);
1126 view_age := oils_json_to_text(usr_view_age.value)::INTERVAL;
1130 view_age := AGE(NOW(), oils_json_to_text(usr_view_start.value)::TIMESTAMPTZ);
1133 IF usr_view_count.value IS NOT NULL THEN
1134 view_count := oils_json_to_text(usr_view_count.value)::INT;
1139 -- show some fulfilled/canceled holds
1142 FROM action.hold_request
1144 AND ( fulfillment_time IS NOT NULL OR cancel_time IS NOT NULL )
1145 AND COALESCE(fulfillment_time, cancel_time) > NOW() - view_age
1146 ORDER BY COALESCE(fulfillment_time, cancel_time) DESC
1154 $func$ LANGUAGE PLPGSQL;
1156 CREATE OR REPLACE FUNCTION action.purge_circulations () RETURNS INT AS $func$
1158 org_keep_age INTERVAL;
1159 org_use_last BOOL = false;
1160 org_age_is_min BOOL = false;
1166 circ_chain_head action.circulation%ROWTYPE;
1167 circ_chain_tail action.circulation%ROWTYPE;
1172 last_finished TIMESTAMP WITH TIME ZONE;
1177 SELECT value::INTERVAL INTO org_keep_age FROM config.global_flag WHERE name = 'history.circ.retention_age' AND enabled;
1179 SELECT value::INT INTO org_keep_count FROM config.global_flag WHERE name = 'history.circ.retention_count' AND enabled;
1180 IF org_keep_count IS NULL THEN
1181 RETURN count_purged; -- Gimme a count to keep, or I keep them all, forever
1184 SELECT enabled INTO org_use_last FROM config.global_flag WHERE name = 'history.circ.retention_uses_last_finished';
1185 SELECT enabled INTO org_age_is_min FROM config.global_flag WHERE name = 'history.circ.retention_age_is_min';
1187 -- First, find copies with more than keep_count non-renewal circs
1190 COUNT(*) AS total_real_circs
1191 FROM action.circulation
1192 WHERE parent_circ IS NULL
1193 AND xact_finish IS NOT NULL
1194 GROUP BY target_copy
1195 HAVING COUNT(*) > org_keep_count
1197 -- And, for those, select circs that are finished and older than keep_age
1198 FOR circ_chain_head IN
1199 -- For reference, the subquery uses a window function to order the circs newest to oldest and number them
1200 -- The outer query then uses that information to skip the most recent set the library wants to keep
1201 -- End result is we don't care what order they come out in, as they are all potentials for deletion.
1202 SELECT ac.* FROM action.circulation ac JOIN (
1203 SELECT rank() OVER (ORDER BY xact_start DESC), ac.id
1204 FROM action.circulation ac
1205 WHERE ac.target_copy = target_acp.target_copy
1206 AND ac.parent_circ IS NULL
1207 ORDER BY ac.xact_start ) ranked USING (id)
1208 WHERE ranked.rank > org_keep_count
1211 SELECT * INTO circ_chain_tail FROM action.circ_chain(circ_chain_head.id) ORDER BY xact_start DESC LIMIT 1;
1212 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);
1213 CONTINUE WHEN circ_chain_tail.xact_finish IS NULL OR num_incomplete > 0;
1215 IF NOT org_use_last THEN
1216 last_finished := circ_chain_tail.xact_finish;
1219 keep_age := COALESCE( org_keep_age, '2000 years'::INTERVAL );
1221 IF org_age_is_min THEN
1222 keep_age := GREATEST( keep_age, org_keep_age );
1225 CONTINUE WHEN AGE(NOW(), last_finished) < keep_age;
1227 -- We've passed the purging tests, purge the circ chain starting at the end
1228 -- A trigger should auto-purge the rest of the chain.
1229 DELETE FROM action.circulation WHERE id = circ_chain_tail.id;
1231 count_purged := count_purged + 1;
1236 return count_purged;
1238 $func$ LANGUAGE PLPGSQL;
1240 CREATE OR REPLACE FUNCTION action.purge_holds() RETURNS INT AS $func$
1242 current_hold RECORD;
1248 user_start TIMESTAMPTZ;
1253 SELECT INTO cgf_d value::INTERVAL FROM config.global_flag WHERE name = 'history.hold.retention_age' AND enabled;
1254 SELECT INTO cgf_f value::INTERVAL FROM config.global_flag WHERE name = 'history.hold.retention_age_fulfilled' AND enabled;
1255 SELECT INTO cgf_c value::INTERVAL FROM config.global_flag WHERE name = 'history.hold.retention_age_canceled' AND enabled;
1258 rank() OVER (PARTITION BY usr ORDER BY COALESCE(fulfillment_time, cancel_time) DESC),
1259 cgf_cs.value::INTERVAL as cgf_cs,
1262 action.hold_request ahr
1263 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)
1265 (fulfillment_time IS NOT NULL OR cancel_time IS NOT NULL)
1267 IF prev_usr IS NULL OR prev_usr != current_hold.usr THEN
1268 prev_usr := current_hold.usr;
1269 SELECT INTO user_start oils_json_to_text(value)::TIMESTAMPTZ FROM actor.usr_setting WHERE usr = prev_usr AND name = 'history.hold.retention_start';
1270 SELECT INTO user_age oils_json_to_text(value)::INTERVAL FROM actor.usr_setting WHERE usr = prev_usr AND name = 'history.hold.retention_age';
1271 SELECT INTO user_count oils_json_to_text(value)::INT FROM actor.usr_setting WHERE usr = prev_usr AND name = 'history.hold.retention_count';
1272 IF user_start IS NOT NULL THEN
1273 user_age := LEAST(user_age, AGE(NOW(), user_start));
1275 IF user_count IS NULL THEN
1276 user_count := 1000; -- Assumption based on the user visible holds routine
1279 -- Library keep age trumps user keep anything, for purposes of being able to hold on to things when staff canceled and such.
1280 IF current_hold.fulfillment_time IS NOT NULL AND current_hold.fulfillment_time > NOW() - COALESCE(cgf_f, cgf_d) THEN
1283 IF current_hold.cancel_time IS NOT NULL AND current_hold.cancel_time > NOW() - COALESCE(current_hold.cgf_cs, cgf_c, cgf_d) THEN
1287 -- User keep age needs combining with count. If too old AND within the count, keep!
1288 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
1292 -- All checks should have passed, delete!
1293 DELETE FROM action.hold_request WHERE id = current_hold.id;
1294 purged_holds := purged_holds + 1;
1296 RETURN purged_holds;
1298 $func$ LANGUAGE plpgsql;
1300 CREATE OR REPLACE FUNCTION action.apply_fieldset(
1301 fieldset_id IN INT, -- id from action.fieldset
1302 table_name IN TEXT, -- table to be updated
1303 pkey_name IN TEXT, -- name of primary key column in that table
1304 query IN TEXT -- query constructed by qstore (for query-based
1305 -- fieldsets only; otherwise null
1321 fs_obj action.fieldset%ROWTYPE;
1322 fs_group action.fieldset_group%ROWTYPE;
1326 IF fieldset_id IS NULL THEN
1327 RETURN 'Fieldset ID parameter is NULL';
1329 IF table_name IS NULL THEN
1330 RETURN 'Table name parameter is NULL';
1332 IF pkey_name IS NULL THEN
1333 RETURN 'Primary key name parameter is NULL';
1338 quote_literal( pkey_value )
1348 -- Build the WHERE clause. This differs according to whether it's a
1349 -- single-row fieldset or a query-based fieldset.
1351 IF query IS NULL AND fs_pkey_value IS NULL THEN
1352 RETURN 'Incomplete fieldset: neither a primary key nor a query available';
1353 ELSIF query IS NOT NULL AND fs_pkey_value IS NULL THEN
1354 fs_query := rtrim( query, ';' );
1355 where_clause := 'WHERE ' || pkey_name || ' IN ( '
1356 || fs_query || ' )';
1357 ELSIF query IS NULL AND fs_pkey_value IS NOT NULL THEN
1358 where_clause := 'WHERE ' || pkey_name || ' = ';
1359 IF pkey_name = 'id' THEN
1360 where_clause := where_clause || fs_pkey_value;
1361 ELSIF pkey_name = 'code' THEN
1362 where_clause := where_clause || quote_literal(fs_pkey_value);
1364 RETURN 'Only know how to handle "id" and "code" pkeys currently, received ' || pkey_name;
1366 ELSE -- both are not null
1367 RETURN 'Ambiguous fieldset: both a primary key and a query provided';
1370 IF fs_status IS NULL THEN
1371 RETURN 'No fieldset found for id = ' || fieldset_id;
1372 ELSIF fs_status = 'APPLIED' THEN
1373 RETURN 'Fieldset ' || fieldset_id || ' has already been applied';
1376 SELECT * INTO fs_obj FROM action.fieldset WHERE id = fieldset_id;
1377 SELECT * INTO fs_group FROM action.fieldset_group WHERE id = fs_obj.fieldset_group;
1379 IF fs_group.can_rollback THEN
1380 -- This is part of a non-rollback group. We need to record the current values for future rollback.
1382 INSERT INTO action.fieldset_group (can_rollback, name, creator, owning_lib, container, container_type)
1383 VALUES (FALSE, 'ROLLBACK: '|| fs_group.name, fs_group.creator, fs_group.owning_lib, fs_group.container, fs_group.container_type);
1385 fsg_id := CURRVAL('action.fieldset_group_id_seq');
1387 FOR rb_row IN EXECUTE 'SELECT * FROM ' || table_name || ' ' || where_clause LOOP
1388 IF pkey_name = 'id' THEN
1389 fs_pkey_value := rb_row.id;
1390 ELSIF pkey_name = 'code' THEN
1391 fs_pkey_value := rb_row.code;
1393 RETURN 'Only know how to handle "id" and "code" pkeys currently, received ' || pkey_name;
1395 INSERT INTO action.fieldset (fieldset_group,owner,owning_lib,status,classname,name,pkey_value)
1396 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);
1398 fs_id := CURRVAL('action.fieldset_id_seq');
1402 FROM action.fieldset_col_val
1403 WHERE fieldset = fieldset_id
1405 EXECUTE 'INSERT INTO action.fieldset_col_val (fieldset, col, val) ' ||
1406 'SELECT '|| fs_id || ', '||quote_literal(cv.col)||', '||cv.col||' FROM '||table_name||' WHERE '||pkey_name||' = '||fs_pkey_value;
1411 statement := 'UPDATE ' || table_name || ' SET';
1417 FROM action.fieldset_col_val
1418 WHERE fieldset = fieldset_id
1420 statement := statement || sep || ' ' || cv.col
1421 || ' = ' || coalesce( quote_literal( cv.val ), 'NULL' );
1426 RETURN 'Fieldset ' || fieldset_id || ' has no column values defined';
1428 statement := statement || ' ' || where_clause;
1431 -- Execute the update
1435 GET DIAGNOSTICS update_count = ROW_COUNT;
1437 IF update_count = 0 THEN
1438 RAISE data_exception;
1441 IF fsg_id IS NOT NULL THEN
1442 UPDATE action.fieldset_group SET rollback_group = fsg_id WHERE id = fs_group.id;
1445 IF fs_group.id IS NOT NULL THEN
1446 UPDATE action.fieldset_group SET complete_time = now() WHERE id = fs_group.id;
1449 UPDATE action.fieldset SET status = 'APPLIED', applied_time = now() WHERE id = fieldset_id;
1451 EXCEPTION WHEN data_exception THEN
1452 msg := 'No eligible rows found for fieldset ' || fieldset_id;
1453 UPDATE action.fieldset SET status = 'ERROR', applied_time = now() WHERE id = fieldset_id;
1460 EXCEPTION WHEN OTHERS THEN
1461 msg := 'Unable to apply fieldset ' || fieldset_id || ': ' || sqlerrm;
1462 UPDATE action.fieldset SET status = 'ERROR', applied_time = now() WHERE id = fieldset_id;
1466 $$ LANGUAGE plpgsql;
1468 COMMENT ON FUNCTION action.apply_fieldset( INT, TEXT, TEXT, TEXT ) IS $$
1469 Applies a specified fieldset, using a supplied table name and primary
1470 key name. The query parameter should be non-null only for
1471 query-based fieldsets.
1473 Returns NULL if successful, or an error message if not.
1476 CREATE OR REPLACE FUNCTION action.hold_copy_calculated_proximity(
1479 copy_context_ou INT DEFAULT NULL
1480 -- TODO maybe? hold_context_ou INT DEFAULT NULL. This would optionally
1481 -- support an "ahprox" measurement: adjust prox between copy circ lib and
1482 -- hold request lib, but I'm unsure whether to use this theoretical
1483 -- argument only in the baseline calculation or later in the other
1484 -- queries in this function.
1485 ) RETURNS NUMERIC AS $f$
1487 aoupa actor.org_unit_proximity_adjustment%ROWTYPE;
1488 ahr action.hold_request%ROWTYPE;
1489 acp asset.copy%ROWTYPE;
1490 acn asset.call_number%ROWTYPE;
1491 acl asset.copy_location%ROWTYPE;
1492 baseline_prox NUMERIC;
1502 SELECT * INTO ahr FROM action.hold_request WHERE id = ahr_id;
1503 SELECT * INTO acp FROM asset.copy WHERE id = acp_id;
1504 SELECT * INTO acn FROM asset.call_number WHERE id = acp.call_number;
1505 SELECT * INTO acl FROM asset.copy_location WHERE id = acp.location;
1507 IF copy_context_ou IS NULL THEN
1508 copy_context_ou := acp.circ_lib;
1511 -- First, gather the baseline proximity of "here" to pickup lib
1512 SELECT prox INTO baseline_prox FROM actor.org_unit_proximity WHERE from_org = copy_context_ou AND to_org = ahr.pickup_lib;
1514 -- Find any absolute adjustments, and set the baseline prox to that
1515 SELECT adj.* INTO aoupa
1516 FROM actor.org_unit_proximity_adjustment adj
1517 LEFT JOIN actor.org_unit_ancestors_distance(copy_context_ou) acp_cl ON (acp_cl.id = adj.item_circ_lib)
1518 LEFT JOIN actor.org_unit_ancestors_distance(acn.owning_lib) acn_ol ON (acn_ol.id = adj.item_owning_lib)
1519 LEFT JOIN actor.org_unit_ancestors_distance(acl.owning_lib) acl_ol ON (acl_ol.id = adj.copy_location)
1520 LEFT JOIN actor.org_unit_ancestors_distance(ahr.pickup_lib) ahr_pl ON (ahr_pl.id = adj.hold_pickup_lib)
1521 LEFT JOIN actor.org_unit_ancestors_distance(ahr.request_lib) ahr_rl ON (ahr_rl.id = adj.hold_request_lib)
1522 WHERE (adj.circ_mod IS NULL OR adj.circ_mod = acp.circ_modifier) AND
1523 (adj.item_circ_lib IS NULL OR adj.item_circ_lib = acp_cl.id) AND
1524 (adj.item_owning_lib IS NULL OR adj.item_owning_lib = acn_ol.id) AND
1525 (adj.copy_location IS NULL OR adj.copy_location = acl_ol.id) AND
1526 (adj.hold_pickup_lib IS NULL OR adj.hold_pickup_lib = ahr_pl.id) AND
1527 (adj.hold_request_lib IS NULL OR adj.hold_request_lib = ahr_rl.id) AND
1528 absolute_adjustment AND
1529 COALESCE(acp_cl.id, acn_ol.id, acl_ol.id, ahr_pl.id, ahr_rl.id) IS NOT NULL
1531 COALESCE(acp_cl.distance,999)
1532 + COALESCE(acn_ol.distance,999)
1533 + COALESCE(acl_ol.distance,999)
1534 + COALESCE(ahr_pl.distance,999)
1535 + COALESCE(ahr_rl.distance,999),
1540 baseline_prox := aoupa.prox_adjustment;
1543 -- Now find any relative adjustments, and change the baseline prox based on them
1546 FROM actor.org_unit_proximity_adjustment adj
1547 LEFT JOIN actor.org_unit_ancestors_distance(copy_context_ou) acp_cl ON (acp_cl.id = adj.item_circ_lib)
1548 LEFT JOIN actor.org_unit_ancestors_distance(acn.owning_lib) acn_ol ON (acn_ol.id = adj.item_owning_lib)
1549 LEFT JOIN actor.org_unit_ancestors_distance(acl.owning_lib) acl_ol ON (acn_ol.id = adj.copy_location)
1550 LEFT JOIN actor.org_unit_ancestors_distance(ahr.pickup_lib) ahr_pl ON (ahr_pl.id = adj.hold_pickup_lib)
1551 LEFT JOIN actor.org_unit_ancestors_distance(ahr.request_lib) ahr_rl ON (ahr_rl.id = adj.hold_request_lib)
1552 WHERE (adj.circ_mod IS NULL OR adj.circ_mod = acp.circ_modifier) AND
1553 (adj.item_circ_lib IS NULL OR adj.item_circ_lib = acp_cl.id) AND
1554 (adj.item_owning_lib IS NULL OR adj.item_owning_lib = acn_ol.id) AND
1555 (adj.copy_location IS NULL OR adj.copy_location = acl_ol.id) AND
1556 (adj.hold_pickup_lib IS NULL OR adj.hold_pickup_lib = ahr_pl.id) AND
1557 (adj.hold_request_lib IS NULL OR adj.hold_request_lib = ahr_rl.id) AND
1558 NOT absolute_adjustment AND
1559 COALESCE(acp_cl.id, acn_ol.id, acl_ol.id, ahr_pl.id, ahr_rl.id) IS NOT NULL
1561 baseline_prox := baseline_prox + aoupa.prox_adjustment;
1564 RETURN baseline_prox;
1566 $f$ LANGUAGE PLPGSQL;
1568 CREATE OR REPLACE FUNCTION action.hold_copy_calculated_proximity_update () RETURNS TRIGGER AS $f$
1570 NEW.proximity := action.hold_copy_calculated_proximity(NEW.hold,NEW.target_copy);
1573 $f$ LANGUAGE PLPGSQL;
1575 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 ();
1577 CREATE TABLE action.usr_circ_history (
1578 id BIGSERIAL PRIMARY KEY,
1579 usr INTEGER NOT NULL REFERENCES actor.usr(id)
1580 DEFERRABLE INITIALLY DEFERRED,
1581 xact_start TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
1582 target_copy BIGINT NOT NULL, -- asset.copy.id / serial.unit.id
1583 due_date TIMESTAMP WITH TIME ZONE NOT NULL,
1584 checkin_time TIMESTAMP WITH TIME ZONE,
1585 source_circ BIGINT REFERENCES action.circulation(id)
1586 ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED
1589 CREATE INDEX action_usr_circ_history_usr_idx ON action.usr_circ_history ( usr );
1590 CREATE INDEX action_usr_circ_history_source_circ_idx ON action.usr_circ_history ( source_circ );
1592 CREATE TRIGGER action_usr_circ_history_target_copy_trig
1593 AFTER INSERT OR UPDATE ON action.usr_circ_history
1594 FOR EACH ROW EXECUTE PROCEDURE evergreen.fake_fkey_tgr('target_copy');
1596 CREATE OR REPLACE FUNCTION action.maintain_usr_circ_history()
1597 RETURNS TRIGGER AS $FUNK$
1603 -- Any retention value signifies history is enabled.
1604 -- This assumes that clearing these values via external
1605 -- process deletes the action.usr_circ_history rows.
1606 -- TODO: replace these settings w/ a single bool setting?
1607 PERFORM 1 FROM actor.usr_setting
1608 WHERE usr = NEW.usr AND value IS NOT NULL AND name IN (
1609 'history.circ.retention_age',
1610 'history.circ.retention_start'
1617 IF TG_OP = 'INSERT' AND NEW.parent_circ IS NULL THEN
1618 -- Starting a new circulation. Insert the history row.
1619 INSERT INTO action.usr_circ_history
1620 (usr, xact_start, target_copy, due_date, source_circ)
1632 -- find the first and last circs in the circ chain
1633 -- for the currently modified circ.
1634 FOR cur_circ IN SELECT id FROM action.circ_chain(NEW.id) LOOP
1635 IF first_circ IS NULL THEN
1636 first_circ := cur_circ;
1639 -- Allow the loop to continue so that at as the loop
1640 -- completes cur_circ points to the final circulation.
1643 IF NEW.id <> cur_circ THEN
1644 -- Modifying an intermediate circ. Ignore it.
1648 -- Update the due_date/checkin_time on the history row if the current
1649 -- circ is the last circ in the chain and an update is warranted.
1651 UPDATE action.usr_circ_history
1653 due_date = NEW.due_date,
1654 checkin_time = NEW.checkin_time
1656 source_circ = first_circ
1658 due_date <> NEW.due_date OR (
1659 (checkin_time IS NULL AND NEW.checkin_time IS NOT NULL) OR
1660 (checkin_time IS NOT NULL AND NEW.checkin_time IS NULL) OR
1661 (checkin_time <> NEW.checkin_time)
1666 $FUNK$ LANGUAGE PLPGSQL;
1668 CREATE TRIGGER maintain_usr_circ_history_tgr
1669 AFTER INSERT OR UPDATE ON action.circulation
1670 FOR EACH ROW EXECUTE PROCEDURE action.maintain_usr_circ_history();
1672 CREATE OR REPLACE VIEW action.all_circulation_combined_types AS
1673 SELECT acirc.id AS id,
1678 ac_acirc.circ_modifier AS item_type,
1679 'regular_circ'::text AS circ_type
1680 FROM action.circulation acirc,
1682 WHERE acirc.target_copy = ac_acirc.id
1684 SELECT ancc.id::BIGINT AS id,
1685 ancc.circ_time AS xact_start,
1687 ancc.staff AS circ_staff,
1688 ancc.circ_time AS create_time,
1689 cnct_ancc.name AS item_type,
1690 'non-cat_circ'::text AS circ_type
1691 FROM action.non_cataloged_circulation ancc,
1692 config.non_cataloged_type cnct_ancc
1693 WHERE ancc.item_type = cnct_ancc.id
1695 SELECT aihu.id::BIGINT AS id,
1696 aihu.use_time AS xact_start,
1697 aihu.org_unit AS circ_lib,
1698 aihu.staff AS circ_staff,
1699 aihu.use_time AS create_time,
1700 ac_aihu.circ_modifier AS item_type,
1701 'in-house_use'::text AS circ_type
1702 FROM action.in_house_use aihu,
1704 WHERE aihu.item = ac_aihu.id
1706 SELECT ancihu.id::BIGINT AS id,
1707 ancihu.use_time AS xact_start,
1708 ancihu.org_unit AS circ_lib,
1709 ancihu.staff AS circ_staff,
1710 ancihu.use_time AS create_time,
1711 cnct_ancihu.name AS item_type,
1712 'non-cat_circ'::text AS circ_type
1713 FROM action.non_cat_in_house_use ancihu,
1714 config.non_cataloged_type cnct_ancihu
1715 WHERE ancihu.item_type = cnct_ancihu.id
1717 SELECT aacirc.id AS id,
1722 ac_aacirc.circ_modifier AS item_type,
1723 'aged_circ'::text AS circ_type
1724 FROM action.aged_circulation aacirc,
1725 asset.copy ac_aacirc
1726 WHERE aacirc.target_copy = ac_aacirc.id;