Open-ILS/src/sql/Pg/030.schema.metabib.sql

   1 /*
   2  * Copyright (C) 2004-2008  Georgia Public Library Service
   3  * Copyright (C) 2007-2008  Equinox Software, Inc.
   4  * Mike Rylander <miker@esilibrary.com>
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version 2
   9  * of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  */
  17
  18 DROP SCHEMA IF EXISTS metabib CASCADE;
  19
  20 BEGIN;
  21 CREATE SCHEMA metabib;
  22
  23 CREATE TABLE metabib.metarecord (
  24         id              BIGSERIAL       PRIMARY KEY,
  25         fingerprint     TEXT            NOT NULL,
  26         master_record   BIGINT,
  27         mods            TEXT
  28 );
  29 CREATE INDEX metabib_metarecord_master_record_idx ON metabib.metarecord (master_record);
  30 CREATE INDEX metabib_metarecord_fingerprint_idx ON metabib.metarecord (fingerprint);
  31
  32 CREATE TABLE metabib.identifier_field_entry (
  33         id              BIGSERIAL       PRIMARY KEY,
  34         source          BIGINT          NOT NULL,
  35         field           INT             NOT NULL,
  36         value           TEXT            NOT NULL,
  37         index_vector    tsvector        NOT NULL
  38 );
  39 CREATE TRIGGER metabib_identifier_field_entry_fti_trigger
  40         BEFORE UPDATE OR INSERT ON metabib.identifier_field_entry
  41         FOR EACH ROW EXECUTE PROCEDURE oils_tsearch2('identifier');
  42
  43 CREATE INDEX metabib_identifier_field_entry_index_vector_idx ON metabib.identifier_field_entry USING GIST (index_vector);
  44 CREATE INDEX metabib_identifier_field_entry_value_idx ON metabib.identifier_field_entry (SUBSTRING(value,1,1024)) WHERE index_vector = ''::TSVECTOR;
  45 CREATE INDEX metabib_identifier_field_entry_source_idx ON metabib.identifier_field_entry (source);
  46
  47
  48 CREATE TABLE metabib.title_field_entry (
  49         id              BIGSERIAL       PRIMARY KEY,
  50         source          BIGINT          NOT NULL,
  51         field           INT             NOT NULL,
  52         value           TEXT            NOT NULL,
  53         index_vector    tsvector        NOT NULL
  54 );
  55 CREATE TRIGGER metabib_title_field_entry_fti_trigger
  56         BEFORE UPDATE OR INSERT ON metabib.title_field_entry
  57         FOR EACH ROW EXECUTE PROCEDURE oils_tsearch2('title');
  58
  59 CREATE INDEX metabib_title_field_entry_index_vector_idx ON metabib.title_field_entry USING GIST (index_vector);
  60 CREATE INDEX metabib_title_field_entry_value_idx ON metabib.title_field_entry (SUBSTRING(value,1,1024)) WHERE index_vector = ''::TSVECTOR;
  61 CREATE INDEX metabib_title_field_entry_source_idx ON metabib.title_field_entry (source);
  62
  63
  64 CREATE TABLE metabib.author_field_entry (
  65         id              BIGSERIAL       PRIMARY KEY,
  66         source          BIGINT          NOT NULL,
  67         field           INT             NOT NULL,
  68         value           TEXT            NOT NULL,
  69         index_vector    tsvector        NOT NULL
  70 );
  71 CREATE TRIGGER metabib_author_field_entry_fti_trigger
  72         BEFORE UPDATE OR INSERT ON metabib.author_field_entry
  73         FOR EACH ROW EXECUTE PROCEDURE oils_tsearch2('author');
  74
  75 CREATE INDEX metabib_author_field_entry_index_vector_idx ON metabib.author_field_entry USING GIST (index_vector);
  76 CREATE INDEX metabib_author_field_entry_value_idx ON metabib.author_field_entry (SUBSTRING(value,1,1024)) WHERE index_vector = ''::TSVECTOR;
  77 CREATE INDEX metabib_author_field_entry_source_idx ON metabib.author_field_entry (source);
  78
  79
  80 CREATE TABLE metabib.subject_field_entry (
  81         id              BIGSERIAL       PRIMARY KEY,
  82         source          BIGINT          NOT NULL,
  83         field           INT             NOT NULL,
  84         value           TEXT            NOT NULL,
  85         index_vector    tsvector        NOT NULL
  86 );
  87 CREATE TRIGGER metabib_subject_field_entry_fti_trigger
  88         BEFORE UPDATE OR INSERT ON metabib.subject_field_entry
  89         FOR EACH ROW EXECUTE PROCEDURE oils_tsearch2('subject');
  90
  91 CREATE INDEX metabib_subject_field_entry_index_vector_idx ON metabib.subject_field_entry USING GIST (index_vector);
  92 CREATE INDEX metabib_subject_field_entry_value_idx ON metabib.subject_field_entry (SUBSTRING(value,1,1024)) WHERE index_vector = ''::TSVECTOR;
  93 CREATE INDEX metabib_subject_field_entry_source_idx ON metabib.subject_field_entry (source);
  94
  95
  96 CREATE TABLE metabib.keyword_field_entry (
  97         id              BIGSERIAL       PRIMARY KEY,
  98         source          BIGINT          NOT NULL,
  99         field           INT             NOT NULL,
 100         value           TEXT            NOT NULL,
 101         index_vector    tsvector        NOT NULL
 102 );
 103 CREATE TRIGGER metabib_keyword_field_entry_fti_trigger
 104         BEFORE UPDATE OR INSERT ON metabib.keyword_field_entry
 105         FOR EACH ROW EXECUTE PROCEDURE oils_tsearch2('keyword');
 106
 107 CREATE INDEX metabib_keyword_field_entry_index_vector_idx ON metabib.keyword_field_entry USING GIST (index_vector);
 108 CREATE INDEX metabib_keyword_field_entry_value_idx ON metabib.keyword_field_entry (SUBSTRING(value,1,1024)) WHERE index_vector = ''::TSVECTOR;
 109 CREATE INDEX metabib_keyword_field_entry_source_idx ON metabib.keyword_field_entry (source);
 110
 111
 112 CREATE TABLE metabib.series_field_entry (
 113         id              BIGSERIAL       PRIMARY KEY,
 114         source          BIGINT          NOT NULL,
 115         field           INT             NOT NULL,
 116         value           TEXT            NOT NULL,
 117         index_vector    tsvector        NOT NULL
 118 );
 119 CREATE TRIGGER metabib_series_field_entry_fti_trigger
 120         BEFORE UPDATE OR INSERT ON metabib.series_field_entry
 121         FOR EACH ROW EXECUTE PROCEDURE oils_tsearch2('series');
 122
 123 CREATE INDEX metabib_series_field_entry_index_vector_idx ON metabib.series_field_entry USING GIST (index_vector);
 124 CREATE INDEX metabib_series_field_entry_value_idx ON metabib.series_field_entry (SUBSTRING(value,1,1024)) WHERE index_vector = ''::TSVECTOR;
 125 CREATE INDEX metabib_series_field_entry_source_idx ON metabib.series_field_entry (source);
 126
 127
 128 CREATE TABLE metabib.facet_entry (
 129         id              BIGSERIAL       PRIMARY KEY,
 130         source          BIGINT          NOT NULL,
 131         field           INT             NOT NULL,
 132         value           TEXT            NOT NULL
 133 );
 134 CREATE INDEX metabib_facet_entry_field_idx ON metabib.facet_entry (field);
 135 CREATE INDEX metabib_facet_entry_value_idx ON metabib.facet_entry (SUBSTRING(value,1,1024));
 136 CREATE INDEX metabib_facet_entry_source_idx ON metabib.facet_entry (source);
 137
 138 CREATE TABLE metabib.browse_entry (
 139     id BIGSERIAL PRIMARY KEY,
 140     value TEXT unique,
 141     index_vector tsvector
 142 );
 143 CREATE INDEX metabib_browse_entry_index_vector_idx ON metabib.browse_entry USING GIST (index_vector);
 144 CREATE TRIGGER metabib_browse_entry_fti_trigger
 145     BEFORE INSERT OR UPDATE ON metabib.browse_entry
 146     FOR EACH ROW EXECUTE PROCEDURE oils_tsearch2('keyword');
 147
 148
 149 CREATE TABLE metabib.browse_entry_def_map (
 150     id BIGSERIAL PRIMARY KEY,
 151     entry BIGINT REFERENCES metabib.browse_entry (id),
 152     def INT REFERENCES config.metabib_field (id),
 153     source BIGINT REFERENCES biblio.record_entry (id)
 154 );
 155
 156
 157 CREATE OR REPLACE FUNCTION metabib.facet_normalize_trigger () RETURNS TRIGGER AS $$
 158 DECLARE
 159     normalizer  RECORD;
 160     facet_text  TEXT;
 161 BEGIN
 162     facet_text := NEW.value;
 163
 164     FOR normalizer IN
 165         SELECT  n.func AS func,
 166                 n.param_count AS param_count,
 167                 m.params AS params
 168           FROM  config.index_normalizer n
 169                 JOIN config.metabib_field_index_norm_map m ON (m.norm = n.id)
 170           WHERE m.field = NEW.field AND m.pos < 0
 171           ORDER BY m.pos LOOP
 172
 173             EXECUTE 'SELECT ' || normalizer.func || '(' ||
 174                 quote_literal( facet_text ) ||
 175                 CASE
 176                     WHEN normalizer.param_count > 0
 177                         THEN ',' || REPLACE(REPLACE(BTRIM(normalizer.params,'[]'),E'\'',E'\\\''),E'"',E'\'')
 178                         ELSE ''
 179                     END ||
 180                 ')' INTO facet_text;
 181
 182     END LOOP;
 183
 184     NEW.value = facet_text;
 185
 186     RETURN NEW;
 187 END;
 188 $$ LANGUAGE PLPGSQL;
 189
 190 CREATE TRIGGER facet_normalize_tgr
 191         BEFORE UPDATE OR INSERT ON metabib.facet_entry
 192         FOR EACH ROW EXECUTE PROCEDURE metabib.facet_normalize_trigger();
 193
 194 CREATE OR REPLACE FUNCTION evergreen.facet_force_nfc() RETURNS TRIGGER AS $$
 195 BEGIN
 196     NEW.value := force_unicode_normal_form(NEW.value,'NFC');
 197     RETURN NEW;
 198 END;
 199 $$ LANGUAGE PLPGSQL;
 200
 201 CREATE TRIGGER facet_force_nfc_tgr
 202         BEFORE UPDATE OR INSERT ON metabib.facet_entry
 203         FOR EACH ROW EXECUTE PROCEDURE evergreen.facet_force_nfc();
 204
 205 CREATE TABLE metabib.record_attr (
 206         id              BIGINT  PRIMARY KEY REFERENCES biblio.record_entry (id) ON DELETE CASCADE,
 207         attrs   HSTORE  NOT NULL DEFAULT ''::HSTORE
 208 );
 209 CREATE INDEX metabib_svf_attrs_idx ON metabib.record_attr USING GIST (attrs);
 210 CREATE INDEX metabib_svf_date1_idx ON metabib.record_attr ((attrs->'date1'));
 211 CREATE INDEX metabib_svf_dates_idx ON metabib.record_attr ((attrs->'date1'),(attrs->'date2'));
 212
 213 -- Back-compat view ... we're moving to an HSTORE world
 214 CREATE TYPE metabib.rec_desc_type AS (
 215     item_type       TEXT,
 216     item_form       TEXT,
 217     bib_level       TEXT,
 218     control_type    TEXT,
 219     char_encoding   TEXT,
 220     enc_level       TEXT,
 221     audience        TEXT,
 222     lit_form        TEXT,
 223     type_mat        TEXT,
 224     cat_form        TEXT,
 225     pub_status      TEXT,
 226     item_lang       TEXT,
 227     vr_format       TEXT,
 228     date1           TEXT,
 229     date2           TEXT
 230 );
 231
 232 CREATE VIEW metabib.rec_descriptor AS
 233     SELECT  id,
 234             id AS record,
 235             (populate_record(NULL::metabib.rec_desc_type, attrs)).*
 236       FROM  metabib.record_attr;
 237
 238 -- Use a sequence that matches previous version, for easier upgrading.
 239 CREATE SEQUENCE metabib.full_rec_id_seq;
 240
 241 CREATE TABLE metabib.real_full_rec (
 242         id                  BIGINT      NOT NULL DEFAULT NEXTVAL('metabib.full_rec_id_seq'::REGCLASS),
 243         record          BIGINT          NOT NULL,
 244         tag             CHAR(3)         NOT NULL,
 245         ind1            TEXT,
 246         ind2            TEXT,
 247         subfield        TEXT,
 248         value           TEXT            NOT NULL,
 249         index_vector    tsvector        NOT NULL
 250 );
 251 ALTER TABLE metabib.real_full_rec ADD PRIMARY KEY (id);
 252
 253 CREATE INDEX metabib_full_rec_tag_subfield_idx ON metabib.real_full_rec (tag,subfield);
 254 CREATE INDEX metabib_full_rec_value_idx ON metabib.real_full_rec (substring(value,1,1024));
 255 /* Enable LIKE to use an index for database clusters with locales other than C or POSIX */
 256 CREATE INDEX metabib_full_rec_value_tpo_index ON metabib.real_full_rec (substring(value,1,1024) text_pattern_ops);
 257 CREATE INDEX metabib_full_rec_record_idx ON metabib.real_full_rec (record);
 258 CREATE INDEX metabib_full_rec_index_vector_idx ON metabib.real_full_rec USING GIST (index_vector);
 259 CREATE INDEX metabib_full_rec_isxn_caseless_idx
 260     ON metabib.real_full_rec (LOWER(value))
 261     WHERE tag IN ('020', '022', '024');
 262
 263
 264 CREATE TRIGGER metabib_full_rec_fti_trigger
 265         BEFORE UPDATE OR INSERT ON metabib.real_full_rec
 266         FOR EACH ROW EXECUTE PROCEDURE oils_tsearch2('default');
 267
 268 CREATE OR REPLACE VIEW metabib.full_rec AS
 269     SELECT  id,
 270             record,
 271             tag,
 272             ind1,
 273             ind2,
 274             subfield,
 275             SUBSTRING(value,1,1024) AS value,
 276             index_vector
 277       FROM  metabib.real_full_rec;
 278
 279 CREATE OR REPLACE RULE metabib_full_rec_insert_rule
 280     AS ON INSERT TO metabib.full_rec
 281     DO INSTEAD
 282     INSERT INTO metabib.real_full_rec VALUES (
 283         COALESCE(NEW.id, NEXTVAL('metabib.full_rec_id_seq'::REGCLASS)),
 284         NEW.record,
 285         NEW.tag,
 286         NEW.ind1,
 287         NEW.ind2,
 288         NEW.subfield,
 289         NEW.value,
 290         NEW.index_vector
 291     );
 292
 293 CREATE OR REPLACE RULE metabib_full_rec_update_rule
 294     AS ON UPDATE TO metabib.full_rec
 295     DO INSTEAD
 296     UPDATE  metabib.real_full_rec SET
 297         id = NEW.id,
 298         record = NEW.record,
 299         tag = NEW.tag,
 300         ind1 = NEW.ind1,
 301         ind2 = NEW.ind2,
 302         subfield = NEW.subfield,
 303         value = NEW.value,
 304         index_vector = NEW.index_vector
 305       WHERE id = OLD.id;
 306
 307 CREATE OR REPLACE RULE metabib_full_rec_delete_rule
 308     AS ON DELETE TO metabib.full_rec
 309     DO INSTEAD
 310     DELETE FROM metabib.real_full_rec WHERE id = OLD.id;
 311
 312 CREATE TABLE metabib.metarecord_source_map (
 313         id              BIGSERIAL       PRIMARY KEY,
 314         metarecord      BIGINT          NOT NULL,
 315         source          BIGINT          NOT NULL
 316 );
 317 CREATE INDEX metabib_metarecord_source_map_metarecord_idx ON metabib.metarecord_source_map (metarecord);
 318 CREATE INDEX metabib_metarecord_source_map_source_record_idx ON metabib.metarecord_source_map (source);
 319
 320 CREATE TYPE metabib.field_entry_template AS (
 321         field_class     TEXT,
 322         field           INT,
 323         facet_field     BOOL,
 324         search_field    BOOL,
 325         browse_field   BOOL,
 326         source          BIGINT,
 327         value           TEXT
 328 );
 329
 330
 331 CREATE OR REPLACE FUNCTION biblio.extract_metabib_field_entry ( rid BIGINT, default_joiner TEXT ) RETURNS SETOF metabib.field_entry_template AS $func$
 332 DECLARE
 333     bib     biblio.record_entry%ROWTYPE;
 334     idx     config.metabib_field%ROWTYPE;
 335     xfrm        config.xml_transform%ROWTYPE;
 336     prev_xfrm   TEXT;
 337     transformed_xml TEXT;
 338     xml_node    TEXT;
 339     xml_node_list   TEXT[];
 340     facet_text  TEXT;
 341     browse_text TEXT;
 342     raw_text    TEXT;
 343     curr_text   TEXT;
 344     joiner      TEXT := default_joiner; -- XXX will index defs supply a joiner?
 345     output_row  metabib.field_entry_template%ROWTYPE;
 346 BEGIN
 347
 348     -- Get the record
 349     SELECT INTO bib * FROM biblio.record_entry WHERE id = rid;
 350
 351     -- Loop over the indexing entries
 352     FOR idx IN SELECT * FROM config.metabib_field ORDER BY format LOOP
 353
 354         SELECT INTO xfrm * from config.xml_transform WHERE name = idx.format;
 355
 356         -- See if we can skip the XSLT ... it's expensive
 357         IF prev_xfrm IS NULL OR prev_xfrm <> xfrm.name THEN
 358             -- Can't skip the transform
 359             IF xfrm.xslt <> '---' THEN
 360                 transformed_xml := oils_xslt_process(bib.marc,xfrm.xslt);
 361             ELSE
 362                 transformed_xml := bib.marc;
 363             END IF;
 364
 365             prev_xfrm := xfrm.name;
 366         END IF;
 367
 368         xml_node_list := oils_xpath( idx.xpath, transformed_xml, ARRAY[ARRAY[xfrm.prefix, xfrm.namespace_uri]] );
 369
 370         raw_text := NULL;
 371         FOR xml_node IN SELECT x FROM unnest(xml_node_list) AS x LOOP
 372             CONTINUE WHEN xml_node !~ E'^\\s*<';
 373
 374             curr_text := ARRAY_TO_STRING(
 375                 oils_xpath( '//text()',
 376                     REGEXP_REPLACE( -- This escapes all &s not followed by "amp;".  Data ise returned from oils_xpath (above) in UTF-8, not entity encoded
 377                         REGEXP_REPLACE( -- This escapes embeded <s
 378                             xml_node,
 379                             $re$(>[^<]+)(<)([^>]+<)$re$,
 380                             E'\\1&lt;\\3',
 381                             'g'
 382                         ),
 383                         '&(?!amp;)',
 384                         '&amp;',
 385                         'g'
 386                     )
 387                 ),
 388                 ' '
 389             );
 390
 391             CONTINUE WHEN curr_text IS NULL OR curr_text = '';
 392
 393             IF raw_text IS NOT NULL THEN
 394                 raw_text := raw_text || joiner;
 395             END IF;
 396
 397             raw_text := COALESCE(raw_text,'') || curr_text;
 398
 399             -- autosuggest/metabib.browse_entry
 400             IF idx.browse_field THEN
 401
 402                 IF idx.browse_xpath IS NOT NULL AND idx.browse_xpath <> '' THEN
 403                     browse_text := oils_xpath_string( idx.browse_xpath, xml_node, joiner, ARRAY[ARRAY[xfrm.prefix, xfrm.namespace_uri]] );
 404                 ELSE
 405                     browse_text := curr_text;
 406                 END IF;
 407
 408                 output_row.field_class = idx.field_class;
 409                 output_row.field = idx.id;
 410                 output_row.source = rid;
 411                 output_row.value = BTRIM(REGEXP_REPLACE(browse_text, E'\\s+', ' ', 'g'));
 412
 413                 output_row.browse_field = TRUE;
 414                 RETURN NEXT output_row;
 415                 output_row.browse_field = FALSE;
 416             END IF;
 417
 418             -- insert raw node text for faceting
 419             IF idx.facet_field THEN
 420
 421                 IF idx.facet_xpath IS NOT NULL AND idx.facet_xpath <> '' THEN
 422                     facet_text := oils_xpath_string( idx.facet_xpath, xml_node, joiner, ARRAY[ARRAY[xfrm.prefix, xfrm.namespace_uri]] );
 423                 ELSE
 424                     facet_text := curr_text;
 425                 END IF;
 426
 427                 output_row.field_class = idx.field_class;
 428                 output_row.field = -1 * idx.id;
 429                 output_row.source = rid;
 430                 output_row.value = BTRIM(REGEXP_REPLACE(facet_text, E'\\s+', ' ', 'g'));
 431
 432                 output_row.facet_field = TRUE;
 433                 RETURN NEXT output_row;
 434                 output_row.facet_field = FALSE;
 435             END IF;
 436
 437         END LOOP;
 438
 439         CONTINUE WHEN raw_text IS NULL OR raw_text = '';
 440
 441         -- insert combined node text for searching
 442         IF idx.search_field THEN
 443             output_row.field_class = idx.field_class;
 444             output_row.field = idx.id;
 445             output_row.source = rid;
 446             output_row.value = BTRIM(REGEXP_REPLACE(raw_text, E'\\s+', ' ', 'g'));
 447
 448             output_row.search_field = TRUE;
 449             RETURN NEXT output_row;
 450         END IF;
 451
 452     END LOOP;
 453
 454 END;
 455
 456 $func$ LANGUAGE PLPGSQL;
 457
 458 CREATE OR REPLACE FUNCTION metabib.reingest_metabib_field_entries( bib_id BIGINT ) RETURNS VOID AS $func$
 459 DECLARE
 460     fclass          RECORD;
 461     ind_data        metabib.field_entry_template%ROWTYPE;
 462     mbe_row         metabib.browse_entry%ROWTYPE;
 463     mbe_id          BIGINT;
 464 BEGIN
 465     PERFORM * FROM config.internal_flag WHERE name = 'ingest.assume_inserts_only' AND enabled;
 466     IF NOT FOUND THEN
 467         FOR fclass IN SELECT * FROM config.metabib_class LOOP
 468             -- RAISE NOTICE 'Emptying out %', fclass.name;
 469             EXECUTE $$DELETE FROM metabib.$$ || fclass.name || $$_field_entry WHERE source = $$ || bib_id;
 470         END LOOP;
 471         DELETE FROM metabib.facet_entry WHERE source = bib_id;
 472         DELETE FROM metabib.browse_entry_def_map WHERE source = bib_id;
 473     END IF;
 474
 475     FOR ind_data IN SELECT * FROM biblio.extract_metabib_field_entry( bib_id ) LOOP
 476         IF ind_data.field < 0 THEN
 477             ind_data.field = -1 * ind_data.field;
 478         END IF;
 479
 480         IF ind_data.facet_field THEN
 481             INSERT INTO metabib.facet_entry (field, source, value)
 482                 VALUES (ind_data.field, ind_data.source, ind_data.value);
 483         END IF;
 484
 485         IF ind_data.browse_field THEN
 486             -- A caveat about this SELECT: this should take care of replacing
 487             -- old mbe rows when data changes, but not if normalization (by
 488             -- which I mean specifically the output of
 489             -- evergreen.oils_tsearch2()) changes.  It may or may not be
 490             -- expensive to add a comparison of index_vector to index_vector
 491             -- to the WHERE clause below.
 492             SELECT INTO mbe_row * FROM metabib.browse_entry WHERE value = ind_data.value;
 493             IF FOUND THEN
 494                 mbe_id := mbe_row.id;
 495             ELSE
 496                 INSERT INTO metabib.browse_entry (value) VALUES
 497                     (metabib.browse_normalize(ind_data.value, ind_data.field));
 498                 mbe_id := CURRVAL('metabib.browse_entry_id_seq'::REGCLASS);
 499             END IF;
 500
 501             INSERT INTO metabib.browse_entry_def_map (entry, def, source)
 502                 VALUES (mbe_id, ind_data.field, ind_data.source);
 503         END IF;
 504
 505         IF ind_data.search_field THEN
 506             EXECUTE $$
 507                 INSERT INTO metabib.$$ || ind_data.field_class || $$_field_entry (field, source, value)
 508                     VALUES ($$ ||
 509                         quote_literal(ind_data.field) || $$, $$ ||
 510                         quote_literal(ind_data.source) || $$, $$ ||
 511                         quote_literal(ind_data.value) ||
 512                     $$);$$;
 513         END IF;
 514
 515     END LOOP;
 516
 517     RETURN;
 518 END;
 519 $func$ LANGUAGE PLPGSQL;
 520
 521 -- default to a space joiner
 522 CREATE OR REPLACE FUNCTION biblio.extract_metabib_field_entry ( BIGINT ) RETURNS SETOF metabib.field_entry_template AS $func$
 523         SELECT * FROM biblio.extract_metabib_field_entry($1, ' ');
 524 $func$ LANGUAGE SQL;
 525
 526 CREATE OR REPLACE FUNCTION authority.flatten_marc ( rid BIGINT ) RETURNS SETOF authority.full_rec AS $func$
 527 DECLARE
 528         auth    authority.record_entry%ROWTYPE;
 529         output  authority.full_rec%ROWTYPE;
 530         field   RECORD;
 531 BEGIN
 532         SELECT INTO auth * FROM authority.record_entry WHERE id = rid;
 533
 534         FOR field IN SELECT * FROM vandelay.flatten_marc( auth.marc ) LOOP
 535                 output.record := rid;
 536                 output.ind1 := field.ind1;
 537                 output.ind2 := field.ind2;
 538                 output.tag := field.tag;
 539                 output.subfield := field.subfield;
 540                 output.value := field.value;
 541
 542                 RETURN NEXT output;
 543         END LOOP;
 544 END;
 545 $func$ LANGUAGE PLPGSQL;
 546
 547 CREATE OR REPLACE FUNCTION biblio.flatten_marc ( rid BIGINT ) RETURNS SETOF metabib.full_rec AS $func$
 548 DECLARE
 549         bib     biblio.record_entry%ROWTYPE;
 550         output  metabib.full_rec%ROWTYPE;
 551         field   RECORD;
 552 BEGIN
 553         SELECT INTO bib * FROM biblio.record_entry WHERE id = rid;
 554
 555         FOR field IN SELECT * FROM vandelay.flatten_marc( bib.marc ) LOOP
 556                 output.record := rid;
 557                 output.ind1 := field.ind1;
 558                 output.ind2 := field.ind2;
 559                 output.tag := field.tag;
 560                 output.subfield := field.subfield;
 561                 output.value := field.value;
 562
 563                 RETURN NEXT output;
 564         END LOOP;
 565 END;
 566 $func$ LANGUAGE PLPGSQL;
 567
 568 CREATE OR REPLACE FUNCTION vandelay.marc21_record_type( marc TEXT ) RETURNS config.marc21_rec_type_map AS $func$
 569 DECLARE
 570         ldr         TEXT;
 571         tval        TEXT;
 572         tval_rec    RECORD;
 573         bval        TEXT;
 574         bval_rec    RECORD;
 575     retval      config.marc21_rec_type_map%ROWTYPE;
 576 BEGIN
 577     ldr := oils_xpath_string( '//*[local-name()="leader"]', marc );
 578
 579     IF ldr IS NULL OR ldr = '' THEN
 580         SELECT * INTO retval FROM config.marc21_rec_type_map WHERE code = 'BKS';
 581         RETURN retval;
 582     END IF;
 583
 584     SELECT * INTO tval_rec FROM config.marc21_ff_pos_map WHERE fixed_field = 'Type' LIMIT 1; -- They're all the same
 585     SELECT * INTO bval_rec FROM config.marc21_ff_pos_map WHERE fixed_field = 'BLvl' LIMIT 1; -- They're all the same
 586
 587
 588     tval := SUBSTRING( ldr, tval_rec.start_pos + 1, tval_rec.length );
 589     bval := SUBSTRING( ldr, bval_rec.start_pos + 1, bval_rec.length );
 590
 591     -- RAISE NOTICE 'type %, blvl %, ldr %', tval, bval, ldr;
 592
 593     SELECT * INTO retval FROM config.marc21_rec_type_map WHERE type_val LIKE '%' || tval || '%' AND blvl_val LIKE '%' || bval || '%';
 594
 595
 596     IF retval.code IS NULL THEN
 597         SELECT * INTO retval FROM config.marc21_rec_type_map WHERE code = 'BKS';
 598     END IF;
 599
 600     RETURN retval;
 601 END;
 602 $func$ LANGUAGE PLPGSQL;
 603
 604 CREATE OR REPLACE FUNCTION biblio.marc21_record_type( rid BIGINT ) RETURNS config.marc21_rec_type_map AS $func$
 605     SELECT * FROM vandelay.marc21_record_type( (SELECT marc FROM biblio.record_entry WHERE id = $1) );
 606 $func$ LANGUAGE SQL;
 607
 608 CREATE OR REPLACE FUNCTION vandelay.marc21_extract_fixed_field( marc TEXT, ff TEXT ) RETURNS TEXT AS $func$
 609 DECLARE
 610     rtype       TEXT;
 611     ff_pos      RECORD;
 612     tag_data    RECORD;
 613     val         TEXT;
 614 BEGIN
 615     rtype := (vandelay.marc21_record_type( marc )).code;
 616     FOR ff_pos IN SELECT * FROM config.marc21_ff_pos_map WHERE fixed_field = ff AND rec_type = rtype ORDER BY tag DESC LOOP
 617         IF ff_pos.tag = 'ldr' THEN
 618             val := oils_xpath_string('//*[local-name()="leader"]', marc);
 619             IF val IS NOT NULL THEN
 620                 val := SUBSTRING( val, ff_pos.start_pos + 1, ff_pos.length );
 621                 RETURN val;
 622             END IF;
 623         ELSE
 624             FOR tag_data IN SELECT value FROM UNNEST( oils_xpath( '//*[@tag="' || UPPER(ff_pos.tag) || '"]/text()', marc ) ) x(value) LOOP
 625                 val := SUBSTRING( tag_data.value, ff_pos.start_pos + 1, ff_pos.length );
 626                 RETURN val;
 627             END LOOP;
 628         END IF;
 629         val := REPEAT( ff_pos.default_val, ff_pos.length );
 630         RETURN val;
 631     END LOOP;
 632
 633     RETURN NULL;
 634 END;
 635 $func$ LANGUAGE PLPGSQL;
 636
 637 CREATE OR REPLACE FUNCTION biblio.marc21_extract_fixed_field( rid BIGINT, ff TEXT ) RETURNS TEXT AS $func$
 638     SELECT * FROM vandelay.marc21_extract_fixed_field( (SELECT marc FROM biblio.record_entry WHERE id = $1), $2 );
 639 $func$ LANGUAGE SQL;
 640
 641 -- CREATE TYPE biblio.record_ff_map AS (record BIGINT, ff_name TEXT, ff_value TEXT);
 642 CREATE OR REPLACE FUNCTION vandelay.marc21_extract_all_fixed_fields( marc TEXT ) RETURNS SETOF biblio.record_ff_map AS $func$
 643 DECLARE
 644     tag_data    TEXT;
 645     rtype       TEXT;
 646     ff_pos      RECORD;
 647     output      biblio.record_ff_map%ROWTYPE;
 648 BEGIN
 649     rtype := (vandelay.marc21_record_type( marc )).code;
 650
 651     FOR ff_pos IN SELECT * FROM config.marc21_ff_pos_map WHERE rec_type = rtype ORDER BY tag DESC LOOP
 652         output.ff_name  := ff_pos.fixed_field;
 653         output.ff_value := NULL;
 654
 655         IF ff_pos.tag = 'ldr' THEN
 656             output.ff_value := oils_xpath_string('//*[local-name()="leader"]', marc);
 657             IF output.ff_value IS NOT NULL THEN
 658                 output.ff_value := SUBSTRING( output.ff_value, ff_pos.start_pos + 1, ff_pos.length );
 659                 RETURN NEXT output;
 660                 output.ff_value := NULL;
 661             END IF;
 662         ELSE
 663             FOR tag_data IN SELECT value FROM UNNEST( oils_xpath( '//*[@tag="' || UPPER(ff_pos.tag) || '"]/text()', marc ) ) x(value) LOOP
 664                 output.ff_value := SUBSTRING( tag_data, ff_pos.start_pos + 1, ff_pos.length );
 665                 IF output.ff_value IS NULL THEN output.ff_value := REPEAT( ff_pos.default_val, ff_pos.length ); END IF;
 666                 RETURN NEXT output;
 667                 output.ff_value := NULL;
 668             END LOOP;
 669         END IF;
 670
 671     END LOOP;
 672
 673     RETURN;
 674 END;
 675 $func$ LANGUAGE PLPGSQL;
 676
 677 CREATE OR REPLACE FUNCTION biblio.marc21_extract_all_fixed_fields( rid BIGINT ) RETURNS SETOF biblio.record_ff_map AS $func$
 678     SELECT $1 AS record, ff_name, ff_value FROM vandelay.marc21_extract_all_fixed_fields( (SELECT marc FROM biblio.record_entry WHERE id = $1) );
 679 $func$ LANGUAGE SQL;
 680
 681 CREATE OR REPLACE FUNCTION biblio.marc21_physical_characteristics( rid BIGINT ) RETURNS SETOF biblio.marc21_physical_characteristics AS $func$
 682     SELECT id, $1 AS record, ptype, subfield, value FROM vandelay.marc21_physical_characteristics( (SELECT marc FROM biblio.record_entry WHERE id = $1) );
 683 $func$ LANGUAGE SQL;
 684
 685 CREATE OR REPLACE FUNCTION biblio.extract_quality ( marc TEXT, best_lang TEXT, best_type TEXT ) RETURNS INT AS $func$
 686 DECLARE
 687     qual        INT;
 688     ldr         TEXT;
 689     tval        TEXT;
 690     tval_rec    RECORD;
 691     bval        TEXT;
 692     bval_rec    RECORD;
 693     type_map    RECORD;
 694     ff_pos      RECORD;
 695     ff_tag_data TEXT;
 696 BEGIN
 697
 698     IF marc IS NULL OR marc = '' THEN
 699         RETURN NULL;
 700     END IF;
 701
 702     -- First, the count of tags
 703     qual := ARRAY_UPPER(oils_xpath('*[local-name()="datafield"]', marc), 1);
 704
 705     -- now go through a bunch of pain to get the record type
 706     IF best_type IS NOT NULL THEN
 707         ldr := (oils_xpath('//*[local-name()="leader"]/text()', marc))[1];
 708
 709         IF ldr IS NOT NULL THEN
 710             SELECT * INTO tval_rec FROM config.marc21_ff_pos_map WHERE fixed_field = 'Type' LIMIT 1; -- They're all the same
 711             SELECT * INTO bval_rec FROM config.marc21_ff_pos_map WHERE fixed_field = 'BLvl' LIMIT 1; -- They're all the same
 712
 713
 714             tval := SUBSTRING( ldr, tval_rec.start_pos + 1, tval_rec.length );
 715             bval := SUBSTRING( ldr, bval_rec.start_pos + 1, bval_rec.length );
 716
 717             -- RAISE NOTICE 'type %, blvl %, ldr %', tval, bval, ldr;
 718
 719             SELECT * INTO type_map FROM config.marc21_rec_type_map WHERE type_val LIKE '%' || tval || '%' AND blvl_val LIKE '%' || bval || '%';
 720
 721             IF type_map.code IS NOT NULL THEN
 722                 IF best_type = type_map.code THEN
 723                     qual := qual + qual / 2;
 724                 END IF;
 725
 726                 FOR ff_pos IN SELECT * FROM config.marc21_ff_pos_map WHERE fixed_field = 'Lang' AND rec_type = type_map.code ORDER BY tag DESC LOOP
 727                     ff_tag_data := SUBSTRING((oils_xpath('//*[@tag="' || ff_pos.tag || '"]/text()',marc))[1], ff_pos.start_pos + 1, ff_pos.length);
 728                     IF ff_tag_data = best_lang THEN
 729                             qual := qual + 100;
 730                     END IF;
 731                 END LOOP;
 732             END IF;
 733         END IF;
 734     END IF;
 735
 736     -- Now look for some quality metrics
 737     -- DCL record?
 738     IF ARRAY_UPPER(oils_xpath('//*[@tag="040"]/*[@code="a" and contains(.,"DLC")]', marc), 1) = 1 THEN
 739         qual := qual + 10;
 740     END IF;
 741
 742     -- From OCLC?
 743     IF (oils_xpath('//*[@tag="003"]/text()', marc))[1] ~* E'oclo?c' THEN
 744         qual := qual + 10;
 745     END IF;
 746
 747     RETURN qual;
 748
 749 END;
 750 $func$ LANGUAGE PLPGSQL;
 751
 752 CREATE OR REPLACE FUNCTION biblio.extract_fingerprint ( marc text ) RETURNS TEXT AS $func$
 753 DECLARE
 754         idx             config.biblio_fingerprint%ROWTYPE;
 755         xfrm            config.xml_transform%ROWTYPE;
 756         prev_xfrm       TEXT;
 757         transformed_xml TEXT;
 758         xml_node        TEXT;
 759         xml_node_list   TEXT[];
 760         raw_text        TEXT;
 761     output_text TEXT := '';
 762 BEGIN
 763
 764     IF marc IS NULL OR marc = '' THEN
 765         RETURN NULL;
 766     END IF;
 767
 768         -- Loop over the indexing entries
 769         FOR idx IN SELECT * FROM config.biblio_fingerprint ORDER BY format, id LOOP
 770
 771                 SELECT INTO xfrm * from config.xml_transform WHERE name = idx.format;
 772
 773                 -- See if we can skip the XSLT ... it's expensive
 774                 IF prev_xfrm IS NULL OR prev_xfrm <> xfrm.name THEN
 775                         -- Can't skip the transform
 776                         IF xfrm.xslt <> '---' THEN
 777                                 transformed_xml := oils_xslt_process(marc,xfrm.xslt);
 778                         ELSE
 779                                 transformed_xml := marc;
 780                         END IF;
 781
 782                         prev_xfrm := xfrm.name;
 783                 END IF;
 784
 785                 raw_text := COALESCE(
 786             naco_normalize(
 787                 ARRAY_TO_STRING(
 788                     oils_xpath(
 789                         '//text()',
 790                         (oils_xpath(
 791                             idx.xpath,
 792                             transformed_xml,
 793                             ARRAY[ARRAY[xfrm.prefix, xfrm.namespace_uri]]
 794                         ))[1]
 795                     ),
 796                     ''
 797                 )
 798             ),
 799             ''
 800         );
 801
 802         raw_text := REGEXP_REPLACE(raw_text, E'\\[.+?\\]', E'');
 803         raw_text := REGEXP_REPLACE(raw_text, E'\\mthe\\M|\\man?d?d\\M', E'', 'g'); -- arg! the pain!
 804
 805         IF idx.first_word IS TRUE THEN
 806             raw_text := REGEXP_REPLACE(raw_text, E'^(\\w+).*?$', E'\\1');
 807         END IF;
 808
 809                 output_text := output_text || REGEXP_REPLACE(raw_text, E'\\s+', '', 'g');
 810
 811         END LOOP;
 812
 813     RETURN output_text;
 814
 815 END;
 816 $func$ LANGUAGE PLPGSQL;
 817
 818 -- BEFORE UPDATE OR INSERT trigger for biblio.record_entry
 819 CREATE OR REPLACE FUNCTION biblio.fingerprint_trigger () RETURNS TRIGGER AS $func$
 820 BEGIN
 821
 822     -- For TG_ARGV, first param is language (like 'eng'), second is record type (like 'BKS')
 823
 824     IF NEW.deleted IS TRUE THEN -- we don't much care, then, do we?
 825         RETURN NEW;
 826     END IF;
 827
 828     NEW.fingerprint := biblio.extract_fingerprint(NEW.marc);
 829     NEW.quality := biblio.extract_quality(NEW.marc, TG_ARGV[0], TG_ARGV[1]);
 830
 831     RETURN NEW;
 832
 833 END;
 834 $func$ LANGUAGE PLPGSQL;
 835
 836 CREATE OR REPLACE FUNCTION metabib.reingest_metabib_full_rec( bib_id BIGINT ) RETURNS VOID AS $func$
 837 BEGIN
 838     PERFORM * FROM config.internal_flag WHERE name = 'ingest.assume_inserts_only' AND enabled;
 839     IF NOT FOUND THEN
 840         DELETE FROM metabib.real_full_rec WHERE record = bib_id;
 841     END IF;
 842     INSERT INTO metabib.real_full_rec (record, tag, ind1, ind2, subfield, value)
 843         SELECT record, tag, ind1, ind2, subfield, value FROM biblio.flatten_marc( bib_id );
 844
 845     RETURN;
 846 END;
 847 $func$ LANGUAGE PLPGSQL;
 848
 849 CREATE OR REPLACE FUNCTION biblio.extract_located_uris( bib_id BIGINT, marcxml TEXT, editor_id INT ) RETURNS VOID AS $func$
 850 DECLARE
 851     uris            TEXT[];
 852     uri_xml         TEXT;
 853     uri_label       TEXT;
 854     uri_href        TEXT;
 855     uri_use         TEXT;
 856     uri_owner_list  TEXT[];
 857     uri_owner       TEXT;
 858     uri_owner_id    INT;
 859     uri_id          INT;
 860     uri_cn_id       INT;
 861     uri_map_id      INT;
 862 BEGIN
 863
 864     -- Clear any URI mappings and call numbers for this bib.
 865     -- This leads to acn / auricnm inflation, but also enables
 866     -- old acn/auricnm's to go away and for bibs to be deleted.
 867     FOR uri_cn_id IN SELECT id FROM asset.call_number WHERE record = bib_id AND label = '##URI##' AND NOT deleted LOOP
 868         DELETE FROM asset.uri_call_number_map WHERE call_number = uri_cn_id;
 869         DELETE FROM asset.call_number WHERE id = uri_cn_id;
 870     END LOOP;
 871
 872     uris := oils_xpath('//*[@tag="856" and (@ind1="4" or @ind1="1") and (@ind2="0" or @ind2="1")]',marcxml);
 873     IF ARRAY_UPPER(uris,1) > 0 THEN
 874         FOR i IN 1 .. ARRAY_UPPER(uris, 1) LOOP
 875             -- First we pull info out of the 856
 876             uri_xml     := uris[i];
 877
 878             uri_href    := (oils_xpath('//*[@code="u"]/text()',uri_xml))[1];
 879             uri_label   := (oils_xpath('//*[@code="y"]/text()|//*[@code="3"]/text()',uri_xml))[1];
 880             uri_use     := (oils_xpath('//*[@code="z"]/text()|//*[@code="2"]/text()|//*[@code="n"]/text()',uri_xml))[1];
 881
 882             IF uri_label IS NULL THEN
 883                 uri_label := uri_href;
 884             END IF;
 885             CONTINUE WHEN uri_href IS NULL;
 886
 887             -- Get the distinct list of libraries wanting to use
 888             SELECT  ARRAY_ACCUM(
 889                         DISTINCT REGEXP_REPLACE(
 890                             x,
 891                             $re$^.*?\((\w+)\).*$$re$,
 892                             E'\\1'
 893                         )
 894                     ) INTO uri_owner_list
 895               FROM  UNNEST(
 896                         oils_xpath(
 897                             '//*[@code="9"]/text()|//*[@code="w"]/text()|//*[@code="n"]/text()',
 898                             uri_xml
 899                         )
 900                     )x;
 901
 902             IF ARRAY_UPPER(uri_owner_list,1) > 0 THEN
 903
 904                 -- look for a matching uri
 905                 IF uri_use IS NULL THEN
 906                     SELECT id INTO uri_id
 907                         FROM asset.uri
 908                         WHERE label = uri_label AND href = uri_href AND use_restriction IS NULL AND active
 909                         ORDER BY id LIMIT 1;
 910                     IF NOT FOUND THEN -- create one
 911                         INSERT INTO asset.uri (label, href, use_restriction) VALUES (uri_label, uri_href, uri_use);
 912                         SELECT id INTO uri_id
 913                             FROM asset.uri
 914                             WHERE label = uri_label AND href = uri_href AND use_restriction IS NULL AND active;
 915                     END IF;
 916                 ELSE
 917                     SELECT id INTO uri_id
 918                         FROM asset.uri
 919                         WHERE label = uri_label AND href = uri_href AND use_restriction = uri_use AND active
 920                         ORDER BY id LIMIT 1;
 921                     IF NOT FOUND THEN -- create one
 922                         INSERT INTO asset.uri (label, href, use_restriction) VALUES (uri_label, uri_href, uri_use);
 923                         SELECT id INTO uri_id
 924                             FROM asset.uri
 925                             WHERE label = uri_label AND href = uri_href AND use_restriction = uri_use AND active;
 926                     END IF;
 927                 END IF;
 928
 929                 FOR j IN 1 .. ARRAY_UPPER(uri_owner_list, 1) LOOP
 930                     uri_owner := uri_owner_list[j];
 931
 932                     SELECT id INTO uri_owner_id FROM actor.org_unit WHERE shortname = uri_owner;
 933                     CONTINUE WHEN NOT FOUND;
 934
 935                     -- we need a call number to link through
 936                     SELECT id INTO uri_cn_id FROM asset.call_number WHERE owning_lib = uri_owner_id AND record = bib_id AND label = '##URI##' AND NOT deleted;
 937                     IF NOT FOUND THEN
 938                         INSERT INTO asset.call_number (owning_lib, record, create_date, edit_date, creator, editor, label)
 939                             VALUES (uri_owner_id, bib_id, 'now', 'now', editor_id, editor_id, '##URI##');
 940                         SELECT id INTO uri_cn_id FROM asset.call_number WHERE owning_lib = uri_owner_id AND record = bib_id AND label = '##URI##' AND NOT deleted;
 941                     END IF;
 942
 943                     -- now, link them if they're not already
 944                     SELECT id INTO uri_map_id FROM asset.uri_call_number_map WHERE call_number = uri_cn_id AND uri = uri_id;
 945                     IF NOT FOUND THEN
 946                         INSERT INTO asset.uri_call_number_map (call_number, uri) VALUES (uri_cn_id, uri_id);
 947                     END IF;
 948
 949                 END LOOP;
 950
 951             END IF;
 952
 953         END LOOP;
 954     END IF;
 955
 956     RETURN;
 957 END;
 958 $func$ LANGUAGE PLPGSQL;
 959
 960 CREATE OR REPLACE FUNCTION metabib.remap_metarecord_for_bib( bib_id BIGINT, fp TEXT ) RETURNS BIGINT AS $func$
 961 DECLARE
 962     source_count    INT;
 963     old_mr          BIGINT;
 964     tmp_mr          metabib.metarecord%ROWTYPE;
 965     deleted_mrs     BIGINT[];
 966 BEGIN
 967
 968     DELETE FROM metabib.metarecord_source_map WHERE source = bib_id; -- Rid ourselves of the search-estimate-killing linkage
 969
 970     FOR tmp_mr IN SELECT  m.* FROM  metabib.metarecord m JOIN metabib.metarecord_source_map s ON (s.metarecord = m.id) WHERE s.source = bib_id LOOP
 971
 972         IF old_mr IS NULL AND fp = tmp_mr.fingerprint THEN -- Find the first fingerprint-matching
 973             old_mr := tmp_mr.id;
 974         ELSE
 975             SELECT COUNT(*) INTO source_count FROM metabib.metarecord_source_map WHERE metarecord = tmp_mr.id;
 976             IF source_count = 0 THEN -- No other records
 977                 deleted_mrs := ARRAY_APPEND(deleted_mrs, tmp_mr.id);
 978                 DELETE FROM metabib.metarecord WHERE id = tmp_mr.id;
 979             END IF;
 980         END IF;
 981
 982     END LOOP;
 983
 984     IF old_mr IS NULL THEN -- we found no suitable, preexisting MR based on old source maps
 985         SELECT id INTO old_mr FROM metabib.metarecord WHERE fingerprint = fp; -- is there one for our current fingerprint?
 986         IF old_mr IS NULL THEN -- nope, create one and grab its id
 987             INSERT INTO metabib.metarecord ( fingerprint, master_record ) VALUES ( fp, bib_id );
 988             SELECT id INTO old_mr FROM metabib.metarecord WHERE fingerprint = fp;
 989         ELSE -- indeed there is. update it with a null cache and recalcualated master record
 990             UPDATE  metabib.metarecord
 991               SET   mods = NULL,
 992                     master_record = ( SELECT id FROM biblio.record_entry WHERE fingerprint = fp ORDER BY quality DESC LIMIT 1)
 993               WHERE id = old_mr;
 994         END IF;
 995     ELSE -- there was one we already attached to, update its mods cache and master_record
 996         UPDATE  metabib.metarecord
 997           SET   mods = NULL,
 998                 master_record = ( SELECT id FROM biblio.record_entry WHERE fingerprint = fp ORDER BY quality DESC LIMIT 1)
 999           WHERE id = old_mr;
