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     requestor_object    actor.usr%ROWTYPE;
  61     user_object        actor.usr%ROWTYPE;
  62     item_object        asset.copy%ROWTYPE;
  63     item_cn_object        asset.call_number%ROWTYPE;
  64     rec_descriptor        metabib.rec_descriptor%ROWTYPE;
  65     current_mp_weight    FLOAT;
  66     matchpoint_weight    FLOAT;
  67     tmp_weight        FLOAT;
  68     current_mp        config.hold_matrix_matchpoint%ROWTYPE;
  69     matchpoint        config.hold_matrix_matchpoint%ROWTYPE;
  70 BEGIN
  71     SELECT INTO user_object * FROM actor.usr WHERE id = match_user;
  72     SELECT INTO requestor_object * FROM actor.usr WHERE id = match_requestor;
  73     SELECT INTO item_object * FROM asset.copy WHERE id = match_item;
  74     SELECT INTO item_cn_object * FROM asset.call_number WHERE id = item_object.call_number;
  75     SELECT INTO rec_descriptor r.* FROM metabib.rec_descriptor r WHERE r.record = item_cn_object.record;
  76
  77     PERFORM * FROM config.internal_flag WHERE name = 'circ.holds.usr_not_requestor' AND enabled;
  78
  79     IF NOT FOUND THEN
  80         SELECT INTO current_requestor_group * FROM permission.grp_tree WHERE id = requestor_object.profile;
  81     ELSE
  82         SELECT INTO current_requestor_group * FROM permission.grp_tree WHERE id = user_object.profile;
  83     END IF;
  84
  85     LOOP
  86         -- for each potential matchpoint for this ou and group ...
  87         FOR current_mp IN
  88             SELECT    m.*
  89               FROM    config.hold_matrix_matchpoint m
  90               WHERE    m.requestor_grp = current_requestor_group.id AND m.active
  91               ORDER BY    CASE WHEN m.circ_modifier    IS NOT NULL THEN 16 ELSE 0 END +
  92                     CASE WHEN m.juvenile_flag    IS NOT NULL THEN 16 ELSE 0 END +
  93                     CASE WHEN m.marc_type        IS NOT NULL THEN 8 ELSE 0 END +
  94                     CASE WHEN m.marc_form        IS NOT NULL THEN 4 ELSE 0 END +
  95                     CASE WHEN m.marc_vr_format    IS NOT NULL THEN 2 ELSE 0 END +
  96                     CASE WHEN m.ref_flag        IS NOT NULL THEN 1 ELSE 0 END DESC LOOP
  97
  98             current_mp_weight := 5.0;
  99
 100             IF current_mp.circ_modifier IS NOT NULL THEN
 101                 CONTINUE WHEN current_mp.circ_modifier <> item_object.circ_modifier OR item_object.circ_modifier IS NULL;
 102             END IF;
 103
 104             IF current_mp.marc_type IS NOT NULL THEN
 105                 IF item_object.circ_as_type IS NOT NULL THEN
 106                     CONTINUE WHEN current_mp.marc_type <> item_object.circ_as_type;
 107                 ELSE
 108                     CONTINUE WHEN current_mp.marc_type <> rec_descriptor.item_type;
 109                 END IF;
 110             END IF;
 111
 112             IF current_mp.marc_form IS NOT NULL THEN
 113                 CONTINUE WHEN current_mp.marc_form <> rec_descriptor.item_form;
 114             END IF;
 115
 116             IF current_mp.marc_vr_format IS NOT NULL THEN
 117                 CONTINUE WHEN current_mp.marc_vr_format <> rec_descriptor.vr_format;
 118             END IF;
 119
 120             IF current_mp.juvenile_flag IS NOT NULL THEN
 121                 CONTINUE WHEN current_mp.juvenile_flag <> user_object.juvenile;
 122             END IF;
 123
 124             IF current_mp.ref_flag IS NOT NULL THEN
 125                 CONTINUE WHEN current_mp.ref_flag <> item_object.ref;
 126             END IF;
 127
 128
 129             -- caclulate the rule match weight
 130             IF current_mp.item_owning_ou IS NOT NULL THEN
 131                 SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.item_owning_ou, item_cn_object.owning_lib)::FLOAT + 1.0)::FLOAT;
 132                 current_mp_weight := current_mp_weight - tmp_weight;
 133             END IF;
 134
 135             IF current_mp.item_circ_ou IS NOT NULL THEN
 136                 SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.item_circ_ou, item_object.circ_lib)::FLOAT + 1.0)::FLOAT;
 137                 current_mp_weight := current_mp_weight - tmp_weight;
 138             END IF;
 139
 140             IF current_mp.pickup_ou IS NOT NULL THEN
 141                 SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.pickup_ou, pickup_ou)::FLOAT + 1.0)::FLOAT;
 142                 current_mp_weight := current_mp_weight - tmp_weight;
 143             END IF;
 144
 145             IF current_mp.request_ou IS NOT NULL THEN
 146                 SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.request_ou, request_ou)::FLOAT + 1.0)::FLOAT;
 147                 current_mp_weight := current_mp_weight - tmp_weight;
 148             END IF;
 149
 150             IF current_mp.user_home_ou IS NOT NULL THEN
 151                 SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.user_home_ou, user_object.home_ou)::FLOAT + 1.0)::FLOAT;
 152                 current_mp_weight := current_mp_weight - tmp_weight;
 153             END IF;
 154
 155             -- set the matchpoint if we found the best one
 156             IF matchpoint_weight IS NULL OR matchpoint_weight > current_mp_weight THEN
 157                 matchpoint = current_mp;
 158                 matchpoint_weight = current_mp_weight;
 159             END IF;
 160
 161         END LOOP;
 162
 163         EXIT WHEN current_requestor_group.parent IS NULL OR matchpoint.id IS NOT NULL;
 164
 165         SELECT INTO current_requestor_group * FROM permission.grp_tree WHERE id = current_requestor_group.parent;
 166     END LOOP;
 167
 168     RETURN matchpoint.id;
 169 END;
 170 $func$ LANGUAGE plpgsql;
 171
 172
 173 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$
 174 DECLARE
 175     matchpoint_id        INT;
 176     user_object        actor.usr%ROWTYPE;
 177     age_protect_object    config.rule_age_hold_protect%ROWTYPE;
 178     standing_penalty    config.standing_penalty%ROWTYPE;
 179     transit_range_ou_type    actor.org_unit_type%ROWTYPE;
 180     transit_source        actor.org_unit%ROWTYPE;
 181     item_object        asset.copy%ROWTYPE;
 182     ou_skip              actor.org_unit_setting%ROWTYPE;
 183     result            action.matrix_test_result;
 184     hold_test        config.hold_matrix_matchpoint%ROWTYPE;
 185     hold_count        INT;
 186     hold_transit_prox    INT;
 187     frozen_hold_count    INT;
 188     context_org_list    INT[];
 189     done            BOOL := FALSE;
 190 BEGIN
 191     SELECT INTO user_object * FROM actor.usr WHERE id = match_user;
 192     SELECT INTO context_org_list ARRAY_ACCUM(id) FROM actor.org_unit_full_path( pickup_ou );
 193
 194     result.success := TRUE;
 195
 196     -- Fail if we couldn't find a user
 197     IF user_object.id IS NULL THEN
 198         result.fail_part := 'no_user';
 199         result.success := FALSE;
 200         done := TRUE;
 201         RETURN NEXT result;
 202         RETURN;
 203     END IF;
 204
 205     SELECT INTO item_object * FROM asset.copy WHERE id = match_item;
 206
 207     -- Fail if we couldn't find a copy
 208     IF item_object.id IS NULL THEN
 209         result.fail_part := 'no_item';
 210         result.success := FALSE;
 211         done := TRUE;
 212         RETURN NEXT result;
 213         RETURN;
 214     END IF;
 215
 216     SELECT INTO matchpoint_id action.find_hold_matrix_matchpoint(pickup_ou, request_ou, match_item, match_user, match_requestor);
 217     result.matchpoint := matchpoint_id;
 218
 219     SELECT INTO ou_skip * FROM actor.org_unit_setting WHERE name = 'circ.holds.target_skip_me' AND org_unit = item_object.circ_lib;
 220
 221     -- Fail if the circ_lib for the item has circ.holds.target_skip_me set to true
 222     IF ou_skip.id IS NOT NULL AND ou_skip.value = 'true' THEN
 223         result.fail_part := 'circ.holds.target_skip_me';
 224         result.success := FALSE;
 225         done := TRUE;
 226         RETURN NEXT result;
 227         RETURN;
 228     END IF;
 229
 230     -- Fail if user is barred
 231     IF user_object.barred IS TRUE THEN
 232         result.fail_part := 'actor.usr.barred';
 233         result.success := FALSE;
 234         done := TRUE;
 235         RETURN NEXT result;
 236         RETURN;
 237     END IF;
 238
 239     -- Fail if we couldn't find any matchpoint (requires a default)
 240     IF matchpoint_id IS NULL THEN
 241         result.fail_part := 'no_matchpoint';
 242         result.success := FALSE;
 243         done := TRUE;
 244         RETURN NEXT result;
 245         RETURN;
 246     END IF;
 247
 248     SELECT INTO hold_test * FROM config.hold_matrix_matchpoint WHERE id = matchpoint_id;
 249
 250     IF hold_test.holdable IS FALSE THEN
 251         result.fail_part := 'config.hold_matrix_test.holdable';
 252         result.success := FALSE;
 253         done := TRUE;
 254         RETURN NEXT result;
 255     END IF;
 256
 257     IF hold_test.transit_range IS NOT NULL THEN
 258         SELECT INTO transit_range_ou_type * FROM actor.org_unit_type WHERE id = hold_test.transit_range;
 259         IF hold_test.distance_is_from_owner THEN
 260             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;
 261         ELSE
 262             SELECT INTO transit_source * FROM actor.org_unit WHERE id = item_object.circ_lib;
 263         END IF;
 264
 265         PERFORM * FROM actor.org_unit_descendants( transit_source.id, transit_range_ou_type.depth ) WHERE id = pickup_ou;
 266
 267         IF NOT FOUND THEN
 268             result.fail_part := 'transit_range';
 269             result.success := FALSE;
 270             done := TRUE;
 271             RETURN NEXT result;
 272         END IF;
 273     END IF;
 274
 275     IF NOT retargetting THEN
 276         FOR standing_penalty IN
 277             SELECT  DISTINCT csp.*
 278               FROM  actor.usr_standing_penalty usp
 279                     JOIN config.standing_penalty csp ON (csp.id = usp.standing_penalty)
 280               WHERE usr = match_user
 281                     AND usp.org_unit IN ( SELECT * FROM explode_array(context_org_list) )
 282                     AND (usp.stop_date IS NULL or usp.stop_date > NOW())
 283                     AND csp.block_list LIKE '%HOLD%' LOOP
 284
 285             result.fail_part := standing_penalty.name;
 286             result.success := FALSE;
 287             done := TRUE;
 288             RETURN NEXT result;
 289         END LOOP;
 290
 291         IF hold_test.stop_blocked_user IS TRUE THEN
 292             FOR standing_penalty IN
 293                 SELECT  DISTINCT csp.*
 294                   FROM  actor.usr_standing_penalty usp
 295                         JOIN config.standing_penalty csp ON (csp.id = usp.standing_penalty)
 296                   WHERE usr = match_user
 297                         AND usp.org_unit IN ( SELECT * FROM explode_array(context_org_list) )
 298                         AND (usp.stop_date IS NULL or usp.stop_date > NOW())
 299                         AND csp.block_list LIKE '%CIRC%' LOOP
 300
 301                 result.fail_part := standing_penalty.name;
 302                 result.success := FALSE;
 303                 done := TRUE;
 304                 RETURN NEXT result;
 305             END LOOP;
 306         END IF;
 307
 308         IF hold_test.max_holds IS NOT NULL THEN
 309             SELECT    INTO hold_count COUNT(*)
 310               FROM    action.hold_request
 311               WHERE    usr = match_user
 312                 AND fulfillment_time IS NULL
 313                 AND cancel_time IS NULL
 314                 AND CASE WHEN hold_test.include_frozen_holds THEN TRUE ELSE frozen IS FALSE END;
 315
 316             IF hold_count >= hold_test.max_holds THEN
 317                 result.fail_part := 'config.hold_matrix_test.max_holds';
 318                 result.success := FALSE;
 319                 done := TRUE;
 320                 RETURN NEXT result;
 321             END IF;
 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 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$
 353     SELECT * FROM action.hold_request_permit_test(pickup_ou, request_ou, match_item, match_user, match_requestor, FALSE);
 354 $func$ LANGUAGE SQL;
 355
 356 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$
 357     SELECT * FROM action.hold_request_permit_test(pickup_ou, request_ou, match_item, match_user, match_requestor, TRUE);
 358 $func$ LANGUAGE SQL;
 359
 360 COMMIT;
 361