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 ('0474'); -- miker
  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 CHECK ( name ~ E'^\\w+$' ),
 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.audience_map (
 570         code            TEXT    PRIMARY KEY,
 571         value           TEXT    NOT NULL,
 572         description     TEXT
 573 );
 574
 575 CREATE TABLE config.lit_form_map (
 576         code            TEXT    PRIMARY KEY,
 577         value           TEXT    NOT NULL,
 578         description     TEXT
 579 );
 580
 581 CREATE TABLE config.language_map (
 582         code    TEXT    PRIMARY KEY,
 583         value   TEXT    NOT NULL
 584 );
 585
 586 CREATE TABLE config.item_form_map (
 587         code    TEXT    PRIMARY KEY,
 588         value   TEXT    NOT NULL
 589 );
 590
 591 CREATE TABLE config.item_type_map (
 592         code    TEXT    PRIMARY KEY,
 593         value   TEXT    NOT NULL
 594 );
 595
 596 CREATE TABLE config.bib_level_map (
 597         code    TEXT    PRIMARY KEY,
 598         value   TEXT    NOT NULL
 599 );
 600
 601 CREATE TABLE config.marc21_rec_type_map (
 602     code        TEXT    PRIMARY KEY,
 603     type_val    TEXT    NOT NULL,
 604     blvl_val    TEXT    NOT NULL
 605 );
 606
 607 CREATE TABLE config.marc21_ff_pos_map (
 608     id          SERIAL  PRIMARY KEY,
 609     fixed_field TEXT    NOT NULL,
 610     tag         TEXT    NOT NULL,
 611     rec_type    TEXT    NOT NULL,
 612     start_pos   INT     NOT NULL,
 613     length      INT     NOT NULL,
 614     default_val TEXT    NOT NULL DEFAULT ' '
 615 );
 616
 617 CREATE TABLE config.marc21_physical_characteristic_type_map (
 618     ptype_key   TEXT    PRIMARY KEY,
 619     label       TEXT    NOT NULL -- I18N
 620 );
 621
 622 CREATE TABLE config.marc21_physical_characteristic_subfield_map (
 623     id          SERIAL  PRIMARY KEY,
 624     ptype_key   TEXT    NOT NULL REFERENCES config.marc21_physical_characteristic_type_map (ptype_key) ON DELETE CASCADE ON UPDATE CASCADE,
 625     subfield    TEXT    NOT NULL,
 626     start_pos   INT     NOT NULL,
 627     length      INT     NOT NULL,
 628     label       TEXT    NOT NULL -- I18N
 629 );
 630
 631 CREATE TABLE config.marc21_physical_characteristic_value_map (
 632     id              SERIAL  PRIMARY KEY,
 633     value           TEXT    NOT NULL,
 634     ptype_subfield  INT     NOT NULL REFERENCES config.marc21_physical_characteristic_subfield_map (id),
 635     label           TEXT    NOT NULL -- I18N
 636 );
 637
 638
 639 CREATE TABLE config.z3950_source (
 640     name                TEXT    PRIMARY KEY,
 641     label               TEXT    NOT NULL UNIQUE,
 642     host                TEXT    NOT NULL,
 643     port                INT     NOT NULL,
 644     db                  TEXT    NOT NULL,
 645     record_format       TEXT    NOT NULL DEFAULT 'FI',
 646     transmission_format TEXT    NOT NULL DEFAULT 'usmarc',
 647     auth                BOOL    NOT NULL DEFAULT TRUE
 648 );
 649
 650 COMMENT ON TABLE config.z3950_source IS $$
 651 Z39.50 Sources
 652
 653 Each row in this table represents a database searchable via Z39.50.
 654 $$;
 655
 656 COMMENT ON COLUMN config.z3950_source.record_format IS $$
 657 Z39.50 element set.
 658 $$;
 659
 660 COMMENT ON COLUMN config.z3950_source.transmission_format IS $$
 661 Z39.50 preferred record syntax..
 662 $$;
 663
 664
 665 CREATE TABLE config.z3950_attr (
 666     id          SERIAL  PRIMARY KEY,
 667     source      TEXT    NOT NULL REFERENCES config.z3950_source (name) DEFERRABLE INITIALLY DEFERRED,
 668     name        TEXT    NOT NULL,
 669     label       TEXT    NOT NULL,
 670     code        INT     NOT NULL,
 671     format      INT     NOT NULL,
 672     truncation  INT     NOT NULL DEFAULT 0,
 673     CONSTRAINT z_code_format_once_per_source UNIQUE (code,format,source)
 674 );
 675
 676 CREATE TABLE config.i18n_locale (
 677     code        TEXT    PRIMARY KEY,
 678     marc_code   TEXT    NOT NULL REFERENCES config.language_map (code) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 679     name        TEXT    UNIQUE NOT NULL,
 680     description TEXT
 681 );
 682
 683 CREATE TABLE config.i18n_core (
 684     id              BIGSERIAL   PRIMARY KEY,
 685     fq_field        TEXT        NOT NULL,
 686     identity_value  TEXT        NOT NULL,
 687     translation     TEXT        NOT NULL    REFERENCES config.i18n_locale (code) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 688     string          TEXT        NOT NULL
 689 );
 690
 691 CREATE UNIQUE INDEX i18n_identity ON config.i18n_core (fq_field,identity_value,translation);
 692
 693 CREATE OR REPLACE FUNCTION oils_i18n_update_apply(old_ident TEXT, new_ident TEXT, hint TEXT) RETURNS VOID AS $_$
 694 BEGIN
 695
 696     EXECUTE $$
 697         UPDATE  config.i18n_core
 698           SET   identity_value = $$ || quote_literal(new_ident) || $$
 699           WHERE fq_field LIKE '$$ || hint || $$.%'
 700                 AND identity_value = $$ || quote_literal(old_ident) || $$::TEXT;$$;
 701
 702     RETURN;
 703
 704 END;
 705 $_$ LANGUAGE PLPGSQL;
 706
 707 CREATE OR REPLACE FUNCTION oils_i18n_id_tracking(/* hint */) RETURNS TRIGGER AS $_$
 708 BEGIN
 709     PERFORM oils_i18n_update_apply( OLD.id::TEXT, NEW.id::TEXT, TG_ARGV[0]::TEXT );
 710     RETURN NEW;
 711 END;
 712 $_$ LANGUAGE PLPGSQL;
 713
 714 CREATE OR REPLACE FUNCTION oils_i18n_code_tracking(/* hint */) RETURNS TRIGGER AS $_$
 715 BEGIN
 716     PERFORM oils_i18n_update_apply( OLD.code::TEXT, NEW.code::TEXT, TG_ARGV[0]::TEXT );
 717     RETURN NEW;
 718 END;
 719 $_$ LANGUAGE PLPGSQL;
 720
 721 CREATE TABLE config.billing_type (
 722     id              SERIAL  PRIMARY KEY,
 723     name            TEXT    NOT NULL,
 724     owner           INT     NOT NULL, -- REFERENCES actor.org_unit (id)
 725     default_price   NUMERIC(6,2),
 726     CONSTRAINT billing_type_once_per_lib UNIQUE (name, owner)
 727 );
 728
 729 CREATE TABLE config.settings_group (
 730     name    TEXT PRIMARY KEY,
 731     label   TEXT UNIQUE NOT NULL -- I18N
 732 );
 733
 734 CREATE TABLE config.org_unit_setting_type (
 735     name            TEXT    PRIMARY KEY,
 736     label           TEXT    UNIQUE NOT NULL,
 737     grp             TEXT    REFERENCES config.settings_group (name),
 738     description     TEXT,
 739     datatype        TEXT    NOT NULL DEFAULT 'string',
 740     fm_class        TEXT,
 741     view_perm       INT,
 742     update_perm     INT,
 743     --
 744     -- define valid datatypes
 745     --
 746     CONSTRAINT coust_valid_datatype CHECK ( datatype IN
 747     ( 'bool', 'integer', 'float', 'currency', 'interval',
 748       'date', 'string', 'object', 'array', 'link' ) ),
 749     --
 750     -- fm_class is meaningful only for 'link' datatype
 751     --
 752     CONSTRAINT coust_no_empty_link CHECK
 753     ( ( datatype =  'link' AND fm_class IS NOT NULL ) OR
 754       ( datatype <> 'link' AND fm_class IS NULL ) )
 755 );
 756
 757 CREATE TABLE config.usr_setting_type (
 758
 759     name TEXT PRIMARY KEY,
 760     opac_visible BOOL NOT NULL DEFAULT FALSE,
 761     label TEXT UNIQUE NOT NULL,
 762     description TEXT,
 763     grp             TEXT    REFERENCES config.settings_group (name),
 764     datatype TEXT NOT NULL DEFAULT 'string',
 765     fm_class TEXT,
 766
 767     --
 768     -- define valid datatypes
 769     --
 770     CONSTRAINT coust_valid_datatype CHECK ( datatype IN
 771     ( 'bool', 'integer', 'float', 'currency', 'interval',
 772         'date', 'string', 'object', 'array', 'link' ) ),
 773
 774     --
 775     -- fm_class is meaningful only for 'link' datatype
 776     --
 777     CONSTRAINT coust_no_empty_link CHECK
 778     ( ( datatype = 'link' AND fm_class IS NOT NULL ) OR
 779         ( datatype <> 'link' AND fm_class IS NULL ) )
 780
 781 );
 782
 783 -- Some handy functions, based on existing ones, to provide optional ingest normalization
 784
 785 CREATE OR REPLACE FUNCTION public.left_trunc( TEXT, INT ) RETURNS TEXT AS $func$
 786         SELECT SUBSTRING($1,$2);
 787 $func$ LANGUAGE SQL STRICT IMMUTABLE;
 788
 789 CREATE OR REPLACE FUNCTION public.right_trunc( TEXT, INT ) RETURNS TEXT AS $func$
 790         SELECT SUBSTRING($1,1,$2);
 791 $func$ LANGUAGE SQL STRICT IMMUTABLE;
 792
 793 CREATE OR REPLACE FUNCTION public.split_date_range( TEXT ) RETURNS TEXT AS $func$
 794         SELECT REGEXP_REPLACE( $1, E'(\\d{4})-(\\d{4})', E'\\1 \\2', 'g' );
 795 $func$ LANGUAGE SQL STRICT IMMUTABLE;
 796
 797 CREATE OR REPLACE FUNCTION public.translate_isbn1013( TEXT ) RETURNS TEXT AS $func$
 798     use Business::ISBN;
 799     use strict;
 800     use warnings;
 801
 802     # For each ISBN found in a single string containing a set of ISBNs:
 803     #   * Normalize an incoming ISBN to have the correct checksum and no hyphens
 804     #   * Convert an incoming ISBN10 or ISBN13 to its counterpart and return
 805
 806     my $input = shift;
 807     my $output = '';
 808
 809     foreach my $word (split(/\s/, $input)) {
 810         my $isbn = Business::ISBN->new($word);
 811
 812         # First check the checksum; if it is not valid, fix it and add the original
 813         # bad-checksum ISBN to the output
 814         if ($isbn && $isbn->is_valid_checksum() == Business::ISBN::BAD_CHECKSUM) {
 815             $output .= $isbn->isbn() . " ";
 816             $isbn->fix_checksum();
 817         }
 818
 819         # If we now have a valid ISBN, convert it to its counterpart ISBN10/ISBN13
 820         # and add the normalized original ISBN to the output
 821         if ($isbn && $isbn->is_valid()) {
 822             my $isbn_xlated = ($isbn->type eq "ISBN13") ? $isbn->as_isbn10 : $isbn->as_isbn13;
 823             $output .= $isbn->isbn . " ";
 824
 825             # If we successfully converted the ISBN to its counterpart, add the
 826             # converted ISBN to the output as well
 827             $output .= ($isbn_xlated->isbn . " ") if ($isbn_xlated);
 828         }
 829     }
 830     return $output if $output;
 831
 832     # If there were no valid ISBNs, just return the raw input
 833     return $input;
 834 $func$ LANGUAGE PLPERLU;
 835
 836 COMMENT ON FUNCTION public.translate_isbn1013(TEXT) IS $$
 837 /*
 838  * Copyright (C) 2010 Merrimack Valley Library Consortium
 839  * Jason Stephenson <jstephenson@mvlc.org>
 840  * Copyright (C) 2010 Laurentian University
 841  * Dan Scott <dscott@laurentian.ca>
 842  *
 843  * The translate_isbn1013 function takes an input ISBN and returns the
 844  * following in a single space-delimited string if the input ISBN is valid:
 845  *   - The normalized input ISBN (hyphens stripped)
 846  *   - The normalized input ISBN with a fixed checksum if the checksum was bad
 847  *   - The ISBN converted to its ISBN10 or ISBN13 counterpart, if possible
 848  */
 849 $$;
 850
 851 -- And ... a table in which to register them
 852
 853 CREATE TABLE config.index_normalizer (
 854         id              SERIAL  PRIMARY KEY,
 855         name            TEXT    UNIQUE NOT NULL,
 856         description     TEXT,
 857         func            TEXT    NOT NULL,
 858         param_count     INT     NOT NULL DEFAULT 0
 859 );
 860
 861 CREATE TABLE config.metabib_field_index_norm_map (
 862         id      SERIAL  PRIMARY KEY,
 863         field   INT     NOT NULL REFERENCES config.metabib_field (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 864         norm    INT     NOT NULL REFERENCES config.index_normalizer (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 865         params  TEXT,
 866         pos     INT     NOT NULL DEFAULT 0
 867 );
 868
 869 CREATE OR REPLACE FUNCTION oils_tsearch2 () RETURNS TRIGGER AS $$
 870 DECLARE
 871     normalizer      RECORD;
 872     value           TEXT := '';
 873 BEGIN
 874
 875     value := NEW.value;
 876
 877     IF TG_TABLE_NAME::TEXT ~ 'field_entry$' THEN
 878         FOR normalizer IN
 879             SELECT  n.func AS func,
 880                     n.param_count AS param_count,
 881                     m.params AS params
 882               FROM  config.index_normalizer n
 883                     JOIN config.metabib_field_index_norm_map m ON (m.norm = n.id)
 884               WHERE field = NEW.field AND m.pos < 0
 885               ORDER BY m.pos LOOP
 886                 EXECUTE 'SELECT ' || normalizer.func || '(' ||
 887                     quote_literal( value ) ||
 888                     CASE
 889                         WHEN normalizer.param_count > 0
 890                             THEN ',' || REPLACE(REPLACE(BTRIM(normalizer.params,'[]'),E'\'',E'\\\''),E'"',E'\'')
 891                             ELSE ''
 892                         END ||
 893                     ')' INTO value;
 894
 895         END LOOP;
 896
 897         NEW.value := value;
 898     END IF;
 899
 900     IF NEW.index_vector = ''::tsvector THEN
 901         RETURN NEW;
 902     END IF;
 903
 904     IF TG_TABLE_NAME::TEXT ~ 'field_entry$' THEN
 905         FOR normalizer IN
 906             SELECT  n.func AS func,
 907                     n.param_count AS param_count,
 908                     m.params AS params
 909               FROM  config.index_normalizer n
 910                     JOIN config.metabib_field_index_norm_map m ON (m.norm = n.id)
 911               WHERE field = NEW.field AND m.pos >= 0
 912               ORDER BY m.pos LOOP
 913                 EXECUTE 'SELECT ' || normalizer.func || '(' ||
 914                     quote_literal( value ) ||
 915                     CASE
 916                         WHEN normalizer.param_count > 0
 917                             THEN ',' || REPLACE(REPLACE(BTRIM(normalizer.params,'[]'),E'\'',E'\\\''),E'"',E'\'')
 918                             ELSE ''
 919                         END ||
 920                     ')' INTO value;
 921
 922         END LOOP;
 923     END IF;
 924
 925     IF REGEXP_REPLACE(VERSION(),E'^.+?(\\d+\\.\\d+).*?$',E'\\1')::FLOAT > 8.2 THEN
 926         NEW.index_vector = to_tsvector((TG_ARGV[0])::regconfig, value);
 927     ELSE
 928         NEW.index_vector = to_tsvector(TG_ARGV[0], value);
 929     END IF;
 930
 931     RETURN NEW;
 932 END;
 933 $$ LANGUAGE PLPGSQL;
 934
 935 COMMIT;