Bring back "split-brain" indexing normalization
[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     -- Start out with no field-use bools set
415     output_row.browse_field = FALSE;
416     output_row.facet_field = FALSE;
417     output_row.search_field = FALSE;
418
419     -- Get the record
420     SELECT INTO bib * FROM biblio.record_entry WHERE id = rid;
421
422     -- Loop over the indexing entries
423     FOR idx IN SELECT * FROM config.metabib_field ORDER BY format LOOP
424
425         SELECT INTO xfrm * from config.xml_transform WHERE name = idx.format;
426
427         -- See if we can skip the XSLT ... it's expensive
428         IF prev_xfrm IS NULL OR prev_xfrm <> xfrm.name THEN
429             -- Can't skip the transform
430             IF xfrm.xslt <> '---' THEN
431                 transformed_xml := oils_xslt_process(bib.marc,xfrm.xslt);
432             ELSE
433                 transformed_xml := bib.marc;
434             END IF;
435
436             prev_xfrm := xfrm.name;
437         END IF;
438
439         xml_node_list := oils_xpath( idx.xpath, transformed_xml, ARRAY[ARRAY[xfrm.prefix, xfrm.namespace_uri]] );
440
441         raw_text := NULL;
442         FOR xml_node IN SELECT x FROM unnest(xml_node_list) AS x LOOP
443             CONTINUE WHEN xml_node !~ E'^\\s*<';
444
445             curr_text := ARRAY_TO_STRING(
446                 oils_xpath( '//text()',
447                     REGEXP_REPLACE( -- This escapes all &s not followed by "amp;".  Data ise returned from oils_xpath (above) in UTF-8, not entity encoded
448                         REGEXP_REPLACE( -- This escapes embeded <s
449                             xml_node,
450                             $re$(>[^<]+)(<)([^>]+<)$re$,
451                             E'\\1&lt;\\3',
452                             'g'
453                         ),
454                         '&(?!amp;)',
455                         '&amp;',
456                         'g'
457                     )
458                 ),
459                 ' '
460             );
461
462             CONTINUE WHEN curr_text IS NULL OR curr_text = '';
463
464             IF raw_text IS NOT NULL THEN
465                 raw_text := raw_text || joiner;
466             END IF;
467
468             raw_text := COALESCE(raw_text,'') || curr_text;
469
470             -- autosuggest/metabib.browse_entry
471             IF idx.browse_field THEN
472
473                 IF idx.browse_xpath IS NOT NULL AND idx.browse_xpath <> '' THEN
474                     browse_text := oils_xpath_string( idx.browse_xpath, xml_node, joiner, ARRAY[ARRAY[xfrm.prefix, xfrm.namespace_uri]] );
475                 ELSE
476                     browse_text := curr_text;
477                 END IF;
478
479                 output_row.field_class = idx.field_class;
480                 output_row.field = idx.id;
481                 output_row.source = rid;
482                 output_row.value = BTRIM(REGEXP_REPLACE(browse_text, E'\\s+', ' ', 'g'));
483
484                 output_row.browse_field = TRUE;
485                 RETURN NEXT output_row;
486                 output_row.browse_field = FALSE;
487             END IF;
488
489             -- insert raw node text for faceting
490             IF idx.facet_field THEN
491
492                 IF idx.facet_xpath IS NOT NULL AND idx.facet_xpath <> '' THEN
493                     facet_text := oils_xpath_string( idx.facet_xpath, xml_node, joiner, ARRAY[ARRAY[xfrm.prefix, xfrm.namespace_uri]] );
494                 ELSE
495                     facet_text := curr_text;
496                 END IF;
497
498                 output_row.field_class = idx.field_class;
499                 output_row.field = -1 * idx.id;
500                 output_row.source = rid;
501                 output_row.value = BTRIM(REGEXP_REPLACE(facet_text, E'\\s+', ' ', 'g'));
502
503                 output_row.facet_field = TRUE;
504                 RETURN NEXT output_row;
505                 output_row.facet_field = FALSE;
506             END IF;
507
508         END LOOP;
509
510         CONTINUE WHEN raw_text IS NULL OR raw_text = '';
511
512         -- insert combined node text for searching
513         IF idx.search_field THEN
514             output_row.field_class = idx.field_class;
515             output_row.field = idx.id;
516             output_row.source = rid;
517             output_row.value = BTRIM(REGEXP_REPLACE(raw_text, E'\\s+', ' ', 'g'));
518
519             output_row.search_field = TRUE;
520             RETURN NEXT output_row;
521             output_row.search_field = FALSE;
522         END IF;
523
524     END LOOP;
525
526 END;
527
528 $func$ LANGUAGE PLPGSQL;
529
530 CREATE OR REPLACE FUNCTION metabib.update_combined_index_vectors(bib_id BIGINT) RETURNS VOID AS $func$
531 BEGIN
532     DELETE FROM metabib.combined_keyword_field_entry WHERE record = bib_id;
533     INSERT INTO metabib.combined_keyword_field_entry(record, metabib_field, index_vector)
534         SELECT bib_id, field, strip(COALESCE(string_agg(index_vector::TEXT,' '),'')::tsvector)
535         FROM metabib.keyword_field_entry WHERE source = bib_id GROUP BY field;
536     INSERT INTO metabib.combined_keyword_field_entry(record, metabib_field, index_vector)
537         SELECT bib_id, NULL, strip(COALESCE(string_agg(index_vector::TEXT,' '),'')::tsvector)
538         FROM metabib.keyword_field_entry WHERE source = bib_id;
539
540     DELETE FROM metabib.combined_title_field_entry WHERE record = bib_id;
541     INSERT INTO metabib.combined_title_field_entry(record, metabib_field, index_vector)
542         SELECT bib_id, field, strip(COALESCE(string_agg(index_vector::TEXT,' '),'')::tsvector)
543         FROM metabib.title_field_entry WHERE source = bib_id GROUP BY field;
544     INSERT INTO metabib.combined_title_field_entry(record, metabib_field, index_vector)
545         SELECT bib_id, NULL, strip(COALESCE(string_agg(index_vector::TEXT,' '),'')::tsvector)
546         FROM metabib.title_field_entry WHERE source = bib_id;
547
548     DELETE FROM metabib.combined_author_field_entry WHERE record = bib_id;
549     INSERT INTO metabib.combined_author_field_entry(record, metabib_field, index_vector)
550         SELECT bib_id, field, strip(COALESCE(string_agg(index_vector::TEXT,' '),'')::tsvector)
551         FROM metabib.author_field_entry WHERE source = bib_id GROUP BY field;
552     INSERT INTO metabib.combined_author_field_entry(record, metabib_field, index_vector)
553         SELECT bib_id, NULL, strip(COALESCE(string_agg(index_vector::TEXT,' '),'')::tsvector)
554         FROM metabib.author_field_entry WHERE source = bib_id;
555
556     DELETE FROM metabib.combined_subject_field_entry WHERE record = bib_id;
557     INSERT INTO metabib.combined_subject_field_entry(record, metabib_field, index_vector)
558         SELECT bib_id, field, strip(COALESCE(string_agg(index_vector::TEXT,' '),'')::tsvector)
559         FROM metabib.subject_field_entry WHERE source = bib_id GROUP BY field;
560     INSERT INTO metabib.combined_subject_field_entry(record, metabib_field, index_vector)
561         SELECT bib_id, NULL, strip(COALESCE(string_agg(index_vector::TEXT,' '),'')::tsvector)
562         FROM metabib.subject_field_entry WHERE source = bib_id;
563
564     DELETE FROM metabib.combined_series_field_entry WHERE record = bib_id;
565     INSERT INTO metabib.combined_series_field_entry(record, metabib_field, index_vector)
566         SELECT bib_id, field, strip(COALESCE(string_agg(index_vector::TEXT,' '),'')::tsvector)
567         FROM metabib.series_field_entry WHERE source = bib_id GROUP BY field;
568     INSERT INTO metabib.combined_series_field_entry(record, metabib_field, index_vector)
569         SELECT bib_id, NULL, strip(COALESCE(string_agg(index_vector::TEXT,' '),'')::tsvector)
570         FROM metabib.series_field_entry WHERE source = bib_id;
571
572     DELETE FROM metabib.combined_identifier_field_entry WHERE record = bib_id;
573     INSERT INTO metabib.combined_identifier_field_entry(record, metabib_field, index_vector)
574         SELECT bib_id, field, strip(COALESCE(string_agg(index_vector::TEXT,' '),'')::tsvector)
575         FROM metabib.identifier_field_entry WHERE source = bib_id GROUP BY field;
576     INSERT INTO metabib.combined_identifier_field_entry(record, metabib_field, index_vector)
577         SELECT bib_id, NULL, strip(COALESCE(string_agg(index_vector::TEXT,' '),'')::tsvector)
578         FROM metabib.identifier_field_entry WHERE source = bib_id;
579
580 END;
581 $func$ LANGUAGE PLPGSQL;
582
583 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$
584 DECLARE
585     fclass          RECORD;
586     ind_data        metabib.field_entry_template%ROWTYPE;
587     mbe_row         metabib.browse_entry%ROWTYPE;
588     mbe_id          BIGINT;
589     b_skip_facet    BOOL;
590     b_skip_browse   BOOL;
591     b_skip_search   BOOL;
592 BEGIN
593
594     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;
595     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;
596     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;
597
598     PERFORM * FROM config.internal_flag WHERE name = 'ingest.assume_inserts_only' AND enabled;
599     IF NOT FOUND THEN
600         IF NOT b_skip_search THEN
601             FOR fclass IN SELECT * FROM config.metabib_class LOOP
602                 -- RAISE NOTICE 'Emptying out %', fclass.name;
603                 EXECUTE $$DELETE FROM metabib.$$ || fclass.name || $$_field_entry WHERE source = $$ || bib_id;
604             END LOOP;
605         END IF;
606         IF NOT b_skip_facet THEN
607             DELETE FROM metabib.facet_entry WHERE source = bib_id;
608         END IF;
609         IF NOT b_skip_browse THEN
610             DELETE FROM metabib.browse_entry_def_map WHERE source = bib_id;
611         END IF;
612     END IF;
613
614     FOR ind_data IN SELECT * FROM biblio.extract_metabib_field_entry( bib_id ) LOOP
615         IF ind_data.field < 0 THEN
616             ind_data.field = -1 * ind_data.field;
617         END IF;
618
619         IF ind_data.facet_field AND NOT b_skip_facet THEN
620             INSERT INTO metabib.facet_entry (field, source, value)
621                 VALUES (ind_data.field, ind_data.source, ind_data.value);
622         END IF;
623
624         IF ind_data.browse_field AND NOT b_skip_browse THEN
625             -- A caveat about this SELECT: this should take care of replacing
626             -- old mbe rows when data changes, but not if normalization (by
627             -- which I mean specifically the output of
628             -- evergreen.oils_tsearch2()) changes.  It may or may not be
629             -- expensive to add a comparison of index_vector to index_vector
630             -- to the WHERE clause below.
631             SELECT INTO mbe_row * FROM metabib.browse_entry WHERE value = ind_data.value;
632             IF FOUND THEN
633                 mbe_id := mbe_row.id;
634             ELSE
635                 INSERT INTO metabib.browse_entry (value) VALUES
636                     (metabib.browse_normalize(ind_data.value, ind_data.field));
637                 mbe_id := CURRVAL('metabib.browse_entry_id_seq'::REGCLASS);
638             END IF;
639
640             INSERT INTO metabib.browse_entry_def_map (entry, def, source)
641                 VALUES (mbe_id, ind_data.field, ind_data.source);
642         END IF;
643
644         IF ind_data.search_field AND NOT b_skip_search THEN
645             EXECUTE $$
646                 INSERT INTO metabib.$$ || ind_data.field_class || $$_field_entry (field, source, value)
647                     VALUES ($$ ||
648                         quote_literal(ind_data.field) || $$, $$ ||
649                         quote_literal(ind_data.source) || $$, $$ ||
650                         quote_literal(ind_data.value) ||
651                     $$);$$;
652         END IF;
653
654     END LOOP;
655
656     IF NOT b_skip_search THEN
657         PERFORM metabib.update_combined_index_vectors(bib_id);
658     END IF;
659
660     RETURN;
661 END;
662 $func$ LANGUAGE PLPGSQL;
663
664 -- default to a space joiner
665 CREATE OR REPLACE FUNCTION biblio.extract_metabib_field_entry ( BIGINT ) RETURNS SETOF metabib.field_entry_template AS $func$
666         SELECT * FROM biblio.extract_metabib_field_entry($1, ' ');
667 $func$ LANGUAGE SQL;
668
669 CREATE OR REPLACE FUNCTION authority.flatten_marc ( rid BIGINT ) RETURNS SETOF authority.full_rec AS $func$
670 DECLARE
671         auth    authority.record_entry%ROWTYPE;
672         output  authority.full_rec%ROWTYPE;
673         field   RECORD;
674 BEGIN
675         SELECT INTO auth * FROM authority.record_entry WHERE id = rid;
676
677         FOR field IN SELECT * FROM vandelay.flatten_marc( auth.marc ) LOOP
678                 output.record := rid;
679                 output.ind1 := field.ind1;
680                 output.ind2 := field.ind2;
681                 output.tag := field.tag;
682                 output.subfield := field.subfield;
683                 output.value := field.value;
684
685                 RETURN NEXT output;
686         END LOOP;
687 END;
688 $func$ LANGUAGE PLPGSQL;
689
690 CREATE OR REPLACE FUNCTION biblio.flatten_marc ( rid BIGINT ) RETURNS SETOF metabib.full_rec AS $func$
691 DECLARE
692         bib     biblio.record_entry%ROWTYPE;
693         output  metabib.full_rec%ROWTYPE;
694         field   RECORD;
695 BEGIN
696         SELECT INTO bib * FROM biblio.record_entry WHERE id = rid;
697
698         FOR field IN SELECT * FROM vandelay.flatten_marc( bib.marc ) LOOP
699                 output.record := rid;
700                 output.ind1 := field.ind1;
701                 output.ind2 := field.ind2;
702                 output.tag := field.tag;
703                 output.subfield := field.subfield;
704                 output.value := field.value;
705
706                 RETURN NEXT output;
707         END LOOP;
708 END;
709 $func$ LANGUAGE PLPGSQL;
710
711 CREATE OR REPLACE FUNCTION vandelay.marc21_record_type( marc TEXT ) RETURNS config.marc21_rec_type_map AS $func$
712 DECLARE
713         ldr         TEXT;
714         tval        TEXT;
715         tval_rec    RECORD;
716         bval        TEXT;
717         bval_rec    RECORD;
718     retval      config.marc21_rec_type_map%ROWTYPE;
719 BEGIN
720     ldr := oils_xpath_string( '//*[local-name()="leader"]', marc );
721
722     IF ldr IS NULL OR ldr = '' THEN
723         SELECT * INTO retval FROM config.marc21_rec_type_map WHERE code = 'BKS';
724         RETURN retval;
725     END IF;
726
727     SELECT * INTO tval_rec FROM config.marc21_ff_pos_map WHERE fixed_field = 'Type' LIMIT 1; -- They're all the same
728     SELECT * INTO bval_rec FROM config.marc21_ff_pos_map WHERE fixed_field = 'BLvl' LIMIT 1; -- They're all the same
729
730
731     tval := SUBSTRING( ldr, tval_rec.start_pos + 1, tval_rec.length );
732     bval := SUBSTRING( ldr, bval_rec.start_pos + 1, bval_rec.length );
733
734     -- RAISE NOTICE 'type %, blvl %, ldr %', tval, bval, ldr;
735
736     SELECT * INTO retval FROM config.marc21_rec_type_map WHERE type_val LIKE '%' || tval || '%' AND blvl_val LIKE '%' || bval || '%';
737
738
739     IF retval.code IS NULL THEN
740         SELECT * INTO retval FROM config.marc21_rec_type_map WHERE code = 'BKS';
741     END IF;
742
743     RETURN retval;
744 END;
745 $func$ LANGUAGE PLPGSQL;
746
747 CREATE OR REPLACE FUNCTION biblio.marc21_record_type( rid BIGINT ) RETURNS config.marc21_rec_type_map AS $func$
748     SELECT * FROM vandelay.marc21_record_type( (SELECT marc FROM biblio.record_entry WHERE id = $1) );
749 $func$ LANGUAGE SQL;
750
751 CREATE OR REPLACE FUNCTION vandelay.marc21_extract_fixed_field( marc TEXT, ff TEXT ) RETURNS TEXT AS $func$
752 DECLARE
753     rtype       TEXT;
754     ff_pos      RECORD;
755     tag_data    RECORD;
756     val         TEXT;
757 BEGIN
758     rtype := (vandelay.marc21_record_type( marc )).code;
759     FOR ff_pos IN SELECT * FROM config.marc21_ff_pos_map WHERE fixed_field = ff AND rec_type = rtype ORDER BY tag DESC LOOP
760         IF ff_pos.tag = 'ldr' THEN
761             val := oils_xpath_string('//*[local-name()="leader"]', marc);
762             IF val IS NOT NULL THEN
763                 val := SUBSTRING( val, ff_pos.start_pos + 1, ff_pos.length );
764                 RETURN val;
765             END IF;
766         ELSE
767             FOR tag_data IN SELECT value FROM UNNEST( oils_xpath( '//*[@tag="' || UPPER(ff_pos.tag) || '"]/text()', marc ) ) x(value) LOOP
768                 val := SUBSTRING( tag_data.value, ff_pos.start_pos + 1, ff_pos.length );
769                 RETURN val;
770             END LOOP;
771         END IF;
772         val := REPEAT( ff_pos.default_val, ff_pos.length );
773         RETURN val;
774     END LOOP;
775
776     RETURN NULL;
777 END;
778 $func$ LANGUAGE PLPGSQL;
779
780 CREATE OR REPLACE FUNCTION biblio.marc21_extract_fixed_field( rid BIGINT, ff TEXT ) RETURNS TEXT AS $func$
781     SELECT * FROM vandelay.marc21_extract_fixed_field( (SELECT marc FROM biblio.record_entry WHERE id = $1), $2 );
782 $func$ LANGUAGE SQL;
783
784 -- CREATE TYPE biblio.record_ff_map AS (record BIGINT, ff_name TEXT, ff_value TEXT);
785 CREATE OR REPLACE FUNCTION vandelay.marc21_extract_all_fixed_fields( marc TEXT ) RETURNS SETOF biblio.record_ff_map AS $func$
786 DECLARE
787     tag_data    TEXT;
788     rtype       TEXT;
789     ff_pos      RECORD;
790     output      biblio.record_ff_map%ROWTYPE;
791 BEGIN
792     rtype := (vandelay.marc21_record_type( marc )).code;
793
794     FOR ff_pos IN SELECT * FROM config.marc21_ff_pos_map WHERE rec_type = rtype ORDER BY tag DESC LOOP
795         output.ff_name  := ff_pos.fixed_field;
796         output.ff_value := NULL;
797
798         IF ff_pos.tag = 'ldr' THEN
799             output.ff_value := oils_xpath_string('//*[local-name()="leader"]', marc);
800             IF output.ff_value IS NOT NULL THEN
801                 output.ff_value := SUBSTRING( output.ff_value, ff_pos.start_pos + 1, ff_pos.length );
802                 RETURN NEXT output;
803                 output.ff_value := NULL;
804             END IF;
805         ELSE
806             FOR tag_data IN SELECT value FROM UNNEST( oils_xpath( '//*[@tag="' || UPPER(ff_pos.tag) || '"]/text()', marc ) ) x(value) LOOP
807                 output.ff_value := SUBSTRING( tag_data, ff_pos.start_pos + 1, ff_pos.length );
808                 IF output.ff_value IS NULL THEN output.ff_value := REPEAT( ff_pos.default_val, ff_pos.length ); END IF;
809                 RETURN NEXT output;
810                 output.ff_value := NULL;
811             END LOOP;
812         END IF;
813
814     END LOOP;
815
816     RETURN;
817 END;
818 $func$ LANGUAGE PLPGSQL;
819
820 CREATE OR REPLACE FUNCTION biblio.marc21_extract_all_fixed_fields( rid BIGINT ) RETURNS SETOF biblio.record_ff_map AS $func$
821     SELECT $1 AS record, ff_name, ff_value FROM vandelay.marc21_extract_all_fixed_fields( (SELECT marc FROM biblio.record_entry WHERE id = $1) );
822 $func$ LANGUAGE SQL;
823
824 CREATE OR REPLACE FUNCTION biblio.marc21_physical_characteristics( rid BIGINT ) RETURNS SETOF biblio.marc21_physical_characteristics AS $func$
825     SELECT id, $1 AS record, ptype, subfield, value FROM vandelay.marc21_physical_characteristics( (SELECT marc FROM biblio.record_entry WHERE id = $1) );
826 $func$ LANGUAGE SQL;
827
828 CREATE OR REPLACE FUNCTION biblio.extract_quality ( marc TEXT, best_lang TEXT, best_type TEXT ) RETURNS INT AS $func$
829 DECLARE
830     qual        INT;
831     ldr         TEXT;
832     tval        TEXT;
833     tval_rec    RECORD;
834     bval        TEXT;
835     bval_rec    RECORD;
836     type_map    RECORD;
837     ff_pos      RECORD;
838     ff_tag_data TEXT;
839 BEGIN
840
841     IF marc IS NULL OR marc = '' THEN
842         RETURN NULL;
843     END IF;
844
845     -- First, the count of tags
846     qual := ARRAY_UPPER(oils_xpath('*[local-name()="datafield"]', marc), 1);
847
848     -- now go through a bunch of pain to get the record type
849     IF best_type IS NOT NULL THEN
850         ldr := (oils_xpath('//*[local-name()="leader"]/text()', marc))[1];
851
852         IF ldr IS NOT NULL THEN
853             SELECT * INTO tval_rec FROM config.marc21_ff_pos_map WHERE fixed_field = 'Type' LIMIT 1; -- They're all the same
854             SELECT * INTO bval_rec FROM config.marc21_ff_pos_map WHERE fixed_field = 'BLvl' LIMIT 1; -- They're all the same
855
856
857             tval := SUBSTRING( ldr, tval_rec.start_pos + 1, tval_rec.length );
858             bval := SUBSTRING( ldr, bval_rec.start_pos + 1, bval_rec.length );
859
860             -- RAISE NOTICE 'type %, blvl %, ldr %', tval, bval, ldr;
861
862             SELECT * INTO type_map FROM config.marc21_rec_type_map WHERE type_val LIKE '%' || tval || '%' AND blvl_val LIKE '%' || bval || '%';
863
864             IF type_map.code IS NOT NULL THEN
865                 IF best_type = type_map.code THEN
866                     qual := qual + qual / 2;
867                 END IF;
868
869                 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
870                     ff_tag_data := SUBSTRING((oils_xpath('//*[@tag="' || ff_pos.tag || '"]/text()',marc))[1], ff_pos.start_pos + 1, ff_pos.length);
871                     IF ff_tag_data = best_lang THEN
872                             qual := qual + 100;
873                     END IF;
874                 END LOOP;
875             END IF;
876         END IF;
877     END IF;
878
879     -- Now look for some quality metrics
880     -- DCL record?
881     IF ARRAY_UPPER(oils_xpath('//*[@tag="040"]/*[@code="a" and contains(.,"DLC")]', marc), 1) = 1 THEN
882         qual := qual + 10;
883     END IF;
884
885     -- From OCLC?
886     IF (oils_xpath('//*[@tag="003"]/text()', marc))[1] ~* E'oclo?c' THEN
887         qual := qual + 10;
888     END IF;
889
890     RETURN qual;
891
892 END;
893 $func$ LANGUAGE PLPGSQL;
894
895 CREATE OR REPLACE FUNCTION biblio.extract_fingerprint ( marc text ) RETURNS TEXT AS $func$
896 DECLARE
897         idx             config.biblio_fingerprint%ROWTYPE;
898         xfrm            config.xml_transform%ROWTYPE;
899         prev_xfrm       TEXT;
900         transformed_xml TEXT;
901         xml_node        TEXT;
902         xml_node_list   TEXT[];
903         raw_text        TEXT;
904     output_text TEXT := '';
905 BEGIN
906
907     IF marc IS NULL OR marc = '' THEN
908         RETURN NULL;
909     END IF;
910
911         -- Loop over the indexing entries
912         FOR idx IN SELECT * FROM config.biblio_fingerprint ORDER BY format, id LOOP
913
914                 SELECT INTO xfrm * from config.xml_transform WHERE name = idx.format;
915
916                 -- See if we can skip the XSLT ... it's expensive
917                 IF prev_xfrm IS NULL OR prev_xfrm <> xfrm.name THEN
918                         -- Can't skip the transform
919                         IF xfrm.xslt <> '---' THEN
920                                 transformed_xml := oils_xslt_process(marc,xfrm.xslt);
921                         ELSE
922                                 transformed_xml := marc;
923                         END IF;
924
925                         prev_xfrm := xfrm.name;
926                 END IF;
927
928                 raw_text := COALESCE(
929             naco_normalize(
930                 ARRAY_TO_STRING(
931                     oils_xpath(
932                         '//text()',
933                         (oils_xpath(
934                             idx.xpath,
935                             transformed_xml,
936                             ARRAY[ARRAY[xfrm.prefix, xfrm.namespace_uri]] 
937                         ))[1]
938                     ),
939                     ''
940                 )
941             ),
942             ''
943         );
944
945         raw_text := REGEXP_REPLACE(raw_text, E'\\[.+?\\]', E'');
946         raw_text := REGEXP_REPLACE(raw_text, E'\\mthe\\M|\\man?d?d\\M', E'', 'g'); -- arg! the pain!
947
948         IF idx.first_word IS TRUE THEN
949             raw_text := REGEXP_REPLACE(raw_text, E'^(\\w+).*?$', E'\\1');
950         END IF;
951
952                 output_text := output_text || REGEXP_REPLACE(raw_text, E'\\s+', '', 'g');
953
954         END LOOP;
955
956     RETURN output_text;
957
958 END;
959 $func$ LANGUAGE PLPGSQL;
960
961 -- BEFORE UPDATE OR INSERT trigger for biblio.record_entry
962 CREATE OR REPLACE FUNCTION biblio.fingerprint_trigger () RETURNS TRIGGER AS $func$
963 BEGIN
964
965     -- For TG_ARGV, first param is language (like 'eng'), second is record type (like 'BKS')
966
967     IF NEW.deleted IS TRUE THEN -- we don't much care, then, do we?
968         RETURN NEW;
969     END IF;
970
971     NEW.fingerprint := biblio.extract_fingerprint(NEW.marc);
972     NEW.quality := biblio.extract_quality(NEW.marc, TG_ARGV[0], TG_ARGV[1]);
973
974     RETURN NEW;
975
976 END;
977 $func$ LANGUAGE PLPGSQL;
978
979 CREATE OR REPLACE FUNCTION metabib.reingest_metabib_full_rec( bib_id BIGINT ) RETURNS VOID AS $func$
980 BEGIN
981     PERFORM * FROM config.internal_flag WHERE name = 'ingest.assume_inserts_only' AND enabled;
982     IF NOT FOUND THEN
983         DELETE FROM metabib.real_full_rec WHERE record = bib_id;
984     END IF;
985     INSERT INTO metabib.real_full_rec (record, tag, ind1, ind2, subfield, value)
986         SELECT record, tag, ind1, ind2, subfield, value FROM biblio.flatten_marc( bib_id );
987
988     RETURN;
989 END;
990 $func$ LANGUAGE PLPGSQL;
991
992 CREATE OR REPLACE FUNCTION biblio.extract_located_uris( bib_id BIGINT, marcxml TEXT, editor_id INT ) RETURNS VOID AS $func$
993 DECLARE
994     uris            TEXT[];
995     uri_xml         TEXT;
996     uri_label       TEXT;
997     uri_href        TEXT;
998     uri_use         TEXT;
999     uri_owner_list  TEXT[];
1000     uri_owner       TEXT;
1001     uri_owner_id    INT;
1002     uri_id          INT;
1003     uri_cn_id       INT;
1004     uri_map_id      INT;
1005 BEGIN
1006
1007     -- Clear any URI mappings and call numbers for this bib.
1008     -- This leads to acn / auricnm inflation, but also enables
1009     -- old acn/auricnm's to go away and for bibs to be deleted.
1010     FOR uri_cn_id IN SELECT id FROM asset.call_number WHERE record = bib_id AND label = '##URI##' AND NOT deleted LOOP
1011         DELETE FROM asset.uri_call_number_map WHERE call_number = uri_cn_id;
1012         DELETE FROM asset.call_number WHERE id = uri_cn_id;
1013     END LOOP;
1014
1015     uris := oils_xpath('//*[@tag="856" and (@ind1="4" or @ind1="1") and (@ind2="0" or @ind2="1")]',marcxml);
1016     IF ARRAY_UPPER(uris,1) > 0 THEN
1017         FOR i IN 1 .. ARRAY_UPPER(uris, 1) LOOP
1018             -- First we pull info out of the 856
1019             uri_xml     := uris[i];
1020
1021             uri_href    := (oils_xpath('//*[@code="u"]/text()',uri_xml))[1];
1022             uri_label   := (oils_xpath('//*[@code="y"]/text()|//*[@code="3"]/text()',uri_xml))[1];
1023             uri_use     := (oils_xpath('//*[@code="z"]/text()|//*[@code="2"]/text()|//*[@code="n"]/text()',uri_xml))[1];
1024
1025             IF uri_label IS NULL THEN
1026                 uri_label := uri_href;
1027             END IF;
1028             CONTINUE WHEN uri_href IS NULL;
1029
1030             -- Get the distinct list of libraries wanting to use 
1031             SELECT  ARRAY_ACCUM(
1032                         DISTINCT REGEXP_REPLACE(
1033                             x,
1034                             $re$^.*?\((\w+)\).*$$re$,
1035                             E'\\1'
1036                         )
1037                     ) INTO uri_owner_list
1038               FROM  UNNEST(
1039                         oils_xpath(
1040                             '//*[@code="9"]/text()|//*[@code="w"]/text()|//*[@code="n"]/text()',
1041                             uri_xml
1042                         )
1043                     )x;
1044
1045             IF ARRAY_UPPER(uri_owner_list,1) > 0 THEN
1046
1047                 -- look for a matching uri
1048                 IF uri_use IS NULL THEN
1049                     SELECT id INTO uri_id
1050                         FROM asset.uri
1051                         WHERE label = uri_label AND href = uri_href AND use_restriction IS NULL AND active
1052                         ORDER BY id LIMIT 1;
1053                     IF NOT FOUND THEN -- create one
1054                         INSERT INTO asset.uri (label, href, use_restriction) VALUES (uri_label, uri_href, uri_use);
1055                         SELECT id INTO uri_id
1056                             FROM asset.uri
1057                             WHERE label = uri_label AND href = uri_href AND use_restriction IS NULL AND active;
1058                     END IF;
1059                 ELSE
1060                     SELECT id INTO uri_id
1061                         FROM asset.uri
1062                         WHERE label = uri_label AND href = uri_href AND use_restriction = uri_use AND active
1063                         ORDER BY id LIMIT 1;
1064                     IF NOT FOUND THEN -- create one
1065                         INSERT INTO asset.uri (label, href, use_restriction) VALUES (uri_label, uri_href, uri_use);
1066                         SELECT id INTO uri_id
1067                             FROM asset.uri
1068                             WHERE label = uri_label AND href = uri_href AND use_restriction = uri_use AND active;
1069                     END IF;
1070                 END IF;
1071
1072                 FOR j IN 1 .. ARRAY_UPPER(uri_owner_list, 1) LOOP
1073                     uri_owner := uri_owner_list[j];
1074
1075                     SELECT id INTO uri_owner_id FROM actor.org_unit WHERE shortname = uri_owner;
1076                     CONTINUE WHEN NOT FOUND;
1077
1078                     -- we need a call number to link through
1079                     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;
1080                     IF NOT FOUND THEN
1081                         INSERT INTO asset.call_number (owning_lib, record, create_date, edit_date, creator, editor, label)
1082                             VALUES (uri_owner_id, bib_id, 'now', 'now', editor_id, editor_id, '##URI##');
1083                         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;
1084                     END IF;
1085
1086                     -- now, link them if they're not already
1087                     SELECT id INTO uri_map_id FROM asset.uri_call_number_map WHERE call_number = uri_cn_id AND uri = uri_id;
1088                     IF NOT FOUND THEN
1089                         INSERT INTO asset.uri_call_number_map (call_number, uri) VALUES (uri_cn_id, uri_id);
1090                     END IF;
1091
1092                 END LOOP;
1093
1094             END IF;
1095
1096         END LOOP;
1097     END IF;
1098
1099     RETURN;
1100 END;
1101 $func$ LANGUAGE PLPGSQL;
1102
1103 CREATE OR REPLACE FUNCTION metabib.remap_metarecord_for_bib( bib_id BIGINT, fp TEXT ) RETURNS BIGINT AS $func$
1104 DECLARE
1105     source_count    INT;
1106     old_mr          BIGINT;
1107     tmp_mr          metabib.metarecord%ROWTYPE;
1108     deleted_mrs     BIGINT[];
1109 BEGIN
1110
1111     DELETE FROM metabib.metarecord_source_map WHERE source = bib_id; -- Rid ourselves of the search-estimate-killing linkage
1112
1113     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
1114
1115         IF old_mr IS NULL AND fp = tmp_mr.fingerprint THEN -- Find the first fingerprint-matching
1116             old_mr := tmp_mr.id;
1117         ELSE
1118             SELECT COUNT(*) INTO source_count FROM metabib.metarecord_source_map WHERE metarecord = tmp_mr.id;
1119             IF source_count = 0 THEN -- No other records
1120                 deleted_mrs := ARRAY_APPEND(deleted_mrs, tmp_mr.id);
1121                 DELETE FROM metabib.metarecord WHERE id = tmp_mr.id;
1122             END IF;
1123         END IF;
1124
1125     END LOOP;
1126
1127     IF old_mr IS NULL THEN -- we found no suitable, preexisting MR based on old source maps
1128         SELECT id INTO old_mr FROM metabib.metarecord WHERE fingerprint = fp; -- is there one for our current fingerprint?
1129         IF old_mr IS NULL THEN -- nope, create one and grab its id
1130             INSERT INTO metabib.metarecord ( fingerprint, master_record ) VALUES ( fp, bib_id );
1131             SELECT id INTO old_mr FROM metabib.metarecord WHERE fingerprint = fp;
1132         ELSE -- indeed there is. update it with a null cache and recalcualated master record
1133             UPDATE  metabib.metarecord
1134               SET   mods = NULL,
1135                     master_record = ( SELECT id FROM biblio.record_entry WHERE fingerprint = fp ORDER BY quality DESC LIMIT 1)
1136               WHERE id = old_mr;
1137         END IF;
1138     ELSE -- there was one we already attached to, update its mods cache and master_record
1139         UPDATE  metabib.metarecord
1140           SET   mods = NULL,
1141                 master_record = ( SELECT id FROM biblio.record_entry WHERE fingerprint = fp ORDER BY quality DESC LIMIT 1)
1142           WHERE id = old_mr;
1143     END IF;
1144
1145     INSERT INTO metabib.metarecord_source_map (metarecord, source) VALUES (old_mr, bib_id); -- new source mapping
1146
1147     IF ARRAY_UPPER(deleted_mrs,1) > 0 THEN
1148         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
1149     END IF;
1150
1151     RETURN old_mr;
1152
1153 END;
1154 $func$ LANGUAGE PLPGSQL;
1155
1156 CREATE OR REPLACE FUNCTION biblio.map_authority_linking (bibid BIGINT, marc TEXT) RETURNS BIGINT AS $func$
1157     DELETE FROM authority.bib_linking WHERE bib = $1;
1158     INSERT INTO authority.bib_linking (bib, authority)
1159         SELECT  y.bib,
1160                 y.authority
1161           FROM (    SELECT  DISTINCT $1 AS bib,
1162                             BTRIM(remove_paren_substring(txt))::BIGINT AS authority
1163                       FROM  unnest(oils_xpath('//*[@code="0"]/text()',$2)) x(txt)
1164                       WHERE BTRIM(remove_paren_substring(txt)) ~ $re$^\d+$$re$
1165                 ) y JOIN authority.record_entry r ON r.id = y.authority;
1166     SELECT $1;
1167 $func$ LANGUAGE SQL;
1168
1169 -- AFTER UPDATE OR INSERT trigger for biblio.record_entry
1170 CREATE OR REPLACE FUNCTION biblio.indexing_ingest_or_delete () RETURNS TRIGGER AS $func$
1171 DECLARE
1172     transformed_xml TEXT;
1173     prev_xfrm       TEXT;
1174     normalizer      RECORD;
1175     xfrm            config.xml_transform%ROWTYPE;
1176     attr_value      TEXT;
1177     new_attrs       HSTORE := ''::HSTORE;
1178     attr_def        config.record_attr_definition%ROWTYPE;
1179 BEGIN
1180
1181     IF NEW.deleted IS TRUE THEN -- If this bib is deleted
1182         PERFORM * FROM config.internal_flag WHERE
1183             name = 'ingest.metarecord_mapping.preserve_on_delete' AND enabled;
1184         IF NOT FOUND THEN
1185             -- One needs to keep these around to support searches
1186             -- with the #deleted modifier, so one should turn on the named
1187             -- internal flag for that functionality.
1188             DELETE FROM metabib.metarecord_source_map WHERE source = NEW.id;
1189             DELETE FROM metabib.record_attr WHERE id = NEW.id;
1190         END IF;
1191
1192         DELETE FROM authority.bib_linking WHERE bib = NEW.id; -- Avoid updating fields in bibs that are no longer visible
1193         DELETE FROM biblio.peer_bib_copy_map WHERE peer_record = NEW.id; -- Separate any multi-homed items
1194         DELETE FROM metabib.browse_entry_def_map WHERE source = NEW.id; -- Don't auto-suggest deleted bibs
1195         RETURN NEW; -- and we're done
1196     END IF;
1197
1198     IF TG_OP = 'UPDATE' THEN -- re-ingest?
1199         PERFORM * FROM config.internal_flag WHERE name = 'ingest.reingest.force_on_same_marc' AND enabled;
1200
1201         IF NOT FOUND AND OLD.marc = NEW.marc THEN -- don't do anything if the MARC didn't change
1202             RETURN NEW;
1203         END IF;
1204     END IF;
1205
1206     -- Record authority linking
1207     PERFORM * FROM config.internal_flag WHERE name = 'ingest.disable_authority_linking' AND enabled;
1208     IF NOT FOUND THEN
1209         PERFORM biblio.map_authority_linking( NEW.id, NEW.marc );
1210     END IF;
1211
1212     -- Flatten and insert the mfr data
1213     PERFORM * FROM config.internal_flag WHERE name = 'ingest.disable_metabib_full_rec' AND enabled;
1214     IF NOT FOUND THEN
1215         PERFORM metabib.reingest_metabib_full_rec(NEW.id);
1216
1217         -- Now we pull out attribute data, which is dependent on the mfr for all but XPath-based fields
1218         PERFORM * FROM config.internal_flag WHERE name = 'ingest.disable_metabib_rec_descriptor' AND enabled;
1219         IF NOT FOUND THEN
1220             FOR attr_def IN SELECT * FROM config.record_attr_definition ORDER BY format LOOP
1221
1222                 IF attr_def.tag IS NOT NULL THEN -- tag (and optional subfield list) selection
1223                     SELECT  ARRAY_TO_STRING(ARRAY_ACCUM(value), COALESCE(attr_def.joiner,' ')) INTO attr_value
1224                       FROM  (SELECT * FROM metabib.full_rec ORDER BY tag, subfield) AS x
1225                       WHERE record = NEW.id
1226                             AND tag LIKE attr_def.tag
1227                             AND CASE
1228                                 WHEN attr_def.sf_list IS NOT NULL 
1229                                     THEN POSITION(subfield IN attr_def.sf_list) > 0
1230                                 ELSE TRUE
1231                                 END
1232                       GROUP BY tag
1233                       ORDER BY tag
1234                       LIMIT 1;
1235
1236                 ELSIF attr_def.fixed_field IS NOT NULL THEN -- a named fixed field, see config.marc21_ff_pos_map.fixed_field
1237                     attr_value := biblio.marc21_extract_fixed_field(NEW.id, attr_def.fixed_field);
1238
1239                 ELSIF attr_def.xpath IS NOT NULL THEN -- and xpath expression
1240
1241                     SELECT INTO xfrm * FROM config.xml_transform WHERE name = attr_def.format;
1242             
1243                     -- See if we can skip the XSLT ... it's expensive
1244                     IF prev_xfrm IS NULL OR prev_xfrm <> xfrm.name THEN
1245                         -- Can't skip the transform
1246                         IF xfrm.xslt <> '---' THEN
1247                             transformed_xml := oils_xslt_process(NEW.marc,xfrm.xslt);
1248                         ELSE
1249                             transformed_xml := NEW.marc;
1250                         END IF;
1251             
1252                         prev_xfrm := xfrm.name;
1253                     END IF;
1254
1255                     IF xfrm.name IS NULL THEN
1256                         -- just grab the marcxml (empty) transform
1257                         SELECT INTO xfrm * FROM config.xml_transform WHERE xslt = '---' LIMIT 1;
1258                         prev_xfrm := xfrm.name;
1259                     END IF;
1260
1261                     attr_value := oils_xpath_string(attr_def.xpath, transformed_xml, COALESCE(attr_def.joiner,' '), ARRAY[ARRAY[xfrm.prefix, xfrm.namespace_uri]]);
1262
1263                 ELSIF attr_def.phys_char_sf IS NOT NULL THEN -- a named Physical Characteristic, see config.marc21_physical_characteristic_*_map
1264                     SELECT  m.value INTO attr_value
1265                       FROM  biblio.marc21_physical_characteristics(NEW.id) v
1266                             JOIN config.marc21_physical_characteristic_value_map m ON (m.id = v.value)
1267                       WHERE v.subfield = attr_def.phys_char_sf
1268                       LIMIT 1; -- Just in case ...
1269
1270                 END IF;
1271
1272                 -- apply index normalizers to attr_value
1273                 FOR normalizer IN
1274                     SELECT  n.func AS func,
1275                             n.param_count AS param_count,
1276                             m.params AS params
1277                       FROM  config.index_normalizer n
1278                             JOIN config.record_attr_index_norm_map m ON (m.norm = n.id)
1279                       WHERE attr = attr_def.name
1280                       ORDER BY m.pos LOOP
1281                         EXECUTE 'SELECT ' || normalizer.func || '(' ||
1282                             COALESCE( quote_literal( attr_value ), 'NULL' ) ||
1283                             CASE
1284                                 WHEN normalizer.param_count > 0
1285                                     THEN ',' || REPLACE(REPLACE(BTRIM(normalizer.params,'[]'),E'\'',E'\\\''),E'"',E'\'')
1286                                     ELSE ''
1287                                 END ||
1288                             ')' INTO attr_value;
1289         
1290                 END LOOP;
1291
1292                 -- Add the new value to the hstore
1293                 new_attrs := new_attrs || hstore( attr_def.name, attr_value );
1294
1295             END LOOP;
1296
1297             IF TG_OP = 'INSERT' OR OLD.deleted THEN -- initial insert OR revivication
1298                 DELETE FROM metabib.record_attr WHERE id = NEW.id;
1299                 INSERT INTO metabib.record_attr (id, attrs) VALUES (NEW.id, new_attrs);
1300             ELSE
1301                 UPDATE metabib.record_attr SET attrs = new_attrs WHERE id = NEW.id;
1302             END IF;
1303
1304         END IF;
1305     END IF;
1306
1307     -- Gather and insert the field entry data
1308     PERFORM metabib.reingest_metabib_field_entries(NEW.id);
1309
1310     -- Located URI magic
1311     IF TG_OP = 'INSERT' THEN
1312         PERFORM * FROM config.internal_flag WHERE name = 'ingest.disable_located_uri' AND enabled;
1313         IF NOT FOUND THEN
1314             PERFORM biblio.extract_located_uris( NEW.id, NEW.marc, NEW.editor );
1315         END IF;
1316     ELSE
1317         PERFORM * FROM config.internal_flag WHERE name = 'ingest.disable_located_uri' AND enabled;
1318         IF NOT FOUND THEN
1319             PERFORM biblio.extract_located_uris( NEW.id, NEW.marc, NEW.editor );
1320         END IF;
1321     END IF;
1322
1323     -- (re)map metarecord-bib linking
1324     IF TG_OP = 'INSERT' THEN -- if not deleted and performing an insert, check for the flag
1325         PERFORM * FROM config.internal_flag WHERE name = 'ingest.metarecord_mapping.skip_on_insert' AND enabled;
1326         IF NOT FOUND THEN
1327             PERFORM metabib.remap_metarecord_for_bib( NEW.id, NEW.fingerprint );
1328         END IF;
1329     ELSE -- we're doing an update, and we're not deleted, remap
1330         PERFORM * FROM config.internal_flag WHERE name = 'ingest.metarecord_mapping.skip_on_update' AND enabled;
1331         IF NOT FOUND THEN
1332             PERFORM metabib.remap_metarecord_for_bib( NEW.id, NEW.fingerprint );
1333         END IF;
1334     END IF;
1335
1336     RETURN NEW;
1337 END;
1338 $func$ LANGUAGE PLPGSQL;
1339
1340 CREATE OR REPLACE FUNCTION metabib.browse_normalize(facet_text TEXT, mapped_field INT) RETURNS TEXT AS $$
1341 DECLARE
1342     normalizer  RECORD;
1343 BEGIN
1344
1345     FOR normalizer IN
1346         SELECT  n.func AS func,
1347                 n.param_count AS param_count,
1348                 m.params AS params
1349           FROM  config.index_normalizer n
1350                 JOIN config.metabib_field_index_norm_map m ON (m.norm = n.id)
1351           WHERE m.field = mapped_field AND m.pos < 0
1352           ORDER BY m.pos LOOP
1353
1354             EXECUTE 'SELECT ' || normalizer.func || '(' ||
1355                 quote_literal( facet_text ) ||
1356                 CASE
1357                     WHEN normalizer.param_count > 0
1358                         THEN ',' || REPLACE(REPLACE(BTRIM(normalizer.params,'[]'),E'\'',E'\\\''),E'"',E'\'')
1359                         ELSE ''
1360                     END ||
1361                 ')' INTO facet_text;
1362
1363     END LOOP;
1364
1365     RETURN facet_text;
1366 END;
1367
1368 $$ LANGUAGE PLPGSQL;
1369
1370
1371 -- This mimics a specific part of QueryParser, turning the first part of a
1372 -- classed search (search_class) into a set of classes and possibly fields.
1373 -- search_class might look like "author" or "title|proper" or "ti|uniform"
1374 -- or "au" or "au|corporate|personal" or anything like that, where the first
1375 -- element of the list you get by separating on the "|" character is either
1376 -- a registered class (config.metabib_class) or an alias
1377 -- (config.metabib_search_alias), and the rest of any such elements are
1378 -- fields (config.metabib_field).
1379 CREATE OR REPLACE
1380     FUNCTION metabib.search_class_to_registered_components(search_class TEXT)
1381     RETURNS SETOF RECORD AS $func$
1382 DECLARE
1383     search_parts        TEXT[];
1384     field_name          TEXT;
1385     search_part_count   INTEGER;
1386     rec                 RECORD;
1387     registered_class    config.metabib_class%ROWTYPE;
1388     registered_alias    config.metabib_search_alias%ROWTYPE;
1389     registered_field    config.metabib_field%ROWTYPE;
1390 BEGIN
1391     search_parts := REGEXP_SPLIT_TO_ARRAY(search_class, E'\\|');
1392
1393     search_part_count := ARRAY_LENGTH(search_parts, 1);
1394     IF search_part_count = 0 THEN
1395         RETURN;
1396     ELSE
1397         SELECT INTO registered_class
1398             * FROM config.metabib_class WHERE name = search_parts[1];
1399         IF FOUND THEN
1400             IF search_part_count < 2 THEN   -- all fields
1401                 rec := (registered_class.name, NULL::INTEGER);
1402                 RETURN NEXT rec;
1403                 RETURN; -- done
1404             END IF;
1405             FOR field_name IN SELECT *
1406                 FROM UNNEST(search_parts[2:search_part_count]) LOOP
1407                 SELECT INTO registered_field
1408                     * FROM config.metabib_field
1409                     WHERE name = field_name AND
1410                         field_class = registered_class.name;
1411                 IF FOUND THEN
1412                     rec := (registered_class.name, registered_field.id);
1413                     RETURN NEXT rec;
1414                 END IF;
1415             END LOOP;
1416         ELSE
1417             -- maybe we have an alias?
1418             SELECT INTO registered_alias
1419                 * FROM config.metabib_search_alias WHERE alias=search_parts[1];
1420             IF NOT FOUND THEN
1421                 RETURN;
1422             ELSE
1423                 IF search_part_count < 2 THEN   -- return w/e the alias says
1424                     rec := (
1425                         registered_alias.field_class, registered_alias.field
1426                     );
1427                     RETURN NEXT rec;
1428                     RETURN; -- done
1429                 ELSE
1430                     FOR field_name IN SELECT *
1431                         FROM UNNEST(search_parts[2:search_part_count]) LOOP
1432                         SELECT INTO registered_field
1433                             * FROM config.metabib_field
1434                             WHERE name = field_name AND
1435                                 field_class = registered_alias.field_class;
1436                         IF FOUND THEN
1437                             rec := (
1438                                 registered_alias.field_class,
1439                                 registered_field.id
1440                             );
1441                             RETURN NEXT rec;
1442                         END IF;
1443                     END LOOP;
1444                 END IF;
1445             END IF;
1446         END IF;
1447     END IF;
1448 END;
1449 $func$ LANGUAGE PLPGSQL ROWS 1;
1450
1451
1452 -- Given a string such as a user might type into a search box, prepare
1453 -- two changed variants for TO_TSQUERY(). See
1454 -- http://www.postgresql.org/docs/9.0/static/textsearch-controls.html
1455 -- The first variant is normalized to match indexed documents regardless
1456 -- of diacritics.  The second variant keeps its diacritics for proper
1457 -- highlighting via TS_HEADLINE().
1458 CREATE OR REPLACE
1459     FUNCTION metabib.autosuggest_prepare_tsquery(orig TEXT) RETURNS TEXT[] AS
1460 $$
1461 DECLARE
1462     orig_ended_in_space     BOOLEAN;
1463     result                  RECORD;
1464     plain                   TEXT;
1465     normalized              TEXT;
1466 BEGIN
1467     orig_ended_in_space := orig ~ E'\\s$';
1468
1469     orig := ARRAY_TO_STRING(
1470         evergreen.regexp_split_to_array(orig, E'\\W+'), ' '
1471     );
1472
1473     normalized := public.search_normalize(orig); -- also trim()s
1474     plain := trim(orig);
1475
1476     IF NOT orig_ended_in_space THEN
1477         plain := plain || ':*';
1478         normalized := normalized || ':*';
1479     END IF;
1480
1481     plain := ARRAY_TO_STRING(
1482         evergreen.regexp_split_to_array(plain, E'\\s+'), ' & '
1483     );
1484     normalized := ARRAY_TO_STRING(
1485         evergreen.regexp_split_to_array(normalized, E'\\s+'), ' & '
1486     );
1487
1488     RETURN ARRAY[normalized, plain];
1489 END;
1490 $$ LANGUAGE PLPGSQL;
1491
1492
1493 CREATE OR REPLACE
1494     FUNCTION metabib.suggest_browse_entries(
1495         raw_query_text  TEXT,   -- actually typed by humans at the UI level
1496         search_class    TEXT,   -- 'alias' or 'class' or 'class|field..', etc
1497         headline_opts   TEXT,   -- markup options for ts_headline()
1498         visibility_org  INTEGER,-- null if you don't want opac visibility test
1499         query_limit     INTEGER,-- use in LIMIT clause of interal query
1500         normalization   INTEGER -- argument to TS_RANK_CD()
1501     ) RETURNS TABLE (
1502         value                   TEXT,   -- plain
1503         field                   INTEGER,
1504         buoyant_and_class_match BOOL,
1505         field_match             BOOL,
1506         field_weight            INTEGER,
1507         rank                    REAL,
1508         buoyant                 BOOL,
1509         match                   TEXT    -- marked up
1510     ) AS $func$
1511 DECLARE
1512     prepared_query_texts    TEXT[];
1513     query                   TSQUERY;
1514     plain_query             TSQUERY;
1515     opac_visibility_join    TEXT;
1516     search_class_join       TEXT;
1517     r_fields                RECORD;
1518 BEGIN
1519     prepared_query_texts := metabib.autosuggest_prepare_tsquery(raw_query_text);
1520
1521     query := TO_TSQUERY('keyword', prepared_query_texts[1]);
1522     plain_query := TO_TSQUERY('keyword', prepared_query_texts[2]);
1523
1524     visibility_org := NULLIF(visibility_org,-1);
1525     IF visibility_org IS NOT NULL THEN
1526         opac_visibility_join := '
1527     JOIN asset.opac_visible_copies aovc ON (
1528         aovc.record = x.source AND
1529         aovc.circ_lib IN (SELECT id FROM actor.org_unit_descendants($4))
1530     )';
1531     ELSE
1532         opac_visibility_join := '';
1533     END IF;
1534
1535     -- The following determines whether we only provide suggestsons matching
1536     -- the user's selected search_class, or whether we show other suggestions
1537     -- too. The reason for MIN() is that for search_classes like
1538     -- 'title|proper|uniform' you would otherwise get multiple rows.  The
1539     -- implication is that if title as a class doesn't have restrict,
1540     -- nor does the proper field, but the uniform field does, you're going
1541     -- to get 'false' for your overall evaluation of 'should we restrict?'
1542     -- To invert that, change from MIN() to MAX().
1543
1544     SELECT
1545         INTO r_fields
1546             MIN(cmc.restrict::INT) AS restrict_class,
1547             MIN(cmf.restrict::INT) AS restrict_field
1548         FROM metabib.search_class_to_registered_components(search_class)
1549             AS _registered (field_class TEXT, field INT)
1550         JOIN
1551             config.metabib_class cmc ON (cmc.name = _registered.field_class)
1552         LEFT JOIN
1553             config.metabib_field cmf ON (cmf.id = _registered.field);
1554
1555     -- evaluate 'should we restrict?'
1556     IF r_fields.restrict_field::BOOL OR r_fields.restrict_class::BOOL THEN
1557         search_class_join := '
1558     JOIN
1559         metabib.search_class_to_registered_components($2)
1560         AS _registered (field_class TEXT, field INT) ON (
1561             (_registered.field IS NULL AND
1562                 _registered.field_class = cmf.field_class) OR
1563             (_registered.field = cmf.id)
1564         )
1565     ';
1566     ELSE
1567         search_class_join := '
1568     LEFT JOIN
1569         metabib.search_class_to_registered_components($2)
1570         AS _registered (field_class TEXT, field INT) ON (
1571             _registered.field_class = cmc.name
1572         )
1573     ';
1574     END IF;
1575
1576     RETURN QUERY EXECUTE '
1577 SELECT  DISTINCT
1578         x.value,
1579         x.id,
1580         x.push,
1581         x.restrict,
1582         x.weight,
1583         x.ts_rank_cd,
1584         x.buoyant,
1585         TS_HEADLINE(value, $7, $3)
1586   FROM  (SELECT DISTINCT
1587                 mbe.value,
1588                 cmf.id,
1589                 cmc.buoyant AND _registered.field_class IS NOT NULL AS push,
1590                 _registered.field = cmf.id AS restrict,
1591                 cmf.weight,
1592                 TS_RANK_CD(mbe.index_vector, $1, $6),
1593                 cmc.buoyant,
1594                 mbedm.source
1595           FROM  metabib.browse_entry_def_map mbedm
1596                 JOIN (SELECT * FROM metabib.browse_entry WHERE index_vector @@ $1 LIMIT 10000) mbe ON (mbe.id = mbedm.entry)
1597                 JOIN config.metabib_field cmf ON (cmf.id = mbedm.def)
1598                 JOIN config.metabib_class cmc ON (cmf.field_class = cmc.name)
1599                 '  || search_class_join || '
1600           ORDER BY 3 DESC, 4 DESC NULLS LAST, 5 DESC, 6 DESC, 7 DESC, 1 ASC
1601           LIMIT 1000) AS x
1602         ' || opac_visibility_join || '
1603   ORDER BY 3 DESC, 4 DESC NULLS LAST, 5 DESC, 6 DESC, 7 DESC, 1 ASC
1604   LIMIT $5
1605 '   -- sic, repeat the order by clause in the outer select too
1606     USING
1607         query, search_class, headline_opts,
1608         visibility_org, query_limit, normalization, plain_query
1609         ;
1610
1611     -- sort order:
1612     --  buoyant AND chosen class = match class
1613     --  chosen field = match field
1614     --  field weight
1615     --  rank
1616     --  buoyancy
1617     --  value itself
1618
1619 END;
1620 $func$ LANGUAGE PLPGSQL;
1621
1622 CREATE OR REPLACE FUNCTION public.oils_tsearch2 () RETURNS TRIGGER AS $$
1623 DECLARE
1624     normalizer      RECORD;
1625     value           TEXT := '';
1626     temp_vector     TEXT := '';
1627     ts_rec          RECORD;
1628     cur_weight      "char";
1629 BEGIN
1630
1631     value := NEW.value;
1632     NEW.index_vector = ''::tsvector;
1633
1634     IF TG_TABLE_NAME::TEXT ~ 'field_entry$' THEN
1635         FOR normalizer IN
1636             SELECT  n.func AS func,
1637                     n.param_count AS param_count,
1638                     m.params AS params
1639               FROM  config.index_normalizer n
1640                     JOIN config.metabib_field_index_norm_map m ON (m.norm = n.id)
1641               WHERE field = NEW.field AND m.pos < 0
1642               ORDER BY m.pos LOOP
1643                 EXECUTE 'SELECT ' || normalizer.func || '(' ||
1644                     quote_literal( value ) ||
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 value;
1651
1652         END LOOP;
1653
1654         NEW.value = value;
1655
1656         FOR normalizer IN
1657             SELECT  n.func AS func,
1658                     n.param_count AS param_count,
1659                     m.params AS params
1660               FROM  config.index_normalizer n
1661                     JOIN config.metabib_field_index_norm_map m ON (m.norm = n.id)
1662               WHERE field = NEW.field AND m.pos >= 0
1663               ORDER BY m.pos LOOP
1664                 EXECUTE 'SELECT ' || normalizer.func || '(' ||
1665                     quote_literal( value ) ||
1666                     CASE
1667                         WHEN normalizer.param_count > 0
1668                             THEN ',' || REPLACE(REPLACE(BTRIM(normalizer.params,'[]'),E'\'',E'\\\''),E'"',E'\'')
1669                             ELSE ''
1670                         END ||
1671                     ')' INTO value;
1672
1673         END LOOP;
1674    END IF;
1675
1676     IF TG_TABLE_NAME::TEXT ~ 'browse_entry$' THEN
1677         value :=  ARRAY_TO_STRING(
1678             evergreen.regexp_split_to_array(value, E'\\W+'), ' '
1679         );
1680         value := public.search_normalize(value);
1681         NEW.index_vector = to_tsvector(TG_ARGV[0]::regconfig, value);
1682     ELSIF TG_TABLE_NAME::TEXT ~ 'field_entry$' THEN
1683         FOR ts_rec IN
1684             SELECT ts_config, index_weight
1685             FROM config.metabib_class_ts_map
1686             WHERE field_class = TG_ARGV[0]
1687                 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'))
1688                 AND always OR NOT EXISTS (SELECT 1 FROM config.metabib_field_ts_map WHERE metabib_field = NEW.field)
1689             UNION
1690             SELECT ts_config, index_weight
1691             FROM config.metabib_field_ts_map
1692             WHERE metabib_field = NEW.field
1693                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'))
1694             ORDER BY index_weight ASC
1695         LOOP
1696             IF cur_weight IS NOT NULL AND cur_weight != ts_rec.index_weight THEN
1697                 NEW.index_vector = NEW.index_vector || setweight(temp_vector::tsvector,cur_weight);
1698                 temp_vector = '';
1699             END IF;
1700             cur_weight = ts_rec.index_weight;
1701             SELECT INTO temp_vector temp_vector || ' ' || to_tsvector(ts_rec.ts_config::regconfig, value)::TEXT;
1702         END LOOP;
1703         NEW.index_vector = NEW.index_vector || setweight(temp_vector::tsvector,cur_weight);
1704     ELSE
1705         NEW.index_vector = to_tsvector(TG_ARGV[0]::regconfig, value);
1706     END IF;
1707
1708     RETURN NEW;
1709 END;
1710 $$ LANGUAGE PLPGSQL;
1711
1712 COMMIT;