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