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

   1 /*
   2  * Copyright (C) 2004-2008  Georgia Public Library Service
   3  * Copyright (C) 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
  19
  20 DROP SCHEMA IF EXISTS stats CASCADE;
  21 DROP SCHEMA IF EXISTS config CASCADE;
  22
  23 BEGIN;
  24 CREATE SCHEMA stats;
  25
  26 CREATE SCHEMA config;
  27 COMMENT ON SCHEMA config IS $$
  28 /*
  29  * Copyright (C) 2005  Georgia Public Library Service
  30  * Mike Rylander <mrylander@gmail.com>
  31  *
  32  * The config schema holds static configuration data for the
  33  * Open-ILS installation.
  34  *
  35  * ****
  36  *
  37  * This program is free software; you can redistribute it and/or
  38  * modify it under the terms of the GNU General Public License
  39  * as published by the Free Software Foundation; either version 2
  40  * of the License, or (at your option) any later version.
  41  *
  42  * This program is distributed in the hope that it will be useful,
  43  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  44  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  45  * GNU General Public License for more details.
  46  */
  47 $$;
  48
  49 CREATE TABLE config.internal_flag (
  50     name    TEXT    PRIMARY KEY,
  51     value   TEXT,
  52     enabled BOOL    NOT NULL DEFAULT FALSE
  53 );
  54 INSERT INTO config.internal_flag (name) VALUES ('ingest.metarecord_mapping.skip_on_insert');
  55 INSERT INTO config.internal_flag (name) VALUES ('ingest.metarecord_mapping.skip_on_update');
  56 INSERT INTO config.internal_flag (name) VALUES ('ingest.reingest.force_on_same_marc');
  57 INSERT INTO config.internal_flag (name) VALUES ('ingest.disable_located_uri');
  58 INSERT INTO config.internal_flag (name) VALUES ('ingest.disable_metabib_full_rec');
  59 INSERT INTO config.internal_flag (name) VALUES ('ingest.disable_metabib_rec_descriptor');
  60 INSERT INTO config.internal_flag (name) VALUES ('ingest.disable_metabib_field_entry');
  61 INSERT INTO config.internal_flag (name) VALUES ('ingest.assume_inserts_only');
  62
  63 CREATE TABLE config.global_flag (
  64     label   TEXT    NOT NULL
  65 ) INHERITS (config.internal_flag);
  66 ALTER TABLE config.global_flag ADD PRIMARY KEY (name);
  67
  68 CREATE TABLE config.upgrade_log (
  69     version         TEXT    PRIMARY KEY,
  70     install_date    TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
  71 );
  72
  73 INSERT INTO config.upgrade_log (version) VALUES ('0497'); -- miker for tsbere
  74
  75 CREATE TABLE config.bib_source (
  76         id              SERIAL  PRIMARY KEY,
  77         quality         INT     CHECK ( quality BETWEEN 0 AND 100 ),
  78         source          TEXT    NOT NULL UNIQUE,
  79         transcendant    BOOL    NOT NULL DEFAULT FALSE
  80 );
  81 COMMENT ON TABLE config.bib_source IS $$
  82 /*
  83  * Copyright (C) 2005  Georgia Public Library Service
  84  * Mike Rylander <mrylander@gmail.com>
  85  *
  86  * Valid sources of MARC records
  87  *
  88  * This is table is used to set up the relative "quality" of each
  89  * MARC source, such as OCLC.
  90  *
  91  * ****
  92  *
  93  * This program is free software; you can redistribute it and/or
  94  * modify it under the terms of the GNU General Public License
  95  * as published by the Free Software Foundation; either version 2
  96  * of the License, or (at your option) any later version.
  97  *
  98  * This program is distributed in the hope that it will be useful,
  99  * but WITHOUT ANY WARRANTY; without even the implied warranty of
 100  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 101  * GNU General Public License for more details.
 102  */
 103 $$;
 104
 105 CREATE TABLE config.standing (
 106         id              SERIAL  PRIMARY KEY,
 107         value           TEXT    NOT NULL UNIQUE
 108 );
 109 COMMENT ON TABLE config.standing IS $$
 110 /*
 111  * Copyright (C) 2005  Georgia Public Library Service
 112  * Mike Rylander <mrylander@gmail.com>
 113  *
 114  * Patron Standings
 115  *
 116  * This table contains the values that can be applied to a patron
 117  * by a staff member.  These values should not be changed, other
 118  * than for translation, as the ID column is currently a "magic
 119  * number" in the source. :(
 120  *
 121  * ****
 122  *
 123  * This program is free software; you can redistribute it and/or
 124  * modify it under the terms of the GNU General Public License
 125  * as published by the Free Software Foundation; either version 2
 126  * of the License, or (at your option) any later version.
 127  *
 128  * This program is distributed in the hope that it will be useful,
 129  * but WITHOUT ANY WARRANTY; without even the implied warranty of
 130  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 131  * GNU General Public License for more details.
 132  */
 133 $$;
 134
 135 CREATE TABLE config.standing_penalty (
 136         id                      SERIAL  PRIMARY KEY,
 137         name            TEXT    NOT NULL UNIQUE,
 138         label           TEXT    NOT NULL,
 139         block_list      TEXT,
 140         org_depth       INTEGER
 141 );
 142 INSERT INTO config.standing_penalty (id,name,label,block_list)
 143         VALUES (1,'PATRON_EXCEEDS_FINES','Patron exceeds fine threshold','CIRC|HOLD|RENEW');
 144 INSERT INTO config.standing_penalty (id,name,label,block_list)
 145         VALUES (2,'PATRON_EXCEEDS_OVERDUE_COUNT','Patron exceeds max overdue item threshold','CIRC|HOLD|RENEW');
 146 INSERT INTO config.standing_penalty (id,name,label,block_list)
 147         VALUES (3,'PATRON_EXCEEDS_CHECKOUT_COUNT','Patron exceeds max checked out item threshold','CIRC');
 148 INSERT INTO config.standing_penalty (id,name,label,block_list)
 149         VALUES (4,'PATRON_EXCEEDS_COLLECTIONS_WARNING','Patron exceeds pre-collections warning fine threshold','CIRC|HOLD|RENEW');
 150
 151 INSERT INTO config.standing_penalty (id,name,label) VALUES (20,'ALERT_NOTE','Alerting Note, no blocks');
 152 INSERT INTO config.standing_penalty (id,name,label) VALUES (21,'SILENT_NOTE','Note, no blocks');
 153 INSERT INTO config.standing_penalty (id,name,label,block_list) VALUES (22,'STAFF_C','Alerting block on Circ','CIRC');
 154 INSERT INTO config.standing_penalty (id,name,label,block_list) VALUES (23,'STAFF_CH','Alerting block on Circ and Hold','CIRC|HOLD');
 155 INSERT INTO config.standing_penalty (id,name,label,block_list) VALUES (24,'STAFF_CR','Alerting block on Circ and Renew','CIRC|RENEW');
 156 INSERT INTO config.standing_penalty (id,name,label,block_list) VALUES (25,'STAFF_CHR','Alerting block on Circ, Hold and Renew','CIRC|HOLD|RENEW');
 157 INSERT INTO config.standing_penalty (id,name,label,block_list) VALUES (26,'STAFF_HR','Alerting block on Hold and Renew','HOLD|RENEW');
 158 INSERT INTO config.standing_penalty (id,name,label,block_list) VALUES (27,'STAFF_H','Alerting block on Hold','HOLD');
 159 INSERT INTO config.standing_penalty (id,name,label,block_list) VALUES (28,'STAFF_R','Alerting block on Renew','RENEW');
 160 INSERT INTO config.standing_penalty (id,name,label) VALUES (29,'INVALID_PATRON_ADDRESS','Patron has an invalid address');
 161 INSERT INTO config.standing_penalty (id,name,label) VALUES (30,'PATRON_IN_COLLECTIONS','Patron has been referred to a collections agency');
 162
 163 SELECT SETVAL('config.standing_penalty_id_seq', 100);
 164
 165 CREATE TABLE config.xml_transform (
 166         name            TEXT    PRIMARY KEY,
 167         namespace_uri   TEXT    NOT NULL,
 168         prefix          TEXT    NOT NULL,
 169         xslt            TEXT    NOT NULL
 170 );
 171
 172 CREATE TABLE config.biblio_fingerprint (
 173         id                      SERIAL  PRIMARY KEY,
 174         name            TEXT    NOT NULL,
 175         xpath           TEXT    NOT NULL,
 176     first_word  BOOL    NOT NULL DEFAULT FALSE,
 177         format          TEXT    NOT NULL DEFAULT 'marcxml'
 178 );
 179
 180 INSERT INTO config.biblio_fingerprint (name, xpath, format)
 181     VALUES (
 182         'Title',
 183         '//marc:datafield[@tag="700"]/marc:subfield[@code="t"]|' ||
 184             '//marc:datafield[@tag="240"]/marc:subfield[@code="a"]|' ||
 185             '//marc:datafield[@tag="242"]/marc:subfield[@code="a"]|' ||
 186             '//marc:datafield[@tag="246"]/marc:subfield[@code="a"]|' ||
 187             '//marc:datafield[@tag="245"]/marc:subfield[@code="a"]',
 188         'marcxml'
 189     );
 190
 191 INSERT INTO config.biblio_fingerprint (name, xpath, format, first_word)
 192     VALUES (
 193         'Author',
 194         '//marc:datafield[@tag="700" and ./*[@code="t"]]/marc:subfield[@code="a"]|'
 195             '//marc:datafield[@tag="100"]/marc:subfield[@code="a"]|'
 196             '//marc:datafield[@tag="110"]/marc:subfield[@code="a"]|'
 197             '//marc:datafield[@tag="111"]/marc:subfield[@code="a"]|'
 198             '//marc:datafield[@tag="260"]/marc:subfield[@code="b"]',
 199         'marcxml',
 200         TRUE
 201     );
 202
 203 CREATE TABLE config.metabib_class (
 204     name    TEXT    PRIMARY KEY,
 205     label   TEXT    NOT NULL UNIQUE
 206 );
 207
 208 CREATE TABLE config.metabib_field (
 209         id              SERIAL  PRIMARY KEY,
 210         field_class     TEXT    NOT NULL REFERENCES config.metabib_class (name),
 211         name            TEXT    NOT NULL,
 212         label           TEXT    NOT NULL,
 213         xpath           TEXT    NOT NULL,
 214         weight          INT     NOT NULL DEFAULT 1,
 215         format          TEXT    NOT NULL REFERENCES config.xml_transform (name) DEFAULT 'mods33',
 216         search_field    BOOL    NOT NULL DEFAULT TRUE,
 217         facet_field     BOOL    NOT NULL DEFAULT FALSE,
 218     facet_xpath TEXT
 219 );
 220 COMMENT ON TABLE config.metabib_field IS $$
 221 /*
 222  * Copyright (C) 2005  Georgia Public Library Service
 223  * Mike Rylander <mrylander@gmail.com>
 224  *
 225  * XPath used for record indexing ingest
 226  *
 227  * This table contains the XPath used to chop up MODS into its
 228  * indexable parts.  Each XPath entry is named and assigned to
 229  * a "class" of either title, subject, author, keyword or series.
 230  *
 231  *
 232  * ****
 233  *
 234  * This program is free software; you can redistribute it and/or
 235  * modify it under the terms of the GNU General Public License
 236  * as published by the Free Software Foundation; either version 2
 237  * of the License, or (at your option) any later version.
 238  *
 239  * This program is distributed in the hope that it will be useful,
 240  * but WITHOUT ANY WARRANTY; without even the implied warranty of
 241  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 242  * GNU General Public License for more details.
 243  */
 244 $$;
 245
 246 CREATE UNIQUE INDEX config_metabib_field_class_name_idx ON config.metabib_field (field_class, name);
 247
 248 CREATE TABLE config.metabib_search_alias (
 249     alias       TEXT    PRIMARY KEY,
 250     field_class TEXT    NOT NULL REFERENCES config.metabib_class (name),
 251     field       INT     REFERENCES config.metabib_field (id)
 252 );
 253
 254 CREATE TABLE config.non_cataloged_type (
 255         id              SERIAL          PRIMARY KEY,
 256         owning_lib      INT             NOT NULL, -- REFERENCES actor.org_unit (id),
 257         name            TEXT            NOT NULL,
 258         circ_duration   INTERVAL        NOT NULL DEFAULT '14 days'::INTERVAL,
 259         in_house        BOOL            NOT NULL DEFAULT FALSE,
 260         CONSTRAINT noncat_once_per_lib UNIQUE (owning_lib,name)
 261 );
 262 COMMENT ON TABLE config.non_cataloged_type IS $$
 263 /*
 264  * Copyright (C) 2005  Georgia Public Library Service
 265  * Mike Rylander <mrylander@gmail.com>
 266  *
 267  * Types of valid non-cataloged items.
 268  *
 269  *
 270  * ****
 271  *
 272  * This program is free software; you can redistribute it and/or
 273  * modify it under the terms of the GNU General Public License
 274  * as published by the Free Software Foundation; either version 2
 275  * of the License, or (at your option) any later version.
 276  *
 277  * This program is distributed in the hope that it will be useful,
 278  * but WITHOUT ANY WARRANTY; without even the implied warranty of
 279  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 280  * GNU General Public License for more details.
 281  */
 282 $$;
 283
 284 CREATE TABLE config.identification_type (
 285         id              SERIAL  PRIMARY KEY,
 286         name            TEXT    NOT NULL UNIQUE
 287 );
 288 COMMENT ON TABLE config.identification_type IS $$
 289 /*
 290  * Copyright (C) 2005  Georgia Public Library Service
 291  * Mike Rylander <mrylander@gmail.com>
 292  *
 293  * Types of valid patron identification.
 294  *
 295  * Each patron must display at least one valid form of identification
 296  * in order to get a library card.  This table lists those forms.
 297  *
 298  *
 299  * ****
 300  *
 301  * This program is free software; you can redistribute it and/or
 302  * modify it under the terms of the GNU General Public License
 303  * as published by the Free Software Foundation; either version 2
 304  * of the License, or (at your option) any later version.
 305  *
 306  * This program is distributed in the hope that it will be useful,
 307  * but WITHOUT ANY WARRANTY; without even the implied warranty of
 308  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 309  * GNU General Public License for more details.
 310  */
 311 $$;
 312
 313 CREATE TABLE config.rule_circ_duration (
 314         id              SERIAL          PRIMARY KEY,
 315         name            TEXT            NOT NULL UNIQUE CHECK ( name ~ E'^\\w+$' ),
 316         extended        INTERVAL        NOT NULL,
 317         normal          INTERVAL        NOT NULL,
 318         shrt            INTERVAL        NOT NULL,
 319         max_renewals    INT             NOT NULL
 320 );
 321 COMMENT ON TABLE config.rule_circ_duration IS $$
 322 /*
 323  * Copyright (C) 2005  Georgia Public Library Service
 324  * Mike Rylander <mrylander@gmail.com>
 325  *
 326  * Circulation Duration rules
 327  *
 328  * Each circulation is given a duration based on one of these rules.
 329  *
 330  *
 331  * ****
 332  *
 333  * This program is free software; you can redistribute it and/or
 334  * modify it under the terms of the GNU General Public License
 335  * as published by the Free Software Foundation; either version 2
 336  * of the License, or (at your option) any later version.
 337  *
 338  * This program is distributed in the hope that it will be useful,
 339  * but WITHOUT ANY WARRANTY; without even the implied warranty of
 340  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 341  * GNU General Public License for more details.
 342  */
 343 $$;
 344
 345 CREATE TABLE config.hard_due_date (
 346     id                  SERIAL      PRIMARY KEY,
 347     name                TEXT        NOT NULL UNIQUE,
 348     ceiling_date        TIMESTAMPTZ NOT NULL,
 349     forceto             BOOL        NOT NULL,
 350     owner               INT         NOT NULL   -- REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
 351 );
 352
 353 CREATE TABLE config.hard_due_date_values (
 354     id                  SERIAL      PRIMARY KEY,
 355     hard_due_date       INT         NOT NULL REFERENCES config.hard_due_date (id)
 356                                     DEFERRABLE INITIALLY DEFERRED,
 357     ceiling_date        TIMESTAMPTZ NOT NULL,
 358     active_date         TIMESTAMPTZ NOT NULL
 359 );
 360
 361 CREATE OR REPLACE FUNCTION config.update_hard_due_dates () RETURNS INT AS $func$
 362 DECLARE
 363     temp_value  config.hard_due_date_values%ROWTYPE;
 364     updated     INT := 0;
 365 BEGIN
 366     FOR temp_value IN
 367       SELECT  DISTINCT ON (hard_due_date) *
 368         FROM  config.hard_due_date_values
 369         WHERE active_date <= NOW() -- We've passed (or are at) the rollover time
 370         ORDER BY hard_due_date, active_date DESC -- Latest (nearest to us) active time
 371    LOOP
 372         UPDATE  config.hard_due_date
 373           SET   ceiling_date = temp_value.ceiling_date
 374           WHERE id = temp_value.hard_due_date
 375                 AND ceiling_date <> temp_value.ceiling_date; -- Time is equal if we've already updated the chdd
 376
 377         IF FOUND THEN
 378             updated := updated + 1;
 379         END IF;
 380     END LOOP;
 381
 382     RETURN updated;
 383 END;
 384 $func$ LANGUAGE plpgsql;
 385
 386 CREATE TABLE config.rule_max_fine (
 387     id          SERIAL          PRIMARY KEY,
 388     name        TEXT            NOT NULL UNIQUE CHECK ( name ~ E'^\\w+$' ),
 389     amount      NUMERIC(6,2)    NOT NULL,
 390     is_percent  BOOL            NOT NULL DEFAULT FALSE
 391 );
 392 COMMENT ON TABLE config.rule_max_fine IS $$
 393 /*
 394  * Copyright (C) 2005  Georgia Public Library Service
 395  * Mike Rylander <mrylander@gmail.com>
 396  *
 397  * Circulation Max Fine rules
 398  *
 399  * Each circulation is given a maximum fine based on one of
 400  * these rules.
 401  *
 402  *
 403  * ****
 404  *
 405  * This program is free software; you can redistribute it and/or
 406  * modify it under the terms of the GNU General Public License
 407  * as published by the Free Software Foundation; either version 2
 408  * of the License, or (at your option) any later version.
 409  *
 410  * This program is distributed in the hope that it will be useful,
 411  * but WITHOUT ANY WARRANTY; without even the implied warranty of
 412  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 413  * GNU General Public License for more details.
 414  */
 415 $$;
 416
 417 CREATE TABLE config.rule_recurring_fine (
 418         id                      SERIAL          PRIMARY KEY,
 419         name                    TEXT            NOT NULL UNIQUE CHECK ( name ~ E'^\\w+$' ),
 420         high                    NUMERIC(6,2)    NOT NULL,
 421         normal                  NUMERIC(6,2)    NOT NULL,
 422         low                     NUMERIC(6,2)    NOT NULL,
 423         recurrence_interval     INTERVAL        NOT NULL DEFAULT '1 day'::INTERVAL
 424 );
 425 COMMENT ON TABLE config.rule_recurring_fine IS $$
 426 /*
 427  * Copyright (C) 2005  Georgia Public Library Service
 428  * Mike Rylander <mrylander@gmail.com>
 429  *
 430  * Circulation Recurring Fine rules
 431  *
 432  * Each circulation is given a recurring fine amount based on one of
 433  * these rules.  The recurrence_interval should not be any shorter
 434  * than the interval between runs of the fine_processor.pl script
 435  * (which is run from CRON), or you could miss fines.
 436  *
 437  *
 438  * ****
 439  *
 440  * This program is free software; you can redistribute it and/or
 441  * modify it under the terms of the GNU General Public License
 442  * as published by the Free Software Foundation; either version 2
 443  * of the License, or (at your option) any later version.
 444  *
 445  * This program is distributed in the hope that it will be useful,
 446  * but WITHOUT ANY WARRANTY; without even the implied warranty of
 447  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 448  * GNU General Public License for more details.
 449  */
 450 $$;
 451
 452
 453 CREATE TABLE config.rule_age_hold_protect (
 454         id      SERIAL          PRIMARY KEY,
 455         name    TEXT            NOT NULL UNIQUE CHECK ( name ~ E'^\\w+$' ),
 456         age     INTERVAL        NOT NULL,
 457         prox    INT             NOT NULL
 458 );
 459 COMMENT ON TABLE config.rule_age_hold_protect IS $$
 460 /*
 461  * Copyright (C) 2005  Georgia Public Library Service
 462  * Mike Rylander <mrylander@gmail.com>
 463  *
 464  * Hold Item Age Protection rules
 465  *
 466  * A hold request can only capture new(ish) items when they are
 467  * within a particular proximity of the home_ou of the requesting
 468  * user.  The proximity ('prox' column) is calculated by counting
 469  * the number of tree edges between the user's home_ou and the owning_lib
 470  * of the copy that could fulfill the hold.
 471  *
 472  *
 473  * ****
 474  *
 475  * This program is free software; you can redistribute it and/or
 476  * modify it under the terms of the GNU General Public License
 477  * as published by the Free Software Foundation; either version 2
 478  * of the License, or (at your option) any later version.
 479  *
 480  * This program is distributed in the hope that it will be useful,
 481  * but WITHOUT ANY WARRANTY; without even the implied warranty of
 482  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 483  * GNU General Public License for more details.
 484  */
 485 $$;
 486
 487 CREATE TABLE config.copy_status (
 488         id              SERIAL  PRIMARY KEY,
 489         name            TEXT    NOT NULL UNIQUE,
 490         holdable        BOOL    NOT NULL DEFAULT FALSE,
 491         opac_visible    BOOL    NOT NULL DEFAULT FALSE
 492 );
 493 COMMENT ON TABLE config.copy_status IS $$
 494 /*
 495  * Copyright (C) 2005  Georgia Public Library Service
 496  * Mike Rylander <mrylander@gmail.com>
 497  *
 498  * Copy Statuses
 499  *
 500  * The available copy statuses, and whether a copy in that
 501  * status is available for hold request capture.  0 (zero) is
 502  * the only special number in this set, meaning that the item
 503  * is available for immediate checkout, and is counted as available
 504  * in the OPAC.
 505  *
 506  * Statuses with an ID below 100 are not removable, and have special
 507  * meaning in the code.  Do not change them except to translate the
 508  * textual name.
 509  *
 510  * You may add and remove statuses above 100, and these can be used
 511  * to remove items from normal circulation without affecting the rest
 512  * of the copy's values or its location.
 513  *
 514  * ****
 515  *
 516  * This program is free software; you can redistribute it and/or
 517  * modify it under the terms of the GNU General Public License
 518  * as published by the Free Software Foundation; either version 2
 519  * of the License, or (at your option) any later version.
 520  *
 521  * This program is distributed in the hope that it will be useful,
 522  * but WITHOUT ANY WARRANTY; without even the implied warranty of
 523  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 524  * GNU General Public License for more details.
 525  */
 526 $$;
 527
 528 CREATE TABLE config.net_access_level (
 529         id      SERIAL          PRIMARY KEY,
 530         name    TEXT            NOT NULL UNIQUE
 531 );
 532 COMMENT ON TABLE config.net_access_level IS $$
 533 /*
 534  * Copyright (C) 2005  Georgia Public Library Service
 535  * Mike Rylander <mrylander@gmail.com>
 536  *
 537  * Patron Network Access level
 538  *
 539  * This will be used to inform the in-library firewall of how much
 540  * internet access the using patron should be allowed.
 541  *
 542  * ****
 543  *
 544  * This program is free software; you can redistribute it and/or
 545  * modify it under the terms of the GNU General Public License
 546  * as published by the Free Software Foundation; either version 2
 547  * of the License, or (at your option) any later version.
 548  *
 549  * This program is distributed in the hope that it will be useful,
 550  * but WITHOUT ANY WARRANTY; without even the implied warranty of
 551  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 552  * GNU General Public License for more details.
 553  */
 554 $$;
 555
 556
 557 CREATE TABLE config.remote_account (
 558     id          SERIAL  PRIMARY KEY,
 559     label       TEXT    NOT NULL,
 560     host        TEXT    NOT NULL,   -- name or IP, :port optional
 561     username    TEXT,               -- optional, since we could default to $USER
 562     password    TEXT,               -- optional, since we could use SSH keys, or anonymous login.
 563     account     TEXT,               -- aka profile or FTP "account" command
 564     path        TEXT,               -- aka directory
 565     owner       INT     NOT NULL,   -- REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
 566     last_activity TIMESTAMP WITH TIME ZONE
 567 );
 568
 569 CREATE TABLE config.marc21_rec_type_map (
 570     code        TEXT    PRIMARY KEY,
 571     type_val    TEXT    NOT NULL,
 572     blvl_val    TEXT    NOT NULL
 573 );
 574
 575 CREATE TABLE config.marc21_ff_pos_map (
 576     id          SERIAL  PRIMARY KEY,
 577     fixed_field TEXT    NOT NULL,
 578     tag         TEXT    NOT NULL,
 579     rec_type    TEXT    NOT NULL,
 580     start_pos   INT     NOT NULL,
 581     length      INT     NOT NULL,
 582     default_val TEXT    NOT NULL DEFAULT ' '
 583 );
 584
 585 CREATE TABLE config.marc21_physical_characteristic_type_map (
 586     ptype_key   TEXT    PRIMARY KEY,
 587     label       TEXT    NOT NULL -- I18N
 588 );
 589
 590 CREATE TABLE config.marc21_physical_characteristic_subfield_map (
 591     id          SERIAL  PRIMARY KEY,
 592     ptype_key   TEXT    NOT NULL REFERENCES config.marc21_physical_characteristic_type_map (ptype_key) ON DELETE CASCADE ON UPDATE CASCADE,
 593     subfield    TEXT    NOT NULL,
 594     start_pos   INT     NOT NULL,
 595     length      INT     NOT NULL,
 596     label       TEXT    NOT NULL -- I18N
 597 );
 598
 599 CREATE TABLE config.marc21_physical_characteristic_value_map (
 600     id              SERIAL  PRIMARY KEY,
 601     value           TEXT    NOT NULL,
 602     ptype_subfield  INT     NOT NULL REFERENCES config.marc21_physical_characteristic_subfield_map (id),
 603     label           TEXT    NOT NULL -- I18N
 604 );
 605
 606
 607 CREATE TABLE config.z3950_source (
 608     name                TEXT    PRIMARY KEY,
 609     label               TEXT    NOT NULL UNIQUE,
 610     host                TEXT    NOT NULL,
 611     port                INT     NOT NULL,
 612     db                  TEXT    NOT NULL,
 613     record_format       TEXT    NOT NULL DEFAULT 'FI',
 614     transmission_format TEXT    NOT NULL DEFAULT 'usmarc',
 615     auth                BOOL    NOT NULL DEFAULT TRUE
 616 );
 617
 618 COMMENT ON TABLE config.z3950_source IS $$
 619 Z39.50 Sources
 620
 621 Each row in this table represents a database searchable via Z39.50.
 622 $$;
 623
 624 COMMENT ON COLUMN config.z3950_source.record_format IS $$
 625 Z39.50 element set.
 626 $$;
 627
 628 COMMENT ON COLUMN config.z3950_source.transmission_format IS $$
 629 Z39.50 preferred record syntax..
 630 $$;
 631
 632
 633 CREATE TABLE config.z3950_attr (
 634     id          SERIAL  PRIMARY KEY,
 635     source      TEXT    NOT NULL REFERENCES config.z3950_source (name) DEFERRABLE INITIALLY DEFERRED,
 636     name        TEXT    NOT NULL,
 637     label       TEXT    NOT NULL,
 638     code        INT     NOT NULL,
 639     format      INT     NOT NULL,
 640     truncation  INT     NOT NULL DEFAULT 0,
 641     CONSTRAINT z_code_format_once_per_source UNIQUE (code,format,source)
 642 );
 643
 644 CREATE TABLE config.i18n_locale (
 645     code        TEXT    PRIMARY KEY,
 646     marc_code   TEXT    NOT NULL, -- should exist in config.coded_value_map WHERE ctype = 'item_lang'
 647     name        TEXT    UNIQUE NOT NULL,
 648     description TEXT
 649 );
 650
 651 CREATE TABLE config.i18n_core (
 652     id              BIGSERIAL   PRIMARY KEY,
 653     fq_field        TEXT        NOT NULL,
 654     identity_value  TEXT        NOT NULL,
 655     translation     TEXT        NOT NULL    REFERENCES config.i18n_locale (code) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 656     string          TEXT        NOT NULL
 657 );
 658
 659 CREATE UNIQUE INDEX i18n_identity ON config.i18n_core (fq_field,identity_value,translation);
 660
 661 CREATE OR REPLACE FUNCTION oils_i18n_update_apply(old_ident TEXT, new_ident TEXT, hint TEXT) RETURNS VOID AS $_$
 662 BEGIN
 663
 664     EXECUTE $$
 665         UPDATE  config.i18n_core
 666           SET   identity_value = $$ || quote_literal(new_ident) || $$
 667           WHERE fq_field LIKE '$$ || hint || $$.%'
 668                 AND identity_value = $$ || quote_literal(old_ident) || $$::TEXT;$$;
 669
 670     RETURN;
 671
 672 END;
 673 $_$ LANGUAGE PLPGSQL;
 674
 675 CREATE OR REPLACE FUNCTION oils_i18n_id_tracking(/* hint */) RETURNS TRIGGER AS $_$
 676 BEGIN
 677     PERFORM oils_i18n_update_apply( OLD.id::TEXT, NEW.id::TEXT, TG_ARGV[0]::TEXT );
 678     RETURN NEW;
 679 END;
 680 $_$ LANGUAGE PLPGSQL;
 681
 682 CREATE OR REPLACE FUNCTION oils_i18n_code_tracking(/* hint */) RETURNS TRIGGER AS $_$
 683 BEGIN
 684     PERFORM oils_i18n_update_apply( OLD.code::TEXT, NEW.code::TEXT, TG_ARGV[0]::TEXT );
 685     RETURN NEW;
 686 END;
 687 $_$ LANGUAGE PLPGSQL;
 688
 689 CREATE TABLE config.billing_type (
 690     id              SERIAL  PRIMARY KEY,
 691     name            TEXT    NOT NULL,
 692     owner           INT     NOT NULL, -- REFERENCES actor.org_unit (id)
 693     default_price   NUMERIC(6,2),
 694     CONSTRAINT billing_type_once_per_lib UNIQUE (name, owner)
 695 );
 696
 697 CREATE TABLE config.settings_group (
 698     name    TEXT PRIMARY KEY,
 699     label   TEXT UNIQUE NOT NULL -- I18N
 700 );
 701
 702 CREATE TABLE config.org_unit_setting_type (
 703     name            TEXT    PRIMARY KEY,
 704     label           TEXT    UNIQUE NOT NULL,
 705     grp             TEXT    REFERENCES config.settings_group (name),
 706     description     TEXT,
 707     datatype        TEXT    NOT NULL DEFAULT 'string',
 708     fm_class        TEXT,
 709     view_perm       INT,
 710     update_perm     INT,
 711     --
 712     -- define valid datatypes
 713     --
 714     CONSTRAINT coust_valid_datatype CHECK ( datatype IN
 715     ( 'bool', 'integer', 'float', 'currency', 'interval',
 716       'date', 'string', 'object', 'array', 'link' ) ),
 717     --
 718     -- fm_class is meaningful only for 'link' datatype
 719     --
 720     CONSTRAINT coust_no_empty_link CHECK
 721     ( ( datatype =  'link' AND fm_class IS NOT NULL ) OR
 722       ( datatype <> 'link' AND fm_class IS NULL ) )
 723 );
 724
 725 CREATE TABLE config.usr_setting_type (
 726
 727     name TEXT PRIMARY KEY,
 728     opac_visible BOOL NOT NULL DEFAULT FALSE,
 729     label TEXT UNIQUE NOT NULL,
 730     description TEXT,
 731     grp             TEXT    REFERENCES config.settings_group (name),
 732     datatype TEXT NOT NULL DEFAULT 'string',
 733     fm_class TEXT,
 734
 735     --
 736     -- define valid datatypes
 737     --
 738     CONSTRAINT coust_valid_datatype CHECK ( datatype IN
 739     ( 'bool', 'integer', 'float', 'currency', 'interval',
 740         'date', 'string', 'object', 'array', 'link' ) ),
 741
 742     --
 743     -- fm_class is meaningful only for 'link' datatype
 744     --
 745     CONSTRAINT coust_no_empty_link CHECK
 746     ( ( datatype = 'link' AND fm_class IS NOT NULL ) OR
 747         ( datatype <> 'link' AND fm_class IS NULL ) )
 748
 749 );
 750
 751 -- Some handy functions, based on existing ones, to provide optional ingest normalization
 752
 753 CREATE OR REPLACE FUNCTION public.left_trunc( TEXT, INT ) RETURNS TEXT AS $func$
 754         SELECT SUBSTRING($1,$2);
 755 $func$ LANGUAGE SQL STRICT IMMUTABLE;
 756
 757 CREATE OR REPLACE FUNCTION public.right_trunc( TEXT, INT ) RETURNS TEXT AS $func$
 758         SELECT SUBSTRING($1,1,$2);
 759 $func$ LANGUAGE SQL STRICT IMMUTABLE;
 760
 761 CREATE OR REPLACE FUNCTION public.split_date_range( TEXT ) RETURNS TEXT AS $func$
 762         SELECT REGEXP_REPLACE( $1, E'(\\d{4})-(\\d{4})', E'\\1 \\2', 'g' );
 763 $func$ LANGUAGE SQL STRICT IMMUTABLE;
 764
 765 CREATE OR REPLACE FUNCTION public.approximate_date( TEXT, TEXT ) RETURNS TEXT AS $func$
 766         SELECT REGEXP_REPLACE( $1, E'\\D', $2, 'g' );
 767 $func$ LANGUAGE SQL STRICT IMMUTABLE;
 768
 769 CREATE OR REPLACE FUNCTION public.approximate_low_date( TEXT ) RETURNS TEXT AS $func$
 770         SELECT approximate_date( $1, '0');
 771 $func$ LANGUAGE SQL STRICT IMMUTABLE;
 772
 773 CREATE OR REPLACE FUNCTION public.approximate_high_date( TEXT ) RETURNS TEXT AS $func$
 774         SELECT approximate_date( $1, '9');
 775 $func$ LANGUAGE SQL STRICT IMMUTABLE;
 776
 777 CREATE OR REPLACE FUNCTION public.content_or_null( TEXT ) RETURNS TEXT AS $func$
 778         SELECT CASE WHEN $1 ~ E'^\\s*$' THEN NULL ELSE $1 END
 779 $func$ LANGUAGE SQL STRICT IMMUTABLE;
 780
 781 CREATE OR REPLACE FUNCTION public.integer_or_null( TEXT ) RETURNS TEXT AS $func$
 782         SELECT CASE WHEN $1 ~ E'^\\d+$' THEN $1 ELSE NULL END
 783 $func$ LANGUAGE SQL STRICT IMMUTABLE;
 784
 785 CREATE OR REPLACE FUNCTION public.force_to_isbn13( TEXT ) RETURNS TEXT AS $func$
 786     use Business::ISBN;
 787     use strict;
 788     use warnings;
 789
 790     # Find the first ISBN, force it to ISBN13 and return it
 791
 792     my $input = shift;
 793
 794     foreach my $word (split(/\s/, $input)) {
 795         my $isbn = Business::ISBN->new($word);
 796
 797         # First check the checksum; if it is not valid, fix it and add the original
 798         # bad-checksum ISBN to the output
 799         if ($isbn && $isbn->is_valid_checksum() == Business::ISBN::BAD_CHECKSUM) {
 800             $isbn->fix_checksum();
 801         }
 802
 803         # If we now have a valid ISBN, force it to ISBN13 and return it
 804         return $isbn->as_isbn13->isbn if ($isbn && $isbn->is_valid());
 805     }
 806     return undef;
 807 $func$ LANGUAGE PLPERLU;
 808
 809 COMMENT ON FUNCTION public.force_to_isbn13(TEXT) IS $$
 810 /*
 811  * Copyright (C) 2011 Equinox Software
 812  * Mike Rylander <mrylander@gmail.com>
 813  *
 814  * Inspired by translate_isbn1013
 815  *
 816  * The force_to_isbn13 function takes an input ISBN and returns the ISBN13
 817  * version without hypens and with a repaired checksum if the checksum was bad
 818  */
 819 $$;
 820
 821
 822 CREATE OR REPLACE FUNCTION public.translate_isbn1013( TEXT ) RETURNS TEXT AS $func$
 823     use Business::ISBN;
 824     use strict;
 825     use warnings;
 826
 827     # For each ISBN found in a single string containing a set of ISBNs:
 828     #   * Normalize an incoming ISBN to have the correct checksum and no hyphens
 829     #   * Convert an incoming ISBN10 or ISBN13 to its counterpart and return
 830
 831     my $input = shift;
 832     my $output = '';
 833
 834     foreach my $word (split(/\s/, $input)) {
 835         my $isbn = Business::ISBN->new($word);
 836
 837         # First check the checksum; if it is not valid, fix it and add the original
 838         # bad-checksum ISBN to the output
 839         if ($isbn && $isbn->is_valid_checksum() == Business::ISBN::BAD_CHECKSUM) {
 840             $output .= $isbn->isbn() . " ";
 841             $isbn->fix_checksum();
 842         }
 843
 844         # If we now have a valid ISBN, convert it to its counterpart ISBN10/ISBN13
 845         # and add the normalized original ISBN to the output
 846         if ($isbn && $isbn->is_valid()) {
 847             my $isbn_xlated = ($isbn->type eq "ISBN13") ? $isbn->as_isbn10 : $isbn->as_isbn13;
 848             $output .= $isbn->isbn . " ";
 849
 850             # If we successfully converted the ISBN to its counterpart, add the
 851             # converted ISBN to the output as well
 852             $output .= ($isbn_xlated->isbn . " ") if ($isbn_xlated);
 853         }
 854     }
 855     return $output if $output;
 856
 857     # If there were no valid ISBNs, just return the raw input
 858     return $input;
 859 $func$ LANGUAGE PLPERLU;
 860
 861 COMMENT ON FUNCTION public.translate_isbn1013(TEXT) IS $$
 862 /*
 863  * Copyright (C) 2010 Merrimack Valley Library Consortium
 864  * Jason Stephenson <jstephenson@mvlc.org>
 865  * Copyright (C) 2010 Laurentian University
 866  * Dan Scott <dscott@laurentian.ca>
 867  *
 868  * The translate_isbn1013 function takes an input ISBN and returns the
 869  * following in a single space-delimited string if the input ISBN is valid:
 870  *   - The normalized input ISBN (hyphens stripped)
 871  *   - The normalized input ISBN with a fixed checksum if the checksum was bad
 872  *   - The ISBN converted to its ISBN10 or ISBN13 counterpart, if possible
 873  */
 874 $$;
 875
 876 -- And ... a table in which to register them
 877
 878 CREATE TABLE config.index_normalizer (
 879         id              SERIAL  PRIMARY KEY,
 880         name            TEXT    UNIQUE NOT NULL,
 881         description     TEXT,
 882         func            TEXT    NOT NULL,
 883         param_count     INT     NOT NULL DEFAULT 0
 884 );
 885
 886 CREATE TABLE config.metabib_field_index_norm_map (
 887         id      SERIAL  PRIMARY KEY,
 888         field   INT     NOT NULL REFERENCES config.metabib_field (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 889         norm    INT     NOT NULL REFERENCES config.index_normalizer (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 890         params  TEXT,
 891         pos     INT     NOT NULL DEFAULT 0
 892 );
 893
 894 CREATE TABLE config.record_attr_definition (
 895     name        TEXT    PRIMARY KEY,
 896     label       TEXT    NOT NULL, -- I18N
 897     description TEXT,
 898     filter      BOOL    NOT NULL DEFAULT TRUE,  -- becomes QP filter if true
 899     sorter      BOOL    NOT NULL DEFAULT FALSE, -- becomes QP sort() axis if true
 900
 901 -- For pre-extracted fields. Takes the first occurance, uses naive subfield ordering
 902     tag         TEXT, -- LIKE format
 903     sf_list     TEXT, -- pile-o-values, like 'abcd' for a and b and c and d
 904
 905 -- This is used for both tag/sf and xpath entries
 906     joiner      TEXT,
 907
 908 -- For xpath-extracted attrs
 909     xpath       TEXT,
 910     format      TEXT    REFERENCES config.xml_transform (name) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 911     start_pos   INT,
 912     string_len  INT,
 913
 914 -- For fixed fields
 915     fixed_field TEXT, -- should exist in config.marc21_ff_pos_map.fixed_field
 916
 917 -- For phys-char fields
 918     phys_char_sf    INT REFERENCES config.marc21_physical_characteristic_subfield_map (id)
 919 );
 920
 921 CREATE TABLE config.record_attr_index_norm_map (
 922     id      SERIAL  PRIMARY KEY,
 923     attr    TEXT    NOT NULL REFERENCES config.record_attr_definition (name) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 924     norm    INT     NOT NULL REFERENCES config.index_normalizer (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 925     params  TEXT,
 926     pos     INT     NOT NULL DEFAULT 0
 927 );
 928
 929 CREATE TABLE config.coded_value_map (
 930     id          SERIAL  PRIMARY KEY,
 931     ctype       TEXT    NOT NULL REFERENCES config.record_attr_definition (name) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 932     code        TEXT    NOT NULL,
 933     value       TEXT    NOT NULL,
 934     description TEXT
 935 );
 936
 937 CREATE VIEW config.language_map AS SELECT code, value FROM config.coded_value_map WHERE ctype = 'item_lang';
 938 CREATE VIEW config.bib_level_map AS SELECT code, value FROM config.coded_value_map WHERE ctype = 'bib_level';
 939 CREATE VIEW config.item_form_map AS SELECT code, value FROM config.coded_value_map WHERE ctype = 'item_form';
 940 CREATE VIEW config.item_type_map AS SELECT code, value FROM config.coded_value_map WHERE ctype = 'item_type';
 941 CREATE VIEW config.lit_form_map AS SELECT code, value, description FROM config.coded_value_map WHERE ctype = 'lit_form';
 942 CREATE VIEW config.audience_map AS SELECT code, value, description FROM config.coded_value_map WHERE ctype = 'audience';
 943 CREATE VIEW config.videorecording_format_map AS SELECT code, value FROM config.coded_value_map WHERE ctype = 'vr_format';
 944
 945 CREATE OR REPLACE FUNCTION oils_tsearch2 () RETURNS TRIGGER AS $$
 946 DECLARE
 947     normalizer      RECORD;
 948     value           TEXT := '';
 949 BEGIN
 950
 951     value := NEW.value;
 952
 953     IF TG_TABLE_NAME::TEXT ~ 'field_entry$' THEN
 954         FOR normalizer IN
 955             SELECT  n.func AS func,
 956                     n.param_count AS param_count,
 957                     m.params AS params
 958               FROM  config.index_normalizer n
 959                     JOIN config.metabib_field_index_norm_map m ON (m.norm = n.id)
 960               WHERE field = NEW.field AND m.pos < 0
 961               ORDER BY m.pos LOOP
 962                 EXECUTE 'SELECT ' || normalizer.func || '(' ||
 963                     quote_literal( value ) ||
 964                     CASE
 965                         WHEN normalizer.param_count > 0
 966                             THEN ',' || REPLACE(REPLACE(BTRIM(normalizer.params,'[]'),E'\'',E'\\\''),E'"',E'\'')
 967                             ELSE ''
 968                         END ||
 969                     ')' INTO value;
 970
 971         END LOOP;
 972
 973         NEW.value := value;
 974     END IF;
 975
 976     IF NEW.index_vector = ''::tsvector THEN
 977         RETURN NEW;
 978     END IF;
 979
 980     IF TG_TABLE_NAME::TEXT ~ 'field_entry$' THEN
 981         FOR normalizer IN
 982             SELECT  n.func AS func,
 983                     n.param_count AS param_count,
 984                     m.params AS params
 985               FROM  config.index_normalizer n
 986                     JOIN config.metabib_field_index_norm_map m ON (m.norm = n.id)
 987               WHERE field = NEW.field AND m.pos >= 0
 988               ORDER BY m.pos LOOP
 989                 EXECUTE 'SELECT ' || normalizer.func || '(' ||
 990                     quote_literal( value ) ||
 991                     CASE
 992                         WHEN normalizer.param_count > 0
 993                             THEN ',' || REPLACE(REPLACE(BTRIM(normalizer.params,'[]'),E'\'',E'\\\''),E'"',E'\'')
 994                             ELSE ''
 995                         END ||
 996                     ')' INTO value;
 997
 998         END LOOP;
 999     END IF;
1000
1001     IF REGEXP_REPLACE(VERSION(),E'^.+?(\\d+\\.\\d+).*?$',E'\\1')::FLOAT > 8.2 THEN
1002         NEW.index_vector = to_tsvector((TG_ARGV[0])::regconfig, value);
1003     ELSE
1004         NEW.index_vector = to_tsvector(TG_ARGV[0], value);
1005     END IF;
1006
1007     RETURN NEW;
1008 END;
1009 $$ LANGUAGE PLPGSQL;
1010
1011 COMMIT;