sql/base/base.sql

   1 --------------------------------------------------------------------------
   2 -- An example of how to use:
   3 --
   4 -- DROP SCHEMA foo CASCADE; CREATE SCHEMA foo;
   5 -- \i base.sql
   6 -- SELECT migration_tools.init('foo');
   7 -- SELECT migration_tools.build('foo');
   8 -- SELECT * FROM foo.fields_requiring_mapping;
   9 -- \d foo.actor_usr
  10 -- create some incoming ILS specific staging tables, like CREATE foo.legacy_items ( l_barcode TEXT, .. ) INHERITS foo.asset_copy;
  11 -- Do some mapping, like UPDATE foo.legacy_items SET barcode = TRIM(BOTH ' ' FROM l_barcode);
  12 -- Then, to move into production, do: select migration_tools.insert_base_into_production('foo')
  13
  14 CREATE SCHEMA migration_tools;
  15
  16 CREATE OR REPLACE FUNCTION migration_tools.production_tables (TEXT) RETURNS TEXT[] AS $$
  17     DECLARE
  18         migration_schema ALIAS FOR $1;
  19         output  RECORD;
  20     BEGIN
  21         FOR output IN
  22             EXECUTE 'SELECT string_to_array(value,'','') AS tables FROM ' || migration_schema || '.config WHERE key = ''production_tables'';'
  23         LOOP
  24             RETURN output.tables;
  25         END LOOP;
  26     END;
  27 $$ LANGUAGE PLPGSQL STRICT STABLE;
  28
  29 CREATE OR REPLACE FUNCTION migration_tools.country_code (TEXT) RETURNS TEXT AS $$
  30     DECLARE
  31         migration_schema ALIAS FOR $1;
  32         output TEXT;
  33     BEGIN
  34         FOR output IN
  35             EXECUTE 'SELECT value FROM ' || migration_schema || '.config WHERE key = ''country_code'';'
  36         LOOP
  37             RETURN output;
  38         END LOOP;
  39     END;
  40 $$ LANGUAGE PLPGSQL STRICT STABLE;
  41
  42
  43 CREATE OR REPLACE FUNCTION migration_tools.log (TEXT,TEXT,INTEGER) RETURNS VOID AS $$
  44     DECLARE
  45         migration_schema ALIAS FOR $1;
  46         sql ALIAS FOR $2;
  47         nrows ALIAS FOR $3;
  48     BEGIN
  49         EXECUTE 'INSERT INTO ' || migration_schema || '.sql_log ( sql, row_count ) VALUES ( ' || quote_literal(sql) || ', ' || nrows || ' );';
  50     END;
  51 $$ LANGUAGE PLPGSQL STRICT VOLATILE;
  52
  53 CREATE OR REPLACE FUNCTION migration_tools.exec (TEXT,TEXT) RETURNS VOID AS $$
  54     DECLARE
  55         migration_schema ALIAS FOR $1;
  56         sql ALIAS FOR $2;
  57         nrows INTEGER;
  58     BEGIN
  59         EXECUTE 'UPDATE ' || migration_schema || '.sql_current SET sql = ' || quote_literal(sql) || ';';
  60         --RAISE INFO '%', sql;
  61         EXECUTE sql;
  62         GET DIAGNOSTICS nrows = ROW_COUNT;
  63         PERFORM migration_tools.log(migration_schema,sql,nrows);
  64     EXCEPTION
  65         WHEN OTHERS THEN
  66             RAISE EXCEPTION '!!!!!!!!!!! state = %, msg = %, sql = %', SQLSTATE, SQLERRM, sql;
  67     END;
  68 $$ LANGUAGE PLPGSQL STRICT VOLATILE;
  69
  70 CREATE OR REPLACE FUNCTION migration_tools.debug_exec (TEXT,TEXT) RETURNS VOID AS $$
  71     DECLARE
  72         migration_schema ALIAS FOR $1;
  73         sql ALIAS FOR $2;
  74         nrows INTEGER;
  75     BEGIN
  76         EXECUTE 'UPDATE ' || migration_schema || '.sql_current SET sql = ' || quote_literal(sql) || ';';
  77         RAISE INFO 'debug_exec sql = %', sql;
  78         EXECUTE sql;
  79         GET DIAGNOSTICS nrows = ROW_COUNT;
  80         PERFORM migration_tools.log(migration_schema,sql,nrows);
  81     EXCEPTION
  82         WHEN OTHERS THEN
  83             RAISE EXCEPTION '!!!!!!!!!!! state = %, msg = %, sql = %', SQLSTATE, SQLERRM, sql;
  84     END;
  85 $$ LANGUAGE PLPGSQL STRICT VOLATILE;
  86
  87 CREATE OR REPLACE FUNCTION migration_tools.init (TEXT) RETURNS VOID AS $$
  88     DECLARE
  89         migration_schema ALIAS FOR $1;
  90         sql TEXT;
  91     BEGIN
  92         EXECUTE 'DROP TABLE IF EXISTS ' || migration_schema || '.sql_current;';
  93         EXECUTE 'CREATE TABLE ' || migration_schema || '.sql_current ( sql TEXT);';
  94         EXECUTE 'INSERT INTO ' || migration_schema || '.sql_current ( sql ) VALUES ( '''' );';
  95         BEGIN
  96             SELECT 'CREATE TABLE ' || migration_schema || '.sql_log ( time TIMESTAMP NOT NULL DEFAULT NOW(), row_count INTEGER, sql TEXT );' INTO STRICT sql;
  97             EXECUTE sql;
  98         EXCEPTION
  99             WHEN OTHERS THEN
 100                 RAISE INFO '!!!!!!!!!!! state = %, msg = %, sql = %', SQLSTATE, SQLERRM, sql;
 101         END;
 102         PERFORM migration_tools.exec( $1, 'DROP TABLE IF EXISTS ' || migration_schema || '.config;' );
 103         PERFORM migration_tools.exec( $1, 'CREATE TABLE ' || migration_schema || '.config ( key TEXT UNIQUE, value TEXT);' );
 104         PERFORM migration_tools.exec( $1, 'INSERT INTO ' || migration_schema || '.config (key,value) VALUES ( ''production_tables'', ''asset.call_number,asset.copy_location,asset.copy,asset.stat_cat,asset.stat_cat_entry,asset.stat_cat_entry_copy_map,asset.copy_note,actor.usr,actor.card,actor.usr_address,actor.stat_cat,actor.stat_cat_entry,actor.stat_cat_entry_usr_map,actor.usr_note,action.circulation,action.hold_request,money.grocery,money.billing,money.cash_payment,money.forgive_payment'' );' );
 105         PERFORM migration_tools.exec( $1, 'INSERT INTO ' || migration_schema || '.config (key,value) VALUES ( ''country_code'', ''USA'' );' );
 106         PERFORM migration_tools.exec( $1, 'DROP TABLE IF EXISTS ' || migration_schema || '.fields_requiring_mapping;' );
 107         PERFORM migration_tools.exec( $1, 'CREATE TABLE ' || migration_schema || '.fields_requiring_mapping( table_schema TEXT, table_name TEXT, column_name TEXT, data_type TEXT);' );
 108         PERFORM migration_tools.exec( $1, 'DROP TABLE IF EXISTS ' || migration_schema || '.base_profile_map;' );
 109         PERFORM migration_tools.exec( $1, 'CREATE TABLE ' || migration_schema || E'.base_profile_map (
 110             id SERIAL,
 111             perm_grp_id INTEGER,
 112             transcribed_perm_group TEXT,
 113             legacy_field1 TEXT,
 114             legacy_value1 TEXT,
 115             legacy_field2 TEXT,
 116             legacy_value2 TEXT,
 117             legacy_field3 TEXT,
 118             legacy_value3 TEXT
 119         );' );
 120         PERFORM migration_tools.exec( $1, 'INSERT INTO ' || migration_schema || '.config (key,value) VALUES ( ''base_profile_map'', ''base_profile_map'' );' );
 121         PERFORM migration_tools.exec( $1, 'DROP TABLE IF EXISTS ' || migration_schema || '.base_item_dynamic_field_map;' );
 122         PERFORM migration_tools.exec( $1, 'CREATE TABLE ' || migration_schema || E'.base_item_dynamic_field_map (
 123             id SERIAL,
 124             evergreen_field TEXT,
 125             evergreen_value TEXT,
 126             evergreen_datatype TEXT,
 127             legacy_field1 TEXT,
 128             legacy_value1 TEXT,
 129             legacy_field2 TEXT,
 130             legacy_value2 TEXT,
 131             legacy_field3 TEXT,
 132             legacy_value3 TEXT
 133         );' );
 134         PERFORM migration_tools.exec( $1, 'CREATE INDEX ' || migration_schema || '_item_dynamic_lf1_idx ON ' || migration_schema || '.base_item_dynamic_field_map (legacy_field1,legacy_value1);' );
 135         PERFORM migration_tools.exec( $1, 'CREATE INDEX ' || migration_schema || '_item_dynamic_lf2_idx ON ' || migration_schema || '.base_item_dynamic_field_map (legacy_field2,legacy_value2);' );
 136         PERFORM migration_tools.exec( $1, 'CREATE INDEX ' || migration_schema || '_item_dynamic_lf3_idx ON ' || migration_schema || '.base_item_dynamic_field_map (legacy_field3,legacy_value3);' );
 137         PERFORM migration_tools.exec( $1, 'INSERT INTO ' || migration_schema || '.config (key,value) VALUES ( ''base_item_dynamic_field_map'', ''base_item_dynamic_field_map'' );' );
 138         PERFORM migration_tools.exec( $1, 'DROP TABLE IF EXISTS ' || migration_schema || '.base_copy_location_map;' );
 139         PERFORM migration_tools.exec( $1, 'CREATE TABLE ' || migration_schema || E'.base_copy_location_map (
 140             id SERIAL,
 141             location INTEGER,
 142             holdable BOOLEAN NOT NULL DEFAULT TRUE,
 143             hold_verify BOOLEAN NOT NULL DEFAULT FALSE,
 144             opac_visible BOOLEAN NOT NULL DEFAULT TRUE,
 145             circulate BOOLEAN NOT NULL DEFAULT TRUE,
 146             transcribed_location TEXT,
 147             legacy_field1 TEXT,
 148             legacy_value1 TEXT,
 149             legacy_field2 TEXT,
 150             legacy_value2 TEXT,
 151             legacy_field3 TEXT,
 152             legacy_value3 TEXT
 153         );' );
 154         PERFORM migration_tools.exec( $1, 'CREATE INDEX ' || migration_schema || '_base_copy_location_lf1_idx ON ' || migration_schema || '.base_copy_location_map (legacy_field1,legacy_value1);' );
 155         PERFORM migration_tools.exec( $1, 'CREATE INDEX ' || migration_schema || '_base_copy_location_lf2_idx ON ' || migration_schema || '.base_copy_location_map (legacy_field2,legacy_value2);' );
 156         PERFORM migration_tools.exec( $1, 'CREATE INDEX ' || migration_schema || '_base_copy_location_lf3_idx ON ' || migration_schema || '.base_copy_location_map (legacy_field3,legacy_value3);' );
 157         PERFORM migration_tools.exec( $1, 'CREATE INDEX ' || migration_schema || '_base_copy_location_loc_idx ON ' || migration_schema || '.base_copy_location_map (transcribed_location);' );
 158         PERFORM migration_tools.exec( $1, 'INSERT INTO ' || migration_schema || '.config (key,value) VALUES ( ''base_copy_location_map'', ''base_copy_location_map'' );' );
 159         PERFORM migration_tools.exec( $1, 'DROP TABLE IF EXISTS ' || migration_schema || '.base_circ_field_map;' );
 160         PERFORM migration_tools.exec( $1, 'CREATE TABLE ' || migration_schema || E'.base_circ_field_map (
 161             id SERIAL,
 162             circulate BOOLEAN,
 163             loan_period TEXT,
 164             max_renewals TEXT,
 165             max_out TEXT,
 166             fine_amount TEXT,
 167             fine_interval TEXT,
 168             max_fine TEXT,
 169             item_field1 TEXT,
 170             item_value1 TEXT,
 171             item_field2 TEXT,
 172             item_value2 TEXT,
 173             patron_field1 TEXT,
 174             patron_value1 TEXT,
 175             patron_field2 TEXT,
 176             patron_value2 TEXT
 177         );' );
 178         PERFORM migration_tools.exec( $1, 'CREATE INDEX ' || migration_schema || '_circ_dynamic_lf1_idx ON ' || migration_schema || '.base_circ_field_map (item_field1,item_value1);' );
 179         PERFORM migration_tools.exec( $1, 'CREATE INDEX ' || migration_schema || '_circ_dynamic_lf2_idx ON ' || migration_schema || '.base_circ_field_map (item_field2,item_value2);' );
 180         PERFORM migration_tools.exec( $1, 'CREATE INDEX ' || migration_schema || '_circ_dynamic_lf3_idx ON ' || migration_schema || '.base_circ_field_map (patron_field1,patron_value1);' );
 181         PERFORM migration_tools.exec( $1, 'CREATE INDEX ' || migration_schema || '_circ_dynamic_lf4_idx ON ' || migration_schema || '.base_circ_field_map (patron_field2,patron_value2);' );
 182         PERFORM migration_tools.exec( $1, 'INSERT INTO ' || migration_schema || '.config (key,value) VALUES ( ''base_circ_field_map'', ''base_circ_field_map'' );' );
 183
 184         BEGIN
 185             PERFORM migration_tools.exec( $1, 'INSERT INTO ' || migration_schema || '.config (key,value) VALUES ( ''last_init'', now() );' );
 186         EXCEPTION
 187             WHEN OTHERS THEN PERFORM migration_tools.exec( $1, 'UPDATE ' || migration_schema || '.config SET value = now() WHERE key = ''last_init'';' );
 188         END;
 189     END;
 190 $$ LANGUAGE PLPGSQL STRICT VOLATILE;
 191
 192 CREATE OR REPLACE FUNCTION migration_tools.build (TEXT) RETURNS VOID AS $$
 193     DECLARE
 194         migration_schema ALIAS FOR $1;
 195         production_tables TEXT[];
 196     BEGIN
 197         --RAISE INFO 'In migration_tools.build(%)', migration_schema;
 198         SELECT migration_tools.production_tables(migration_schema) INTO STRICT production_tables;
 199         PERFORM migration_tools.build_base_staging_tables(migration_schema,production_tables);
 200         PERFORM migration_tools.exec( $1, 'CREATE UNIQUE INDEX ' || migration_schema || '_patron_barcode_key ON ' || migration_schema || '.actor_card ( barcode );' );
 201         PERFORM migration_tools.exec( $1, 'CREATE UNIQUE INDEX ' || migration_schema || '_patron_usrname_key ON ' || migration_schema || '.actor_usr ( usrname );' );
 202         PERFORM migration_tools.exec( $1, 'CREATE UNIQUE INDEX ' || migration_schema || '_copy_barcode_key ON ' || migration_schema || '.asset_copy ( barcode );' );
 203         PERFORM migration_tools.exec( $1, 'CREATE INDEX ' || migration_schema || '_callnum_record_idx ON ' || migration_schema || '.asset_call_number ( record );' );
 204         PERFORM migration_tools.exec( $1, 'CREATE INDEX ' || migration_schema || '_callnum_upper_label_id_lib_idx ON ' || migration_schema || '.asset_call_number ( UPPER(label),id,owning_lib );' );
 205         PERFORM migration_tools.exec( $1, 'CREATE UNIQUE INDEX ' || migration_schema || '_callnum_label_once_per_lib ON ' || migration_schema || '.asset_call_number ( record,owning_lib,label );' );
 206     END;
 207 $$ LANGUAGE PLPGSQL STRICT VOLATILE;
 208
 209 CREATE OR REPLACE FUNCTION migration_tools.build_base_staging_tables (TEXT,TEXT[]) RETURNS VOID AS $$
 210     DECLARE
 211         migration_schema ALIAS FOR $1;
 212         production_tables ALIAS FOR $2;
 213     BEGIN
 214         --RAISE INFO 'In migration_tools.build_base_staging_tables(%,%)', migration_schema, production_tables;
 215         FOR i IN array_lower(production_tables,1) .. array_upper(production_tables,1) LOOP
 216             PERFORM migration_tools.build_specific_base_staging_table(migration_schema,production_tables[i]);
 217         END LOOP;
 218     END;
 219 $$ LANGUAGE PLPGSQL STRICT VOLATILE;
 220
 221 CREATE OR REPLACE FUNCTION migration_tools.build_specific_base_staging_table (TEXT,TEXT) RETURNS VOID AS $$
 222     DECLARE
 223         migration_schema ALIAS FOR $1;
 224         production_table ALIAS FOR $2;
 225         base_staging_table TEXT;
 226         columns RECORD;
 227     BEGIN
 228         base_staging_table = REPLACE( production_table, '.', '_' );
 229         --RAISE INFO 'In migration_tools.build_specific_base_staging_table(%,%) -> %', migration_schema, production_table, base_staging_table;
 230         PERFORM migration_tools.exec( $1, 'CREATE TABLE ' || migration_schema || '.' || base_staging_table || ' ( LIKE ' || production_table || ' INCLUDING DEFAULTS EXCLUDING CONSTRAINTS );' );
 231         PERFORM migration_tools.exec( $1, '
 232             INSERT INTO ' || migration_schema || '.fields_requiring_mapping
 233                 SELECT table_schema, table_name, column_name, data_type
 234                 FROM information_schema.columns
 235                 WHERE table_schema = ''' || migration_schema || ''' AND table_name = ''' || base_staging_table || ''' AND is_nullable = ''NO'' AND column_default IS NULL;
 236         ' );
 237         FOR columns IN
 238             SELECT table_schema, table_name, column_name, data_type
 239             FROM information_schema.columns
 240             WHERE table_schema = migration_schema AND table_name = base_staging_table AND is_nullable = 'NO' AND column_default IS NULL
 241         LOOP
 242             PERFORM migration_tools.exec( $1, 'ALTER TABLE ' || columns.table_schema || '.' || columns.table_name || ' ALTER COLUMN ' || columns.column_name || ' DROP NOT NULL;' );
 243         END LOOP;
 244     END;
 245 $$ LANGUAGE PLPGSQL STRICT VOLATILE;
 246
 247 CREATE OR REPLACE FUNCTION migration_tools.insert_base_into_production (TEXT) RETURNS VOID AS $$
 248     DECLARE
 249         migration_schema ALIAS FOR $1;
 250         production_tables TEXT[];
 251     BEGIN
 252         --RAISE INFO 'In migration_tools.insert_into_production(%)', migration_schema;
 253         SELECT migration_tools.production_tables(migration_schema) INTO STRICT production_tables;
 254         FOR i IN array_lower(production_tables,1) .. array_upper(production_tables,1) LOOP
 255             PERFORM migration_tools.insert_into_production(migration_schema,production_tables[i]);
 256         END LOOP;
 257     END;
 258 $$ LANGUAGE PLPGSQL STRICT VOLATILE;
 259
 260 CREATE OR REPLACE FUNCTION migration_tools.insert_into_production (TEXT,TEXT) RETURNS VOID AS $$
 261     DECLARE
 262         migration_schema ALIAS FOR $1;
 263         production_table ALIAS FOR $2;
 264         base_staging_table TEXT;
 265         columns RECORD;
 266     BEGIN
 267         base_staging_table = REPLACE( production_table, '.', '_' );
 268         --RAISE INFO 'In migration_tools.insert_into_production(%,%) -> %', migration_schema, production_table, base_staging_table;
 269         PERFORM migration_tools.exec( $1, 'INSERT INTO ' || production_table || ' SELECT * FROM ' || migration_schema || '.' || base_staging_table || ';' );
 270     END;
 271 $$ LANGUAGE PLPGSQL STRICT VOLATILE;
 272
 273 CREATE OR REPLACE FUNCTION migration_tools.name_parse_out_last_comma_prefix_first_middle_suffix (TEXT) RETURNS TEXT[] AS $$
 274     DECLARE
 275         full_name TEXT := $1;
 276         temp TEXT;
 277         family_name TEXT := '';
 278         first_given_name TEXT := '';
 279         second_given_name TEXT := '';
 280         suffix TEXT := '';
 281         prefix TEXT := '';
 282     BEGIN
 283         temp := full_name;
 284         -- Use values, not structure, for prefix/suffix, unless we come up with a better idea
 285         IF temp ilike '%MR.%' THEN
 286             prefix := 'Mr.';
 287             temp := REGEXP_REPLACE( temp, E'MR\.\\s*', '', 'i' );
 288         END IF;
 289         IF temp ilike '%MRS.%' THEN
 290             prefix := 'Mrs.';
 291             temp := REGEXP_REPLACE( temp, E'MRS\.\\s*', '', 'i' );
 292         END IF;
 293         IF temp ilike '%MS.%' THEN
 294             prefix := 'Ms.';
 295             temp := REGEXP_REPLACE( temp, E'MS\.\\s*', '', 'i' );
 296         END IF;
 297         IF temp ilike '%DR.%' THEN
 298             prefix := 'Dr.';
 299             temp := REGEXP_REPLACE( temp, E'DR\.\\s*', '', 'i' );
 300         END IF;
 301         IF temp ilike '%JR%' THEN
 302             suffix := 'Jr.';
 303             temp := REGEXP_REPLACE( temp, E'JR\.?\\s*', '', 'i' );
 304         END IF;
 305         IF temp ilike '%SR%' THEN
 306             suffix := 'Sr.';
 307             temp := REGEXP_REPLACE( temp, E'SR\.?\\s*', '', 'i' );
 308         END IF;
 309         IF temp ~ E'\\sII$' THEN
 310             suffix := 'II';
 311             temp := REGEXP_REPLACE( temp, E'II$', '', 'i' );
 312         END IF;
 313         IF temp ~ E'\\sIII$' THEN
 314             suffix := 'III';
 315             temp := REGEXP_REPLACE( temp, E'III$', '', 'i' );
 316         END IF;
 317
 318         family_name := BTRIM( REGEXP_REPLACE(temp,E'^([^,]*)\\s*,.*$',E'\\1') );
 319         first_given_name := BTRIM( CASE WHEN temp ~ ',' THEN REGEXP_REPLACE(temp,E'^[^,]*\\s*,\\s*([^,\\s]*)\\s*.*$',E'\\1') ELSE 'N/A' END );
 320         second_given_name := BTRIM( CASE WHEN temp ~ ',' THEN REGEXP_REPLACE(temp,E'^[^,]*\\s*,\\s*[^,\\s]*\\s*(.*)$',E'\\1') ELSE ''  END );
 321
 322         RETURN ARRAY[ family_name, prefix, first_given_name, second_given_name, suffix ];
 323     END;
 324 $$ LANGUAGE PLPGSQL STRICT IMMUTABLE;
 325
 326 CREATE OR REPLACE FUNCTION migration_tools.address_parse_out_citystatezip (TEXT) RETURNS TEXT[] AS $$
 327     DECLARE
 328         city_state_zip TEXT := $1;
 329         city TEXT := '';
 330         state TEXT := '';
 331         zip TEXT := '';
 332     BEGIN
 333         zip := CASE WHEN city_state_zip ~ E'\\d\\d\\d\\d\\d' THEN REGEXP_REPLACE( city_state_zip, E'^.*(\\d\\d\\d\\d\\d-?\\d*).*$', E'\\1' ) ELSE '' END;
 334         city_state_zip := REGEXP_REPLACE( city_state_zip, E'^(.*)\\d\\d\\d\\d\\d-?\\d*(.*)$', E'\\1\\2');
 335         IF city_state_zip ~ ',' THEN
 336             state := REGEXP_REPLACE( city_state_zip, E'^(.*),(.*)$', E'\\2');
 337             city := REGEXP_REPLACE( city_state_zip, E'^(.*),(.*)$', E'\\1');
 338         ELSE
 339             IF city_state_zip ~ E'\\s+[A-Z][A-Z]\\s*' THEN
 340                 state := REGEXP_REPLACE( city_state_zip, E'^.*,?\\s+([A-Z][A-Z])\\s*.*$', E'\\1' );
 341                 city := REGEXP_REPLACE( city_state_zip, E'^(.*?),?\\s+[A-Z][A-Z](\\s*.*)$', E'\\1\\2' );
 342             ELSE
 343                 IF city_state_zip ~ E'^\\S+$'  THEN
 344                     city := city_state_zip;
 345                     state := 'N/A';
 346                 ELSE
 347                     state := REGEXP_REPLACE( city_state_zip, E'^(.*?),?\\s*(\\S+)\\s*$', E'\\2');
 348                     city := REGEXP_REPLACE( city_state_zip, E'^(.*?),?\\s*(\\S+)\\s*$', E'\\1');
 349                 END IF;
 350             END IF;
 351         END IF;
 352         RETURN ARRAY[ TRIM(BOTH ' ' FROM city), TRIM(BOTH ' ' FROM state), TRIM(BOTH ' ' FROM zip) ];
 353     END;
 354 $$ LANGUAGE PLPGSQL STRICT VOLATILE;
 355
 356 CREATE OR REPLACE FUNCTION migration_tools.rebarcode (o TEXT, t BIGINT) RETURNS TEXT AS $$
 357     DECLARE
 358         n TEXT := o;
 359     BEGIN
 360         IF o ~ E'^\\d+$' AND o !~ E'^0' AND length(o) < 19 THEN -- for reference, the max value for a bigint is 9223372036854775807.  May also want to consider the case where folks want to add prefixes to non-numeric barcodes
 361             IF o::BIGINT < t THEN
 362                 n = o::BIGINT + t;
 363             END IF;
 364         END IF;
 365
 366         RETURN n;
 367     END;
 368 $$ LANGUAGE PLPGSQL STRICT IMMUTABLE;
 369
 370 CREATE OR REPLACE FUNCTION migration_tools.base_profile_map (TEXT) RETURNS TEXT AS $$
 371     DECLARE
 372         migration_schema ALIAS FOR $1;
 373         output TEXT;
 374     BEGIN
 375         FOR output IN
 376             EXECUTE 'SELECT ''' || migration_schema || '.'' || value FROM ' || migration_schema || '.config WHERE key = ''base_profile_map'';'
 377         LOOP
 378             RETURN output;
 379         END LOOP;
 380     END;
 381 $$ LANGUAGE PLPGSQL STRICT STABLE;
 382
 383 CREATE OR REPLACE FUNCTION migration_tools.base_item_dynamic_field_map (TEXT) RETURNS TEXT AS $$
 384     DECLARE
 385         migration_schema ALIAS FOR $1;
 386         output TEXT;
 387     BEGIN
 388         FOR output IN
 389             EXECUTE 'SELECT ''' || migration_schema || '.'' || value FROM ' || migration_schema || '.config WHERE key = ''base_item_dynamic_field_map'';'
 390         LOOP
 391             RETURN output;
 392         END LOOP;
 393     END;
 394 $$ LANGUAGE PLPGSQL STRICT STABLE;
 395
 396 CREATE OR REPLACE FUNCTION migration_tools.base_copy_location_map (TEXT) RETURNS TEXT AS $$
 397     DECLARE
 398         migration_schema ALIAS FOR $1;
 399         output TEXT;
 400     BEGIN
 401         FOR output IN
 402             EXECUTE 'SELECT ''' || migration_schema || '.'' || value FROM ' || migration_schema || '.config WHERE key = ''base_copy_location_map'';'
 403         LOOP
 404             RETURN output;
 405         END LOOP;
 406     END;
 407 $$ LANGUAGE PLPGSQL STRICT STABLE;
 408
 409 CREATE OR REPLACE FUNCTION migration_tools.base_circ_field_map (TEXT) RETURNS TEXT AS $$
 410     DECLARE
 411         migration_schema ALIAS FOR $1;
 412         output TEXT;
 413     BEGIN
 414         FOR output IN
 415             EXECUTE 'SELECT ''' || migration_schema || '.'' || value FROM ' || migration_schema || '.config WHERE key = ''base_circ_field_map'';'
 416         LOOP
 417             RETURN output;
 418         END LOOP;
 419     END;
 420 $$ LANGUAGE PLPGSQL STRICT STABLE;
 421
 422 CREATE OR REPLACE FUNCTION migration_tools.map_base_patron_profile (TEXT,TEXT,INTEGER) RETURNS VOID AS $$
 423     DECLARE
 424         migration_schema ALIAS FOR $1;
 425         profile_map TEXT;
 426         patron_table ALIAS FOR $2;
 427         default_patron_profile ALIAS FOR $3;
 428         sql TEXT;
 429         sql_update TEXT;
 430         sql_where1 TEXT := '';
 431         sql_where2 TEXT := '';
 432         sql_where3 TEXT := '';
 433         output RECORD;
 434     BEGIN
 435         SELECT migration_tools.base_profile_map(migration_schema) INTO STRICT profile_map;
 436         FOR output IN
 437             EXECUTE 'SELECT * FROM ' || profile_map || E' ORDER BY id;'
 438         LOOP
 439             sql_update := 'UPDATE ' || patron_table || ' AS u SET profile = perm_grp_id FROM ' || profile_map || ' AS m WHERE ';
 440             sql_where1 := NULLIF(output.legacy_field1,'') || ' = ' || quote_literal( output.legacy_value1 ) || ' AND legacy_field1 = ' || quote_literal(output.legacy_field1) || ' AND legacy_value1 = ' || quote_literal(output.legacy_value1);
 441             sql_where2 := NULLIF(output.legacy_field2,'') || ' = ' || quote_literal( output.legacy_value2 ) || ' AND legacy_field2 = ' || quote_literal(output.legacy_field2) || ' AND legacy_value2 = ' || quote_literal(output.legacy_value2);
 442             sql_where3 := NULLIF(output.legacy_field3,'') || ' = ' || quote_literal( output.legacy_value3 ) || ' AND legacy_field3 = ' || quote_literal(output.legacy_field3) || ' AND legacy_value3 = ' || quote_literal(output.legacy_value3);
 443             sql := sql_update || COALESCE(sql_where1,'') || CASE WHEN sql_where1 <> '' AND sql_where2<> ''  THEN ' AND ' ELSE '' END || COALESCE(sql_where2,'') || CASE WHEN sql_where2 <> '' AND sql_where3 <> '' THEN ' AND ' ELSE '' END || COALESCE(sql_where3,'') || ';';
 444             --RAISE INFO 'sql = %', sql;
 445             PERFORM migration_tools.exec( $1, sql );
 446         END LOOP;
 447         PERFORM migration_tools.exec( $1, 'UPDATE ' || patron_table || ' AS u SET profile = ' || quote_literal(default_patron_profile) || ' WHERE profile IS NULL;'  );
 448         BEGIN
 449             PERFORM migration_tools.exec( $1, 'INSERT INTO ' || migration_schema || '.config (key,value) VALUES ( ''last_base_patron_mapping_profile'', now() );' );
 450         EXCEPTION
 451             WHEN OTHERS THEN PERFORM migration_tools.exec( $1, 'UPDATE ' || migration_schema || '.config SET value = now() WHERE key = ''last_base_patron_mapping_profile'';' );
 452         END;
 453     END;
 454 $$ LANGUAGE PLPGSQL STRICT STABLE;
 455
 456 CREATE OR REPLACE FUNCTION migration_tools.map_base_item_table_dynamic (TEXT,TEXT) RETURNS VOID AS $$
 457     DECLARE
 458         migration_schema ALIAS FOR $1;
 459         field_map TEXT;
 460         item_table ALIAS FOR $2;
 461         sql TEXT;
 462         sql_update TEXT;
 463         sql_where1 TEXT := '';
 464         sql_where2 TEXT := '';
 465         sql_where3 TEXT := '';
 466         output RECORD;
 467     BEGIN
 468         SELECT migration_tools.base_item_dynamic_field_map(migration_schema) INTO STRICT field_map;
 469         FOR output IN
 470             EXECUTE 'SELECT * FROM ' || field_map || E' ORDER BY id;'
 471         LOOP
 472             sql_update := 'UPDATE ' || item_table || ' AS i SET ' || output.evergreen_field || E' = ' || quote_literal(output.evergreen_value) || '::' || output.evergreen_datatype || E' FROM ' || field_map || ' AS m WHERE ';
 473             sql_where1 := NULLIF(output.legacy_field1,'') || ' = ' || quote_literal( output.legacy_value1 ) || ' AND legacy_field1 = ' || quote_literal(output.legacy_field1) || ' AND legacy_value1 = ' || quote_literal(output.legacy_value1);
 474             sql_where2 := NULLIF(output.legacy_field2,'') || ' = ' || quote_literal( output.legacy_value2 ) || ' AND legacy_field2 = ' || quote_literal(output.legacy_field2) || ' AND legacy_value2 = ' || quote_literal(output.legacy_value2);
 475             sql_where3 := NULLIF(output.legacy_field3,'') || ' = ' || quote_literal( output.legacy_value3 ) || ' AND legacy_field3 = ' || quote_literal(output.legacy_field3) || ' AND legacy_value3 = ' || quote_literal(output.legacy_value3);
 476             sql := sql_update || COALESCE(sql_where1,'') || CASE WHEN sql_where1 <> '' AND sql_where2<> ''  THEN ' AND ' ELSE '' END || COALESCE(sql_where2,'') || CASE WHEN sql_where2 <> '' AND sql_where3 <> '' THEN ' AND ' ELSE '' END || COALESCE(sql_where3,'') || ';';
 477             --RAISE INFO 'sql = %', sql;
 478             PERFORM migration_tools.exec( $1, sql );
 479         END LOOP;
 480         BEGIN
 481             PERFORM migration_tools.exec( $1, 'INSERT INTO ' || migration_schema || '.config (key,value) VALUES ( ''last_base_item_mapping_dynamic'', now() );' );
 482         EXCEPTION
 483             WHEN OTHERS THEN PERFORM migration_tools.exec( $1, 'UPDATE ' || migration_schema || '.config SET value = now() WHERE key = ''last_base_item_mapping_dynamic'';' );
 484         END;
 485     END;
 486 $$ LANGUAGE PLPGSQL STRICT VOLATILE;
 487
 488 CREATE OR REPLACE FUNCTION migration_tools.map_base_item_table_locations (TEXT,TEXT) RETURNS VOID AS $$
 489     DECLARE
 490         migration_schema ALIAS FOR $1;
 491         base_copy_location_map TEXT;
 492         item_table ALIAS FOR $2;
 493         sql TEXT;
 494         sql_update TEXT;
 495         sql_where1 TEXT := '';
 496         sql_where2 TEXT := '';
 497         sql_where3 TEXT := '';
 498         output RECORD;
 499     BEGIN
 500         SELECT migration_tools.base_copy_location_map(migration_schema) INTO STRICT base_copy_location_map;
 501         FOR output IN
 502             EXECUTE 'SELECT * FROM ' || base_copy_location_map || E' ORDER BY id;'
 503         LOOP
 504             sql_update := 'UPDATE ' || item_table || ' AS i SET location = m.location FROM ' || base_copy_location_map || ' AS m WHERE ';
 505             sql_where1 := NULLIF(output.legacy_field1,'') || ' = ' || quote_literal( output.legacy_value1 ) || ' AND legacy_field1 = ' || quote_literal(output.legacy_field1) || ' AND legacy_value1 = ' || quote_literal(output.legacy_value1);
 506             sql_where2 := NULLIF(output.legacy_field2,'') || ' = ' || quote_literal( output.legacy_value2 ) || ' AND legacy_field2 = ' || quote_literal(output.legacy_field2) || ' AND legacy_value2 = ' || quote_literal(output.legacy_value2);
 507             sql_where3 := NULLIF(output.legacy_field3,'') || ' = ' || quote_literal( output.legacy_value3 ) || ' AND legacy_field3 = ' || quote_literal(output.legacy_field3) || ' AND legacy_value3 = ' || quote_literal(output.legacy_value3);
 508             sql := sql_update || COALESCE(sql_where1,'') || CASE WHEN sql_where1 <> '' AND sql_where2<> ''  THEN ' AND ' ELSE '' END || COALESCE(sql_where2,'') || CASE WHEN sql_where2 <> '' AND sql_where3 <> '' THEN ' AND ' ELSE '' END || COALESCE(sql_where3,'') || ';';
 509             --RAISE INFO 'sql = %', sql;
 510             PERFORM migration_tools.exec( $1, sql );
 511         END LOOP;
 512         BEGIN
 513             PERFORM migration_tools.exec( $1, 'INSERT INTO ' || migration_schema || '.config (key,value) VALUES ( ''last_base_item_mapping_locations'', now() );' );
 514         EXCEPTION
 515             WHEN OTHERS THEN PERFORM migration_tools.exec( $1, 'UPDATE ' || migration_schema || '.config SET value = now() WHERE key = ''last_base_item_mapping_locations'';' );
 516         END;
 517     END;
 518 $$ LANGUAGE PLPGSQL STRICT VOLATILE;
 519
 520 -- circulate       loan period     max renewals    max out fine amount     fine interval   max fine        item field 1    item value 1    item field 2    item value 2    patron field 1  patron value 1  patron field 2  patron value 2
 521 CREATE OR REPLACE FUNCTION migration_tools.map_base_circ_table_dynamic (TEXT,TEXT,TEXT,TEXT) RETURNS VOID AS $$
 522     DECLARE
 523         migration_schema ALIAS FOR $1;
 524         field_map TEXT;
 525         circ_table ALIAS FOR $2;
 526         item_table ALIAS FOR $3;
 527         patron_table ALIAS FOR $4;
 528         sql TEXT;
 529         sql_update TEXT;
 530         sql_where1 TEXT := '';
 531         sql_where2 TEXT := '';
 532         sql_where3 TEXT := '';
 533         sql_where4 TEXT := '';
 534         output RECORD;
 535     BEGIN
 536         SELECT migration_tools.base_circ_field_map(migration_schema) INTO STRICT field_map;
 537         FOR output IN
 538             EXECUTE 'SELECT * FROM ' || field_map || E' ORDER BY id;'
 539         LOOP
 540             sql_update := 'UPDATE ' || circ_table || ' AS c SET duration = ' || quote_literal(output.loan_period) || '::INTERVAL, renewal_remaining = ' || quote_literal(output.max_renewals) || '::INTEGER, recuring_fine = ' || quote_literal(output.fine_amount) || '::NUMERIC(6,2), fine_interval = ' || quote_literal(output.fine_interval) || '::INTERVAL, max_fine = ' || quote_literal(output.max_fine) || '::NUMERIC(6,2) FROM ' || field_map || ' AS m, ' || item_table || ' AS i, ' || patron_table || ' AS u WHERE c.usr = u.id AND c.target_copy = i.id AND ';
 541             sql_where1 := NULLIF(output.item_field1,'') || ' = ' || quote_literal( output.item_value1 ) || ' AND item_field1 = ' || quote_literal(output.item_field1) || ' AND item_value1 = ' || quote_literal(output.item_value1);
 542             sql_where2 := NULLIF(output.item_field2,'') || ' = ' || quote_literal( output.item_value2 ) || ' AND item_field2 = ' || quote_literal(output.item_field2) || ' AND item_value2 = ' || quote_literal(output.item_value2);
 543             sql_where3 := NULLIF(output.patron_field1,'') || ' = ' || quote_literal( output.patron_value1 ) || ' AND patron_field1 = ' || quote_literal(output.patron_field1) || ' AND patron_value1 = ' || quote_literal(output.patron_value1);
 544             sql_where4 := NULLIF(output.patron_field2,'') || ' = ' || quote_literal( output.patron_value2 ) || ' AND patron_field2 = ' || quote_literal(output.patron_field2) || ' AND patron_value2 = ' || quote_literal(output.patron_value2);
 545             sql := sql_update || COALESCE(sql_where1,'') || CASE WHEN sql_where1 <> '' AND sql_where2<> ''  THEN ' AND ' ELSE '' END || COALESCE(sql_where2,'') || CASE WHEN sql_where2 <> '' AND sql_where3 <> '' THEN ' AND ' ELSE '' END || COALESCE(sql_where3,'') || CASE WHEN sql_where3 <> '' AND sql_where4 <> '' THEN ' AND ' ELSE '' END || COALESCE(sql_where4,'') || ';';
 546             --RAISE INFO 'sql = %', sql;
 547             PERFORM migration_tools.exec( $1, sql );
 548         END LOOP;
 549         BEGIN
 550             PERFORM migration_tools.exec( $1, 'INSERT INTO ' || migration_schema || '.config (key,value) VALUES ( ''last_base_circ_field_mapping'', now() );' );
 551         EXCEPTION
 552             WHEN OTHERS THEN PERFORM migration_tools.exec( $1, 'UPDATE ' || migration_schema || '.config SET value = now() WHERE key = ''last_base_circ_field_mapping'';' );
 553         END;
 554     END;
 555 $$ LANGUAGE PLPGSQL STRICT VOLATILE;
 556
 557 -- expand_barcode
 558 --   $barcode      source barcode
 559 --   $prefix       prefix to add to barcode, NULL = add no prefix
 560 --   $maxlen       maximum length of barcode; default to 14 if left NULL
 561 --   $pad          padding string to apply to left of source barcode before adding
 562 --                 prefix and suffix; set to NULL or '' if no padding is desired
 563 --   $suffix       suffix to add to barcode, NULL = add no suffix
 564 --
 565 -- Returns a new string consisting of prefix concatenated with padded barcode and suffix.
 566 -- If new barcode would be longer than $maxlen, the original barcode is returned instead.
 567 --
 568 CREATE OR REPLACE FUNCTION migration_tools.expand_barcode (TEXT, TEXT, INTEGER, TEXT, TEXT) RETURNS TEXT AS $$
 569     my ($barcode, $prefix, $maxlen, $pad, $suffix) = @_;
 570
 571     # default case
 572     return unless defined $barcode;
 573
 574     $prefix     = '' unless defined $prefix;
 575     $maxlen ||= 14;
 576     $pad        = '0' unless defined $pad;
 577     $suffix     = '' unless defined $suffix;
 578
 579     # bail out if adding prefix and suffix would bring new barcode over max length
 580     return $barcode if (length($prefix) + length($barcode) + length($suffix)) > $maxlen;
 581
 582     my $new_barcode = $barcode;
 583     if ($pad ne '') {
 584         my $pad_length = $maxlen - length($prefix) - length($suffix);
 585         if (length($barcode) < $pad_length) {
 586             # assuming we always want padding on the left
 587             # also assuming that it is possible to have the pad string be longer than 1 character
 588             $new_barcode = substr($pad x ($pad_length - length($barcode)), 0, $pad_length - length($barcode)) . $new_barcode;
 589         }
 590     }
 591
 592     # bail out if adding prefix and suffix would bring new barcode over max length
 593     return $barcode if (length($prefix) + length($new_barcode) + length($suffix)) > $maxlen;
 594
 595     return "$prefix$new_barcode$suffix";
 596 $$ LANGUAGE PLPERL STABLE;
 597
 598 CREATE OR REPLACE FUNCTION migration_tools.attempt_cast (TEXT,TEXT,TEXT) RETURNS RECORD AS $$
 599     DECLARE
 600         attempt_value ALIAS FOR $1;
 601         datatype ALIAS FOR $2;
 602         fail_value ALIAS FOR $3;
 603         output RECORD;
 604     BEGIN
 605         FOR output IN
 606             EXECUTE 'SELECT ' || quote_literal(attempt_value) || '::' || datatype || ' AS a;'
 607         LOOP
 608             RETURN output;
 609         END LOOP;
 610     EXCEPTION
 611         WHEN OTHERS THEN
 612             FOR output IN
 613                 EXECUTE 'SELECT ' || quote_literal(fail_value) || '::' || datatype || ' AS a;'
 614             LOOP
 615                 RETURN output;
 616             END LOOP;
 617     END;
 618 $$ LANGUAGE PLPGSQL STRICT STABLE;
 619
 620 CREATE OR REPLACE FUNCTION migration_tools.attempt_date (TEXT,TEXT) RETURNS DATE AS $$
 621     DECLARE
 622         attempt_value ALIAS FOR $1;
 623         fail_value ALIAS FOR $2;
 624         output DATE;
 625     BEGIN
 626         FOR output IN
 627             EXECUTE 'SELECT ' || quote_literal(attempt_value) || '::date AS a;'
 628         LOOP
 629             RETURN output;
 630         END LOOP;
 631     EXCEPTION
 632         WHEN OTHERS THEN
 633             FOR output IN
 634                 EXECUTE 'SELECT ' || quote_literal(fail_value) || '::date AS a;'
 635             LOOP
 636                 RETURN output;
 637             END LOOP;
 638     END;
 639 $$ LANGUAGE PLPGSQL STRICT STABLE;
 640