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

   1 BEGIN;
   2
   3
   4 --
   5 --                 ****** Which ruleset and tests to use *******
   6 --
   7 -- * Most specific range for org_unit and grp wins.
   8 --
   9 -- * circ_modifier match takes precidence over marc_type match, if circ_modifier is set here
  10 --
  11 -- * marc_type is first checked against the circ_as_type from the copy, then the item type from the marc record
  12 --
  13 -- * If neither circ_modifier nor marc_type is set (both are NULLABLE) then the entry defines the default
  14 --   ruleset and tests for the OU + group (like BOOK in PINES)
  15 --
  16
  17
  18
  19 CREATE TABLE config.hold_matrix_matchpoint (
  20         id                      SERIAL      PRIMARY KEY,
  21         active                  BOOL    NOT NULL DEFAULT TRUE,
  22         user_home_ou    INT         REFERENCES actor.org_unit (id),     -- Set to the top OU for the matchpoint applicability range; we can use org_unit_prox to choose the "best"
  23         request_ou              INT         REFERENCES actor.org_unit (id),     -- Set to the top OU for the matchpoint applicability range; we can use org_unit_prox to choose the "best"
  24         pickup_ou               INT         REFERENCES actor.org_unit (id),     -- Set to the top OU for the matchpoint applicability range; we can use org_unit_prox to choose the "best"
  25         item_owning_ou  INT         REFERENCES actor.org_unit (id),     -- Set to the top OU for the matchpoint applicability range; we can use org_unit_prox to choose the "best"
  26         item_circ_ou    INT         REFERENCES actor.org_unit (id),     -- Set to the top OU for the matchpoint applicability range; we can use org_unit_prox to choose the "best"
  27         usr_grp                 INT         REFERENCES permission.grp_tree (id),        -- Set to the top applicable group from the group tree; will need decendents and prox functions for filtering
  28         requestor_grp   INT         NOT NULL REFERENCES permission.grp_tree (id),       -- Set to the top applicable group from the group tree; will need decendents and prox functions for filtering
  29         circ_modifier   TEXT    REFERENCES config.circ_modifier (code),
  30         marc_type               TEXT    REFERENCES config.item_type_map (code),
  31         marc_form               TEXT    REFERENCES config.item_form_map (code),
  32         marc_vr_format  TEXT    REFERENCES config.videorecording_format_map (code),
  33         ref_flag                BOOL,
  34         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)
  35 );
  36
  37 -- Tests to determine if hold against a specific copy is possible for a user at (and from) a location
  38 CREATE TABLE config.hold_matrix_test (
  39         matchpoint                      INT     PRIMARY KEY REFERENCES config.hold_matrix_matchpoint (id),
  40         holdable                        BOOL    NOT NULL DEFAULT TRUE,                          -- Hard "can't hold" flag requiring an override
  41         distance_is_from_owner  BOOL    NOT NULL DEFAULT FALSE,                         -- How to calculate transit_range.  True means owning lib, false means copy circ lib
  42         transit_range               INT REFERENCES actor.org_unit_type (id),            -- Can circ inside range of cn.owner/cp.circ_lib at depth of the org_unit_type specified here
  43         max_holds                       INT,                                                    -- Total hold requests must be less than this, NULL means skip (always pass)
  44         include_frozen_holds    BOOL    NOT NULL DEFAULT TRUE,                          -- Include frozen hold requests in the count for max_holds test
  45         age_hold_protect_rule   INT     REFERENCES config.rule_age_hold_protect (id)    -- still not sure we want to move this off the copy
  46 );
  47
  48 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$
  49 DECLARE
  50         current_requestor_group permission.grp_tree%ROWTYPE;
  51         root_ou                 actor.org_unit%ROWTYPE;
  52         requestor_object        actor.usr%ROWTYPE;
  53         user_object             actor.usr%ROWTYPE;
  54         item_object             asset.copy%ROWTYPE;
  55         item_cn_object          asset.call_number%ROWTYPE;
  56         rec_descriptor          metabib.rec_descriptor%ROWTYPE;
  57         current_mp_weight       FLOAT;
  58         matchpoint_weight       FLOAT;
  59         tmp_weight              FLOAT;
  60         current_mp              config.hold_matrix_matchpoint%ROWTYPE;
  61         matchpoint              config.hold_matrix_matchpoint%ROWTYPE;
  62 BEGIN
  63         SELECT INTO root_ou * FROM actor.org_unit WHERE parent_ou IS NULL;
  64         SELECT INTO user_object * FROM actor.usr WHERE id = match_user;
  65         SELECT INTO requestor_object * FROM actor.usr WHERE id = match_requestor;
  66         SELECT INTO item_object * FROM asset.copy WHERE id = match_item;
  67         SELECT INTO item_cn_object * FROM asset.call_number WHERE id = item_object.call_number;
  68         SELECT INTO rec_descriptor r.* FROM metabib.rec_descriptor r WHERE r.record = item_cn_object.record;
  69         SELECT INTO current_requestor_group * FROM permission.grp_tree WHERE id = requestor_object.profile;
  70
  71         LOOP
  72                 -- for each potential matchpoint for this ou and group ...
  73                 FOR current_mp IN
  74                         SELECT  m.*
  75                           FROM  config.hold_matrix_matchpoint m
  76                           WHERE m.requestor_grp = current_requestor_group.id AND m.active
  77                           ORDER BY      CASE WHEN m.circ_modifier       IS NOT NULL THEN 16 ELSE 0 END +
  78                                         CASE WHEN m.marc_type           IS NOT NULL THEN 8 ELSE 0 END +
  79                                         CASE WHEN m.marc_form           IS NOT NULL THEN 4 ELSE 0 END +
  80                                         CASE WHEN m.marc_vr_format      IS NOT NULL THEN 2 ELSE 0 END +
  81                                         CASE WHEN m.ref_flag            IS NOT NULL THEN 1 ELSE 0 END DESC LOOP
  82
  83                         current_mp_weight := 5.0;
  84
  85                         IF current_mp.circ_modifier IS NOT NULL THEN
  86                                 CONTINUE WHEN current_mp.circ_modifier <> item_object.circ_modifier;
  87                         END IF;
  88
  89                         IF current_mp.marc_type IS NOT NULL THEN
  90                                 IF item_object.circ_as_type IS NOT NULL THEN
  91                                         CONTINUE WHEN current_mp.marc_type <> item_object.circ_as_type;
  92                                 ELSE
  93                                         CONTINUE WHEN current_mp.marc_type <> rec_descriptor.item_type;
  94                                 END IF;
  95                         END IF;
  96
  97                         IF current_mp.marc_form IS NOT NULL THEN
  98                                 CONTINUE WHEN current_mp.marc_form <> rec_descriptor.item_form;
  99                         END IF;
 100
 101                         IF current_mp.marc_vr_format IS NOT NULL THEN
 102                                 CONTINUE WHEN current_mp.marc_vr_format <> rec_descriptor.vr_format;
 103                         END IF;
 104
 105                         IF current_mp.ref_flag IS NOT NULL THEN
 106                                 CONTINUE WHEN current_mp.ref_flag <> item_object.ref;
 107                         END IF;
 108
 109
 110                         -- caclulate the rule match weight
 111                         IF current_mp.item_owning_ou IS NOT NULL AND current_mp.item_owning_ou <> root_ou.id THEN
 112                                 SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.item_owning_ou, item_cn_object.owning_lib)::FLOAT + 1.0)::FLOAT;
 113                                 current_mp_weight := current_mp_weight - tmp_weight;
 114                         END IF;
 115
 116                         IF current_mp.item_circ_ou IS NOT NULL AND current_mp.item_circ_ou <> root_ou.id THEN
 117                                 SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.item_circ_ou, item_object.circ_lib)::FLOAT + 1.0)::FLOAT;
 118                                 current_mp_weight := current_mp_weight - tmp_weight;
 119                         END IF;
 120
 121                         IF current_mp.pickup_ou IS NOT NULL AND current_mp.pickup_ou <> root_ou.id THEN
 122                                 SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.pickup_ou, pickup_ou)::FLOAT + 1.0)::FLOAT;
 123                                 current_mp_weight := current_mp_weight - tmp_weight;
 124                         END IF;
 125
 126                         IF current_mp.request_ou IS NOT NULL AND current_mp.request_ou <> root_ou.id THEN
 127                                 SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.request_ou, request_ou)::FLOAT + 1.0)::FLOAT;
 128                                 current_mp_weight := current_mp_weight - tmp_weight;
 129                         END IF;
 130
 131                         IF current_mp.user_home_ou IS NOT NULL AND current_mp.user_home_ou <> root_ou.id THEN
 132                                 SELECT INTO tmp_weight 1.0 / (actor.org_unit_proximity(current_mp.user_home_ou, user_object.home_ou)::FLOAT + 1.0)::FLOAT;
 133                                 current_mp_weight := current_mp_weight - tmp_weight;
 134                         END IF;
 135
 136                         -- set the matchpoint if we found the best one
 137                         IF matchpoint_weight IS NULL OR matchpoint_weight > current_mp_weight THEN
 138                                 matchpoint = current_mp;
 139                                 matchpoint_weight = current_mp_weight;
 140                         END IF;
 141
 142                 END LOOP;
 143
 144                 EXIT WHEN current_requestor_group.parent IS NULL OR matchpoint.id IS NOT NULL;
 145
 146                 SELECT INTO current_requestor_group * FROM permission.grp_tree WHERE id = current_requestor_group.parent;
 147         END LOOP;
 148
 149         RETURN matchpoint.id;
 150 END;
 151 $func$ LANGUAGE plpgsql;
 152
 153
 154 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$
 155 DECLARE
 156         matchpoint_id           INT;
 157         user_object             actor.usr%ROWTYPE;
 158         age_protect_object      config.rule_age_hold_protect%ROWTYPE;
 159         transit_range_ou_type   actor.org_unit_type%ROWTYPE;
 160         transit_source          actor.org_unit%ROWTYPE;
 161         item_object             asset.copy%ROWTYPE;
 162         result                  action.matrix_test_result;
 163         hold_test               config.hold_matrix_test%ROWTYPE;
 164         hold_count              INT;
 165         hold_transit_prox       INT;
 166         frozen_hold_count       INT;
 167         done                    BOOL := FALSE;
 168 BEGIN
 169         SELECT INTO user_object * FROM actor.usr WHERE id = match_user;
 170
 171         -- Fail if we couldn't find a user
 172         IF user_object.id IS NULL THEN
 173                 result.fail_part := 'no_user';
 174                 result.success := FALSE;
 175                 done := TRUE;
 176                 RETURN NEXT result;
 177                 RETURN;
 178         END IF;
 179
 180         SELECT INTO item_object * FROM asset.copy WHERE id = match_item;
 181
 182         -- Fail if we couldn't find a copy
 183         IF item_object.id IS NULL THEN
 184                 result.fail_part := 'no_item';
 185                 result.success := FALSE;
 186                 done := TRUE;
 187                 RETURN NEXT result;
 188                 RETURN;
 189         END IF;
 190
 191         SELECT INTO matchpoint_id action.find_hold_matrix_matchpoint(pickup_ou, request_ou, match_item, match_user, match_requestor);
 192
 193         -- Fail if we couldn't find any matchpoint (requires a default)
 194         IF matchpoint_id IS NULL THEN
 195                 result.fail_part := 'no_matchpoint';
 196                 result.success := FALSE;
 197                 done := TRUE;
 198                 RETURN NEXT result;
 199                 RETURN;
 200         END IF;
 201
 202         SELECT INTO hold_test * FROM config.hold_matrix_test WHERE matchpoint = matchpoint_id;
 203
 204         result.matchpoint := matchpoint_id;
 205         result.success := TRUE;
 206
 207         IF hold_test.holdable IS FALSE THEN
 208                 result.fail_part := 'config.hold_matrix_test.holdable';
 209                 result.success := FALSE;
 210                 done := TRUE;
 211                 RETURN NEXT result;
 212         END IF;
 213
 214         IF hold_test.transit_range IS NOT NULL THEN
 215                 SELECT INTO transit_range_ou_type * FROM actor.org_unit_type WHERE id = hold_test.transit_range;
 216                 IF hold_test.distance_is_from_owner THEN
 217                         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;
 218                 ELSE
 219                         SELECT INTO transit_source * FROM actor.org_unit WHERE id = item_object.circ_lib;
 220                 END IF;
 221
 222                 PERFORM * FROM actor.org_unit_descendants( transit_source.id, transit_range_ou_type.depth ) WHERE id = pickup_ou;
 223
 224                 IF NOT FOUND THEN
 225                         result.fail_part := 'transit_range';
 226                         result.success := FALSE;
 227                         done := TRUE;
 228                         RETURN NEXT result;
 229                 END IF;
 230         END IF;
 231
 232         IF hold_test.max_holds IS NOT NULL THEN
 233                 SELECT  INTO hold_count COUNT(*)
 234                   FROM  action.hold_request
 235                   WHERE usr = match_user
 236                         AND fulfillment_time IS NULL
 237                         AND cancel_time IS NULL
 238                         AND CASE WHEN hold_test.include_frozen_holds THEN TRUE ELSE frozen IS FALSE END;
 239
 240                 IF items_out >= hold_test.max_holds THEN
 241                         result.fail_part := 'config.hold_matrix_test.max_holds';
 242                         result.success := FALSE;
 243                         done := TRUE;
 244                         RETURN NEXT result;
 245                 END IF;
 246         END IF;
 247
 248         IF item_object.age_protect IS NOT NULL THEN
 249                 SELECT INTO age_protect_object * FROM config.rule_age_hold_protect WHERE id = item_object.age_protect;
 250
 251                 IF item_object.create_date + age_protect_object.age > NOW() THEN
 252                         IF hold_test.distance_is_from_owner THEN
 253                                 SELECT INTO hold_transit_prox prox FROM actor.org_unit_prox WHERE from_org = item_cn_object.owning_lib AND to_org = pickup_ou;
 254                         ELSE
 255                                 SELECT INTO hold_transit_prox prox FROM actor.org_unit_prox WHERE from_org = item_object.circ_lib AND to_org = pickup_ou;
 256                         END IF;
 257
 258                         IF hold_transit_prox > age_protect_object.prox THEN
 259                                 result.fail_part := 'config.rule_age_hold_protect.prox';
 260                                 result.success := FALSE;
 261                                 done := TRUE;
 262                                 RETURN NEXT result;
 263                         END IF;
 264                 END IF;
 265         END IF;
 266
 267         IF NOT done THEN
 268                 RETURN NEXT result;
 269         END IF;
 270
 271         RETURN;
 272 END;
 273 $func$ LANGUAGE plpgsql;
 274
 275 COMMIT;
 276