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,
 189     index_vector tsvector,
 190     sort_value  TEXT NOT NULL,
 191     UNIQUE(sort_value, value)
 192 );
 193
 194
 195 CREATE INDEX browse_entry_sort_value_idx
 196     ON metabib.browse_entry USING BTREE (sort_value);
 197
 198 CREATE INDEX metabib_browse_entry_index_vector_idx ON metabib.browse_entry USING GIN (index_vector);
 199 CREATE TRIGGER metabib_browse_entry_fti_trigger
 200     BEFORE INSERT OR UPDATE ON metabib.browse_entry
 201     FOR EACH ROW EXECUTE PROCEDURE oils_tsearch2('keyword');
 202
 203
 204 CREATE TABLE metabib.browse_entry_def_map (
 205     id BIGSERIAL PRIMARY KEY,
 206     entry BIGINT REFERENCES metabib.browse_entry (id),
 207     def INT REFERENCES config.metabib_field (id) ON UPDATE CASCADE DEFERRABLE INITIALLY DEFERRED,
 208     source BIGINT REFERENCES biblio.record_entry (id),
 209     authority BIGINT REFERENCES authority.record_entry (id) ON DELETE SET NULL
 210 );
 211 CREATE INDEX browse_entry_def_map_def_idx ON metabib.browse_entry_def_map (def);
 212 CREATE INDEX browse_entry_def_map_entry_idx ON metabib.browse_entry_def_map (entry);
 213 CREATE INDEX browse_entry_def_map_source_idx ON metabib.browse_entry_def_map (source);
 214
 215 CREATE TABLE metabib.browse_entry_simple_heading_map (
 216     id BIGSERIAL PRIMARY KEY,
 217     entry BIGINT REFERENCES metabib.browse_entry (id),
 218     simple_heading BIGINT REFERENCES authority.simple_heading (id) ON DELETE CASCADE
 219 );
 220 CREATE INDEX browse_entry_sh_map_entry_idx ON metabib.browse_entry_simple_heading_map (entry);
 221 CREATE INDEX browse_entry_sh_map_sh_idx ON metabib.browse_entry_simple_heading_map (simple_heading);
 222
 223 CREATE OR REPLACE FUNCTION metabib.facet_normalize_trigger () RETURNS TRIGGER AS $$
 224 DECLARE
 225     normalizer  RECORD;
 226     facet_text  TEXT;
 227 BEGIN
 228     facet_text := NEW.value;
 229
 230     FOR normalizer IN
 231         SELECT  n.func AS func,
 232                 n.param_count AS param_count,
 233                 m.params AS params
 234           FROM  config.index_normalizer n
 235                 JOIN config.metabib_field_index_norm_map m ON (m.norm = n.id)
 236           WHERE m.field = NEW.field AND m.pos < 0
 237           ORDER BY m.pos LOOP
 238
 239             EXECUTE 'SELECT ' || normalizer.func || '(' ||
 240                 quote_literal( facet_text ) ||
 241                 CASE
 242                     WHEN normalizer.param_count > 0
 243                         THEN ',' || REPLACE(REPLACE(BTRIM(normalizer.params,'[]'),E'\'',E'\\\''),E'"',E'\'')
 244                         ELSE ''
 245                     END ||
 246                 ')' INTO facet_text;
 247
 248     END LOOP;
 249
 250     NEW.value = facet_text;
 251
 252     RETURN NEW;
 253 END;
 254 $$ LANGUAGE PLPGSQL;
 255
 256 CREATE TRIGGER facet_normalize_tgr
 257         BEFORE UPDATE OR INSERT ON metabib.facet_entry
 258         FOR EACH ROW EXECUTE PROCEDURE metabib.facet_normalize_trigger();
 259
 260 CREATE OR REPLACE FUNCTION evergreen.facet_force_nfc() RETURNS TRIGGER AS $$
 261 BEGIN
 262     NEW.value := force_unicode_normal_form(NEW.value,'NFC');
 263     RETURN NEW;
 264 END;
 265 $$ LANGUAGE PLPGSQL;
 266
 267 CREATE TRIGGER facet_force_nfc_tgr
 268         BEFORE UPDATE OR INSERT ON metabib.facet_entry
 269         FOR EACH ROW EXECUTE PROCEDURE evergreen.facet_force_nfc();
 270
 271 -- DECREMENTING serial starts at -1
 272 CREATE SEQUENCE metabib.uncontrolled_record_attr_value_id_seq INCREMENT BY -1;
 273
 274 CREATE TABLE metabib.uncontrolled_record_attr_value (
 275     id      BIGINT  PRIMARY KEY DEFAULT nextval('metabib.uncontrolled_record_attr_value_id_seq'),
 276     attr    TEXT    NOT NULL REFERENCES config.record_attr_definition (name),
 277     value   TEXT    NOT NULL
 278 );
 279 CREATE UNIQUE INDEX muv_once_idx ON metabib.uncontrolled_record_attr_value (attr,value);
 280
 281 CREATE VIEW metabib.record_attr_id_map AS
 282     SELECT id, attr, value FROM metabib.uncontrolled_record_attr_value
 283         UNION
 284     SELECT  c.id, c.ctype AS attr, c.code AS value
 285       FROM  config.coded_value_map c
 286             JOIN config.record_attr_definition d ON (d.name = c.ctype AND NOT d.composite);
 287
 288 CREATE VIEW metabib.composite_attr_id_map AS
 289     SELECT  c.id, c.ctype AS attr, c.code AS value
 290       FROM  config.coded_value_map c
 291             JOIN config.record_attr_definition d ON (d.name = c.ctype AND d.composite);
 292
 293 CREATE VIEW metabib.full_attr_id_map AS
 294     SELECT id, attr, value FROM metabib.record_attr_id_map
 295         UNION
 296     SELECT id, attr, value FROM metabib.composite_attr_id_map;
 297
 298
 299 CREATE OR REPLACE FUNCTION metabib.compile_composite_attr_cache_init () RETURNS BOOL AS $f$
 300     $_SHARED{metabib_compile_composite_attr_cache} = {}
 301         if ! exists $_SHARED{metabib_compile_composite_attr_cache};
 302     return exists $_SHARED{metabib_compile_composite_attr_cache};
 303 $f$ LANGUAGE PLPERLU;
 304
 305 CREATE OR REPLACE FUNCTION metabib.compile_composite_attr_cache_disable () RETURNS BOOL AS $f$
 306     delete $_SHARED{metabib_compile_composite_attr_cache};
 307     return ! exists $_SHARED{metabib_compile_composite_attr_cache};
 308 $f$ LANGUAGE PLPERLU;
 309
 310 CREATE OR REPLACE FUNCTION metabib.compile_composite_attr_cache_invalidate () RETURNS BOOL AS $f$
 311     SELECT metabib.compile_composite_attr_cache_disable() AND metabib.compile_composite_attr_cache_init();
 312 $f$ LANGUAGE SQL;
 313
 314 CREATE OR REPLACE FUNCTION metabib.composite_attr_def_cache_inval_tgr () RETURNS TRIGGER AS $f$
 315 BEGIN
 316     PERFORM metabib.compile_composite_attr_cache_invalidate();
 317     RETURN NULL;
 318 END;
 319 $f$ LANGUAGE PLPGSQL;
 320
 321 CREATE TRIGGER ccraed_cache_inval_tgr AFTER INSERT OR UPDATE OR DELETE ON config.composite_attr_entry_definition FOR EACH STATEMENT EXECUTE PROCEDURE metabib.composite_attr_def_cache_inval_tgr();
 322
 323 CREATE OR REPLACE FUNCTION metabib.compile_composite_attr ( cattr_def TEXT ) RETURNS query_int AS $func$
 324
 325     use JSON::XS;
 326
 327     my $json = shift;
 328     my $def = decode_json($json);
 329
 330     die("Composite attribute definition not supplied") unless $def;
 331
 332     my $_cache = (exists $_SHARED{metabib_compile_composite_attr_cache}) ? 1 : 0;
 333
 334     return $_SHARED{metabib_compile_composite_attr_cache}{$json}
 335         if ($_cache && $_SHARED{metabib_compile_composite_attr_cache}{$json});
 336
 337     sub recurse {
 338         my $d = shift;
 339         my $j = '&';
 340         my @list;
 341
 342         if (ref $d eq 'HASH') { # node or AND
 343             if (exists $d->{_attr}) { # it is a node
 344                 my $plan = spi_prepare('SELECT * FROM metabib.full_attr_id_map WHERE attr = $1 AND value = $2', qw/TEXT TEXT/);
 345                 my $id = spi_exec_prepared(
 346                     $plan, {limit => 1}, $d->{_attr}, $d->{_val}
 347                 )->{rows}[0]{id};
 348                 spi_freeplan($plan);
 349                 return $id;
 350             } elsif (exists $d->{_not} && scalar(keys(%$d)) == 1) { # it is a NOT
 351                 return '!' . recurse($$d{_not});
 352             } else { # an AND list
 353                 @list = map { recurse($$d{$_}) } sort keys %$d;
 354             }
 355         } elsif (ref $d eq 'ARRAY') {
 356             $j = '|';
 357             @list = map { recurse($_) } @$d;
 358         }
 359
 360         @list = grep { defined && $_ ne '' } @list;
 361
 362         return '(' . join($j,@list) . ')' if @list;
 363         return '';
 364     }
 365
 366     my $val = recurse($def) || undef;
 367     $_SHARED{metabib_compile_composite_attr_cache}{$json} = $val if $_cache;
 368     return $val;
 369
 370 $func$ IMMUTABLE LANGUAGE plperlu;
 371
 372 CREATE OR REPLACE FUNCTION metabib.compile_composite_attr ( cattr_id INT ) RETURNS query_int AS $func$
 373     SELECT metabib.compile_composite_attr(definition) FROM config.composite_attr_entry_definition WHERE coded_value = $1;
 374 $func$ STRICT IMMUTABLE LANGUAGE SQL;
 375
 376 CREATE TABLE metabib.record_attr_vector_list (
 377     source  BIGINT  PRIMARY KEY REFERENCES biblio.record_entry (id),
 378     vlist   INT[]   NOT NULL -- stores id from ccvm AND murav
 379 );
 380 CREATE INDEX mrca_vlist_idx ON metabib.record_attr_vector_list USING gin ( vlist gin__int_ops );
 381
 382 /* This becomes a view, and we do sorters differently ...
 383 CREATE TABLE metabib.record_attr (
 384         id              BIGINT  PRIMARY KEY REFERENCES biblio.record_entry (id) ON DELETE CASCADE,
 385         attrs   HSTORE  NOT NULL DEFAULT ''::HSTORE
 386 );
 387 CREATE INDEX metabib_svf_attrs_idx ON metabib.record_attr USING GIST (attrs);
 388 CREATE INDEX metabib_svf_date1_idx ON metabib.record_attr ((attrs->'date1'));
 389 CREATE INDEX metabib_svf_dates_idx ON metabib.record_attr ((attrs->'date1'),(attrs->'date2'));
 390 */
 391
 392 /* ... like this */
 393 CREATE TABLE metabib.record_sorter (
 394     id      BIGSERIAL   PRIMARY KEY,
 395     source  BIGINT      NOT NULL REFERENCES biblio.record_entry (id) ON DELETE CASCADE,
 396     attr    TEXT        NOT NULL REFERENCES config.record_attr_definition (name) ON DELETE CASCADE,
 397     value   TEXT        NOT NULL
 398 );
 399 CREATE INDEX metabib_sorter_source_idx ON metabib.record_sorter (source); -- we may not need one of this or the next ... stats will tell
 400 CREATE INDEX metabib_sorter_s_a_idx ON metabib.record_sorter (source, attr);
 401 CREATE INDEX metabib_sorter_a_v_idx ON metabib.record_sorter (attr, value);
 402
 403
 404 CREATE TYPE metabib.record_attr_type AS (
 405     id      BIGINT,
 406     attrs   HSTORE
 407 );
 408
 409 -- Back-compat view ... we're moving to an INTARRAY world
 410 CREATE VIEW metabib.record_attr_flat AS
 411     SELECT  v.source AS id,
 412             m.attr AS attr,
 413             m.value AS value
 414       FROM  metabib.record_attr_vector_list v
 415             LEFT JOIN metabib.uncontrolled_record_attr_value m ON ( m.id = ANY( v.vlist ) )
 416         UNION
 417     SELECT  v.source AS id,
 418             c.ctype AS attr,
 419             c.code AS value
 420       FROM  metabib.record_attr_vector_list v
 421             LEFT JOIN config.coded_value_map c ON ( c.id = ANY( v.vlist ) );
 422
 423 CREATE VIEW metabib.record_attr AS
 424     SELECT  id, HSTORE( ARRAY_AGG( attr ), ARRAY_AGG( value ) ) AS attrs
 425       FROM  metabib.record_attr_flat
 426       WHERE attr IS NOT NULL
 427       GROUP BY 1;
 428
 429 -- Back-back-compat view ... we use to live in an HSTORE world
 430 CREATE TYPE metabib.rec_desc_type AS (
 431     item_type       TEXT,
 432     item_form       TEXT,
 433     bib_level       TEXT,
 434     control_type    TEXT,
 435     char_encoding   TEXT,
 436     enc_level       TEXT,
 437     audience        TEXT,
 438     lit_form        TEXT,
 439     type_mat        TEXT,
 440     cat_form        TEXT,
 441     pub_status      TEXT,
 442     item_lang       TEXT,
 443     vr_format       TEXT,
 444     date1           TEXT,
 445     date2           TEXT
 446 );
 447
 448 CREATE VIEW metabib.rec_descriptor AS
 449     SELECT  id,
 450             id AS record,
 451             (populate_record(NULL::metabib.rec_desc_type, attrs)).*
 452       FROM  metabib.record_attr;
 453
 454 -- Use a sequence that matches previous version, for easier upgrading.
 455 CREATE SEQUENCE metabib.full_rec_id_seq;
 456
 457 CREATE TABLE metabib.real_full_rec (
 458         id                  BIGINT      NOT NULL DEFAULT NEXTVAL('metabib.full_rec_id_seq'::REGCLASS),
 459         record          BIGINT          NOT NULL,
 460         tag             CHAR(3)         NOT NULL,
 461         ind1            TEXT,
 462         ind2            TEXT,
 463         subfield        TEXT,
 464         value           TEXT            NOT NULL,
 465         index_vector    tsvector        NOT NULL
 466 );
 467 ALTER TABLE metabib.real_full_rec ADD PRIMARY KEY (id);
 468
 469 CREATE INDEX metabib_full_rec_tag_subfield_idx ON metabib.real_full_rec (tag,subfield);
 470 CREATE INDEX metabib_full_rec_value_idx ON metabib.real_full_rec (substring(value,1,1024));
 471 /* Enable LIKE to use an index for database clusters with locales other than C or POSIX */
 472 CREATE INDEX metabib_full_rec_value_tpo_index ON metabib.real_full_rec (substring(value,1,1024) text_pattern_ops);
 473 CREATE INDEX metabib_full_rec_record_idx ON metabib.real_full_rec (record);
 474 CREATE INDEX metabib_full_rec_index_vector_idx ON metabib.real_full_rec USING GIST (index_vector);
 475 CREATE INDEX metabib_full_rec_isxn_caseless_idx
 476     ON metabib.real_full_rec (LOWER(value))
 477     WHERE tag IN ('020', '022', '024');
 478 -- This next index might fully supplant the one above, but leaving both for now.
 479 -- (they are not too large)
 480 -- The reason we need this index is to ensure that the query parser always
 481 -- prefers this index over the simpler tag/subfield index, as this greatly
 482 -- increases Vandelay overlay speed for these identifiers, especially when
 483 -- a record has many of these fields (around > 4-6 seems like the cutoff
 484 -- on at least one PG9.1 system)
 485 -- A similar index could be added for other fields (e.g. 010), but one should
 486 -- leave out the LOWER() in all other cases.
 487 -- TODO: verify whether we can discard the non tag/subfield/substring version
 488 -- above (metabib_full_rec_isxn_caseless_idx)
 489 CREATE INDEX metabib_full_rec_02x_tag_subfield_lower_substring
 490     ON metabib.real_full_rec (tag, subfield, LOWER(substring(value, 1, 1024)))
 491     WHERE tag IN ('020', '022', '024');
 492
 493
 494 CREATE TRIGGER metabib_full_rec_fti_trigger
 495         BEFORE UPDATE OR INSERT ON metabib.real_full_rec
 496         FOR EACH ROW EXECUTE PROCEDURE oils_tsearch2('default');
 497
 498 CREATE OR REPLACE VIEW metabib.full_rec AS
 499     SELECT  id,
 500             record,
 501             tag,
 502             ind1,
 503             ind2,
 504             subfield,
 505             SUBSTRING(value,1,1024) AS value,
 506             index_vector
 507       FROM  metabib.real_full_rec;
 508
 509 CREATE OR REPLACE RULE metabib_full_rec_insert_rule
 510     AS ON INSERT TO metabib.full_rec
 511     DO INSTEAD
 512     INSERT INTO metabib.real_full_rec VALUES (
 513         COALESCE(NEW.id, NEXTVAL('metabib.full_rec_id_seq'::REGCLASS)),
 514         NEW.record,
 515         NEW.tag,
 516         NEW.ind1,
 517         NEW.ind2,
 518         NEW.subfield,
 519         NEW.value,
 520         NEW.index_vector
 521     );
 522
 523 CREATE OR REPLACE RULE metabib_full_rec_update_rule
 524     AS ON UPDATE TO metabib.full_rec
 525     DO INSTEAD
 526     UPDATE  metabib.real_full_rec SET
 527         id = NEW.id,
 528         record = NEW.record,
 529         tag = NEW.tag,
 530         ind1 = NEW.ind1,
 531         ind2 = NEW.ind2,
 532         subfield = NEW.subfield,
 533         value = NEW.value,
 534         index_vector = NEW.index_vector
 535       WHERE id = OLD.id;
 536
 537 CREATE OR REPLACE RULE metabib_full_rec_delete_rule
 538     AS ON DELETE TO metabib.full_rec
 539     DO INSTEAD
 540     DELETE FROM metabib.real_full_rec WHERE id = OLD.id;
 541
 542 CREATE TABLE metabib.metarecord_source_map (
 543         id              BIGSERIAL       PRIMARY KEY,
 544         metarecord      BIGINT          NOT NULL,
 545         source          BIGINT          NOT NULL
 546 );
 547 CREATE INDEX metabib_metarecord_source_map_metarecord_idx ON metabib.metarecord_source_map (metarecord);
 548 CREATE INDEX metabib_metarecord_source_map_source_record_idx ON metabib.metarecord_source_map (source);
 549
 550 CREATE TYPE metabib.field_entry_template AS (
 551     field_class         TEXT,
 552     field               INT,
 553     facet_field         BOOL,
 554     search_field        BOOL,
 555     browse_field        BOOL,
 556     source              BIGINT,
 557     value               TEXT,
 558     authority           BIGINT,
 559     sort_value          TEXT
 560 );
 561
 562
 563 CREATE OR REPLACE FUNCTION biblio.extract_metabib_field_entry ( rid BIGINT, default_joiner TEXT ) RETURNS SETOF metabib.field_entry_template AS $func$
 564 DECLARE
 565     bib     biblio.record_entry%ROWTYPE;
 566     idx     config.metabib_field%ROWTYPE;
 567     xfrm        config.xml_transform%ROWTYPE;
 568     prev_xfrm   TEXT;
 569     transformed_xml TEXT;
 570     xml_node    TEXT;
 571     xml_node_list   TEXT[];
 572     facet_text  TEXT;
 573     browse_text TEXT;
 574     sort_value  TEXT;
 575     raw_text    TEXT;
 576     curr_text   TEXT;
 577     joiner      TEXT := default_joiner; -- XXX will index defs supply a joiner?
 578     authority_text TEXT;
 579     authority_link BIGINT;
 580     output_row  metabib.field_entry_template%ROWTYPE;
 581 BEGIN
 582
 583     -- Start out with no field-use bools set
 584     output_row.browse_field = FALSE;
 585     output_row.facet_field = FALSE;
 586     output_row.search_field = FALSE;
 587
 588     -- Get the record
 589     SELECT INTO bib * FROM biblio.record_entry WHERE id = rid;
 590
 591     -- Loop over the indexing entries
 592     FOR idx IN SELECT * FROM config.metabib_field ORDER BY format LOOP
 593
 594         joiner := COALESCE(idx.joiner, default_joiner);
 595
 596         SELECT INTO xfrm * from config.xml_transform WHERE name = idx.format;
 597
 598         -- See if we can skip the XSLT ... it's expensive
 599         IF prev_xfrm IS NULL OR prev_xfrm <> xfrm.name THEN
 600             -- Can't skip the transform
 601             IF xfrm.xslt <> '---' THEN
 602                 transformed_xml := oils_xslt_process(bib.marc,xfrm.xslt);
 603             ELSE
 604                 transformed_xml := bib.marc;
 605             END IF;
 606
 607             prev_xfrm := xfrm.name;
 608         END IF;
 609
 610         xml_node_list := oils_xpath( idx.xpath, transformed_xml, ARRAY[ARRAY[xfrm.prefix, xfrm.namespace_uri]] );
 611
 612         raw_text := NULL;
 613         FOR xml_node IN SELECT x FROM unnest(xml_node_list) AS x LOOP
 614             CONTINUE WHEN xml_node !~ E'^\\s*<';
 615
 616             -- XXX much of this should be moved into oils_xpath_string...
 617             curr_text := ARRAY_TO_STRING(evergreen.array_remove_item_by_value(evergreen.array_remove_item_by_value(
 618                 oils_xpath( '//text()', -- get the content of all the nodes within the main selected node
 619                     REGEXP_REPLACE( xml_node, E'\\s+', ' ', 'g' ) -- Translate adjacent whitespace to a single space
 620                 ), ' '), ''),  -- throw away morally empty (bankrupt?) strings
 621                 joiner
 622             );
 623
 624             CONTINUE WHEN curr_text IS NULL OR curr_text = '';
 625
 626             IF raw_text IS NOT NULL THEN
 627                 raw_text := raw_text || joiner;
 628             END IF;
 629
 630             raw_text := COALESCE(raw_text,'') || curr_text;
 631
 632             -- autosuggest/metabib.browse_entry
 633             IF idx.browse_field THEN
 634
 635                 IF idx.browse_xpath IS NOT NULL AND idx.browse_xpath <> '' THEN
 636                     browse_text := oils_xpath_string( idx.browse_xpath, xml_node, joiner, ARRAY[ARRAY[xfrm.prefix, xfrm.namespace_uri]] );
 637                 ELSE
 638                     browse_text := curr_text;
 639                 END IF;
 640
 641                 IF idx.browse_sort_xpath IS NOT NULL AND
 642                     idx.browse_sort_xpath <> '' THEN
 643
 644                     sort_value := oils_xpath_string(
 645                         idx.browse_sort_xpath, xml_node, joiner,
 646                         ARRAY[ARRAY[xfrm.prefix, xfrm.namespace_uri]]
 647                     );
 648                 ELSE
 649                     sort_value := browse_text;
 650                 END IF;
 651
 652                 output_row.field_class = idx.field_class;
 653                 output_row.field = idx.id;
 654                 output_row.source = rid;
 655                 output_row.value = BTRIM(REGEXP_REPLACE(browse_text, E'\\s+', ' ', 'g'));
 656                 output_row.sort_value :=
 657                     public.naco_normalize(sort_value);
 658
 659                 output_row.authority := NULL;
 660
 661                 IF idx.authority_xpath IS NOT NULL AND idx.authority_xpath <> '' THEN
 662                     authority_text := oils_xpath_string(
 663                         idx.authority_xpath, xml_node, joiner,
 664                         ARRAY[
 665                             ARRAY[xfrm.prefix, xfrm.namespace_uri],
 666                             ARRAY['xlink','http://www.w3.org/1999/xlink']
 667                         ]
 668                     );
 669
 670                     IF authority_text ~ '^\d+$' THEN
 671                         authority_link := authority_text::BIGINT;
 672                         PERFORM * FROM authority.record_entry WHERE id = authority_link;
 673                         IF FOUND THEN
 674                             output_row.authority := authority_link;
 675                         END IF;
 676                     END IF;
 677
 678                 END IF;
 679
 680                 output_row.browse_field = TRUE;
 681                 -- Returning browse rows with search_field = true for search+browse
 682                 -- configs allows us to retain granularity of being able to search
 683                 -- browse fields with "starts with" type operators (for example, for
 684                 -- titles of songs in music albums)
 685                 IF idx.search_field THEN
 686                     output_row.search_field = TRUE;
 687                 END IF;
 688                 RETURN NEXT output_row;
 689                 output_row.browse_field = FALSE;
 690                 output_row.search_field = FALSE;
 691                 output_row.sort_value := NULL;
 692             END IF;
 693
 694             -- insert raw node text for faceting
 695             IF idx.facet_field THEN
 696
 697                 IF idx.facet_xpath IS NOT NULL AND idx.facet_xpath <> '' THEN
 698                     facet_text := oils_xpath_string( idx.facet_xpath, xml_node, joiner, ARRAY[ARRAY[xfrm.prefix, xfrm.namespace_uri]] );
 699                 ELSE
 700                     facet_text := curr_text;
 701                 END IF;
 702
 703                 output_row.field_class = idx.field_class;
 704                 output_row.field = -1 * idx.id;
 705                 output_row.source = rid;
 706                 output_row.value = BTRIM(REGEXP_REPLACE(facet_text, E'\\s+', ' ', 'g'));
 707
 708                 output_row.facet_field = TRUE;
 709                 RETURN NEXT output_row;
 710                 output_row.facet_field = FALSE;
 711             END IF;
 712
 713         END LOOP;
 714
 715         CONTINUE WHEN raw_text IS NULL OR raw_text = '';
 716
 717         -- insert combined node text for searching
 718         IF idx.search_field THEN
 719             output_row.field_class = idx.field_class;
 720             output_row.field = idx.id;
 721             output_row.source = rid;
 722             output_row.value = BTRIM(REGEXP_REPLACE(raw_text, E'\\s+', ' ', 'g'));
 723
 724             output_row.search_field = TRUE;
 725             RETURN NEXT output_row;
 726             output_row.search_field = FALSE;
 727         END IF;
 728
 729     END LOOP;
 730
 731 END;
 732
 733 $func$ LANGUAGE PLPGSQL;
 734
 735 CREATE OR REPLACE FUNCTION metabib.update_combined_index_vectors(bib_id BIGINT) RETURNS VOID AS $func$
 736 BEGIN
 737     DELETE FROM metabib.combined_keyword_field_entry WHERE record = bib_id;
 738     INSERT INTO metabib.combined_keyword_field_entry(record, metabib_field, index_vector)
 739         SELECT bib_id, field, strip(COALESCE(string_agg(index_vector::TEXT,' '),'')::tsvector)
 740         FROM metabib.keyword_field_entry WHERE source = bib_id GROUP BY field;
 741     INSERT INTO metabib.combined_keyword_field_entry(record, metabib_field, index_vector)
 742         SELECT bib_id, NULL, strip(COALESCE(string_agg(index_vector::TEXT,' '),'')::tsvector)
 743         FROM metabib.keyword_field_entry WHERE source = bib_id;
 744
 745     DELETE FROM metabib.combined_title_field_entry WHERE record = bib_id;
 746     INSERT INTO metabib.combined_title_field_entry(record, metabib_field, index_vector)
 747         SELECT bib_id, field, strip(COALESCE(string_agg(index_vector::TEXT,' '),'')::tsvector)
 748         FROM metabib.title_field_entry WHERE source = bib_id GROUP BY field;
 749     INSERT INTO metabib.combined_title_field_entry(record, metabib_field, index_vector)
 750         SELECT bib_id, NULL, strip(COALESCE(string_agg(index_vector::TEXT,' '),'')::tsvector)
 751         FROM metabib.title_field_entry WHERE source = bib_id;
 752
 753     DELETE FROM metabib.combined_author_field_entry WHERE record = bib_id;
 754     INSERT INTO metabib.combined_author_field_entry(record, metabib_field, index_vector)
 755         SELECT bib_id, field, strip(COALESCE(string_agg(index_vector::TEXT,' '),'')::tsvector)
 756         FROM metabib.author_field_entry WHERE source = bib_id GROUP BY field;
 757     INSERT INTO metabib.combined_author_field_entry(record, metabib_field, index_vector)
 758         SELECT bib_id, NULL, strip(COALESCE(string_agg(index_vector::TEXT,' '),'')::tsvector)
 759         FROM metabib.author_field_entry WHERE source = bib_id;
 760
 761     DELETE FROM metabib.combined_subject_field_entry WHERE record = bib_id;
 762     INSERT INTO metabib.combined_subject_field_entry(record, metabib_field, index_vector)
 763         SELECT bib_id, field, strip(COALESCE(string_agg(index_vector::TEXT,' '),'')::tsvector)
 764         FROM metabib.subject_field_entry WHERE source = bib_id GROUP BY field;
 765     INSERT INTO metabib.combined_subject_field_entry(record, metabib_field, index_vector)
 766         SELECT bib_id, NULL, strip(COALESCE(string_agg(index_vector::TEXT,' '),'')::tsvector)
 767         FROM metabib.subject_field_entry WHERE source = bib_id;
 768
 769     DELETE FROM metabib.combined_series_field_entry WHERE record = bib_id;
 770     INSERT INTO metabib.combined_series_field_entry(record, metabib_field, index_vector)
 771         SELECT bib_id, field, strip(COALESCE(string_agg(index_vector::TEXT,' '),'')::tsvector)
 772         FROM metabib.series_field_entry WHERE source = bib_id GROUP BY field;
 773     INSERT INTO metabib.combined_series_field_entry(record, metabib_field, index_vector)
 774         SELECT bib_id, NULL, strip(COALESCE(string_agg(index_vector::TEXT,' '),'')::tsvector)
 775         FROM metabib.series_field_entry WHERE source = bib_id;
 776
 777     DELETE FROM metabib.combined_identifier_field_entry WHERE record = bib_id;
 778     INSERT INTO metabib.combined_identifier_field_entry(record, metabib_field, index_vector)
 779         SELECT bib_id, field, strip(COALESCE(string_agg(index_vector::TEXT,' '),'')::tsvector)
 780         FROM metabib.identifier_field_entry WHERE source = bib_id GROUP BY field;
 781     INSERT INTO metabib.combined_identifier_field_entry(record, metabib_field, index_vector)
 782         SELECT bib_id, NULL, strip(COALESCE(string_agg(index_vector::TEXT,' '),'')::tsvector)
 783         FROM metabib.identifier_field_entry WHERE source = bib_id;
 784
 785 END;
 786 $func$ LANGUAGE PLPGSQL;
 787
 788 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$
 789 DECLARE
 790     fclass          RECORD;
 791     ind_data        metabib.field_entry_template%ROWTYPE;
 792     mbe_row         metabib.browse_entry%ROWTYPE;
 793     mbe_id          BIGINT;
 794     b_skip_facet    BOOL;
 795     b_skip_browse   BOOL;
 796     b_skip_search   BOOL;
 797     value_prepped   TEXT;
 798 BEGIN
 799
 800     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;
 801     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;
 802     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;
 803
 804     PERFORM * FROM config.internal_flag WHERE name = 'ingest.assume_inserts_only' AND enabled;
 805     IF NOT FOUND THEN
 806         IF NOT b_skip_search THEN
 807             FOR fclass IN SELECT * FROM config.metabib_class LOOP
 808                 -- RAISE NOTICE 'Emptying out %', fclass.name;
 809                 EXECUTE $$DELETE FROM metabib.$$ || fclass.name || $$_field_entry WHERE source = $$ || bib_id;
 810             END LOOP;
 811         END IF;
 812         IF NOT b_skip_facet THEN
 813             DELETE FROM metabib.facet_entry WHERE source = bib_id;
 814         END IF;
 815         IF NOT b_skip_browse THEN
 816             DELETE FROM metabib.browse_entry_def_map WHERE source = bib_id;
 817         END IF;
 818     END IF;
 819
 820     FOR ind_data IN SELECT * FROM biblio.extract_metabib_field_entry( bib_id ) LOOP
 821
 822         -- don't store what has been normalized away
 823         CONTINUE WHEN ind_data.value IS NULL;
 824
 825         IF ind_data.field < 0 THEN
 826             ind_data.field = -1 * ind_data.field;
 827         END IF;
 828
 829         IF ind_data.facet_field AND NOT b_skip_facet THEN
 830             INSERT INTO metabib.facet_entry (field, source, value)
 831                 VALUES (ind_data.field, ind_data.source, ind_data.value);
 832         END IF;
 833
 834         IF ind_data.browse_field AND NOT b_skip_browse THEN
 835             -- A caveat about this SELECT: this should take care of replacing
 836             -- old mbe rows when data changes, but not if normalization (by
 837             -- which I mean specifically the output of
 838             -- evergreen.oils_tsearch2()) changes.  It may or may not be
 839             -- expensive to add a comparison of index_vector to index_vector
 840             -- to the WHERE clause below.
 841
 842             CONTINUE WHEN ind_data.sort_value IS NULL;
 843
 844             value_prepped := metabib.browse_normalize(ind_data.value, ind_data.field);
 845             SELECT INTO mbe_row * FROM metabib.browse_entry
 846                 WHERE value = value_prepped AND sort_value = ind_data.sort_value;
 847
 848             IF FOUND THEN
 849                 mbe_id := mbe_row.id;
 850             ELSE
 851                 INSERT INTO metabib.browse_entry
 852                     ( value, sort_value ) VALUES
 853                     ( value_prepped, ind_data.sort_value );
 854
 855                 mbe_id := CURRVAL('metabib.browse_entry_id_seq'::REGCLASS);
 856             END IF;
 857
 858             INSERT INTO metabib.browse_entry_def_map (entry, def, source, authority)
 859                 VALUES (mbe_id, ind_data.field, ind_data.source, ind_data.authority);
 860         END IF;
 861
 862         IF ind_data.search_field AND NOT b_skip_search THEN
 863             -- Avoid inserting duplicate rows
 864             EXECUTE 'SELECT 1 FROM metabib.' || ind_data.field_class ||
 865                 '_field_entry WHERE field = $1 AND source = $2 AND value = $3'
 866                 INTO mbe_id USING ind_data.field, ind_data.source, ind_data.value;
 867                 -- RAISE NOTICE 'Search for an already matching row returned %', mbe_id;
 868             IF mbe_id IS NULL THEN
 869                 EXECUTE $$
 870                 INSERT INTO metabib.$$ || ind_data.field_class || $$_field_entry (field, source, value)
 871                     VALUES ($$ ||
 872                         quote_literal(ind_data.field) || $$, $$ ||
 873                         quote_literal(ind_data.source) || $$, $$ ||
 874                         quote_literal(ind_data.value) ||
 875                     $$);$$;
 876             END IF;
 877         END IF;
 878
 879     END LOOP;
 880
 881     IF NOT b_skip_search THEN
 882         PERFORM metabib.update_combined_index_vectors(bib_id);
 883     END IF;
 884
 885     RETURN;
 886 END;
 887 $func$ LANGUAGE PLPGSQL;
 888
 889 -- default to a space joiner
 890 CREATE OR REPLACE FUNCTION biblio.extract_metabib_field_entry ( BIGINT ) RETURNS SETOF metabib.field_entry_template AS $func$
 891         SELECT * FROM biblio.extract_metabib_field_entry($1, ' ');
 892 $func$ LANGUAGE SQL;
 893
 894 CREATE OR REPLACE FUNCTION authority.flatten_marc ( rid BIGINT ) RETURNS SETOF authority.full_rec AS $func$
 895 DECLARE
 896         auth    authority.record_entry%ROWTYPE;
 897         output  authority.full_rec%ROWTYPE;
 898         field   RECORD;
 899 BEGIN
 900         SELECT INTO auth * FROM authority.record_entry WHERE id = rid;
 901
 902         FOR field IN SELECT * FROM vandelay.flatten_marc( auth.marc ) LOOP
 903                 output.record := rid;
 904                 output.ind1 := field.ind1;
 905                 output.ind2 := field.ind2;
 906                 output.tag := field.tag;
 907                 output.subfield := field.subfield;
 908                 output.value := field.value;
 909
 910                 RETURN NEXT output;
 911         END LOOP;
 912 END;
 913 $func$ LANGUAGE PLPGSQL;
 914
 915 CREATE OR REPLACE FUNCTION biblio.flatten_marc ( rid BIGINT ) RETURNS SETOF metabib.full_rec AS $func$
 916 DECLARE
 917         bib     biblio.record_entry%ROWTYPE;
 918         output  metabib.full_rec%ROWTYPE;
 919         field   RECORD;
 920 BEGIN
 921         SELECT INTO bib * FROM biblio.record_entry WHERE id = rid;
 922
 923         FOR field IN SELECT * FROM vandelay.flatten_marc( bib.marc ) LOOP
 924                 output.record := rid;
 925                 output.ind1 := field.ind1;
 926                 output.ind2 := field.ind2;
 927                 output.tag := field.tag;
 928                 output.subfield := field.subfield;
 929                 output.value := field.value;
 930
 931                 RETURN NEXT output;
 932         END LOOP;
 933 END;
 934 $func$ LANGUAGE PLPGSQL;
 935
 936 CREATE OR REPLACE FUNCTION biblio.marc21_extract_fixed_field_list( rid BIGINT, ff TEXT ) RETURNS TEXT[] AS $func$
 937     SELECT * FROM vandelay.marc21_extract_fixed_field_list( (SELECT marc FROM biblio.record_entry WHERE id = $1), $2, TRUE );
 938 $func$ LANGUAGE SQL;
 939
 940 CREATE OR REPLACE FUNCTION biblio.marc21_extract_fixed_field( rid BIGINT, ff TEXT ) RETURNS TEXT AS $func$
 941     SELECT * FROM vandelay.marc21_extract_fixed_field( (SELECT marc FROM biblio.record_entry WHERE id = $1), $2, TRUE );
 942 $func$ LANGUAGE SQL;
 943
 944 CREATE OR REPLACE FUNCTION biblio.marc21_extract_all_fixed_fields( rid BIGINT ) RETURNS SETOF biblio.record_ff_map AS $func$
 945     SELECT $1 AS record, ff_name, ff_value FROM vandelay.marc21_extract_all_fixed_fields( (SELECT marc FROM biblio.record_entry WHERE id = $1), TRUE );
 946 $func$ LANGUAGE SQL;
 947
 948 CREATE OR REPLACE FUNCTION biblio.marc21_physical_characteristics( rid BIGINT ) RETURNS SETOF biblio.marc21_physical_characteristics AS $func$
 949     SELECT id, $1 AS record, ptype, subfield, value FROM vandelay.marc21_physical_characteristics( (SELECT marc FROM biblio.record_entry WHERE id = $1) );
 950 $func$ LANGUAGE SQL;
 951
 952 CREATE OR REPLACE FUNCTION biblio.extract_quality ( marc TEXT, best_lang TEXT, best_type TEXT ) RETURNS INT AS $func$
 953 DECLARE
 954     qual        INT;
 955     ldr         TEXT;
 956     tval        TEXT;
 957     tval_rec    RECORD;
 958     bval        TEXT;
 959     bval_rec    RECORD;
 960     type_map    RECORD;
 961     ff_pos      RECORD;
 962     ff_tag_data TEXT;
 963 BEGIN
 964
 965     IF marc IS NULL OR marc = '' THEN
 966         RETURN NULL;
 967     END IF;
 968
 969     -- First, the count of tags
 970     qual := ARRAY_UPPER(oils_xpath('*[local-name()="datafield"]', marc), 1);
 971
 972     -- now go through a bunch of pain to get the record type
 973     IF best_type IS NOT NULL THEN
 974         ldr := (oils_xpath('//*[local-name()="leader"]/text()', marc))[1];
 975
 976         IF ldr IS NOT NULL THEN
 977             SELECT * INTO tval_rec FROM config.marc21_ff_pos_map WHERE fixed_field = 'Type' LIMIT 1; -- They're all the same
 978             SELECT * INTO bval_rec FROM config.marc21_ff_pos_map WHERE fixed_field = 'BLvl' LIMIT 1; -- They're all the same
 979
 980
 981             tval := SUBSTRING( ldr, tval_rec.start_pos + 1, tval_rec.length );
 982             bval := SUBSTRING( ldr, bval_rec.start_pos + 1, bval_rec.length );
 983
 984             -- RAISE NOTICE 'type %, blvl %, ldr %', tval, bval, ldr;
 985
 986             SELECT * INTO type_map FROM config.marc21_rec_type_map WHERE type_val LIKE '%' || tval || '%' AND blvl_val LIKE '%' || bval || '%';
 987
 988             IF type_map.code IS NOT NULL THEN
 989                 IF best_type = type_map.code THEN
 990                     qual := qual + qual / 2;
 991                 END IF;
 992
 993                 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
 994                     ff_tag_data := SUBSTRING((oils_xpath('//*[@tag="' || ff_pos.tag || '"]/text()',marc))[1], ff_pos.start_pos + 1, ff_pos.length);
 995                     IF ff_tag_data = best_lang THEN
 996                             qual := qual + 100;
 997                     END IF;
 998                 END LOOP;
 999             END IF;
