Observed speed increases through judicious indexing
[working/Evergreen.git] / Open-ILS / src / sql / Pg / 090.schema.action.sql
1 /*
2  * Copyright (C) 2004-2008  Georgia Public Library Service
3  * Copyright (C) 2007-2008  Equinox Software, Inc.
4  * Mike Rylander <miker@esilibrary.com> 
5  *
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.
10  *
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.
15  *
16  */
17
18 DROP SCHEMA IF EXISTS action CASCADE;
19
20 BEGIN;
21
22 CREATE SCHEMA action;
23
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()
30 );
31 CREATE INDEX action_in_house_use_staff_idx      ON action.in_house_use ( staff );
32
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()
40 );
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 );
43
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()
50 );
51 CREATE INDEX non_cat_in_house_use_staff_idx ON action.non_cat_in_house_use ( staff );
52
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,
62         name            TEXT                            NOT NULL,
63         description     TEXT                            NOT NULL
64 );
65 CREATE UNIQUE INDEX asv_once_per_owner_idx ON action.survey (owner,name);
66
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
71 );
72
73 CREATE TABLE action.survey_answer (
74         id              SERIAL  PRIMARY KEY,
75         question        INT     NOT NULL REFERENCES action.survey_question DEFERRABLE INITIALLY DEFERRED,
76         answer          TEXT    NOT NULL
77 );
78
79 CREATE SEQUENCE action.survey_response_group_id_seq;
80
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()
90 );
91 CREATE INDEX action_survey_response_usr_idx ON action.survey_response ( usr );
92
93 CREATE OR REPLACE FUNCTION action.survey_response_answer_date_fixup () RETURNS TRIGGER AS '
94 BEGIN
95         NEW.answer_date := NOW();
96         RETURN NEW;
97 END;
98 ' LANGUAGE 'plpgsql';
99 CREATE TRIGGER action_survey_response_answer_date_fixup_tgr
100         BEFORE INSERT ON action.survey_response
101         FOR EACH ROW
102         EXECUTE PROCEDURE action.survey_response_answer_date_fixup ();
103
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,
108     value       TEXT        NOT NULL
109 );
110
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,
115     value       TEXT        NOT NULL
116 );
117
118
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)
144                                        ON DELETE SET NULL
145                                                                    DEFERRABLE INITIALLY DEFERRED,
146         checkin_workstation INT        REFERENCES actor.workstation(id)
147                                        ON DELETE SET NULL
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 ) INHERITS (money.billable_xact);
152 ALTER TABLE action.circulation ADD PRIMARY KEY (id);
153 ALTER TABLE action.circulation
154         ADD COLUMN parent_circ BIGINT
155         REFERENCES action.circulation( id )
156         DEFERRABLE INITIALLY DEFERRED;
157 CREATE INDEX circ_open_xacts_idx ON action.circulation (usr) WHERE xact_finish IS NULL;
158 CREATE INDEX circ_outstanding_idx ON action.circulation (usr) WHERE checkin_time IS NULL;
159 CREATE INDEX circ_checkin_time ON "action".circulation (checkin_time) WHERE checkin_time IS NOT NULL;
160 CREATE INDEX circ_circ_lib_idx ON "action".circulation (circ_lib);
161 CREATE INDEX circ_open_date_idx ON "action".circulation (xact_start) WHERE xact_finish IS NULL;
162 CREATE INDEX circ_all_usr_idx       ON action.circulation ( usr );
163 CREATE INDEX circ_circ_staff_idx    ON action.circulation ( circ_staff );
164 CREATE INDEX circ_checkin_staff_idx ON action.circulation ( checkin_staff );
165 CREATE INDEX action_circulation_target_copy_idx ON action.circulation (target_copy);
166 CREATE UNIQUE INDEX circ_parent_idx ON action.circulation ( parent_circ ) WHERE parent_circ IS NOT NULL;
167 CREATE UNIQUE INDEX only_one_concurrent_checkout_per_copy ON action.circulation(target_copy) WHERE checkin_time IS NULL;
168
169 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');
170
171 CREATE TRIGGER mat_summary_create_tgr AFTER INSERT ON action.circulation FOR EACH ROW EXECUTE PROCEDURE money.mat_summary_create ('circulation');
172 CREATE TRIGGER mat_summary_change_tgr AFTER UPDATE ON action.circulation FOR EACH ROW EXECUTE PROCEDURE money.mat_summary_update ();
173 CREATE TRIGGER mat_summary_remove_tgr AFTER DELETE ON action.circulation FOR EACH ROW EXECUTE PROCEDURE money.mat_summary_delete ();
174
175 CREATE OR REPLACE FUNCTION action.push_circ_due_time () RETURNS TRIGGER AS $$
176 BEGIN
177     IF (EXTRACT(EPOCH FROM NEW.duration)::INT % EXTRACT(EPOCH FROM '1 day'::INTERVAL)::INT) = 0 THEN
178         NEW.due_date = (NEW.due_date::DATE + '1 day'::INTERVAL - '1 second'::INTERVAL)::TIMESTAMPTZ;
179     END IF;
180
181     RETURN NEW;
182 END;
183 $$ LANGUAGE PLPGSQL;
184
185 CREATE TRIGGER push_due_date_tgr BEFORE INSERT OR UPDATE ON action.circulation FOR EACH ROW EXECUTE PROCEDURE action.push_circ_due_time();
186
187 CREATE OR REPLACE FUNCTION action.fill_circ_copy_location () RETURNS TRIGGER AS $$
188 BEGIN
189     SELECT INTO NEW.copy_location location FROM asset.copy WHERE id = NEW.target_copy;
190     RETURN NEW;
191 END;
192 $$ LANGUAGE PLPGSQL;
193
194 CREATE TRIGGER fill_circ_copy_location_tgr BEFORE INSERT ON action.circulation FOR EACH ROW EXECUTE PROCEDURE action.fill_circ_copy_location();
195
196 CREATE OR REPLACE FUNCTION action.archive_stat_cats () RETURNS TRIGGER AS $$
197 BEGIN
198     INSERT INTO action.archive_actor_stat_cat(xact, stat_cat, value)
199         SELECT NEW.id, asceum.stat_cat, asceum.stat_cat_entry
200         FROM actor.stat_cat_entry_usr_map asceum
201              JOIN actor.stat_cat sc ON asceum.stat_cat = sc.id
202         WHERE NEW.usr = asceum.target_usr AND sc.checkout_archive;
203     INSERT INTO action.archive_asset_stat_cat(xact, stat_cat, value)
204         SELECT NEW.id, ascecm.stat_cat, asce.value
205         FROM asset.stat_cat_entry_copy_map ascecm
206              JOIN asset.stat_cat sc ON ascecm.stat_cat = sc.id
207              JOIN asset.stat_cat_entry asce ON ascecm.stat_cat_entry = asce.id
208         WHERE NEW.target_copy = ascecm.owning_copy AND sc.checkout_archive;
209     RETURN NULL;
210 END;
211 $$ LANGUAGE PLPGSQL;
212
213 CREATE TRIGGER archive_stat_cats_tgr AFTER INSERT ON action.circulation FOR EACH ROW EXECUTE PROCEDURE action.archive_stat_cats();
214
215 CREATE TABLE action.aged_circulation (
216         usr_post_code           TEXT,
217         usr_home_ou             INT     NOT NULL,
218         usr_profile             INT     NOT NULL,
219         usr_birth_year          INT,
220         copy_call_number        INT     NOT NULL,
221         copy_owning_lib         INT     NOT NULL,
222         copy_circ_lib           INT     NOT NULL,
223         copy_bib_record         BIGINT  NOT NULL,
224         LIKE action.circulation
225
226 );
227 ALTER TABLE action.aged_circulation ADD PRIMARY KEY (id);
228 ALTER TABLE action.aged_circulation DROP COLUMN usr;
229 CREATE INDEX aged_circ_circ_lib_idx ON "action".aged_circulation (circ_lib);
230 CREATE INDEX aged_circ_start_idx ON "action".aged_circulation (xact_start);
231 CREATE INDEX aged_circ_copy_circ_lib_idx ON "action".aged_circulation (copy_circ_lib);
232 CREATE INDEX aged_circ_copy_owning_lib_idx ON "action".aged_circulation (copy_owning_lib);
233 CREATE INDEX aged_circ_copy_location_idx ON "action".aged_circulation (copy_location);
234 CREATE INDEX action_aged_circulation_target_copy_idx ON action.aged_circulation (target_copy);
235
236 CREATE OR REPLACE VIEW action.all_circulation AS
237     SELECT  id,usr_post_code, usr_home_ou, usr_profile, usr_birth_year, copy_call_number, copy_location,
238         copy_owning_lib, copy_circ_lib, copy_bib_record, xact_start, xact_finish, target_copy,
239         circ_lib, circ_staff, checkin_staff, checkin_lib, renewal_remaining, grace_period, due_date,
240         stop_fines_time, checkin_time, create_time, duration, fine_interval, recurring_fine,
241         max_fine, phone_renewal, desk_renewal, opac_renewal, duration_rule, recurring_fine_rule,
242         max_fine_rule, stop_fines, workstation, checkin_workstation, checkin_scan_time, parent_circ
243       FROM  action.aged_circulation
244             UNION ALL
245     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,
246         cp.call_number AS copy_call_number, circ.copy_location, cn.owning_lib AS copy_owning_lib, cp.circ_lib AS copy_circ_lib,
247         cn.record AS copy_bib_record, circ.xact_start, circ.xact_finish, circ.target_copy, circ.circ_lib, circ.circ_staff, circ.checkin_staff,
248         circ.checkin_lib, circ.renewal_remaining, circ.grace_period, circ.due_date, circ.stop_fines_time, circ.checkin_time, circ.create_time, circ.duration,
249         circ.fine_interval, circ.recurring_fine, circ.max_fine, circ.phone_renewal, circ.desk_renewal, circ.opac_renewal, circ.duration_rule,
250         circ.recurring_fine_rule, circ.max_fine_rule, circ.stop_fines, circ.workstation, circ.checkin_workstation, circ.checkin_scan_time,
251         circ.parent_circ
252       FROM  action.circulation circ
253         JOIN asset.copy cp ON (circ.target_copy = cp.id)
254         JOIN asset.call_number cn ON (cp.call_number = cn.id)
255         JOIN actor.usr p ON (circ.usr = p.id)
256         LEFT JOIN actor.usr_address a ON (p.mailing_address = a.id)
257         LEFT JOIN actor.usr_address b ON (p.billing_address = b.id);
258
259 CREATE OR REPLACE FUNCTION action.age_circ_on_delete () RETURNS TRIGGER AS $$
260 DECLARE
261 found char := 'N';
262 BEGIN
263
264     -- If there are any renewals for this circulation, don't archive or delete
265     -- it yet.   We'll do so later, when we archive and delete the renewals.
266
267     SELECT 'Y' INTO found
268     FROM action.circulation
269     WHERE parent_circ = OLD.id
270     LIMIT 1;
271
272     IF found = 'Y' THEN
273         RETURN NULL;  -- don't delete
274         END IF;
275
276     -- Archive a copy of the old row to action.aged_circulation
277
278     INSERT INTO action.aged_circulation
279         (id,usr_post_code, usr_home_ou, usr_profile, usr_birth_year, copy_call_number, copy_location,
280         copy_owning_lib, copy_circ_lib, copy_bib_record, xact_start, xact_finish, target_copy,
281         circ_lib, circ_staff, checkin_staff, checkin_lib, renewal_remaining, grace_period, due_date,
282         stop_fines_time, checkin_time, create_time, duration, fine_interval, recurring_fine,
283         max_fine, phone_renewal, desk_renewal, opac_renewal, duration_rule, recurring_fine_rule,
284         max_fine_rule, stop_fines, workstation, checkin_workstation, checkin_scan_time, parent_circ)
285       SELECT
286         id,usr_post_code, usr_home_ou, usr_profile, usr_birth_year, copy_call_number, copy_location,
287         copy_owning_lib, copy_circ_lib, copy_bib_record, xact_start, xact_finish, target_copy,
288         circ_lib, circ_staff, checkin_staff, checkin_lib, renewal_remaining, grace_period, due_date,
289         stop_fines_time, checkin_time, create_time, duration, fine_interval, recurring_fine,
290         max_fine, phone_renewal, desk_renewal, opac_renewal, duration_rule, recurring_fine_rule,
291         max_fine_rule, stop_fines, workstation, checkin_workstation, checkin_scan_time, parent_circ
292         FROM action.all_circulation WHERE id = OLD.id;
293
294     RETURN OLD;
295 END;
296 $$ LANGUAGE 'plpgsql';
297
298 CREATE TRIGGER action_circulation_aging_tgr
299         BEFORE DELETE ON action.circulation
300         FOR EACH ROW
301         EXECUTE PROCEDURE action.age_circ_on_delete ();
302
303
304 CREATE OR REPLACE FUNCTION action.age_parent_circ_on_delete () RETURNS TRIGGER AS $$
305 BEGIN
306
307     -- Having deleted a renewal, we can delete the original circulation (or a previous
308     -- renewal, if that's what parent_circ is pointing to).  That deletion will trigger
309     -- deletion of any prior parents, etc. recursively.
310
311     IF OLD.parent_circ IS NOT NULL THEN
312         DELETE FROM action.circulation
313         WHERE id = OLD.parent_circ;
314     END IF;
315
316     RETURN OLD;
317 END;
318 $$ LANGUAGE 'plpgsql';
319
320 CREATE TRIGGER age_parent_circ
321         AFTER DELETE ON action.circulation
322         FOR EACH ROW
323         EXECUTE PROCEDURE action.age_parent_circ_on_delete ();
324
325
326 CREATE OR REPLACE VIEW action.open_circulation AS
327         SELECT  *
328           FROM  action.circulation
329           WHERE checkin_time IS NULL
330           ORDER BY due_date;
331                 
332
333 CREATE OR REPLACE VIEW action.billable_circulations AS
334         SELECT  *
335           FROM  action.circulation
336           WHERE xact_finish IS NULL;
337
338 CREATE OR REPLACE FUNCTION action.circulation_claims_returned () RETURNS TRIGGER AS $$
339 BEGIN
340         IF OLD.stop_fines IS NULL OR OLD.stop_fines <> NEW.stop_fines THEN
341                 IF NEW.stop_fines = 'CLAIMSRETURNED' THEN
342                         UPDATE actor.usr SET claims_returned_count = claims_returned_count + 1 WHERE id = NEW.usr;
343                 END IF;
344                 IF NEW.stop_fines = 'CLAIMSNEVERCHECKEDOUT' THEN
345                         UPDATE actor.usr SET claims_never_checked_out_count = claims_never_checked_out_count + 1 WHERE id = NEW.usr;
346                 END IF;
347                 IF NEW.stop_fines = 'LOST' THEN
348                         UPDATE asset.copy SET status = 3 WHERE id = NEW.target_copy;
349                 END IF;
350         END IF;
351         RETURN NEW;
352 END;
353 $$ LANGUAGE 'plpgsql';
354 CREATE TRIGGER action_circulation_stop_fines_tgr
355         BEFORE UPDATE ON action.circulation
356         FOR EACH ROW
357         EXECUTE PROCEDURE action.circulation_claims_returned ();
358
359 CREATE TABLE action.hold_request_cancel_cause (
360     id      SERIAL  PRIMARY KEY,
361     label   TEXT    UNIQUE
362 );
363 INSERT INTO action.hold_request_cancel_cause (id,label) VALUES (1,'Untargeted expiration');
364 INSERT INTO action.hold_request_cancel_cause (id,label) VALUES (2,'Hold Shelf expiration');
365 INSERT INTO action.hold_request_cancel_cause (id,label) VALUES (3,'Patron via phone');
366 INSERT INTO action.hold_request_cancel_cause (id,label) VALUES (4,'Patron in person');
367 INSERT INTO action.hold_request_cancel_cause (id,label) VALUES (5,'Staff forced');
368 INSERT INTO action.hold_request_cancel_cause (id,label) VALUES (6,'Patron via OPAC');
369 SELECT SETVAL('action.hold_request_cancel_cause_id_seq', 100);
370
371 CREATE TABLE action.hold_request (
372         id                      SERIAL                          PRIMARY KEY,
373         request_time            TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW(),
374         capture_time            TIMESTAMP WITH TIME ZONE,
375         fulfillment_time        TIMESTAMP WITH TIME ZONE,
376         checkin_time            TIMESTAMP WITH TIME ZONE,
377         return_time             TIMESTAMP WITH TIME ZONE,
378         prev_check_time         TIMESTAMP WITH TIME ZONE,
379         expire_time             TIMESTAMP WITH TIME ZONE,
380         cancel_time             TIMESTAMP WITH TIME ZONE,
381         cancel_cause    INT REFERENCES action.hold_request_cancel_cause (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
382         cancel_note             TEXT,
383         target                  BIGINT                          NOT NULL, -- see hold_type
384         current_copy            BIGINT,                         -- REFERENCES asset.copy (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,  -- XXX could be an serial.unit now...
385         fulfillment_staff       INT                             REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
386         fulfillment_lib         INT                             REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
387         request_lib             INT                             NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
388         requestor               INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
389         usr                     INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
390         selection_ou            INT                             NOT NULL,
391         selection_depth         INT                             NOT NULL DEFAULT 0,
392         pickup_lib              INT                             NOT NULL REFERENCES actor.org_unit DEFERRABLE INITIALLY DEFERRED,
393         hold_type               TEXT                            NOT NULL, -- CHECK (hold_type IN ('M','T','V','C')),  -- XXX constraint too constraining...
394         holdable_formats        TEXT,
395         phone_notify            TEXT,
396         email_notify            BOOL                            NOT NULL DEFAULT FALSE,
397         sms_notify              TEXT,
398         sms_carrier             INT REFERENCES config.sms_carrier (id),
399         frozen                  BOOL                            NOT NULL DEFAULT FALSE,
400         thaw_date               TIMESTAMP WITH TIME ZONE,
401         shelf_time              TIMESTAMP WITH TIME ZONE,
402     cut_in_line     BOOL,
403         mint_condition  BOOL NOT NULL DEFAULT TRUE,
404         shelf_expire_time TIMESTAMPTZ,
405         current_shelf_lib INT REFERENCES actor.org_unit DEFERRABLE INITIALLY DEFERRED
406 );
407 ALTER TABLE action.hold_request ADD CONSTRAINT sms_check CHECK (
408     sms_notify IS NULL
409     OR sms_carrier IS NOT NULL -- and implied sms_notify IS NOT NULL
410 );
411
412
413 CREATE INDEX hold_request_target_idx ON action.hold_request (target);
414 CREATE INDEX hold_request_usr_idx ON action.hold_request (usr);
415 CREATE INDEX hold_request_pickup_lib_idx ON action.hold_request (pickup_lib);
416 CREATE INDEX hold_request_current_copy_idx ON action.hold_request (current_copy);
417 CREATE INDEX hold_request_prev_check_time_idx ON action.hold_request (prev_check_time);
418 CREATE INDEX hold_request_fulfillment_staff_idx ON action.hold_request ( fulfillment_staff );
419 CREATE INDEX hold_request_requestor_idx         ON action.hold_request ( requestor );
420 CREATE INDEX hold_request_open_idx ON action.hold_request (id) WHERE cancel_time IS NULL AND fulfillment_time IS NULL;
421 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;
422
423
424 CREATE TABLE action.hold_request_note (
425
426     id     BIGSERIAL PRIMARY KEY,
427     hold   BIGINT    NOT NULL REFERENCES action.hold_request (id)
428                               ON DELETE CASCADE
429                               DEFERRABLE INITIALLY DEFERRED,
430     title  TEXT      NOT NULL,
431     body   TEXT      NOT NULL,
432     slip   BOOL      NOT NULL DEFAULT FALSE,
433     pub    BOOL      NOT NULL DEFAULT FALSE,
434     staff  BOOL      NOT NULL DEFAULT FALSE  -- created by staff
435
436 );
437 CREATE INDEX ahrn_hold_idx ON action.hold_request_note (hold);
438
439
440 CREATE TABLE action.hold_notification (
441         id              SERIAL                          PRIMARY KEY,
442         hold            INT                             NOT NULL REFERENCES action.hold_request (id)
443                                                                         ON DELETE CASCADE
444                                                                         DEFERRABLE INITIALLY DEFERRED,
445         notify_staff    INT                     REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
446         notify_time     TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW(),
447         method          TEXT                            NOT NULL, -- email address or phone number
448         note            TEXT
449 );
450 CREATE INDEX ahn_hold_idx ON action.hold_notification (hold);
451 CREATE INDEX ahn_notify_staff_idx ON action.hold_notification ( notify_staff );
452
453 CREATE TABLE action.hold_copy_map (
454         id              BIGSERIAL       PRIMARY KEY,
455         hold            INT     NOT NULL REFERENCES action.hold_request (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
456         target_copy     BIGINT  NOT NULL, -- REFERENCES asset.copy (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED, -- XXX could be an serial.issuance
457         proximity       NUMERIC,
458         CONSTRAINT copy_once_per_hold UNIQUE (hold,target_copy)
459 );
460 -- CREATE INDEX acm_hold_idx ON action.hold_copy_map (hold);
461 CREATE INDEX acm_copy_idx ON action.hold_copy_map (target_copy);
462
463 CREATE TABLE action.transit_copy (
464         id                      SERIAL                          PRIMARY KEY,
465         source_send_time        TIMESTAMP WITH TIME ZONE,
466         dest_recv_time          TIMESTAMP WITH TIME ZONE,
467         target_copy             BIGINT                          NOT NULL, -- REFERENCES asset.copy (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED, -- XXX could be an serial.issuance
468         source                  INT                             NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
469         dest                    INT                             NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
470         prev_hop                INT                             REFERENCES action.transit_copy (id) DEFERRABLE INITIALLY DEFERRED,
471         copy_status             INT                             NOT NULL REFERENCES config.copy_status (id) DEFERRABLE INITIALLY DEFERRED,
472         persistant_transfer     BOOL                            NOT NULL DEFAULT FALSE,
473         prev_dest       INT                             REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED
474 );
475 CREATE INDEX active_transit_dest_idx ON "action".transit_copy (dest); 
476 CREATE INDEX active_transit_source_idx ON "action".transit_copy (source);
477 CREATE INDEX active_transit_cp_idx ON "action".transit_copy (target_copy);
478
479
480 CREATE TABLE action.hold_transit_copy (
481         hold    INT     REFERENCES action.hold_request (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED
482 ) INHERITS (action.transit_copy);
483 ALTER TABLE action.hold_transit_copy ADD PRIMARY KEY (id);
484 -- 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
485 CREATE INDEX active_hold_transit_dest_idx ON "action".hold_transit_copy (dest);
486 CREATE INDEX active_hold_transit_source_idx ON "action".hold_transit_copy (source);
487 CREATE INDEX active_hold_transit_cp_idx ON "action".hold_transit_copy (target_copy);
488 CREATE INDEX hold_transit_copy_hold_idx on action.hold_transit_copy (hold);
489
490
491 CREATE TABLE action.unfulfilled_hold_list (
492         id              BIGSERIAL                       PRIMARY KEY,
493         current_copy    BIGINT                          NOT NULL,
494         hold            INT                             NOT NULL,
495         circ_lib        INT                             NOT NULL,
496         fail_time       TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW()
497 );
498 CREATE INDEX uhr_hold_idx ON action.unfulfilled_hold_list (hold);
499
500 CREATE OR REPLACE VIEW action.unfulfilled_hold_loops AS
501     SELECT  u.hold,
502             c.circ_lib,
503             count(*)
504       FROM  action.unfulfilled_hold_list u
505             JOIN asset.copy c ON (c.id = u.current_copy)
506       GROUP BY 1,2;
507
508 CREATE OR REPLACE VIEW action.unfulfilled_hold_min_loop AS
509     SELECT  hold,
510             min(count)
511       FROM  action.unfulfilled_hold_loops
512       GROUP BY 1;
513
514 CREATE OR REPLACE VIEW action.unfulfilled_hold_innermost_loop AS
515     SELECT  DISTINCT l.*
516       FROM  action.unfulfilled_hold_loops l
517             JOIN action.unfulfilled_hold_min_loop m USING (hold)
518       WHERE l.count = m.min;
519
520 CREATE VIEW action.unfulfilled_hold_max_loop AS
521     SELECT  hold,
522             max(count) AS max
523       FROM  action.unfulfilled_hold_loops
524       GROUP BY 1;
525
526
527 CREATE TABLE action.fieldset (
528     id              SERIAL          PRIMARY KEY,
529     owner           INT             NOT NULL REFERENCES actor.usr (id)
530                                     DEFERRABLE INITIALLY DEFERRED,
531         owning_lib      INT             NOT NULL REFERENCES actor.org_unit (id)
532                                     DEFERRABLE INITIALLY DEFERRED,
533         status          TEXT            NOT NULL
534                                         CONSTRAINT valid_status CHECK ( status in
535                                                                         ( 'PENDING', 'APPLIED', 'ERROR' )),
536     creation_time   TIMESTAMPTZ     NOT NULL DEFAULT NOW(),
537     scheduled_time  TIMESTAMPTZ,
538     applied_time    TIMESTAMPTZ,
539     classname       TEXT            NOT NULL, -- an IDL class name
540     name            TEXT            NOT NULL,
541     stored_query    INT             REFERENCES query.stored_query (id)
542                                     DEFERRABLE INITIALLY DEFERRED,
543     pkey_value      TEXT,
544         CONSTRAINT lib_name_unique UNIQUE (owning_lib, name),
545     CONSTRAINT fieldset_one_or_the_other CHECK (
546         (stored_query IS NOT NULL AND pkey_value IS NULL) OR
547         (pkey_value IS NOT NULL AND stored_query IS NULL)
548     )
549         -- the CHECK constraint means we can update the fields for a single
550         -- row without all the extra overhead involved in a query
551 );
552
553 CREATE INDEX action_fieldset_sched_time_idx ON action.fieldset( scheduled_time );
554 CREATE INDEX action_owner_idx               ON action.fieldset( owner );
555
556
557 CREATE TABLE action.fieldset_col_val (
558     id              SERIAL  PRIMARY KEY,
559     fieldset        INT     NOT NULL REFERENCES action.fieldset
560                                          ON DELETE CASCADE
561                                          DEFERRABLE INITIALLY DEFERRED,
562     col             TEXT    NOT NULL,  -- "field" from the idl ... the column on the table
563     val             TEXT,              -- value for the column ... NULL means, well, NULL
564     CONSTRAINT fieldset_col_once_per_set UNIQUE (fieldset, col)
565 );
566
567
568 -- represents a circ chain summary
569 CREATE TYPE action.circ_chain_summary AS (
570     num_circs INTEGER,
571     start_time TIMESTAMP WITH TIME ZONE,
572     checkout_workstation TEXT,
573     last_renewal_time TIMESTAMP WITH TIME ZONE, -- NULL if no renewals
574     last_stop_fines TEXT,
575     last_stop_fines_time TIMESTAMP WITH TIME ZONE,
576     last_renewal_workstation TEXT, -- NULL if no renewals
577     last_checkin_workstation TEXT,
578     last_checkin_time TIMESTAMP WITH TIME ZONE,
579     last_checkin_scan_time TIMESTAMP WITH TIME ZONE
580 );
581
582
583 CREATE OR REPLACE FUNCTION action.circ_chain ( ctx_circ_id INTEGER ) RETURNS SETOF action.circulation AS $$
584 DECLARE
585     tmp_circ action.circulation%ROWTYPE;
586     circ_0 action.circulation%ROWTYPE;
587 BEGIN
588
589     SELECT INTO tmp_circ * FROM action.circulation WHERE id = ctx_circ_id;
590
591     IF tmp_circ IS NULL THEN
592         RETURN NEXT tmp_circ;
593     END IF;
594     circ_0 := tmp_circ;
595
596     -- find the front of the chain
597     WHILE TRUE LOOP
598         SELECT INTO tmp_circ * FROM action.circulation WHERE id = tmp_circ.parent_circ;
599         IF tmp_circ IS NULL THEN
600             EXIT;
601         END IF;
602         circ_0 := tmp_circ;
603     END LOOP;
604
605     -- now send the circs to the caller, oldest to newest
606     tmp_circ := circ_0;
607     WHILE TRUE LOOP
608         IF tmp_circ IS NULL THEN
609             EXIT;
610         END IF;
611         RETURN NEXT tmp_circ;
612         SELECT INTO tmp_circ * FROM action.circulation WHERE parent_circ = tmp_circ.id;
613     END LOOP;
614
615 END;
616 $$ LANGUAGE 'plpgsql';
617
618 CREATE OR REPLACE FUNCTION action.summarize_circ_chain ( ctx_circ_id INTEGER ) RETURNS action.circ_chain_summary AS $$
619
620 DECLARE
621
622     -- first circ in the chain
623     circ_0 action.circulation%ROWTYPE;
624
625     -- last circ in the chain
626     circ_n action.circulation%ROWTYPE;
627
628     -- circ chain under construction
629     chain action.circ_chain_summary;
630     tmp_circ action.circulation%ROWTYPE;
631
632 BEGIN
633     
634     chain.num_circs := 0;
635     FOR tmp_circ IN SELECT * FROM action.circ_chain(ctx_circ_id) LOOP
636
637         IF chain.num_circs = 0 THEN
638             circ_0 := tmp_circ;
639         END IF;
640
641         chain.num_circs := chain.num_circs + 1;
642         circ_n := tmp_circ;
643     END LOOP;
644
645     chain.start_time := circ_0.xact_start;
646     chain.last_stop_fines := circ_n.stop_fines;
647     chain.last_stop_fines_time := circ_n.stop_fines_time;
648     chain.last_checkin_time := circ_n.checkin_time;
649     chain.last_checkin_scan_time := circ_n.checkin_scan_time;
650     SELECT INTO chain.checkout_workstation name FROM actor.workstation WHERE id = circ_0.workstation;
651     SELECT INTO chain.last_checkin_workstation name FROM actor.workstation WHERE id = circ_n.checkin_workstation;
652
653     IF chain.num_circs > 1 THEN
654         chain.last_renewal_time := circ_n.xact_start;
655         SELECT INTO chain.last_renewal_workstation name FROM actor.workstation WHERE id = circ_n.workstation;
656     END IF;
657
658     RETURN chain;
659
660 END;
661 $$ LANGUAGE 'plpgsql';
662
663 -- Return the list of circ chain heads in xact_start order that the user has chosen to "retain"
664 CREATE OR REPLACE FUNCTION action.usr_visible_circs (usr_id INT) RETURNS SETOF action.circulation AS $func$
665 DECLARE
666     c               action.circulation%ROWTYPE;
667     view_age        INTERVAL;
668     usr_view_age    actor.usr_setting%ROWTYPE;
669     usr_view_start  actor.usr_setting%ROWTYPE;
670 BEGIN
671     SELECT * INTO usr_view_age FROM actor.usr_setting WHERE usr = usr_id AND name = 'history.circ.retention_age';
672     SELECT * INTO usr_view_start FROM actor.usr_setting WHERE usr = usr_id AND name = 'history.circ.retention_start';
673
674     IF usr_view_age.value IS NOT NULL AND usr_view_start.value IS NOT NULL THEN
675         -- User opted in and supplied a retention age
676         IF oils_json_to_text(usr_view_age.value)::INTERVAL > AGE(NOW(), oils_json_to_text(usr_view_start.value)::TIMESTAMPTZ) THEN
677             view_age := AGE(NOW(), oils_json_to_text(usr_view_start.value)::TIMESTAMPTZ);
678         ELSE
679             view_age := oils_json_to_text(usr_view_age.value)::INTERVAL;
680         END IF;
681     ELSIF usr_view_start.value IS NOT NULL THEN
682         -- User opted in
683         view_age := AGE(NOW(), oils_json_to_text(usr_view_start.value)::TIMESTAMPTZ);
684     ELSE
685         -- User did not opt in
686         RETURN;
687     END IF;
688
689     FOR c IN
690         SELECT  *
691           FROM  action.circulation
692           WHERE usr = usr_id
693                 AND parent_circ IS NULL
694                 AND xact_start > NOW() - view_age
695           ORDER BY xact_start DESC
696     LOOP
697         RETURN NEXT c;
698     END LOOP;
699
700     RETURN;
701 END;
702 $func$ LANGUAGE PLPGSQL;
703
704 CREATE OR REPLACE FUNCTION action.usr_visible_circ_copies( INTEGER ) RETURNS SETOF BIGINT AS $$
705     SELECT DISTINCT(target_copy) FROM action.usr_visible_circs($1)
706 $$ LANGUAGE SQL ROWS 10;
707
708 CREATE OR REPLACE FUNCTION action.usr_visible_holds (usr_id INT) RETURNS SETOF action.hold_request AS $func$
709 DECLARE
710     h               action.hold_request%ROWTYPE;
711     view_age        INTERVAL;
712     view_count      INT;
713     usr_view_count  actor.usr_setting%ROWTYPE;
714     usr_view_age    actor.usr_setting%ROWTYPE;
715     usr_view_start  actor.usr_setting%ROWTYPE;
716 BEGIN
717     SELECT * INTO usr_view_count FROM actor.usr_setting WHERE usr = usr_id AND name = 'history.hold.retention_count';
718     SELECT * INTO usr_view_age FROM actor.usr_setting WHERE usr = usr_id AND name = 'history.hold.retention_age';
719     SELECT * INTO usr_view_start FROM actor.usr_setting WHERE usr = usr_id AND name = 'history.hold.retention_start';
720
721     FOR h IN
722         SELECT  *
723           FROM  action.hold_request
724           WHERE usr = usr_id
725                 AND fulfillment_time IS NULL
726                 AND cancel_time IS NULL
727           ORDER BY request_time DESC
728     LOOP
729         RETURN NEXT h;
730     END LOOP;
731
732     IF usr_view_start.value IS NULL THEN
733         RETURN;
734     END IF;
735
736     IF usr_view_age.value IS NOT NULL THEN
737         -- User opted in and supplied a retention age
738         IF oils_json_to_text(usr_view_age.value)::INTERVAL > AGE(NOW(), oils_json_to_text(usr_view_start.value)::TIMESTAMPTZ) THEN
739             view_age := AGE(NOW(), oils_json_to_text(usr_view_start.value)::TIMESTAMPTZ);
740         ELSE
741             view_age := oils_json_to_text(usr_view_age.value)::INTERVAL;
742         END IF;
743     ELSE
744         -- User opted in
745         view_age := AGE(NOW(), oils_json_to_text(usr_view_start.value)::TIMESTAMPTZ);
746     END IF;
747
748     IF usr_view_count.value IS NOT NULL THEN
749         view_count := oils_json_to_text(usr_view_count.value)::INT;
750     ELSE
751         view_count := 1000;
752     END IF;
753
754     -- show some fulfilled/canceled holds
755     FOR h IN
756         SELECT  *
757           FROM  action.hold_request
758           WHERE usr = usr_id
759                 AND ( fulfillment_time IS NOT NULL OR cancel_time IS NOT NULL )
760                 AND request_time > NOW() - view_age
761           ORDER BY request_time DESC
762           LIMIT view_count
763     LOOP
764         RETURN NEXT h;
765     END LOOP;
766
767     RETURN;
768 END;
769 $func$ LANGUAGE PLPGSQL;
770
771 CREATE OR REPLACE FUNCTION action.purge_circulations () RETURNS INT AS $func$
772 DECLARE
773     usr_keep_age    actor.usr_setting%ROWTYPE;
774     usr_keep_start  actor.usr_setting%ROWTYPE;
775     org_keep_age    INTERVAL;
776     org_keep_count  INT;
777
778     keep_age        INTERVAL;
779
780     target_acp      RECORD;
781     circ_chain_head action.circulation%ROWTYPE;
782     circ_chain_tail action.circulation%ROWTYPE;
783
784     purge_position  INT;
785     count_purged    INT;
786 BEGIN
787
788     count_purged := 0;
789
790     SELECT value::INTERVAL INTO org_keep_age FROM config.global_flag WHERE name = 'history.circ.retention_age' AND enabled;
791
792     SELECT value::INT INTO org_keep_count FROM config.global_flag WHERE name = 'history.circ.retention_count' AND enabled;
793     IF org_keep_count IS NULL THEN
794         RETURN count_purged; -- Gimme a count to keep, or I keep them all, forever
795     END IF;
796
797     -- First, find copies with more than keep_count non-renewal circs
798     FOR target_acp IN
799         SELECT  target_copy,
800                 COUNT(*) AS total_real_circs
801           FROM  action.circulation
802           WHERE parent_circ IS NULL
803                 AND xact_finish IS NOT NULL
804           GROUP BY target_copy
805           HAVING COUNT(*) > org_keep_count
806     LOOP
807         purge_position := 0;
808         -- And, for those, select circs that are finished and older than keep_age
809         FOR circ_chain_head IN
810             SELECT  *
811               FROM  action.circulation
812               WHERE target_copy = target_acp.target_copy
813                     AND parent_circ IS NULL
814               ORDER BY xact_start
815         LOOP
816
817             -- Stop once we've purged enough circs to hit org_keep_count
818             EXIT WHEN target_acp.total_real_circs - purge_position <= org_keep_count;
819
820             SELECT * INTO circ_chain_tail FROM action.circ_chain(circ_chain_head.id) ORDER BY xact_start DESC LIMIT 1;
821             EXIT WHEN circ_chain_tail.xact_finish IS NULL;
822
823             -- Now get the user settings, if any, to block purging if the user wants to keep more circs
824             usr_keep_age.value := NULL;
825             SELECT * INTO usr_keep_age FROM actor.usr_setting WHERE usr = circ_chain_head.usr AND name = 'history.circ.retention_age';
826
827             usr_keep_start.value := NULL;
828             SELECT * INTO usr_keep_start FROM actor.usr_setting WHERE usr = circ_chain_head.usr AND name = 'history.circ.retention_start';
829
830             IF usr_keep_age.value IS NOT NULL AND usr_keep_start.value IS NOT NULL THEN
831                 IF oils_json_to_text(usr_keep_age.value)::INTERVAL > AGE(NOW(), oils_json_to_text(usr_keep_start.value)::TIMESTAMPTZ) THEN
832                     keep_age := AGE(NOW(), oils_json_to_text(usr_keep_start.value)::TIMESTAMPTZ);
833                 ELSE
834                     keep_age := oils_json_to_text(usr_keep_age.value)::INTERVAL;
835                 END IF;
836             ELSIF usr_keep_start.value IS NOT NULL THEN
837                 keep_age := AGE(NOW(), oils_json_to_text(usr_keep_start.value)::TIMESTAMPTZ);
838             ELSE
839                 keep_age := COALESCE( org_keep_age::INTERVAL, '2000 years'::INTERVAL );
840             END IF;
841
842             EXIT WHEN AGE(NOW(), circ_chain_tail.xact_finish) < keep_age;
843
844             -- We've passed the purging tests, purge the circ chain starting at the end
845             DELETE FROM action.circulation WHERE id = circ_chain_tail.id;
846             WHILE circ_chain_tail.parent_circ IS NOT NULL LOOP
847                 SELECT * INTO circ_chain_tail FROM action.circulation WHERE id = circ_chain_tail.parent_circ;
848                 DELETE FROM action.circulation WHERE id = circ_chain_tail.id;
849             END LOOP;
850
851             count_purged := count_purged + 1;
852             purge_position := purge_position + 1;
853
854         END LOOP;
855     END LOOP;
856 END;
857 $func$ LANGUAGE PLPGSQL;
858
859
860 CREATE OR REPLACE FUNCTION action.apply_fieldset(
861         fieldset_id IN INT,        -- id from action.fieldset
862         table_name  IN TEXT,       -- table to be updated
863         pkey_name   IN TEXT,       -- name of primary key column in that table
864         query       IN TEXT        -- query constructed by qstore (for query-based
865                                    --    fieldsets only; otherwise null
866 )
867 RETURNS TEXT AS $$
868 DECLARE
869         statement TEXT;
870         fs_status TEXT;
871         fs_pkey_value TEXT;
872         fs_query TEXT;
873         sep CHAR;
874         status_code TEXT;
875         msg TEXT;
876         update_count INT;
877         cv RECORD;
878 BEGIN
879         -- Sanity checks
880         IF fieldset_id IS NULL THEN
881                 RETURN 'Fieldset ID parameter is NULL';
882         END IF;
883         IF table_name IS NULL THEN
884                 RETURN 'Table name parameter is NULL';
885         END IF;
886         IF pkey_name IS NULL THEN
887                 RETURN 'Primary key name parameter is NULL';
888         END IF;
889         --
890         statement := 'UPDATE ' || table_name || ' SET';
891         --
892         SELECT
893                 status,
894                 quote_literal( pkey_value )
895         INTO
896                 fs_status,
897                 fs_pkey_value
898         FROM
899                 action.fieldset
900         WHERE
901                 id = fieldset_id;
902         --
903         IF fs_status IS NULL THEN
904                 RETURN 'No fieldset found for id = ' || fieldset_id;
905         ELSIF fs_status = 'APPLIED' THEN
906                 RETURN 'Fieldset ' || fieldset_id || ' has already been applied';
907         END IF;
908         --
909         sep := '';
910         FOR cv IN
911                 SELECT  col,
912                                 val
913                 FROM    action.fieldset_col_val
914                 WHERE   fieldset = fieldset_id
915         LOOP
916                 statement := statement || sep || ' ' || cv.col
917                                          || ' = ' || coalesce( quote_literal( cv.val ), 'NULL' );
918                 sep := ',';
919         END LOOP;
920         --
921         IF sep = '' THEN
922                 RETURN 'Fieldset ' || fieldset_id || ' has no column values defined';
923         END IF;
924         --
925         -- Add the WHERE clause.  This differs according to whether it's a
926         -- single-row fieldset or a query-based fieldset.
927         --
928         IF query IS NULL        AND fs_pkey_value IS NULL THEN
929                 RETURN 'Incomplete fieldset: neither a primary key nor a query available';
930         ELSIF query IS NOT NULL AND fs_pkey_value IS NULL THEN
931             fs_query := rtrim( query, ';' );
932             statement := statement || ' WHERE ' || pkey_name || ' IN ( '
933                          || fs_query || ' );';
934         ELSIF query IS NULL     AND fs_pkey_value IS NOT NULL THEN
935                 statement := statement || ' WHERE ' || pkey_name || ' = '
936                                      || fs_pkey_value || ';';
937         ELSE  -- both are not null
938                 RETURN 'Ambiguous fieldset: both a primary key and a query provided';
939         END IF;
940         --
941         -- Execute the update
942         --
943         BEGIN
944                 EXECUTE statement;
945                 GET DIAGNOSTICS update_count = ROW_COUNT;
946                 --
947                 IF UPDATE_COUNT > 0 THEN
948                         status_code := 'APPLIED';
949                         msg := NULL;
950                 ELSE
951                         status_code := 'ERROR';
952                         msg := 'No eligible rows found for fieldset ' || fieldset_id;
953         END IF;
954         EXCEPTION WHEN OTHERS THEN
955                 status_code := 'ERROR';
956                 msg := 'Unable to apply fieldset ' || fieldset_id
957                            || ': ' || sqlerrm;
958         END;
959         --
960         -- Update fieldset status
961         --
962         UPDATE action.fieldset
963         SET status       = status_code,
964             applied_time = now()
965         WHERE id = fieldset_id;
966         --
967         RETURN msg;
968 END;
969 $$ LANGUAGE plpgsql;
970
971 COMMENT ON FUNCTION action.apply_fieldset( INT, TEXT, TEXT, TEXT ) IS $$
972 Applies a specified fieldset, using a supplied table name and primary
973 key name.  The query parameter should be non-null only for
974 query-based fieldsets.
975
976 Returns NULL if successful, or an error message if not.
977 $$;
978
979 CREATE OR REPLACE FUNCTION action.hold_copy_calculated_proximity(
980     ahr_id INT,
981     acp_id BIGINT,
982     copy_context_ou INT DEFAULT NULL
983     -- TODO maybe? hold_context_ou INT DEFAULT NULL.  This would optionally
984     -- support an "ahprox" measurement: adjust prox between copy circ lib and
985     -- hold request lib, but I'm unsure whether to use this theoretical
986     -- argument only in the baseline calculation or later in the other
987     -- queries in this function.
988 ) RETURNS NUMERIC AS $f$
989 DECLARE
990     aoupa           actor.org_unit_proximity_adjustment%ROWTYPE;
991     ahr             action.hold_request%ROWTYPE;
992     acp             asset.copy%ROWTYPE;
993     acn             asset.call_number%ROWTYPE;
994     acl             asset.copy_location%ROWTYPE;
995     baseline_prox   NUMERIC;
996
997     icl_list        INT[];
998     iol_list        INT[];
999     isl_list        INT[];
1000     hpl_list        INT[];
1001     hrl_list        INT[];
1002
1003 BEGIN
1004
1005     SELECT * INTO ahr FROM action.hold_request WHERE id = ahr_id;
1006     SELECT * INTO acp FROM asset.copy WHERE id = acp_id;
1007     SELECT * INTO acn FROM asset.call_number WHERE id = acp.call_number;
1008     SELECT * INTO acl FROM asset.copy_location WHERE id = acp.location;
1009
1010     IF copy_context_ou IS NULL THEN
1011         copy_context_ou := acp.circ_lib;
1012     END IF;
1013
1014     -- First, gather the baseline proximity of "here" to pickup lib
1015     SELECT prox INTO baseline_prox FROM actor.org_unit_proximity WHERE from_org = copy_context_ou AND to_org = ahr.pickup_lib;
1016
1017     -- Find any absolute adjustments, and set the baseline prox to that
1018     SELECT  adj.* INTO aoupa
1019       FROM  actor.org_unit_proximity_adjustment adj
1020             LEFT JOIN actor.org_unit_ancestors_distance(copy_context_ou) acp_cl ON (acp_cl.id = adj.item_circ_lib)
1021             LEFT JOIN actor.org_unit_ancestors_distance(acn.owning_lib) acn_ol ON (acn_ol.id = adj.item_owning_lib)
1022             LEFT JOIN actor.org_unit_ancestors_distance(acl.owning_lib) acl_ol ON (acn_ol.id = adj.copy_location)
1023             LEFT JOIN actor.org_unit_ancestors_distance(ahr.pickup_lib) ahr_pl ON (ahr_pl.id = adj.hold_pickup_lib)
1024             LEFT JOIN actor.org_unit_ancestors_distance(ahr.request_lib) ahr_rl ON (ahr_rl.id = adj.hold_request_lib)
1025       WHERE (adj.circ_mod IS NULL OR adj.circ_mod = acp.circ_modifier) AND
1026         absolute_adjustment AND
1027         COALESCE(acp_cl.id, acn_ol.id, acl_ol.id, ahr_pl.id, ahr_rl.id) IS NOT NULL
1028       ORDER BY
1029             COALESCE(acp_cl.distance,999)
1030                 + COALESCE(acn_ol.distance,999)
1031                 + COALESCE(acl_ol.distance,999)
1032                 + COALESCE(ahr_pl.distance,999)
1033                 + COALESCE(ahr_rl.distance,999),
1034             adj.pos
1035       LIMIT 1;
1036
1037     IF FOUND THEN
1038         baseline_prox := aoupa.prox_adjustment;
1039     END IF;
1040
1041     -- Now find any relative adjustments, and change the baseline prox based on them
1042     FOR aoupa IN
1043         SELECT  adj.* 
1044           FROM  actor.org_unit_proximity_adjustment adj
1045                 LEFT JOIN actor.org_unit_ancestors_distance(copy_context_ou) acp_cl ON (acp_cl.id = adj.item_circ_lib)
1046                 LEFT JOIN actor.org_unit_ancestors_distance(acn.owning_lib) acn_ol ON (acn_ol.id = adj.item_owning_lib)
1047                 LEFT JOIN actor.org_unit_ancestors_distance(acl.owning_lib) acl_ol ON (acn_ol.id = adj.copy_location)
1048                 LEFT JOIN actor.org_unit_ancestors_distance(ahr.pickup_lib) ahr_pl ON (ahr_pl.id = adj.hold_pickup_lib)
1049                 LEFT JOIN actor.org_unit_ancestors_distance(ahr.request_lib) ahr_rl ON (ahr_rl.id = adj.hold_request_lib)
1050           WHERE (adj.circ_mod IS NULL OR adj.circ_mod = acp.circ_modifier) AND
1051             NOT absolute_adjustment AND
1052             COALESCE(acp_cl.id, acn_ol.id, acl_ol.id, ahr_pl.id, ahr_rl.id) IS NOT NULL
1053     LOOP
1054         baseline_prox := baseline_prox + aoupa.prox_adjustment;
1055     END LOOP;
1056
1057     RETURN baseline_prox;
1058 END;
1059 $f$ LANGUAGE PLPGSQL;
1060
1061 COMMIT;