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 DECLARE
 177     proper_tz TEXT := COALESCE(
 178         oils_json_to_text((
 179             SELECT value
 180               FROM  actor.org_unit_ancestor_setting('lib.timezone',NEW.circ_lib)
 181               LIMIT 1
 182         )),
 183         CURRENT_SETTING('timezone')
 184     );
 185 BEGIN
 186
 187     IF (EXTRACT(EPOCH FROM NEW.duration)::INT % EXTRACT(EPOCH FROM '1 day'::INTERVAL)::INT) = 0 -- day-granular duration
 188         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
 189         NEW.due_date = ((NEW.due_date AT TIME ZONE proper_tz)::DATE + '1 day'::INTERVAL - '1 second'::INTERVAL) || ' ' || proper_tz;
 190     END IF;
 191
 192     RETURN NEW;
 193 END;
 194 $$ LANGUAGE PLPGSQL;
 195
 196 CREATE TRIGGER push_due_date_tgr BEFORE INSERT OR UPDATE ON action.circulation FOR EACH ROW EXECUTE PROCEDURE action.push_circ_due_time();
 197
 198 CREATE OR REPLACE FUNCTION action.fill_circ_copy_location () RETURNS TRIGGER AS $$
 199 BEGIN
 200     SELECT INTO NEW.copy_location location FROM asset.copy WHERE id = NEW.target_copy;
 201     RETURN NEW;
 202 END;
 203 $$ LANGUAGE PLPGSQL;
 204
 205 CREATE TRIGGER fill_circ_copy_location_tgr BEFORE INSERT ON action.circulation FOR EACH ROW EXECUTE PROCEDURE action.fill_circ_copy_location();
 206
 207 CREATE OR REPLACE FUNCTION action.archive_stat_cats () RETURNS TRIGGER AS $$
 208 BEGIN
 209     INSERT INTO action.archive_actor_stat_cat(xact, stat_cat, value)
 210         SELECT NEW.id, asceum.stat_cat, asceum.stat_cat_entry
 211         FROM actor.stat_cat_entry_usr_map asceum
 212              JOIN actor.stat_cat sc ON asceum.stat_cat = sc.id
 213         WHERE NEW.usr = asceum.target_usr AND sc.checkout_archive;
 214     INSERT INTO action.archive_asset_stat_cat(xact, stat_cat, value)
 215         SELECT NEW.id, ascecm.stat_cat, asce.value
 216         FROM asset.stat_cat_entry_copy_map ascecm
 217              JOIN asset.stat_cat sc ON ascecm.stat_cat = sc.id
 218              JOIN asset.stat_cat_entry asce ON ascecm.stat_cat_entry = asce.id
 219         WHERE NEW.target_copy = ascecm.owning_copy AND sc.checkout_archive;
 220     RETURN NULL;
 221 END;
 222 $$ LANGUAGE PLPGSQL;
 223
 224 CREATE TRIGGER archive_stat_cats_tgr AFTER INSERT ON action.circulation FOR EACH ROW EXECUTE PROCEDURE action.archive_stat_cats();
 225
 226 CREATE TABLE action.aged_circulation (
 227         usr_post_code           TEXT,
 228         usr_home_ou             INT     NOT NULL,
 229         usr_profile             INT     NOT NULL,
 230         usr_birth_year          INT,
 231         copy_call_number        INT     NOT NULL,
 232         copy_owning_lib         INT     NOT NULL,
 233         copy_circ_lib           INT     NOT NULL,
 234         copy_bib_record         BIGINT  NOT NULL,
 235         LIKE action.circulation
 236
 237 );
 238 ALTER TABLE action.aged_circulation ADD PRIMARY KEY (id);
 239 ALTER TABLE action.aged_circulation DROP COLUMN usr;
 240 CREATE INDEX aged_circ_circ_lib_idx ON "action".aged_circulation (circ_lib);
 241 CREATE INDEX aged_circ_start_idx ON "action".aged_circulation (xact_start);
 242 CREATE INDEX aged_circ_copy_circ_lib_idx ON "action".aged_circulation (copy_circ_lib);
 243 CREATE INDEX aged_circ_copy_owning_lib_idx ON "action".aged_circulation (copy_owning_lib);
 244 CREATE INDEX aged_circ_copy_location_idx ON "action".aged_circulation (copy_location);
 245 CREATE INDEX action_aged_circulation_target_copy_idx ON action.aged_circulation (target_copy);
 246 CREATE INDEX action_aged_circulation_parent_circ_idx ON action.aged_circulation (parent_circ);
 247
 248 CREATE OR REPLACE VIEW action.all_circulation AS
 249     SELECT  id,usr_post_code, usr_home_ou, usr_profile, usr_birth_year, copy_call_number, copy_location,
 250         copy_owning_lib, copy_circ_lib, copy_bib_record, xact_start, xact_finish, target_copy,
 251         circ_lib, circ_staff, checkin_staff, checkin_lib, renewal_remaining, grace_period, due_date,
 252         stop_fines_time, checkin_time, create_time, duration, fine_interval, recurring_fine,
 253         max_fine, phone_renewal, desk_renewal, opac_renewal, duration_rule, recurring_fine_rule,
 254         max_fine_rule, stop_fines, workstation, checkin_workstation, checkin_scan_time, parent_circ,
 255         NULL AS usr
 256       FROM  action.aged_circulation
 257             UNION ALL
 258     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,
 259         cp.call_number AS copy_call_number, circ.copy_location, cn.owning_lib AS copy_owning_lib, cp.circ_lib AS copy_circ_lib,
 260         cn.record AS copy_bib_record, circ.xact_start, circ.xact_finish, circ.target_copy, circ.circ_lib, circ.circ_staff, circ.checkin_staff,
 261         circ.checkin_lib, circ.renewal_remaining, circ.grace_period, circ.due_date, circ.stop_fines_time, circ.checkin_time, circ.create_time, circ.duration,
 262         circ.fine_interval, circ.recurring_fine, circ.max_fine, circ.phone_renewal, circ.desk_renewal, circ.opac_renewal, circ.duration_rule,
 263         circ.recurring_fine_rule, circ.max_fine_rule, circ.stop_fines, circ.workstation, circ.checkin_workstation, circ.checkin_scan_time,
 264         circ.parent_circ, circ.usr
 265       FROM  action.circulation circ
 266         JOIN asset.copy cp ON (circ.target_copy = cp.id)
 267         JOIN asset.call_number cn ON (cp.call_number = cn.id)
 268         JOIN actor.usr p ON (circ.usr = p.id)
 269         LEFT JOIN actor.usr_address a ON (p.mailing_address = a.id)
 270         LEFT JOIN actor.usr_address b ON (p.billing_address = b.id);
 271
 272 CREATE OR REPLACE VIEW action.all_circulation_slim AS
 273     SELECT * FROM action.circulation
 274 UNION ALL
 275     SELECT
 276         id,
 277         NULL AS usr,
 278         xact_start,
 279         xact_finish,
 280         unrecovered,
 281         target_copy,
 282         circ_lib,
 283         circ_staff,
 284         checkin_staff,
 285         checkin_lib,
 286         renewal_remaining,
 287         grace_period,
 288         due_date,
 289         stop_fines_time,
 290         checkin_time,
 291         create_time,
 292         duration,
 293         fine_interval,
 294         recurring_fine,
 295         max_fine,
 296         phone_renewal,
 297         desk_renewal,
 298         opac_renewal,
 299         duration_rule,
 300         recurring_fine_rule,
 301         max_fine_rule,
 302         stop_fines,
 303         workstation,
 304         checkin_workstation,
 305         copy_location,
 306         checkin_scan_time,
 307         parent_circ
 308     FROM action.aged_circulation
 309 ;
 310
 311
 312
 313 CREATE OR REPLACE FUNCTION action.age_circ_on_delete () RETURNS TRIGGER AS $$
 314 DECLARE
 315 found char := 'N';
 316 BEGIN
 317
 318     -- If there are any renewals for this circulation, don't archive or delete
 319     -- it yet.   We'll do so later, when we archive and delete the renewals.
 320
 321     SELECT 'Y' INTO found
 322     FROM action.circulation
 323     WHERE parent_circ = OLD.id
 324     LIMIT 1;
 325
 326     IF found = 'Y' THEN
 327         RETURN NULL;  -- don't delete
 328         END IF;
 329
 330     -- Archive a copy of the old row to action.aged_circulation
 331
 332     INSERT INTO action.aged_circulation
 333         (id,usr_post_code, usr_home_ou, usr_profile, usr_birth_year, copy_call_number, copy_location,
 334         copy_owning_lib, copy_circ_lib, copy_bib_record, xact_start, xact_finish, target_copy,
 335         circ_lib, circ_staff, checkin_staff, checkin_lib, renewal_remaining, grace_period, due_date,
 336         stop_fines_time, checkin_time, create_time, duration, fine_interval, recurring_fine,
 337         max_fine, phone_renewal, desk_renewal, opac_renewal, duration_rule, recurring_fine_rule,
 338         max_fine_rule, stop_fines, workstation, checkin_workstation, checkin_scan_time, parent_circ)
 339       SELECT
 340         id,usr_post_code, usr_home_ou, usr_profile, usr_birth_year, copy_call_number, copy_location,
 341         copy_owning_lib, copy_circ_lib, copy_bib_record, xact_start, xact_finish, target_copy,
 342         circ_lib, circ_staff, checkin_staff, checkin_lib, renewal_remaining, grace_period, due_date,
 343         stop_fines_time, checkin_time, create_time, duration, fine_interval, recurring_fine,
 344         max_fine, phone_renewal, desk_renewal, opac_renewal, duration_rule, recurring_fine_rule,
 345         max_fine_rule, stop_fines, workstation, checkin_workstation, checkin_scan_time, parent_circ
 346         FROM action.all_circulation WHERE id = OLD.id;
 347
 348     RETURN OLD;
 349 END;
 350 $$ LANGUAGE 'plpgsql';
 351
 352 CREATE TRIGGER action_circulation_aging_tgr
 353         BEFORE DELETE ON action.circulation
 354         FOR EACH ROW
 355         EXECUTE PROCEDURE action.age_circ_on_delete ();
 356
 357
 358 CREATE OR REPLACE FUNCTION action.age_parent_circ_on_delete () RETURNS TRIGGER AS $$
 359 BEGIN
 360
 361     -- Having deleted a renewal, we can delete the original circulation (or a previous
 362     -- renewal, if that's what parent_circ is pointing to).  That deletion will trigger
 363     -- deletion of any prior parents, etc. recursively.
 364
 365     IF OLD.parent_circ IS NOT NULL THEN
 366         DELETE FROM action.circulation
 367         WHERE id = OLD.parent_circ;
 368     END IF;
 369
 370     RETURN OLD;
 371 END;
 372 $$ LANGUAGE 'plpgsql';
 373
 374 CREATE TRIGGER age_parent_circ
 375         AFTER DELETE ON action.circulation
 376         FOR EACH ROW
 377         EXECUTE PROCEDURE action.age_parent_circ_on_delete ();
 378
 379
 380 CREATE OR REPLACE VIEW action.open_circulation AS
 381         SELECT  *
 382           FROM  action.circulation
 383           WHERE checkin_time IS NULL
 384           ORDER BY due_date;
 385
 386
 387 CREATE OR REPLACE VIEW action.billable_circulations AS
 388         SELECT  *
 389           FROM  action.circulation
 390           WHERE xact_finish IS NULL;
 391
 392 CREATE OR REPLACE FUNCTION action.circulation_claims_returned () RETURNS TRIGGER AS $$
 393 BEGIN
 394         IF OLD.stop_fines IS NULL OR OLD.stop_fines <> NEW.stop_fines THEN
 395                 IF NEW.stop_fines = 'CLAIMSRETURNED' THEN
 396                         UPDATE actor.usr SET claims_returned_count = claims_returned_count + 1 WHERE id = NEW.usr;
 397                 END IF;
 398                 IF NEW.stop_fines = 'CLAIMSNEVERCHECKEDOUT' THEN
 399                         UPDATE actor.usr SET claims_never_checked_out_count = claims_never_checked_out_count + 1 WHERE id = NEW.usr;
 400                 END IF;
 401                 IF NEW.stop_fines = 'LOST' THEN
 402                         UPDATE asset.copy SET status = 3 WHERE id = NEW.target_copy;
 403                 END IF;
 404         END IF;
 405         RETURN NEW;
 406 END;
 407 $$ LANGUAGE 'plpgsql';
 408 CREATE TRIGGER action_circulation_stop_fines_tgr
 409         BEFORE UPDATE ON action.circulation
 410         FOR EACH ROW
 411         EXECUTE PROCEDURE action.circulation_claims_returned ();
 412
 413 CREATE TABLE action.hold_request_cancel_cause (
 414     id      SERIAL  PRIMARY KEY,
 415     label   TEXT    UNIQUE
 416 );
 417
 418 CREATE TABLE action.hold_request (
 419         id                      SERIAL                          PRIMARY KEY,
 420         request_time            TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW(),
 421         capture_time            TIMESTAMP WITH TIME ZONE,
 422         fulfillment_time        TIMESTAMP WITH TIME ZONE,
 423         checkin_time            TIMESTAMP WITH TIME ZONE,
 424         return_time             TIMESTAMP WITH TIME ZONE,
 425         prev_check_time         TIMESTAMP WITH TIME ZONE,
 426         expire_time             TIMESTAMP WITH TIME ZONE,
 427         cancel_time             TIMESTAMP WITH TIME ZONE,
 428         cancel_cause    INT REFERENCES action.hold_request_cancel_cause (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
 429         cancel_note             TEXT,
 430         target                  BIGINT                          NOT NULL, -- see hold_type
 431         current_copy            BIGINT,                         -- REFERENCES asset.copy (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,  -- XXX could be an serial.unit now...
 432         fulfillment_staff       INT                             REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 433         fulfillment_lib         INT                             REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
 434         request_lib             INT                             NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
 435         requestor               INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 436         usr                     INT                             NOT NULL REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 437         selection_ou            INT                             NOT NULL,
 438         selection_depth         INT                             NOT NULL DEFAULT 0,
 439         pickup_lib              INT                             NOT NULL REFERENCES actor.org_unit DEFERRABLE INITIALLY DEFERRED,
 440         hold_type               TEXT                            NOT NULL, -- CHECK (hold_type IN ('M','T','V','C')),  -- XXX constraint too constraining...
 441         holdable_formats        TEXT,
 442         phone_notify            TEXT,
 443         email_notify            BOOL                            NOT NULL DEFAULT FALSE,
 444         sms_notify              TEXT,
 445         sms_carrier             INT REFERENCES config.sms_carrier (id),
 446         frozen                  BOOL                            NOT NULL DEFAULT FALSE,
 447         thaw_date               TIMESTAMP WITH TIME ZONE,
 448         shelf_time              TIMESTAMP WITH TIME ZONE,
 449     cut_in_line     BOOL,
 450         mint_condition  BOOL NOT NULL DEFAULT TRUE,
 451         shelf_expire_time TIMESTAMPTZ,
 452         current_shelf_lib INT REFERENCES actor.org_unit DEFERRABLE INITIALLY DEFERRED,
 453     behind_desk BOOLEAN NOT NULL DEFAULT FALSE
 454 );
 455 ALTER TABLE action.hold_request ADD CONSTRAINT sms_check CHECK (
 456     sms_notify IS NULL
 457     OR sms_carrier IS NOT NULL -- and implied sms_notify IS NOT NULL
 458 );
 459
 460
 461 CREATE OR REPLACE FUNCTION action.hold_request_clear_map () RETURNS TRIGGER AS $$
 462 BEGIN
 463   DELETE FROM action.hold_copy_map WHERE hold = NEW.id;
 464   RETURN NEW;
 465 END;
 466 $$ LANGUAGE PLPGSQL;
 467
 468 CREATE TRIGGER hold_request_clear_map_tgr
 469     AFTER UPDATE ON action.hold_request
 470     FOR EACH ROW
 471     WHEN (
 472         (NEW.cancel_time IS NOT NULL AND OLD.cancel_time IS NULL)
 473         OR (NEW.fulfillment_time IS NOT NULL AND OLD.fulfillment_time IS NULL)
 474     )
 475     EXECUTE PROCEDURE action.hold_request_clear_map();
 476
 477 CREATE INDEX hold_request_target_idx ON action.hold_request (target);
 478 CREATE INDEX hold_request_usr_idx ON action.hold_request (usr);
 479 CREATE INDEX hold_request_pickup_lib_idx ON action.hold_request (pickup_lib);
 480 CREATE INDEX hold_request_current_copy_idx ON action.hold_request (current_copy);
 481 CREATE INDEX hold_request_prev_check_time_idx ON action.hold_request (prev_check_time);
 482 CREATE INDEX hold_request_fulfillment_staff_idx ON action.hold_request ( fulfillment_staff );
 483 CREATE INDEX hold_request_requestor_idx         ON action.hold_request ( requestor );
 484 CREATE INDEX hold_request_open_idx ON action.hold_request (id) WHERE cancel_time IS NULL AND fulfillment_time IS NULL;
 485 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;
 486 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;
 487 CREATE INDEX hold_request_copy_capture_time_idx ON action.hold_request (current_copy,capture_time);
 488 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);
 489 CREATE INDEX hold_fulfillment_time_idx ON action.hold_request (fulfillment_time) WHERE fulfillment_time IS NOT NULL;
 490 CREATE INDEX hold_request_time_idx ON action.hold_request (request_time);
 491
 492
 493 CREATE TABLE action.hold_request_note (
 494
 495     id     BIGSERIAL PRIMARY KEY,
 496     hold   BIGINT    NOT NULL REFERENCES action.hold_request (id)
 497                               ON DELETE CASCADE
 498                               DEFERRABLE INITIALLY DEFERRED,
 499     title  TEXT      NOT NULL,
 500     body   TEXT      NOT NULL,
 501     slip   BOOL      NOT NULL DEFAULT FALSE,
 502     pub    BOOL      NOT NULL DEFAULT FALSE,
 503     staff  BOOL      NOT NULL DEFAULT FALSE  -- created by staff
 504
 505 );
 506 CREATE INDEX ahrn_hold_idx ON action.hold_request_note (hold);
 507
 508
 509 CREATE TABLE action.hold_notification (
 510         id              SERIAL                          PRIMARY KEY,
 511         hold            INT                             NOT NULL REFERENCES action.hold_request (id)
 512                                                                         ON DELETE CASCADE
 513                                                                         DEFERRABLE INITIALLY DEFERRED,
 514         notify_staff    INT                     REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
 515         notify_time     TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW(),
 516         method          TEXT                            NOT NULL, -- email address or phone number
 517         note            TEXT
 518 );
 519 CREATE INDEX ahn_hold_idx ON action.hold_notification (hold);
 520 CREATE INDEX ahn_notify_staff_idx ON action.hold_notification ( notify_staff );
 521
 522 CREATE TABLE action.hold_copy_map (
 523         id              BIGSERIAL       PRIMARY KEY,
 524         hold            INT     NOT NULL REFERENCES action.hold_request (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 525         target_copy     BIGINT  NOT NULL, -- REFERENCES asset.copy (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED, -- XXX could be an serial.issuance
 526         proximity       NUMERIC,
 527         CONSTRAINT copy_once_per_hold UNIQUE (hold,target_copy)
 528 );
 529 -- CREATE INDEX acm_hold_idx ON action.hold_copy_map (hold);
 530 CREATE INDEX acm_copy_idx ON action.hold_copy_map (target_copy);
 531
 532 CREATE OR REPLACE FUNCTION
 533     action.hold_request_regen_copy_maps(
 534         hold_id INTEGER, copy_ids INTEGER[]) RETURNS VOID AS $$
 535     DELETE FROM action.hold_copy_map WHERE hold = $1;
 536     INSERT INTO action.hold_copy_map (hold, target_copy) SELECT $1, UNNEST($2);
 537 $$ LANGUAGE SQL;
 538
 539 CREATE TABLE action.transit_copy (
 540         id                      SERIAL                          PRIMARY KEY,
 541         source_send_time        TIMESTAMP WITH TIME ZONE,
 542         dest_recv_time          TIMESTAMP WITH TIME ZONE,
 543         target_copy             BIGINT                          NOT NULL, -- REFERENCES asset.copy (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED, -- XXX could be an serial.issuance
 544         source                  INT                             NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
 545         dest                    INT                             NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
 546         prev_hop                INT                             REFERENCES action.transit_copy (id) DEFERRABLE INITIALLY DEFERRED,
 547         copy_status             INT                             NOT NULL REFERENCES config.copy_status (id) DEFERRABLE INITIALLY DEFERRED,
 548         persistant_transfer     BOOL                            NOT NULL DEFAULT FALSE,
 549         prev_dest               INT                             REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
 550         cancel_time             TIMESTAMP WITH TIME ZONE
 551 );
 552 CREATE INDEX active_transit_dest_idx ON "action".transit_copy (dest);
 553 CREATE INDEX active_transit_source_idx ON "action".transit_copy (source);
 554 CREATE INDEX active_transit_cp_idx ON "action".transit_copy (target_copy);
 555
 556
 557 CREATE TABLE action.hold_transit_copy (
 558         hold    INT     REFERENCES action.hold_request (id) ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED
 559 ) INHERITS (action.transit_copy);
 560 ALTER TABLE action.hold_transit_copy ADD PRIMARY KEY (id);
 561 -- 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
 562 CREATE INDEX active_hold_transit_dest_idx ON "action".hold_transit_copy (dest);
 563 CREATE INDEX active_hold_transit_source_idx ON "action".hold_transit_copy (source);
 564 CREATE INDEX active_hold_transit_cp_idx ON "action".hold_transit_copy (target_copy);
 565 CREATE INDEX hold_transit_copy_hold_idx on action.hold_transit_copy (hold);
 566
 567
 568 CREATE TABLE action.unfulfilled_hold_list (
 569         id              BIGSERIAL                       PRIMARY KEY,
 570         current_copy    BIGINT                          NOT NULL,
 571         hold            INT                             NOT NULL,
 572         circ_lib        INT                             NOT NULL,
 573         fail_time       TIMESTAMP WITH TIME ZONE        NOT NULL DEFAULT NOW()
 574 );
 575 CREATE INDEX uhr_hold_idx ON action.unfulfilled_hold_list (hold);
 576
 577 CREATE OR REPLACE VIEW action.unfulfilled_hold_loops AS
 578     SELECT  u.hold,
 579             c.circ_lib,
 580             count(*)
 581       FROM  action.unfulfilled_hold_list u
 582             JOIN asset.copy c ON (c.id = u.current_copy)
 583       GROUP BY 1,2;
 584
 585 CREATE OR REPLACE VIEW action.unfulfilled_hold_min_loop AS
 586     SELECT  hold,
 587             min(count)
 588       FROM  action.unfulfilled_hold_loops
 589       GROUP BY 1;
 590
 591 CREATE OR REPLACE VIEW action.unfulfilled_hold_innermost_loop AS
 592     SELECT  DISTINCT l.*
 593       FROM  action.unfulfilled_hold_loops l
 594             JOIN action.unfulfilled_hold_min_loop m USING (hold)
 595       WHERE l.count = m.min;
 596
 597 CREATE VIEW action.unfulfilled_hold_max_loop AS
 598     SELECT  hold,
 599             max(count) AS max
 600       FROM  action.unfulfilled_hold_loops
 601       GROUP BY 1;
 602
 603
 604 CREATE TABLE action.aged_hold_request (
 605     usr_post_code               TEXT,
 606     usr_home_ou         INT     NOT NULL,
 607     usr_profile         INT     NOT NULL,
 608     usr_birth_year              INT,
 609     staff_placed        BOOLEAN NOT NULL,
 610     LIKE action.hold_request
 611 );
 612 ALTER TABLE action.aged_hold_request
 613       ADD PRIMARY KEY (id),
 614       DROP COLUMN usr,
 615       DROP COLUMN requestor,
 616       DROP COLUMN sms_carrier,
 617       ALTER COLUMN phone_notify TYPE BOOLEAN
 618             USING CASE WHEN phone_notify IS NULL OR phone_notify = '' THEN FALSE ELSE TRUE END,
 619       ALTER COLUMN sms_notify TYPE BOOLEAN
 620             USING CASE WHEN sms_notify IS NULL OR sms_notify = '' THEN FALSE ELSE TRUE END,
 621       ALTER COLUMN phone_notify SET NOT NULL,
 622       ALTER COLUMN sms_notify SET NOT NULL;
 623 CREATE INDEX aged_hold_request_target_idx ON action.aged_hold_request (target);
 624 CREATE INDEX aged_hold_request_pickup_lib_idx ON action.aged_hold_request (pickup_lib);
 625 CREATE INDEX aged_hold_request_current_copy_idx ON action.aged_hold_request (current_copy);
 626 CREATE INDEX aged_hold_request_fulfillment_staff_idx ON action.aged_hold_request ( fulfillment_staff );
 627
 628 CREATE OR REPLACE VIEW action.all_hold_request AS
 629     SELECT DISTINCT
 630            COALESCE(a.post_code, b.post_code) AS usr_post_code,
 631            p.home_ou AS usr_home_ou,
 632            p.profile AS usr_profile,
 633            EXTRACT(YEAR FROM p.dob)::INT AS usr_birth_year,
 634            CAST(ahr.requestor <> ahr.usr AS BOOLEAN) AS staff_placed,
 635            ahr.id,
 636            ahr.request_time,
 637            ahr.capture_time,
 638            ahr.fulfillment_time,
 639            ahr.checkin_time,
 640            ahr.return_time,
 641            ahr.prev_check_time,
 642            ahr.expire_time,
 643            ahr.cancel_time,
 644            ahr.cancel_cause,
 645            ahr.cancel_note,
 646            ahr.target,
 647            ahr.current_copy,
 648            ahr.fulfillment_staff,
 649            ahr.fulfillment_lib,
 650            ahr.request_lib,
 651            ahr.selection_ou,
 652            ahr.selection_depth,
 653            ahr.pickup_lib,
 654            ahr.hold_type,
 655            ahr.holdable_formats,
 656            CASE
 657            WHEN ahr.phone_notify IS NULL THEN FALSE
 658            WHEN ahr.phone_notify = '' THEN FALSE
 659            ELSE TRUE
 660            END AS phone_notify,
 661            ahr.email_notify,
 662            CASE
 663            WHEN ahr.sms_notify IS NULL THEN FALSE
 664            WHEN ahr.sms_notify = '' THEN FALSE
 665            ELSE TRUE
 666            END AS sms_notify,
 667            ahr.frozen,
 668            ahr.thaw_date,
 669            ahr.shelf_time,
 670            ahr.cut_in_line,
 671            ahr.mint_condition,
 672            ahr.shelf_expire_time,
 673            ahr.current_shelf_lib,
 674            ahr.behind_desk
 675     FROM action.hold_request ahr
 676          JOIN actor.usr p ON (ahr.usr = p.id)
 677          LEFT JOIN actor.usr_address a ON (p.mailing_address = a.id)
 678          LEFT JOIN actor.usr_address b ON (p.billing_address = b.id)
 679     UNION ALL
 680     SELECT
 681            usr_post_code,
 682            usr_home_ou,
 683            usr_profile,
 684            usr_birth_year,
 685            staff_placed,
 686            id,
 687            request_time,
 688            capture_time,
 689            fulfillment_time,
 690            checkin_time,
 691            return_time,
 692            prev_check_time,
 693            expire_time,
 694            cancel_time,
 695            cancel_cause,
 696            cancel_note,
 697            target,
 698            current_copy,
 699            fulfillment_staff,
 700            fulfillment_lib,
 701            request_lib,
 702            selection_ou,
 703            selection_depth,
 704            pickup_lib,
 705            hold_type,
 706            holdable_formats,
 707            phone_notify,
 708            email_notify,
 709            sms_notify,
 710            frozen,
 711            thaw_date,
 712            shelf_time,
 713            cut_in_line,
 714            mint_condition,
 715            shelf_expire_time,
 716            current_shelf_lib,
 717            behind_desk
 718     FROM action.aged_hold_request;
 719
 720 CREATE OR REPLACE FUNCTION action.age_hold_on_delete () RETURNS TRIGGER AS $$
 721 DECLARE
 722 BEGIN
 723     -- Archive a copy of the old row to action.aged_hold_request
 724
 725     INSERT INTO action.aged_hold_request
 726            (usr_post_code,
 727             usr_home_ou,
 728             usr_profile,
 729             usr_birth_year,
 730             staff_placed,
 731             id,
 732             request_time,
 733             capture_time,
 734             fulfillment_time,
 735             checkin_time,
 736             return_time,
 737             prev_check_time,
 738             expire_time,
 739             cancel_time,
 740             cancel_cause,
 741             cancel_note,
 742             target,
 743             current_copy,
 744             fulfillment_staff,
 745             fulfillment_lib,
 746             request_lib,
 747             selection_ou,
 748             selection_depth,
 749             pickup_lib,
 750             hold_type,
 751             holdable_formats,
 752             phone_notify,
 753             email_notify,
 754             sms_notify,
 755             frozen,
 756             thaw_date,
 757             shelf_time,
 758             cut_in_line,
 759             mint_condition,
 760             shelf_expire_time,
 761             current_shelf_lib,
 762             behind_desk)
 763       SELECT
 764            usr_post_code,
 765            usr_home_ou,
 766            usr_profile,
 767            usr_birth_year,
 768            staff_placed,
 769            id,
 770            request_time,
 771            capture_time,
 772            fulfillment_time,
 773            checkin_time,
 774            return_time,
 775            prev_check_time,
 776            expire_time,
 777            cancel_time,
 778            cancel_cause,
 779            cancel_note,
 780            target,
 781            current_copy,
 782            fulfillment_staff,
 783            fulfillment_lib,
 784            request_lib,
 785            selection_ou,
 786            selection_depth,
 787            pickup_lib,
 788            hold_type,
 789            holdable_formats,
 790            phone_notify,
 791            email_notify,
 792            sms_notify,
 793            frozen,
 794            thaw_date,
 795            shelf_time,
 796            cut_in_line,
 797            mint_condition,
 798            shelf_expire_time,
 799            current_shelf_lib,
 800            behind_desk
 801         FROM action.all_hold_request WHERE id = OLD.id;
 802
 803     RETURN OLD;
 804 END;
 805 $$ LANGUAGE 'plpgsql';
 806
 807 CREATE TRIGGER action_hold_request_aging_tgr
 808         BEFORE DELETE ON action.hold_request
 809         FOR EACH ROW
 810         EXECUTE PROCEDURE action.age_hold_on_delete ();
 811
 812 CREATE TABLE action.fieldset_group (
 813     id              SERIAL  PRIMARY KEY,
 814     name            NEXT        NOT NULL,
 815     create_time     TIMESTAMPTZ NOT NULL DEFAULT NOW(),
 816     complete_time   TIMESTAMPTZ,
 817     container       INT,        -- Points to a container of some type ...
 818     container_type  TEXT,       -- One of 'biblio_record_entry', 'user', 'call_number', 'copy'
 819     rollback_group  INT         REFERENCES action.fieldset_group (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 820     rollback_time   TIMESTAMPTZ,
 821     creator         INT         NOT NULL REFERENCES actor.usr (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 822     owning_lib      INT         NOT NULL REFERENCES actor.org_unit (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED
 823 );
 824
 825 CREATE TABLE action.fieldset (
 826     id              SERIAL          PRIMARY KEY,
 827     fieldset_group  INT             REFERENCES action.fieldset_group (id)
 828                                     DEFERRABLE INITIALLY DEFERRED,
 829     owner           INT             NOT NULL REFERENCES actor.usr (id)
 830                                     DEFERRABLE INITIALLY DEFERRED,
 831         owning_lib      INT             NOT NULL REFERENCES actor.org_unit (id)
 832                                     DEFERRABLE INITIALLY DEFERRED,
 833         status          TEXT            NOT NULL
 834                                         CONSTRAINT valid_status CHECK ( status in
 835                                                                         ( 'PENDING', 'APPLIED', 'ERROR' )),
 836     creation_time   TIMESTAMPTZ     NOT NULL DEFAULT NOW(),
 837     scheduled_time  TIMESTAMPTZ,
 838     applied_time    TIMESTAMPTZ,
 839     classname       TEXT            NOT NULL, -- an IDL class name
 840     name            TEXT            NOT NULL,
 841     error_msg       TEXT,
 842     stored_query    INT             REFERENCES query.stored_query (id)
 843                                     DEFERRABLE INITIALLY DEFERRED,
 844     pkey_value      TEXT,
 845         CONSTRAINT lib_name_unique UNIQUE (owning_lib, name),
 846     CONSTRAINT fieldset_one_or_the_other CHECK (
 847         (stored_query IS NOT NULL AND pkey_value IS NULL) OR
 848         (pkey_value IS NOT NULL AND stored_query IS NULL)
 849     )
 850         -- the CHECK constraint means we can update the fields for a single
 851         -- row without all the extra overhead involved in a query
 852 );
 853
 854 CREATE INDEX action_fieldset_sched_time_idx ON action.fieldset( scheduled_time );
 855 CREATE INDEX action_owner_idx               ON action.fieldset( owner );
 856
 857
 858 CREATE TABLE action.fieldset_col_val (
 859     id              SERIAL  PRIMARY KEY,
 860     fieldset        INT     NOT NULL REFERENCES action.fieldset
 861                                          ON DELETE CASCADE
 862                                          DEFERRABLE INITIALLY DEFERRED,
 863     col             TEXT    NOT NULL,  -- "field" from the idl ... the column on the table
 864     val             TEXT,              -- value for the column ... NULL means, well, NULL
 865     CONSTRAINT fieldset_col_once_per_set UNIQUE (fieldset, col)
 866 );
 867
 868
 869 -- represents a circ chain summary
 870 CREATE TYPE action.circ_chain_summary AS (
 871     num_circs INTEGER,
 872     start_time TIMESTAMP WITH TIME ZONE,
 873     checkout_workstation TEXT,
 874     last_renewal_time TIMESTAMP WITH TIME ZONE, -- NULL if no renewals
 875     last_stop_fines TEXT,
 876     last_stop_fines_time TIMESTAMP WITH TIME ZONE,
 877     last_renewal_workstation TEXT, -- NULL if no renewals
 878     last_checkin_workstation TEXT,
 879     last_checkin_time TIMESTAMP WITH TIME ZONE,
 880     last_checkin_scan_time TIMESTAMP WITH TIME ZONE
 881 );
 882
 883
 884 CREATE OR REPLACE FUNCTION action.circ_chain ( ctx_circ_id BIGINT ) RETURNS SETOF action.circulation AS $$
 885 DECLARE
 886     tmp_circ action.circulation%ROWTYPE;
 887     circ_0 action.circulation%ROWTYPE;
 888 BEGIN
 889
 890     SELECT INTO tmp_circ * FROM action.circulation WHERE id = ctx_circ_id;
 891
 892     IF tmp_circ IS NULL THEN
 893         RETURN NEXT tmp_circ;
 894     END IF;
 895     circ_0 := tmp_circ;
 896
 897     -- find the front of the chain
 898     WHILE TRUE LOOP
 899         SELECT INTO tmp_circ * FROM action.circulation WHERE id = tmp_circ.parent_circ;
 900         IF tmp_circ IS NULL THEN
 901             EXIT;
 902         END IF;
 903         circ_0 := tmp_circ;
 904     END LOOP;
 905
 906     -- now send the circs to the caller, oldest to newest
 907     tmp_circ := circ_0;
 908     WHILE TRUE LOOP
 909         IF tmp_circ IS NULL THEN
 910             EXIT;
 911         END IF;
 912         RETURN NEXT tmp_circ;
 913         SELECT INTO tmp_circ * FROM action.circulation WHERE parent_circ = tmp_circ.id;
 914     END LOOP;
 915
 916 END;
 917 $$ LANGUAGE 'plpgsql';
 918
 919 CREATE OR REPLACE FUNCTION action.summarize_circ_chain ( ctx_circ_id BIGINT ) RETURNS action.circ_chain_summary AS $$
 920
 921 DECLARE
 922
 923     -- first circ in the chain
 924     circ_0 action.circulation%ROWTYPE;
 925
 926     -- last circ in the chain
 927     circ_n action.circulation%ROWTYPE;
 928
 929     -- circ chain under construction
 930     chain action.circ_chain_summary;
 931     tmp_circ action.circulation%ROWTYPE;
 932
 933 BEGIN
 934
 935     chain.num_circs := 0;
 936     FOR tmp_circ IN SELECT * FROM action.circ_chain(ctx_circ_id) LOOP
 937
 938         IF chain.num_circs = 0 THEN
 939             circ_0 := tmp_circ;
 940         END IF;
 941
 942         chain.num_circs := chain.num_circs + 1;
 943         circ_n := tmp_circ;
 944     END LOOP;
 945
 946     chain.start_time := circ_0.xact_start;
 947     chain.last_stop_fines := circ_n.stop_fines;
 948     chain.last_stop_fines_time := circ_n.stop_fines_time;
 949     chain.last_checkin_time := circ_n.checkin_time;
 950     chain.last_checkin_scan_time := circ_n.checkin_scan_time;
 951     SELECT INTO chain.checkout_workstation name FROM actor.workstation WHERE id = circ_0.workstation;
 952     SELECT INTO chain.last_checkin_workstation name FROM actor.workstation WHERE id = circ_n.checkin_workstation;
 953
 954     IF chain.num_circs > 1 THEN
 955         chain.last_renewal_time := circ_n.xact_start;
 956         SELECT INTO chain.last_renewal_workstation name FROM actor.workstation WHERE id = circ_n.workstation;
 957     END IF;
 958
 959     RETURN chain;
 960
 961 END;
 962 $$ LANGUAGE 'plpgsql';
 963
 964 -- same as action.circ_chain, but returns action.all_circulation
 965 -- rows which may include aged circulations.
 966 CREATE OR REPLACE FUNCTION action.all_circ_chain (ctx_circ_id INTEGER)
 967     RETURNS SETOF action.all_circulation_slim AS $$
 968 DECLARE
 969     tmp_circ action.all_circulation_slim%ROWTYPE;
 970     circ_0 action.all_circulation_slim%ROWTYPE;
 971 BEGIN
 972
 973     SELECT INTO tmp_circ * FROM action.all_circulation_slim WHERE id = ctx_circ_id;
 974
 975     IF tmp_circ IS NULL THEN
 976         RETURN NEXT tmp_circ;
 977     END IF;
 978     circ_0 := tmp_circ;
 979
 980     -- find the front of the chain
 981     WHILE TRUE LOOP
 982         SELECT INTO tmp_circ * FROM action.all_circulation_slim
 983             WHERE id = tmp_circ.parent_circ;
 984         IF tmp_circ IS NULL THEN
 985             EXIT;
 986         END IF;
 987         circ_0 := tmp_circ;
 988     END LOOP;
 989
 990     -- now send the circs to the caller, oldest to newest
 991     tmp_circ := circ_0;
 992     WHILE TRUE LOOP
 993         IF tmp_circ IS NULL THEN
 994             EXIT;
 995         END IF;
 996         RETURN NEXT tmp_circ;
 997         SELECT INTO tmp_circ * FROM action.all_circulation_slim
 998             WHERE parent_circ = tmp_circ.id;
 999     END LOOP;
1000
1001 END;
1002 $$ LANGUAGE 'plpgsql';
1003
1004 -- same as action.summarize_circ_chain, but returns data collected
1005 -- from action.all_circulation, which may include aged circulations.
1006 CREATE OR REPLACE FUNCTION action.summarize_all_circ_chain
1007     (ctx_circ_id INTEGER) RETURNS action.circ_chain_summary AS $$
1008
1009 DECLARE
1010
1011     -- first circ in the chain
1012     circ_0 action.all_circulation_slim%ROWTYPE;
1013
1014     -- last circ in the chain
1015     circ_n action.all_circulation_slim%ROWTYPE;
1016
1017     -- circ chain under construction
1018     chain action.circ_chain_summary;
1019     tmp_circ action.all_circulation_slim%ROWTYPE;
1020
1021 BEGIN
1022
1023     chain.num_circs := 0;
1024     FOR tmp_circ IN SELECT * FROM action.all_circ_chain(ctx_circ_id) LOOP
1025
1026         IF chain.num_circs = 0 THEN
1027             circ_0 := tmp_circ;
1028         END IF;
1029
1030         chain.num_circs := chain.num_circs + 1;
1031         circ_n := tmp_circ;
1032     END LOOP;
1033
1034     chain.start_time := circ_0.xact_start;
1035     chain.last_stop_fines := circ_n.stop_fines;
1036     chain.last_stop_fines_time := circ_n.stop_fines_time;
1037     chain.last_checkin_time := circ_n.checkin_time;
1038     chain.last_checkin_scan_time := circ_n.checkin_scan_time;
1039     SELECT INTO chain.checkout_workstation name FROM actor.workstation WHERE id = circ_0.workstation;
1040     SELECT INTO chain.last_checkin_workstation name FROM actor.workstation WHERE id = circ_n.checkin_workstation;
1041
1042     IF chain.num_circs > 1 THEN
1043         chain.last_renewal_time := circ_n.xact_start;
1044         SELECT INTO chain.last_renewal_workstation name FROM actor.workstation WHERE id = circ_n.workstation;
1045     END IF;
1046
1047     RETURN chain;
1048
1049 END;
1050 $$ LANGUAGE 'plpgsql';
1051
1052 CREATE OR REPLACE FUNCTION action.usr_visible_holds (usr_id INT) RETURNS SETOF action.hold_request AS $func$
1053 DECLARE
1054     h               action.hold_request%ROWTYPE;
1055     view_age        INTERVAL;
1056     view_count      INT;
1057     usr_view_count  actor.usr_setting%ROWTYPE;
1058     usr_view_age    actor.usr_setting%ROWTYPE;
1059     usr_view_start  actor.usr_setting%ROWTYPE;
1060 BEGIN
1061     SELECT * INTO usr_view_count FROM actor.usr_setting WHERE usr = usr_id AND name = 'history.hold.retention_count';
1062     SELECT * INTO usr_view_age FROM actor.usr_setting WHERE usr = usr_id AND name = 'history.hold.retention_age';
1063     SELECT * INTO usr_view_start FROM actor.usr_setting WHERE usr = usr_id AND name = 'history.hold.retention_start';
1064
1065     FOR h IN
1066         SELECT  *
1067           FROM  action.hold_request
1068           WHERE usr = usr_id
1069                 AND fulfillment_time IS NULL
1070                 AND cancel_time IS NULL
1071           ORDER BY request_time DESC
1072     LOOP
1073         RETURN NEXT h;
1074     END LOOP;
1075
1076     IF usr_view_start.value IS NULL THEN
1077         RETURN;
1078     END IF;
1079
1080     IF usr_view_age.value IS NOT NULL THEN
1081         -- User opted in and supplied a retention age
1082         IF oils_json_to_text(usr_view_age.value)::INTERVAL > AGE(NOW(), oils_json_to_text(usr_view_start.value)::TIMESTAMPTZ) THEN
1083             view_age := AGE(NOW(), oils_json_to_text(usr_view_start.value)::TIMESTAMPTZ);
1084         ELSE
1085             view_age := oils_json_to_text(usr_view_age.value)::INTERVAL;
1086         END IF;
1087     ELSE
1088         -- User opted in
1089         view_age := AGE(NOW(), oils_json_to_text(usr_view_start.value)::TIMESTAMPTZ);
1090     END IF;
1091
1092     IF usr_view_count.value IS NOT NULL THEN
1093         view_count := oils_json_to_text(usr_view_count.value)::INT;
1094     ELSE
1095         view_count := 1000;
1096     END IF;
1097
1098     -- show some fulfilled/canceled holds
1099     FOR h IN
1100         SELECT  *
1101           FROM  action.hold_request
1102           WHERE usr = usr_id
1103                 AND ( fulfillment_time IS NOT NULL OR cancel_time IS NOT NULL )
1104                 AND COALESCE(fulfillment_time, cancel_time) > NOW() - view_age
1105           ORDER BY COALESCE(fulfillment_time, cancel_time) DESC
1106           LIMIT view_count
1107     LOOP
1108         RETURN NEXT h;
1109     END LOOP;
1110
1111     RETURN;
1112 END;
1113 $func$ LANGUAGE PLPGSQL;
1114
1115 CREATE OR REPLACE FUNCTION action.purge_circulations () RETURNS INT AS $func$
1116 DECLARE
1117     org_keep_age    INTERVAL;
1118     org_use_last    BOOL = false;
1119     org_age_is_min  BOOL = false;
1120     org_keep_count  INT;
1121
1122     keep_age        INTERVAL;
1123
1124     target_acp      RECORD;
1125     circ_chain_head action.circulation%ROWTYPE;
1126     circ_chain_tail action.circulation%ROWTYPE;
1127
1128     count_purged    INT;
1129     num_incomplete  INT;
1130
1131     last_finished   TIMESTAMP WITH TIME ZONE;
1132 BEGIN
1133
1134     count_purged := 0;
1135
1136     SELECT value::INTERVAL INTO org_keep_age FROM config.global_flag WHERE name = 'history.circ.retention_age' AND enabled;
1137
1138     SELECT value::INT INTO org_keep_count FROM config.global_flag WHERE name = 'history.circ.retention_count' AND enabled;
1139     IF org_keep_count IS NULL THEN
1140         RETURN count_purged; -- Gimme a count to keep, or I keep them all, forever
1141     END IF;
1142
1143     SELECT enabled INTO org_use_last FROM config.global_flag WHERE name = 'history.circ.retention_uses_last_finished';
1144     SELECT enabled INTO org_age_is_min FROM config.global_flag WHERE name = 'history.circ.retention_age_is_min';
1145
1146     -- First, find copies with more than keep_count non-renewal circs
1147     FOR target_acp IN
1148         SELECT  target_copy,
1149                 COUNT(*) AS total_real_circs
1150           FROM  action.circulation
1151           WHERE parent_circ IS NULL
1152                 AND xact_finish IS NOT NULL
1153           GROUP BY target_copy
1154           HAVING COUNT(*) > org_keep_count
1155     LOOP
1156         -- And, for those, select circs that are finished and older than keep_age
1157         FOR circ_chain_head IN
1158             -- For reference, the subquery uses a window function to order the circs newest to oldest and number them
1159             -- The outer query then uses that information to skip the most recent set the library wants to keep
1160             -- End result is we don't care what order they come out in, as they are all potentials for deletion.
1161             SELECT ac.* FROM action.circulation ac JOIN (
1162               SELECT  rank() OVER (ORDER BY xact_start DESC), ac.id
1163                 FROM  action.circulation ac
1164                 WHERE ac.target_copy = target_acp.target_copy
1165                   AND ac.parent_circ IS NULL
1166                 ORDER BY ac.xact_start ) ranked USING (id)
1167                 WHERE ranked.rank > org_keep_count
1168         LOOP
1169
1170             SELECT * INTO circ_chain_tail FROM action.circ_chain(circ_chain_head.id) ORDER BY xact_start DESC LIMIT 1;
1171             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);
1172             CONTINUE WHEN circ_chain_tail.xact_finish IS NULL OR num_incomplete > 0;
1173
1174             IF NOT org_use_last THEN
1175                 last_finished := circ_chain_tail.xact_finish;
1176             END IF;
1177
1178             keep_age := COALESCE( org_keep_age, '2000 years'::INTERVAL );
1179
1180             IF org_age_is_min THEN
1181                 keep_age := GREATEST( keep_age, org_keep_age );
1182             END IF;
1183
1184             CONTINUE WHEN AGE(NOW(), last_finished) < keep_age;
1185
1186             -- We've passed the purging tests, purge the circ chain starting at the end
1187             -- A trigger should auto-purge the rest of the chain.
1188             DELETE FROM action.circulation WHERE id = circ_chain_tail.id;
1189
1190             count_purged := count_purged + 1;
1191
1192         END LOOP;
1193     END LOOP;
1194
1195     return count_purged;
1196 END;
1197 $func$ LANGUAGE PLPGSQL;
1198
1199 CREATE OR REPLACE FUNCTION action.purge_holds() RETURNS INT AS $func$
1200 DECLARE
1201   current_hold RECORD;
1202   purged_holds INT;
1203   cgf_d INTERVAL;
1204   cgf_f INTERVAL;
1205   cgf_c INTERVAL;
1206   prev_usr INT;
1207   user_start TIMESTAMPTZ;
1208   user_age INTERVAL;
1209   user_count INT;
1210 BEGIN
1211   purged_holds := 0;
1212   SELECT INTO cgf_d value::INTERVAL FROM config.global_flag WHERE name = 'history.hold.retention_age' AND enabled;
1213   SELECT INTO cgf_f value::INTERVAL FROM config.global_flag WHERE name = 'history.hold.retention_age_fulfilled' AND enabled;
1214   SELECT INTO cgf_c value::INTERVAL FROM config.global_flag WHERE name = 'history.hold.retention_age_canceled' AND enabled;
1215   FOR current_hold IN
1216     SELECT
1217       rank() OVER (PARTITION BY usr ORDER BY COALESCE(fulfillment_time, cancel_time) DESC),
1218       cgf_cs.value::INTERVAL as cgf_cs,
1219       ahr.*
1220     FROM
1221       action.hold_request ahr
1222       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)
1223     WHERE
1224       (fulfillment_time IS NOT NULL OR cancel_time IS NOT NULL)
1225   LOOP
1226     IF prev_usr IS NULL OR prev_usr != current_hold.usr THEN
1227       prev_usr := current_hold.usr;
1228       SELECT INTO user_start oils_json_to_text(value)::TIMESTAMPTZ FROM actor.usr_setting WHERE usr = prev_usr AND name = 'history.hold.retention_start';
1229       SELECT INTO user_age oils_json_to_text(value)::INTERVAL FROM actor.usr_setting WHERE usr = prev_usr AND name = 'history.hold.retention_age';
1230       SELECT INTO user_count oils_json_to_text(value)::INT FROM actor.usr_setting WHERE usr = prev_usr AND name = 'history.hold.retention_count';
1231       IF user_start IS NOT NULL THEN
1232         user_age := LEAST(user_age, AGE(NOW(), user_start));
1233       END IF;
1234       IF user_count IS NULL THEN
1235         user_count := 1000; -- Assumption based on the user visible holds routine
1236       END IF;
1237     END IF;
1238     -- Library keep age trumps user keep anything, for purposes of being able to hold on to things when staff canceled and such.
1239     IF current_hold.fulfillment_time IS NOT NULL AND current_hold.fulfillment_time > NOW() - COALESCE(cgf_f, cgf_d) THEN
1240       CONTINUE;
1241     END IF;
1242     IF current_hold.cancel_time IS NOT NULL AND current_hold.cancel_time > NOW() - COALESCE(current_hold.cgf_cs, cgf_c, cgf_d) THEN
1243       CONTINUE;
1244     END IF;
1245
1246     -- User keep age needs combining with count. If too old AND within the count, keep!
1247     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
1248       CONTINUE;
1249     END IF;
1250
1251     -- All checks should have passed, delete!
1252     DELETE FROM action.hold_request WHERE id = current_hold.id;
1253     purged_holds := purged_holds + 1;
1254   END LOOP;
1255   RETURN purged_holds;
1256 END;
1257 $func$ LANGUAGE plpgsql;
1258
1259 CREATE OR REPLACE FUNCTION action.apply_fieldset(
1260     fieldset_id IN INT,        -- id from action.fieldset
1261     table_name  IN TEXT,       -- table to be updated
1262     pkey_name   IN TEXT,       -- name of primary key column in that table
1263     query       IN TEXT        -- query constructed by qstore (for query-based
1264                                --    fieldsets only; otherwise null
1265 )
1266 RETURNS TEXT AS $$
1267 DECLARE
1268     statement TEXT;
1269     where_clause TEXT;
1270     fs_status TEXT;
1271     fs_pkey_value TEXT;
1272     fs_query TEXT;
1273     sep CHAR;
1274     status_code TEXT;
1275     msg TEXT;
1276     fs_id INT;
1277     fsg_id INT;
1278     update_count INT;
1279     cv RECORD;
1280     fs_obj action.fieldset%ROWTYPE;
1281     fs_group action.fieldset_group%ROWTYPE;
1282     rb_row RECORD;
1283 BEGIN
1284     -- Sanity checks
1285     IF fieldset_id IS NULL THEN
1286         RETURN 'Fieldset ID parameter is NULL';
1287     END IF;
1288     IF table_name IS NULL THEN
1289         RETURN 'Table name parameter is NULL';
1290     END IF;
1291     IF pkey_name IS NULL THEN
1292         RETURN 'Primary key name parameter is NULL';
1293     END IF;
1294
1295     SELECT
1296         status,
1297         quote_literal( pkey_value )
1298     INTO
1299         fs_status,
1300         fs_pkey_value
1301     FROM
1302         action.fieldset
1303     WHERE
1304         id = fieldset_id;
1305
1306     --
1307     -- Build the WHERE clause.  This differs according to whether it's a
1308     -- single-row fieldset or a query-based fieldset.
1309     --
1310     IF query IS NULL        AND fs_pkey_value IS NULL THEN
1311         RETURN 'Incomplete fieldset: neither a primary key nor a query available';
1312     ELSIF query IS NOT NULL AND fs_pkey_value IS NULL THEN
1313         fs_query := rtrim( query, ';' );
1314         where_clause := 'WHERE ' || pkey_name || ' IN ( '
1315                      || fs_query || ' )';
1316     ELSIF query IS NULL     AND fs_pkey_value IS NOT NULL THEN
1317         where_clause := 'WHERE ' || pkey_name || ' = ';
1318         IF pkey_name = 'id' THEN
1319             where_clause := where_clause || fs_pkey_value;
1320         ELSIF pkey_name = 'code' THEN
1321             where_clause := where_clause || quote_literal(fs_pkey_value);
1322         ELSE
1323             RETURN 'Only know how to handle "id" and "code" pkeys currently, received ' || pkey_name;
1324         END IF;
1325     ELSE  -- both are not null
1326         RETURN 'Ambiguous fieldset: both a primary key and a query provided';
1327     END IF;
1328
1329     IF fs_status IS NULL THEN
1330         RETURN 'No fieldset found for id = ' || fieldset_id;
1331     ELSIF fs_status = 'APPLIED' THEN
1332         RETURN 'Fieldset ' || fieldset_id || ' has already been applied';
1333     END IF;
1334
1335     SELECT * INTO fs_obj FROM action.fieldset WHERE id = fieldset_id;
1336     SELECT * INTO fs_group FROM action.fieldset_group WHERE id = fs_obj.fieldset_group;
1337
1338     IF fs_group.can_rollback THEN
1339         -- This is part of a non-rollback group.  We need to record the current values for future rollback.
1340
1341         INSERT INTO action.fieldset_group (can_rollback, name, creator, owning_lib, container, container_type)
1342             VALUES (FALSE, 'ROLLBACK: '|| fs_group.name, fs_group.creator, fs_group.owning_lib, fs_group.container, fs_group.container_type);
1343
1344         fsg_id := CURRVAL('action.fieldset_group_id_seq');
1345
1346         FOR rb_row IN EXECUTE 'SELECT * FROM ' || table_name || ' ' || where_clause LOOP
1347             IF pkey_name = 'id' THEN
1348                 fs_pkey_value := rb_row.id;
1349             ELSIF pkey_name = 'code' THEN
1350                 fs_pkey_value := rb_row.code;
1351             ELSE
1352                 RETURN 'Only know how to handle "id" and "code" pkeys currently, received ' || pkey_name;
1353             END IF;
1354             INSERT INTO action.fieldset (fieldset_group,owner,owning_lib,status,classname,name,pkey_value)
1355                 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);
1356
1357             fs_id := CURRVAL('action.fieldset_id_seq');
1358             sep := '';
1359             FOR cv IN
1360                 SELECT  DISTINCT col
1361                 FROM    action.fieldset_col_val
1362                 WHERE   fieldset = fieldset_id
1363             LOOP
1364                 EXECUTE 'INSERT INTO action.fieldset_col_val (fieldset, col, val) ' ||
1365                     'SELECT '|| fs_id || ', '||quote_literal(cv.col)||', '||cv.col||' FROM '||table_name||' WHERE '||pkey_name||' = '||fs_pkey_value;
1366             END LOOP;
1367         END LOOP;
1368     END IF;
1369
1370     statement := 'UPDATE ' || table_name || ' SET';
1371
1372     sep := '';
1373     FOR cv IN
1374         SELECT  col,
1375                 val
1376         FROM    action.fieldset_col_val
1377         WHERE   fieldset = fieldset_id
1378     LOOP
1379         statement := statement || sep || ' ' || cv.col
1380                      || ' = ' || coalesce( quote_literal( cv.val ), 'NULL' );
1381         sep := ',';
1382     END LOOP;
1383
1384     IF sep = '' THEN
1385         RETURN 'Fieldset ' || fieldset_id || ' has no column values defined';
1386     END IF;
1387     statement := statement || ' ' || where_clause;
1388
1389     --
1390     -- Execute the update
1391     --
1392     BEGIN
1393         EXECUTE statement;
1394         GET DIAGNOSTICS update_count = ROW_COUNT;
1395
1396         IF update_count = 0 THEN
1397             RAISE data_exception;
1398         END IF;
1399
1400         IF fsg_id IS NOT NULL THEN
1401             UPDATE action.fieldset_group SET rollback_group = fsg_id WHERE id = fs_group.id;
1402         END IF;
1403
1404         IF fs_group.id IS NOT NULL THEN
1405             UPDATE action.fieldset_group SET complete_time = now() WHERE id = fs_group.id;
1406         END IF;
1407
1408         UPDATE action.fieldset SET status = 'APPLIED', applied_time = now() WHERE id = fieldset_id;
1409
1410     EXCEPTION WHEN data_exception THEN
1411         msg := 'No eligible rows found for fieldset ' || fieldset_id;
1412         UPDATE action.fieldset SET status = 'ERROR', applied_time = now() WHERE id = fieldset_id;
1413         RETURN msg;
1414
1415     END;
1416
1417     RETURN msg;
1418
1419 EXCEPTION WHEN OTHERS THEN
1420     msg := 'Unable to apply fieldset ' || fieldset_id || ': ' || sqlerrm;
1421     UPDATE action.fieldset SET status = 'ERROR', applied_time = now() WHERE id = fieldset_id;
1422     RETURN msg;
1423
1424 END;
1425 $$ LANGUAGE plpgsql;
1426
1427 COMMENT ON FUNCTION action.apply_fieldset( INT, TEXT, TEXT, TEXT ) IS $$
1428 Applies a specified fieldset, using a supplied table name and primary
1429 key name.  The query parameter should be non-null only for
1430 query-based fieldsets.
1431
1432 Returns NULL if successful, or an error message if not.
1433 $$;
1434
1435 CREATE OR REPLACE FUNCTION action.hold_copy_calculated_proximity(
1436     ahr_id INT,
1437     acp_id BIGINT,
1438     copy_context_ou INT DEFAULT NULL
1439     -- TODO maybe? hold_context_ou INT DEFAULT NULL.  This would optionally
1440     -- support an "ahprox" measurement: adjust prox between copy circ lib and
1441     -- hold request lib, but I'm unsure whether to use this theoretical
1442     -- argument only in the baseline calculation or later in the other
1443     -- queries in this function.
1444 ) RETURNS NUMERIC AS $f$
1445 DECLARE
1446     aoupa           actor.org_unit_proximity_adjustment%ROWTYPE;
1447     ahr             action.hold_request%ROWTYPE;
1448     acp             asset.copy%ROWTYPE;
1449     acn             asset.call_number%ROWTYPE;
1450     acl             asset.copy_location%ROWTYPE;
1451     baseline_prox   NUMERIC;
1452
1453     icl_list        INT[];
1454     iol_list        INT[];
1455     isl_list        INT[];
1456     hpl_list        INT[];
1457     hrl_list        INT[];
1458
1459 BEGIN
1460
1461     SELECT * INTO ahr FROM action.hold_request WHERE id = ahr_id;
1462     SELECT * INTO acp FROM asset.copy WHERE id = acp_id;
1463     SELECT * INTO acn FROM asset.call_number WHERE id = acp.call_number;
1464     SELECT * INTO acl FROM asset.copy_location WHERE id = acp.location;
1465
1466     IF copy_context_ou IS NULL THEN
1467         copy_context_ou := acp.circ_lib;
1468     END IF;
1469
1470     -- First, gather the baseline proximity of "here" to pickup lib
1471     SELECT prox INTO baseline_prox FROM actor.org_unit_proximity WHERE from_org = copy_context_ou AND to_org = ahr.pickup_lib;
1472
1473     -- Find any absolute adjustments, and set the baseline prox to that
1474     SELECT  adj.* INTO aoupa
1475       FROM  actor.org_unit_proximity_adjustment adj
1476             LEFT JOIN actor.org_unit_ancestors_distance(copy_context_ou) acp_cl ON (acp_cl.id = adj.item_circ_lib)
1477             LEFT JOIN actor.org_unit_ancestors_distance(acn.owning_lib) acn_ol ON (acn_ol.id = adj.item_owning_lib)
1478             LEFT JOIN actor.org_unit_ancestors_distance(acl.owning_lib) acl_ol ON (acl_ol.id = adj.copy_location)
1479             LEFT JOIN actor.org_unit_ancestors_distance(ahr.pickup_lib) ahr_pl ON (ahr_pl.id = adj.hold_pickup_lib)
1480             LEFT JOIN actor.org_unit_ancestors_distance(ahr.request_lib) ahr_rl ON (ahr_rl.id = adj.hold_request_lib)
1481       WHERE (adj.circ_mod IS NULL OR adj.circ_mod = acp.circ_modifier) AND
1482             (adj.item_circ_lib IS NULL OR adj.item_circ_lib = acp_cl.id) AND
1483             (adj.item_owning_lib IS NULL OR adj.item_owning_lib = acn_ol.id) AND
1484             (adj.copy_location IS NULL OR adj.copy_location = acl_ol.id) AND
1485             (adj.hold_pickup_lib IS NULL OR adj.hold_pickup_lib = ahr_pl.id) AND
1486             (adj.hold_request_lib IS NULL OR adj.hold_request_lib = ahr_rl.id) AND
1487             absolute_adjustment AND
1488             COALESCE(acp_cl.id, acn_ol.id, acl_ol.id, ahr_pl.id, ahr_rl.id) IS NOT NULL
1489       ORDER BY
1490             COALESCE(acp_cl.distance,999)
1491                 + COALESCE(acn_ol.distance,999)
1492                 + COALESCE(acl_ol.distance,999)
1493                 + COALESCE(ahr_pl.distance,999)
1494                 + COALESCE(ahr_rl.distance,999),
1495             adj.pos
1496       LIMIT 1;
1497
1498     IF FOUND THEN
1499         baseline_prox := aoupa.prox_adjustment;
1500     END IF;
1501
1502     -- Now find any relative adjustments, and change the baseline prox based on them
1503     FOR aoupa IN
1504         SELECT  adj.*
1505           FROM  actor.org_unit_proximity_adjustment adj
1506                 LEFT JOIN actor.org_unit_ancestors_distance(copy_context_ou) acp_cl ON (acp_cl.id = adj.item_circ_lib)
1507                 LEFT JOIN actor.org_unit_ancestors_distance(acn.owning_lib) acn_ol ON (acn_ol.id = adj.item_owning_lib)
1508                 LEFT JOIN actor.org_unit_ancestors_distance(acl.owning_lib) acl_ol ON (acn_ol.id = adj.copy_location)
1509                 LEFT JOIN actor.org_unit_ancestors_distance(ahr.pickup_lib) ahr_pl ON (ahr_pl.id = adj.hold_pickup_lib)
1510                 LEFT JOIN actor.org_unit_ancestors_distance(ahr.request_lib) ahr_rl ON (ahr_rl.id = adj.hold_request_lib)
1511           WHERE (adj.circ_mod IS NULL OR adj.circ_mod = acp.circ_modifier) AND
1512                 (adj.item_circ_lib IS NULL OR adj.item_circ_lib = acp_cl.id) AND
1513                 (adj.item_owning_lib IS NULL OR adj.item_owning_lib = acn_ol.id) AND
1514                 (adj.copy_location IS NULL OR adj.copy_location = acl_ol.id) AND
1515                 (adj.hold_pickup_lib IS NULL OR adj.hold_pickup_lib = ahr_pl.id) AND
1516                 (adj.hold_request_lib IS NULL OR adj.hold_request_lib = ahr_rl.id) AND
1517                 NOT absolute_adjustment AND
1518                 COALESCE(acp_cl.id, acn_ol.id, acl_ol.id, ahr_pl.id, ahr_rl.id) IS NOT NULL
1519     LOOP
1520         baseline_prox := baseline_prox + aoupa.prox_adjustment;
1521     END LOOP;
1522
1523     RETURN baseline_prox;
1524 END;
1525 $f$ LANGUAGE PLPGSQL;
1526
1527 CREATE OR REPLACE FUNCTION action.hold_copy_calculated_proximity_update () RETURNS TRIGGER AS $f$
1528 BEGIN
1529     NEW.proximity := action.hold_copy_calculated_proximity(NEW.hold,NEW.target_copy);
1530     RETURN NEW;
1531 END;
1532 $f$ LANGUAGE PLPGSQL;
1533
1534 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 ();
1535
1536 CREATE TABLE action.usr_circ_history (
1537     id           BIGSERIAL PRIMARY KEY,
1538     usr          INTEGER NOT NULL REFERENCES actor.usr(id)
1539                  DEFERRABLE INITIALLY DEFERRED,
1540     xact_start   TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
1541     target_copy  BIGINT NOT NULL, -- asset.copy.id / serial.unit.id
1542     due_date     TIMESTAMP WITH TIME ZONE NOT NULL,
1543     checkin_time TIMESTAMP WITH TIME ZONE,
1544     source_circ  BIGINT REFERENCES action.circulation(id)
1545                  ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED
1546 );
1547
1548 CREATE INDEX action_usr_circ_history_usr_idx ON action.usr_circ_history ( usr );
1549
1550 CREATE TRIGGER action_usr_circ_history_target_copy_trig
1551     AFTER INSERT OR UPDATE ON action.usr_circ_history
1552     FOR EACH ROW EXECUTE PROCEDURE evergreen.fake_fkey_tgr('target_copy');
1553
1554 CREATE OR REPLACE FUNCTION action.maintain_usr_circ_history()
1555     RETURNS TRIGGER AS $FUNK$
1556 DECLARE
1557     cur_circ  BIGINT;
1558     first_circ BIGINT;
1559 BEGIN
1560
1561     -- Any retention value signifies history is enabled.
1562     -- This assumes that clearing these values via external
1563     -- process deletes the action.usr_circ_history rows.
1564     -- TODO: replace these settings w/ a single bool setting?
1565     PERFORM 1 FROM actor.usr_setting
1566         WHERE usr = NEW.usr AND value IS NOT NULL AND name IN (
1567             'history.circ.retention_age',
1568             'history.circ.retention_start'
1569         );
1570
1571     IF NOT FOUND THEN
1572         RETURN NEW;
1573     END IF;
1574
1575     IF TG_OP = 'INSERT' AND NEW.parent_circ IS NULL THEN
1576         -- Starting a new circulation.  Insert the history row.
1577         INSERT INTO action.usr_circ_history
1578             (usr, xact_start, target_copy, due_date, source_circ)
1579         VALUES (
1580             NEW.usr,
1581             NEW.xact_start,
1582             NEW.target_copy,
1583             NEW.due_date,
1584             NEW.id
1585         );
1586
1587         RETURN NEW;
1588     END IF;
1589
1590     -- find the first and last circs in the circ chain
1591     -- for the currently modified circ.
1592     FOR cur_circ IN SELECT id FROM action.circ_chain(NEW.id) LOOP
1593         IF first_circ IS NULL THEN
1594             first_circ := cur_circ;
1595             CONTINUE;
1596         END IF;
1597         -- Allow the loop to continue so that at as the loop
1598         -- completes cur_circ points to the final circulation.
1599     END LOOP;
1600
1601     IF NEW.id <> cur_circ THEN
1602         -- Modifying an intermediate circ.  Ignore it.
1603         RETURN NEW;
1604     END IF;
1605
1606     -- Update the due_date/checkin_time on the history row if the current
1607     -- circ is the last circ in the chain and an update is warranted.
1608
1609     UPDATE action.usr_circ_history
1610         SET
1611             due_date = NEW.due_date,
1612             checkin_time = NEW.checkin_time
1613         WHERE
1614             source_circ = first_circ
1615             AND (
1616                 due_date <> NEW.due_date OR (
1617                     (checkin_time IS NULL AND NEW.checkin_time IS NOT NULL) OR
1618                     (checkin_time IS NOT NULL AND NEW.checkin_time IS NULL) OR
1619                     (checkin_time <> NEW.checkin_time)
1620                 )
1621             );
1622     RETURN NEW;
1623 END;
1624 $FUNK$ LANGUAGE PLPGSQL;
1625
1626 CREATE TRIGGER maintain_usr_circ_history_tgr
1627     AFTER INSERT OR UPDATE ON action.circulation
1628     FOR EACH ROW EXECUTE PROCEDURE action.maintain_usr_circ_history();
1629
1630 CREATE OR REPLACE VIEW action.all_circulation_combined_types AS
1631  SELECT acirc.id AS id,
1632     acirc.xact_start,
1633     acirc.circ_lib,
1634     acirc.circ_staff,
1635     acirc.create_time,
1636     ac_acirc.circ_modifier AS item_type,
1637     'regular_circ'::text AS circ_type
1638    FROM action.circulation acirc,
1639     asset.copy ac_acirc
1640   WHERE acirc.target_copy = ac_acirc.id
1641 UNION ALL
1642  SELECT ancc.id::BIGINT AS id,
1643     ancc.circ_time AS xact_start,
1644     ancc.circ_lib,
1645     ancc.staff AS circ_staff,
1646     ancc.circ_time AS create_time,
1647     cnct_ancc.name AS item_type,
1648     'non-cat_circ'::text AS circ_type
1649    FROM action.non_cataloged_circulation ancc,
1650     config.non_cataloged_type cnct_ancc
1651   WHERE ancc.item_type = cnct_ancc.id
1652 UNION ALL
1653  SELECT aihu.id::BIGINT AS id,
1654     aihu.use_time AS xact_start,
1655     aihu.org_unit AS circ_lib,
1656     aihu.staff AS circ_staff,
1657     aihu.use_time AS create_time,
1658     ac_aihu.circ_modifier AS item_type,
1659     'in-house_use'::text AS circ_type
1660    FROM action.in_house_use aihu,
1661     asset.copy ac_aihu
1662   WHERE aihu.item = ac_aihu.id
1663 UNION ALL
1664  SELECT ancihu.id::BIGINT AS id,
1665     ancihu.use_time AS xact_start,
1666     ancihu.org_unit AS circ_lib,
1667     ancihu.staff AS circ_staff,
1668     ancihu.use_time AS create_time,
1669     cnct_ancihu.name AS item_type,
1670     'non-cat_circ'::text AS circ_type
1671    FROM action.non_cat_in_house_use ancihu,
1672     config.non_cataloged_type cnct_ancihu
1673   WHERE ancihu.item_type = cnct_ancihu.id
1674 UNION ALL
1675  SELECT aacirc.id AS id,
1676     aacirc.xact_start,
1677     aacirc.circ_lib,
1678     aacirc.circ_staff,
1679     aacirc.create_time,
1680     ac_aacirc.circ_modifier AS item_type,
1681     'aged_circ'::text AS circ_type
1682    FROM action.aged_circulation aacirc,
1683     asset.copy ac_aacirc
1684   WHERE aacirc.target_copy = ac_aacirc.id;
1685
1686 COMMIT;
1687