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