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