2 * Copyright (C) 2004-2008 Georgia Public Library Service
3 * Copyright (C) 2008 Equinox Software, Inc.
4 * Mike Rylander <miker@esilibrary.com>
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.
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.
22 CREATE OR REPLACE FUNCTION oils_xml_transform ( TEXT, TEXT ) RETURNS TEXT AS $_$
23 SELECT CASE WHEN (SELECT COUNT(*) FROM config.xml_transform WHERE name = $2 AND xslt = '---') > 0 THEN $1
24 ELSE xslt_process($1, (SELECT xslt FROM config.xml_transform WHERE name = $2))
26 $_$ LANGUAGE SQL STRICT IMMUTABLE;
28 CREATE OR REPLACE FUNCTION public.extract_marc_field ( TEXT, BIGINT, TEXT, TEXT ) RETURNS TEXT AS $$
29 SELECT regexp_replace(array_to_string( array_accum( output ),' ' ),$4,'','g') FROM oils_xpath_table('id', 'marc', $1, $3, 'id='||$2)x(id INT, output TEXT);
32 CREATE OR REPLACE FUNCTION oils_xml_uncache (xml TEXT) RETURNS BOOL AS $func$
33 delete $_SHARED{'_xslt_process'}{docs}{shift()};
35 $func$ LANGUAGE PLPERLU;
37 CREATE OR REPLACE FUNCTION oils_xml_cache (xml TEXT) RETURNS BOOL AS $func$
43 # The following approach uses the older XML::LibXML 1.69 / XML::LibXSLT 1.68
44 # methods of parsing XML documents and stylesheets, in the hopes of broader
45 # compatibility with distributions
46 my $parser = $_SHARED{'_xslt_process'}{parsers}{xml} || XML::LibXML->new();
48 # Cache the XML parser, if we do not already have one
49 $_SHARED{'_xslt_process'}{parsers}{xml} = $parser
50 unless ($_SHARED{'_xslt_process'}{parsers}{xml});
52 # Parse and cache the doc
53 eval { $_SHARED{'_xslt_process'}{docs}{$doc} = $parser->parse_string($doc) };
57 $func$ LANGUAGE PLPERLU;
59 -- if we use these, we need to ...
60 drop function oils_xpath(text, text, anyarray);
62 CREATE OR REPLACE FUNCTION oils_xpath (xpath TEXT, xml TEXT, ns TEXT[][]) RETURNS TEXT[] AS $func$
68 my $ns_string = shift || '';
69 #elog(NOTICE,"ns_string: $ns_string");
71 my %ns_list = $ns_string =~ m/\{([^{,]+),([^}]+)\}/g;
72 #elog(NOTICE,"NS Prefix $_: $ns_list{$_}") for (keys %ns_list);
74 # The following approach uses the older XML::LibXML 1.69 / XML::LibXSLT 1.68
75 # methods of parsing XML documents and stylesheets, in the hopes of broader
76 # compatibility with distributions
77 my $parser = eval { $_SHARED{'_xslt_process'}{parsers}{xml} || XML::LibXML->new() };
81 # Cache the XML parser, if we do not already have one
82 $_SHARED{'_xslt_process'}{parsers}{xml} = $parser
83 unless ($_SHARED{'_xslt_process'}{parsers}{xml});
85 # Look for a cached version of the doc, or parse it if none
86 my $dom = eval { $_SHARED{'_xslt_process'}{docs}{$doc} || $parser->parse_string($doc) };
90 # Cache the parsed XML doc, if already there
91 $_SHARED{'_xslt_process'}{docs}{$doc} = $dom
92 unless ($_SHARED{'_xslt_process'}{docs}{$doc});
94 # Register the requested namespaces
95 $dom->documentElement->setNamespace( $ns_list{$_} => $_ ) for ( keys %ns_list );
97 # Gather and return nodes
98 my @nodes = $dom->findnodes($xpath);
99 #elog(NOTICE,"nodes found by $xpath: ". scalar(@nodes));
101 return [ map { $_->toString } @nodes ];
102 $func$ LANGUAGE PLPERLU;
104 CREATE OR REPLACE FUNCTION oils_xpath ( TEXT, TEXT ) RETURNS TEXT[] AS $$SELECT oils_xpath( $1, $2, '{}'::TEXT[] );$$ LANGUAGE SQL IMMUTABLE;
108 CREATE FUNCTION version_specific_xpath () RETURNS TEXT AS $wrapper_function$
113 IF REGEXP_REPLACE(VERSION(),E'^.+?(\\d+\\.\\d+).*?$',E'\\1')::FLOAT < 8.3 THEN
114 out_text := 'Creating XPath functions that work like the native XPATH function in 8.3+';
116 EXECUTE $create_82_funcs$
118 CREATE OR REPLACE FUNCTION oils_xpath ( xpath TEXT, xml TEXT, ns ANYARRAY ) RETURNS TEXT[] AS $func$
125 munged_xpath := xpath;
127 IF ns IS NOT NULL AND array_upper(ns, 1) IS NOT NULL THEN
128 FOR namespace IN 1 .. array_upper(ns, 1) LOOP
129 munged_xpath := REGEXP_REPLACE(
131 E'(' || ns[namespace][1] || E'):(\\w+)',
132 E'*[local-name() = "\\2" and namespace-uri() = "' || ns[namespace][2] || E'"]',
137 munged_xpath := REGEXP_REPLACE( munged_xpath, E'\\]\\[(\\D)',E' and \\1', 'g');
140 -- RAISE NOTICE 'munged xpath: %', munged_xpath;
142 node_text := xpath_nodeset(xml, munged_xpath, 'XXX_OILS_NODESET');
143 -- RAISE NOTICE 'node_text: %', node_text;
145 IF munged_xpath ~ $re$/[^/[]*@[^/]+$$re$ THEN
146 node_text := REGEXP_REPLACE(node_text,'<XXX_OILS_NODESET>[^"]+"', '<XXX_OILS_NODESET>', 'g');
147 node_text := REGEXP_REPLACE(node_text,'"</XXX_OILS_NODESET>', '</XXX_OILS_NODESET>', 'g');
150 node_text := REGEXP_REPLACE(node_text,'^<XXX_OILS_NODESET>', '');
151 node_text := REGEXP_REPLACE(node_text,'</XXX_OILS_NODESET>$', '');
153 RETURN STRING_TO_ARRAY(node_text, '</XXX_OILS_NODESET><XXX_OILS_NODESET>');
155 $func$ LANGUAGE PLPGSQL IMMUTABLE;
157 CREATE OR REPLACE FUNCTION oils_xpath ( TEXT, TEXT ) RETURNS TEXT[] AS $$SELECT oils_xpath( $1, $2, '{}'::TEXT[] );$$ LANGUAGE SQL IMMUTABLE;
159 CREATE OR REPLACE FUNCTION oils_xslt_process(TEXT, TEXT) RETURNS TEXT AS $$
160 SELECT xslt_process( $1, $2 );
161 $$ LANGUAGE SQL IMMUTABLE;
164 ELSIF REGEXP_REPLACE(VERSION(),E'^.+?(\\d+\\.\\d+).*?$',E'\\1')::FLOAT = 8.3 THEN
165 out_text := 'Creating XPath wrapper functions around the native XPATH function in 8.3. contrib/xml2 still required!';
167 EXECUTE $create_83_funcs$
169 CREATE OR REPLACE FUNCTION oils_xpath ( TEXT, TEXT, ANYARRAY ) RETURNS TEXT[] AS 'SELECT XPATH( $1, $2::XML, $3 )::TEXT[];' LANGUAGE SQL IMMUTABLE;
170 CREATE OR REPLACE FUNCTION oils_xpath ( TEXT, TEXT ) RETURNS TEXT[] AS 'SELECT XPATH( $1, $2::XML )::TEXT[];' LANGUAGE SQL IMMUTABLE;
172 CREATE OR REPLACE FUNCTION oils_xslt_process(TEXT, TEXT) RETURNS TEXT AS $$
173 SELECT xslt_process( $1, $2 );
174 $$ LANGUAGE SQL IMMUTABLE;
179 out_text := 'Creating XPath wrapper functions around the native XPATH function in 8.4+, and plperlu-based xslt processor. No contrib/xml2 needed!';
181 EXECUTE $create_84_funcs$
183 CREATE OR REPLACE FUNCTION oils_xpath ( TEXT, TEXT, ANYARRAY ) RETURNS TEXT[] AS 'SELECT XPATH( $1, $2::XML, $3 )::TEXT[];' LANGUAGE SQL IMMUTABLE;
184 CREATE OR REPLACE FUNCTION oils_xpath ( TEXT, TEXT ) RETURNS TEXT[] AS 'SELECT XPATH( $1, $2::XML )::TEXT[];' LANGUAGE SQL IMMUTABLE;
186 CREATE OR REPLACE FUNCTION oils_xslt_process(TEXT, TEXT) RETURNS TEXT AS $func$
195 # The following approach uses the older XML::LibXML 1.69 / XML::LibXSLT 1.68
196 # methods of parsing XML documents and stylesheets, in the hopes of broader
197 # compatibility with distributions
198 my $parser = $_SHARED{'_xslt_process'}{parsers}{xml} || XML::LibXML->new();
200 # Cache the XML parser, if we do not already have one
201 $_SHARED{'_xslt_process'}{parsers}{xml} = $parser
202 unless ($_SHARED{'_xslt_process'}{parsers}{xml});
204 my $xslt_parser = $_SHARED{'_xslt_process'}{parsers}{xslt} || XML::LibXSLT->new();
206 # Cache the XSLT processor, if we do not already have one
207 $_SHARED{'_xslt_process'}{parsers}{xslt} = $xslt_parser
208 unless ($_SHARED{'_xslt_process'}{parsers}{xslt});
210 my $stylesheet = $_SHARED{'_xslt_process'}{stylesheets}{$xslt} ||
211 $xslt_parser->parse_stylesheet( $parser->parse_string($xslt) );
213 $_SHARED{'_xslt_process'}{stylesheets}{$xslt} = $stylesheet
214 unless ($_SHARED{'_xslt_process'}{stylesheets}{$xslt});
216 return $stylesheet->output_string(
217 $stylesheet->transform(
218 $parser->parse_string($doc)
222 $func$ LANGUAGE 'plperlu' STRICT IMMUTABLE;
230 $wrapper_function$ LANGUAGE PLPGSQL;
232 SELECT version_specific_xpath();
233 DROP FUNCTION version_specific_xpath();
236 CREATE OR REPLACE FUNCTION oils_xpath_string ( TEXT, TEXT, TEXT, ANYARRAY ) RETURNS TEXT AS $func$
237 SELECT ARRAY_TO_STRING(
240 CASE WHEN $1 ~ $re$/[^/[]*@[^]]+$$re$ OR $1 ~ $re$text\(\)$$re$ THEN '' ELSE '//text()' END,
246 $func$ LANGUAGE SQL IMMUTABLE;
248 CREATE OR REPLACE FUNCTION oils_xpath_string ( TEXT, TEXT, TEXT ) RETURNS TEXT AS $func$
249 SELECT oils_xpath_string( $1, $2, $3, '{}'::TEXT[] );
250 $func$ LANGUAGE SQL IMMUTABLE;
252 CREATE OR REPLACE FUNCTION oils_xpath_string ( TEXT, TEXT, ANYARRAY ) RETURNS TEXT AS $func$
253 SELECT oils_xpath_string( $1, $2, '', $3 );
254 $func$ LANGUAGE SQL IMMUTABLE;
256 CREATE OR REPLACE FUNCTION oils_xpath_string ( TEXT, TEXT ) RETURNS TEXT AS $func$
257 SELECT oils_xpath_string( $1, $2, '{}'::TEXT[] );
258 $func$ LANGUAGE SQL IMMUTABLE;
261 CREATE OR REPLACE FUNCTION oils_xpath_table ( key TEXT, document_field TEXT, relation_name TEXT, xpaths TEXT, criteria TEXT ) RETURNS SETOF RECORD AS $func$
270 xpath_list := STRING_TO_ARRAY( xpaths, '|' );
272 select_list := ARRAY_APPEND( select_list, key || '::INT AS key' );
274 FOR i IN 1 .. ARRAY_UPPER(xpath_list,1) LOOP
275 IF xpath_list[i] = 'null()' THEN
276 select_list := ARRAY_APPEND( select_list, 'NULL::TEXT AS c_' || i );
278 select_list := ARRAY_APPEND(
288 WHEN xpath_list[i] ~ $re$/[^/[]*@[^/]+$$re$ OR xpath_list[i] ~ $re$text\(\)$$re$ THEN xpath_list[i]
289 ELSE xpath_list[i] || '//text()'
293 $sel$ || document_field || $sel$
301 where_list := ARRAY_APPEND(
303 'c_' || i || ' IS NOT NULL'
310 SELECT $q$ || ARRAY_TO_STRING( select_list, ', ' ) || $q$ FROM $q$ || relation_name || $q$ WHERE ($q$ || criteria || $q$)
311 )x WHERE $q$ || ARRAY_TO_STRING( where_list, ' OR ' );
312 -- RAISE NOTICE 'query: %', q;
314 FOR out_record IN EXECUTE q LOOP
315 RETURN NEXT out_record;
320 $func$ LANGUAGE PLPGSQL IMMUTABLE;
323 CREATE OR REPLACE FUNCTION extract_marc_field ( TEXT, BIGINT, TEXT, TEXT ) RETURNS TEXT AS $$
329 SELECT regexp_replace(
331 $q$ || quote_literal($3) || $q$,
335 $q$ || quote_literal($4) || $q$,
338 FROM $q$ || $1 || $q$
339 WHERE id = $q$ || $2;
341 EXECUTE query INTO output;
343 -- RAISE NOTICE 'query: %, output; %', query, output;
347 $$ LANGUAGE PLPGSQL IMMUTABLE;
349 CREATE OR REPLACE FUNCTION extract_marc_field ( TEXT, BIGINT, TEXT ) RETURNS TEXT AS $$
350 SELECT extract_marc_field($1,$2,$3,'');
351 $$ LANGUAGE SQL IMMUTABLE;
355 CREATE OR REPLACE FUNCTION oils_i18n_xlate ( keytable TEXT, keyclass TEXT, keycol TEXT, identcol TEXT, keyvalue TEXT, raw_locale TEXT ) RETURNS TEXT AS $func$
357 locale TEXT := REGEXP_REPLACE( REGEXP_REPLACE( raw_locale, E'[;, ].+$', '' ), E'_', '-', 'g' );
358 language TEXT := REGEXP_REPLACE( locale, E'-.+$', '' );
359 result config.i18n_core%ROWTYPE;
361 keyfield TEXT := keyclass || '.' || keycol;
364 -- Try the full locale
366 FROM config.i18n_core
367 WHERE fq_field = keyfield
368 AND identity_value = keyvalue
369 AND translation = locale;
371 -- Try just the language
374 FROM config.i18n_core
375 WHERE fq_field = keyfield
376 AND identity_value = keyvalue
377 AND translation = language;
380 -- Fall back to the string we passed in in the first place
385 ' FROM ' || keytable ||
386 ' WHERE ' || identcol || ' = ' || quote_literal(keyvalue)
391 RETURN result.string;
393 $func$ LANGUAGE PLPGSQL STABLE;
395 -- Functions for marking translatable strings in SQL statements
396 -- Parameters are: primary key, string, class hint, property
397 CREATE OR REPLACE FUNCTION oils_i18n_gettext( INT, TEXT, TEXT, TEXT ) RETURNS TEXT AS $$
401 CREATE OR REPLACE FUNCTION oils_i18n_gettext( TEXT, TEXT, TEXT, TEXT ) RETURNS TEXT AS $$
405 CREATE OR REPLACE FUNCTION is_json( TEXT ) RETURNS BOOL AS $f$
408 eval { JSON::XS->new->allow_nonref->decode( $json ) };
410 $f$ LANGUAGE PLPERLU;
412 -- turn a JSON scalar into an SQL TEXT value
413 CREATE OR REPLACE FUNCTION oils_json_to_text( TEXT ) RETURNS TEXT AS $f$
417 eval { $txt = JSON::XS->new->allow_nonref->decode( $json ) };
418 return undef if ($@);
420 $f$ LANGUAGE PLPERLU;
422 CREATE OR REPLACE FUNCTION evergreen.maintain_901 () RETURNS TRIGGER AS $func$
424 use_id_for_tcn BOOLEAN;
426 -- Remove any existing 901 fields before we insert the authoritative one
427 NEW.marc := REGEXP_REPLACE(NEW.marc, E'<datafield[^>]*?tag="901".+?</datafield>', '', 'g');
429 IF TG_TABLE_SCHEMA = 'biblio' THEN
430 -- Set TCN value to record ID?
431 SELECT enabled FROM config.global_flag INTO use_id_for_tcn
432 WHERE name = 'cat.bib.use_id_for_tcn';
434 IF use_id_for_tcn = 't' THEN
435 NEW.tcn_value := NEW.id;
438 NEW.marc := REGEXP_REPLACE(
440 E'(</(?:[^:]*?:)?record>)',
441 E'<datafield tag="901" ind1=" " ind2=" ">' ||
442 '<subfield code="a">' || evergreen.xml_escape(NEW.tcn_value) || E'</subfield>' ||
443 '<subfield code="b">' || evergreen.xml_escape(NEW.tcn_source) || E'</subfield>' ||
444 '<subfield code="c">' || NEW.id || E'</subfield>' ||
445 '<subfield code="t">' || TG_TABLE_SCHEMA || E'</subfield>' ||
446 CASE WHEN NEW.owner IS NOT NULL THEN '<subfield code="o">' || NEW.owner || E'</subfield>' ELSE '' END ||
447 CASE WHEN NEW.share_depth IS NOT NULL THEN '<subfield code="d">' || NEW.share_depth || E'</subfield>' ELSE '' END ||
450 ELSIF TG_TABLE_SCHEMA = 'authority' THEN
451 NEW.marc := REGEXP_REPLACE(
453 E'(</(?:[^:]*?:)?record>)',
454 E'<datafield tag="901" ind1=" " ind2=" ">' ||
455 '<subfield code="c">' || NEW.id || E'</subfield>' ||
456 '<subfield code="t">' || TG_TABLE_SCHEMA || E'</subfield>' ||
459 ELSIF TG_TABLE_SCHEMA = 'serial' THEN
460 NEW.marc := REGEXP_REPLACE(
462 E'(</(?:[^:]*?:)?record>)',
463 E'<datafield tag="901" ind1=" " ind2=" ">' ||
464 '<subfield code="c">' || NEW.id || E'</subfield>' ||
465 '<subfield code="t">' || TG_TABLE_SCHEMA || E'</subfield>' ||
466 '<subfield code="o">' || NEW.owning_lib || E'</subfield>' ||
467 CASE WHEN NEW.record IS NOT NULL THEN '<subfield code="r">' || NEW.record || E'</subfield>' ELSE '' END ||
471 NEW.marc := REGEXP_REPLACE(
473 E'(</(?:[^:]*?:)?record>)',
474 E'<datafield tag="901" ind1=" " ind2=" ">' ||
475 '<subfield code="c">' || NEW.id || E'</subfield>' ||
476 '<subfield code="t">' || TG_TABLE_SCHEMA || E'</subfield>' ||
483 $func$ LANGUAGE PLPGSQL;
485 CREATE OR REPLACE FUNCTION evergreen.force_unicode_normal_form(string TEXT, form TEXT) RETURNS TEXT AS $func$
486 use Unicode::Normalize 'normalize';
487 return normalize($_[1],$_[0]); # reverse the params
488 $func$ LANGUAGE PLPERLU;
490 CREATE OR REPLACE FUNCTION maintain_control_numbers() RETURNS TRIGGER AS $func$
493 use MARC::File::XML (BinaryEncoding => 'UTF-8');
496 use Unicode::Normalize;
498 MARC::Charset->assume_unicode(1);
500 my $record = MARC::Record->new_from_xml($_TD->{new}{marc});
501 my $schema = $_TD->{table_schema};
502 my $rec_id = $_TD->{new}{id};
504 # Short-circuit if maintaining control numbers per MARC21 spec is not enabled
505 my $enable = spi_exec_query("SELECT enabled FROM config.global_flag WHERE name = 'cat.maintain_control_numbers'");
506 if (!($enable->{processed}) or $enable->{rows}[0]->{enabled} eq 'f') {
510 # Get the control number identifier from an OU setting based on $_TD->{new}{owner}
511 my $ou_cni = 'EVRGRN';
514 if ($schema eq 'serial') {
515 $owner = $_TD->{new}{owning_lib};
517 # are.owner and bre.owner can be null, so fall back to the consortial setting
518 $owner = $_TD->{new}{owner} || 1;
521 my $ous_rv = spi_exec_query("SELECT value FROM actor.org_unit_ancestor_setting('cat.marc_control_number_identifier', $owner)");
522 if ($ous_rv->{processed}) {
523 $ou_cni = $ous_rv->{rows}[0]->{value};
524 $ou_cni =~ s/"//g; # Stupid VIM syntax highlighting"
526 # Fall back to the shortname of the OU if there was no OU setting
527 $ous_rv = spi_exec_query("SELECT shortname FROM actor.org_unit WHERE id = $owner");
528 if ($ous_rv->{processed}) {
529 $ou_cni = $ous_rv->{rows}[0]->{shortname};
533 my ($create, $munge) = (0, 0);
535 my @scns = $record->field('035');
537 foreach my $id_field ('001', '003') {
539 my @controls = $record->field($id_field);
541 if ($id_field eq '001') {
542 $spec_value = $rec_id;
544 $spec_value = $ou_cni;
547 # Create the 001/003 if none exist
548 if (scalar(@controls) == 1) {
549 # Only one field; check to see if we need to munge it
550 unless (grep $_->data() eq $spec_value, @controls) {
554 # Delete the other fields, as with more than 1 001/003 we do not know which 003/001 to match
555 foreach my $control (@controls) {
556 unless ($control->data() eq $spec_value) {
557 $record->delete_field($control);
560 $record->insert_fields_ordered(MARC::Field->new($id_field, $spec_value));
565 # Now, if we need to munge the 001, we will first push the existing 001/003
566 # into the 035; but if the record did not have one (and one only) 001 and 003
567 # to begin with, skip this process
568 if ($munge and not $create) {
569 my $scn = "(" . $record->field('003')->data() . ")" . $record->field('001')->data();
571 # Do not create duplicate 035 fields
572 unless (grep $_->subfield('a') eq $scn, @scns) {
573 $record->insert_fields_ordered(MARC::Field->new('035', '', '', 'a' => $scn));
577 # Set the 001/003 and update the MARC
578 if ($create or $munge) {
579 $record->field('001')->data($rec_id);
580 $record->field('003')->data($ou_cni);
582 my $xml = $record->as_xml_record();
584 $xml =~ s/^<\?xml.+\?\s*>//go;
585 $xml =~ s/>\s+</></go;
586 $xml =~ s/\p{Cc}//go;
588 # Embed a version of OpenILS::Application::AppUtils->entityize()
589 # to avoid having to set PERL5LIB for PostgreSQL as well
591 # If we are going to convert non-ASCII characters to XML entities,
592 # we had better be dealing with a UTF8 string to begin with
593 $xml = decode_utf8($xml);
597 # Convert raw ampersands to entities
598 $xml =~ s/&(?!\S+;)/&/gso;
600 # Convert Unicode characters to entities
601 $xml =~ s/([\x{0080}-\x{fffd}])/sprintf('&#x%X;',ord($1))/sgoe;
603 $xml =~ s/[\x00-\x1f]//go;
604 $_TD->{new}{marc} = $xml;
610 $func$ LANGUAGE PLPERLU;
612 CREATE OR REPLACE FUNCTION oils_text_as_bytea (TEXT) RETURNS BYTEA AS $_$
613 SELECT CAST(REGEXP_REPLACE(UPPER($1), $$\\$$, $$\\\\$$, 'g') AS BYTEA);
614 $_$ LANGUAGE SQL IMMUTABLE;
616 CREATE OR REPLACE FUNCTION evergreen.lpad_number_substrings( TEXT, TEXT, INT ) RETURNS TEXT AS $$
622 while ($string =~ /(?:^|\D)(\d{1,$find})(?:$|\D)/) {
624 $padded = $pad x ($len - length($padded)) . $padded;
625 $string =~ s/$1/$padded/sg;