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