Open-ILS/src/sql/Pg/upgrade/XXXX.function.located_uris_act_as_copies.sql

   1 /*
   2  * Copyright (C) 2014  Equinox Software, Inc.
   3  * Mike Rylander <miker@esilibrary.com>
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  */
  16
  17
  18 BEGIN;
  19
  20 INSERT INTO config.global_flag (name, enabled, label)
  21 VALUES (
  22     'opac.located_uri.act_as_copy',
  23     FALSE,
  24     oils_i18n_gettext(
  25         'opac.located_uri.act_as_copy',
  26         'When enabled, Located URIs will provide visiblity behavior identical to copies.',
  27         'cgf',
  28         'label'
  29     )
  30 );
  31
  32 CREATE OR REPLACE FUNCTION evergreen.located_uris (
  33     bibid BIGINT,
  34     ouid INT,
  35     pref_lib INT DEFAULT NULL
  36 ) RETURNS TABLE (id BIGINT, name TEXT, label_sortkey TEXT, rank INT) AS $$
  37     WITH all_orgs AS (SELECT COALESCE( enabled, FALSE ) AS flag FROM config.global_flag WHERE name = 'opac.located_uri.act_as_copy')
  38     SELECT DISTINCT ON (id) * FROM (
  39     SELECT acn.id, COALESCE(aou.name,aoud.name), acn.label_sortkey, evergreen.rank_ou(aou.id, $2, $3) AS pref_ou
  40       FROM asset.call_number acn
  41            INNER JOIN asset.uri_call_number_map auricnm ON acn.id = auricnm.call_number
  42            INNER JOIN asset.uri auri ON auri.id = auricnm.uri
  43            LEFT JOIN actor.org_unit_ancestors( COALESCE($3, $2) ) aou ON (acn.owning_lib = aou.id)
  44            LEFT JOIN actor.org_unit_descendants( COALESCE($3, $2) ) aoud ON (acn.owning_lib = aoud.id),
  45            all_orgs
  46       WHERE acn.record = $1
  47           AND acn.deleted IS FALSE
  48           AND auri.active IS TRUE
  49           AND ((NOT all_orgs.flag AND aou.id IS NOT NULL) OR COALESCE(aou.id,aoud.id) IS NOT NULL)
  50     UNION
  51     SELECT acn.id, COALESCE(aou.name,aoud.name) AS name, acn.label_sortkey, evergreen.rank_ou(aou.id, $2, $3) AS pref_ou
  52       FROM asset.call_number acn
  53            INNER JOIN asset.uri_call_number_map auricnm ON acn.id = auricnm.call_number
  54            INNER JOIN asset.uri auri ON auri.id = auricnm.uri
  55            LEFT JOIN actor.org_unit_ancestors( $2 ) aou ON (acn.owning_lib = aou.id)
  56            LEFT JOIN actor.org_unit_descendants( $2 ) aoud ON (acn.owning_lib = aoud.id),
  57            all_orgs
  58       WHERE acn.record = $1
  59           AND acn.deleted IS FALSE
  60           AND auri.active IS TRUE
  61           AND ((NOT all_orgs.flag AND aou.id IS NOT NULL) OR COALESCE(aou.id,aoud.id) IS NOT NULL))x
  62     ORDER BY id, pref_ou DESC;
  63 $$
  64 LANGUAGE SQL STABLE;
  65
  66 CREATE OR REPLACE FUNCTION search.query_parser_fts (
  67
  68     param_search_ou INT,
  69     param_depth     INT,
  70     param_query     TEXT,
  71     param_statuses  INT[],
  72     param_locations INT[],
  73     param_offset    INT,
  74     param_check     INT,
  75     param_limit     INT,
  76     metarecord      BOOL,
  77     staff           BOOL,
  78     deleted_search  BOOL,
  79     param_pref_ou   INT DEFAULT NULL
  80 ) RETURNS SETOF search.search_result AS $func$
  81 DECLARE
  82
  83     current_res         search.search_result%ROWTYPE;
  84     search_org_list     INT[];
  85     luri_org_list       INT[];
  86     tmp_int_list        INT[];
  87
  88     check_limit         INT;
  89     core_limit          INT;
  90     core_offset         INT;
  91     tmp_int             INT;
  92
  93     core_result         RECORD;
  94     core_cursor         REFCURSOR;
  95     core_rel_query      TEXT;
  96
  97     total_count         INT := 0;
  98     check_count         INT := 0;
  99     deleted_count       INT := 0;
 100     visible_count       INT := 0;
 101     excluded_count      INT := 0;
 102
 103     luri_as_copy        BOOL;
 104 BEGIN
 105
 106     check_limit := COALESCE( param_check, 1000 );
 107     core_limit  := COALESCE( param_limit, 25000 );
 108     core_offset := COALESCE( param_offset, 0 );
 109
 110     SELECT COALESCE( enabled, FALSE ) INTO luri_as_copy FROM config.global_flag WHERE name = 'opac.located_uri.act_as_copy';
 111
 112     -- core_skip_chk := COALESCE( param_skip_chk, 1 );
 113
 114     IF param_search_ou > 0 THEN
 115         IF param_depth IS NOT NULL THEN
 116             SELECT array_accum(distinct id) INTO search_org_list FROM actor.org_unit_descendants( param_search_ou, param_depth );
 117         ELSE
 118             SELECT array_accum(distinct id) INTO search_org_list FROM actor.org_unit_descendants( param_search_ou );
 119         END IF;
 120
 121         IF luri_as_copy THEN
 122             SELECT array_accum(distinct id) INTO luri_org_list FROM actor.org_unit_full_path( param_search_ou );
 123         ELSE
 124             SELECT array_accum(distinct id) INTO luri_org_list FROM actor.org_unit_ancestors( param_search_ou );
 125         END IF;
 126
 127     ELSIF param_search_ou < 0 THEN
 128         SELECT array_accum(distinct org_unit) INTO search_org_list FROM actor.org_lasso_map WHERE lasso = -param_search_ou;
 129
 130         FOR tmp_int IN SELECT * FROM UNNEST(search_org_list) LOOP
 131
 132             IF luri_as_copy THEN
 133                 SELECT array_accum(distinct id) INTO tmp_int_list FROM actor.org_unit_full_path( tmp_int );
 134             ELSE
 135                 SELECT array_accum(distinct id) INTO tmp_int_list FROM actor.org_unit_ancestors( tmp_int );
 136             END IF;
 137
 138             luri_org_list := luri_org_list || tmp_int_list;
 139         END LOOP;
 140
 141         SELECT array_accum(DISTINCT x.id) INTO luri_org_list FROM UNNEST(luri_org_list) x(id);
 142
 143     ELSIF param_search_ou = 0 THEN
 144         -- reserved for user lassos (ou_buckets/type='lasso') with ID passed in depth ... hack? sure.
 145     END IF;
 146
 147     IF param_pref_ou IS NOT NULL THEN
 148             IF luri_as_copy THEN
 149                 SELECT array_accum(distinct id) INTO tmp_int_list FROM actor.org_unit_full_path( param_pref_ou );
 150             ELSE
 151                 SELECT array_accum(distinct id) INTO tmp_int_list FROM actor.org_unit_ancestors( param_pref_ou );
 152             END IF;
 153
 154         luri_org_list := luri_org_list || tmp_int_list;
 155     END IF;
 156
 157     OPEN core_cursor FOR EXECUTE param_query;
 158
 159     LOOP
 160
 161         FETCH core_cursor INTO core_result;
 162         EXIT WHEN NOT FOUND;
 163         EXIT WHEN total_count >= core_limit;
 164
 165         total_count := total_count + 1;
 166
 167         CONTINUE WHEN total_count NOT BETWEEN  core_offset + 1 AND check_limit + core_offset;
 168
 169         check_count := check_count + 1;
 170
 171         IF NOT deleted_search THEN
 172
 173             PERFORM 1 FROM biblio.record_entry b WHERE NOT b.deleted AND b.id IN ( SELECT * FROM unnest( core_result.records ) );
 174             IF NOT FOUND THEN
 175                 -- RAISE NOTICE ' % were all deleted ... ', core_result.records;
 176                 deleted_count := deleted_count + 1;
 177                 CONTINUE;
 178             END IF;
 179
 180             PERFORM 1
 181               FROM  biblio.record_entry b
 182                     JOIN config.bib_source s ON (b.source = s.id)
 183               WHERE s.transcendant
 184                     AND b.id IN ( SELECT * FROM unnest( core_result.records ) );
 185
 186             IF FOUND THEN
 187                 -- RAISE NOTICE ' % were all transcendant ... ', core_result.records;
 188                 visible_count := visible_count + 1;
 189
 190                 current_res.id = core_result.id;
 191                 current_res.rel = core_result.rel;
 192
 193                 tmp_int := 1;
 194                 IF metarecord THEN
 195                     SELECT COUNT(DISTINCT s.source) INTO tmp_int FROM metabib.metarecord_source_map s WHERE s.metarecord = core_result.id;
 196                 END IF;
 197
 198                 IF tmp_int = 1 THEN
 199                     current_res.record = core_result.records[1];
 200                 ELSE
 201                     current_res.record = NULL;
 202                 END IF;
 203
 204                 RETURN NEXT current_res;
 205
 206                 CONTINUE;
 207             END IF;
 208
 209             PERFORM 1
 210               FROM  asset.call_number cn
 211                     JOIN asset.uri_call_number_map map ON (map.call_number = cn.id)
 212                     JOIN asset.uri uri ON (map.uri = uri.id)
 213               WHERE NOT cn.deleted
 214                     AND cn.label = '##URI##'
 215                     AND uri.active
 216                     AND ( param_locations IS NULL OR array_upper(param_locations, 1) IS NULL )
 217                     AND cn.record IN ( SELECT * FROM unnest( core_result.records ) )
 218                     AND cn.owning_lib IN ( SELECT * FROM unnest( luri_org_list ) )
 219               LIMIT 1;
 220
 221             IF FOUND THEN
 222                 -- RAISE NOTICE ' % have at least one URI ... ', core_result.records;
 223                 visible_count := visible_count + 1;
 224
 225                 current_res.id = core_result.id;
 226                 current_res.rel = core_result.rel;
 227
 228                 tmp_int := 1;
 229                 IF metarecord THEN
 230                     SELECT COUNT(DISTINCT s.source) INTO tmp_int FROM metabib.metarecord_source_map s WHERE s.metarecord = core_result.id;
 231                 END IF;
 232
 233                 IF tmp_int = 1 THEN
 234                     current_res.record = core_result.records[1];
 235                 ELSE
 236                     current_res.record = NULL;
 237                 END IF;
 238
 239                 RETURN NEXT current_res;
 240
 241                 CONTINUE;
 242             END IF;
 243
 244             IF param_statuses IS NOT NULL AND array_upper(param_statuses, 1) > 0 THEN
 245
 246                 PERFORM 1
 247                   FROM  asset.call_number cn
 248                         JOIN asset.copy cp ON (cp.call_number = cn.id)
 249                   WHERE NOT cn.deleted
 250                         AND NOT cp.deleted
 251                         AND cp.status IN ( SELECT * FROM unnest( param_statuses ) )
 252                         AND cn.record IN ( SELECT * FROM unnest( core_result.records ) )
 253                         AND cp.circ_lib IN ( SELECT * FROM unnest( search_org_list ) )
 254                   LIMIT 1;
 255
 256                 IF NOT FOUND THEN
 257                     PERFORM 1
 258                       FROM  biblio.peer_bib_copy_map pr
 259                             JOIN asset.copy cp ON (cp.id = pr.target_copy)
 260                       WHERE NOT cp.deleted
 261                             AND cp.status IN ( SELECT * FROM unnest( param_statuses ) )
 262                             AND pr.peer_record IN ( SELECT * FROM unnest( core_result.records ) )
 263                             AND cp.circ_lib IN ( SELECT * FROM unnest( search_org_list ) )
 264                       LIMIT 1;
 265
 266                     IF NOT FOUND THEN
 267                     -- RAISE NOTICE ' % and multi-home linked records were all status-excluded ... ', core_result.records;
 268                         excluded_count := excluded_count + 1;
 269                         CONTINUE;
 270                     END IF;
 271                 END IF;
 272
 273             END IF;
 274
 275             IF param_locations IS NOT NULL AND array_upper(param_locations, 1) > 0 THEN
 276
 277                 PERFORM 1
 278                   FROM  asset.call_number cn
 279                         JOIN asset.copy cp ON (cp.call_number = cn.id)
 280                   WHERE NOT cn.deleted
 281                         AND NOT cp.deleted
 282                         AND cp.location IN ( SELECT * FROM unnest( param_locations ) )
 283                         AND cn.record IN ( SELECT * FROM unnest( core_result.records ) )
 284                         AND cp.circ_lib IN ( SELECT * FROM unnest( search_org_list ) )
 285                   LIMIT 1;
 286
 287                 IF NOT FOUND THEN
 288                     PERFORM 1
 289                       FROM  biblio.peer_bib_copy_map pr
 290                             JOIN asset.copy cp ON (cp.id = pr.target_copy)
 291                       WHERE NOT cp.deleted
 292                             AND cp.location IN ( SELECT * FROM unnest( param_locations ) )
 293                             AND pr.peer_record IN ( SELECT * FROM unnest( core_result.records ) )
 294                             AND cp.circ_lib IN ( SELECT * FROM unnest( search_org_list ) )
 295                       LIMIT 1;
 296
 297                     IF NOT FOUND THEN
 298                         -- RAISE NOTICE ' % and multi-home linked records were all copy_location-excluded ... ', core_result.records;
 299                         excluded_count := excluded_count + 1;
 300                         CONTINUE;
 301                     END IF;
 302                 END IF;
 303
 304             END IF;
 305
 306             IF staff IS NULL OR NOT staff THEN
 307
 308                 PERFORM 1
 309                   FROM  asset.opac_visible_copies
 310                   WHERE circ_lib IN ( SELECT * FROM unnest( search_org_list ) )
 311                         AND record IN ( SELECT * FROM unnest( core_result.records ) )
 312                   LIMIT 1;
 313
 314                 IF NOT FOUND THEN
 315                     PERFORM 1
 316                       FROM  biblio.peer_bib_copy_map pr
 317                             JOIN asset.opac_visible_copies cp ON (cp.copy_id = pr.target_copy)
 318                       WHERE cp.circ_lib IN ( SELECT * FROM unnest( search_org_list ) )
 319                             AND pr.peer_record IN ( SELECT * FROM unnest( core_result.records ) )
 320                       LIMIT 1;
 321
 322                     IF NOT FOUND THEN
 323
 324                         -- RAISE NOTICE ' % and multi-home linked records were all visibility-excluded ... ', core_result.records;
 325                         excluded_count := excluded_count + 1;
 326                         CONTINUE;
 327                     END IF;
 328                 END IF;
 329
 330             ELSE
 331
 332                 PERFORM 1
 333                   FROM  asset.call_number cn
 334                         JOIN asset.copy cp ON (cp.call_number = cn.id)
 335                   WHERE NOT cn.deleted
 336                         AND NOT cp.deleted
 337                         AND cp.circ_lib IN ( SELECT * FROM unnest( search_org_list ) )
 338                         AND cn.record IN ( SELECT * FROM unnest( core_result.records ) )
 339                   LIMIT 1;
 340
 341                 IF NOT FOUND THEN
 342
 343                     PERFORM 1
 344                       FROM  biblio.peer_bib_copy_map pr
 345                             JOIN asset.copy cp ON (cp.id = pr.target_copy)
 346                       WHERE NOT cp.deleted
 347                             AND cp.circ_lib IN ( SELECT * FROM unnest( search_org_list ) )
 348                             AND pr.peer_record IN ( SELECT * FROM unnest( core_result.records ) )
 349                       LIMIT 1;
 350
 351                     IF NOT FOUND THEN
 352
 353                         PERFORM 1
 354                           FROM  asset.call_number cn
 355                                 JOIN asset.copy cp ON (cp.call_number = cn.id)
 356                           WHERE cn.record IN ( SELECT * FROM unnest( core_result.records ) )
 357                                 AND NOT cp.deleted
 358                           LIMIT 1;
 359
 360                         IF FOUND THEN
 361                             -- RAISE NOTICE ' % and multi-home linked records were all visibility-excluded ... ', core_result.records;
 362                             excluded_count := excluded_count + 1;
 363                             CONTINUE;
 364                         END IF;
 365                     END IF;
 366
 367                 END IF;
 368
 369             END IF;
 370
 371         END IF;
 372
 373         visible_count := visible_count + 1;
 374
 375         current_res.id = core_result.id;
 376         current_res.rel = core_result.rel;
 377
 378         tmp_int := 1;
 379         IF metarecord THEN
 380             SELECT COUNT(DISTINCT s.source) INTO tmp_int FROM metabib.metarecord_source_map s WHERE s.metarecord = core_result.id;
 381         END IF;
 382
 383         IF tmp_int = 1 THEN
 384             current_res.record = core_result.records[1];
 385         ELSE
 386             current_res.record = NULL;
 387         END IF;
 388
 389         RETURN NEXT current_res;
 390
 391         IF visible_count % 1000 = 0 THEN
 392             -- RAISE NOTICE ' % visible so far ... ', visible_count;
 393         END IF;
 394
 395     END LOOP;
 396
 397     current_res.id = NULL;
 398     current_res.rel = NULL;
 399     current_res.record = NULL;
 400     current_res.total = total_count;
 401     current_res.checked = check_count;
 402     current_res.deleted = deleted_count;
 403     current_res.visible = visible_count;
 404     current_res.excluded = excluded_count;
 405
 406     CLOSE core_cursor;
 407
 408     RETURN NEXT current_res;
 409
 410 END;
 411 $func$ LANGUAGE PLPGSQL;
 412
 413 CREATE OR REPLACE FUNCTION unapi.holdings_xml (
 414     bid BIGINT,
 415     ouid INT,
 416     org TEXT,
 417     depth INT DEFAULT NULL,
 418     includes TEXT[] DEFAULT NULL::TEXT[],
 419     slimit HSTORE DEFAULT NULL,
 420     soffset HSTORE DEFAULT NULL,
 421     include_xmlns BOOL DEFAULT TRUE,
 422     pref_lib INT DEFAULT NULL
 423 )
 424 RETURNS XML AS $F$
 425      SELECT  XMLELEMENT(
 426                  name holdings,
 427                  XMLATTRIBUTES(
 428                     CASE WHEN $8 THEN 'http://open-ils.org/spec/holdings/v1' ELSE NULL END AS xmlns,
 429                     CASE WHEN ('bre' = ANY ($5)) THEN 'tag:open-ils.org:U2@bre/' || $1 || '/' || $3 ELSE NULL END AS id,
 430                     (SELECT record_has_holdable_copy FROM asset.record_has_holdable_copy($1)) AS has_holdable
 431                  ),
 432                  XMLELEMENT(
 433                      name counts,
 434                      (SELECT  XMLAGG(XMLELEMENT::XML) FROM (
 435                          SELECT  XMLELEMENT(
 436                                      name count,
 437                                      XMLATTRIBUTES('public' as type, depth, org_unit, coalesce(transcendant,0) as transcendant, available, visible as count, unshadow)
 438                                  )::text
 439                            FROM  asset.opac_ou_record_copy_count($2,  $1)
 440                                      UNION
 441                          SELECT  XMLELEMENT(
 442                                      name count,
 443                                      XMLATTRIBUTES('staff' as type, depth, org_unit, coalesce(transcendant,0) as transcendant, available, visible as count, unshadow)
 444                                  )::text
 445                            FROM  asset.staff_ou_record_copy_count($2, $1)
 446                                      UNION
 447                          SELECT  XMLELEMENT(
 448                                      name count,
 449                                      XMLATTRIBUTES('pref_lib' as type, depth, org_unit, coalesce(transcendant,0) as transcendant, available, visible as count, unshadow)
 450                                  )::text
 451                            FROM  asset.opac_ou_record_copy_count($9,  $1)
 452                                      ORDER BY 1
 453                      )x)
 454                  ),
 455                  CASE
 456                      WHEN ('bmp' = ANY ($5)) THEN
 457                         XMLELEMENT(
 458                             name monograph_parts,
 459                             (SELECT XMLAGG(bmp) FROM (
 460                                 SELECT  unapi.bmp( id, 'xml', 'monograph_part', evergreen.array_remove_item_by_value( evergreen.array_remove_item_by_value($5,'bre'), 'holdings_xml'), $3, $4, $6, $7, FALSE)
 461                                   FROM  biblio.monograph_part
 462                                   WHERE record = $1
 463                             )x)
 464                         )
 465                      ELSE NULL
 466                  END,
 467                  XMLELEMENT(
 468                      name volumes,
 469                      (SELECT XMLAGG(acn ORDER BY rank, name, label_sortkey) FROM (
 470                         -- Physical copies
 471                         SELECT  unapi.acn(y.id,'xml','volume',evergreen.array_remove_item_by_value( evergreen.array_remove_item_by_value($5,'holdings_xml'),'bre'), $3, $4, $6, $7, FALSE), y.rank, name, label_sortkey
 472                         FROM evergreen.ranked_volumes($1, $2, $4, $6, $7, $9, $5) AS y
 473                         UNION ALL
 474                         -- Located URIs
 475                         SELECT unapi.acn(uris.id,'xml','volume',evergreen.array_remove_item_by_value( evergreen.array_remove_item_by_value($5,'holdings_xml'),'bre'), $3, $4, $6, $7, FALSE), uris.rank, name, label_sortkey
 476                         FROM evergreen.located_uris($1, $2, $9) AS uris
 477                      )x)
 478                  ),
 479                  CASE WHEN ('ssub' = ANY ($5)) THEN
 480                      XMLELEMENT(
 481                          name subscriptions,
 482                          (SELECT XMLAGG(ssub) FROM (
 483                             SELECT  unapi.ssub(id,'xml','subscription','{}'::TEXT[], $3, $4, $6, $7, FALSE)
 484                               FROM  serial.subscription
 485                               WHERE record_entry = $1
 486                         )x)
 487                      )
 488                  ELSE NULL END,
 489                  CASE WHEN ('acp' = ANY ($5)) THEN
 490                      XMLELEMENT(
 491                          name foreign_copies,
 492                          (SELECT XMLAGG(acp) FROM (
 493                             SELECT  unapi.acp(p.target_copy,'xml','copy',evergreen.array_remove_item_by_value($5,'acp'), $3, $4, $6, $7, FALSE)
 494                               FROM  biblio.peer_bib_copy_map p
 495                                     JOIN asset.copy c ON (p.target_copy = c.id)
 496                               WHERE NOT c.deleted AND p.peer_record = $1
 497                             LIMIT ($6 -> 'acp')::INT
 498                             OFFSET ($7 -> 'acp')::INT
 499                         )x)
 500                      )
 501                  ELSE NULL END
 502              );
 503 $F$ LANGUAGE SQL STABLE;
 504
 505 COMMIT;
 506