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