Open-ILS/src/sql/Pg/002.schema.config.sql

   1 /*
   2  * Copyright (C) 2004-2008  Georgia Public Library Service
   3  * Copyright (C) 2008-2011  Equinox Software, Inc.
   4  * Mike Rylander <miker@esilibrary.com>
   5  * Copyright (C) 2010 Merrimack Valley Library Consortium
   6  * Jason Stephenson <jstephenson@mvlc.org>
   7  * Copyright (C) 2010 Laurentian University
   8  * Dan Scott <dscott@laurentian.ca>
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public License
  12  * as published by the Free Software Foundation; either version 2
  13  * of the License, or (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  */
  21
  22
  23
  24 DROP SCHEMA IF EXISTS stats CASCADE;
  25 DROP SCHEMA IF EXISTS config CASCADE;
  26
  27 BEGIN;
  28 CREATE SCHEMA stats;
  29
  30 CREATE SCHEMA config;
  31 COMMENT ON SCHEMA config IS $$
  32 The config schema holds static configuration data for the
  33 Evergreen installation.
  34 $$;
  35
  36 CREATE TABLE config.internal_flag (
  37     name    TEXT    PRIMARY KEY,
  38     value   TEXT,
  39     enabled BOOL    NOT NULL DEFAULT FALSE
  40 );
  41 INSERT INTO config.internal_flag (name) VALUES ('ingest.metarecord_mapping.skip_on_insert');
  42 INSERT INTO config.internal_flag (name) VALUES ('ingest.metarecord_mapping.skip_on_update');
  43 INSERT INTO config.internal_flag (name) VALUES ('ingest.reingest.force_on_same_marc');
  44 INSERT INTO config.internal_flag (name) VALUES ('ingest.disable_located_uri');
  45 INSERT INTO config.internal_flag (name) VALUES ('ingest.disable_metabib_full_rec');
  46 INSERT INTO config.internal_flag (name) VALUES ('ingest.disable_metabib_rec_descriptor');
  47 INSERT INTO config.internal_flag (name) VALUES ('ingest.assume_inserts_only');
  48 INSERT INTO config.internal_flag (name) VALUES ('ingest.skip_browse_indexing');
  49 INSERT INTO config.internal_flag (name) VALUES ('ingest.skip_search_indexing');
  50 INSERT INTO config.internal_flag (name) VALUES ('ingest.skip_facet_indexing');
  51 INSERT INTO config.internal_flag (name) VALUES ('ingest.skip_display_indexing');
  52 INSERT INTO config.internal_flag (name) VALUES ('serial.rematerialize_on_same_holding_code');
  53 INSERT INTO config.internal_flag (name) VALUES ('ingest.metarecord_mapping.preserve_on_delete');
  54
  55
  56 CREATE TABLE config.global_flag (
  57     label   TEXT    NOT NULL
  58 ) INHERITS (config.internal_flag);
  59 ALTER TABLE config.global_flag ADD PRIMARY KEY (name);
  60
  61 CREATE TABLE config.upgrade_log (
  62     version         TEXT    PRIMARY KEY,
  63     install_date    TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
  64     applied_to      TEXT
  65 );
  66
  67 CREATE TABLE config.db_patch_dependencies (
  68   db_patch      TEXT PRIMARY KEY,
  69   supersedes    TEXT[],
  70   deprecates    TEXT[]
  71 );
  72
  73 CREATE OR REPLACE FUNCTION evergreen.array_overlap_check (/* field */) RETURNS TRIGGER AS $$
  74 DECLARE
  75     fld     TEXT;
  76     cnt     INT;
  77 BEGIN
  78     fld := TG_ARGV[0];
  79     EXECUTE 'SELECT COUNT(*) FROM '|| TG_TABLE_SCHEMA ||'.'|| TG_TABLE_NAME ||' WHERE '|| fld ||' && ($1).'|| fld INTO cnt USING NEW;
  80     IF cnt > 0 THEN
  81         RAISE EXCEPTION 'Cannot insert duplicate array into field % of table %', fld, TG_TABLE_SCHEMA ||'.'|| TG_TABLE_NAME;
  82     END IF;
  83     RETURN NEW;
  84 END;
  85 $$ LANGUAGE PLPGSQL;
  86
  87 CREATE TRIGGER no_overlapping_sups
  88     BEFORE INSERT OR UPDATE ON config.db_patch_dependencies
  89     FOR EACH ROW EXECUTE PROCEDURE evergreen.array_overlap_check ('supersedes');
  90
  91 CREATE TRIGGER no_overlapping_deps
  92     BEFORE INSERT OR UPDATE ON config.db_patch_dependencies
  93     FOR EACH ROW EXECUTE PROCEDURE evergreen.array_overlap_check ('deprecates');
  94
  95 INSERT INTO config.upgrade_log (version, applied_to) VALUES ('1171', :eg_version); -- rhamby/mstroup/gmcharlt
  96 INSERT INTO config.upgrade_log (version, applied_to) VALUES ('3.3.4', :eg_version);
  97
  98 CREATE TABLE config.bib_source (
  99         id              SERIAL  PRIMARY KEY,
 100         quality         INT     CHECK ( quality BETWEEN 0 AND 100 ),
 101         source          TEXT    NOT NULL UNIQUE,
 102         transcendant    BOOL    NOT NULL DEFAULT FALSE,
 103         can_have_copies BOOL    NOT NULL DEFAULT TRUE
 104 );
 105 COMMENT ON TABLE config.bib_source IS $$
 106 This is table is used to set up the relative "quality" of each
 107 MARC source, such as OCLC.  Also identifies "transcendant" sources,
 108 i.e., sources of bib records that should display in the OPAC
 109 even if no copies or located URIs are attached. Also indicates if
 110 the source is allowed to have actual copies on its bibs. Volumes
 111 for targeted URIs are unaffected by this setting.
 112 $$;
 113
 114 CREATE TABLE config.standing (
 115         id              SERIAL  PRIMARY KEY,
 116         value           TEXT    NOT NULL UNIQUE
 117 );
 118 COMMENT ON TABLE config.standing IS $$
 119 Patron Standings
 120
 121 This table contains the values that can be applied to a patron
 122 by a staff member.  These values should not be changed, other
 123 than for translation, as the ID column is currently a "magic
 124 number" in the source. :(
 125 $$;
 126
 127 CREATE TABLE config.standing_penalty (
 128         id                      SERIAL  PRIMARY KEY,
 129         name            TEXT    NOT NULL UNIQUE,
 130         label           TEXT    NOT NULL,
 131         block_list      TEXT,
 132         staff_alert     BOOL    NOT NULL DEFAULT FALSE,
 133         org_depth       INTEGER,
 134         ignore_proximity INTEGER
 135 );
 136
 137 CREATE TABLE config.xml_transform (
 138         name            TEXT    PRIMARY KEY,
 139         namespace_uri   TEXT    NOT NULL,
 140         prefix          TEXT    NOT NULL,
 141         xslt            TEXT    NOT NULL
 142 );
 143
 144 CREATE TABLE config.biblio_fingerprint (
 145         id                      SERIAL  PRIMARY KEY,
 146         name            TEXT    NOT NULL,
 147         xpath           TEXT    NOT NULL,
 148     first_word  BOOL    NOT NULL DEFAULT FALSE,
 149         format          TEXT    NOT NULL DEFAULT 'marcxml'
 150 );
 151
 152 INSERT INTO config.biblio_fingerprint (name, xpath, format)
 153     VALUES (
 154         'Title',
 155         '//marc:datafield[@tag="700"]/marc:subfield[@code="t"]|' ||
 156             '//marc:datafield[@tag="240"]/marc:subfield[@code="a"]|' ||
 157             '//marc:datafield[@tag="242"]/marc:subfield[@code="a"]|' ||
 158             '//marc:datafield[@tag="246"]/marc:subfield[@code="a"]|' ||
 159             '//marc:datafield[@tag="245"]/marc:subfield[@code="a"]',
 160         'marcxml'
 161     );
 162
 163 INSERT INTO config.biblio_fingerprint (name, xpath, format, first_word)
 164     VALUES (
 165         'Author',
 166         '//marc:datafield[@tag="700" and ./*[@code="t"]]/marc:subfield[@code="a"]|'
 167             '//marc:datafield[@tag="100"]/marc:subfield[@code="a"]|'
 168             '//marc:datafield[@tag="110"]/marc:subfield[@code="a"]|'
 169             '//marc:datafield[@tag="111"]/marc:subfield[@code="a"]|'
 170             '//marc:datafield[@tag="260"]/marc:subfield[@code="b"]',
 171         'marcxml',
 172         TRUE
 173     );
 174
 175 INSERT INTO config.biblio_fingerprint (name, xpath, format)
 176     VALUES (
 177         'PartName',
 178         '//mods32:mods/mods32:titleInfo/mods32:partName',
 179         'mods32'
 180     );
 181
 182 INSERT INTO config.biblio_fingerprint (name, xpath, format)
 183     VALUES (
 184         'PartNumber',
 185         '//mods32:mods/mods32:titleInfo/mods32:partNumber',
 186         'mods32'
 187     );
 188
 189 CREATE TABLE config.metabib_class (
 190     name     TEXT    PRIMARY KEY,
 191     label    TEXT    NOT NULL UNIQUE,
 192     buoyant  BOOL    DEFAULT FALSE NOT NULL,
 193     restrict BOOL    DEFAULT FALSE NOT NULL,
 194     combined BOOL    DEFAULT FALSE NOT NULL,
 195     a_weight NUMERIC  DEFAULT 1.0 NOT NULL,
 196     b_weight NUMERIC  DEFAULT 0.4 NOT NULL,
 197     c_weight NUMERIC  DEFAULT 0.2 NOT NULL,
 198     d_weight NUMERIC  DEFAULT 0.1 NOT NULL
 199 );
 200
 201 CREATE TABLE config.metabib_field (
 202         id              SERIAL  PRIMARY KEY,
 203         field_class     TEXT    NOT NULL REFERENCES config.metabib_class (name),
 204         name            TEXT    NOT NULL,
 205         label           TEXT    NOT NULL,
 206         xpath           TEXT,
 207         weight          INT     NOT NULL DEFAULT 1,
 208         format          TEXT    NOT NULL REFERENCES config.xml_transform (name) DEFAULT 'mods33',
 209         search_field    BOOL    NOT NULL DEFAULT TRUE,
 210         facet_field     BOOL    NOT NULL DEFAULT FALSE,
 211         browse_field    BOOL    NOT NULL DEFAULT TRUE,
 212         browse_xpath   TEXT,
 213         browse_sort_xpath TEXT,
 214         facet_xpath     TEXT,
 215         display_xpath   TEXT,
 216         authority_xpath TEXT,
 217         joiner      TEXT,
 218         restrict        BOOL    DEFAULT FALSE NOT NULL,
 219     display_field BOOL NOT NULL DEFAULT TRUE
 220 );
 221 COMMENT ON TABLE config.metabib_field IS $$
 222 XPath used for record indexing ingest
 223
 224 This table contains the XPath used to chop up MODS into its
 225 indexable parts.  Each XPath entry is named and assigned to
 226 a "class" of either title, subject, author, keyword, series
 227 or identifier.
 228 $$;
 229
 230 CREATE TABLE config.metabib_field_virtual_map (
 231     id      SERIAL  PRIMARY KEY,
 232     real    INT NOT NULL REFERENCES config.metabib_field (id),
 233     virtual INT NOT NULL REFERENCES config.metabib_field (id),
 234     weight  INT NOT NULL DEFAULT 1
 235 );
 236 COMMENT ON TABLE config.metabib_field_virtual_map IS $$
 237 Maps between real (physically extracted) index definitions
 238 and virtual (target sync, no required extraction of its own)
 239 index definitions.
 240
 241 The virtual side may not extract any data of its own, but
 242 will collect data from all of the real fields.  This reduces
 243 extraction (ingest) overhead by eliminating duplcated extraction,
 244 and allows for searching across novel combinations of fields, such
 245 as names used as either subjects or authors.  By preserving this
 246 mapping rather than defining duplicate extractions, information
 247 about the originating, "real" index definitions can be used
 248 in interesting ways, such as highlighting in search results.
 249 $$;
 250
 251 CREATE UNIQUE INDEX config_metabib_field_class_name_idx ON config.metabib_field (field_class, name);
 252
 253 CREATE TABLE config.display_field_map (
 254     name    TEXT   PRIMARY KEY,
 255     field   INTEGER REFERENCES config.metabib_field (id),
 256     multi   BOOLEAN DEFAULT FALSE
 257 );
 258
 259 CREATE TABLE config.ts_config_list (
 260         id                      TEXT PRIMARY KEY,
 261         name            TEXT NOT NULL
 262 );
 263 COMMENT ON TABLE config.ts_config_list IS $$
 264 Full Text Configs
 265
 266 A list of full text configs with names and descriptions.
 267 $$;
 268
 269 CREATE TABLE config.metabib_class_ts_map (
 270         id                              SERIAL PRIMARY KEY,
 271         field_class             TEXT NOT NULL REFERENCES config.metabib_class (name),
 272         ts_config               TEXT NOT NULL REFERENCES config.ts_config_list (id),
 273         active                  BOOL NOT NULL DEFAULT TRUE,
 274         index_weight    CHAR(1) NOT NULL DEFAULT 'C' CHECK (index_weight IN ('A','B','C','D')),
 275         index_lang              TEXT NULL,
 276         search_lang             TEXT NULL,
 277         always                  BOOL NOT NULL DEFAULT true
 278 );
 279 COMMENT ON TABLE config.metabib_class_ts_map IS $$
 280 Text Search Configs for metabib class indexing
 281
 282 This table contains text search config definitions for
 283 storing index_vector values.
 284 $$;
 285
 286 CREATE TABLE config.metabib_field_ts_map (
 287         id                              SERIAL PRIMARY KEY,
 288         metabib_field   INT NOT NULL REFERENCES config.metabib_field (id) ON UPDATE CASCADE DEFERRABLE INITIALLY DEFERRED,
 289         ts_config               TEXT NOT NULL REFERENCES config.ts_config_list (id),
 290         active                  BOOL NOT NULL DEFAULT TRUE,
 291         index_weight    CHAR(1) NOT NULL DEFAULT 'C' CHECK (index_weight IN ('A','B','C','D')),
 292         index_lang              TEXT NULL,
 293         search_lang             TEXT NULL
 294 );
 295 COMMENT ON TABLE config.metabib_field_ts_map IS $$
 296 Text Search Configs for metabib field indexing
 297
 298 This table contains text search config definitions for
 299 storing index_vector values.
 300 $$;
 301
 302 CREATE TABLE config.metabib_search_alias (
 303     alias       TEXT    PRIMARY KEY,
 304     field_class TEXT    NOT NULL REFERENCES config.metabib_class (name),
 305     field       INT     REFERENCES config.metabib_field (id) ON UPDATE CASCADE DEFERRABLE INITIALLY DEFERRED
 306 );
 307
 308 CREATE TABLE config.non_cataloged_type (
 309         id              SERIAL          PRIMARY KEY,
 310         owning_lib      INT             NOT NULL, -- REFERENCES actor.org_unit (id),
 311         name            TEXT            NOT NULL,
 312         circ_duration   INTERVAL        NOT NULL DEFAULT '14 days'::INTERVAL,
 313         in_house        BOOL            NOT NULL DEFAULT FALSE,
 314         CONSTRAINT noncat_once_per_lib UNIQUE (owning_lib,name)
 315 );
 316 COMMENT ON TABLE config.non_cataloged_type IS $$
 317 Types of valid non-cataloged items.
 318 $$;
 319
 320 CREATE TABLE config.identification_type (
 321         id              SERIAL  PRIMARY KEY,
 322         name            TEXT    NOT NULL UNIQUE
 323 );
 324 COMMENT ON TABLE config.identification_type IS $$
 325 Types of valid patron identification.
 326
 327 Each patron must display at least one valid form of identification
 328 in order to get a library card.  This table lists those forms.
 329 $$;
 330
 331 CREATE TABLE config.rule_circ_duration (
 332         id              SERIAL          PRIMARY KEY,
 333         name            TEXT            NOT NULL UNIQUE CHECK ( name ~ E'^\\w+$' ),
 334         extended        INTERVAL        NOT NULL,
 335         normal          INTERVAL        NOT NULL,
 336         shrt            INTERVAL        NOT NULL,
 337         max_renewals    INT             NOT NULL,
 338     max_auto_renewals INTEGER
 339 );
 340 COMMENT ON TABLE config.rule_circ_duration IS $$
 341 Circulation Duration rules
 342
 343 Each circulation is given a duration based on one of these rules.
 344 $$;
 345
 346 CREATE TABLE config.hard_due_date (
 347     id                  SERIAL      PRIMARY KEY,
 348     name                TEXT        NOT NULL UNIQUE,
 349     ceiling_date        TIMESTAMPTZ NOT NULL,
 350     forceto             BOOL        NOT NULL,
 351     owner               INT         NOT NULL   -- REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
 352 );
 353
 354 CREATE TABLE config.hard_due_date_values (
 355     id                  SERIAL      PRIMARY KEY,
 356     hard_due_date       INT         NOT NULL REFERENCES config.hard_due_date (id)
 357                                     DEFERRABLE INITIALLY DEFERRED,
 358     ceiling_date        TIMESTAMPTZ NOT NULL,
 359     active_date         TIMESTAMPTZ NOT NULL
 360 );
 361
 362 CREATE OR REPLACE FUNCTION config.update_hard_due_dates () RETURNS INT AS $func$
 363 DECLARE
 364     temp_value  config.hard_due_date_values%ROWTYPE;
 365     updated     INT := 0;
 366 BEGIN
 367     FOR temp_value IN
 368       SELECT  DISTINCT ON (hard_due_date) *
 369         FROM  config.hard_due_date_values
 370         WHERE active_date <= NOW() -- We've passed (or are at) the rollover time
 371         ORDER BY hard_due_date, active_date DESC -- Latest (nearest to us) active time
 372    LOOP
 373         UPDATE  config.hard_due_date
 374           SET   ceiling_date = temp_value.ceiling_date
 375           WHERE id = temp_value.hard_due_date
 376                 AND ceiling_date <> temp_value.ceiling_date -- Time is equal if we've already updated the chdd
 377                 AND temp_value.ceiling_date >= NOW(); -- Don't update ceiling dates to the past
 378
 379         IF FOUND THEN
 380             updated := updated + 1;
 381         END IF;
 382     END LOOP;
 383
 384     RETURN updated;
 385 END;
 386 $func$ LANGUAGE plpgsql;
 387
 388 CREATE TABLE config.rule_max_fine (
 389     id          SERIAL          PRIMARY KEY,
 390     name        TEXT            NOT NULL UNIQUE CHECK ( name ~ E'^\\w+$' ),
 391     amount      NUMERIC(6,2)    NOT NULL,
 392     is_percent  BOOL            NOT NULL DEFAULT FALSE
 393 );
 394 COMMENT ON TABLE config.rule_max_fine IS $$
 395 Circulation Max Fine rules
 396
 397 Each circulation is given a maximum fine based on one of
 398 these rules.
 399 $$;
 400
 401 CREATE TABLE config.rule_recurring_fine (
 402         id                      SERIAL          PRIMARY KEY,
 403         name                    TEXT            NOT NULL UNIQUE CHECK ( name ~ E'^\\w+$' ),
 404         high                    NUMERIC(6,2)    NOT NULL,
 405         normal                  NUMERIC(6,2)    NOT NULL,
 406         low                     NUMERIC(6,2)    NOT NULL,
 407         recurrence_interval     INTERVAL        NOT NULL DEFAULT '1 day'::INTERVAL,
 408     grace_period       INTERVAL         NOT NULL DEFAULT '1 day'::INTERVAL
 409 );
 410 COMMENT ON TABLE config.rule_recurring_fine IS $$
 411 Circulation Recurring Fine rules
 412
 413 Each circulation is given a recurring fine amount based on one of
 414 these rules.  Note that it is recommended to run the fine generator
 415 (from cron) at least as frequently as the lowest recurrence interval
 416 used by your circulation rules so that accrued fines will be up
 417 to date.
 418 $$;
 419
 420
 421 CREATE TABLE config.rule_age_hold_protect (
 422         id      SERIAL          PRIMARY KEY,
 423         name    TEXT            NOT NULL UNIQUE CHECK ( name ~ E'^\\w+$' ),
 424         age     INTERVAL        NOT NULL,
 425         prox    INT             NOT NULL
 426 );
 427 COMMENT ON TABLE config.rule_age_hold_protect IS $$
 428 Hold Item Age Protection rules
 429
 430 A hold request can only capture new(ish) items when they are
 431 within a particular proximity of the pickup_lib of the request.
 432 The proximity ('prox' column) is calculated by counting
 433 the number of tree edges between the pickup_lib and either the
 434 owning_lib or circ_lib of the copy that could fulfill the hold,
 435 as determined by the distance_is_from_owner value of the hold matrix
 436 rule controlling the hold request.
 437 $$;
 438
 439 CREATE TABLE config.copy_status (
 440         id              SERIAL  PRIMARY KEY,
 441         name            TEXT    NOT NULL UNIQUE,
 442         holdable        BOOL    NOT NULL DEFAULT FALSE,
 443         opac_visible    BOOL    NOT NULL DEFAULT FALSE,
 444     copy_active  BOOL    NOT NULL DEFAULT FALSE,
 445         restrict_copy_delete BOOL         NOT NULL DEFAULT FALSE,
 446     is_available  BOOL    NOT NULL DEFAULT FALSE
 447 );
 448 COMMENT ON TABLE config.copy_status IS $$
 449 Copy Statuses
 450
 451 The available copy statuses, and whether a copy in that
 452 status is available for hold request capture.  0 (zero) is
 453 the only special number in this set, meaning that the item
 454 is available for immediate checkout, and is counted as available
 455 in the OPAC.
 456
 457 Statuses with an ID below 100 are not removable, and have special
 458 meaning in the code.  Do not change them except to translate the
 459 textual name.
 460
 461 You may add and remove statuses above 100, and these can be used
 462 to remove items from normal circulation without affecting the rest
 463 of the copy's values or its location.
 464 $$;
 465
 466 CREATE TABLE config.net_access_level (
 467         id      SERIAL          PRIMARY KEY,
 468         name    TEXT            NOT NULL UNIQUE
 469 );
 470 COMMENT ON TABLE config.net_access_level IS $$
 471 Patron Network Access level
 472
 473 This will be used to inform the in-library firewall of how much
 474 internet access the using patron should be allowed.
 475 $$;
 476
 477
 478 CREATE TABLE config.remote_account (
 479     id          SERIAL  PRIMARY KEY,
 480     label       TEXT    NOT NULL,
 481     host        TEXT    NOT NULL,   -- name or IP, :port optional
 482     username    TEXT,               -- optional, since we could default to $USER
 483     password    TEXT,               -- optional, since we could use SSH keys, or anonymous login.
 484     account     TEXT,               -- aka profile or FTP "account" command
 485     path        TEXT,               -- aka directory
 486     owner       INT     NOT NULL,   -- REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
 487     last_activity TIMESTAMP WITH TIME ZONE
 488 );
 489
 490 CREATE TABLE config.marc21_rec_type_map (
 491     code        TEXT    PRIMARY KEY,
 492     type_val    TEXT    NOT NULL,
 493     blvl_val    TEXT    NOT NULL
 494 );
 495
 496 CREATE TABLE config.marc21_ff_pos_map (
 497     id          SERIAL  PRIMARY KEY,
 498     fixed_field TEXT    NOT NULL,
 499     tag         TEXT    NOT NULL,
 500     rec_type    TEXT    NOT NULL,
 501     start_pos   INT     NOT NULL,
 502     length      INT     NOT NULL,
 503     default_val TEXT    NOT NULL DEFAULT ' '
 504 );
 505
 506 CREATE TABLE config.marc21_physical_characteristic_type_map (
 507     ptype_key   TEXT    PRIMARY KEY,
 508     label       TEXT    NOT NULL -- I18N
 509 );
 510
 511 CREATE TABLE config.marc21_physical_characteristic_subfield_map (
 512     id          SERIAL  PRIMARY KEY,
 513     ptype_key   TEXT    NOT NULL REFERENCES config.marc21_physical_characteristic_type_map (ptype_key) ON DELETE CASCADE ON UPDATE CASCADE,
 514     subfield    TEXT    NOT NULL,
 515     start_pos   INT     NOT NULL,
 516     length      INT     NOT NULL,
 517     label       TEXT    NOT NULL -- I18N
 518 );
 519
 520 CREATE TABLE config.marc21_physical_characteristic_value_map (
 521     id              SERIAL  PRIMARY KEY,
 522     value           TEXT    NOT NULL,
 523     ptype_subfield  INT     NOT NULL REFERENCES config.marc21_physical_characteristic_subfield_map (id),
 524     label           TEXT    NOT NULL -- I18N
 525 );
 526
 527
 528 CREATE TABLE config.z3950_source (
 529     name                TEXT    PRIMARY KEY,
 530     label               TEXT    NOT NULL UNIQUE,
 531     host                TEXT    NOT NULL,
 532     port                INT     NOT NULL,
 533     db                  TEXT    NOT NULL,
 534     record_format       TEXT    NOT NULL DEFAULT 'FI',
 535     transmission_format TEXT    NOT NULL DEFAULT 'usmarc',
 536     auth                BOOL    NOT NULL DEFAULT TRUE,
 537     use_perm            INT     -- REFERENCES permission.perm_list (id)
 538 );
 539
 540 COMMENT ON TABLE config.z3950_source IS $$
 541 Z39.50 Sources
 542
 543 Each row in this table represents a database searchable via Z39.50.
 544 $$;
 545
 546 COMMENT ON COLUMN config.z3950_source.record_format IS $$
 547 Z39.50 element set.
 548 $$;
 549
 550 COMMENT ON COLUMN config.z3950_source.transmission_format IS $$
 551 Z39.50 preferred record syntax..
 552 $$;
 553
 554 COMMENT ON COLUMN config.z3950_source.use_perm IS $$
 555 If set, this permission is required for the source to be listed in the staff
 556 client Z39.50 interface.  Similar to permission.grp_tree.application_perm.
 557 $$;
 558
 559 CREATE TABLE config.z3950_attr (
 560     id          SERIAL  PRIMARY KEY,
 561     source      TEXT    NOT NULL REFERENCES config.z3950_source (name) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 562     name        TEXT    NOT NULL,
 563     label       TEXT    NOT NULL,
 564     code        INT     NOT NULL,
 565     format      INT     NOT NULL,
 566     truncation  INT     NOT NULL DEFAULT 0,
 567     CONSTRAINT z_code_format_once_per_source UNIQUE (code,format,source)
 568 );
 569
 570 CREATE TABLE config.z3950_source_credentials (
 571     id SERIAL PRIMARY KEY,
 572     owner INTEGER NOT NULL, -- REFERENCES actor.org_unit(id),
 573     source TEXT NOT NULL REFERENCES config.z3950_source(name) ON DELETE CASCADE ON UPDATE CASCADE DEFERRABLE INITIALLY DEFERRED,
 574     username TEXT,
 575     password TEXT,
 576     CONSTRAINT czsc_source_once_per_lib UNIQUE (source, owner)
 577 );
 578
 579 CREATE TABLE config.i18n_locale (
 580     code        TEXT    PRIMARY KEY,
 581     marc_code   TEXT    NOT NULL, -- should exist in config.coded_value_map WHERE ctype = 'item_lang'
 582     name        TEXT    UNIQUE NOT NULL,
 583     description TEXT,
 584     rtl         BOOL    NOT NULL DEFAULT FALSE
 585 );
 586
 587 CREATE TABLE config.i18n_core (
 588     id              BIGSERIAL   PRIMARY KEY,
 589     fq_field        TEXT        NOT NULL,
 590     identity_value  TEXT        NOT NULL,
 591     translation     TEXT        NOT NULL    REFERENCES config.i18n_locale (code) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 592     string          TEXT        NOT NULL
 593 );
 594
 595 CREATE UNIQUE INDEX i18n_identity ON config.i18n_core (fq_field,identity_value,translation);
 596
 597 CREATE OR REPLACE FUNCTION oils_i18n_update_apply(old_ident TEXT, new_ident TEXT, hint TEXT) RETURNS VOID AS $_$
 598 BEGIN
 599
 600     EXECUTE $$
 601         UPDATE  config.i18n_core
 602           SET   identity_value = $$ || quote_literal(new_ident) || $$
 603           WHERE fq_field LIKE '$$ || hint || $$.%'
 604                 AND identity_value = $$ || quote_literal(old_ident) || $$::TEXT;$$;
 605
 606     RETURN;
 607
 608 END;
 609 $_$ LANGUAGE PLPGSQL;
 610
 611 CREATE OR REPLACE FUNCTION oils_i18n_id_tracking(/* hint */) RETURNS TRIGGER AS $_$
 612 BEGIN
 613     PERFORM oils_i18n_update_apply( OLD.id::TEXT, NEW.id::TEXT, TG_ARGV[0]::TEXT );
 614     RETURN NEW;
 615 END;
 616 $_$ LANGUAGE PLPGSQL;
 617
 618 CREATE OR REPLACE FUNCTION oils_i18n_code_tracking(/* hint */) RETURNS TRIGGER AS $_$
 619 BEGIN
 620     PERFORM oils_i18n_update_apply( OLD.code::TEXT, NEW.code::TEXT, TG_ARGV[0]::TEXT );
 621     RETURN NEW;
 622 END;
 623 $_$ LANGUAGE PLPGSQL;
 624
 625 CREATE TABLE config.billing_type (
 626     id              SERIAL  PRIMARY KEY,
 627     name            TEXT    NOT NULL,
 628     owner           INT     NOT NULL, -- REFERENCES actor.org_unit (id)
 629     default_price   NUMERIC(6,2),
 630     CONSTRAINT billing_type_once_per_lib UNIQUE (name, owner)
 631 );
 632
 633 CREATE TABLE config.settings_group (
 634     name    TEXT PRIMARY KEY,
 635     label   TEXT UNIQUE NOT NULL -- I18N
 636 );
 637
 638 CREATE TABLE config.org_unit_setting_type (
 639     name            TEXT    PRIMARY KEY,
 640     label           TEXT    UNIQUE NOT NULL,
 641     grp             TEXT    REFERENCES config.settings_group (name),
 642     description     TEXT,
 643     datatype        TEXT    NOT NULL DEFAULT 'string',
 644     fm_class        TEXT,
 645     view_perm       INT,
 646     update_perm     INT,
 647     --
 648     -- define valid datatypes
 649     --
 650     CONSTRAINT coust_valid_datatype CHECK ( datatype IN
 651     ( 'bool', 'integer', 'float', 'currency', 'interval',
 652       'date', 'string', 'object', 'array', 'link' ) ),
 653     --
 654     -- fm_class is meaningful only for 'link' datatype
 655     --
 656     CONSTRAINT coust_no_empty_link CHECK
 657     ( ( datatype =  'link' AND fm_class IS NOT NULL ) OR
 658       ( datatype <> 'link' AND fm_class IS NULL ) )
 659 );
 660
 661 CREATE TABLE config.usr_setting_type (
 662
 663     name TEXT PRIMARY KEY,
 664     opac_visible BOOL NOT NULL DEFAULT FALSE,
 665     label TEXT UNIQUE NOT NULL,
 666     description TEXT,
 667     grp             TEXT    REFERENCES config.settings_group (name),
 668     datatype TEXT NOT NULL DEFAULT 'string',
 669     fm_class TEXT,
 670     reg_default TEXT,
 671
 672     --
 673     -- define valid datatypes
 674     --
 675     CONSTRAINT coust_valid_datatype CHECK ( datatype IN
 676     ( 'bool', 'integer', 'float', 'currency', 'interval',
 677         'date', 'string', 'object', 'array', 'link' ) ),
 678
 679     --
 680     -- fm_class is meaningful only for 'link' datatype
 681     --
 682     CONSTRAINT coust_no_empty_link CHECK
 683     ( ( datatype = 'link' AND fm_class IS NOT NULL ) OR
 684         ( datatype <> 'link' AND fm_class IS NULL ) )
 685
 686 );
 687
 688 CREATE TABLE config.workstation_setting_type (
 689     name            TEXT    PRIMARY KEY,
 690     label           TEXT    UNIQUE NOT NULL,
 691     grp             TEXT    REFERENCES config.settings_group (name),
 692     description     TEXT,
 693     datatype        TEXT    NOT NULL DEFAULT 'string',
 694     fm_class        TEXT,
 695     --
 696     -- define valid datatypes
 697     --
 698     CONSTRAINT cwst_valid_datatype CHECK ( datatype IN
 699     ( 'bool', 'integer', 'float', 'currency', 'interval',
 700       'date', 'string', 'object', 'array', 'link' ) ),
 701     --
 702     -- fm_class is meaningful only for 'link' datatype
 703     --
 704     CONSTRAINT cwst_no_empty_link CHECK
 705     ( ( datatype =  'link' AND fm_class IS NOT NULL ) OR
 706       ( datatype <> 'link' AND fm_class IS NULL ) )
 707 );
 708
 709 -- Prevent setting types from being both user and workstation settings.
 710 CREATE OR REPLACE FUNCTION config.setting_is_user_or_ws()
 711 RETURNS TRIGGER AS $FUNC$
 712 BEGIN
 713
 714     IF TG_TABLE_NAME = 'usr_setting_type' THEN
 715         PERFORM TRUE FROM config.workstation_setting_type cwst
 716             WHERE cwst.name = NEW.name;
 717         IF NOT FOUND THEN
 718             RETURN NULL;
 719         END IF;
 720     END IF;
 721
 722     IF TG_TABLE_NAME = 'workstation_setting_type' THEN
 723         PERFORM TRUE FROM config.usr_setting_type cust
 724             WHERE cust.name = NEW.name;
 725         IF NOT FOUND THEN
 726             RETURN NULL;
 727         END IF;
 728     END IF;
 729
 730     RAISE EXCEPTION
 731         '% Cannot be used as both a user setting and a workstation setting.',
 732         NEW.name;
 733 END;
 734 $FUNC$ LANGUAGE PLPGSQL STABLE;
 735
 736 CREATE CONSTRAINT TRIGGER check_setting_is_usr_or_ws
 737   AFTER INSERT OR UPDATE ON config.usr_setting_type
 738   FOR EACH ROW EXECUTE PROCEDURE config.setting_is_user_or_ws();
 739
 740 CREATE CONSTRAINT TRIGGER check_setting_is_usr_or_ws
 741   AFTER INSERT OR UPDATE ON config.workstation_setting_type
 742   FOR EACH ROW EXECUTE PROCEDURE config.setting_is_user_or_ws();
 743
 744
 745
 746 -- Some handy functions, based on existing ones, to provide optional ingest normalization
 747
 748 CREATE OR REPLACE FUNCTION public.left_trunc( TEXT, INT ) RETURNS TEXT AS $func$
 749         SELECT SUBSTRING($1,$2);
 750 $func$ LANGUAGE SQL STRICT IMMUTABLE;
 751
 752 CREATE OR REPLACE FUNCTION public.right_trunc( TEXT, INT ) RETURNS TEXT AS $func$
 753         SELECT SUBSTRING($1,1,$2);
 754 $func$ LANGUAGE SQL STRICT IMMUTABLE;
 755
 756 CREATE OR REPLACE FUNCTION public.split_date_range( TEXT ) RETURNS TEXT AS $func$
 757         SELECT REGEXP_REPLACE( $1, E'(\\d{4})-(\\d{4})', E'\\1 \\2', 'g' );
 758 $func$ LANGUAGE SQL STRICT IMMUTABLE;
 759
 760 CREATE OR REPLACE FUNCTION public.approximate_date( TEXT, TEXT ) RETURNS TEXT AS $func$
 761         SELECT REGEXP_REPLACE( $1, E'\\D', $2, 'g' );
 762 $func$ LANGUAGE SQL STRICT IMMUTABLE;
 763
 764 CREATE OR REPLACE FUNCTION public.approximate_low_date( TEXT ) RETURNS TEXT AS $func$
 765         SELECT approximate_date( $1, '0');
 766 $func$ LANGUAGE SQL STRICT IMMUTABLE;
 767
 768 CREATE OR REPLACE FUNCTION public.approximate_high_date( TEXT ) RETURNS TEXT AS $func$
 769         SELECT approximate_date( $1, '9');
 770 $func$ LANGUAGE SQL STRICT IMMUTABLE;
 771
 772 CREATE OR REPLACE FUNCTION public.content_or_null( TEXT ) RETURNS TEXT AS $func$
 773         SELECT CASE WHEN $1 ~ E'^\\s*$' THEN NULL ELSE $1 END
 774 $func$ LANGUAGE SQL STRICT IMMUTABLE;
 775
 776 CREATE OR REPLACE FUNCTION public.integer_or_null( TEXT ) RETURNS TEXT AS $func$
 777         SELECT CASE WHEN $1 ~ E'^\\d+$' THEN $1 ELSE NULL END
 778 $func$ LANGUAGE SQL STRICT IMMUTABLE;
 779
 780 CREATE OR REPLACE FUNCTION public.force_to_isbn13( TEXT ) RETURNS TEXT AS $func$
 781     use Business::ISBN;
 782     use strict;
 783     use warnings;
 784
 785     # Find the first ISBN, force it to ISBN13 and return it
 786
 787     my $input = shift;
 788
 789     foreach my $word (split(/\s/, $input)) {
 790         my $isbn = Business::ISBN->new($word);
 791
 792         # First check the checksum; if it is not valid, fix it and add the original
 793         # bad-checksum ISBN to the output
 794         if ($isbn && $isbn->is_valid_checksum() == Business::ISBN::BAD_CHECKSUM) {
 795             $isbn->fix_checksum();
 796         }
 797
 798         # If we now have a valid ISBN, force it to ISBN13 and return it
 799         return $isbn->as_isbn13->isbn if ($isbn && $isbn->is_valid());
 800     }
 801     return undef;
 802 $func$ LANGUAGE PLPERLU;
 803
 804 COMMENT ON FUNCTION public.force_to_isbn13(TEXT) IS $$
 805 Inspired by translate_isbn1013
 806
 807 The force_to_isbn13 function takes an input ISBN and returns the ISBN13
 808 version without hypens and with a repaired checksum if the checksum was bad
 809 $$;
 810
 811
 812 CREATE OR REPLACE FUNCTION public.translate_isbn1013( TEXT ) RETURNS TEXT AS $func$
 813     use Business::ISBN;
 814     use strict;
 815     use warnings;
 816
 817     # For each ISBN found in a single string containing a set of ISBNs:
 818     #   * Normalize an incoming ISBN to have the correct checksum and no hyphens
 819     #   * Convert an incoming ISBN10 or ISBN13 to its counterpart and return
 820
 821     my $input = shift;
 822     my $output = '';
 823
 824     foreach my $word (split(/\s/, $input)) {
 825         my $isbn = Business::ISBN->new($word);
 826
 827         # First check the checksum; if it is not valid, fix it and add the original
 828         # bad-checksum ISBN to the output
 829         if ($isbn && $isbn->is_valid_checksum() == Business::ISBN::BAD_CHECKSUM) {
 830             $output .= $isbn->isbn() . " ";
 831             $isbn->fix_checksum();
 832         }
 833
 834         # If we now have a valid ISBN, convert it to its counterpart ISBN10/ISBN13
 835         # and add the normalized original ISBN to the output
 836         if ($isbn && $isbn->is_valid()) {
 837             my $isbn_xlated = ($isbn->type eq "ISBN13") ? $isbn->as_isbn10 : $isbn->as_isbn13;
 838             $output .= $isbn->isbn . " ";
 839
 840             # If we successfully converted the ISBN to its counterpart, add the
 841             # converted ISBN to the output as well
 842             $output .= ($isbn_xlated->isbn . " ") if ($isbn_xlated);
 843         }
 844     }
 845     return $output if $output;
 846
 847     # If there were no valid ISBNs, just return the raw input
 848     return $input;
 849 $func$ LANGUAGE PLPERLU;
 850
 851 COMMENT ON FUNCTION public.translate_isbn1013(TEXT) IS $$
 852 The translate_isbn1013 function takes an input ISBN and returns the
 853 following in a single space-delimited string if the input ISBN is valid:
 854   - The normalized input ISBN (hyphens stripped)
 855   - The normalized input ISBN with a fixed checksum if the checksum was bad
 856   - The ISBN converted to its ISBN10 or ISBN13 counterpart, if possible
 857 $$;
 858
 859 -- And ... a table in which to register them
 860
 861 CREATE TABLE config.index_normalizer (
 862         id              SERIAL  PRIMARY KEY,
 863         name            TEXT    UNIQUE NOT NULL,
 864         description     TEXT,
 865         func            TEXT    NOT NULL,
 866         param_count     INT     NOT NULL DEFAULT 0
 867 );
 868
 869 CREATE TABLE config.metabib_field_index_norm_map (
 870         id      SERIAL  PRIMARY KEY,
 871         field   INT     NOT NULL REFERENCES config.metabib_field (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 872         norm    INT     NOT NULL REFERENCES config.index_normalizer (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 873         params  TEXT,
 874         pos     INT     NOT NULL DEFAULT 0
 875 );
 876
 877 CREATE TABLE config.record_attr_definition (
 878     name        TEXT    PRIMARY KEY,
 879     label       TEXT    NOT NULL, -- I18N
 880     description TEXT,
 881     multi       BOOL    NOT NULL DEFAULT TRUE,  -- will store all values from a record
 882     filter      BOOL    NOT NULL DEFAULT TRUE,  -- becomes QP filter if true
 883     sorter      BOOL    NOT NULL DEFAULT FALSE, -- becomes QP sort() axis if true
 884     composite   BOOL    NOT NULL DEFAULT FALSE, -- its values are derived from others
 885
 886 -- For pre-extracted fields. Takes the first occurance, uses naive subfield ordering
 887     tag         TEXT, -- LIKE format
 888     sf_list     TEXT, -- pile-o-values, like 'abcd' for a and b and c and d
 889
 890 -- This is used for both tag/sf and xpath entries
 891     joiner      TEXT,
 892
 893 -- For xpath-extracted attrs
 894     xpath       TEXT,
 895     format      TEXT    REFERENCES config.xml_transform (name) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 896     start_pos   INT,
 897     string_len  INT,
 898
 899 -- For fixed fields
 900     fixed_field TEXT, -- should exist in config.marc21_ff_pos_map.fixed_field
 901
 902 -- For phys-char fields
 903     phys_char_sf    INT REFERENCES config.marc21_physical_characteristic_subfield_map (id),
 904
 905 -- Source of vocabulary terms for this record attribute;
 906 -- typically will be a URI referring to a SKOS vocabulary
 907     vocabulary  TEXT
 908 );
 909
 910 CREATE TABLE config.record_attr_index_norm_map (
 911     id      SERIAL  PRIMARY KEY,
 912     attr    TEXT    NOT NULL REFERENCES config.record_attr_definition (name) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 913     norm    INT     NOT NULL REFERENCES config.index_normalizer (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 914     params  TEXT,
 915     pos     INT     NOT NULL DEFAULT 0
 916 );
 917
 918 CREATE TABLE config.coded_value_map (
 919     id              SERIAL  PRIMARY KEY,
 920     ctype           TEXT    NOT NULL REFERENCES config.record_attr_definition (name) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 921     code            TEXT    NOT NULL,
 922     value           TEXT    NOT NULL,
 923     description     TEXT,
 924     opac_visible    BOOL    NOT NULL DEFAULT TRUE, -- For TPac selectors
 925     search_label    TEXT,
 926     is_simple       BOOL    NOT NULL DEFAULT FALSE,
 927     concept_uri     TEXT    -- URI expressing the SKOS concept that the
 928                             -- coded value represents
 929 );
 930
 931 CREATE INDEX config_coded_value_map_ctype_idx ON config.coded_value_map (ctype);
 932
 933 CREATE VIEW config.language_map AS SELECT code, value FROM config.coded_value_map WHERE ctype = 'item_lang';
 934 CREATE VIEW config.bib_level_map AS SELECT code, value FROM config.coded_value_map WHERE ctype = 'bib_level';
 935 CREATE VIEW config.item_form_map AS SELECT code, value FROM config.coded_value_map WHERE ctype = 'item_form';
 936 CREATE VIEW config.item_type_map AS SELECT code, value FROM config.coded_value_map WHERE ctype = 'item_type';
 937 CREATE VIEW config.lit_form_map AS SELECT code, value, description FROM config.coded_value_map WHERE ctype = 'lit_form';
 938 CREATE VIEW config.audience_map AS SELECT code, value, description FROM config.coded_value_map WHERE ctype = 'audience';
 939 CREATE VIEW config.videorecording_format_map AS SELECT code, value FROM config.coded_value_map WHERE ctype = 'vr_format';
 940
 941 CREATE OR REPLACE FUNCTION config.update_coded_value_map(in_ctype TEXT, in_code TEXT, in_value TEXT, in_description TEXT DEFAULT NULL, in_opac_visible BOOL DEFAULT NULL, in_search_label TEXT DEFAULT NULL, in_is_simple BOOL DEFAULT NULL, add_only BOOL DEFAULT FALSE) RETURNS VOID AS $f$
 942 DECLARE
 943     current_row config.coded_value_map%ROWTYPE;
 944 BEGIN
 945     -- Look for a current value
 946     SELECT INTO current_row * FROM config.coded_value_map WHERE ctype = in_ctype AND code = in_code;
 947     -- If we have one..
 948     IF FOUND AND NOT add_only THEN
 949         -- Update anything we were handed
 950         current_row.value := COALESCE(current_row.value, in_value);
 951         current_row.description := COALESCE(current_row.description, in_description);
 952         current_row.opac_visible := COALESCE(current_row.opac_visible, in_opac_visible);
 953         current_row.search_label := COALESCE(current_row.search_label, in_search_label);
 954         current_row.is_simple := COALESCE(current_row.is_simple, in_is_simple);
 955         UPDATE config.coded_value_map
 956             SET
 957                 value = current_row.value,
 958                 description = current_row.description,
 959                 opac_visible = current_row.opac_visible,
 960                 search_label = current_row.search_label,
 961                 is_simple = current_row.is_simple
 962             WHERE id = current_row.id;
 963     ELSE
 964         INSERT INTO config.coded_value_map(ctype, code, value, description, opac_visible, search_label, is_simple) VALUES
 965             (in_ctype, in_code, in_value, in_description, COALESCE(in_opac_visible, TRUE), in_search_label, COALESCE(in_is_simple, FALSE));
 966     END IF;
 967 END;
 968 $f$ LANGUAGE PLPGSQL;
 969
 970 CREATE TABLE config.composite_attr_entry_definition(
 971     coded_value INT  PRIMARY KEY NOT NULL REFERENCES config.coded_value_map (id) ON UPDATE CASCADE ON DELETE CASCADE,
 972     definition  TEXT    NOT NULL -- JSON
 973 );
 974
 975 -- List applied db patches that are deprecated by (and block the application of) my_db_patch
 976 CREATE OR REPLACE FUNCTION evergreen.upgrade_list_applied_deprecates ( my_db_patch TEXT ) RETURNS SETOF evergreen.patch AS $$
 977     SELECT  DISTINCT l.version
 978       FROM  config.upgrade_log l
 979             JOIN config.db_patch_dependencies d ON (l.version = ANY(d.deprecates))
 980       WHERE d.db_patch = $1
 981 $$ LANGUAGE SQL;
 982
 983 -- List applied db patches that are superseded by (and block the application of) my_db_patch
 984 CREATE OR REPLACE FUNCTION evergreen.upgrade_list_applied_supersedes ( my_db_patch TEXT ) RETURNS SETOF evergreen.patch AS $$
 985     SELECT  DISTINCT l.version
 986       FROM  config.upgrade_log l
 987             JOIN config.db_patch_dependencies d ON (l.version = ANY(d.supersedes))
 988       WHERE d.db_patch = $1
 989 $$ LANGUAGE SQL;
 990
 991 -- List applied db patches that deprecates (and block the application of) my_db_patch
 992 CREATE FUNCTION evergreen.upgrade_list_applied_deprecated ( my_db_patch TEXT ) RETURNS SETOF TEXT AS $$
 993     SELECT  db_patch
 994       FROM  config.db_patch_dependencies
 995       WHERE ARRAY[$1]::TEXT[] && deprecates
 996 $$ LANGUAGE SQL;
 997
 998 -- List applied db patches that supersedes (and block the application of) my_db_patch
 999 CREATE FUNCTION evergreen.upgrade_list_applied_superseded ( my_db_patch TEXT ) RETURNS SETOF TEXT AS $$
1000     SELECT  db_patch
1001       FROM  config.db_patch_dependencies
1002       WHERE ARRAY[$1]::TEXT[] && supersedes
1003 $$ LANGUAGE SQL;
1004
1005 -- Make sure that no deprecated or superseded db patches are currently applied
1006 CREATE OR REPLACE FUNCTION evergreen.upgrade_verify_no_dep_conflicts ( my_db_patch TEXT ) RETURNS BOOL AS $$
1007     SELECT  COUNT(*) = 0
1008       FROM  (SELECT * FROM evergreen.upgrade_list_applied_deprecates( $1 )
1009                 UNION
1010              SELECT * FROM evergreen.upgrade_list_applied_supersedes( $1 )
1011                 UNION
1012              SELECT * FROM evergreen.upgrade_list_applied_deprecated( $1 )
1013                 UNION
1014              SELECT * FROM evergreen.upgrade_list_applied_superseded( $1 ))x
1015 $$ LANGUAGE SQL;
1016
1017 -- Raise an exception if there are, in fact, dep/sup conflict
1018 CREATE OR REPLACE FUNCTION evergreen.upgrade_deps_block_check ( my_db_patch TEXT, my_applied_to TEXT ) RETURNS BOOL AS $$
1019 DECLARE
1020     deprecates TEXT;
1021     supersedes TEXT;
1022 BEGIN
1023     IF NOT evergreen.upgrade_verify_no_dep_conflicts( my_db_patch ) THEN
1024         SELECT  STRING_AGG(patch, ', ') INTO deprecates FROM evergreen.upgrade_list_applied_deprecates(my_db_patch);
1025         SELECT  STRING_AGG(patch, ', ') INTO supersedes FROM evergreen.upgrade_list_applied_supersedes(my_db_patch);
1026         RAISE EXCEPTION '
1027 Upgrade script % can not be applied:
1028   applied deprecated scripts %
1029   applied superseded scripts %
1030   deprecated by %
1031   superseded by %',
1032             my_db_patch,
1033             (SELECT ARRAY_AGG(patch) FROM evergreen.upgrade_list_applied_deprecates(my_db_patch)),
1034             (SELECT ARRAY_AGG(patch) FROM evergreen.upgrade_list_applied_supersedes(my_db_patch)),
1035             evergreen.upgrade_list_applied_deprecated(my_db_patch),
1036             evergreen.upgrade_list_applied_superseded(my_db_patch);
1037     END IF;
1038
1039     INSERT INTO config.upgrade_log (version, applied_to) VALUES (my_db_patch, my_applied_to);
1040     RETURN TRUE;
1041 END;
1042 $$ LANGUAGE PLPGSQL;
1043
1044 CREATE TABLE config.barcode_completion (
1045     id          SERIAL PRIMARY KEY,
1046     active      BOOL NOT NULL DEFAULT true,
1047     org_unit    INT NOT NULL, -- REFERENCES actor.org_unit(id) DEFERRABLE INITIALLY DEFERRED,
1048     prefix      TEXT,
1049     suffix      TEXT,
1050     length      INT NOT NULL DEFAULT 0,
1051     padding     TEXT,
1052     padding_end BOOL NOT NULL DEFAULT false,
1053     asset       BOOL NOT NULL DEFAULT true,
1054     actor       BOOL NOT NULL DEFAULT true
1055 );
1056
1057 CREATE TYPE evergreen.barcode_set AS (type TEXT, id BIGINT, barcode TEXT);
1058
1059 -- Add support for logging, only keep the most recent five rows for each category.
1060
1061
1062 CREATE TABLE config.org_unit_setting_type_log (
1063     id              BIGSERIAL   PRIMARY KEY,
1064     date_applied    TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
1065     org             INT,   --REFERENCES actor.org_unit (id),
1066     original_value  TEXT,
1067     new_value       TEXT,
1068     field_name      TEXT      REFERENCES config.org_unit_setting_type (name) DEFERRABLE INITIALLY DEFERRED
1069 );
1070
1071 COMMENT ON TABLE config.org_unit_setting_type_log IS $$
1072 Org Unit setting Logs
1073
1074 This table contains the most recent changes to each setting
1075 in actor.org_unit_setting, allowing for mistakes to be undone.
1076 This is NOT meant to be an auditor, but rather an undo/redo.
1077 $$;
1078
1079 CREATE OR REPLACE FUNCTION evergreen.limit_oustl() RETURNS TRIGGER AS $oustl_limit$
1080     BEGIN
1081         -- Only keeps the most recent five settings changes.
1082         DELETE FROM config.org_unit_setting_type_log WHERE field_name = NEW.field_name AND org = NEW.org AND date_applied NOT IN
1083         (SELECT date_applied FROM config.org_unit_setting_type_log WHERE field_name = NEW.field_name AND org = NEW.org ORDER BY date_applied DESC LIMIT 4);
1084
1085         IF (TG_OP = 'UPDATE') THEN
1086             RETURN NEW;
1087         ELSIF (TG_OP = 'INSERT') THEN
1088             RETURN NEW;
1089         END IF;
1090         RETURN NULL;
1091     END;
1092 $oustl_limit$ LANGUAGE plpgsql;
1093
1094 CREATE TRIGGER limit_logs_oust
1095     BEFORE INSERT OR UPDATE ON config.org_unit_setting_type_log
1096     FOR EACH ROW EXECUTE PROCEDURE limit_oustl();
1097
1098 CREATE TABLE config.sms_carrier (
1099     id              SERIAL PRIMARY KEY,
1100     region          TEXT,
1101     name            TEXT,
1102     email_gateway   TEXT,
1103     active          BOOLEAN DEFAULT TRUE
1104 );
1105
1106 CREATE TYPE config.usr_activity_group AS ENUM ('authen','authz','circ','hold','search');
1107
1108 CREATE TABLE config.usr_activity_type (
1109     id          SERIAL                      PRIMARY KEY,
1110     ewho        TEXT,
1111     ewhat       TEXT,
1112     ehow        TEXT,
1113     label       TEXT                        NOT NULL, -- i18n
1114     egroup      config.usr_activity_group   NOT NULL,
1115     enabled     BOOL                        NOT NULL DEFAULT TRUE,
1116     transient   BOOL                        NOT NULL DEFAULT TRUE,
1117     CONSTRAINT  one_of_wwh CHECK (COALESCE(ewho,ewhat,ehow) IS NOT NULL)
1118 );
1119
1120 CREATE UNIQUE INDEX unique_wwh ON config.usr_activity_type
1121     (COALESCE(ewho,''), COALESCE (ewhat,''), COALESCE(ehow,''));
1122
1123 CREATE TABLE config.filter_dialog_interface (
1124     key         TEXT                        PRIMARY KEY,
1125     description TEXT
1126 );
1127
1128 CREATE TABLE config.filter_dialog_filter_set (
1129     id          SERIAL                      PRIMARY KEY,
1130     name        TEXT                        NOT NULL,
1131     owning_lib  INT                         NOT NULL, -- REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
1132     creator     INT                         NOT NULL, -- REFERENCES actor.usr (id) DEFERRABLE INITIALLY DEFERRED,
1133     create_time TIMESTAMP WITH TIME ZONE    NOT NULL DEFAULT NOW(),
1134     interface   TEXT                        NOT NULL REFERENCES config.filter_dialog_interface (key) DEFERRABLE INITIALLY DEFERRED,
1135     filters     TEXT                        NOT NULL, -- CHECK (evergreen.is_json(filters))
1136     CONSTRAINT cfdfs_name_once_per_lib UNIQUE (name, owning_lib)
1137 );
1138
1139 CREATE TABLE config.best_hold_order(
1140     id          SERIAL      PRIMARY KEY,
1141     name        TEXT        UNIQUE,   -- i18n
1142     pprox       INT, -- copy capture <-> pickup lib prox
1143     hprox       INT, -- copy circ lib <-> request lib prox
1144     aprox       INT, -- copy circ lib <-> pickup lib ADJUSTED prox on ahcm
1145     approx      INT, -- copy capture <-> pickup lib ADJUSTED prox from function
1146     priority    INT, -- group hold priority
1147     cut         INT, -- cut-in-line
1148     depth       INT, -- selection depth
1149     htime       INT, -- time since last home-lib circ exceeds org-unit setting
1150     rtime       INT, -- request time
1151     shtime      INT  -- time since copy last trip home exceeds org-unit setting
1152 );
1153
1154 -- At least one of these columns must contain a non-null value
1155 ALTER TABLE config.best_hold_order ADD CHECK ((
1156     pprox IS NOT NULL OR
1157     hprox IS NOT NULL OR
1158     aprox IS NOT NULL OR
1159     priority IS NOT NULL OR
1160     cut IS NOT NULL OR
1161     depth IS NOT NULL OR
1162     htime IS NOT NULL OR
1163     rtime IS NOT NULL
1164 ));
1165
1166 CREATE OR REPLACE FUNCTION
1167     evergreen.z3950_attr_name_is_valid() RETURNS TRIGGER AS $func$
1168     BEGIN
1169
1170       PERFORM * FROM config.z3950_attr WHERE name = NEW.z3950_attr_type;
1171
1172       IF FOUND THEN
1173         RETURN NULL;
1174       END IF;
1175
1176       RAISE EXCEPTION '% is not a valid Z39.50 attribute type', NEW.z3950_attr_type;
1177
1178     END;
1179 $func$ LANGUAGE PLPGSQL STABLE;
1180
1181 COMMENT ON FUNCTION evergreen.z3950_attr_name_is_valid() IS $$
1182 Used by a config.z3950_index_field_map constraint trigger
1183 to verify z3950_attr_type maps.
1184 $$;
1185
1186 -- drop these in down here since they reference config.metabib_field
1187 -- and config.record_attr_definition
1188 CREATE TABLE config.z3950_index_field_map (
1189     id              SERIAL  PRIMARY KEY,
1190     label           TEXT    NOT NULL, -- i18n
1191     metabib_field   INTEGER REFERENCES config.metabib_field(id) ON UPDATE CASCADE DEFERRABLE INITIALLY DEFERRED,
1192     record_attr     TEXT    REFERENCES config.record_attr_definition(name),
1193     z3950_attr      INTEGER REFERENCES config.z3950_attr(id),
1194     z3950_attr_type TEXT,-- REFERENCES config.z3950_attr(name)
1195     CONSTRAINT metabib_field_or_record_attr CHECK (
1196         metabib_field IS NOT NULL OR
1197         record_attr IS NOT NULL
1198     ),
1199     CONSTRAINT attr_or_attr_type CHECK (
1200         z3950_attr IS NOT NULL OR
1201         z3950_attr_type IS NOT NULL
1202     )
1203 );
1204
1205 CREATE CONSTRAINT TRIGGER valid_z3950_attr_type AFTER INSERT OR UPDATE ON config.z3950_index_field_map
1206     DEFERRABLE INITIALLY DEFERRED FOR EACH ROW WHEN (NEW.z3950_attr_type IS NOT NULL)
1207     EXECUTE PROCEDURE evergreen.z3950_attr_name_is_valid();
1208
1209 CREATE TABLE config.marc_format (
1210     id                  SERIAL PRIMARY KEY,
1211     code                TEXT NOT NULL,
1212     name                TEXT NOT NULL
1213 );
1214 COMMENT ON TABLE config.marc_format IS $$
1215 List of MARC formats supported by this Evergreen
1216 database. This exists primarily as a hook for future
1217 support of UNIMARC, though whether that will ever
1218 happen remains to be seen.
1219 $$;
1220
1221 CREATE TYPE config.marc_record_type AS ENUM ('biblio', 'authority', 'serial');
1222
1223 CREATE TABLE config.marc_field (
1224     id                  SERIAL PRIMARY KEY,
1225     marc_format         INTEGER NOT NULL
1226                         REFERENCES config.marc_format (id) DEFERRABLE INITIALLY DEFERRED,
1227     marc_record_type    config.marc_record_type NOT NULL,
1228     tag                 CHAR(3) NOT NULL,
1229     name                TEXT,
1230     description         TEXT,
1231     fixed_field         BOOLEAN,
1232     repeatable          BOOLEAN,
1233     mandatory           BOOLEAN,
1234     hidden              BOOLEAN,
1235     owner               INTEGER -- REFERENCES actor.org_unit (id)
1236                         -- if the owner is null, the data about the field is
1237                         -- assumed to come from the controlling MARC standard
1238 );
1239
1240 COMMENT ON TABLE config.marc_field IS $$
1241 This table stores a list of MARC fields recognized by the Evergreen
1242 instance.  Note that we're not aiming for completely generic ISO2709
1243 support: we're assuming things like three characters for a tag,
1244 one-character subfield labels, two indicators per variable data field,
1245 and the like, all of which are technically specializations of ISO2709.
1246
1247 Of particular significance is the owner column; if it's set to a null
1248 value, the field definition is assumed to come from a national
1249 standards body; if it's set to a non-null value, the field definition
1250 is an OU-level addition to or override of the standard.
1251 $$;
1252
1253 CREATE INDEX config_marc_field_tag_idx ON config.marc_field (tag);
1254 CREATE INDEX config_marc_field_owner_idx ON config.marc_field (owner);
1255
1256 CREATE UNIQUE INDEX config_standard_marc_tags_are_unique
1257     ON config.marc_field(marc_format, marc_record_type, tag)
1258     WHERE owner IS NULL;
1259 ALTER TABLE config.marc_field
1260     ADD CONSTRAINT config_standard_marc_tags_are_fully_specified
1261     CHECK ((owner IS NOT NULL) OR
1262            (
1263                 owner IS NULL AND
1264                 repeatable IS NOT NULL AND
1265                 mandatory IS NOT NULL AND
1266                 hidden IS NOT NULL
1267            )
1268           );
1269
1270 CREATE TABLE config.marc_subfield (
1271     id                  SERIAL PRIMARY KEY,
1272     marc_format         INTEGER NOT NULL
1273                         REFERENCES config.marc_format (id) DEFERRABLE INITIALLY DEFERRED,
1274     marc_record_type    config.marc_record_type NOT NULL,
1275     tag                 CHAR(3) NOT NULL,
1276     code                CHAR(1) NOT NULL,
1277     description         TEXT,
1278     repeatable          BOOLEAN,
1279     mandatory           BOOLEAN,
1280     hidden              BOOLEAN,
1281     value_ctype         TEXT
1282                         REFERENCES config.record_attr_definition (name)
1283                             DEFERRABLE INITIALLY DEFERRED,
1284     owner               INTEGER -- REFERENCES actor.org_unit (id)
1285                         -- if the owner is null, the data about the subfield is
1286                         -- assumed to come from the controlling MARC standard
1287 );
1288
1289 COMMENT ON TABLE config.marc_subfield IS $$
1290 This table stores the list of subfields recognized by this Evergreen
1291 instance.  As with config.marc_field, of particular significance is the
1292 owner column; if it's set to a null value, the subfield definition is
1293 assumed to come from a national standards body; if it's set to a non-null
1294 value, the subfield definition is an OU-level addition to or override
1295 of the standard.
1296 $$;
1297
1298 CREATE INDEX config_marc_subfield_tag_code_idx ON config.marc_subfield (tag, code);
1299 CREATE UNIQUE INDEX config_standard_marc_subfields_are_unique
1300     ON config.marc_subfield(marc_format, marc_record_type, tag, code)
1301     WHERE owner IS NULL;
1302 ALTER TABLE config.marc_subfield
1303     ADD CONSTRAINT config_standard_marc_subfields_are_fully_specified
1304     CHECK ((owner IS NOT NULL) OR
1305            (
1306                 owner IS NULL AND
1307                 repeatable IS NOT NULL AND
1308                 mandatory IS NOT NULL AND
1309                 hidden IS NOT NULL
1310            )
1311           );
1312
1313 CREATE TABLE config.copy_tag_type (
1314     code            TEXT NOT NULL PRIMARY KEY,
1315     label           TEXT NOT NULL,
1316     owner           INTEGER NOT NULL -- REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED
1317 );
1318
1319 CREATE INDEX config_copy_tag_type_owner_idx
1320     ON config.copy_tag_type (owner);
1321
1322 COMMIT;