Open-ILS/src/sql/Pg/000.functions.general.sql

   1 -- Rather than polluting the public schema with general Evergreen
   2 -- functions, carve out a dedicated schema
   3
   4 DROP SCHEMA IF EXISTS evergreen CASCADE;
   5
   6 BEGIN;
   7
   8 CREATE SCHEMA evergreen;
   9
  10 CREATE OR REPLACE FUNCTION evergreen.change_db_setting(setting_name TEXT, settings TEXT[]) RETURNS VOID AS $$
  11 BEGIN
  12     EXECUTE 'ALTER DATABASE ' || quote_ident(current_database()) || ' SET ' || quote_ident(setting_name) || ' = ' || array_to_string(settings, ',');
  13 END;
  14 $$ LANGUAGE plpgsql;
  15
  16 SELECT evergreen.change_db_setting('search_path', ARRAY['evergreen','public','pg_catalog']);
  17
  18 CREATE OR REPLACE FUNCTION evergreen.array_remove_item_by_value(inp ANYARRAY, el ANYELEMENT) RETURNS anyarray AS $$ SELECT ARRAY_AGG(x.e) FROM UNNEST( $1 ) x(e) WHERE x.e <> $2; $$ LANGUAGE SQL;
  19
  20 CREATE OR REPLACE FUNCTION evergreen.lowercase( TEXT ) RETURNS TEXT AS $$
  21     return lc(shift);
  22 $$ LANGUAGE PLPERLU STRICT IMMUTABLE;
  23
  24 CREATE OR REPLACE FUNCTION evergreen.uppercase( TEXT ) RETURNS TEXT AS $$
  25     return uc(shift);
  26 $$ LANGUAGE PLPERLU STRICT IMMUTABLE;
  27
  28 CREATE OR REPLACE FUNCTION evergreen.xml_escape(str TEXT) RETURNS text AS $$
  29     SELECT REPLACE(REPLACE(REPLACE($1,
  30        '&', '&amp;'),
  31        '<', '&lt;'),
  32        '>', '&gt;');
  33 $$ LANGUAGE SQL IMMUTABLE;
  34
  35 CREATE OR REPLACE FUNCTION evergreen.regexp_split_to_array(TEXT, TEXT)
  36 RETURNS TEXT[] AS $$
  37     return encode_array_literal([split $_[1], $_[0]]);
  38 $$ LANGUAGE PLPERLU STRICT IMMUTABLE;
  39
  40 -- Provide a named type for patching functions
  41 CREATE TYPE evergreen.patch AS (patch TEXT);
  42
  43 CREATE OR REPLACE FUNCTION evergreen.xml_pretty_print(input XML)
  44     RETURNS XML
  45     LANGUAGE SQL AS
  46 $func$
  47 SELECT xslt_process($1::text,
  48 $$<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
  49     version="1.0">
  50    <xsl:output method="xml" omit-xml-declaration="yes" indent="yes"/>
  51    <xsl:strip-space elements="*"/>
  52    <xsl:template match="@*|node()">
  53      <xsl:copy>
  54        <xsl:apply-templates select="@*|node()"/>
  55      </xsl:copy>
  56    </xsl:template>
  57  </xsl:stylesheet>
  58 $$::text)::XML
  59 $func$;
  60
  61 COMMENT ON FUNCTION evergreen.xml_pretty_print(input XML) IS
  62 'Simple pretty printer for XML, as written by Andrew Dunstan at http://goo.gl/zBHIk';
  63
  64 CREATE OR REPLACE FUNCTION evergreen.could_be_serial_holding_code(TEXT) RETURNS BOOL AS $$
  65     use JSON::XS;
  66     use MARC::Field;
  67
  68     eval {
  69         my $holding_code = (new JSON::XS)->decode(shift);
  70         new MARC::Field('999', @$holding_code);
  71     };
  72     return 0 if $@;
  73     # verify that subfield labels are exactly one character long
  74     foreach (keys %{ { @$holding_code } }) {
  75         return 0 if length($_) != 1;
  76     }
  77     return 1;
  78 $$ LANGUAGE PLPERLU;
  79
  80 COMMENT ON FUNCTION evergreen.could_be_serial_holding_code(TEXT) IS
  81     'Return true if parameter is valid JSON representing an array that at minimum doesn''t make MARC::Field balk and only has subfield labels exactly one character long.  Otherwise false.';
  82
  83 CREATE OR REPLACE FUNCTION evergreen.protect_reserved_rows_from_delete() RETURNS trigger AS $protect_reserved$
  84 BEGIN
  85 IF OLD.id < TG_ARGV[0]::INT THEN
  86     RAISE EXCEPTION 'Cannot delete row with reserved ID %', OLD.id;
  87 END IF;
  88 RETURN OLD;
  89 END
  90 $protect_reserved$
  91 LANGUAGE plpgsql;
  92
  93 CREATE OR REPLACE FUNCTION evergreen.unaccent_and_squash ( IN arg text) RETURNS text
  94     IMMUTABLE STRICT AS $$
  95         BEGIN
  96         RETURN evergreen.lowercase(public.unaccent('public.unaccent', regexp_replace(arg, '[\s[:punct:]]','','g')));
  97         END;
  98 $$ LANGUAGE PLPGSQL;
  99
 100
 101 COMMIT;