1000     END IF;
1001
1002     INSERT INTO metabib.metarecord_source_map (metarecord, source) VALUES (old_mr, bib_id); -- new source mapping
1003
1004     IF ARRAY_UPPER(deleted_mrs,1) > 0 THEN
1005         UPDATE action.hold_request SET target = old_mr WHERE target IN ( SELECT unnest(deleted_mrs) ) AND hold_type = 'M'; -- if we had to delete any MRs above, make sure their holds are moved
1006     END IF;
1007
1008     RETURN old_mr;
1009
1010 END;
1011 $func$ LANGUAGE PLPGSQL;
1012
1013 CREATE OR REPLACE FUNCTION biblio.map_authority_linking (bibid BIGINT, marc TEXT) RETURNS BIGINT AS $func$
1014     DELETE FROM authority.bib_linking WHERE bib = $1;
1015     INSERT INTO authority.bib_linking (bib, authority)
1016         SELECT  y.bib,
1017                 y.authority
1018           FROM (    SELECT  DISTINCT $1 AS bib,
1019                             BTRIM(remove_paren_substring(txt))::BIGINT AS authority
1020                       FROM  unnest(oils_xpath('//*[@code="0"]/text()',$2)) x(txt)
1021                       WHERE BTRIM(remove_paren_substring(txt)) ~ $re$^\d+$$re$
1022                 ) y JOIN authority.record_entry r ON r.id = y.authority;
1023     SELECT $1;
1024 $func$ LANGUAGE SQL;
1025
1026 -- AFTER UPDATE OR INSERT trigger for biblio.record_entry
1027 CREATE OR REPLACE FUNCTION biblio.indexing_ingest_or_delete () RETURNS TRIGGER AS $func$
1028 DECLARE
1029     transformed_xml TEXT;
1030     prev_xfrm       TEXT;
1031     normalizer      RECORD;
1032     xfrm            config.xml_transform%ROWTYPE;
1033     attr_value      TEXT;
1034     new_attrs       HSTORE := ''::HSTORE;
1035     attr_def        config.record_attr_definition%ROWTYPE;
1036 BEGIN
1037
1038     IF NEW.deleted IS TRUE THEN -- If this bib is deleted
1039         DELETE FROM metabib.metarecord_source_map WHERE source = NEW.id; -- Rid ourselves of the search-estimate-killing linkage
1040         DELETE FROM metabib.record_attr WHERE id = NEW.id; -- Kill the attrs hash, useless on deleted records
1041         DELETE FROM authority.bib_linking WHERE bib = NEW.id; -- Avoid updating fields in bibs that are no longer visible
1042         DELETE FROM biblio.peer_bib_copy_map WHERE peer_record = NEW.id; -- Separate any multi-homed items
1043         DELETE FROM metabib.browse_entry_def_map WHERE source = NEW.id; -- Don't auto-suggest deleted bibs
1044         RETURN NEW; -- and we're done
1045     END IF;
1046
1047     IF TG_OP = 'UPDATE' THEN -- re-ingest?
1048         PERFORM * FROM config.internal_flag WHERE name = 'ingest.reingest.force_on_same_marc' AND enabled;
1049
1050         IF NOT FOUND AND OLD.marc = NEW.marc THEN -- don't do anything if the MARC didn't change
1051             RETURN NEW;
1052         END IF;
1053     END IF;
1054
1055     -- Record authority linking
1056     PERFORM * FROM config.internal_flag WHERE name = 'ingest.disable_authority_linking' AND enabled;
1057     IF NOT FOUND THEN
1058         PERFORM biblio.map_authority_linking( NEW.id, NEW.marc );
1059     END IF;
1060
1061     -- Flatten and insert the mfr data
1062     PERFORM * FROM config.internal_flag WHERE name = 'ingest.disable_metabib_full_rec' AND enabled;
1063     IF NOT FOUND THEN
1064         PERFORM metabib.reingest_metabib_full_rec(NEW.id);
1065
1066         -- Now we pull out attribute data, which is dependent on the mfr for all but XPath-based fields
1067         PERFORM * FROM config.internal_flag WHERE name = 'ingest.disable_metabib_rec_descriptor' AND enabled;
1068         IF NOT FOUND THEN
1069             FOR attr_def IN SELECT * FROM config.record_attr_definition ORDER BY format LOOP
1070
1071                 IF attr_def.tag IS NOT NULL THEN -- tag (and optional subfield list) selection
1072                     SELECT  ARRAY_TO_STRING(ARRAY_ACCUM(value), COALESCE(attr_def.joiner,' ')) INTO attr_value
1073                       FROM  (SELECT * FROM metabib.full_rec ORDER BY tag, subfield) AS x
1074                       WHERE record = NEW.id
1075                             AND tag LIKE attr_def.tag
1076                             AND CASE
1077                                 WHEN attr_def.sf_list IS NOT NULL
1078                                     THEN POSITION(subfield IN attr_def.sf_list) > 0
1079                                 ELSE TRUE
1080                                 END
1081                       GROUP BY tag
1082                       ORDER BY tag
1083                       LIMIT 1;
1084
1085                 ELSIF attr_def.fixed_field IS NOT NULL THEN -- a named fixed field, see config.marc21_ff_pos_map.fixed_field
1086                     attr_value := biblio.marc21_extract_fixed_field(NEW.id, attr_def.fixed_field);
1087
1088                 ELSIF attr_def.xpath IS NOT NULL THEN -- and xpath expression
1089
1090                     SELECT INTO xfrm * FROM config.xml_transform WHERE name = attr_def.format;
1091
1092                     -- See if we can skip the XSLT ... it's expensive
1093                     IF prev_xfrm IS NULL OR prev_xfrm <> xfrm.name THEN
1094                         -- Can't skip the transform
1095                         IF xfrm.xslt <> '---' THEN
1096                             transformed_xml := oils_xslt_process(NEW.marc,xfrm.xslt);
1097                         ELSE
1098                             transformed_xml := NEW.marc;
1099                         END IF;
1100
1101                         prev_xfrm := xfrm.name;
1102                     END IF;
1103
1104                     IF xfrm.name IS NULL THEN
1105                         -- just grab the marcxml (empty) transform
1106                         SELECT INTO xfrm * FROM config.xml_transform WHERE xslt = '---' LIMIT 1;
1107                         prev_xfrm := xfrm.name;
1108                     END IF;
1109
1110                     attr_value := oils_xpath_string(attr_def.xpath, transformed_xml, COALESCE(attr_def.joiner,' '), ARRAY[ARRAY[xfrm.prefix, xfrm.namespace_uri]]);
1111
1112                 ELSIF attr_def.phys_char_sf IS NOT NULL THEN -- a named Physical Characteristic, see config.marc21_physical_characteristic_*_map
1113                     SELECT  m.value INTO attr_value
1114                       FROM  biblio.marc21_physical_characteristics(NEW.id) v
1115                             JOIN config.marc21_physical_characteristic_value_map m ON (m.id = v.value)
1116                       WHERE v.subfield = attr_def.phys_char_sf
1117                       LIMIT 1; -- Just in case ...
1118
1119                 END IF;
1120
1121                 -- apply index normalizers to attr_value
1122                 FOR normalizer IN
1123                     SELECT  n.func AS func,
1124                             n.param_count AS param_count,
1125                             m.params AS params
1126                       FROM  config.index_normalizer n
1127                             JOIN config.record_attr_index_norm_map m ON (m.norm = n.id)
1128                       WHERE attr = attr_def.name
1129                       ORDER BY m.pos LOOP
1130                         EXECUTE 'SELECT ' || normalizer.func || '(' ||
1131                             COALESCE( quote_literal( attr_value ), 'NULL' ) ||
1132                             CASE
1133                                 WHEN normalizer.param_count > 0
1134                                     THEN ',' || REPLACE(REPLACE(BTRIM(normalizer.params,'[]'),E'\'',E'\\\''),E'"',E'\'')
1135                                     ELSE ''
1136                                 END ||
1137                             ')' INTO attr_value;
1138
1139                 END LOOP;
1140
1141                 -- Add the new value to the hstore
1142                 new_attrs := new_attrs || hstore( attr_def.name, attr_value );
1143
1144             END LOOP;
1145
1146             IF TG_OP = 'INSERT' OR OLD.deleted THEN -- initial insert OR revivication
1147                 INSERT INTO metabib.record_attr (id, attrs) VALUES (NEW.id, new_attrs);
1148             ELSE
1149                 UPDATE metabib.record_attr SET attrs = new_attrs WHERE id = NEW.id;
1150             END IF;
1151
1152         END IF;
1153     END IF;
1154
1155     -- Gather and insert the field entry data
1156     PERFORM metabib.reingest_metabib_field_entries(NEW.id);
1157
1158     -- Located URI magic
1159     IF TG_OP = 'INSERT' THEN
1160         PERFORM * FROM config.internal_flag WHERE name = 'ingest.disable_located_uri' AND enabled;
1161         IF NOT FOUND THEN
1162             PERFORM biblio.extract_located_uris( NEW.id, NEW.marc, NEW.editor );
1163         END IF;
1164     ELSE
1165         PERFORM * FROM config.internal_flag WHERE name = 'ingest.disable_located_uri' AND enabled;
1166         IF NOT FOUND THEN
1167             PERFORM biblio.extract_located_uris( NEW.id, NEW.marc, NEW.editor );
1168         END IF;
1169     END IF;
1170
1171     -- (re)map metarecord-bib linking
1172     IF TG_OP = 'INSERT' THEN -- if not deleted and performing an insert, check for the flag
1173         PERFORM * FROM config.internal_flag WHERE name = 'ingest.metarecord_mapping.skip_on_insert' AND enabled;
1174         IF NOT FOUND THEN
1175             PERFORM metabib.remap_metarecord_for_bib( NEW.id, NEW.fingerprint );
1176         END IF;
1177     ELSE -- we're doing an update, and we're not deleted, remap
1178         PERFORM * FROM config.internal_flag WHERE name = 'ingest.metarecord_mapping.skip_on_update' AND enabled;
1179         IF NOT FOUND THEN
1180             PERFORM metabib.remap_metarecord_for_bib( NEW.id, NEW.fingerprint );
1181         END IF;
1182     END IF;
1183
1184     RETURN NEW;
1185 END;
1186 $func$ LANGUAGE PLPGSQL;
1187
1188 CREATE OR REPLACE FUNCTION metabib.browse_normalize(facet_text TEXT, mapped_field INT) RETURNS TEXT AS $$
1189 DECLARE
1190     normalizer  RECORD;
1191 BEGIN
1192
1193     FOR normalizer IN
1194         SELECT  n.func AS func,
1195                 n.param_count AS param_count,
1196                 m.params AS params
1197           FROM  config.index_normalizer n
1198                 JOIN config.metabib_field_index_norm_map m ON (m.norm = n.id)
1199           WHERE m.field = mapped_field AND m.pos < 0
1200           ORDER BY m.pos LOOP
1201
1202             EXECUTE 'SELECT ' || normalizer.func || '(' ||
1203                 quote_literal( facet_text ) ||
1204                 CASE
1205                     WHEN normalizer.param_count > 0
1206                         THEN ',' || REPLACE(REPLACE(BTRIM(normalizer.params,'[]'),E'\'',E'\\\''),E'"',E'\'')
1207                         ELSE ''
1208                     END ||
1209                 ')' INTO facet_text;
1210
1211     END LOOP;
1212
1213     RETURN facet_text;
1214 END;
1215
1216 $$ LANGUAGE PLPGSQL;
1217
1218
1219 -- This mimics a specific part of QueryParser, turning the first part of a
1220 -- classed search (search_class) into a set of classes and possibly fields.
1221 -- search_class might look like "author" or "title|proper" or "ti|uniform"
1222 -- or "au" or "au|corporate|personal" or anything like that, where the first
1223 -- element of the list you get by separating on the "|" character is either
1224 -- a registered class (config.metabib_class) or an alias
1225 -- (config.metabib_search_alias), and the rest of any such elements are
1226 -- fields (config.metabib_field).
1227 CREATE OR REPLACE
1228     FUNCTION metabib.search_class_to_registered_components(search_class TEXT)
1229     RETURNS SETOF RECORD AS $func$
1230 DECLARE
1231     search_parts        TEXT[];
1232     field_name          TEXT;
1233     search_part_count   INTEGER;
1234     rec                 RECORD;
1235     registered_class    config.metabib_class%ROWTYPE;
1236     registered_alias    config.metabib_search_alias%ROWTYPE;
1237     registered_field    config.metabib_field%ROWTYPE;
1238 BEGIN
1239     search_parts := REGEXP_SPLIT_TO_ARRAY(search_class, E'\\|');
1240
1241     search_part_count := ARRAY_LENGTH(search_parts, 1);
1242     IF search_part_count = 0 THEN
1243         RETURN;
1244     ELSE
1245         SELECT INTO registered_class
1246             * FROM config.metabib_class WHERE name = search_parts[1];
1247         IF FOUND THEN
1248             IF search_part_count < 2 THEN   -- all fields
1249                 rec := (registered_class.name, NULL::INTEGER);
1250                 RETURN NEXT rec;
1251                 RETURN; -- done
1252             END IF;
1253             FOR field_name IN SELECT *
1254                 FROM UNNEST(search_parts[2:search_part_count]) LOOP
1255                 SELECT INTO registered_field
1256                     * FROM config.metabib_field
1257                     WHERE name = field_name AND
1258                         field_class = registered_class.name;
1259                 IF FOUND THEN
1260                     rec := (registered_class.name, registered_field.id);
1261                     RETURN NEXT rec;
1262                 END IF;
1263             END LOOP;
1264         ELSE
1265             -- maybe we have an alias?
1266             SELECT INTO registered_alias
1267                 * FROM config.metabib_search_alias WHERE alias=search_parts[1];
1268             IF NOT FOUND THEN
1269                 RETURN;
1270             ELSE
1271                 IF search_part_count < 2 THEN   -- return w/e the alias says
1272                     rec := (
1273                         registered_alias.field_class, registered_alias.field
1274                     );
1275                     RETURN NEXT rec;
1276                     RETURN; -- done
1277                 ELSE
1278                     FOR field_name IN SELECT *
1279                         FROM UNNEST(search_parts[2:search_part_count]) LOOP
1280                         SELECT INTO registered_field
1281                             * FROM config.metabib_field
1282                             WHERE name = field_name AND
1283                                 field_class = registered_alias.field_class;
1284                         IF FOUND THEN
1285                             rec := (
1286                                 registered_alias.field_class,
1287                                 registered_field.id
1288                             );
1289                             RETURN NEXT rec;
1290                         END IF;
1291                     END LOOP;
1292                 END IF;
1293             END IF;
1294         END IF;
1295     END IF;
1296 END;
1297 $func$ LANGUAGE PLPGSQL;
1298
1299
1300 -- Given a string such as a user might type into a search box, prepare
1301 -- two changed variants for TO_TSQUERY(). See
1302 -- http://www.postgresql.org/docs/9.0/static/textsearch-controls.html
1303 -- The first variant is normalized to match indexed documents regardless
1304 -- of diacritics.  The second variant keeps its diacritics for proper
1305 -- highlighting via TS_HEADLINE().
1306 CREATE OR REPLACE
1307     FUNCTION metabib.autosuggest_prepare_tsquery(orig TEXT) RETURNS TEXT[] AS
1308 $$
1309 DECLARE
1310     orig_ended_in_space     BOOLEAN;
1311     result                  RECORD;
1312     plain                   TEXT;
1313     normalized              TEXT;
1314 BEGIN
1315     orig_ended_in_space := orig ~ E'\\s$';
1316
1317     orig := ARRAY_TO_STRING(
1318         evergreen.regexp_split_to_array(orig, E'\\W+'), ' '
1319     );
1320
1321     normalized := public.search_normalize(orig); -- also trim()s
1322     plain := trim(orig);
1323
1324     IF NOT orig_ended_in_space THEN
1325         plain := plain || ':*';
1326         normalized := normalized || ':*';
1327     END IF;
1328
1329     plain := ARRAY_TO_STRING(
1330         evergreen.regexp_split_to_array(plain, E'\\s+'), ' & '
1331     );
1332     normalized := ARRAY_TO_STRING(
1333         evergreen.regexp_split_to_array(normalized, E'\\s+'), ' & '
1334     );
1335
1336     RETURN ARRAY[normalized, plain];
1337 END;
1338 $$ LANGUAGE PLPGSQL;
1339
1340
1341 CREATE OR REPLACE
1342     FUNCTION metabib.suggest_browse_entries(
1343         raw_query_text  TEXT,   -- actually typed by humans at the UI level
1344         search_class    TEXT,   -- 'alias' or 'class' or 'class|field..', etc
1345         headline_opts   TEXT,   -- markup options for ts_headline()
1346         visibility_org  INTEGER,-- null if you don't want opac visibility test
1347         query_limit     INTEGER,-- use in LIMIT clause of interal query
1348         normalization   INTEGER -- argument to TS_RANK_CD()
1349     ) RETURNS TABLE (
1350         value                   TEXT,   -- plain
1351         field                   INTEGER,
1352         bouyant_and_class_match BOOL,
1353         field_match             BOOL,
1354         field_weight            INTEGER,
1355         rank                    REAL,
1356         bouyant                 BOOL,
1357         match                   TEXT    -- marked up
1358     ) AS $func$
1359 DECLARE
1360     prepared_query_texts    TEXT[];
1361     query                   TSQUERY;
1362     plain_query             TSQUERY;
1363     opac_visibility_join    TEXT;
1364     search_class_join       TEXT;
1365     r_fields                RECORD;
1366 BEGIN
1367     prepared_query_texts := metabib.autosuggest_prepare_tsquery(raw_query_text);
1368
1369     query := TO_TSQUERY('keyword', prepared_query_texts[1]);
1370     plain_query := TO_TSQUERY('keyword', prepared_query_texts[2]);
1371
1372     IF visibility_org IS NOT NULL THEN
1373         opac_visibility_join := '
1374     JOIN asset.opac_visible_copies aovc ON (
1375         aovc.record = mbedm.source AND
1376         aovc.circ_lib IN (SELECT id FROM actor.org_unit_descendants($4))
1377     )';
1378     ELSE
1379         opac_visibility_join := '';
1380     END IF;
1381
1382     -- The following determines whether we only provide suggestsons matching
1383     -- the user's selected search_class, or whether we show other suggestions
1384     -- too. The reason for MIN() is that for search_classes like
1385     -- 'title|proper|uniform' you would otherwise get multiple rows.  The
1386     -- implication is that if title as a class doesn't have restrict,
1387     -- nor does the proper field, but the uniform field does, you're going
1388     -- to get 'false' for your overall evaluation of 'should we restrict?'
1389     -- To invert that, change from MIN() to MAX().
1390
1391     SELECT
1392         INTO r_fields
1393             MIN(cmc.restrict::INT) AS restrict_class,
1394             MIN(cmf.restrict::INT) AS restrict_field
1395         FROM metabib.search_class_to_registered_components(search_class)
1396             AS _registered (field_class TEXT, field INT)
1397         JOIN
1398             config.metabib_class cmc ON (cmc.name = _registered.field_class)
1399         LEFT JOIN
1400             config.metabib_field cmf ON (cmf.id = _registered.field);
1401
1402     -- evaluate 'should we restrict?'
1403     IF r_fields.restrict_field::BOOL OR r_fields.restrict_class::BOOL THEN
1404         search_class_join := '
1405     JOIN
1406         metabib.search_class_to_registered_components($2)
1407         AS _registered (field_class TEXT, field INT) ON (
1408             (_registered.field IS NULL AND
1409                 _registered.field_class = cmf.field_class) OR
1410             (_registered.field = cmf.id)
1411         )
1412     ';
1413     ELSE
1414         search_class_join := '
1415     LEFT JOIN
1416         metabib.search_class_to_registered_components($2)
1417         AS _registered (field_class TEXT, field INT) ON (
1418             _registered.field_class = cmc.name
1419         )
1420     ';
1421     END IF;
1422
1423     RETURN QUERY EXECUTE 'SELECT *, TS_HEADLINE(value, $7, $3) FROM (SELECT DISTINCT
1424         mbe.value,
1425         cmf.id,
1426         cmc.bouyant AND _registered.field_class IS NOT NULL,
1427         _registered.field = cmf.id,
1428         cmf.weight,
1429         TS_RANK_CD(mbe.index_vector, $1, $6),
1430         cmc.bouyant
1431     FROM metabib.browse_entry_def_map mbedm
1432     JOIN metabib.browse_entry mbe ON (mbe.id = mbedm.entry)
1433     JOIN config.metabib_field cmf ON (cmf.id = mbedm.def)
1434     JOIN config.metabib_class cmc ON (cmf.field_class = cmc.name)
1435     '  || search_class_join || opac_visibility_join ||
1436     ' WHERE $1 @@ mbe.index_vector
1437     ORDER BY 3 DESC, 4 DESC NULLS LAST, 5 DESC, 6 DESC, 7 DESC, 1 ASC
1438     LIMIT $5) x
1439     ORDER BY 3 DESC, 4 DESC NULLS LAST, 5 DESC, 6 DESC, 7 DESC, 1 ASC
1440     '   -- sic, repeat the order by clause in the outer select too
1441     USING
1442         query, search_class, headline_opts,
1443         visibility_org, query_limit, normalization, plain_query
1444         ;
1445
1446     -- sort order:
1447     --  bouyant AND chosen class = match class
1448     --  chosen field = match field
1449     --  field weight
1450     --  rank
1451     --  bouyancy
1452     --  value itself
1453
1454 END;
1455 $func$ LANGUAGE PLPGSQL;
1456
1457 COMMIT;