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             current_mp_weight := 5.0;
 100
 101             IF current_mp.circ_modifier IS NOT NULL THEN
 102                 CONTINUE WHEN current_mp.circ_modifier <> item_object.circ_modifier OR item_object.circ_modifier IS NULL;
 103             END IF;
 104
 105             IF current_mp.marc_type IS NOT NULL THEN
 106                 IF item_object.circ_as_type IS NOT NULL THEN
 107                     CONTINUE WHEN current_mp.marc_type <> item_object.circ_as_type;
 108                 ELSE
 109                     CONTINUE WHEN current_mp.marc_type <> rec_descriptor.item_type;
 110                 END IF;
 111             END IF;
 112
 113             IF current_mp.marc_form IS NOT NULL THEN
 114                 CONTINUE WHEN current_mp.marc_form <> rec_descriptor.item_form;
 115             END IF;
 116
 117             IF current_mp.marc_vr_format IS NOT NULL THEN
 118                 CONTINUE WHEN current_mp.marc_vr_format <> rec_descriptor.vr_format;
 119             END IF;
 120
 121             IF current_mp.juvenile_flag IS NOT NULL THEN
 122                 CONTINUE WHEN current_mp.juvenile_flag <> user_object.juvenile;
 123             END IF;
 124
 125             IF current_mp.ref_flag IS NOT NULL THEN
 126                 CONTINUE WHEN current_mp.ref_flag <> item_object.ref;
 127             END IF;
 128
 129
 130             -- caclulate the rule match weight
 131             IF current_mp.item_owning_ou IS NOT NULL THEN
 132                 IF NOT current_mp.strict_ou_match THEN
 133                     SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.item_owning_ou, item_cn_object.owning_lib)::FLOAT + 1.0)::FLOAT;
 134                 ELSE
 135                     tmp_weight := CASE WHEN current_mp.item_owning_ou = item_cn_object.owning_lib THEN 1.0 ELSE 0.0 END;
 136                 END IF;
 137                 current_mp_weight := current_mp_weight - tmp_weight;
 138             END IF;
 139
 140             IF current_mp.item_circ_ou IS NOT NULL THEN
 141                 IF NOT current_mp.strict_ou_match THEN
 142                     SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.item_circ_ou, item_object.circ_lib)::FLOAT + 1.0)::FLOAT;
 143                 ELSE
 144                     tmp_weight := CASE WHEN current_mp.item_circ_ou = item_object.circ_lib THEN 1.0 ELSE 0.0 END;
 145                 END IF;
 146                 current_mp_weight := current_mp_weight - tmp_weight;
 147             END IF;
 148
 149             IF current_mp.pickup_ou IS NOT NULL THEN
 150                 IF NOT current_mp.strict_ou_match THEN
 151                     SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.pickup_ou, pickup_ou)::FLOAT + 1.0)::FLOAT;
 152                 ELSE
 153                     tmp_weight := CASE WHEN current_mp.pickup_ou = pickiup_ou THEN 1.0 ELSE 0.0 END;
 154                 END IF;
 155                 current_mp_weight := current_mp_weight - tmp_weight;
 156             END IF;
 157
 158             IF current_mp.request_ou IS NOT NULL THEN
 159                 IF NOT current_mp.strict_ou_match THEN
 160                     SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.request_ou, request_ou)::FLOAT + 1.0)::FLOAT;
 161                 ELSE
 162                     tmp_weight := CASE WHEN current_mp.request_ou = request_ou THEN 1.0 ELSE 0.0 END;
 163                 END IF;
 164                 current_mp_weight := current_mp_weight - tmp_weight;
 165             END IF;
 166
 167             IF current_mp.user_home_ou IS NOT NULL THEN
 168                 IF NOT current_mp.strict_ou_match THEN
 169                     SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.user_home_ou, user_object.home_ou)::FLOAT + 1.0)::FLOAT;
 170                 ELSE
 171                     tmp_weight := CASE WHEN current_mp.user_home_ou = user_object.home_lib THEN 1.0 ELSE 0.0 END;
 172                 END IF;
 173                 current_mp_weight := current_mp_weight - tmp_weight;
 174             END IF;
 175
 176             -- set the matchpoint if we found the best one
 177             IF matchpoint_weight IS NULL OR matchpoint_weight > current_mp_weight THEN
 178                 matchpoint = current_mp;
 179                 matchpoint_weight = current_mp_weight;
 180             END IF;
 181
 182         END LOOP;
 183
 184         EXIT WHEN current_requestor_group.parent IS NULL OR matchpoint.id IS NOT NULL;
 185
 186         SELECT INTO current_requestor_group * FROM permission.grp_tree WHERE id = current_requestor_group.parent;
 187     END LOOP;
 188
 189     RETURN matchpoint.id;
 190 END;
 191 $func$ LANGUAGE plpgsql;
 192
 193
 194 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$
 195 DECLARE
 196     matchpoint_id        INT;
 197     user_object        actor.usr%ROWTYPE;
 198     age_protect_object    config.rule_age_hold_protect%ROWTYPE;
 199     standing_penalty    config.standing_penalty%ROWTYPE;
 200     transit_range_ou_type    actor.org_unit_type%ROWTYPE;
 201     transit_source        actor.org_unit%ROWTYPE;
 202     item_object        asset.copy%ROWTYPE;
 203     ou_skip              actor.org_unit_setting%ROWTYPE;
 204     result            action.matrix_test_result;
 205     hold_test        config.hold_matrix_matchpoint%ROWTYPE;
 206     hold_count        INT;
 207     hold_transit_prox    INT;
 208     frozen_hold_count    INT;
 209     context_org_list    INT[];
 210     done            BOOL := FALSE;
 211 BEGIN
 212     SELECT INTO user_object * FROM actor.usr WHERE id = match_user;
 213     SELECT INTO context_org_list ARRAY_ACCUM(id) FROM actor.org_unit_full_path( pickup_ou );
 214
 215     result.success := TRUE;
 216
 217     -- Fail if we couldn't find a user
 218     IF user_object.id IS NULL THEN
 219         result.fail_part := 'no_user';
 220         result.success := FALSE;
 221         done := TRUE;
 222         RETURN NEXT result;
 223         RETURN;
 224     END IF;
 225
 226     SELECT INTO item_object * FROM asset.copy WHERE id = match_item;
 227
 228     -- Fail if we couldn't find a copy
 229     IF item_object.id IS NULL THEN
 230         result.fail_part := 'no_item';
 231         result.success := FALSE;
 232         done := TRUE;
 233         RETURN NEXT result;
 234         RETURN;
 235     END IF;
 236
 237     SELECT INTO matchpoint_id action.find_hold_matrix_matchpoint(pickup_ou, request_ou, match_item, match_user, match_requestor);
 238     result.matchpoint := matchpoint_id;
 239
 240     SELECT INTO ou_skip * FROM actor.org_unit_setting WHERE name = 'circ.holds.target_skip_me' AND org_unit = item_object.circ_lib;
 241
 242     -- Fail if the circ_lib for the item has circ.holds.target_skip_me set to true
 243     IF ou_skip.id IS NOT NULL AND ou_skip.value = 'true' THEN
 244         result.fail_part := 'circ.holds.target_skip_me';
 245         result.success := FALSE;
 246         done := TRUE;
 247         RETURN NEXT result;
 248         RETURN;
 249     END IF;
 250
 251     -- Fail if user is barred
 252     IF user_object.barred IS TRUE THEN
 253         result.fail_part := 'actor.usr.barred';
 254         result.success := FALSE;
 255         done := TRUE;
 256         RETURN NEXT result;
 257         RETURN;
 258     END IF;
 259
 260     -- Fail if we couldn't find any matchpoint (requires a default)
 261     IF matchpoint_id IS NULL THEN
 262         result.fail_part := 'no_matchpoint';
 263         result.success := FALSE;
 264         done := TRUE;
 265         RETURN NEXT result;
 266         RETURN;
 267     END IF;
 268
 269     SELECT INTO hold_test * FROM config.hold_matrix_matchpoint WHERE id = matchpoint_id;
 270
 271     IF hold_test.holdable IS FALSE THEN
 272         result.fail_part := 'config.hold_matrix_test.holdable';
 273         result.success := FALSE;
 274         done := TRUE;
 275         RETURN NEXT result;
 276     END IF;
 277
 278     IF hold_test.transit_range IS NOT NULL THEN
 279         SELECT INTO transit_range_ou_type * FROM actor.org_unit_type WHERE id = hold_test.transit_range;
 280         IF hold_test.distance_is_from_owner THEN
 281             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;
 282         ELSE
 283             SELECT INTO transit_source * FROM actor.org_unit WHERE id = item_object.circ_lib;
 284         END IF;
 285
 286         PERFORM * FROM actor.org_unit_descendants( transit_source.id, transit_range_ou_type.depth ) WHERE id = pickup_ou;
 287
 288         IF NOT FOUND THEN
 289             result.fail_part := 'transit_range';
 290             result.success := FALSE;
 291             done := TRUE;
 292             RETURN NEXT result;
 293         END IF;
 294     END IF;
 295
 296     FOR standing_penalty IN
 297         SELECT  DISTINCT csp.*
 298           FROM  actor.usr_standing_penalty usp
 299                 JOIN config.standing_penalty csp ON (csp.id = usp.standing_penalty)
 300           WHERE usr = match_user
 301                 AND usp.org_unit IN ( SELECT * FROM explode_array(context_org_list) )
 302                 AND (usp.stop_date IS NULL or usp.stop_date > NOW())
 303                 AND csp.block_list LIKE '%HOLD%' LOOP
 304
 305         result.fail_part := standing_penalty.name;
 306         result.success := FALSE;
 307         done := TRUE;
 308         RETURN NEXT result;
 309     END LOOP;
 310
 311     IF hold_test.stop_blocked_user IS TRUE THEN
 312         FOR standing_penalty IN
 313             SELECT  DISTINCT csp.*
 314               FROM  actor.usr_standing_penalty usp
 315                     JOIN config.standing_penalty csp ON (csp.id = usp.standing_penalty)
 316               WHERE usr = match_user
 317                     AND usp.org_unit IN ( SELECT * FROM explode_array(context_org_list) )
 318                     AND (usp.stop_date IS NULL or usp.stop_date > NOW())
 319                     AND csp.block_list LIKE '%CIRC%' LOOP
 320
 321             result.fail_part := standing_penalty.name;
 322             result.success := FALSE;
 323             done := TRUE;
 324             RETURN NEXT result;
 325         END LOOP;
 326     END IF;
 327
 328     IF hold_test.max_holds IS NOT NULL AND NOT retargetting THEN
 329         SELECT    INTO hold_count COUNT(*)
 330           FROM    action.hold_request
 331           WHERE    usr = match_user
 332             AND fulfillment_time IS NULL
 333             AND cancel_time IS NULL
 334             AND CASE WHEN hold_test.include_frozen_holds THEN TRUE ELSE frozen IS FALSE END;
 335
 336         IF hold_count >= hold_test.max_holds THEN
 337             result.fail_part := 'config.hold_matrix_test.max_holds';
 338             result.success := FALSE;
 339             done := TRUE;
 340             RETURN NEXT result;
 341         END IF;
 342     END IF;
 343
 344     IF item_object.age_protect IS NOT NULL THEN
 345         SELECT INTO age_protect_object * FROM config.rule_age_hold_protect WHERE id = item_object.age_protect;
 346
 347         IF item_object.create_date + age_protect_object.age > NOW() THEN
 348             IF hold_test.distance_is_from_owner THEN
 349                 SELECT INTO hold_transit_prox prox FROM actor.org_unit_proximity WHERE from_org = item_cn_object.owning_lib AND to_org = pickup_ou;
 350             ELSE
 351                 SELECT INTO hold_transit_prox prox FROM actor.org_unit_proximity WHERE from_org = item_object.circ_lib AND to_org = pickup_ou;
 352             END IF;
 353
 354             IF hold_transit_prox > age_protect_object.prox THEN
 355                 result.fail_part := 'config.rule_age_hold_protect.prox';
 356                 result.success := FALSE;
 357                 done := TRUE;
 358                 RETURN NEXT result;
 359             END IF;
 360         END IF;
 361     END IF;
 362
 363     IF NOT done THEN
 364         RETURN NEXT result;
 365     END IF;
 366
 367     RETURN;
 368 END;
 369 $func$ LANGUAGE plpgsql;
 370
 371 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$
 372     SELECT * FROM action.hold_request_permit_test(pickup_ou, request_ou, match_item, match_user, match_requestor, FALSE);
 373 $func$ LANGUAGE SQL;
 374
 375 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$
 376     SELECT * FROM action.hold_request_permit_test(pickup_ou, request_ou, match_item, match_user, match_requestor, TRUE);
 377 $func$ LANGUAGE SQL;
 378
 379 COMMIT;
 380