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