Open-ILS/src/sql/Pg/020.schema.functions.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 CREATE OR REPLACE FUNCTION public.non_filing_normalize ( TEXT, "char" ) RETURNS TEXT AS $$
  19         SELECT  SUBSTRING(
  20                         REGEXP_REPLACE(
  21                                 REGEXP_REPLACE(
  22                                         $1,
  23                                         E'\W*$',
  24                                         ''
  25                                 ),
  26                                 '  ',
  27                                 ' '
  28                         ),
  29                         CASE
  30                                 WHEN $2::INT NOT BETWEEN 48 AND 57 THEN 1
  31                                 ELSE $2::TEXT::INT + 1
  32                         END
  33                 );
  34 $$ LANGUAGE SQL STRICT IMMUTABLE;
  35
  36 CREATE OR REPLACE FUNCTION public.naco_normalize( TEXT, TEXT ) RETURNS TEXT AS $func$
  37     use Unicode::Normalize;
  38
  39         my $txt = lc(shift);
  40         my $sf = shift;
  41
  42     $txt = NFD($txt);
  43         $txt =~ s/\pM+//go;     # Remove diacritics
  44
  45         $txt =~ s/\xE6/AE/go;   # Convert ae digraph
  46         $txt =~ s/\x{153}/OE/go;# Convert oe digraph
  47         $txt =~ s/\xFE/TH/go;   # Convert Icelandic thorn
  48
  49         $txt =~ tr/\x{2070}\x{2071}\x{2072}\x{2073}\x{2074}\x{2075}\x{2076}\x{2077}\x{2078}\x{2079}\x{207A}\x{207B}/0123456789+-/;# Convert superscript numbers
  50         $txt =~ tr/\x{2080}\x{2081}\x{2082}\x{2083}\x{2084}\x{2085}\x{2086}\x{2087}\x{2088}\x{2089}\x{208A}\x{208B}/0123456889+-/;# Convert subscript numbers
  51
  52         $txt =~ tr/\x{0251}\x{03B1}\x{03B2}\x{0262}\x{03B3}/AABGG/;             # Convert Latin and Greek
  53         $txt =~ tr/\x{2113}\xF0\!\"\(\)\-\{\}\<\>\;\:\.\?\xA1\xBF\/\\\@\*\%\=\xB1\+\xAE\xA9\x{2117}\$\xA3\x{FFE1}\xB0\^\_\~\`/LD /;     # Convert Misc
  54         $txt =~ tr/\'\[\]\|//d;                                                 # Remove Misc
  55
  56         if ($sf && $sf =~ /^a/o) {
  57                 my $commapos = index($txt,',');
  58                 if ($commapos > -1) {
  59                         if ($commapos != length($txt) - 1) {
  60                                 my @list = split /,/, $txt;
  61                                 my $first = shift @list;
  62                                 $txt = $first . ',' . join(' ', @list);
  63                         } else {
  64                                 $txt =~ s/,/ /go;
  65                         }
  66                 }
  67         } else {
  68                 $txt =~ s/,/ /go;
  69         }
  70
  71         $txt =~ s/\s+/ /go;     # Compress multiple spaces
  72         $txt =~ s/^\s+//o;      # Remove leading space
  73         $txt =~ s/\s+$//o;      # Remove trailing space
  74
  75         return $txt;
  76 $func$ LANGUAGE 'plperlu' STRICT IMMUTABLE;
  77
  78 CREATE OR REPLACE FUNCTION public.naco_normalize( TEXT ) RETURNS TEXT AS $func$
  79         SELECT public.naco_normalize($1,'');
  80 $func$ LANGUAGE 'sql' STRICT IMMUTABLE;
  81
  82 CREATE OR REPLACE FUNCTION public.first_word ( TEXT ) RETURNS TEXT AS $$
  83         SELECT SUBSTRING( $1 FROM $_$^\S+$_$);
  84 $$ LANGUAGE SQL;
  85
  86 CREATE OR REPLACE FUNCTION public.naco_normalize_keep_comma( TEXT ) RETURNS TEXT AS $func$
  87         SELECT public.naco_normalize($1,'a');
  88 $func$ LANGUAGE SQL STRICT IMMUTABLE;
  89
  90 CREATE OR REPLACE FUNCTION public.normalize_space( TEXT ) RETURNS TEXT AS $$
  91     SELECT regexp_replace(regexp_replace(regexp_replace($1, E'\\n', ' ', 'g'), E'(?:^\\s+)|(\\s+$)', '', 'g'), E'\\s+', ' ', 'g');
  92 $$ LANGUAGE SQL;
  93
  94 CREATE OR REPLACE FUNCTION public.lowercase( TEXT ) RETURNS TEXT AS $$
  95     return lc(shift);
  96 $$ LANGUAGE PLPERLU;
  97
  98 CREATE OR REPLACE FUNCTION public.uppercase( TEXT ) RETURNS TEXT AS $$
  99     return uc(shift);
 100 $$ LANGUAGE PLPERLU;
 101
 102 CREATE OR REPLACE FUNCTION public.remove_diacritics( TEXT ) RETURNS TEXT AS $$
 103     use Unicode::Normalize;
 104
 105     my $x = NFD(shift);
 106     $x =~ s/\pM+//go;
 107     return $x;
 108
 109 $$ LANGUAGE PLPERLU;
 110
 111 CREATE OR REPLACE FUNCTION public.entityize( TEXT ) RETURNS TEXT AS $$
 112     use Unicode::Normalize;
 113
 114     my $x = NFC(shift);
 115     $x =~ s/([\x{0080}-\x{fffd}])/sprintf('&#x%X;',ord($1))/sgoe;
 116     return $x;
 117
 118 $$ LANGUAGE PLPERLU;
 119
 120 CREATE OR REPLACE FUNCTION public.call_number_dewey( TEXT ) RETURNS TEXT AS $$
 121         my $txt = shift;
 122         $txt =~ s/^\s+//o;
 123         $txt =~ s/[\[\]\{\}\(\)`'"#<>\*\?\-\+\$\\]+//og;
 124         $txt =~ s/\s+$//o;
 125         if ($txt =~ /(\d{3}(?:\.\d+)?)/o) {
 126                 return $1;
 127         } else {
 128                 return (split /\s+/, $txt)[0];
 129         }
 130 $$ LANGUAGE 'plperlu' STRICT IMMUTABLE;
 131
 132 CREATE OR REPLACE FUNCTION public.call_number_dewey( TEXT, INT ) RETURNS TEXT AS $$
 133         SELECT SUBSTRING(call_number_dewey($1) FROM 1 FOR $2);
 134 $$ LANGUAGE SQL STRICT IMMUTABLE;
 135
 136 CREATE OR REPLACE FUNCTION tableoid2name ( oid ) RETURNS TEXT AS $$
 137         BEGIN
 138                 RETURN $1::regclass;
 139         END;
 140 $$ language 'plpgsql';
 141
 142
 143 CREATE OR REPLACE FUNCTION actor.org_unit_descendants ( INT ) RETURNS SETOF actor.org_unit AS $$
 144         SELECT  a.*
 145           FROM  connectby('actor.org_unit'::text,'id'::text,'parent_ou'::text,'name'::text,$1::text,100,'.'::text)
 146                         AS t(keyid text, parent_keyid text, level int, branch text,pos int)
 147                 JOIN actor.org_unit a ON a.id::text = t.keyid::text
 148           ORDER BY  CASE WHEN a.parent_ou IS NULL THEN 0 ELSE 1 END, a.name;
 149 $$ LANGUAGE SQL STABLE;
 150
 151 CREATE OR REPLACE FUNCTION actor.org_unit_ancestors ( INT ) RETURNS SETOF actor.org_unit AS $$
 152         SELECT  a.*
 153           FROM  connectby('actor.org_unit'::text,'parent_ou'::text,'id'::text,'name'::text,$1::text,100,'.'::text)
 154                         AS t(keyid text, parent_keyid text, level int, branch text,pos int)
 155                 JOIN actor.org_unit a ON a.id::text = t.keyid::text
 156         JOIN actor.org_unit_type tp ON tp.id = a.ou_type
 157         ORDER BY tp.depth, a.name;
 158 $$ LANGUAGE SQL STABLE;
 159
 160 CREATE OR REPLACE FUNCTION actor.org_unit_descendants ( INT,INT ) RETURNS SETOF actor.org_unit AS $$
 161         SELECT  a.*
 162           FROM  connectby('actor.org_unit'::text,'id'::text,'parent_ou'::text,'name'::text,
 163                                 (SELECT x.id
 164                                    FROM actor.org_unit_ancestors($1) x
 165                                         JOIN actor.org_unit_type y ON x.ou_type = y.id
 166                                   WHERE y.depth = $2)::text
 167                 ,100,'.'::text)
 168                         AS t(keyid text, parent_keyid text, level int, branch text,pos int)
 169                 JOIN actor.org_unit a ON a.id::text = t.keyid::text
 170           ORDER BY  CASE WHEN a.parent_ou IS NULL THEN 0 ELSE 1 END, a.name;
 171 $$ LANGUAGE SQL STABLE;
 172
 173 CREATE OR REPLACE FUNCTION actor.org_unit_ancestor_at_depth ( INT,INT ) RETURNS actor.org_unit AS $$
 174         SELECT  a.*
 175           FROM  actor.org_unit a
 176           WHERE id = ( SELECT FIRST(x.id)
 177                          FROM   actor.org_unit_ancestors($1) x
 178                                 JOIN actor.org_unit_type y
 179                                         ON x.ou_type = y.id AND y.depth = $2);
 180 $$ LANGUAGE SQL STABLE;
 181
 182 CREATE OR REPLACE FUNCTION actor.org_unit_full_path ( INT ) RETURNS SETOF actor.org_unit AS $$
 183         SELECT  *
 184           FROM  actor.org_unit_ancestors($1)
 185                         UNION
 186         SELECT  *
 187           FROM  actor.org_unit_descendants($1);
 188 $$ LANGUAGE SQL STABLE;
 189
 190 CREATE OR REPLACE FUNCTION actor.org_unit_full_path ( INT, INT ) RETURNS SETOF actor.org_unit AS $$
 191         SELECT  * FROM actor.org_unit_full_path((actor.org_unit_ancestor_at_depth($1, $2)).id)
 192 $$ LANGUAGE SQL STABLE;
 193
 194 CREATE OR REPLACE FUNCTION actor.org_unit_combined_ancestors ( INT, INT ) RETURNS SETOF actor.org_unit AS $$
 195         SELECT  *
 196           FROM  actor.org_unit_ancestors($1)
 197                         UNION
 198         SELECT  *
 199           FROM  actor.org_unit_ancestors($2);
 200 $$ LANGUAGE SQL STABLE;
 201
 202 CREATE OR REPLACE FUNCTION actor.org_unit_common_ancestors ( INT, INT ) RETURNS SETOF actor.org_unit AS $$
 203         SELECT  *
 204           FROM  actor.org_unit_ancestors($1)
 205                         INTERSECT
 206         SELECT  *
 207           FROM  actor.org_unit_ancestors($2);
 208 $$ LANGUAGE SQL STABLE;
 209
 210 CREATE OR REPLACE FUNCTION actor.org_unit_proximity ( INT, INT ) RETURNS INT AS $$
 211         SELECT COUNT(id)::INT FROM (
 212                 SELECT id FROM actor.org_unit_combined_ancestors($1, $2)
 213                         EXCEPT
 214                 SELECT id FROM actor.org_unit_common_ancestors($1, $2)
 215         ) z;
 216 $$ LANGUAGE SQL STABLE;
 217
 218 CREATE OR REPLACE FUNCTION actor.org_unit_ancestor_setting( setting_name TEXT, org_id INT ) RETURNS SETOF actor.org_unit_setting AS $$
 219 DECLARE
 220     setting RECORD;
 221     cur_org INT;
 222 BEGIN
 223     cur_org := org_id;
 224     LOOP
 225         SELECT INTO setting * FROM actor.org_unit_setting WHERE org_unit = cur_org AND name = setting_name;
 226         IF FOUND THEN
 227             RETURN NEXT setting;
 228         END IF;
 229         SELECT INTO cur_org parent_ou FROM actor.org_unit WHERE id = cur_org;
 230         EXIT WHEN cur_org IS NULL;
 231     END LOOP;
 232     RETURN;
 233 END;
 234 $$ LANGUAGE plpgsql;
 235
 236 COMMENT ON FUNCTION actor.org_unit_ancestor_setting( TEXT, INT) IS $$
 237 /**
 238 * Search "up" the org_unit tree until we find the first occurrence of an
 239 * org_unit_setting with the given name.
 240 */
 241 $$;
 242