1000         END IF;
1001     END IF;
1002
1003     -- Now look for some quality metrics
1004     -- DCL record?
1005     IF ARRAY_UPPER(oils_xpath('//*[@tag="040"]/*[@code="a" and contains(.,"DLC")]', marc), 1) = 1 THEN
1006         qual := qual + 10;
1007     END IF;
1008
1009     -- From OCLC?
1010     IF (oils_xpath('//*[@tag="003"]/text()', marc))[1] ~* E'oclo?c' THEN
1011         qual := qual + 10;
1012     END IF;
1013
1014     RETURN qual;
1015
1016 END;
1017 $func$ LANGUAGE PLPGSQL;
1018
1019 CREATE OR REPLACE FUNCTION biblio.extract_fingerprint ( marc text ) RETURNS TEXT AS $func$
1020 DECLARE
1021         idx             config.biblio_fingerprint%ROWTYPE;
1022         xfrm            config.xml_transform%ROWTYPE;
1023         prev_xfrm       TEXT;
1024         transformed_xml TEXT;
1025         xml_node        TEXT;
1026         xml_node_list   TEXT[];
1027         raw_text        TEXT;
1028     output_text TEXT := '';
1029 BEGIN
1030
1031     IF marc IS NULL OR marc = '' THEN
1032         RETURN NULL;
1033     END IF;
1034
1035         -- Loop over the indexing entries
1036         FOR idx IN SELECT * FROM config.biblio_fingerprint ORDER BY format, id LOOP
1037
1038                 SELECT INTO xfrm * from config.xml_transform WHERE name = idx.format;
1039
1040                 -- See if we can skip the XSLT ... it's expensive
1041                 IF prev_xfrm IS NULL OR prev_xfrm <> xfrm.name THEN
1042                         -- Can't skip the transform
1043                         IF xfrm.xslt <> '---' THEN
1044                                 transformed_xml := oils_xslt_process(marc,xfrm.xslt);
1045                         ELSE
1046                                 transformed_xml := marc;
1047                         END IF;
1048
1049                         prev_xfrm := xfrm.name;
1050                 END IF;
1051
1052                 raw_text := COALESCE(
1053             naco_normalize(
1054                 ARRAY_TO_STRING(
1055                     oils_xpath(
1056                         '//text()',
1057                         (oils_xpath(
1058                             idx.xpath,
1059                             transformed_xml,
1060                             ARRAY[ARRAY[xfrm.prefix, xfrm.namespace_uri]]
1061                         ))[1]
1062                     ),
1063                     ''
1064                 )
1065             ),
1066             ''
1067         );
1068
1069         raw_text := REGEXP_REPLACE(raw_text, E'\\[.+?\\]', E'');
1070         raw_text := REGEXP_REPLACE(raw_text, E'\\mthe\\M|\\man?d?d\\M', E'', 'g'); -- arg! the pain!
1071
1072         IF idx.first_word IS TRUE THEN
1073             raw_text := REGEXP_REPLACE(raw_text, E'^(\\w+).*?$', E'\\1');
1074         END IF;
1075
1076                 output_text := output_text || REGEXP_REPLACE(raw_text, E'\\s+', '', 'g');
1077
1078         END LOOP;
1079
1080     RETURN output_text;
1081
1082 END;
1083 $func$ LANGUAGE PLPGSQL;
1084
1085 -- BEFORE UPDATE OR INSERT trigger for biblio.record_entry
1086 CREATE OR REPLACE FUNCTION biblio.fingerprint_trigger () RETURNS TRIGGER AS $func$
1087 BEGIN
1088
1089     -- For TG_ARGV, first param is language (like 'eng'), second is record type (like 'BKS')
1090
1091     IF NEW.deleted IS TRUE THEN -- we don't much care, then, do we?
1092         RETURN NEW;
1093     END IF;
1094
1095     NEW.fingerprint := biblio.extract_fingerprint(NEW.marc);
1096     NEW.quality := biblio.extract_quality(NEW.marc, TG_ARGV[0], TG_ARGV[1]);
1097
1098     RETURN NEW;
1099
1100 END;
1101 $func$ LANGUAGE PLPGSQL;
1102
1103 CREATE OR REPLACE FUNCTION metabib.reingest_metabib_full_rec( bib_id BIGINT ) RETURNS VOID AS $func$
1104 BEGIN
1105     PERFORM * FROM config.internal_flag WHERE name = 'ingest.assume_inserts_only' AND enabled;
1106     IF NOT FOUND THEN
1107         DELETE FROM metabib.real_full_rec WHERE record = bib_id;
1108     END IF;
1109     INSERT INTO metabib.real_full_rec (record, tag, ind1, ind2, subfield, value)
1110         SELECT record, tag, ind1, ind2, subfield, value FROM biblio.flatten_marc( bib_id );
1111
1112     RETURN;
1113 END;
1114 $func$ LANGUAGE PLPGSQL;
1115
1116 CREATE OR REPLACE FUNCTION biblio.extract_located_uris( bib_id BIGINT, marcxml TEXT, editor_id INT ) RETURNS VOID AS $func$
1117 DECLARE
1118     uris            TEXT[];
1119     uri_xml         TEXT;
1120     uri_label       TEXT;
1121     uri_href        TEXT;
1122     uri_use         TEXT;
1123     uri_owner_list  TEXT[];
1124     uri_owner       TEXT;
1125     uri_owner_id    INT;
1126     uri_id          INT;
1127     uri_cn_id       INT;
1128     uri_map_id      INT;
1129 BEGIN
1130
1131     -- Clear any URI mappings and call numbers for this bib.
1132     -- This leads to acn / auricnm inflation, but also enables
1133     -- old acn/auricnm's to go away and for bibs to be deleted.
1134     FOR uri_cn_id IN SELECT id FROM asset.call_number WHERE record = bib_id AND label = '##URI##' AND NOT deleted LOOP
1135         DELETE FROM asset.uri_call_number_map WHERE call_number = uri_cn_id;
1136         DELETE FROM asset.call_number WHERE id = uri_cn_id;
1137     END LOOP;
1138
1139     uris := oils_xpath('//*[@tag="856" and (@ind1="4" or @ind1="1") and (@ind2="0" or @ind2="1")]',marcxml);
1140     IF ARRAY_UPPER(uris,1) > 0 THEN
1141         FOR i IN 1 .. ARRAY_UPPER(uris, 1) LOOP
1142             -- First we pull info out of the 856
1143             uri_xml     := uris[i];
1144
1145             uri_href    := (oils_xpath('//*[@code="u"]/text()',uri_xml))[1];
1146             uri_label   := (oils_xpath('//*[@code="y"]/text()|//*[@code="3"]/text()',uri_xml))[1];
1147             uri_use     := (oils_xpath('//*[@code="z"]/text()|//*[@code="2"]/text()|//*[@code="n"]/text()',uri_xml))[1];
1148
1149             IF uri_label IS NULL THEN
1150                 uri_label := uri_href;
1151             END IF;
1152             CONTINUE WHEN uri_href IS NULL;
1153
1154             -- Get the distinct list of libraries wanting to use
1155             SELECT  ARRAY_AGG(
1156                         DISTINCT REGEXP_REPLACE(
1157                             x,
1158                             $re$^.*?\((\w+)\).*$$re$,
1159                             E'\\1'
1160                         )
1161                     ) INTO uri_owner_list
1162               FROM  UNNEST(
1163                         oils_xpath(
1164                             '//*[@code="9"]/text()|//*[@code="w"]/text()|//*[@code="n"]/text()',
1165                             uri_xml
1166                         )
1167                     )x;
1168
1169             IF ARRAY_UPPER(uri_owner_list,1) > 0 THEN
1170
1171                 -- look for a matching uri
1172                 IF uri_use IS NULL THEN
1173                     SELECT id INTO uri_id
1174                         FROM asset.uri
1175                         WHERE label = uri_label AND href = uri_href AND use_restriction IS NULL AND active
1176                         ORDER BY id LIMIT 1;
1177                     IF NOT FOUND THEN -- create one
1178                         INSERT INTO asset.uri (label, href, use_restriction) VALUES (uri_label, uri_href, uri_use);
1179                         SELECT id INTO uri_id
1180                             FROM asset.uri
1181                             WHERE label = uri_label AND href = uri_href AND use_restriction IS NULL AND active;
1182                     END IF;
1183                 ELSE
1184                     SELECT id INTO uri_id
1185                         FROM asset.uri
1186                         WHERE label = uri_label AND href = uri_href AND use_restriction = uri_use AND active
1187                         ORDER BY id LIMIT 1;
1188                     IF NOT FOUND THEN -- create one
1189                         INSERT INTO asset.uri (label, href, use_restriction) VALUES (uri_label, uri_href, uri_use);
1190                         SELECT id INTO uri_id
1191                             FROM asset.uri
1192                             WHERE label = uri_label AND href = uri_href AND use_restriction = uri_use AND active;
1193                     END IF;
1194                 END IF;
1195
1196                 FOR j IN 1 .. ARRAY_UPPER(uri_owner_list, 1) LOOP
1197                     uri_owner := uri_owner_list[j];
1198
1199                     SELECT id INTO uri_owner_id FROM actor.org_unit WHERE shortname = uri_owner;
1200                     CONTINUE WHEN NOT FOUND;
1201
1202                     -- we need a call number to link through
1203                     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;
1204                     IF NOT FOUND THEN
1205                         INSERT INTO asset.call_number (owning_lib, record, create_date, edit_date, creator, editor, label)
1206                             VALUES (uri_owner_id, bib_id, 'now', 'now', editor_id, editor_id, '##URI##');
1207                         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;
1208                     END IF;
1209
1210                     -- now, link them if they're not already
1211                     SELECT id INTO uri_map_id FROM asset.uri_call_number_map WHERE call_number = uri_cn_id AND uri = uri_id;
1212                     IF NOT FOUND THEN
1213                         INSERT INTO asset.uri_call_number_map (call_number, uri) VALUES (uri_cn_id, uri_id);
1214                     END IF;
1215
1216                 END LOOP;
1217
1218             END IF;
1219
1220         END LOOP;
1221     END IF;
1222
1223     RETURN;
1224 END;
1225 $func$ LANGUAGE PLPGSQL;
1226
1227 CREATE OR REPLACE FUNCTION metabib.remap_metarecord_for_bib( bib_id BIGINT, fp TEXT, bib_is_deleted BOOL DEFAULT FALSE, retain_deleted BOOL DEFAULT FALSE ) RETURNS BIGINT AS $func$
1228 DECLARE
1229     new_mapping     BOOL := TRUE;
1230     source_count    INT;
1231     old_mr          BIGINT;
1232     tmp_mr          metabib.metarecord%ROWTYPE;
1233     deleted_mrs     BIGINT[];
1234 BEGIN
1235
1236     -- We need to make sure we're not a deleted master record of an MR
1237     IF bib_is_deleted THEN
1238         FOR old_mr IN SELECT id FROM metabib.metarecord WHERE master_record = bib_id LOOP
1239
1240             IF NOT retain_deleted THEN -- Go away for any MR that we're master of, unless retained
1241                 DELETE FROM metabib.metarecord_source_map WHERE source = bib_id;
1242             END IF;
1243
1244             -- Now, are there any more sources on this MR?
1245             SELECT COUNT(*) INTO source_count FROM metabib.metarecord_source_map WHERE metarecord = old_mr;
1246
1247             IF source_count = 0 AND NOT retain_deleted THEN -- No other records
1248                 deleted_mrs := ARRAY_APPEND(deleted_mrs, old_mr); -- Just in case...
1249                 DELETE FROM metabib.metarecord WHERE id = old_mr;
1250
1251             ELSE -- indeed there are. Update it with a null cache and recalcualated master record
1252                 UPDATE  metabib.metarecord
1253                   SET   mods = NULL,
1254                         master_record = ( SELECT id FROM biblio.record_entry WHERE fingerprint = fp AND NOT deleted ORDER BY quality DESC LIMIT 1)
1255                   WHERE id = old_mr;
1256             END IF;
1257         END LOOP;
1258
1259     ELSE -- insert or update
1260
1261         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
1262
1263             -- Find the first fingerprint-matching
1264             IF old_mr IS NULL AND fp = tmp_mr.fingerprint THEN
1265                 old_mr := tmp_mr.id;
1266                 new_mapping := FALSE;
1267
1268             ELSE -- Our fingerprint changed ... maybe remove the old MR
1269                 DELETE FROM metabib.metarecord_source_map WHERE metarecord = old_mr AND source = bib_id; -- remove the old source mapping
1270                 SELECT COUNT(*) INTO source_count FROM metabib.metarecord_source_map WHERE metarecord = tmp_mr.id;
1271                 IF source_count = 0 THEN -- No other records
1272                     deleted_mrs := ARRAY_APPEND(deleted_mrs, tmp_mr.id);
1273                     DELETE FROM metabib.metarecord WHERE id = tmp_mr.id;
1274                 END IF;
1275             END IF;
1276
1277         END LOOP;
1278
1279         -- we found no suitable, preexisting MR based on old source maps
1280         IF old_mr IS NULL THEN
1281             SELECT id INTO old_mr FROM metabib.metarecord WHERE fingerprint = fp; -- is there one for our current fingerprint?
1282
1283             IF old_mr IS NULL THEN -- nope, create one and grab its id
1284                 INSERT INTO metabib.metarecord ( fingerprint, master_record ) VALUES ( fp, bib_id );
1285                 SELECT id INTO old_mr FROM metabib.metarecord WHERE fingerprint = fp;
1286
1287             ELSE -- indeed there is. update it with a null cache and recalcualated master record
1288                 UPDATE  metabib.metarecord
1289                   SET   mods = NULL,
1290                         master_record = ( SELECT id FROM biblio.record_entry WHERE fingerprint = fp AND NOT deleted ORDER BY quality DESC LIMIT 1)
1291                   WHERE id = old_mr;
1292             END IF;
1293
1294         ELSE -- there was one we already attached to, update its mods cache and master_record
1295             UPDATE  metabib.metarecord
1296               SET   mods = NULL,
1297                     master_record = ( SELECT id FROM biblio.record_entry WHERE fingerprint = fp AND NOT deleted ORDER BY quality DESC LIMIT 1)
1298               WHERE id = old_mr;
1299         END IF;
1300
1301         IF new_mapping THEN
1302             INSERT INTO metabib.metarecord_source_map (metarecord, source) VALUES (old_mr, bib_id); -- new source mapping
1303         END IF;
1304
1305     END IF;
1306
1307     IF ARRAY_UPPER(deleted_mrs,1) > 0 THEN
1308         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
1309     END IF;
1310
1311     RETURN old_mr;
1312
1313 END;
1314 $func$ LANGUAGE PLPGSQL;
1315
1316
1317 CREATE OR REPLACE FUNCTION biblio.map_authority_linking (bibid BIGINT, marc TEXT) RETURNS BIGINT AS $func$
1318     DELETE FROM authority.bib_linking WHERE bib = $1;
1319     INSERT INTO authority.bib_linking (bib, authority)
1320         SELECT  y.bib,
1321                 y.authority
1322           FROM (    SELECT  DISTINCT $1 AS bib,
1323                             BTRIM(remove_paren_substring(txt))::BIGINT AS authority
1324                       FROM  unnest(oils_xpath('//*[@code="0"]/text()',$2)) x(txt)
1325                       WHERE BTRIM(remove_paren_substring(txt)) ~ $re$^\d+$$re$
1326                 ) y JOIN authority.record_entry r ON r.id = y.authority;
1327     SELECT $1;
1328 $func$ LANGUAGE SQL;
1329
1330 CREATE OR REPLACE FUNCTION metabib.reingest_record_attributes (rid BIGINT, pattr_list TEXT[] DEFAULT NULL, prmarc TEXT DEFAULT NULL, rdeleted BOOL DEFAULT TRUE) RETURNS VOID AS $func$
1331 DECLARE
1332     transformed_xml TEXT;
1333     rmarc           TEXT := prmarc;
1334     tmp_val         TEXT;
1335     prev_xfrm       TEXT;
1336     normalizer      RECORD;
1337     xfrm            config.xml_transform%ROWTYPE;
1338     attr_vector     INT[] := '{}'::INT[];
1339     attr_vector_tmp INT[];
1340     attr_list       TEXT[] := pattr_list;
1341     attr_value      TEXT[];
1342     norm_attr_value TEXT[];
1343     tmp_xml         TEXT;
1344     attr_def        config.record_attr_definition%ROWTYPE;
1345     ccvm_row        config.coded_value_map%ROWTYPE;
1346 BEGIN
1347
1348     IF attr_list IS NULL OR rdeleted THEN -- need to do the full dance on INSERT or undelete
1349         SELECT ARRAY_AGG(name) INTO attr_list FROM config.record_attr_definition;
1350     END IF;
1351
1352     IF rmarc IS NULL THEN
1353         SELECT marc INTO rmarc FROM biblio.record_entry WHERE id = rid;
1354     END IF;
1355
1356     FOR attr_def IN SELECT * FROM config.record_attr_definition WHERE NOT composite AND name = ANY( attr_list ) ORDER BY format LOOP
1357
1358         attr_value := '{}'::TEXT[];
1359         norm_attr_value := '{}'::TEXT[];
1360         attr_vector_tmp := '{}'::INT[];
1361
1362         SELECT * INTO ccvm_row FROM config.coded_value_map c WHERE c.ctype = attr_def.name LIMIT 1;
1363
1364         -- tag+sf attrs only support SVF
1365         IF attr_def.tag IS NOT NULL THEN -- tag (and optional subfield list) selection
1366             SELECT  ARRAY[ARRAY_TO_STRING(ARRAY_AGG(value), COALESCE(attr_def.joiner,' '))] INTO attr_value
1367               FROM  (SELECT * FROM metabib.full_rec ORDER BY tag, subfield) AS x
1368               WHERE record = rid
1369                     AND tag LIKE attr_def.tag
1370                     AND CASE
1371                         WHEN attr_def.sf_list IS NOT NULL
1372                             THEN POSITION(subfield IN attr_def.sf_list) > 0
1373                         ELSE TRUE
1374                     END
1375               GROUP BY tag
1376               ORDER BY tag
1377               LIMIT 1;
1378
1379         ELSIF attr_def.fixed_field IS NOT NULL THEN -- a named fixed field, see config.marc21_ff_pos_map.fixed_field
1380             attr_value := vandelay.marc21_extract_fixed_field_list(rmarc, attr_def.fixed_field);
1381
1382             IF NOT attr_def.multi THEN
1383                 attr_value := ARRAY[attr_value[1]];
1384             END IF;
1385
1386         ELSIF attr_def.xpath IS NOT NULL THEN -- and xpath expression
1387
1388             SELECT INTO xfrm * FROM config.xml_transform WHERE name = attr_def.format;
1389
1390             -- See if we can skip the XSLT ... it's expensive
1391             IF prev_xfrm IS NULL OR prev_xfrm <> xfrm.name THEN
1392                 -- Can't skip the transform
1393                 IF xfrm.xslt <> '---' THEN
1394                     transformed_xml := oils_xslt_process(rmarc,xfrm.xslt);
1395                 ELSE
1396                     transformed_xml := rmarc;
1397                 END IF;
1398
1399                 prev_xfrm := xfrm.name;
1400             END IF;
1401
1402             IF xfrm.name IS NULL THEN
1403                 -- just grab the marcxml (empty) transform
1404                 SELECT INTO xfrm * FROM config.xml_transform WHERE xslt = '---' LIMIT 1;
1405                 prev_xfrm := xfrm.name;
1406             END IF;
1407
1408             FOR tmp_xml IN SELECT oils_xpath(attr_def.xpath, transformed_xml, ARRAY[ARRAY[xfrm.prefix, xfrm.namespace_uri]]) LOOP
1409                 tmp_val := oils_xpath_string(
1410                                 '//*',
1411                                 tmp_xml,
1412                                 COALESCE(attr_def.joiner,' '),
1413                                 ARRAY[ARRAY[xfrm.prefix, xfrm.namespace_uri]]
1414                             );
1415                 IF tmp_val IS NOT NULL AND BTRIM(tmp_val) <> '' THEN
1416                     attr_value := attr_value || tmp_val;
1417                     EXIT WHEN NOT attr_def.multi;
1418                 END IF;
1419             END LOOP;
1420
1421         ELSIF attr_def.phys_char_sf IS NOT NULL THEN -- a named Physical Characteristic, see config.marc21_physical_characteristic_*_map
1422             SELECT  ARRAY_AGG(m.value) INTO attr_value
1423               FROM  vandelay.marc21_physical_characteristics(rmarc) v
1424                     LEFT JOIN config.marc21_physical_characteristic_value_map m ON (m.id = v.value)
1425               WHERE v.subfield = attr_def.phys_char_sf AND (m.value IS NOT NULL AND BTRIM(m.value) <> '')
1426                     AND ( ccvm_row.id IS NULL OR ( ccvm_row.id IS NOT NULL AND v.id IS NOT NULL) );
1427
1428             IF NOT attr_def.multi THEN
1429                 attr_value := ARRAY[attr_value[1]];
1430             END IF;
1431
1432         END IF;
1433
1434                 -- apply index normalizers to attr_value
1435         FOR tmp_val IN SELECT value FROM UNNEST(attr_value) x(value) LOOP
1436             FOR normalizer IN
1437                 SELECT  n.func AS func,
1438                         n.param_count AS param_count,
1439                         m.params AS params
1440                   FROM  config.index_normalizer n
1441                         JOIN config.record_attr_index_norm_map m ON (m.norm = n.id)
1442                   WHERE attr = attr_def.name
1443                   ORDER BY m.pos LOOP
1444                     EXECUTE 'SELECT ' || normalizer.func || '(' ||
1445                     COALESCE( quote_literal( tmp_val ), 'NULL' ) ||
1446                         CASE
1447                             WHEN normalizer.param_count > 0
1448                                 THEN ',' || REPLACE(REPLACE(BTRIM(normalizer.params,'[]'),E'\'',E'\\\''),E'"',E'\'')
1449                                 ELSE ''
1450                             END ||
1451                     ')' INTO tmp_val;
1452
1453             END LOOP;
1454             IF tmp_val IS NOT NULL AND BTRIM(tmp_val) <> '' THEN
1455                 norm_attr_value := norm_attr_value || tmp_val;
1456             END IF;
1457         END LOOP;
1458
1459         IF attr_def.filter THEN
1460             -- Create unknown uncontrolled values and find the IDs of the values
1461             IF ccvm_row.id IS NULL THEN
1462                 FOR tmp_val IN SELECT value FROM UNNEST(norm_attr_value) x(value) LOOP
1463                     IF tmp_val IS NOT NULL AND BTRIM(tmp_val) <> '' THEN
1464                         BEGIN -- use subtransaction to isolate unique constraint violations
1465                             INSERT INTO metabib.uncontrolled_record_attr_value ( attr, value ) VALUES ( attr_def.name, tmp_val );
1466                         EXCEPTION WHEN unique_violation THEN END;
1467                     END IF;
1468                 END LOOP;
1469
1470                 SELECT ARRAY_AGG(id) INTO attr_vector_tmp FROM metabib.uncontrolled_record_attr_value WHERE attr = attr_def.name AND value = ANY( norm_attr_value );
1471             ELSE
1472                 SELECT ARRAY_AGG(id) INTO attr_vector_tmp FROM config.coded_value_map WHERE ctype = attr_def.name AND code = ANY( norm_attr_value );
1473             END IF;
1474
1475             -- Add the new value to the vector
1476             attr_vector := attr_vector || attr_vector_tmp;
1477         END IF;
1478
1479         IF attr_def.sorter AND norm_attr_value[1] IS NOT NULL THEN
1480             DELETE FROM metabib.record_sorter WHERE source = rid AND attr = attr_def.name;
1481             INSERT INTO metabib.record_sorter (source, attr, value) VALUES (rid, attr_def.name, norm_attr_value[1]);
1482         END IF;
1483
1484     END LOOP;
1485
1486 /* We may need to rewrite the vlist to contain
1487    the intersection of new values for requested
1488    attrs and old values for ignored attrs. To
1489    do this, we take the old attr vlist and
1490    subtract any values that are valid for the
1491    requested attrs, and then add back the new
1492    set of attr values. */
1493
1494     IF ARRAY_LENGTH(pattr_list, 1) > 0 THEN
1495         SELECT vlist INTO attr_vector_tmp FROM metabib.record_attr_vector_list WHERE source = rid;
1496         SELECT attr_vector_tmp - ARRAY_AGG(id::INT) INTO attr_vector_tmp FROM metabib.full_attr_id_map WHERE attr = ANY (pattr_list);
1497         attr_vector := attr_vector || attr_vector_tmp;
1498     END IF;
1499
1500     -- On to composite attributes, now that the record attrs have been pulled.  Processed in name order, so later composite
1501     -- attributes can depend on earlier ones.
1502     PERFORM metabib.compile_composite_attr_cache_init();
1503     FOR attr_def IN SELECT * FROM config.record_attr_definition WHERE composite AND name = ANY( attr_list ) ORDER BY name LOOP
1504
1505         FOR ccvm_row IN SELECT * FROM config.coded_value_map c WHERE c.ctype = attr_def.name ORDER BY value LOOP
1506
1507             tmp_val := metabib.compile_composite_attr( ccvm_row.id );
1508             CONTINUE WHEN tmp_val IS NULL OR tmp_val = ''; -- nothing to do
1509
1510             IF attr_def.filter THEN
1511                 IF attr_vector @@ tmp_val::query_int THEN
1512                     attr_vector = attr_vector + intset(ccvm_row.id);
1513                     EXIT WHEN NOT attr_def.multi;
1514                 END IF;
1515             END IF;
1516
1517             IF attr_def.sorter THEN
1518                 IF attr_vector @@ tmp_val THEN
1519                     DELETE FROM metabib.record_sorter WHERE source = rid AND attr = attr_def.name;
1520                     INSERT INTO metabib.record_sorter (source, attr, value) VALUES (rid, attr_def.name, ccvm_row.code);
1521                 END IF;
1522             END IF;
1523
1524         END LOOP;
1525
1526     END LOOP;
1527
1528     IF ARRAY_LENGTH(attr_vector, 1) > 0 THEN
1529         IF rdeleted THEN -- initial insert OR revivication
1530             DELETE FROM metabib.record_attr_vector_list WHERE source = rid;
1531             INSERT INTO metabib.record_attr_vector_list (source, vlist) VALUES (rid, attr_vector);
1532         ELSE
1533             UPDATE metabib.record_attr_vector_list SET vlist = attr_vector WHERE source = rid;
1534         END IF;
1535     END IF;
1536
1537 END;
1538
1539 $func$ LANGUAGE PLPGSQL;
1540
1541
1542 -- AFTER UPDATE OR INSERT trigger for biblio.record_entry
1543 CREATE OR REPLACE FUNCTION biblio.indexing_ingest_or_delete () RETURNS TRIGGER AS $func$
1544 DECLARE
1545     tmp_bool BOOL;
1546 BEGIN
1547
1548     IF NEW.deleted THEN -- If this bib is deleted
1549
1550         PERFORM * FROM config.internal_flag WHERE
1551             name = 'ingest.metarecord_mapping.preserve_on_delete' AND enabled;
1552
1553         tmp_bool := FOUND; -- Just in case this is changed by some other statement
1554
1555         PERFORM metabib.remap_metarecord_for_bib( NEW.id, NEW.fingerprint, TRUE, tmp_bool );
1556
1557         IF NOT tmp_bool THEN
1558             -- One needs to keep these around to support searches
1559             -- with the #deleted modifier, so one should turn on the named
1560             -- internal flag for that functionality.
1561             DELETE FROM metabib.record_attr_vector_list WHERE source = NEW.id;
1562         END IF;
1563
1564         DELETE FROM authority.bib_linking WHERE bib = NEW.id; -- Avoid updating fields in bibs that are no longer visible
1565         DELETE FROM biblio.peer_bib_copy_map WHERE peer_record = NEW.id; -- Separate any multi-homed items
1566         DELETE FROM metabib.browse_entry_def_map WHERE source = NEW.id; -- Don't auto-suggest deleted bibs
1567         RETURN NEW; -- and we're done
1568     END IF;
1569
1570     IF TG_OP = 'UPDATE' THEN -- re-ingest?
1571         PERFORM * FROM config.internal_flag WHERE name = 'ingest.reingest.force_on_same_marc' AND enabled;
1572
1573         IF NOT FOUND AND OLD.marc = NEW.marc THEN -- don't do anything if the MARC didn't change
1574             RETURN NEW;
1575         END IF;
1576     END IF;
1577
1578     -- Record authority linking
1579     PERFORM * FROM config.internal_flag WHERE name = 'ingest.disable_authority_linking' AND enabled;
1580     IF NOT FOUND THEN
1581         PERFORM biblio.map_authority_linking( NEW.id, NEW.marc );
1582     END IF;
1583
1584     -- Flatten and insert the mfr data
1585     PERFORM * FROM config.internal_flag WHERE name = 'ingest.disable_metabib_full_rec' AND enabled;
1586     IF NOT FOUND THEN
1587         PERFORM metabib.reingest_metabib_full_rec(NEW.id);
1588
1589         -- Now we pull out attribute data, which is dependent on the mfr for all but XPath-based fields
1590         PERFORM * FROM config.internal_flag WHERE name = 'ingest.disable_metabib_rec_descriptor' AND enabled;
1591         IF NOT FOUND THEN
1592             PERFORM metabib.reingest_record_attributes(NEW.id, NULL, NEW.marc, TG_OP = 'INSERT' OR OLD.deleted);
1593         END IF;
1594     END IF;
1595
1596     -- Gather and insert the field entry data
1597     PERFORM metabib.reingest_metabib_field_entries(NEW.id);
1598
1599     -- Located URI magic
1600     IF TG_OP = 'INSERT' THEN
1601         PERFORM * FROM config.internal_flag WHERE name = 'ingest.disable_located_uri' AND enabled;
1602         IF NOT FOUND THEN
1603             PERFORM biblio.extract_located_uris( NEW.id, NEW.marc, NEW.editor );
1604         END IF;
1605     ELSE
1606         PERFORM * FROM config.internal_flag WHERE name = 'ingest.disable_located_uri' AND enabled;
1607         IF NOT FOUND THEN
1608             PERFORM biblio.extract_located_uris( NEW.id, NEW.marc, NEW.editor );
1609         END IF;
1610     END IF;
1611
1612     -- (re)map metarecord-bib linking
1613     IF TG_OP = 'INSERT' THEN -- if not deleted and performing an insert, check for the flag
1614         PERFORM * FROM config.internal_flag WHERE name = 'ingest.metarecord_mapping.skip_on_insert' AND enabled;
1615         IF NOT FOUND THEN
1616             PERFORM metabib.remap_metarecord_for_bib( NEW.id, NEW.fingerprint );
1617         END IF;
1618     ELSE -- we're doing an update, and we're not deleted, remap
1619         PERFORM * FROM config.internal_flag WHERE name = 'ingest.metarecord_mapping.skip_on_update' AND enabled;
1620         IF NOT FOUND THEN
1621             PERFORM metabib.remap_metarecord_for_bib( NEW.id, NEW.fingerprint );
1622         END IF;
1623     END IF;
1624
1625     RETURN NEW;
1626 END;
1627 $func$ LANGUAGE PLPGSQL;
1628
1629 CREATE OR REPLACE FUNCTION metabib.browse_normalize(facet_text TEXT, mapped_field INT) RETURNS TEXT AS $$
1630 DECLARE
1631     normalizer  RECORD;
1632 BEGIN
1633
1634     FOR normalizer IN
1635         SELECT  n.func AS func,
1636                 n.param_count AS param_count,
1637                 m.params AS params
1638           FROM  config.index_normalizer n
1639                 JOIN config.metabib_field_index_norm_map m ON (m.norm = n.id)
1640           WHERE m.field = mapped_field AND m.pos < 0
1641           ORDER BY m.pos LOOP
1642
1643             EXECUTE 'SELECT ' || normalizer.func || '(' ||
1644                 quote_literal( facet_text ) ||
1645                 CASE
1646                     WHEN normalizer.param_count > 0
1647                         THEN ',' || REPLACE(REPLACE(BTRIM(normalizer.params,'[]'),E'\'',E'\\\''),E'"',E'\'')
1648                         ELSE ''
1649                     END ||
1650                 ')' INTO facet_text;
1651
1652     END LOOP;
1653
1654     RETURN facet_text;
1655 END;
1656
1657 $$ LANGUAGE PLPGSQL;
1658
1659
1660 -- This mimics a specific part of QueryParser, turning the first part of a
1661 -- classed search (search_class) into a set of classes and possibly fields.
1662 -- search_class might look like "author" or "title|proper" or "ti|uniform"
1663 -- or "au" or "au|corporate|personal" or anything like that, where the first
1664 -- element of the list you get by separating on the "|" character is either
1665 -- a registered class (config.metabib_class) or an alias
1666 -- (config.metabib_search_alias), and the rest of any such elements are
1667 -- fields (config.metabib_field).
1668 CREATE OR REPLACE
1669     FUNCTION metabib.search_class_to_registered_components(search_class TEXT)
1670     RETURNS SETOF RECORD AS $func$
1671 DECLARE
1672     search_parts        TEXT[];
1673     field_name          TEXT;
1674     search_part_count   INTEGER;
1675     rec                 RECORD;
1676     registered_class    config.metabib_class%ROWTYPE;
1677     registered_alias    config.metabib_search_alias%ROWTYPE;
1678     registered_field    config.metabib_field%ROWTYPE;
1679 BEGIN
1680     search_parts := REGEXP_SPLIT_TO_ARRAY(search_class, E'\\|');
1681
1682     search_part_count := ARRAY_LENGTH(search_parts, 1);
1683     IF search_part_count = 0 THEN
1684         RETURN;
1685     ELSE
1686         SELECT INTO registered_class
1687             * FROM config.metabib_class WHERE name = search_parts[1];
1688         IF FOUND THEN
1689             IF search_part_count < 2 THEN   -- all fields
1690                 rec := (registered_class.name, NULL::INTEGER);
1691                 RETURN NEXT rec;
1692                 RETURN; -- done
1693             END IF;
1694             FOR field_name IN SELECT *
1695                 FROM UNNEST(search_parts[2:search_part_count]) LOOP
1696                 SELECT INTO registered_field
1697                     * FROM config.metabib_field
1698                     WHERE name = field_name AND
1699                         field_class = registered_class.name;
1700                 IF FOUND THEN
1701                     rec := (registered_class.name, registered_field.id);
1702                     RETURN NEXT rec;
1703                 END IF;
1704             END LOOP;
1705         ELSE
1706             -- maybe we have an alias?
1707             SELECT INTO registered_alias
1708                 * FROM config.metabib_search_alias WHERE alias=search_parts[1];
1709             IF NOT FOUND THEN
1710                 RETURN;
1711             ELSE
1712                 IF search_part_count < 2 THEN   -- return w/e the alias says
1713                     rec := (
1714                         registered_alias.field_class, registered_alias.field
1715                     );
1716                     RETURN NEXT rec;
1717                     RETURN; -- done
1718                 ELSE
1719                     FOR field_name IN SELECT *
1720                         FROM UNNEST(search_parts[2:search_part_count]) LOOP
1721                         SELECT INTO registered_field
1722                             * FROM config.metabib_field
1723                             WHERE name = field_name AND
1724                                 field_class = registered_alias.field_class;
1725                         IF FOUND THEN
1726                             rec := (
1727                                 registered_alias.field_class,
1728                                 registered_field.id
1729                             );
1730                             RETURN NEXT rec;
1731                         END IF;
1732                     END LOOP;
1733                 END IF;
1734             END IF;
1735         END IF;
1736     END IF;
1737 END;
1738 $func$ LANGUAGE PLPGSQL ROWS 1;
1739
1740
1741 -- Given a string such as a user might type into a search box, prepare
1742 -- two changed variants for TO_TSQUERY(). See
1743 -- http://www.postgresql.org/docs/9.0/static/textsearch-controls.html
1744 -- The first variant is normalized to match indexed documents regardless
1745 -- of diacritics.  The second variant keeps its diacritics for proper
1746 -- highlighting via TS_HEADLINE().
1747 CREATE OR REPLACE
1748     FUNCTION metabib.autosuggest_prepare_tsquery(orig TEXT) RETURNS TEXT[] AS
1749 $$
1750 DECLARE
1751     orig_ended_in_space     BOOLEAN;
1752     result                  RECORD;
1753     plain                   TEXT;
1754     normalized              TEXT;
1755 BEGIN
1756     orig_ended_in_space := orig ~ E'\\s$';
1757
1758     orig := ARRAY_TO_STRING(
1759         evergreen.regexp_split_to_array(orig, E'\\W+'), ' '
1760     );
1761
1762     normalized := public.naco_normalize(orig); -- also trim()s
1763     plain := trim(orig);
1764
1765     IF NOT orig_ended_in_space THEN
1766         plain := plain || ':*';
1767         normalized := normalized || ':*';
1768     END IF;
1769
1770     plain := ARRAY_TO_STRING(
1771         evergreen.regexp_split_to_array(plain, E'\\s+'), ' & '
1772     );
1773     normalized := ARRAY_TO_STRING(
1774         evergreen.regexp_split_to_array(normalized, E'\\s+'), ' & '
1775     );
1776
1777     RETURN ARRAY[normalized, plain];
1778 END;
1779 $$ LANGUAGE PLPGSQL;
1780
1781
1782 CREATE OR REPLACE
1783     FUNCTION metabib.suggest_browse_entries(
1784         raw_query_text  TEXT,   -- actually typed by humans at the UI level
1785         search_class    TEXT,   -- 'alias' or 'class' or 'class|field..', etc
1786         headline_opts   TEXT,   -- markup options for ts_headline()
1787         visibility_org  INTEGER,-- null if you don't want opac visibility test
1788         query_limit     INTEGER,-- use in LIMIT clause of interal query
1789         normalization   INTEGER -- argument to TS_RANK_CD()
1790     ) RETURNS TABLE (
1791         value                   TEXT,   -- plain
1792         field                   INTEGER,
1793         buoyant_and_class_match BOOL,
1794         field_match             BOOL,
1795         field_weight            INTEGER,
1796         rank                    REAL,
1797         buoyant                 BOOL,
1798         match                   TEXT    -- marked up
1799     ) AS $func$
1800 DECLARE
1801     prepared_query_texts    TEXT[];
1802     query                   TSQUERY;
1803     plain_query             TSQUERY;
1804     opac_visibility_join    TEXT;
1805     search_class_join       TEXT;
1806     r_fields                RECORD;
1807 BEGIN
1808     prepared_query_texts := metabib.autosuggest_prepare_tsquery(raw_query_text);
1809
1810     query := TO_TSQUERY('keyword', prepared_query_texts[1]);
1811     plain_query := TO_TSQUERY('keyword', prepared_query_texts[2]);
1812
1813     visibility_org := NULLIF(visibility_org,-1);
1814     IF visibility_org IS NOT NULL THEN
1815         opac_visibility_join := '
1816     JOIN asset.opac_visible_copies aovc ON (
1817         aovc.record = x.source AND
1818         aovc.circ_lib IN (SELECT id FROM actor.org_unit_descendants($4))
1819     )';
1820     ELSE
1821         opac_visibility_join := '';
1822     END IF;
1823
1824     -- The following determines whether we only provide suggestsons matching
1825     -- the user's selected search_class, or whether we show other suggestions
1826     -- too. The reason for MIN() is that for search_classes like
1827     -- 'title|proper|uniform' you would otherwise get multiple rows.  The
1828     -- implication is that if title as a class doesn't have restrict,
1829     -- nor does the proper field, but the uniform field does, you're going
1830     -- to get 'false' for your overall evaluation of 'should we restrict?'
1831     -- To invert that, change from MIN() to MAX().
1832
1833     SELECT
1834         INTO r_fields
1835             MIN(cmc.restrict::INT) AS restrict_class,
1836             MIN(cmf.restrict::INT) AS restrict_field
1837         FROM metabib.search_class_to_registered_components(search_class)
1838             AS _registered (field_class TEXT, field INT)
1839         JOIN
1840             config.metabib_class cmc ON (cmc.name = _registered.field_class)
1841         LEFT JOIN
1842             config.metabib_field cmf ON (cmf.id = _registered.field);
1843
1844     -- evaluate 'should we restrict?'
1845     IF r_fields.restrict_field::BOOL OR r_fields.restrict_class::BOOL THEN
1846         search_class_join := '
1847     JOIN
1848         metabib.search_class_to_registered_components($2)
1849         AS _registered (field_class TEXT, field INT) ON (
1850             (_registered.field IS NULL AND
1851                 _registered.field_class = cmf.field_class) OR
1852             (_registered.field = cmf.id)
1853         )
1854     ';
1855     ELSE
1856         search_class_join := '
1857     LEFT JOIN
1858         metabib.search_class_to_registered_components($2)
1859         AS _registered (field_class TEXT, field INT) ON (
1860             _registered.field_class = cmc.name
1861         )
1862     ';
1863     END IF;
1864
1865     RETURN QUERY EXECUTE '
1866 SELECT  DISTINCT
1867         x.value,
1868         x.id,
1869         x.push,
1870         x.restrict,
1871         x.weight,
1872         x.ts_rank_cd,
1873         x.buoyant,
1874         TS_HEADLINE(value, $7, $3)
1875   FROM  (SELECT DISTINCT
1876                 mbe.value,
1877                 cmf.id,
1878                 cmc.buoyant AND _registered.field_class IS NOT NULL AS push,
1879                 _registered.field = cmf.id AS restrict,
1880                 cmf.weight,
1881                 TS_RANK_CD(mbe.index_vector, $1, $6),
1882                 cmc.buoyant,
1883                 mbedm.source
1884           FROM  metabib.browse_entry_def_map mbedm
1885                 JOIN (SELECT * FROM metabib.browse_entry WHERE index_vector @@ $1 LIMIT 10000) mbe ON (mbe.id = mbedm.entry)
1886                 JOIN config.metabib_field cmf ON (cmf.id = mbedm.def)
1887                 JOIN config.metabib_class cmc ON (cmf.field_class = cmc.name)
1888                 '  || search_class_join || '
1889           ORDER BY 3 DESC, 4 DESC NULLS LAST, 5 DESC, 6 DESC, 7 DESC, 1 ASC
1890           LIMIT 1000) AS x
1891         ' || opac_visibility_join || '
1892   ORDER BY 3 DESC, 4 DESC NULLS LAST, 5 DESC, 6 DESC, 7 DESC, 1 ASC
1893   LIMIT $5
1894 '   -- sic, repeat the order by clause in the outer select too
1895     USING
1896         query, search_class, headline_opts,
1897         visibility_org, query_limit, normalization, plain_query
1898         ;
1899
1900     -- sort order:
1901     --  buoyant AND chosen class = match class
1902     --  chosen field = match field
1903     --  field weight
1904     --  rank
1905     --  buoyancy
1906     --  value itself
1907
1908 END;
1909 $func$ LANGUAGE PLPGSQL;
1910
1911 CREATE OR REPLACE FUNCTION public.oils_tsearch2 () RETURNS TRIGGER AS $$
1912 DECLARE
1913     normalizer      RECORD;
1914     value           TEXT := '';
1915     temp_vector     TEXT := '';
1916     ts_rec          RECORD;
1917     cur_weight      "char";
1918 BEGIN
1919
1920     value := NEW.value;
1921     NEW.index_vector = ''::tsvector;
1922
1923     IF TG_TABLE_NAME::TEXT ~ 'field_entry$' THEN
1924         FOR normalizer IN
1925             SELECT  n.func AS func,
1926                     n.param_count AS param_count,
1927                     m.params AS params
1928               FROM  config.index_normalizer n
1929                     JOIN config.metabib_field_index_norm_map m ON (m.norm = n.id)
1930               WHERE field = NEW.field AND m.pos < 0
1931               ORDER BY m.pos LOOP
1932                 EXECUTE 'SELECT ' || normalizer.func || '(' ||
1933                     quote_literal( value ) ||
1934                     CASE
1935                         WHEN normalizer.param_count > 0
1936                             THEN ',' || REPLACE(REPLACE(BTRIM(normalizer.params,'[]'),E'\'',E'\\\''),E'"',E'\'')
1937                             ELSE ''
1938                         END ||
1939                     ')' INTO value;
1940
1941         END LOOP;
1942
1943         NEW.value = value;
1944
1945         FOR normalizer IN
1946             SELECT  n.func AS func,
1947                     n.param_count AS param_count,
1948                     m.params AS params
1949               FROM  config.index_normalizer n
1950                     JOIN config.metabib_field_index_norm_map m ON (m.norm = n.id)
1951               WHERE field = NEW.field AND m.pos >= 0
1952               ORDER BY m.pos LOOP
1953                 EXECUTE 'SELECT ' || normalizer.func || '(' ||
1954                     quote_literal( value ) ||
1955                     CASE
1956                         WHEN normalizer.param_count > 0
1957                             THEN ',' || REPLACE(REPLACE(BTRIM(normalizer.params,'[]'),E'\'',E'\\\''),E'"',E'\'')
1958                             ELSE ''
1959                         END ||
1960                     ')' INTO value;
1961
1962         END LOOP;
1963    END IF;
1964
1965     IF TG_TABLE_NAME::TEXT ~ 'browse_entry$' THEN
1966
1967         value :=  ARRAY_TO_STRING(
1968             evergreen.regexp_split_to_array(value, E'\\W+'), ' '
1969         );
1970         value := public.search_normalize(value);
1971         NEW.index_vector = to_tsvector(TG_ARGV[0]::regconfig, value);
1972
1973     ELSIF TG_TABLE_NAME::TEXT ~ 'field_entry$' THEN
1974         FOR ts_rec IN
1975
1976             SELECT DISTINCT m.ts_config, m.index_weight
1977             FROM config.metabib_class_ts_map m
1978                  LEFT JOIN metabib.record_attr_vector_list r ON (r.source = NEW.source)
1979                  LEFT JOIN config.coded_value_map ccvm ON (
1980                     ccvm.ctype IN ('item_lang', 'language') AND
1981                     ccvm.code = m.index_lang AND
1982                     r.vlist @> intset(ccvm.id)
1983                 )
1984             WHERE m.field_class = TG_ARGV[0]
1985                 AND m.active
1986                 AND (m.always OR NOT EXISTS (SELECT 1 FROM config.metabib_field_ts_map WHERE metabib_field = NEW.field))
1987                 AND (m.index_lang IS NULL OR ccvm.id IS NOT NULL)
1988                         UNION
1989             SELECT DISTINCT m.ts_config, m.index_weight
1990             FROM config.metabib_field_ts_map m
1991                  LEFT JOIN metabib.record_attr_vector_list r ON (r.source = NEW.source)
1992                  LEFT JOIN config.coded_value_map ccvm ON (
1993                     ccvm.ctype IN ('item_lang', 'language') AND
1994                     ccvm.code = m.index_lang AND
1995                     r.vlist @> intset(ccvm.id)
1996                 )
1997             WHERE m.metabib_field = NEW.field
1998                 AND m.active
1999                 AND (m.index_lang IS NULL OR ccvm.id IS NOT NULL)
2000             ORDER BY index_weight ASC
2001
2002         LOOP
2003
2004             IF cur_weight IS NOT NULL AND cur_weight != ts_rec.index_weight THEN
2005                 NEW.index_vector = NEW.index_vector || setweight(temp_vector::tsvector,cur_weight);
2006                 temp_vector = '';
2007             END IF;
2008
2009             cur_weight = ts_rec.index_weight;
2010             SELECT INTO temp_vector temp_vector || ' ' || to_tsvector(ts_rec.ts_config::regconfig, value)::TEXT;
2011
2012         END LOOP;
2013         NEW.index_vector = NEW.index_vector || setweight(temp_vector::tsvector,cur_weight);
2014     ELSE
2015         NEW.index_vector = to_tsvector(TG_ARGV[0]::regconfig, value);
2016     END IF;
2017
2018     RETURN NEW;
2019 END;
2020 $$ LANGUAGE PLPGSQL;
2021
2022
2023 CREATE TYPE metabib.flat_browse_entry_appearance AS (
2024     browse_entry    BIGINT,
2025     value           TEXT,
2026     fields          TEXT,
2027     authorities     TEXT,
2028     sees            TEXT,
2029     sources         INT,        -- visible ones, that is
2030     asources        INT,        -- visible ones, that is
2031     row_number      INT,        -- internal use, sort of
2032     accurate        BOOL,       -- Count in sources field is accurate? Not
2033                                 -- if we had more than a browse superpage
2034                                 -- of records to look at.
2035     aaccurate       BOOL,       -- See previous comment...
2036     pivot_point     BIGINT
2037 );
2038
2039
2040 CREATE OR REPLACE FUNCTION metabib.browse_bib_pivot(
2041     INT[],
2042     TEXT
2043 ) RETURNS BIGINT AS $p$
2044     SELECT  mbe.id
2045       FROM  metabib.browse_entry mbe
2046             JOIN metabib.browse_entry_def_map mbedm ON (
2047                 mbedm.entry = mbe.id
2048                 AND mbedm.def = ANY($1)
2049             )
2050       WHERE mbe.sort_value >= public.naco_normalize($2)
2051       ORDER BY mbe.sort_value, mbe.value LIMIT 1;
2052 $p$ LANGUAGE SQL STABLE;
2053
2054 CREATE OR REPLACE FUNCTION metabib.browse_authority_pivot(
2055     INT[],
2056     TEXT
2057 ) RETURNS BIGINT AS $p$
2058     SELECT  mbe.id
2059       FROM  metabib.browse_entry mbe
2060             JOIN metabib.browse_entry_simple_heading_map mbeshm ON ( mbeshm.entry = mbe.id )
2061             JOIN authority.simple_heading ash ON ( mbeshm.simple_heading = ash.id )
2062             JOIN authority.control_set_auth_field_metabib_field_map_refs map ON (
2063                 ash.atag = map.authority_field
2064                 AND map.metabib_field = ANY($1)
2065             )
2066       WHERE mbe.sort_value >= public.naco_normalize($2)
2067       ORDER BY mbe.sort_value, mbe.value LIMIT 1;
2068 $p$ LANGUAGE SQL STABLE;
2069
2070 CREATE OR REPLACE FUNCTION metabib.browse_authority_refs_pivot(
2071     INT[],
2072     TEXT
2073 ) RETURNS BIGINT AS $p$
2074     SELECT  mbe.id
2075       FROM  metabib.browse_entry mbe
2076             JOIN metabib.browse_entry_simple_heading_map mbeshm ON ( mbeshm.entry = mbe.id )
2077             JOIN authority.simple_heading ash ON ( mbeshm.simple_heading = ash.id )
2078             JOIN authority.control_set_auth_field_metabib_field_map_refs_only map ON (
2079                 ash.atag = map.authority_field
2080                 AND map.metabib_field = ANY($1)
2081             )
2082       WHERE mbe.sort_value >= public.naco_normalize($2)
2083       ORDER BY mbe.sort_value, mbe.value LIMIT 1;
2084 $p$ LANGUAGE SQL STABLE;
2085
2086 CREATE OR REPLACE FUNCTION metabib.browse_pivot(
2087     INT[],
2088     TEXT
2089 ) RETURNS BIGINT AS $p$
2090     SELECT  id FROM metabib.browse_entry
2091       WHERE id IN (
2092                 metabib.browse_bib_pivot($1, $2),
2093                 metabib.browse_authority_refs_pivot($1,$2) -- only look in 4xx, 5xx, 7xx of authority
2094             )
2095       ORDER BY sort_value, value LIMIT 1;
2096 $p$ LANGUAGE SQL STABLE;
2097
2098
2099 CREATE OR REPLACE FUNCTION metabib.staged_browse(
2100     query                   TEXT,
2101     fields                  INT[],
2102     context_org             INT,
2103     context_locations       INT[],
2104     staff                   BOOL,
2105     browse_superpage_size   INT,
2106     count_up_from_zero      BOOL,   -- if false, count down from -1
2107     result_limit            INT,
2108     next_pivot_pos          INT
2109 ) RETURNS SETOF metabib.flat_browse_entry_appearance AS $p$
2110 DECLARE
2111     curs                    REFCURSOR;
2112     rec                     RECORD;
2113     qpfts_query             TEXT;
2114     aqpfts_query            TEXT;
2115     afields                 INT[];
2116     bfields                 INT[];
2117     result_row              metabib.flat_browse_entry_appearance%ROWTYPE;
2118     results_skipped         INT := 0;
2119     row_counter             INT := 0;
2120     row_number              INT;
2121     slice_start             INT;
2122     slice_end               INT;
2123     full_end                INT;
2124     all_records             BIGINT[];
2125     all_brecords             BIGINT[];
2126     all_arecords            BIGINT[];
2127     superpage_of_records    BIGINT[];
2128     superpage_size          INT;
2129 BEGIN
2130     IF count_up_from_zero THEN
2131         row_number := 0;
2132     ELSE
2133         row_number := -1;
2134     END IF;
2135
2136     OPEN curs FOR EXECUTE query;
2137
2138     LOOP
2139         FETCH curs INTO rec;
2140         IF NOT FOUND THEN
2141             IF result_row.pivot_point IS NOT NULL THEN
2142                 RETURN NEXT result_row;
2143             END IF;
2144             RETURN;
2145         END IF;
2146
2147
2148         -- Gather aggregate data based on the MBE row we're looking at now, authority axis
2149         SELECT INTO all_arecords, result_row.sees, afields
2150                 ARRAY_AGG(DISTINCT abl.bib), -- bibs to check for visibility
2151                 STRING_AGG(DISTINCT aal.source::TEXT, $$,$$), -- authority record ids
2152                 ARRAY_AGG(DISTINCT map.metabib_field) -- authority-tag-linked CMF rows
2153
2154           FROM  metabib.browse_entry_simple_heading_map mbeshm
2155                 JOIN authority.simple_heading ash ON ( mbeshm.simple_heading = ash.id )
2156                 JOIN authority.authority_linking aal ON ( ash.record = aal.source )
2157                 JOIN authority.bib_linking abl ON ( aal.target = abl.authority )
2158                 JOIN authority.control_set_auth_field_metabib_field_map_refs map ON (
2159                     ash.atag = map.authority_field
2160                     AND map.metabib_field = ANY(fields)
2161                 )
2162           WHERE mbeshm.entry = rec.id;
2163
2164
2165         -- Gather aggregate data based on the MBE row we're looking at now, bib axis
2166         SELECT INTO all_brecords, result_row.authorities, bfields
2167                 ARRAY_AGG(DISTINCT source),
2168                 STRING_AGG(DISTINCT authority::TEXT, $$,$$),
2169                 ARRAY_AGG(DISTINCT def)
2170           FROM  metabib.browse_entry_def_map
2171           WHERE entry = rec.id
2172                 AND def = ANY(fields);
2173
2174         SELECT INTO result_row.fields STRING_AGG(DISTINCT x::TEXT, $$,$$) FROM UNNEST(afields || bfields) x;
2175
2176         result_row.sources := 0;
2177         result_row.asources := 0;
2178
2179         -- Bib-linked vis checking
2180         IF ARRAY_UPPER(all_brecords,1) IS NOT NULL THEN
2181
2182             full_end := ARRAY_LENGTH(all_brecords, 1);
2183             superpage_size := COALESCE(browse_superpage_size, full_end);
2184             slice_start := 1;
2185             slice_end := superpage_size;
2186
2187             WHILE result_row.sources = 0 AND slice_start <= full_end LOOP
2188                 superpage_of_records := all_brecords[slice_start:slice_end];
2189                 qpfts_query :=
2190                     'SELECT NULL::BIGINT AS id, ARRAY[r] AS records, ' ||
2191                     '1::INT AS rel FROM (SELECT UNNEST(' ||
2192                     quote_literal(superpage_of_records) || '::BIGINT[]) AS r) rr';
2193
2194                 -- We use search.query_parser_fts() for visibility testing.
2195                 -- We're calling it once per browse-superpage worth of records
2196                 -- out of the set of records related to a given mbe, until we've
2197                 -- either exhausted that set of records or found at least 1
2198                 -- visible record.
2199
2200                 SELECT INTO result_row.sources visible
2201                     FROM search.query_parser_fts(
2202                         context_org, NULL, qpfts_query, NULL,
2203                         context_locations, 0, NULL, NULL, FALSE, staff, FALSE
2204                     ) qpfts
2205                     WHERE qpfts.rel IS NULL;
2206
2207                 slice_start := slice_start + superpage_size;
2208                 slice_end := slice_end + superpage_size;
2209             END LOOP;
2210
2211             -- Accurate?  Well, probably.
2212             result_row.accurate := browse_superpage_size IS NULL OR
2213                 browse_superpage_size >= full_end;
2214
2215         END IF;
2216
2217         -- Authority-linked vis checking
2218         IF ARRAY_UPPER(all_arecords,1) IS NOT NULL THEN
2219
2220             full_end := ARRAY_LENGTH(all_arecords, 1);
2221             superpage_size := COALESCE(browse_superpage_size, full_end);
2222             slice_start := 1;
2223             slice_end := superpage_size;
2224
2225             WHILE result_row.asources = 0 AND slice_start <= full_end LOOP
2226                 superpage_of_records := all_arecords[slice_start:slice_end];
2227                 qpfts_query :=
2228                     'SELECT NULL::BIGINT AS id, ARRAY[r] AS records, ' ||
2229                     '1::INT AS rel FROM (SELECT UNNEST(' ||
2230                     quote_literal(superpage_of_records) || '::BIGINT[]) AS r) rr';
2231
2232                 -- We use search.query_parser_fts() for visibility testing.
2233                 -- We're calling it once per browse-superpage worth of records
2234                 -- out of the set of records related to a given mbe, via
2235                 -- authority until we've either exhausted that set of records
2236                 -- or found at least 1 visible record.
2237
2238                 SELECT INTO result_row.asources visible
2239                     FROM search.query_parser_fts(
2240                         context_org, NULL, qpfts_query, NULL,
2241                         context_locations, 0, NULL, NULL, FALSE, staff, FALSE
2242                     ) qpfts
2243                     WHERE qpfts.rel IS NULL;
2244
2245                 slice_start := slice_start + superpage_size;
2246                 slice_end := slice_end + superpage_size;
2247             END LOOP;
2248
2249
2250             -- Accurate?  Well, probably.
2251             result_row.aaccurate := browse_superpage_size IS NULL OR
2252                 browse_superpage_size >= full_end;
2253
2254         END IF;
2255
2256         IF result_row.sources > 0 OR result_row.asources > 0 THEN
2257
2258             -- The function that calls this function needs row_number in order
2259             -- to correctly order results from two different runs of this
2260             -- functions.
2261             result_row.row_number := row_number;
2262
2263             -- Now, if row_counter is still less than limit, return a row.  If
2264             -- not, but it is less than next_pivot_pos, continue on without
2265             -- returning actual result rows until we find
2266             -- that next pivot, and return it.
2267
2268             IF row_counter < result_limit THEN
2269                 result_row.browse_entry := rec.id;
2270                 result_row.value := rec.value;
2271
2272                 RETURN NEXT result_row;
2273             ELSE
2274                 result_row.browse_entry := NULL;
2275                 result_row.authorities := NULL;
2276                 result_row.fields := NULL;
2277                 result_row.value := NULL;
2278                 result_row.sources := NULL;
2279                 result_row.sees := NULL;
2280                 result_row.accurate := NULL;
2281                 result_row.aaccurate := NULL;
2282                 result_row.pivot_point := rec.id;
2283
2284                 IF row_counter >= next_pivot_pos THEN
2285                     RETURN NEXT result_row;
2286                     RETURN;
2287                 END IF;
2288             END IF;
2289
2290             IF count_up_from_zero THEN
2291                 row_number := row_number + 1;
2292             ELSE
2293                 row_number := row_number - 1;
2294             END IF;
2295
2296             -- row_counter is different from row_number.
2297             -- It simply counts up from zero so that we know when
2298             -- we've reached our limit.
2299             row_counter := row_counter + 1;
2300         END IF;
2301     END LOOP;
2302 END;
2303 $p$ LANGUAGE PLPGSQL;
2304
2305
2306 CREATE OR REPLACE FUNCTION metabib.browse(
2307     search_field            INT[],
2308     browse_term             TEXT,
2309     context_org             INT DEFAULT NULL,
2310     context_loc_group       INT DEFAULT NULL,
2311     staff                   BOOL DEFAULT FALSE,
2312     pivot_id                BIGINT DEFAULT NULL,
2313     result_limit            INT DEFAULT 10
2314 ) RETURNS SETOF metabib.flat_browse_entry_appearance AS $p$
2315 DECLARE
2316     core_query              TEXT;
2317     back_query              TEXT;
2318     forward_query           TEXT;
2319     pivot_sort_value        TEXT;
2320     pivot_sort_fallback     TEXT;
2321     context_locations       INT[];
2322     browse_superpage_size   INT;
2323     results_skipped         INT := 0;
2324     back_limit              INT;
2325     back_to_pivot           INT;
2326     forward_limit           INT;
2327     forward_to_pivot        INT;
2328 BEGIN
2329     -- First, find the pivot if we were given a browse term but not a pivot.
2330     IF pivot_id IS NULL THEN
2331         pivot_id := metabib.browse_pivot(search_field, browse_term);
2332     END IF;
2333
2334     SELECT INTO pivot_sort_value, pivot_sort_fallback
2335         sort_value, value FROM metabib.browse_entry WHERE id = pivot_id;
2336
2337     -- Bail if we couldn't find a pivot.
2338     IF pivot_sort_value IS NULL THEN
2339         RETURN;
2340     END IF;
2341
2342     -- Transform the context_loc_group argument (if any) (logc at the
2343     -- TPAC layer) into a form we'll be able to use.
2344     IF context_loc_group IS NOT NULL THEN
2345         SELECT INTO context_locations ARRAY_AGG(location)
2346             FROM asset.copy_location_group_map
2347             WHERE lgroup = context_loc_group;
2348     END IF;
2349
2350     -- Get the configured size of browse superpages.
2351     SELECT INTO browse_superpage_size value     -- NULL ok
2352         FROM config.global_flag
2353         WHERE enabled AND name = 'opac.browse.holdings_visibility_test_limit';
2354
2355     -- First we're going to search backward from the pivot, then we're going
2356     -- to search forward.  In each direction, we need two limits.  At the
2357     -- lesser of the two limits, we delineate the edge of the result set
2358     -- we're going to return.  At the greater of the two limits, we find the
2359     -- pivot value that would represent an offset from the current pivot
2360     -- at a distance of one "page" in either direction, where a "page" is a
2361     -- result set of the size specified in the "result_limit" argument.
2362     --
2363     -- The two limits in each direction make four derived values in total,
2364     -- and we calculate them now.
2365     back_limit := CEIL(result_limit::FLOAT / 2);
2366     back_to_pivot := result_limit;
2367     forward_limit := result_limit / 2;
2368     forward_to_pivot := result_limit - 1;
2369
2370     -- This is the meat of the SQL query that finds browse entries.  We'll
2371     -- pass this to a function which uses it with a cursor, so that individual
2372     -- rows may be fetched in a loop until some condition is satisfied, without
2373     -- waiting for a result set of fixed size to be collected all at once.
2374     core_query := '
2375 SELECT  mbe.id,
2376         mbe.value,
2377         mbe.sort_value
2378   FROM  metabib.browse_entry mbe
2379   WHERE (
2380             EXISTS ( -- are there any bibs using this mbe via the requested fields?
2381                 SELECT  1
2382                   FROM  metabib.browse_entry_def_map mbedm
2383                   WHERE mbedm.entry = mbe.id AND mbedm.def = ANY(' || quote_literal(search_field) || ')
2384                   LIMIT 1
2385             ) OR EXISTS ( -- are there any authorities using this mbe via the requested fields?
2386                 SELECT  1
2387                   FROM  metabib.browse_entry_simple_heading_map mbeshm
2388                         JOIN authority.simple_heading ash ON ( mbeshm.simple_heading = ash.id )
2389                         JOIN authority.control_set_auth_field_metabib_field_map_refs map ON (
2390                             ash.atag = map.authority_field
2391                             AND map.metabib_field = ANY(' || quote_literal(search_field) || ')
2392                         )
2393                   WHERE mbeshm.entry = mbe.id
2394             )
2395         ) AND ';
2396
2397     -- This is the variant of the query for browsing backward.
2398     back_query := core_query ||
2399         ' mbe.sort_value <= ' || quote_literal(pivot_sort_value) ||
2400     ' ORDER BY mbe.sort_value DESC, mbe.value DESC ';
2401
2402     -- This variant browses forward.
2403     forward_query := core_query ||
2404         ' mbe.sort_value > ' || quote_literal(pivot_sort_value) ||
2405     ' ORDER BY mbe.sort_value, mbe.value ';
2406
2407     -- We now call the function which applies a cursor to the provided
2408     -- queries, stopping at the appropriate limits and also giving us
2409     -- the next page's pivot.
2410     RETURN QUERY
2411         SELECT * FROM metabib.staged_browse(
2412             back_query, search_field, context_org, context_locations,
2413             staff, browse_superpage_size, TRUE, back_limit, back_to_pivot
2414         ) UNION
2415         SELECT * FROM metabib.staged_browse(
2416             forward_query, search_field, context_org, context_locations,
2417             staff, browse_superpage_size, FALSE, forward_limit, forward_to_pivot
2418         ) ORDER BY row_number DESC;
2419
2420 END;
2421 $p$ LANGUAGE PLPGSQL;
2422
2423 CREATE OR REPLACE FUNCTION metabib.browse(
2424     search_class        TEXT,
2425     browse_term         TEXT,
2426     context_org         INT DEFAULT NULL,
2427     context_loc_group   INT DEFAULT NULL,
2428     staff               BOOL DEFAULT FALSE,
2429     pivot_id            BIGINT DEFAULT NULL,
2430     result_limit        INT DEFAULT 10
2431 ) RETURNS SETOF metabib.flat_browse_entry_appearance AS $p$
2432 BEGIN
2433     RETURN QUERY SELECT * FROM metabib.browse(
2434         (SELECT COALESCE(ARRAY_AGG(id), ARRAY[]::INT[])
2435             FROM config.metabib_field WHERE field_class = search_class),
2436         browse_term,
2437         context_org,
2438         context_loc_group,
2439         staff,
2440         pivot_id,
2441         result_limit
2442     );
2443 END;
2444 $p$ LANGUAGE PLPGSQL;
2445
2446 COMMIT;
2447