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     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"
  35     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"
  36     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"
  37     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"
  38     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"
  39     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
  40     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
  41     circ_modifier           TEXT    REFERENCES config.circ_modifier (code) DEFERRABLE INITIALLY DEFERRED,
  42     marc_type               TEXT    REFERENCES config.item_type_map (code) DEFERRABLE INITIALLY DEFERRED,
  43     marc_form               TEXT    REFERENCES config.item_form_map (code) DEFERRABLE INITIALLY DEFERRED,
  44     marc_vr_format          TEXT    REFERENCES config.videorecording_format_map (code) DEFERRABLE INITIALLY DEFERRED,
  45     juvenile_flag           BOOL,
  46     ref_flag                BOOL,
  47     holdable                BOOL    NOT NULL DEFAULT TRUE,                -- Hard "can't hold" flag requiring an override
  48     distance_is_from_owner  BOOL    NOT NULL DEFAULT FALSE,                -- How to calculate transit_range.  True means owning lib, false means copy circ lib
  49     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
  50     max_holds               INT,                            -- Total hold requests must be less than this, NULL means skip (always pass)
  51     include_frozen_holds    BOOL    NOT NULL DEFAULT TRUE,                -- Include frozen hold requests in the count for max_holds test
  52     stop_blocked_user       BOOL    NOT NULL DEFAULT FALSE,                -- Stop users who cannot check out items from placing holds
  53     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
  54     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)
  55 );
  56
  57 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$
  58 DECLARE
  59     current_requestor_group    permission.grp_tree%ROWTYPE;
  60     root_ou            actor.org_unit%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 root_ou * FROM actor.org_unit WHERE parent_ou IS NULL;
  73     SELECT INTO user_object * FROM actor.usr WHERE id = match_user;
  74     SELECT INTO requestor_object * FROM actor.usr WHERE id = match_requestor;
  75     SELECT INTO item_object * FROM asset.copy WHERE id = match_item;
  76     SELECT INTO item_cn_object * FROM asset.call_number WHERE id = item_object.call_number;
  77     SELECT INTO rec_descriptor r.* FROM metabib.rec_descriptor r WHERE r.record = item_cn_object.record;
  78
  79     PERFORM * FROM config.internal_flag WHERE name = 'circ.holds.usr_not_requestor' AND enabled;
  80
  81     IF NOT FOUND THEN
  82         SELECT INTO current_requestor_group * FROM permission.grp_tree WHERE id = requestor_object.profile;
  83     ELSE
  84         SELECT INTO current_requestor_group * FROM permission.grp_tree WHERE id = user_object.profile;
  85     END IF;
  86
  87     LOOP
  88         -- for each potential matchpoint for this ou and group ...
  89         FOR current_mp IN
  90             SELECT    m.*
  91               FROM    config.hold_matrix_matchpoint m
  92               WHERE    m.requestor_grp = current_requestor_group.id AND m.active
  93               ORDER BY    CASE WHEN m.circ_modifier    IS NOT NULL THEN 16 ELSE 0 END +
  94                     CASE WHEN m.juvenile_flag    IS NOT NULL THEN 16 ELSE 0 END +
  95                     CASE WHEN m.marc_type        IS NOT NULL THEN 8 ELSE 0 END +
  96                     CASE WHEN m.marc_form        IS NOT NULL THEN 4 ELSE 0 END +
  97                     CASE WHEN m.marc_vr_format    IS NOT NULL THEN 2 ELSE 0 END +
  98                     CASE WHEN m.ref_flag        IS NOT NULL THEN 1 ELSE 0 END DESC LOOP
  99
 100             current_mp_weight := 5.0;
 101
 102             IF current_mp.circ_modifier IS NOT NULL THEN
 103                 CONTINUE WHEN current_mp.circ_modifier <> item_object.circ_modifier OR item_object.circ_modifier IS NULL;
 104             END IF;
 105
 106             IF current_mp.marc_type IS NOT NULL THEN
 107                 IF item_object.circ_as_type IS NOT NULL THEN
 108                     CONTINUE WHEN current_mp.marc_type <> item_object.circ_as_type;
 109                 ELSE
 110                     CONTINUE WHEN current_mp.marc_type <> rec_descriptor.item_type;
 111                 END IF;
 112             END IF;
 113
 114             IF current_mp.marc_form IS NOT NULL THEN
 115                 CONTINUE WHEN current_mp.marc_form <> rec_descriptor.item_form;
 116             END IF;
 117
 118             IF current_mp.marc_vr_format IS NOT NULL THEN
 119                 CONTINUE WHEN current_mp.marc_vr_format <> rec_descriptor.vr_format;
 120             END IF;
 121
 122             IF current_mp.juvenile_flag IS NOT NULL THEN
 123                 CONTINUE WHEN current_mp.juvenile_flag <> user_object.juvenile;
 124             END IF;
 125
 126             IF current_mp.ref_flag IS NOT NULL THEN
 127                 CONTINUE WHEN current_mp.ref_flag <> item_object.ref;
 128             END IF;
 129
 130
 131             -- caclulate the rule match weight
 132             IF current_mp.item_owning_ou IS NOT NULL AND current_mp.item_owning_ou <> root_ou.id 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                 current_mp_weight := current_mp_weight - tmp_weight;
 135             END IF;
 136
 137             IF current_mp.item_circ_ou IS NOT NULL AND current_mp.item_circ_ou <> root_ou.id THEN
 138                 SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.item_circ_ou, item_object.circ_lib)::FLOAT + 1.0)::FLOAT;
 139                 current_mp_weight := current_mp_weight - tmp_weight;
 140             END IF;
 141
 142             IF current_mp.pickup_ou IS NOT NULL AND current_mp.pickup_ou <> root_ou.id THEN
 143                 SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.pickup_ou, pickup_ou)::FLOAT + 1.0)::FLOAT;
 144                 current_mp_weight := current_mp_weight - tmp_weight;
 145             END IF;
 146
 147             IF current_mp.request_ou IS NOT NULL AND current_mp.request_ou <> root_ou.id THEN
 148                 SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.request_ou, request_ou)::FLOAT + 1.0)::FLOAT;
 149                 current_mp_weight := current_mp_weight - tmp_weight;
 150             END IF;
 151
 152             IF current_mp.user_home_ou IS NOT NULL AND current_mp.user_home_ou <> root_ou.id THEN
 153                 SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.user_home_ou, user_object.home_ou)::FLOAT + 1.0)::FLOAT;
 154                 current_mp_weight := current_mp_weight - tmp_weight;
 155             END IF;
 156
 157             -- set the matchpoint if we found the best one
 158             IF matchpoint_weight IS NULL OR matchpoint_weight > current_mp_weight THEN
 159                 matchpoint = current_mp;
 160                 matchpoint_weight = current_mp_weight;
 161             END IF;
 162
 163         END LOOP;
 164
 165         EXIT WHEN current_requestor_group.parent IS NULL OR matchpoint.id IS NOT NULL;
 166
 167         SELECT INTO current_requestor_group * FROM permission.grp_tree WHERE id = current_requestor_group.parent;
 168     END LOOP;
 169
 170     RETURN matchpoint.id;
 171 END;
 172 $func$ LANGUAGE plpgsql;
 173
 174
 175 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$
 176 DECLARE
 177     matchpoint_id        INT;
 178     user_object        actor.usr%ROWTYPE;
 179     age_protect_object    config.rule_age_hold_protect%ROWTYPE;
 180     standing_penalty    config.standing_penalty%ROWTYPE;
 181     transit_range_ou_type    actor.org_unit_type%ROWTYPE;
 182     transit_source        actor.org_unit%ROWTYPE;
 183     item_object        asset.copy%ROWTYPE;
 184     ou_skip              actor.org_unit_setting%ROWTYPE;
 185     result            action.matrix_test_result;
 186     hold_test        config.hold_matrix_matchpoint%ROWTYPE;
 187     hold_count        INT;
 188     hold_transit_prox    INT;
 189     frozen_hold_count    INT;
 190     context_org_list    INT[];
 191     done            BOOL := FALSE;
 192 BEGIN
 193     SELECT INTO user_object * FROM actor.usr WHERE id = match_user;
 194     SELECT INTO context_org_list ARRAY_ACCUM(id) FROM actor.org_unit_full_path( pickup_ou );
 195
 196     result.success := TRUE;
 197
 198     -- Fail if we couldn't find a user
 199     IF user_object.id IS NULL THEN
 200         result.fail_part := 'no_user';
 201         result.success := FALSE;
 202         done := TRUE;
 203         RETURN NEXT result;
 204         RETURN;
 205     END IF;
 206
 207     SELECT INTO item_object * FROM asset.copy WHERE id = match_item;
 208
 209     -- Fail if we couldn't find a copy
 210     IF item_object.id IS NULL THEN
 211         result.fail_part := 'no_item';
 212         result.success := FALSE;
 213         done := TRUE;
 214         RETURN NEXT result;
 215         RETURN;
 216     END IF;
 217
 218     SELECT INTO matchpoint_id action.find_hold_matrix_matchpoint(pickup_ou, request_ou, match_item, match_user, match_requestor);
 219     result.matchpoint := matchpoint_id;
 220
 221     SELECT INTO ou_skip * FROM actor.org_unit_setting WHERE name = 'circ.holds.target_skip_me' AND org_unit = item_object.circ_lib;
 222
 223     -- Fail if the circ_lib for the item has circ.holds.target_skip_me set to true
 224     IF ou_skip.id IS NOT NULL AND ou_skip.value = 'true' THEN
 225         result.fail_part := 'circ.holds.target_skip_me';
 226         result.success := FALSE;
 227         done := TRUE;
 228         RETURN NEXT result;
 229         RETURN;
 230     END IF;
 231
 232     -- Fail if user is barred
 233     IF user_object.barred IS TRUE THEN
 234         result.fail_part := 'actor.usr.barred';
 235         result.success := FALSE;
 236         done := TRUE;
 237         RETURN NEXT result;
 238         RETURN;
 239     END IF;
 240
 241     -- Fail if we couldn't find any matchpoint (requires a default)
 242     IF matchpoint_id IS NULL THEN
 243         result.fail_part := 'no_matchpoint';
 244         result.success := FALSE;
 245         done := TRUE;
 246         RETURN NEXT result;
 247         RETURN;
 248     END IF;
 249
 250     SELECT INTO hold_test * FROM config.hold_matrix_matchpoint WHERE id = matchpoint_id;
 251
 252     IF hold_test.holdable IS FALSE THEN
 253         result.fail_part := 'config.hold_matrix_test.holdable';
 254         result.success := FALSE;
 255         done := TRUE;
 256         RETURN NEXT result;
 257     END IF;
 258
 259     IF hold_test.transit_range IS NOT NULL THEN
 260         SELECT INTO transit_range_ou_type * FROM actor.org_unit_type WHERE id = hold_test.transit_range;
 261         IF hold_test.distance_is_from_owner THEN
 262             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;
 263         ELSE
 264             SELECT INTO transit_source * FROM actor.org_unit WHERE id = item_object.circ_lib;
 265         END IF;
 266
 267         PERFORM * FROM actor.org_unit_descendants( transit_source.id, transit_range_ou_type.depth ) WHERE id = pickup_ou;
 268
 269         IF NOT FOUND THEN
 270             result.fail_part := 'transit_range';
 271             result.success := FALSE;
 272             done := TRUE;
 273             RETURN NEXT result;
 274         END IF;
 275     END IF;
 276
 277     FOR standing_penalty IN
 278         SELECT  DISTINCT csp.*
 279           FROM  actor.usr_standing_penalty usp
 280                 JOIN config.standing_penalty csp ON (csp.id = usp.standing_penalty)
 281           WHERE usr = match_user
 282                 AND usp.org_unit IN ( SELECT * FROM explode_array(context_org_list) )
 283                 AND (usp.stop_date IS NULL or usp.stop_date > NOW())
 284                 AND csp.block_list LIKE '%HOLD%' LOOP
 285
 286         result.fail_part := standing_penalty.name;
 287         result.success := FALSE;
 288         done := TRUE;
 289         RETURN NEXT result;
 290     END LOOP;
 291
 292     IF hold_test.stop_blocked_user IS TRUE THEN
 293         FOR standing_penalty IN
 294             SELECT  DISTINCT csp.*
 295               FROM  actor.usr_standing_penalty usp
 296                     JOIN config.standing_penalty csp ON (csp.id = usp.standing_penalty)
 297               WHERE usr = match_user
 298                     AND usp.org_unit IN ( SELECT * FROM explode_array(context_org_list) )
 299                     AND (usp.stop_date IS NULL or usp.stop_date > NOW())
 300                     AND csp.block_list LIKE '%CIRC%' LOOP
 301
 302             result.fail_part := standing_penalty.name;
 303             result.success := FALSE;
 304             done := TRUE;
 305             RETURN NEXT result;
 306         END LOOP;
 307     END IF;
 308
 309     IF hold_test.max_holds IS NOT NULL THEN
 310         SELECT    INTO hold_count COUNT(*)
 311           FROM    action.hold_request
 312           WHERE    usr = match_user
 313             AND fulfillment_time IS NULL
 314             AND cancel_time IS NULL
 315             AND CASE WHEN hold_test.include_frozen_holds THEN TRUE ELSE frozen IS FALSE END;
 316
 317         IF hold_count >= hold_test.max_holds THEN
 318             result.fail_part := 'config.hold_matrix_test.max_holds';
 319             result.success := FALSE;
 320             done := TRUE;
 321             RETURN NEXT result;
 322         END IF;
 323     END IF;
 324
 325     IF item_object.age_protect IS NOT NULL THEN
 326         SELECT INTO age_protect_object * FROM config.rule_age_hold_protect WHERE id = item_object.age_protect;
 327
 328         IF item_object.create_date + age_protect_object.age > NOW() THEN
 329             IF hold_test.distance_is_from_owner THEN
 330                 SELECT INTO hold_transit_prox prox FROM actor.org_unit_proximity WHERE from_org = item_cn_object.owning_lib AND to_org = pickup_ou;
 331             ELSE
 332                 SELECT INTO hold_transit_prox prox FROM actor.org_unit_proximity WHERE from_org = item_object.circ_lib AND to_org = pickup_ou;
 333             END IF;
 334
 335             IF hold_transit_prox > age_protect_object.prox THEN
 336                 result.fail_part := 'config.rule_age_hold_protect.prox';
 337                 result.success := FALSE;
 338                 done := TRUE;
 339                 RETURN NEXT result;
 340             END IF;
 341         END IF;
 342     END IF;
 343
 344     IF NOT done THEN
 345         RETURN NEXT result;
 346     END IF;
 347
 348     RETURN;
 349 END;
 350 $func$ LANGUAGE plpgsql;
 351
 352 COMMIT;
 353