]> git.evergreen-ils.org Git - working/Evergreen.git/blob - Open-ILS/src/sql/Pg/030.schema.metabib.sql
Split the ingest trigger logic into bits, simplifying optimization and configuration
[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.rec_descriptor (
129         id              BIGSERIAL PRIMARY KEY,
130         record          BIGINT,
131         item_type       TEXT,
132         item_form       TEXT,
133         bib_level       TEXT,
134         control_type    TEXT,
135         char_encoding   TEXT,
136         enc_level       TEXT,
137         audience        TEXT,
138         lit_form        TEXT,
139         type_mat        TEXT,
140         cat_form        TEXT,
141         pub_status      TEXT,
142         item_lang       TEXT,
143         vr_format       TEXT,
144         date1           TEXT,
145         date2           TEXT
146 );
147 CREATE INDEX metabib_rec_descriptor_record_idx ON metabib.rec_descriptor (record);
148 CREATE INDEX metabib_rec_descriptor_item_type_idx ON metabib.rec_descriptor (item_type);
149 CREATE INDEX metabib_rec_descriptor_item_form_idx ON metabib.rec_descriptor (item_form);
150 CREATE INDEX metabib_rec_descriptor_bib_level_idx ON metabib.rec_descriptor (bib_level);
151 CREATE INDEX metabib_rec_descriptor_control_type_idx ON metabib.rec_descriptor (control_type);
152 CREATE INDEX metabib_rec_descriptor_char_encoding_idx ON metabib.rec_descriptor (char_encoding);
153 CREATE INDEX metabib_rec_descriptor_enc_level_idx ON metabib.rec_descriptor (enc_level);
154 CREATE INDEX metabib_rec_descriptor_audience_idx ON metabib.rec_descriptor (audience);
155 CREATE INDEX metabib_rec_descriptor_lit_form_idx ON metabib.rec_descriptor (lit_form);
156 CREATE INDEX metabib_rec_descriptor_cat_form_idx ON metabib.rec_descriptor (cat_form);
157 CREATE INDEX metabib_rec_descriptor_pub_status_idx ON metabib.rec_descriptor (pub_status);
158 CREATE INDEX metabib_rec_descriptor_item_lang_idx ON metabib.rec_descriptor (item_lang);
159 CREATE INDEX metabib_rec_descriptor_vr_format_idx ON metabib.rec_descriptor (vr_format);
160 CREATE INDEX metabib_rec_descriptor_date1_idx ON metabib.rec_descriptor (date1);
161 CREATE INDEX metabib_rec_descriptor_dates_idx ON metabib.rec_descriptor (date1,date2);
162
163 -- Use a sequence that matches previous version, for easier upgrading.
164 CREATE SEQUENCE metabib.full_rec_id_seq;
165
166 CREATE TABLE metabib.real_full_rec (
167         id                  BIGINT      NOT NULL DEFAULT NEXTVAL('metabib.full_rec_id_seq'::REGCLASS),
168         record          BIGINT          NOT NULL,
169         tag             CHAR(3)         NOT NULL,
170         ind1            TEXT,
171         ind2            TEXT,
172         subfield        TEXT,
173         value           TEXT            NOT NULL,
174         index_vector    tsvector        NOT NULL
175 );
176 ALTER TABLE metabib.real_full_rec ADD PRIMARY KEY (id);
177
178 CREATE INDEX metabib_full_rec_tag_subfield_idx ON metabib.real_full_rec (tag,subfield);
179 CREATE INDEX metabib_full_rec_value_idx ON metabib.real_full_rec (substring(value,1,1024));
180 /* Enable LIKE to use an index for database clusters with locales other than C or POSIX */
181 CREATE INDEX metabib_full_rec_value_tpo_index ON metabib.real_full_rec (substring(value,1,1024) text_pattern_ops);
182 CREATE INDEX metabib_full_rec_record_idx ON metabib.real_full_rec (record);
183 CREATE INDEX metabib_full_rec_index_vector_idx ON metabib.real_full_rec USING GIST (index_vector);
184
185 CREATE TRIGGER metabib_full_rec_fti_trigger
186         BEFORE UPDATE OR INSERT ON metabib.real_full_rec
187         FOR EACH ROW EXECUTE PROCEDURE oils_tsearch2('default');
188
189 CREATE OR REPLACE VIEW metabib.full_rec AS
190     SELECT  id,
191             record,
192             tag,
193             ind1,
194             ind2,
195             subfield,
196             SUBSTRING(value,1,1024) AS value,
197             index_vector
198       FROM  metabib.real_full_rec;
199
200 CREATE OR REPLACE RULE metabib_full_rec_insert_rule
201     AS ON INSERT TO metabib.full_rec
202     DO INSTEAD
203     INSERT INTO metabib.real_full_rec VALUES (
204         COALESCE(NEW.id, NEXTVAL('metabib.full_rec_id_seq'::REGCLASS)),
205         NEW.record,
206         NEW.tag,
207         NEW.ind1,
208         NEW.ind2,
209         NEW.subfield,
210         NEW.value,
211         NEW.index_vector
212     );
213
214 CREATE OR REPLACE RULE metabib_full_rec_update_rule
215     AS ON UPDATE TO metabib.full_rec
216     DO INSTEAD
217     UPDATE  metabib.real_full_rec SET
218         id = NEW.id,
219         record = NEW.record,
220         tag = NEW.tag,
221         ind1 = NEW.ind1,
222         ind2 = NEW.ind2,
223         subfield = NEW.subfield,
224         value = NEW.value,
225         index_vector = NEW.index_vector
226       WHERE id = OLD.id;
227
228 CREATE OR REPLACE RULE metabib_full_rec_delete_rule
229     AS ON DELETE TO metabib.full_rec
230     DO INSTEAD
231     DELETE FROM metabib.real_full_rec WHERE id = OLD.id;
232
233 CREATE TABLE metabib.metarecord_source_map (
234         id              BIGSERIAL       PRIMARY KEY,
235         metarecord      BIGINT          NOT NULL,
236         source          BIGINT          NOT NULL
237 );
238 CREATE INDEX metabib_metarecord_source_map_metarecord_idx ON metabib.metarecord_source_map (metarecord);
239 CREATE INDEX metabib_metarecord_source_map_source_record_idx ON metabib.metarecord_source_map (source);
240
241 CREATE TYPE metabib.field_entry_template AS (
242         field_class     TEXT,
243         field           INT,
244         source          BIGINT,
245         value           TEXT
246 );
247
248 CREATE OR REPLACE FUNCTION biblio.extract_metabib_field_entry ( rid BIGINT, default_joiner TEXT ) RETURNS SETOF metabib.field_entry_template AS $func$
249 DECLARE
250     bib     biblio.record_entry%ROWTYPE;
251     idx     config.metabib_field%ROWTYPE;
252     xfrm        config.xml_transform%ROWTYPE;
253     prev_xfrm   TEXT;
254     transformed_xml TEXT;
255     xml_node    TEXT;
256     xml_node_list   TEXT[];
257     facet_text  TEXT;
258     raw_text    TEXT;
259     curr_text   TEXT;
260     joiner      TEXT := default_joiner; -- XXX will index defs supply a joiner?
261     output_row  metabib.field_entry_template%ROWTYPE;
262 BEGIN
263
264     -- Get the record
265     SELECT INTO bib * FROM biblio.record_entry WHERE id = rid;
266
267     -- Loop over the indexing entries
268     FOR idx IN SELECT * FROM config.metabib_field ORDER BY format LOOP
269
270         SELECT INTO xfrm * from config.xml_transform WHERE name = idx.format;
271
272         -- See if we can skip the XSLT ... it's expensive
273         IF prev_xfrm IS NULL OR prev_xfrm <> xfrm.name THEN
274             -- Can't skip the transform
275             IF xfrm.xslt <> '---' THEN
276                 transformed_xml := oils_xslt_process(bib.marc,xfrm.xslt);
277             ELSE
278                 transformed_xml := bib.marc;
279             END IF;
280
281             prev_xfrm := xfrm.name;
282         END IF;
283
284         xml_node_list := oils_xpath( idx.xpath, transformed_xml, ARRAY[ARRAY[xfrm.prefix, xfrm.namespace_uri]] );
285
286         raw_text := NULL;
287         FOR xml_node IN SELECT x FROM explode_array(xml_node_list) AS x LOOP
288             CONTINUE WHEN xml_node !~ E'^\\s*<';
289
290             curr_text := ARRAY_TO_STRING(
291                 oils_xpath( '//text()',
292                     REGEXP_REPLACE( -- This escapes all &s not followed by "amp;".  Data ise returned from oils_xpath (above) in UTF-8, not entity encoded
293                         REGEXP_REPLACE( -- This escapes embeded <s
294                             xml_node,
295                             $re$(>[^<]+)(<)([^>]+<)$re$,
296                             E'\\1&lt;\\3',
297                             'g'
298                         ),
299                         '&(?!amp;)',
300                         '&amp;',
301                         'g'
302                     )
303                 ),
304                 ' '
305             );
306
307             CONTINUE WHEN curr_text IS NULL OR curr_text = '';
308
309             IF raw_text IS NOT NULL THEN
310                 raw_text := raw_text || joiner;
311             END IF;
312
313             raw_text := COALESCE(raw_text,'') || curr_text;
314
315             -- insert raw node text for faceting
316             IF idx.facet_field THEN
317
318                 IF idx.facet_xpath IS NOT NULL AND idx.facet_xpath <> '' THEN
319                     facet_text := oils_xpath_string( idx.facet_xpath, xml_node, joiner, ARRAY[ARRAY[xfrm.prefix, xfrm.namespace_uri]] );
320                 ELSE
321                     facet_text := curr_text;
322                 END IF;
323
324                 output_row.field_class = idx.field_class;
325                 output_row.field = -1 * idx.id;
326                 output_row.source = rid;
327                 output_row.value = BTRIM(REGEXP_REPLACE(facet_text, E'\\s+', ' ', 'g'));
328
329                 RETURN NEXT output_row;
330             END IF;
331
332         END LOOP;
333
334         CONTINUE WHEN raw_text IS NULL OR raw_text = '';
335
336         -- insert combined node text for searching
337         IF idx.search_field THEN
338             output_row.field_class = idx.field_class;
339             output_row.field = idx.id;
340             output_row.source = rid;
341             output_row.value = BTRIM(REGEXP_REPLACE(raw_text, E'\\s+', ' ', 'g'));
342
343             RETURN NEXT output_row;
344         END IF;
345
346     END LOOP;
347
348 END;
349 $func$ LANGUAGE PLPGSQL;
350
351 -- default to a space joiner
352 CREATE OR REPLACE FUNCTION biblio.extract_metabib_field_entry ( BIGINT ) RETURNS SETOF metabib.field_entry_template AS $func$
353         SELECT * FROM biblio.extract_metabib_field_entry($1, ' ');
354 $func$ LANGUAGE SQL;
355
356 CREATE OR REPLACE FUNCTION biblio.flatten_marc ( rid BIGINT ) RETURNS SETOF metabib.full_rec AS $func$
357 DECLARE
358         bib     biblio.record_entry%ROWTYPE;
359         output  metabib.full_rec%ROWTYPE;
360         field   RECORD;
361 BEGIN
362         SELECT INTO bib * FROM biblio.record_entry WHERE id = rid;
363
364         FOR field IN SELECT * FROM biblio.flatten_marc( bib.marc ) LOOP
365                 output.record := rid;
366                 output.ind1 := field.ind1;
367                 output.ind2 := field.ind2;
368                 output.tag := field.tag;
369                 output.subfield := field.subfield;
370                 IF field.subfield IS NOT NULL AND field.tag NOT IN ('020','022','024') THEN -- exclude standard numbers and control fields
371                         output.value := naco_normalize(field.value, field.subfield);
372                 ELSE
373                         output.value := field.value;
374                 END IF;
375
376                 CONTINUE WHEN output.value IS NULL;
377
378                 RETURN NEXT output;
379         END LOOP;
380 END;
381 $func$ LANGUAGE PLPGSQL;
382
383 /* Old form of biblio.flatten_marc() relied on contrib/xml2 functions that got all crashy in PostgreSQL 8.4 */
384 -- CREATE OR REPLACE FUNCTION biblio.flatten_marc ( TEXT, BIGINT ) RETURNS SETOF metabib.full_rec AS $func$
385 --     SELECT  NULL::bigint AS id, NULL::bigint, 'LDR'::char(3), NULL::TEXT, NULL::TEXT, NULL::TEXT, oils_xpath_string( '//*[local-name()="leader"]', $1 ), NULL::tsvector AS index_vector
386 --         UNION
387 --     SELECT  NULL::bigint AS id, NULL::bigint, x.tag::char(3), NULL::TEXT, NULL::TEXT, NULL::TEXT, x.value, NULL::tsvector AS index_vector
388 --       FROM  oils_xpath_table(
389 --                 'id',
390 --                 'marc',
391 --                 'biblio.record_entry',
392 --                 '//*[local-name()="controlfield"]/@tag|//*[local-name()="controlfield"]',
393 --                 'id=' || $2::TEXT
394 --             )x(record int, tag text, value text)
395 --         UNION
396 --     SELECT  NULL::bigint AS id, NULL::bigint, x.tag::char(3), x.ind1, x.ind2, x.subfield, x.value, NULL::tsvector AS index_vector
397 --       FROM  oils_xpath_table(
398 --                 'id',
399 --                 'marc',
400 --                 'biblio.record_entry',
401 --                 '//*[local-name()="datafield"]/@tag|' ||
402 --                 '//*[local-name()="datafield"]/@ind1|' ||
403 --                 '//*[local-name()="datafield"]/@ind2|' ||
404 --                 '//*[local-name()="datafield"]/*/@code|' ||
405 --                 '//*[local-name()="datafield"]/*[@code]',
406 --                 'id=' || $2::TEXT
407 --             )x(record int, tag text, ind1 text, ind2 text, subfield text, value text);
408 -- $func$ LANGUAGE SQL;
409
410 CREATE OR REPLACE FUNCTION biblio.flatten_marc ( TEXT ) RETURNS SETOF metabib.full_rec AS $func$
411
412 use MARC::Record;
413 use MARC::File::XML (BinaryEncoding => 'UTF-8');
414
415 my $xml = shift;
416 my $r = MARC::Record->new_from_xml( $xml );
417
418 return_next( { tag => 'LDR', value => $r->leader } );
419
420 for my $f ( $r->fields ) {
421         if ($f->is_control_field) {
422                 return_next({ tag => $f->tag, value => $f->data });
423         } else {
424                 for my $s ($f->subfields) {
425                         return_next({
426                                 tag      => $f->tag,
427                                 ind1     => $f->indicator(1),
428                                 ind2     => $f->indicator(2),
429                                 subfield => $s->[0],
430                                 value    => $s->[1]
431                         });
432
433                         if ( $f->tag eq '245' and $s->[0] eq 'a' ) {
434                                 my $trim = $f->indicator(2) || 0;
435                                 return_next({
436                                         tag      => 'tnf',
437                                         ind1     => $f->indicator(1),
438                                         ind2     => $f->indicator(2),
439                                         subfield => 'a',
440                                         value    => substr( $s->[1], $trim )
441                                 });
442                         }
443                 }
444         }
445 }
446
447 return undef;
448
449 $func$ LANGUAGE PLPERLU;
450
451 CREATE OR REPLACE FUNCTION biblio.marc21_record_type( rid BIGINT ) RETURNS config.marc21_rec_type_map AS $func$
452 DECLARE
453         ldr         RECORD;
454         tval        TEXT;
455         tval_rec    RECORD;
456         bval        TEXT;
457         bval_rec    RECORD;
458     retval      config.marc21_rec_type_map%ROWTYPE;
459 BEGIN
460     SELECT * INTO ldr FROM metabib.full_rec WHERE record = rid AND tag = 'LDR' LIMIT 1;
461
462     IF ldr.id IS NULL THEN
463         SELECT * INTO retval FROM config.marc21_rec_type_map WHERE code = 'BKS';
464         RETURN retval;
465     END IF;
466
467     SELECT * INTO tval_rec FROM config.marc21_ff_pos_map WHERE fixed_field = 'Type' LIMIT 1; -- They're all the same
468     SELECT * INTO bval_rec FROM config.marc21_ff_pos_map WHERE fixed_field = 'BLvl' LIMIT 1; -- They're all the same
469
470
471     tval := SUBSTRING( ldr.value, tval_rec.start_pos + 1, tval_rec.length );
472     bval := SUBSTRING( ldr.value, bval_rec.start_pos + 1, bval_rec.length );
473
474     -- RAISE NOTICE 'type %, blvl %, ldr %', tval, bval, ldr.value;
475
476     SELECT * INTO retval FROM config.marc21_rec_type_map WHERE type_val LIKE '%' || tval || '%' AND blvl_val LIKE '%' || bval || '%';
477
478
479     IF retval.code IS NULL THEN
480         SELECT * INTO retval FROM config.marc21_rec_type_map WHERE code = 'BKS';
481     END IF;
482
483     RETURN retval;
484 END;
485 $func$ LANGUAGE PLPGSQL;
486
487 CREATE OR REPLACE FUNCTION biblio.marc21_extract_fixed_field( rid BIGINT, ff TEXT ) RETURNS TEXT AS $func$
488 DECLARE
489     rtype       TEXT;
490     ff_pos      RECORD;
491     tag_data    RECORD;
492     val         TEXT;
493 BEGIN
494     rtype := (biblio.marc21_record_type( rid )).code;
495     FOR ff_pos IN SELECT * FROM config.marc21_ff_pos_map WHERE fixed_field = ff AND rec_type = rtype ORDER BY tag DESC LOOP
496         FOR tag_data IN SELECT * FROM metabib.full_rec WHERE tag = UPPER(ff_pos.tag) AND record = rid LOOP
497             val := SUBSTRING( tag_data.value, ff_pos.start_pos + 1, ff_pos.length );
498             RETURN val;
499         END LOOP;
500         val := REPEAT( ff_pos.default_val, ff_pos.length );
501         RETURN val;
502     END LOOP;
503
504     RETURN NULL;
505 END;
506 $func$ LANGUAGE PLPGSQL;
507
508 CREATE TYPE biblio.marc21_physical_characteristics AS ( id INT, record BIGINT, ptype TEXT, subfield INT, value INT );
509 CREATE OR REPLACE FUNCTION biblio.marc21_physical_characteristics( rid BIGINT ) RETURNS SETOF biblio.marc21_physical_characteristics AS $func$
510 DECLARE
511     rowid   INT := 0;
512     _007    RECORD;
513     ptype   config.marc21_physical_characteristic_type_map%ROWTYPE;
514     psf     config.marc21_physical_characteristic_subfield_map%ROWTYPE;
515     pval    config.marc21_physical_characteristic_value_map%ROWTYPE;
516     retval  biblio.marc21_physical_characteristics%ROWTYPE;
517 BEGIN
518
519     SELECT * INTO _007 FROM metabib.full_rec WHERE record = rid AND tag = '007' LIMIT 1;
520
521     IF _007.id IS NOT NULL THEN
522         SELECT * INTO ptype FROM config.marc21_physical_characteristic_type_map WHERE ptype_key = SUBSTRING( _007.value, 1, 1 );
523
524         IF ptype.ptype_key IS NOT NULL THEN
525             FOR psf IN SELECT * FROM config.marc21_physical_characteristic_subfield_map WHERE ptype_key = ptype.ptype_key LOOP
526                 SELECT * INTO pval FROM config.marc21_physical_characteristic_value_map WHERE ptype_subfield = psf.id AND value = SUBSTRING( _007.value, psf.start_pos + 1, psf.length );
527
528                 IF pval.id IS NOT NULL THEN
529                     rowid := rowid + 1;
530                     retval.id := rowid;
531                     retval.record := rid;
532                     retval.ptype := ptype.ptype_key;
533                     retval.subfield := psf.id;
534                     retval.value := pval.id;
535                     RETURN NEXT retval;
536                 END IF;
537
538             END LOOP;
539         END IF;
540     END IF;
541
542     RETURN;
543 END;
544 $func$ LANGUAGE PLPGSQL;
545
546 CREATE OR REPLACE FUNCTION biblio.extract_quality ( marc TEXT, best_lang TEXT, best_type TEXT ) RETURNS INT AS $func$
547 DECLARE
548     qual        INT;
549     ldr         TEXT;
550     tval        TEXT;
551     tval_rec    RECORD;
552     bval        TEXT;
553     bval_rec    RECORD;
554     type_map    RECORD;
555     ff_pos      RECORD;
556     ff_tag_data TEXT;
557 BEGIN
558
559     IF marc IS NULL OR marc = '' THEN
560         RETURN NULL;
561     END IF;
562
563     -- First, the count of tags
564     qual := ARRAY_UPPER(oils_xpath('*[local-name()="datafield"]', marc), 1);
565
566     -- now go through a bunch of pain to get the record type
567     IF best_type IS NOT NULL THEN
568         ldr := (oils_xpath('//*[local-name()="leader"]/text()', marc))[1];
569
570         IF ldr IS NOT NULL THEN
571             SELECT * INTO tval_rec FROM config.marc21_ff_pos_map WHERE fixed_field = 'Type' LIMIT 1; -- They're all the same
572             SELECT * INTO bval_rec FROM config.marc21_ff_pos_map WHERE fixed_field = 'BLvl' LIMIT 1; -- They're all the same
573
574
575             tval := SUBSTRING( ldr, tval_rec.start_pos + 1, tval_rec.length );
576             bval := SUBSTRING( ldr, bval_rec.start_pos + 1, bval_rec.length );
577
578             -- RAISE NOTICE 'type %, blvl %, ldr %', tval, bval, ldr;
579
580             SELECT * INTO type_map FROM config.marc21_rec_type_map WHERE type_val LIKE '%' || tval || '%' AND blvl_val LIKE '%' || bval || '%';
581
582             IF type_map.code IS NOT NULL THEN
583                 IF best_type = type_map.code THEN
584                     qual := qual + qual / 2;
585                 END IF;
586
587                 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
588                     ff_tag_data := SUBSTRING((oils_xpath('//*[@tag="' || ff_pos.tag || '"]/text()',marc))[1], ff_pos.start_pos + 1, ff_pos.length);
589                     IF ff_tag_data = best_lang THEN
590                             qual := qual + 100;
591                     END IF;
592                 END LOOP;
593             END IF;
594         END IF;
595     END IF;
596
597     -- Now look for some quality metrics
598     -- DCL record?
599     IF ARRAY_UPPER(oils_xpath('//*[@tag="040"]/*[@code="a" and contains(.,"DLC")]', marc), 1) = 1 THEN
600         qual := qual + 10;
601     END IF;
602
603     -- From OCLC?
604     IF (oils_xpath('//*[@tag="003"]/text()', marc))[1] ~* E'oclo?c' THEN
605         qual := qual + 10;
606     END IF;
607
608     RETURN qual;
609
610 END;
611 $func$ LANGUAGE PLPGSQL;
612
613 CREATE OR REPLACE FUNCTION biblio.extract_fingerprint ( marc text ) RETURNS TEXT AS $func$
614 DECLARE
615         idx             config.biblio_fingerprint%ROWTYPE;
616         xfrm            config.xml_transform%ROWTYPE;
617         prev_xfrm       TEXT;
618         transformed_xml TEXT;
619         xml_node        TEXT;
620         xml_node_list   TEXT[];
621         raw_text        TEXT;
622     output_text TEXT := '';
623 BEGIN
624
625     IF marc IS NULL OR marc = '' THEN
626         RETURN NULL;
627     END IF;
628
629         -- Loop over the indexing entries
630         FOR idx IN SELECT * FROM config.biblio_fingerprint ORDER BY format, id LOOP
631
632                 SELECT INTO xfrm * from config.xml_transform WHERE name = idx.format;
633
634                 -- See if we can skip the XSLT ... it's expensive
635                 IF prev_xfrm IS NULL OR prev_xfrm <> xfrm.name THEN
636                         -- Can't skip the transform
637                         IF xfrm.xslt <> '---' THEN
638                                 transformed_xml := oils_xslt_process(marc,xfrm.xslt);
639                         ELSE
640                                 transformed_xml := marc;
641                         END IF;
642
643                         prev_xfrm := xfrm.name;
644                 END IF;
645
646                 raw_text := COALESCE(
647             naco_normalize(
648                 ARRAY_TO_STRING(
649                     oils_xpath(
650                         '//text()',
651                         (oils_xpath(
652                             idx.xpath,
653                             transformed_xml,
654                             ARRAY[ARRAY[xfrm.prefix, xfrm.namespace_uri]] 
655                         ))[1]
656                     ),
657                     ''
658                 )
659             ),
660             ''
661         );
662
663         raw_text := REGEXP_REPLACE(raw_text, E'\\[.+?\\]', E'');
664         raw_text := REGEXP_REPLACE(raw_text, E'\\mthe\\M|\\man?d?d\\M', E'', 'g'); -- arg! the pain!
665
666         IF idx.first_word IS TRUE THEN
667             raw_text := REGEXP_REPLACE(raw_text, E'^(\\w+).*?$', E'\\1');
668         END IF;
669
670                 output_text := output_text || REGEXP_REPLACE(raw_text, E'\\s+', '', 'g');
671
672         END LOOP;
673
674     RETURN output_text;
675
676 END;
677 $func$ LANGUAGE PLPGSQL;
678
679 -- BEFORE UPDATE OR INSERT trigger for biblio.record_entry
680 CREATE OR REPLACE FUNCTION biblio.fingerprint_trigger () RETURNS TRIGGER AS $func$
681 BEGIN
682
683     -- For TG_ARGV, first param is language (like 'eng'), second is record type (like 'BKS')
684
685     IF NEW.deleted IS TRUE THEN -- we don't much care, then, do we?
686         RETURN NEW;
687     END IF;
688
689     NEW.fingerprint := biblio.extract_fingerprint(NEW.marc);
690     NEW.quality := biblio.extract_quality(NEW.marc, TG_ARGV[0], TG_ARGV[1]);
691
692     RETURN NEW;
693
694 END;
695 $func$ LANGUAGE PLPGSQL;
696
697 CREATE OR REPLACE FUNCTION metabib.reingest_metabib_rec_descriptor( bib_id BIGINT ) RETURNS VOID AS $func$
698 BEGIN
699     DELETE FROM metabib.rec_descriptor WHERE record = bib_id;
700     INSERT INTO metabib.rec_descriptor (record, item_type, item_form, bib_level, control_type, enc_level, audience, lit_form, type_mat, cat_form, pub_status, item_lang, vr_format, date1, date2)
701         SELECT  bib_id,
702                 biblio.marc21_extract_fixed_field( bib_id, 'Type' ),
703                 biblio.marc21_extract_fixed_field( bib_id, 'Form' ),
704                 biblio.marc21_extract_fixed_field( bib_id, 'BLvl' ),
705                 biblio.marc21_extract_fixed_field( bib_id, 'Ctrl' ),
706                 biblio.marc21_extract_fixed_field( bib_id, 'ELvl' ),
707                 biblio.marc21_extract_fixed_field( bib_id, 'Audn' ),
708                 biblio.marc21_extract_fixed_field( bib_id, 'LitF' ),
709                 biblio.marc21_extract_fixed_field( bib_id, 'TMat' ),
710                 biblio.marc21_extract_fixed_field( bib_id, 'Desc' ),
711                 biblio.marc21_extract_fixed_field( bib_id, 'DtSt' ),
712                 biblio.marc21_extract_fixed_field( bib_id, 'Lang' ),
713                 (   SELECT  v.value
714                       FROM  biblio.marc21_physical_characteristics( bib_id) p
715                             JOIN config.marc21_physical_characteristic_subfield_map s ON (s.id = p.subfield)
716                             JOIN config.marc21_physical_characteristic_value_map v ON (v.id = p.value)
717                       WHERE p.ptype = 'v' AND s.subfield = 'e'    ),
718                 biblio.marc21_extract_fixed_field( bib_id, 'Date1'),
719                 biblio.marc21_extract_fixed_field( bib_id, 'Date2');
720
721     RETURN;
722 END;
723 $func$ LANGUAGE PLPGSQL;
724
725 CREATE OR REPLACE FUNCTION metabib.reingest_metabib_full_rec( bib_id BIGINT ) RETURNS VOID AS $func$
726 BEGIN
727     DELETE FROM metabib.real_full_rec WHERE record = bib_id;
728     INSERT INTO metabib.real_full_rec (record, tag, ind1, ind2, subfield, value)
729         SELECT record, tag, ind1, ind2, subfield, value FROM biblio.flatten_marc( bib_id );
730
731     RETURN;
732 END;
733 $func$ LANGUAGE PLPGSQL;
734
735 CREATE OR REPLACE FUNCTION metabib.reingest_metabib_field_entries( bib_id BIGINT ) RETURNS VOID AS $func$
736 DECLARE
737     fclass          RECORD;
738     ind_data        metabib.field_entry_template%ROWTYPE;
739     ind_vector      TSVECTOR;
740 BEGIN
741     FOR fclass IN SELECT * FROM config.metabib_class LOOP
742         -- RAISE NOTICE 'Emptying out %', fclass.name;
743         EXECUTE $$DELETE FROM metabib.$$ || fclass.name || $$_field_entry WHERE source = $$ || bib_id;
744     END LOOP;
745
746     FOR ind_data IN SELECT * FROM biblio.extract_metabib_field_entry( bib_id ) LOOP
747         IF ind_data.field < 0 THEN
748             ind_vector = '';
749             ind_data.field = -1 * ind_data.field;
750         ELSE
751             ind_vector = NULL;
752         END IF;
753
754         EXECUTE $$
755             INSERT INTO metabib.$$ || ind_data.field_class || $$_field_entry (field, source, value, index_vector)
756                 VALUES ($$ ||
757                     quote_literal(ind_data.field) || $$, $$ ||
758                     quote_literal(ind_data.source) || $$, $$ ||
759                     quote_literal(ind_data.value) || $$, $$ ||
760                     COALESCE(quote_literal(ind_vector),'NULL'::TEXT) ||
761                 $$);$$;
762     END LOOP;
763
764     RETURN;
765 END;
766 $func$ LANGUAGE PLPGSQL;
767
768 CREATE OR REPLACE FUNCTION biblio.extract_located_uris( bib_id BIGINT, marcxml TEXT, editor_id INT ) RETURNS VOID AS $func$
769 DECLARE
770     uris            TEXT[];
771     uri_xml         TEXT;
772     uri_label       TEXT;
773     uri_href        TEXT;
774     uri_use         TEXT;
775     uri_owner       TEXT;
776     uri_owner_id    INT;
777     uri_id          INT;
778     uri_cn_id       INT;
779     uri_map_id      INT;
780 BEGIN
781
782     uris := oils_xpath('//*[@tag="856" and (@ind1="4" or @ind1="1") and (@ind2="0" or @ind2="1")]',marcxml);
783     IF ARRAY_UPPER(uris,1) > 0 THEN
784         FOR i IN 1 .. ARRAY_UPPER(uris, 1) LOOP
785             -- First we pull info out of the 856
786             uri_xml     := uris[i];
787
788             uri_href    := (oils_xpath('//*[@code="u"]/text()',uri_xml))[1];
789             CONTINUE WHEN uri_href IS NULL;
790
791             uri_label   := (oils_xpath('//*[@code="y"]/text()|//*[@code="3"]/text()|//*[@code="u"]/text()',uri_xml))[1];
792             CONTINUE WHEN uri_label IS NULL;
793
794             uri_owner   := (oils_xpath('//*[@code="9"]/text()|//*[@code="w"]/text()|//*[@code="n"]/text()',uri_xml))[1];
795             CONTINUE WHEN uri_owner IS NULL;
796
797             uri_use     := (oils_xpath('//*[@code="z"]/text()|//*[@code="2"]/text()|//*[@code="n"]/text()',uri_xml))[1];
798
799             uri_owner := REGEXP_REPLACE(uri_owner, $re$^.*?\((\w+)\).*$$re$, E'\\1');
800
801             SELECT id INTO uri_owner_id FROM actor.org_unit WHERE shortname = uri_owner;
802             CONTINUE WHEN NOT FOUND;
803
804             -- now we look for a matching uri
805             SELECT id INTO uri_id FROM asset.uri WHERE label = uri_label AND href = uri_href AND use_restriction = uri_use AND active;
806             IF NOT FOUND THEN -- create one
807                 INSERT INTO asset.uri (label, href, use_restriction) VALUES (uri_label, uri_href, uri_use);
808                 SELECT id INTO uri_id FROM asset.uri WHERE label = uri_label AND href = uri_href AND use_restriction = uri_use AND active;
809             END IF;
810
811             -- we need a call number to link through
812             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;
813             IF NOT FOUND THEN
814                 INSERT INTO asset.call_number (owning_lib, record, create_date, edit_date, creator, editor, label)
815                     VALUES (uri_owner_id, bib_id, 'now', 'now', editor_id, editor_id, '##URI##');
816                 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;
817             END IF;
818
819             -- now, link them if they're not already
820             SELECT id INTO uri_map_id FROM asset.uri_call_number_map WHERE call_number = uri_cn_id AND uri = uri_id;
821             IF NOT FOUND THEN
822                 INSERT INTO asset.uri_call_number_map (call_number, uri) VALUES (uri_cn_id, uri_id);
823             END IF;
824
825         END LOOP;
826     END IF;
827
828     RETURN;
829 END;
830 $func$ LANGUAGE PLPGSQL;
831
832
833 CREATE OR REPLACE FUNCTION metabib.remap_metarecord_for_bib( bib_id BIGINT, fp TEXT ) RETURNS BIGINT AS $func$
834 DECLARE
835     source_count    INT;
836     old_mr          BIGINT;
837     tmp_mr          metabib.metarecord%ROWTYPE;
838     deleted_mrs     BIGINT[];
839 BEGIN
840
841     DELETE FROM metabib.metarecord_source_map WHERE source = bib_id; -- Rid ourselves of the search-estimate-killing linkage
842
843     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
844
845         IF old_mr IS NULL AND fp = tmp_mr.fingerprint THEN -- Find the first fingerprint-matching
846             old_mr := tmp_mr.id;
847         ELSE
848             SELECT COUNT(*) INTO source_count FROM metabib.metarecord_source_map WHERE metarecord = tmp_mr.id;
849             IF source_count = 0 THEN -- No other records
850                 deleted_mrs := ARRAY_APPEND(deleted_mrs, tmp_mr.id);
851                 DELETE FROM metabib.metarecord WHERE id = tmp_mr.id;
852             END IF;
853         END IF;
854
855     END LOOP;
856
857     IF old_mr IS NULL THEN -- we found no suitable, preexisting MR based on old source maps
858         SELECT id INTO old_mr FROM metabib.metarecord WHERE fingerprint = fp; -- is there one for our current fingerprint?
859         IF old_mr IS NULL THEN -- nope, create one and grab its id
860             INSERT INTO metabib.metarecord ( fingerprint, master_record ) VALUES ( fp, bib_id );
861             SELECT id INTO old_mr FROM metabib.metarecord WHERE fingerprint = fp;
862         ELSE -- indeed there is. update it with a null cache and recalcualated master record
863             UPDATE  metabib.metarecord
864               SET   mods = NULL,
865                     master_record = ( SELECT id FROM biblio.record_entry WHERE fingerprint = fp ORDER BY quality DESC LIMIT 1)
866               WHERE id = old_mr;
867         END IF;
868     ELSE -- there was one we already attached to, update its mods cache and master_record
869         UPDATE  metabib.metarecord
870           SET   mods = NULL,
871                 master_record = ( SELECT id FROM biblio.record_entry WHERE fingerprint = fp ORDER BY quality DESC LIMIT 1)
872           WHERE id = old_mr;
873     END IF;
874
875     INSERT INTO metabib.metarecord_source_map (metarecord, source) VALUES (old_mr, bib_id); -- new source mapping
876
877     IF ARRAY_UPPER(deleted_mrs,1) > 0 THEN
878         UPDATE action.hold_request SET target = old_mr WHERE target IN ( SELECT explode_array(deleted_mrs) ) AND hold_type = 'M'; -- if we had to delete any MRs above, make sure their holds are moved
879     END IF;
880
881     RETURN old_mr;
882
883 END;
884 $func$ LANGUAGE PLPGSQL;
885
886 -- AFTER UPDATE OR INSERT trigger for biblio.record_entry
887 CREATE OR REPLACE FUNCTION biblio.indexing_ingest_or_delete () RETURNS TRIGGER AS $func$
888 BEGIN
889
890     IF NEW.deleted IS TRUE THEN -- If this bib is deleted
891         DELETE FROM metabib.metarecord_source_map WHERE source = NEW.id; -- Rid ourselves of the search-estimate-killing linkage
892         RETURN NEW; -- and we're done
893     END IF;
894
895     IF TG_OP = 'UPDATE' THEN -- re-ingest?
896         PERFORM * FROM config.internal_flag WHERE name = 'ingest.reingest.force_on_same_marc' AND enabled;
897
898         IF NOT FOUND AND OLD.marc = NEW.marc THEN -- don't do anything if the MARC didn't change
899             RETURN NEW;
900         END IF;
901
902
903     END IF;
904
905     -- Flatten and insert the mfr data
906     PERFORM * FROM config.internal_flag WHERE name = 'ingest.disable_metabib_full_rec' AND enabled;
907     IF NOT FOUND THEN
908         PERFORM metabib.reingest_metabib_full_rec(NEW.id);
909         PERFORM * FROM config.internal_flag WHERE name = 'ingest.disable_metabib_rec_descriptor' AND enabled;
910         IF NOT FOUND THEN
911             PERFORM metabib.reingest_metabib_rec_descriptor(NEW.id);
912         END IF;
913     END IF;
914
915     -- Gather and insert the field entry data
916     PERFORM metabib.reingest_metabib_field_entries(NEW.id);
917
918     -- Located URI magic
919     IF TG_OP = 'INSERT' THEN
920         PERFORM * FROM config.internal_flag WHERE name = 'ingest.disable_located_uri' AND enabled;
921         IF NOT FOUND THEN
922             PERFORM biblio.extract_located_uris( NEW.id, NEW.marc, NEW.editor );
923         END IF;
924     ELSE
925         PERFORM * FROM config.internal_flag WHERE name = 'ingest.disable_located_uri' AND enabled;
926         IF NOT FOUND THEN
927             PERFORM biblio.extract_located_uris( NEW.id, NEW.marc, NEW.editor );
928         END IF;
929     END IF;
930
931     -- (re)map metarecord-bib linking
932     IF TG_OP = 'INSERT' THEN -- if not deleted and performing an insert, check for the flag
933         PERFORM * FROM config.internal_flag WHERE name = 'ingest.metarecord_mapping.skip_on_insert' AND enabled;
934         IF NOT FOUND THEN
935             PERFORM metabib.remap_metarecord_for_bib( NEW.id, NEW.fingerprint );
936         END IF;
937     ELSE -- we're doing an update, and we're not deleted, remap
938         PERFORM metabib.remap_metarecord_for_bib( NEW.id, NEW.fingerprint );
939     END IF;
940
941     RETURN NEW;
942 END;
943 $func$ LANGUAGE PLPGSQL;
944
945 COMMIT;