Open-ILS/src/sql/Pg/110.hold_matrix.sql

   1 /*
   2
   3 -- If, for some reason, you need to reload this chunk of the schema
   4 -- just use the following two statements to remove the tables before
   5 -- running the rest of the file.  See 950.data.seed-values.sql for
   6 -- the one default entry to add back to config.hold_matrix_matchpoint.
   7
   8 DROP TABLE config.hold_matrix_matchpoint CASCADE;
   9 DROP TABLE config.hold_matrix_test CASCADE;
  10
  11 */
  12
  13 BEGIN;
  14
  15
  16 --
  17 --                 ****** Which ruleset and tests to use *******
  18 --
  19 -- * Most specific range for org_unit and grp wins.
  20 --
  21 -- * circ_modifier match takes precidence over marc_type match, if circ_modifier is set here
  22 --
  23 -- * marc_type is first checked against the circ_as_type from the copy, then the item type from the marc record
  24 --
  25 -- * If neither circ_modifier nor marc_type is set (both are NULLABLE) then the entry defines the default
  26 --   ruleset and tests for the OU + group (like BOOK in PINES)
  27 --
  28
  29
  30
  31 CREATE TABLE config.hold_matrix_matchpoint (
  32     id                      SERIAL    PRIMARY KEY,
  33     active                  BOOL    NOT NULL DEFAULT TRUE,
  34     strict_ou_match         BOOL    NOT NULL DEFAULT FALSE,
  35     user_home_ou            INT        REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,    -- Set to the top OU for the matchpoint applicability range; we can use org_unit_prox to choose the "best"
  36     request_ou              INT        REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,    -- Set to the top OU for the matchpoint applicability range; we can use org_unit_prox to choose the "best"
  37     pickup_ou               INT        REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,    -- Set to the top OU for the matchpoint applicability range; we can use org_unit_prox to choose the "best"
  38     item_owning_ou          INT        REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,    -- Set to the top OU for the matchpoint applicability range; we can use org_unit_prox to choose the "best"
  39     item_circ_ou            INT        REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,    -- Set to the top OU for the matchpoint applicability range; we can use org_unit_prox to choose the "best"
  40     usr_grp                 INT        REFERENCES permission.grp_tree (id) DEFERRABLE INITIALLY DEFERRED,    -- Set to the top applicable group from the group tree; will need descendents and prox functions for filtering
  41     requestor_grp           INT        NOT NULL REFERENCES permission.grp_tree (id) DEFERRABLE INITIALLY DEFERRED,    -- Set to the top applicable group from the group tree; will need descendents and prox functions for filtering
  42     circ_modifier           TEXT    REFERENCES config.circ_modifier (code) DEFERRABLE INITIALLY DEFERRED,
  43     marc_type               TEXT    REFERENCES config.item_type_map (code) DEFERRABLE INITIALLY DEFERRED,
  44     marc_form               TEXT    REFERENCES config.item_form_map (code) DEFERRABLE INITIALLY DEFERRED,
  45     marc_vr_format          TEXT    REFERENCES config.videorecording_format_map (code) DEFERRABLE INITIALLY DEFERRED,
  46     juvenile_flag           BOOL,
  47     ref_flag                BOOL,
  48     holdable                BOOL    NOT NULL DEFAULT TRUE,                -- Hard "can't hold" flag requiring an override
  49     distance_is_from_owner  BOOL    NOT NULL DEFAULT FALSE,                -- How to calculate transit_range.  True means owning lib, false means copy circ lib
  50     transit_range           INT        REFERENCES actor.org_unit_type (id) DEFERRABLE INITIALLY DEFERRED,        -- Can circ inside range of cn.owner/cp.circ_lib at depth of the org_unit_type specified here
  51     max_holds               INT,                            -- Total hold requests must be less than this, NULL means skip (always pass)
  52     include_frozen_holds    BOOL    NOT NULL DEFAULT TRUE,                -- Include frozen hold requests in the count for max_holds test
  53     stop_blocked_user       BOOL    NOT NULL DEFAULT FALSE,                -- Stop users who cannot check out items from placing holds
  54     age_hold_protect_rule   INT        REFERENCES config.rule_age_hold_protect (id) DEFERRABLE INITIALLY DEFERRED,    -- still not sure we want to move this off the copy
  55     CONSTRAINT hous_once_per_grp_loc_mod_marc UNIQUE (user_home_ou, request_ou, pickup_ou, item_owning_ou, item_circ_ou, requestor_grp, usr_grp, circ_modifier, marc_type, marc_form, marc_vr_format, ref_flag, juvenile_flag)
  56 );
  57
  58 CREATE OR REPLACE FUNCTION action.find_hold_matrix_matchpoint( pickup_ou INT, request_ou INT, match_item BIGINT, match_user INT, match_requestor INT ) RETURNS INT AS $func$
  59 DECLARE
  60     current_requestor_group    permission.grp_tree%ROWTYPE;
  61     requestor_object    actor.usr%ROWTYPE;
  62     user_object        actor.usr%ROWTYPE;
  63     item_object        asset.copy%ROWTYPE;
  64     item_cn_object        asset.call_number%ROWTYPE;
  65     rec_descriptor        metabib.rec_descriptor%ROWTYPE;
  66     current_mp_weight    FLOAT;
  67     matchpoint_weight    FLOAT;
  68     tmp_weight        FLOAT;
  69     current_mp        config.hold_matrix_matchpoint%ROWTYPE;
  70     matchpoint        config.hold_matrix_matchpoint%ROWTYPE;
  71 BEGIN
  72     SELECT INTO user_object * FROM actor.usr WHERE id = match_user;
  73     SELECT INTO requestor_object * FROM actor.usr WHERE id = match_requestor;
  74     SELECT INTO item_object * FROM asset.copy WHERE id = match_item;
  75     SELECT INTO item_cn_object * FROM asset.call_number WHERE id = item_object.call_number;
  76     SELECT INTO rec_descriptor r.* FROM metabib.rec_descriptor r WHERE r.record = item_cn_object.record;
  77
  78     PERFORM * FROM config.internal_flag WHERE name = 'circ.holds.usr_not_requestor' AND enabled;
  79
  80     IF NOT FOUND THEN
  81         SELECT INTO current_requestor_group * FROM permission.grp_tree WHERE id = requestor_object.profile;
  82     ELSE
  83         SELECT INTO current_requestor_group * FROM permission.grp_tree WHERE id = user_object.profile;
  84     END IF;
  85
  86     LOOP
  87         -- for each potential matchpoint for this ou and group ...
  88         FOR current_mp IN
  89             SELECT    m.*
  90               FROM    config.hold_matrix_matchpoint m
  91               WHERE    m.requestor_grp = current_requestor_group.id AND m.active
  92               ORDER BY    CASE WHEN m.circ_modifier    IS NOT NULL THEN 16 ELSE 0 END +
  93                     CASE WHEN m.juvenile_flag    IS NOT NULL THEN 16 ELSE 0 END +
  94                     CASE WHEN m.marc_type        IS NOT NULL THEN 8 ELSE 0 END +
  95                     CASE WHEN m.marc_form        IS NOT NULL THEN 4 ELSE 0 END +
  96                     CASE WHEN m.marc_vr_format    IS NOT NULL THEN 2 ELSE 0 END +
  97                     CASE WHEN m.ref_flag        IS NOT NULL THEN 1 ELSE 0 END DESC LOOP
  98
  99             IF NOT current_mp.strict_ou_match THEN
 100                 current_mp_weight := 5.0;
 101             ELSE
 102                 current_mp_weight := 0.0;
 103             END IF;
 104
 105             IF current_mp.circ_modifier IS NOT NULL THEN
 106                 CONTINUE WHEN current_mp.circ_modifier <> item_object.circ_modifier OR item_object.circ_modifier IS NULL;
 107             END IF;
 108
 109             IF current_mp.marc_type IS NOT NULL THEN
 110                 IF item_object.circ_as_type IS NOT NULL THEN
 111                     CONTINUE WHEN current_mp.marc_type <> item_object.circ_as_type;
 112                 ELSE
 113                     CONTINUE WHEN current_mp.marc_type <> rec_descriptor.item_type;
 114                 END IF;
 115             END IF;
 116
 117             IF current_mp.marc_form IS NOT NULL THEN
 118                 CONTINUE WHEN current_mp.marc_form <> rec_descriptor.item_form;
 119             END IF;
 120
 121             IF current_mp.marc_vr_format IS NOT NULL THEN
 122                 CONTINUE WHEN current_mp.marc_vr_format <> rec_descriptor.vr_format;
 123             END IF;
 124
 125             IF current_mp.juvenile_flag IS NOT NULL THEN
 126                 CONTINUE WHEN current_mp.juvenile_flag <> user_object.juvenile;
 127             END IF;
 128
 129             IF current_mp.ref_flag IS NOT NULL THEN
 130                 CONTINUE WHEN current_mp.ref_flag <> item_object.ref;
 131             END IF;
 132
 133
 134             -- caclulate the rule match weight
 135             IF current_mp.item_owning_ou IS NOT NULL THEN
 136                 IF NOT current_mp.strict_ou_match THEN
 137                     SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.item_owning_ou, item_cn_object.owning_lib)::FLOAT + 1.0)::FLOAT;
 138                 ELSE
 139                     tmp_weight := CASE WHEN current_mp.item_owning_ou = item_cn_object.owning_lib THEN 1.0 ELSE 0.0 END;
 140                 END IF;
 141                 current_mp_weight := current_mp_weight - tmp_weight;
 142             END IF;
 143
 144             IF current_mp.item_circ_ou IS NOT NULL THEN
 145                 IF NOT current_mp.strict_ou_match THEN
 146                     SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.item_circ_ou, item_object.circ_lib)::FLOAT + 1.0)::FLOAT;
 147                 ELSE
 148                     tmp_weight := CASE WHEN current_mp.item_circ_ou = item_object.circ_lib THEN 1.0 ELSE 0.0 END;
 149                 END IF;
 150                 current_mp_weight := current_mp_weight - tmp_weight;
 151             END IF;
 152
 153             IF current_mp.pickup_ou IS NOT NULL THEN
 154                 IF NOT current_mp.strict_ou_match THEN
 155                     SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.pickup_ou, pickup_ou)::FLOAT + 1.0)::FLOAT;
 156                 ELSE
 157                     tmp_weight := CASE WHEN current_mp.pickup_ou = pickiup_ou THEN 1.0 ELSE 0.0 END;
 158                 END IF;
 159                 current_mp_weight := current_mp_weight - tmp_weight;
 160             END IF;
 161
 162             IF current_mp.request_ou IS NOT NULL THEN
 163                 IF NOT current_mp.strict_ou_match THEN
 164                     SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.request_ou, request_ou)::FLOAT + 1.0)::FLOAT;
 165                 ELSE
 166                     tmp_weight := CASE WHEN current_mp.request_ou = request_ou THEN 1.0 ELSE 0.0 END;
 167                 END IF;
 168                 current_mp_weight := current_mp_weight - tmp_weight;
 169             END IF;
 170
 171             IF current_mp.user_home_ou IS NOT NULL THEN
 172                 IF NOT current_mp.strict_ou_match THEN
 173                     SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.user_home_ou, user_object.home_ou)::FLOAT + 1.0)::FLOAT;
 174                 ELSE
 175                     tmp_weight := CASE WHEN current_mp.user_home_ou = user_object.home_lib THEN 1.0 ELSE 0.0 END;
 176                 END IF;
 177                 current_mp_weight := current_mp_weight - tmp_weight;
 178             END IF;
 179
 180             -- set the matchpoint if we found the best one
 181             IF matchpoint_weight IS NULL OR matchpoint_weight > current_mp_weight THEN
 182                 matchpoint = current_mp;
 183                 matchpoint_weight = current_mp_weight;
 184             END IF;
 185
 186         END LOOP;
 187
 188         EXIT WHEN current_requestor_group.parent IS NULL OR matchpoint.id IS NOT NULL;
 189
 190         SELECT INTO current_requestor_group * FROM permission.grp_tree WHERE id = current_requestor_group.parent;
 191     END LOOP;
 192
 193     RETURN matchpoint.id;
 194 END;
 195 $func$ LANGUAGE plpgsql;
 196
 197
 198 CREATE OR REPLACE FUNCTION action.hold_request_permit_test( pickup_ou INT, request_ou INT, match_item BIGINT, match_user INT, match_requestor INT, retargetting BOOL ) RETURNS SETOF action.matrix_test_result AS $func$
 199 DECLARE
 200     matchpoint_id        INT;
 201     user_object        actor.usr%ROWTYPE;
 202     age_protect_object    config.rule_age_hold_protect%ROWTYPE;
 203     standing_penalty    config.standing_penalty%ROWTYPE;
 204     transit_range_ou_type    actor.org_unit_type%ROWTYPE;
 205     transit_source        actor.org_unit%ROWTYPE;
 206     item_object        asset.copy%ROWTYPE;
 207     ou_skip              actor.org_unit_setting%ROWTYPE;
 208     result            action.matrix_test_result;
 209     hold_test        config.hold_matrix_matchpoint%ROWTYPE;
 210     hold_count        INT;
 211     hold_transit_prox    INT;
 212     frozen_hold_count    INT;
 213     context_org_list    INT[];
 214     done            BOOL := FALSE;
 215 BEGIN
 216     SELECT INTO user_object * FROM actor.usr WHERE id = match_user;
 217     SELECT INTO context_org_list ARRAY_ACCUM(id) FROM actor.org_unit_full_path( pickup_ou );
 218
 219     result.success := TRUE;
 220
 221     -- Fail if we couldn't find a user
 222     IF user_object.id IS NULL THEN
 223         result.fail_part := 'no_user';
 224         result.success := FALSE;
 225         done := TRUE;
 226         RETURN NEXT result;
 227         RETURN;
 228     END IF;
 229
 230     SELECT INTO item_object * FROM asset.copy WHERE id = match_item;
 231
 232     -- Fail if we couldn't find a copy
 233     IF item_object.id IS NULL THEN
 234         result.fail_part := 'no_item';
 235         result.success := FALSE;
 236         done := TRUE;
 237         RETURN NEXT result;
 238         RETURN;
 239     END IF;
 240
 241     SELECT INTO matchpoint_id action.find_hold_matrix_matchpoint(pickup_ou, request_ou, match_item, match_user, match_requestor);
 242     result.matchpoint := matchpoint_id;
 243
 244     SELECT INTO ou_skip * FROM actor.org_unit_setting WHERE name = 'circ.holds.target_skip_me' AND org_unit = item_object.circ_lib;
 245
 246     -- Fail if the circ_lib for the item has circ.holds.target_skip_me set to true
 247     IF ou_skip.id IS NOT NULL AND ou_skip.value = 'true' THEN
 248         result.fail_part := 'circ.holds.target_skip_me';
 249         result.success := FALSE;
 250         done := TRUE;
 251         RETURN NEXT result;
 252         RETURN;
 253     END IF;
 254
 255     -- Fail if user is barred
 256     IF user_object.barred IS TRUE THEN
 257         result.fail_part := 'actor.usr.barred';
 258         result.success := FALSE;
 259         done := TRUE;
 260         RETURN NEXT result;
 261         RETURN;
 262     END IF;
 263
 264     -- Fail if we couldn't find any matchpoint (requires a default)
 265     IF matchpoint_id IS NULL THEN
 266         result.fail_part := 'no_matchpoint';
 267         result.success := FALSE;
 268         done := TRUE;
 269         RETURN NEXT result;
 270         RETURN;
 271     END IF;
 272
 273     SELECT INTO hold_test * FROM config.hold_matrix_matchpoint WHERE id = matchpoint_id;
 274
 275     IF hold_test.holdable IS FALSE THEN
 276         result.fail_part := 'config.hold_matrix_test.holdable';
 277         result.success := FALSE;
 278         done := TRUE;
 279         RETURN NEXT result;
 280     END IF;
 281
 282     IF hold_test.transit_range IS NOT NULL THEN
 283         SELECT INTO transit_range_ou_type * FROM actor.org_unit_type WHERE id = hold_test.transit_range;
 284         IF hold_test.distance_is_from_owner THEN
 285             SELECT INTO transit_source ou.* FROM actor.org_unit ou JOIN asset.call_number cn ON (cn.owning_lib = ou.id) WHERE cn.id = item_object.call_number;
 286         ELSE
 287             SELECT INTO transit_source * FROM actor.org_unit WHERE id = item_object.circ_lib;
 288         END IF;
 289
 290         PERFORM * FROM actor.org_unit_descendants( transit_source.id, transit_range_ou_type.depth ) WHERE id = pickup_ou;
 291
 292         IF NOT FOUND THEN
 293             result.fail_part := 'transit_range';
 294             result.success := FALSE;
 295             done := TRUE;
 296             RETURN NEXT result;
 297         END IF;
 298     END IF;
 299
 300     FOR standing_penalty IN
 301         SELECT  DISTINCT csp.*
 302           FROM  actor.usr_standing_penalty usp
 303                 JOIN config.standing_penalty csp ON (csp.id = usp.standing_penalty)
 304           WHERE usr = match_user
 305                 AND usp.org_unit IN ( SELECT * FROM explode_array(context_org_list) )
 306                 AND (usp.stop_date IS NULL or usp.stop_date > NOW())
 307                 AND csp.block_list LIKE '%HOLD%' LOOP
 308
 309         result.fail_part := standing_penalty.name;
 310         result.success := FALSE;
 311         done := TRUE;
 312         RETURN NEXT result;
 313     END LOOP;
 314
 315     IF hold_test.stop_blocked_user IS TRUE THEN
 316         FOR standing_penalty IN
 317             SELECT  DISTINCT csp.*
 318               FROM  actor.usr_standing_penalty usp
 319                     JOIN config.standing_penalty csp ON (csp.id = usp.standing_penalty)
 320               WHERE usr = match_user
 321                     AND usp.org_unit IN ( SELECT * FROM explode_array(context_org_list) )
 322                     AND (usp.stop_date IS NULL or usp.stop_date > NOW())
 323                     AND csp.block_list LIKE '%CIRC%' LOOP
 324
 325             result.fail_part := standing_penalty.name;
 326             result.success := FALSE;
 327             done := TRUE;
 328             RETURN NEXT result;
 329         END LOOP;
 330     END IF;
 331
 332     IF hold_test.max_holds IS NOT NULL AND NOT retargetting THEN
 333         SELECT    INTO hold_count COUNT(*)
 334           FROM    action.hold_request
 335           WHERE    usr = match_user
 336             AND fulfillment_time IS NULL
 337             AND cancel_time IS NULL
 338             AND CASE WHEN hold_test.include_frozen_holds THEN TRUE ELSE frozen IS FALSE END;
 339
 340         IF hold_count >= hold_test.max_holds THEN
 341             result.fail_part := 'config.hold_matrix_test.max_holds';
 342             result.success := FALSE;
 343             done := TRUE;
 344             RETURN NEXT result;
 345         END IF;
 346     END IF;
 347
 348     IF item_object.age_protect IS NOT NULL THEN
 349         SELECT INTO age_protect_object * FROM config.rule_age_hold_protect WHERE id = item_object.age_protect;
 350
 351         IF item_object.create_date + age_protect_object.age > NOW() THEN
 352             IF hold_test.distance_is_from_owner THEN
 353                 SELECT INTO hold_transit_prox prox FROM actor.org_unit_proximity WHERE from_org = item_cn_object.owning_lib AND to_org = pickup_ou;
 354             ELSE
 355                 SELECT INTO hold_transit_prox prox FROM actor.org_unit_proximity WHERE from_org = item_object.circ_lib AND to_org = pickup_ou;
 356             END IF;
 357
 358             IF hold_transit_prox > age_protect_object.prox THEN
 359                 result.fail_part := 'config.rule_age_hold_protect.prox';
 360                 result.success := FALSE;
 361                 done := TRUE;
 362                 RETURN NEXT result;
 363             END IF;
 364         END IF;
 365     END IF;
 366
 367     IF NOT done THEN
 368         RETURN NEXT result;
 369     END IF;
 370
 371     RETURN;
 372 END;
 373 $func$ LANGUAGE plpgsql;
 374
 375 CREATE OR REPLACE FUNCTION action.hold_request_permit_test( pickup_ou INT, request_ou INT, match_item BIGINT, match_user INT, match_requestor INT ) RETURNS SETOF action.matrix_test_result AS $func$
 376     SELECT * FROM action.hold_request_permit_test(pickup_ou, request_ou, match_item, match_user, match_requestor, FALSE);
 377 $func$ LANGUAGE SQL;
 378
 379 CREATE OR REPLACE FUNCTION action.hold_retarget_permit_test( pickup_ou INT, request_ou INT, match_item BIGINT, match_user INT, match_requestor INT ) RETURNS SETOF action.matrix_test_result AS $func$
 380     SELECT * FROM action.hold_request_permit_test(pickup_ou, request_ou, match_item, match_user, match_requestor, TRUE);
 381 $func$ LANGUAGE SQL;
 382
 383 COMMIT;
 384