Open-ILS/src/sql/Pg/100.circ_matrix.sql

   1
   2 BEGIN;
   3 -- NOTE: current config.item_type should get sip2_media_type and magnetic_media columns
   4
   5 -- New table needed to handle circ modifiers inside the DB.  Will still require
   6 -- central admin.  The circ_modifier column on asset.copy will become an fkey to this table.
   7 CREATE TABLE config.circ_modifier (
   8     code            TEXT    PRIMARY KEY,
   9     name            TEXT    UNIQUE NOT NULL,
  10     description        TEXT    NOT NULL,
  11     sip2_media_type    TEXT    NOT NULL,
  12     magnetic_media     BOOL    NOT NULL DEFAULT TRUE,
  13     avg_wait_time      INTERVAL
  14 );
  15
  16 /*
  17 -- for instance ...
  18 INSERT INTO config.circ_modifier VALUES ( 'DVD', 'DVD', 'um ... DVDs', '001', FALSE );
  19 INSERT INTO config.circ_modifier VALUES ( 'VIDEO', 'VIDEO', 'Tapes', '001', TRUE );
  20 INSERT INTO config.circ_modifier VALUES ( 'BOOK', 'BOOK', 'Dead tree', '001', FALSE );
  21 INSERT INTO config.circ_modifier VALUES ( 'CRAZY_ARL-ATH_SETTING', 'R2R_TAPE', 'reel2reel tape', '007', TRUE );
  22 */
  23
  24 -- But, just to get us started, use this
  25 /*
  26
  27 UPDATE asset.copy SET circ_modifier = UPPER(circ_modifier) WHERE circ_modifier IS NOT NULL AND circ_modifier <> '';
  28 UPDATE asset.copy SET circ_modifier = NULL WHERE circ_modifier = '';
  29
  30 INSERT INTO config.circ_modifier (code, name, description, sip2_media_type )
  31     SELECT DISTINCT
  32             UPPER(circ_modifier),
  33             UPPER(circ_modifier),
  34             LOWER(circ_modifier),
  35             '001'
  36       FROM  asset.copy
  37       WHERE circ_modifier IS NOT NULL;
  38
  39 */
  40
  41 -- add an fkey pointing to the new circ mod table
  42 ALTER TABLE asset.copy ADD CONSTRAINT circ_mod_fkey FOREIGN KEY (circ_modifier) REFERENCES config.circ_modifier (code) ON UPDATE CASCADE ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED;
  43
  44
  45 /**
  46  **  Here we define the tables that make up the circ matrix.  Conceptually, this implements
  47  **  the "sparse matrix" that everyone talks about, instead of using traditional rules logic.
  48  **  Physically, we cut the matrix up into separate tables (almost 3rd normal form!) that handle
  49  **  different portions of the matrix.  This wil simplify creation of the UI (I hope), and help the
  50  **  developers focus on specific parts of the matrix.
  51  **/
  52
  53 CREATE TABLE config.circ_matrix_matchpoint (
  54     id                   SERIAL    PRIMARY KEY,
  55     active               BOOL    NOT NULL DEFAULT TRUE,
  56     -- Match Fields
  57     org_unit             INT        NOT NULL 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"
  58     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
  59     circ_modifier        TEXT    REFERENCES config.circ_modifier (code) DEFERRABLE INITIALLY DEFERRED,
  60     copy_location        INT     REFERENCES asset.copy_location (id) DEFERRABLE INITIALLY DEFERRED,
  61     marc_type            TEXT,
  62     marc_form            TEXT,
  63     marc_bib_level       TEXT,
  64     marc_vr_format       TEXT,
  65     copy_circ_lib        INT     REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
  66     copy_owning_lib      INT     REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
  67     user_home_ou         INT     REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
  68     ref_flag             BOOL,
  69     juvenile_flag        BOOL,
  70     is_renewal           BOOL,
  71     usr_age_lower_bound  INTERVAL,
  72     usr_age_upper_bound  INTERVAL,
  73     item_age             INTERVAL,
  74     -- "Result" Fields
  75     circulate            BOOL,   -- Hard "can't circ" flag requiring an override
  76     duration_rule        INT     REFERENCES config.rule_circ_duration (id) DEFERRABLE INITIALLY DEFERRED,
  77     recurring_fine_rule  INT     REFERENCES config.rule_recurring_fine (id) DEFERRABLE INITIALLY DEFERRED,
  78     max_fine_rule        INT     REFERENCES config.rule_max_fine (id) DEFERRABLE INITIALLY DEFERRED,
  79     hard_due_date        INT     REFERENCES config.hard_due_date (id) DEFERRABLE INITIALLY DEFERRED,
  80     renewals             INT,    -- Renewal count override
  81     grace_period         INTERVAL,    -- Grace period override
  82     script_test          TEXT,                           -- javascript source
  83     total_copy_hold_ratio     FLOAT,
  84     available_copy_hold_ratio FLOAT
  85 );
  86
  87 -- Nulls don't count for a constraint match, so we have to coalesce them into something that does.
  88 CREATE UNIQUE INDEX ccmm_once_per_paramset ON config.circ_matrix_matchpoint (org_unit, grp, COALESCE(circ_modifier, ''), COALESCE(copy_location::TEXT, ''), COALESCE(marc_type, ''), COALESCE(marc_form, ''), COALESCE(marc_bib_level,''), COALESCE(marc_vr_format, ''), COALESCE(copy_circ_lib::TEXT, ''), COALESCE(copy_owning_lib::TEXT, ''), COALESCE(user_home_ou::TEXT, ''), COALESCE(ref_flag::TEXT, ''), COALESCE(juvenile_flag::TEXT, ''), COALESCE(is_renewal::TEXT, ''), COALESCE(usr_age_lower_bound::TEXT, ''), COALESCE(usr_age_upper_bound::TEXT, ''), COALESCE(item_age::TEXT, '')) WHERE active;
  89
  90 -- Limit groups for circ counting
  91 CREATE TABLE config.circ_limit_group (
  92     id          SERIAL  PRIMARY KEY,
  93     name        TEXT    UNIQUE NOT NULL,
  94     description TEXT
  95 );
  96
  97 -- Limit sets
  98 CREATE TABLE config.circ_limit_set (
  99     id          SERIAL  PRIMARY KEY,
 100     name        TEXT    UNIQUE NOT NULL,
 101     owning_lib  INT     NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
 102     items_out   INT     NOT NULL, -- Total current active circulations must be less than this. 0 means skip counting (always pass)
 103     depth       INT     NOT NULL DEFAULT 0, -- Depth count starts at
 104     global      BOOL    NOT NULL DEFAULT FALSE, -- If enabled, include everything below depth, otherwise ancestors/descendants only
 105     description TEXT
 106 );
 107
 108 -- Linkage between matchpoints and limit sets
 109 CREATE TABLE config.circ_matrix_limit_set_map (
 110     id          SERIAL  PRIMARY KEY,
 111     matchpoint  INT     NOT NULL REFERENCES config.circ_matrix_matchpoint (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 112     limit_set   INT     NOT NULL REFERENCES config.circ_limit_set (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 113     fallthrough BOOL    NOT NULL DEFAULT FALSE, -- If true fallthrough will grab this rule as it goes along
 114     active      BOOL    NOT NULL DEFAULT TRUE,
 115     CONSTRAINT circ_limit_set_once_per_matchpoint UNIQUE (matchpoint, limit_set)
 116 );
 117
 118 -- Linkage between limit sets and circ mods
 119 CREATE TABLE config.circ_limit_set_circ_mod_map (
 120     id          SERIAL  PRIMARY KEY,
 121     limit_set   INT     NOT NULL REFERENCES config.circ_limit_set (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 122     circ_mod    TEXT    NOT NULL REFERENCES config.circ_modifier (code) ON DELETE CASCADE ON UPDATE CASCADE DEFERRABLE INITIALLY DEFERRED,
 123     CONSTRAINT cm_once_per_set UNIQUE (limit_set, circ_mod)
 124 );
 125
 126 -- Linkage between limit sets and copy locations
 127 CREATE TABLE config.circ_limit_set_copy_loc_map (
 128     id          SERIAL  PRIMARY KEY,
 129     limit_set   INT     NOT NULL REFERENCES config.circ_limit_set (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 130     copy_loc    INT     NOT NULL REFERENCES asset.copy_location (id) ON DELETE CASCADE ON UPDATE CASCADE DEFERRABLE INITIALLY DEFERRED,
 131     CONSTRAINT cl_once_per_set UNIQUE (limit_set, copy_loc)
 132 );
 133
 134 -- Linkage between limit sets and limit groups
 135 CREATE TABLE config.circ_limit_set_group_map (
 136     id          SERIAL  PRIMARY KEY,
 137     limit_set    INT     NOT NULL REFERENCES config.circ_limit_set (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 138     limit_group INT     NOT NULL REFERENCES config.circ_limit_group (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 139     check_only  BOOL    NOT NULL DEFAULT FALSE, -- If true, don't accumulate this limit_group for storing with the circulation
 140     CONSTRAINT clg_once_per_set UNIQUE (limit_set, limit_group)
 141 );
 142
 143 -- Linkage between limit groups and circulations
 144 CREATE TABLE action.circulation_limit_group_map (
 145     circ        BIGINT      NOT NULL REFERENCES action.circulation (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 146     limit_group INT         NOT NULL REFERENCES config.circ_limit_group (id) ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
 147     PRIMARY KEY (circ, limit_group)
 148 );
 149
 150 -- Function for populating the circ/limit group mappings
 151 CREATE OR REPLACE FUNCTION action.link_circ_limit_groups ( BIGINT, INT[] ) RETURNS VOID AS $func$
 152     INSERT INTO action.circulation_limit_group_map(circ, limit_group) SELECT $1, id FROM config.circ_limit_group WHERE id IN (SELECT * FROM UNNEST($2));
 153 $func$ LANGUAGE SQL;
 154
 155 CREATE TYPE action.found_circ_matrix_matchpoint AS ( success BOOL, matchpoint config.circ_matrix_matchpoint, buildrows INT[] );
 156
 157 CREATE OR REPLACE FUNCTION action.find_circ_matrix_matchpoint( context_ou INT, item_object asset.copy, user_object actor.usr, renewal BOOL ) RETURNS action.found_circ_matrix_matchpoint AS $func$
 158 DECLARE
 159     cn_object       asset.call_number%ROWTYPE;
 160     rec_descriptor  metabib.rec_descriptor%ROWTYPE;
 161     cur_matchpoint  config.circ_matrix_matchpoint%ROWTYPE;
 162     matchpoint      config.circ_matrix_matchpoint%ROWTYPE;
 163     weights         config.circ_matrix_weights%ROWTYPE;
 164     user_age        INTERVAL;
 165     my_item_age     INTERVAL;
 166     denominator     NUMERIC(6,2);
 167     row_list        INT[];
 168     result          action.found_circ_matrix_matchpoint;
 169 BEGIN
 170     -- Assume failure
 171     result.success = false;
 172
 173     -- Fetch useful data
 174     SELECT INTO cn_object       * FROM asset.call_number        WHERE id = item_object.call_number;
 175     SELECT INTO rec_descriptor  * FROM metabib.rec_descriptor   WHERE record = cn_object.record;
 176
 177     -- Pre-generate this so we only calc it once
 178     IF user_object.dob IS NOT NULL THEN
 179         SELECT INTO user_age age(user_object.dob);
 180     END IF;
 181
 182     -- Ditto
 183     SELECT INTO my_item_age age(coalesce(item_object.active_date, now()));
 184
 185     -- Grab the closest set circ weight setting.
 186     SELECT INTO weights cw.*
 187       FROM config.weight_assoc wa
 188            JOIN config.circ_matrix_weights cw ON (cw.id = wa.circ_weights)
 189            JOIN actor.org_unit_ancestors_distance( context_ou ) d ON (wa.org_unit = d.id)
 190       WHERE active
 191       ORDER BY d.distance
 192       LIMIT 1;
 193
 194     -- No weights? Bad admin! Defaults to handle that anyway.
 195     IF weights.id IS NULL THEN
 196         weights.grp                 := 11.0;
 197         weights.org_unit            := 10.0;
 198         weights.circ_modifier       := 5.0;
 199         weights.copy_location       := 5.0;
 200         weights.marc_type           := 4.0;
 201         weights.marc_form           := 3.0;
 202         weights.marc_bib_level      := 2.0;
 203         weights.marc_vr_format      := 2.0;
 204         weights.copy_circ_lib       := 8.0;
 205         weights.copy_owning_lib     := 8.0;
 206         weights.user_home_ou        := 8.0;
 207         weights.ref_flag            := 1.0;
 208         weights.juvenile_flag       := 6.0;
 209         weights.is_renewal          := 7.0;
 210         weights.usr_age_lower_bound := 0.0;
 211         weights.usr_age_upper_bound := 0.0;
 212         weights.item_age            := 0.0;
 213     END IF;
 214
 215     -- Determine the max (expected) depth (+1) of the org tree and max depth of the permisson tree
 216     -- If you break your org tree with funky parenting this may be wrong
 217     -- Note: This CTE is duplicated in the find_hold_matrix_matchpoint function, and it may be a good idea to split it off to a function
 218     -- We use one denominator for all tree-based checks for when permission groups and org units have the same weighting
 219     WITH all_distance(distance) AS (
 220             SELECT depth AS distance FROM actor.org_unit_type
 221         UNION
 222             SELECT distance AS distance FROM permission.grp_ancestors_distance((SELECT id FROM permission.grp_tree WHERE parent IS NULL))
 223         )
 224     SELECT INTO denominator MAX(distance) + 1 FROM all_distance;
 225
 226     -- Loop over all the potential matchpoints
 227     FOR cur_matchpoint IN
 228         SELECT m.*
 229           FROM  config.circ_matrix_matchpoint m
 230                 /*LEFT*/ JOIN permission.grp_ancestors_distance( user_object.profile ) upgad ON m.grp = upgad.id
 231                 /*LEFT*/ JOIN actor.org_unit_ancestors_distance( context_ou ) ctoua ON m.org_unit = ctoua.id
 232                 LEFT JOIN actor.org_unit_ancestors_distance( cn_object.owning_lib ) cnoua ON m.copy_owning_lib = cnoua.id
 233                 LEFT JOIN actor.org_unit_ancestors_distance( item_object.circ_lib ) iooua ON m.copy_circ_lib = iooua.id
 234                 LEFT JOIN actor.org_unit_ancestors_distance( user_object.home_ou  ) uhoua ON m.user_home_ou = uhoua.id
 235           WHERE m.active
 236                 -- Permission Groups
 237              -- AND (m.grp                      IS NULL OR upgad.id IS NOT NULL) -- Optional Permission Group?
 238                 -- Org Units
 239              -- AND (m.org_unit                 IS NULL OR ctoua.id IS NOT NULL) -- Optional Org Unit?
 240                 AND (m.copy_owning_lib          IS NULL OR cnoua.id IS NOT NULL)
 241                 AND (m.copy_circ_lib            IS NULL OR iooua.id IS NOT NULL)
 242                 AND (m.user_home_ou             IS NULL OR uhoua.id IS NOT NULL)
 243                 -- Circ Type
 244                 AND (m.is_renewal               IS NULL OR m.is_renewal = renewal)
 245                 -- Static User Checks
 246                 AND (m.juvenile_flag            IS NULL OR m.juvenile_flag = user_object.juvenile)
 247                 AND (m.usr_age_lower_bound      IS NULL OR (user_age IS NOT NULL AND m.usr_age_lower_bound < user_age))
 248                 AND (m.usr_age_upper_bound      IS NULL OR (user_age IS NOT NULL AND m.usr_age_upper_bound > user_age))
 249                 -- Static Item Checks
 250                 AND (m.circ_modifier            IS NULL OR m.circ_modifier = item_object.circ_modifier)
 251                 AND (m.copy_location            IS NULL OR m.copy_location = item_object.location)
 252                 AND (m.marc_type                IS NULL OR m.marc_type = COALESCE(item_object.circ_as_type, rec_descriptor.item_type))
 253                 AND (m.marc_form                IS NULL OR m.marc_form = rec_descriptor.item_form)
 254                 AND (m.marc_bib_level           IS NULL OR m.marc_bib_level = rec_descriptor.bib_level)
 255                 AND (m.marc_vr_format           IS NULL OR m.marc_vr_format = rec_descriptor.vr_format)
 256                 AND (m.ref_flag                 IS NULL OR m.ref_flag = item_object.ref)
 257                 AND (m.item_age                 IS NULL OR (my_item_age IS NOT NULL AND m.item_age > my_item_age))
 258           ORDER BY
 259                 -- Permission Groups
 260                 CASE WHEN upgad.distance        IS NOT NULL THEN 2^(2*weights.grp - (upgad.distance/denominator)) ELSE 0.0 END +
 261                 -- Org Units
 262                 CASE WHEN ctoua.distance        IS NOT NULL THEN 2^(2*weights.org_unit - (ctoua.distance/denominator)) ELSE 0.0 END +
 263                 CASE WHEN cnoua.distance        IS NOT NULL THEN 2^(2*weights.copy_owning_lib - (cnoua.distance/denominator)) ELSE 0.0 END +
 264                 CASE WHEN iooua.distance        IS NOT NULL THEN 2^(2*weights.copy_circ_lib - (iooua.distance/denominator)) ELSE 0.0 END +
 265                 CASE WHEN uhoua.distance        IS NOT NULL THEN 2^(2*weights.user_home_ou - (uhoua.distance/denominator)) ELSE 0.0 END +
 266                 -- Circ Type                    -- Note: 4^x is equiv to 2^(2*x)
 267                 CASE WHEN m.is_renewal          IS NOT NULL THEN 4^weights.is_renewal ELSE 0.0 END +
 268                 -- Static User Checks
 269                 CASE WHEN m.juvenile_flag       IS NOT NULL THEN 4^weights.juvenile_flag ELSE 0.0 END +
 270                 CASE WHEN m.usr_age_lower_bound IS NOT NULL THEN 4^weights.usr_age_lower_bound ELSE 0.0 END +
 271                 CASE WHEN m.usr_age_upper_bound IS NOT NULL THEN 4^weights.usr_age_upper_bound ELSE 0.0 END +
 272                 -- Static Item Checks
 273                 CASE WHEN m.circ_modifier       IS NOT NULL THEN 4^weights.circ_modifier ELSE 0.0 END +
 274                 CASE WHEN m.copy_location       IS NOT NULL THEN 4^weights.copy_location ELSE 0.0 END +
 275                 CASE WHEN m.marc_type           IS NOT NULL THEN 4^weights.marc_type ELSE 0.0 END +
 276                 CASE WHEN m.marc_form           IS NOT NULL THEN 4^weights.marc_form ELSE 0.0 END +
 277                 CASE WHEN m.marc_vr_format      IS NOT NULL THEN 4^weights.marc_vr_format ELSE 0.0 END +
 278                 CASE WHEN m.ref_flag            IS NOT NULL THEN 4^weights.ref_flag ELSE 0.0 END +
 279                 -- Item age has a slight adjustment to weight based on value.
 280                 -- This should ensure that a shorter age limit comes first when all else is equal.
 281                 -- NOTE: This assumes that intervals will normally be in days.
 282                 CASE WHEN m.item_age            IS NOT NULL THEN 4^weights.item_age - 1 + 86400/EXTRACT(EPOCH FROM m.item_age) ELSE 0.0 END DESC,
 283                 -- Final sort on id, so that if two rules have the same sorting in the previous sort they have a defined order
 284                 -- This prevents "we changed the table order by updating a rule, and we started getting different results"
 285                 m.id LOOP
 286
 287         -- Record the full matching row list
 288         row_list := row_list || cur_matchpoint.id;
 289
 290         -- No matchpoint yet?
 291         IF matchpoint.id IS NULL THEN
 292             -- Take the entire matchpoint as a starting point
 293             matchpoint := cur_matchpoint;
 294             CONTINUE; -- No need to look at this row any more.
 295         END IF;
 296
 297         -- Incomplete matchpoint?
 298         IF matchpoint.circulate IS NULL THEN
 299             matchpoint.circulate := cur_matchpoint.circulate;
 300         END IF;
 301         IF matchpoint.duration_rule IS NULL THEN
 302             matchpoint.duration_rule := cur_matchpoint.duration_rule;
 303         END IF;
 304         IF matchpoint.recurring_fine_rule IS NULL THEN
 305             matchpoint.recurring_fine_rule := cur_matchpoint.recurring_fine_rule;
 306         END IF;
 307         IF matchpoint.max_fine_rule IS NULL THEN
 308             matchpoint.max_fine_rule := cur_matchpoint.max_fine_rule;
 309         END IF;
 310         IF matchpoint.hard_due_date IS NULL THEN
 311             matchpoint.hard_due_date := cur_matchpoint.hard_due_date;
 312         END IF;
 313         IF matchpoint.total_copy_hold_ratio IS NULL THEN
 314             matchpoint.total_copy_hold_ratio := cur_matchpoint.total_copy_hold_ratio;
 315         END IF;
 316         IF matchpoint.available_copy_hold_ratio IS NULL THEN
 317             matchpoint.available_copy_hold_ratio := cur_matchpoint.available_copy_hold_ratio;
 318         END IF;
 319         IF matchpoint.renewals IS NULL THEN
 320             matchpoint.renewals := cur_matchpoint.renewals;
 321         END IF;
 322         IF matchpoint.grace_period IS NULL THEN
 323             matchpoint.grace_period := cur_matchpoint.grace_period;
 324         END IF;
 325     END LOOP;
 326
 327     -- Check required fields
 328     IF matchpoint.circulate             IS NOT NULL AND
 329        matchpoint.duration_rule         IS NOT NULL AND
 330        matchpoint.recurring_fine_rule   IS NOT NULL AND
 331        matchpoint.max_fine_rule         IS NOT NULL THEN
 332         -- All there? We have a completed match.
 333         result.success := true;
 334     END IF;
 335
 336     -- Include the assembled matchpoint, even if it isn't complete
 337     result.matchpoint := matchpoint;
 338
 339     -- Include (for debugging) the full list of matching rows
 340     result.buildrows := row_list;
 341
 342     -- Hand the result back to caller
 343     RETURN result;
 344 END;
 345 $func$ LANGUAGE plpgsql;
 346
 347 -- Helper function - For manual calling, it can be easier to pass in IDs instead of objects
 348 CREATE OR REPLACE FUNCTION action.find_circ_matrix_matchpoint( context_ou INT, match_item BIGINT, match_user INT, renewal BOOL ) RETURNS SETOF action.found_circ_matrix_matchpoint AS $func$
 349 DECLARE
 350     item_object asset.copy%ROWTYPE;
 351     user_object actor.usr%ROWTYPE;
 352 BEGIN
 353     SELECT INTO item_object * FROM asset.copy   WHERE id = match_item;
 354     SELECT INTO user_object * FROM actor.usr    WHERE id = match_user;
 355
 356     RETURN QUERY SELECT * FROM action.find_circ_matrix_matchpoint( context_ou, item_object, user_object, renewal );
 357 END;
 358 $func$ LANGUAGE plpgsql;
 359
 360 CREATE TYPE action.hold_stats AS (
 361     hold_count              INT,
 362     copy_count              INT,
 363     available_count         INT,
 364     total_copy_ratio        FLOAT,
 365     available_copy_ratio    FLOAT
 366 );
 367
 368 CREATE OR REPLACE FUNCTION action.copy_related_hold_stats (copy_id BIGINT) RETURNS action.hold_stats AS $func$
 369 DECLARE
 370     output          action.hold_stats%ROWTYPE;
 371     hold_count      INT := 0;
 372     copy_count      INT := 0;
 373     available_count INT := 0;
 374     hold_map_data   RECORD;
 375 BEGIN
 376
 377     output.hold_count := 0;
 378     output.copy_count := 0;
 379     output.available_count := 0;
 380
 381     SELECT  COUNT( DISTINCT m.hold ) INTO hold_count
 382       FROM  action.hold_copy_map m
 383             JOIN action.hold_request h ON (m.hold = h.id)
 384       WHERE m.target_copy = copy_id
 385             AND NOT h.frozen;
 386
 387     output.hold_count := hold_count;
 388
 389     IF output.hold_count > 0 THEN
 390         FOR hold_map_data IN
 391             SELECT  DISTINCT m.target_copy,
 392                     acp.status
 393               FROM  action.hold_copy_map m
 394                     JOIN asset.copy acp ON (m.target_copy = acp.id)
 395                     JOIN action.hold_request h ON (m.hold = h.id)
 396               WHERE m.hold IN ( SELECT DISTINCT hold FROM action.hold_copy_map WHERE target_copy = copy_id ) AND NOT h.frozen
 397         LOOP
 398             output.copy_count := output.copy_count + 1;
 399             IF hold_map_data.status IN (0,7,12) THEN
 400                 output.available_count := output.available_count + 1;
 401             END IF;
 402         END LOOP;
 403         output.total_copy_ratio = output.copy_count::FLOAT / output.hold_count::FLOAT;
 404         output.available_copy_ratio = output.available_count::FLOAT / output.hold_count::FLOAT;
 405
 406     END IF;
 407
 408     RETURN output;
 409
 410 END;
 411 $func$ LANGUAGE PLPGSQL;
 412
 413 CREATE TYPE action.circ_matrix_test_result AS ( success BOOL, fail_part TEXT, buildrows INT[], matchpoint INT, circulate BOOL, duration_rule INT, recurring_fine_rule INT, max_fine_rule INT, hard_due_date INT, renewals INT, grace_period INTERVAL, limit_groups INT[] );
 414 CREATE OR REPLACE FUNCTION action.item_user_circ_test( circ_ou INT, match_item BIGINT, match_user INT, renewal BOOL ) RETURNS SETOF action.circ_matrix_test_result AS $func$
 415 DECLARE
 416     user_object             actor.usr%ROWTYPE;
 417     standing_penalty        config.standing_penalty%ROWTYPE;
 418     item_object             asset.copy%ROWTYPE;
 419     item_status_object      config.copy_status%ROWTYPE;
 420     item_location_object    asset.copy_location%ROWTYPE;
 421     result                  action.circ_matrix_test_result;
 422     circ_test               action.found_circ_matrix_matchpoint;
 423     circ_matchpoint         config.circ_matrix_matchpoint%ROWTYPE;
 424     circ_limit_set          config.circ_limit_set%ROWTYPE;
 425     hold_ratio              action.hold_stats%ROWTYPE;
 426     penalty_type            TEXT;
 427     items_out               INT;
 428     context_org_list        INT[];
 429     done                    BOOL := FALSE;
 430 BEGIN
 431     -- Assume success unless we hit a failure condition
 432     result.success := TRUE;
 433
 434     -- Need user info to look up matchpoints
 435     SELECT INTO user_object * FROM actor.usr WHERE id = match_user AND NOT deleted;
 436
 437     -- (Insta)Fail if we couldn't find the user
 438     IF user_object.id IS NULL THEN
 439         result.fail_part := 'no_user';
 440         result.success := FALSE;
 441         done := TRUE;
 442         RETURN NEXT result;
 443         RETURN;
 444     END IF;
 445
 446     -- Need item info to look up matchpoints
 447     SELECT INTO item_object * FROM asset.copy WHERE id = match_item AND NOT deleted;
 448
 449     -- (Insta)Fail if we couldn't find the item
 450     IF item_object.id IS NULL THEN
 451         result.fail_part := 'no_item';
 452         result.success := FALSE;
 453         done := TRUE;
 454         RETURN NEXT result;
 455         RETURN;
 456     END IF;
 457
 458     SELECT INTO circ_test * FROM action.find_circ_matrix_matchpoint(circ_ou, item_object, user_object, renewal);
 459
 460     circ_matchpoint             := circ_test.matchpoint;
 461     result.matchpoint           := circ_matchpoint.id;
 462     result.circulate            := circ_matchpoint.circulate;
 463     result.duration_rule        := circ_matchpoint.duration_rule;
 464     result.recurring_fine_rule  := circ_matchpoint.recurring_fine_rule;
 465     result.max_fine_rule        := circ_matchpoint.max_fine_rule;
 466     result.hard_due_date        := circ_matchpoint.hard_due_date;
 467     result.renewals             := circ_matchpoint.renewals;
 468     result.grace_period         := circ_matchpoint.grace_period;
 469     result.buildrows            := circ_test.buildrows;
 470
 471     -- (Insta)Fail if we couldn't find a matchpoint
 472     IF circ_test.success = false THEN
 473         result.fail_part := 'no_matchpoint';
 474         result.success := FALSE;
 475         done := TRUE;
 476         RETURN NEXT result;
 477         RETURN;
 478     END IF;
 479
 480     -- All failures before this point are non-recoverable
 481     -- Below this point are possibly overridable failures
 482
 483     -- Fail if the user is barred
 484     IF user_object.barred IS TRUE THEN
 485         result.fail_part := 'actor.usr.barred';
 486         result.success := FALSE;
 487         done := TRUE;
 488         RETURN NEXT result;
 489     END IF;
 490
 491     -- Fail if the item can't circulate
 492     IF item_object.circulate IS FALSE THEN
 493         result.fail_part := 'asset.copy.circulate';
 494         result.success := FALSE;
 495         done := TRUE;
 496         RETURN NEXT result;
 497     END IF;
 498
 499     -- Fail if the item isn't in a circulateable status on a non-renewal
 500     IF NOT renewal AND item_object.status NOT IN ( 0, 7, 8 ) THEN
 501         result.fail_part := 'asset.copy.status';
 502         result.success := FALSE;
 503         done := TRUE;
 504         RETURN NEXT result;
 505     -- Alternately, fail if the item isn't checked out on a renewal
 506     ELSIF renewal AND item_object.status <> 1 THEN
 507         result.fail_part := 'asset.copy.status';
 508         result.success := FALSE;
 509         done := TRUE;
 510         RETURN NEXT result;
 511     END IF;
 512
 513     -- Fail if the item can't circulate because of the shelving location
 514     SELECT INTO item_location_object * FROM asset.copy_location WHERE id = item_object.location;
 515     IF item_location_object.circulate IS FALSE THEN
 516         result.fail_part := 'asset.copy_location.circulate';
 517         result.success := FALSE;
 518         done := TRUE;
 519         RETURN NEXT result;
 520     END IF;
 521
 522     -- Use Circ OU for penalties and such
 523     SELECT INTO context_org_list ARRAY_AGG(id) FROM actor.org_unit_full_path( circ_ou );
 524
 525     IF renewal THEN
 526         penalty_type = '%RENEW%';
 527     ELSE
 528         penalty_type = '%CIRC%';
 529     END IF;
 530
 531     FOR standing_penalty IN
 532         SELECT  DISTINCT csp.*
 533           FROM  actor.usr_standing_penalty usp
 534                 JOIN config.standing_penalty csp ON (csp.id = usp.standing_penalty)
 535           WHERE usr = match_user
 536                 AND usp.org_unit IN ( SELECT * FROM unnest(context_org_list) )
 537                 AND (usp.stop_date IS NULL or usp.stop_date > NOW())
 538                 AND csp.block_list LIKE penalty_type LOOP
 539
 540         result.fail_part := standing_penalty.name;
 541         result.success := FALSE;
 542         done := TRUE;
 543         RETURN NEXT result;
 544     END LOOP;
 545
 546     -- Fail if the test is set to hard non-circulating
 547     IF circ_matchpoint.circulate IS FALSE THEN
 548         result.fail_part := 'config.circ_matrix_test.circulate';
 549         result.success := FALSE;
 550         done := TRUE;
 551         RETURN NEXT result;
 552     END IF;
 553
 554     -- Fail if the total copy-hold ratio is too low
 555     IF circ_matchpoint.total_copy_hold_ratio IS NOT NULL THEN
 556         SELECT INTO hold_ratio * FROM action.copy_related_hold_stats(match_item);
 557         IF hold_ratio.total_copy_ratio IS NOT NULL AND hold_ratio.total_copy_ratio < circ_matchpoint.total_copy_hold_ratio THEN
 558             result.fail_part := 'config.circ_matrix_test.total_copy_hold_ratio';
 559             result.success := FALSE;
 560             done := TRUE;
 561             RETURN NEXT result;
 562         END IF;
 563     END IF;
 564
 565     -- Fail if the available copy-hold ratio is too low
 566     IF circ_matchpoint.available_copy_hold_ratio IS NOT NULL THEN
 567         IF hold_ratio.hold_count IS NULL THEN
 568             SELECT INTO hold_ratio * FROM action.copy_related_hold_stats(match_item);
 569         END IF;
 570         IF hold_ratio.available_copy_ratio IS NOT NULL AND hold_ratio.available_copy_ratio < circ_matchpoint.available_copy_hold_ratio THEN
 571             result.fail_part := 'config.circ_matrix_test.available_copy_hold_ratio';
 572             result.success := FALSE;
 573             done := TRUE;
 574             RETURN NEXT result;
 575         END IF;
 576     END IF;
 577
 578     -- Fail if the user has too many items out by defined limit sets
 579     FOR circ_limit_set IN SELECT ccls.* FROM config.circ_limit_set ccls
 580       JOIN config.circ_matrix_limit_set_map ccmlsm ON ccmlsm.limit_set = ccls.id
 581       WHERE ccmlsm.active AND ( ccmlsm.matchpoint = circ_matchpoint.id OR
 582         ( ccmlsm.matchpoint IN (SELECT * FROM unnest(result.buildrows)) AND ccmlsm.fallthrough )
 583         ) LOOP
 584             IF circ_limit_set.items_out > 0 AND NOT renewal THEN
 585                 SELECT INTO context_org_list ARRAY_AGG(aou.id)
 586                   FROM actor.org_unit_full_path( circ_ou ) aou
 587                     JOIN actor.org_unit_type aout ON aou.ou_type = aout.id
 588                   WHERE aout.depth >= circ_limit_set.depth;
 589                 IF circ_limit_set.global THEN
 590                     WITH RECURSIVE descendant_depth AS (
 591                         SELECT  ou.id,
 592                             ou.parent_ou
 593                         FROM  actor.org_unit ou
 594                         WHERE ou.id IN (SELECT * FROM unnest(context_org_list))
 595                             UNION
 596                         SELECT  ou.id,
 597                             ou.parent_ou
 598                         FROM  actor.org_unit ou
 599                             JOIN descendant_depth ot ON (ot.id = ou.parent_ou)
 600                     ) SELECT INTO context_org_list ARRAY_AGG(ou.id) FROM actor.org_unit ou JOIN descendant_depth USING (id);
 601                 END IF;
 602                 SELECT INTO items_out COUNT(DISTINCT circ.id)
 603                   FROM action.circulation circ
 604                     JOIN asset.copy copy ON (copy.id = circ.target_copy)
 605                     LEFT JOIN action.circulation_limit_group_map aclgm ON (circ.id = aclgm.circ)
 606                   WHERE circ.usr = match_user
 607                     AND circ.circ_lib IN (SELECT * FROM unnest(context_org_list))
 608                     AND circ.checkin_time IS NULL
 609                     AND (circ.stop_fines IN ('MAXFINES','LONGOVERDUE') OR circ.stop_fines IS NULL)
 610                     AND (copy.circ_modifier IN (SELECT circ_mod FROM config.circ_limit_set_circ_mod_map WHERE limit_set = circ_limit_set.id)
 611                         OR copy.location IN (SELECT copy_loc FROM config.circ_limit_set_copy_loc_map WHERE limit_set = circ_limit_set.id)
 612                         OR aclgm.limit_group IN (SELECT limit_group FROM config.circ_limit_set_group_map WHERE limit_set = circ_limit_set.id)
 613                     );
 614                 IF items_out >= circ_limit_set.items_out THEN
 615                     result.fail_part := 'config.circ_matrix_circ_mod_test';
 616                     result.success := FALSE;
 617                     done := TRUE;
 618                     RETURN NEXT result;
 619                 END IF;
 620             END IF;
 621             SELECT INTO result.limit_groups result.limit_groups || ARRAY_AGG(limit_group) FROM config.circ_limit_set_group_map WHERE limit_set = circ_limit_set.id AND NOT check_only;
 622     END LOOP;
 623
 624     -- If we passed everything, return the successful matchpoint
 625     IF NOT done THEN
 626         RETURN NEXT result;
 627     END IF;
 628
 629     RETURN;
 630 END;
 631 $func$ LANGUAGE plpgsql;
 632
 633 CREATE OR REPLACE FUNCTION action.item_user_circ_test( INT, BIGINT, INT ) RETURNS SETOF action.circ_matrix_test_result AS $func$
 634     SELECT * FROM action.item_user_circ_test( $1, $2, $3, FALSE );
 635 $func$ LANGUAGE SQL;
 636
 637 CREATE OR REPLACE FUNCTION action.item_user_renew_test( INT, BIGINT, INT ) RETURNS SETOF action.circ_matrix_test_result AS $func$
 638     SELECT * FROM action.item_user_circ_test( $1, $2, $3, TRUE );
 639 $func$ LANGUAGE SQL;
 640
 641 CREATE OR REPLACE FUNCTION actor.calculate_system_penalties( match_user INT, context_org INT ) RETURNS SETOF actor.usr_standing_penalty AS $func$
 642 DECLARE
 643     user_object         actor.usr%ROWTYPE;
 644     new_sp_row          actor.usr_standing_penalty%ROWTYPE;
 645     existing_sp_row     actor.usr_standing_penalty%ROWTYPE;
 646     collections_fines   permission.grp_penalty_threshold%ROWTYPE;
 647     max_fines           permission.grp_penalty_threshold%ROWTYPE;
 648     max_overdue         permission.grp_penalty_threshold%ROWTYPE;
 649     max_items_out       permission.grp_penalty_threshold%ROWTYPE;
 650     max_lost            permission.grp_penalty_threshold%ROWTYPE;
 651     max_longoverdue     permission.grp_penalty_threshold%ROWTYPE;
 652     tmp_grp             INT;
 653     items_overdue       INT;
 654     items_out           INT;
 655     items_lost          INT;
 656     items_longoverdue   INT;
 657     context_org_list    INT[];
 658     current_fines        NUMERIC(8,2) := 0.0;
 659     tmp_fines            NUMERIC(8,2);
 660     tmp_groc            RECORD;
 661     tmp_circ            RECORD;
 662     tmp_org             actor.org_unit%ROWTYPE;
 663     tmp_penalty         config.standing_penalty%ROWTYPE;
 664     tmp_depth           INTEGER;
 665 BEGIN
 666     SELECT INTO user_object * FROM actor.usr WHERE id = match_user;
 667
 668     -- Max fines
 669     SELECT INTO tmp_org * FROM actor.org_unit WHERE id = context_org;
 670
 671     -- Fail if the user has a high fine balance
 672     LOOP
 673         tmp_grp := user_object.profile;
 674         LOOP
 675             SELECT * INTO max_fines FROM permission.grp_penalty_threshold WHERE grp = tmp_grp AND penalty = 1 AND org_unit = tmp_org.id;
 676
 677             IF max_fines.threshold IS NULL THEN
 678                 SELECT parent INTO tmp_grp FROM permission.grp_tree WHERE id = tmp_grp;
 679             ELSE
 680                 EXIT;
 681             END IF;
 682
 683             IF tmp_grp IS NULL THEN
 684                 EXIT;
 685             END IF;
 686         END LOOP;
 687
 688         IF max_fines.threshold IS NOT NULL OR tmp_org.parent_ou IS NULL THEN
 689             EXIT;
 690         END IF;
 691
 692         SELECT * INTO tmp_org FROM actor.org_unit WHERE id = tmp_org.parent_ou;
 693
 694     END LOOP;
 695
 696     IF max_fines.threshold IS NOT NULL THEN
 697
 698         RETURN QUERY
 699             SELECT  *
 700               FROM  actor.usr_standing_penalty
 701               WHERE usr = match_user
 702                     AND org_unit = max_fines.org_unit
 703                     AND (stop_date IS NULL or stop_date > NOW())
 704                     AND standing_penalty = 1;
 705
 706         SELECT INTO context_org_list ARRAY_AGG(id) FROM actor.org_unit_full_path( max_fines.org_unit );
 707
 708         SELECT  SUM(f.balance_owed) INTO current_fines
 709           FROM  money.materialized_billable_xact_summary f
 710                 JOIN (
 711                     SELECT  r.id
 712                       FROM  booking.reservation r
 713                       WHERE r.usr = match_user
 714                             AND r.pickup_lib IN (SELECT * FROM unnest(context_org_list))
 715                             AND xact_finish IS NULL
 716                                 UNION ALL
 717                     SELECT  g.id
 718                       FROM  money.grocery g
 719                       WHERE g.usr = match_user
 720                             AND g.billing_location IN (SELECT * FROM unnest(context_org_list))
 721                             AND xact_finish IS NULL
 722                                 UNION ALL
 723                     SELECT  circ.id
 724                       FROM  action.circulation circ
 725                       WHERE circ.usr = match_user
 726                             AND circ.circ_lib IN (SELECT * FROM unnest(context_org_list))
 727                             AND xact_finish IS NULL ) l USING (id);
 728
 729         IF current_fines >= max_fines.threshold THEN
 730             new_sp_row.usr := match_user;
 731             new_sp_row.org_unit := max_fines.org_unit;
 732             new_sp_row.standing_penalty := 1;
 733             RETURN NEXT new_sp_row;
 734         END IF;
 735     END IF;
 736
 737     -- Start over for max overdue
 738     SELECT INTO tmp_org * FROM actor.org_unit WHERE id = context_org;
 739
 740     -- Fail if the user has too many overdue items
 741     LOOP
 742         tmp_grp := user_object.profile;
 743         LOOP
 744
 745             SELECT * INTO max_overdue FROM permission.grp_penalty_threshold WHERE grp = tmp_grp AND penalty = 2 AND org_unit = tmp_org.id;
 746
 747             IF max_overdue.threshold IS NULL THEN
 748                 SELECT parent INTO tmp_grp FROM permission.grp_tree WHERE id = tmp_grp;
 749             ELSE
 750                 EXIT;
 751             END IF;
 752
 753             IF tmp_grp IS NULL THEN
 754                 EXIT;
 755             END IF;
 756         END LOOP;
 757
 758         IF max_overdue.threshold IS NOT NULL OR tmp_org.parent_ou IS NULL THEN
 759             EXIT;
 760         END IF;
 761
 762         SELECT INTO tmp_org * FROM actor.org_unit WHERE id = tmp_org.parent_ou;
 763
 764     END LOOP;
 765
 766     IF max_overdue.threshold IS NOT NULL THEN
 767
 768         RETURN QUERY
 769             SELECT  *
 770               FROM  actor.usr_standing_penalty
 771               WHERE usr = match_user
 772                     AND org_unit = max_overdue.org_unit
 773                     AND (stop_date IS NULL or stop_date > NOW())
 774                     AND standing_penalty = 2;
 775
 776         SELECT  INTO items_overdue COUNT(*)
 777           FROM  action.circulation circ
 778                 JOIN  actor.org_unit_full_path( max_overdue.org_unit ) fp ON (circ.circ_lib = fp.id)
 779           WHERE circ.usr = match_user
 780             AND circ.checkin_time IS NULL
 781             AND circ.due_date < NOW()
 782             AND (circ.stop_fines = 'MAXFINES' OR circ.stop_fines IS NULL);
 783
 784         IF items_overdue >= max_overdue.threshold::INT THEN
 785             new_sp_row.usr := match_user;
 786             new_sp_row.org_unit := max_overdue.org_unit;
 787             new_sp_row.standing_penalty := 2;
 788             RETURN NEXT new_sp_row;
 789         END IF;
 790     END IF;
 791
 792     -- Start over for max out
 793     SELECT INTO tmp_org * FROM actor.org_unit WHERE id = context_org;
 794
 795     -- Fail if the user has too many checked out items
 796     LOOP
 797         tmp_grp := user_object.profile;
 798         LOOP
 799             SELECT * INTO max_items_out FROM permission.grp_penalty_threshold WHERE grp = tmp_grp AND penalty = 3 AND org_unit = tmp_org.id;
 800
 801             IF max_items_out.threshold IS NULL THEN
 802                 SELECT parent INTO tmp_grp FROM permission.grp_tree WHERE id = tmp_grp;
 803             ELSE
 804                 EXIT;
 805             END IF;
 806
 807             IF tmp_grp IS NULL THEN
 808                 EXIT;
 809             END IF;
 810         END LOOP;
 811
 812         IF max_items_out.threshold IS NOT NULL OR tmp_org.parent_ou IS NULL THEN
 813             EXIT;
 814         END IF;
 815
 816         SELECT INTO tmp_org * FROM actor.org_unit WHERE id = tmp_org.parent_ou;
 817
 818     END LOOP;
 819
 820
 821     -- Fail if the user has too many items checked out
 822     IF max_items_out.threshold IS NOT NULL THEN
 823
 824         RETURN QUERY
 825             SELECT  *
 826               FROM  actor.usr_standing_penalty
 827               WHERE usr = match_user
 828                     AND org_unit = max_items_out.org_unit
 829                     AND (stop_date IS NULL or stop_date > NOW())
 830                     AND standing_penalty = 3;
 831
 832         SELECT  INTO items_out COUNT(*)
 833           FROM  action.circulation circ
 834                 JOIN  actor.org_unit_full_path( max_items_out.org_unit ) fp ON (circ.circ_lib = fp.id)
 835           WHERE circ.usr = match_user
 836                 AND circ.checkin_time IS NULL
 837                 AND (circ.stop_fines IN (
 838                     SELECT 'MAXFINES'::TEXT
 839                     UNION ALL
 840                     SELECT 'LONGOVERDUE'::TEXT
 841                     UNION ALL
 842                     SELECT 'LOST'::TEXT
 843                     WHERE 'true' ILIKE
 844                     (
 845                         SELECT CASE
 846                             WHEN (SELECT value FROM actor.org_unit_ancestor_setting('circ.tally_lost', circ.circ_lib)) ILIKE 'true' THEN 'true'
 847                             ELSE 'false'
 848                         END
 849                     )
 850                     UNION ALL
 851                     SELECT 'CLAIMSRETURNED'::TEXT
 852                     WHERE 'false' ILIKE
 853                     (
 854                         SELECT CASE
 855                             WHEN (SELECT value FROM actor.org_unit_ancestor_setting('circ.do_not_tally_claims_returned', circ.circ_lib)) ILIKE 'true' THEN 'true'
 856                             ELSE 'false'
 857                         END
 858                     )
 859                     ) OR circ.stop_fines IS NULL)
 860                 AND xact_finish IS NULL;
 861
 862            IF items_out >= max_items_out.threshold::INT THEN
 863             new_sp_row.usr := match_user;
 864             new_sp_row.org_unit := max_items_out.org_unit;
 865             new_sp_row.standing_penalty := 3;
 866             RETURN NEXT new_sp_row;
 867            END IF;
 868     END IF;
 869
 870     -- Start over for max lost
 871     SELECT INTO tmp_org * FROM actor.org_unit WHERE id = context_org;
 872
 873     -- Fail if the user has too many lost items
 874     LOOP
 875         tmp_grp := user_object.profile;
 876         LOOP
 877
 878             SELECT * INTO max_lost FROM permission.grp_penalty_threshold WHERE grp = tmp_grp AND penalty = 5 AND org_unit = tmp_org.id;
 879
 880             IF max_lost.threshold IS NULL THEN
 881                 SELECT parent INTO tmp_grp FROM permission.grp_tree WHERE id = tmp_grp;
 882             ELSE
 883                 EXIT;
 884             END IF;
 885
 886             IF tmp_grp IS NULL THEN
 887                 EXIT;
 888             END IF;
 889         END LOOP;
 890
 891         IF max_lost.threshold IS NOT NULL OR tmp_org.parent_ou IS NULL THEN
 892             EXIT;
 893         END IF;
 894
 895         SELECT INTO tmp_org * FROM actor.org_unit WHERE id = tmp_org.parent_ou;
 896
 897     END LOOP;
 898
 899     IF max_lost.threshold IS NOT NULL THEN
 900
 901         RETURN QUERY
 902             SELECT  *
 903             FROM  actor.usr_standing_penalty
 904             WHERE usr = match_user
 905                 AND org_unit = max_lost.org_unit
 906                 AND (stop_date IS NULL or stop_date > NOW())
 907                 AND standing_penalty = 5;
 908
 909         SELECT  INTO items_lost COUNT(*)
 910         FROM  action.circulation circ
 911             JOIN  actor.org_unit_full_path( max_lost.org_unit ) fp ON (circ.circ_lib = fp.id)
 912         WHERE circ.usr = match_user
 913             AND circ.checkin_time IS NULL
 914             AND (circ.stop_fines = 'LOST')
 915             AND xact_finish IS NULL;
 916
 917         IF items_lost >= max_lost.threshold::INT AND 0 < max_lost.threshold::INT THEN
 918             new_sp_row.usr := match_user;
 919             new_sp_row.org_unit := max_lost.org_unit;
 920             new_sp_row.standing_penalty := 5;
 921             RETURN NEXT new_sp_row;
 922         END IF;
 923     END IF;
 924
 925     -- Start over for max longoverdue
 926     SELECT INTO tmp_org * FROM actor.org_unit WHERE id = context_org;
 927
 928     -- Fail if the user has too many longoverdue items
 929     LOOP
 930         tmp_grp := user_object.profile;
 931         LOOP
 932
 933             SELECT * INTO max_longoverdue
 934                 FROM permission.grp_penalty_threshold
 935                 WHERE grp = tmp_grp AND
 936                     penalty = 35 AND
 937                     org_unit = tmp_org.id;
 938
 939             IF max_longoverdue.threshold IS NULL THEN
 940                 SELECT parent INTO tmp_grp
 941                     FROM permission.grp_tree WHERE id = tmp_grp;
 942             ELSE
 943                 EXIT;
 944             END IF;
 945
 946             IF tmp_grp IS NULL THEN
 947                 EXIT;
 948             END IF;
 949         END LOOP;
 950
 951         IF max_longoverdue.threshold IS NOT NULL
 952                 OR tmp_org.parent_ou IS NULL THEN
 953             EXIT;
 954         END IF;
 955
 956         SELECT INTO tmp_org * FROM actor.org_unit WHERE id = tmp_org.parent_ou;
 957
 958     END LOOP;
 959
 960     IF max_longoverdue.threshold IS NOT NULL THEN
 961
 962         RETURN QUERY
 963             SELECT  *
 964             FROM  actor.usr_standing_penalty
 965             WHERE usr = match_user
 966                 AND org_unit = max_longoverdue.org_unit
 967                 AND (stop_date IS NULL or stop_date > NOW())
 968                 AND standing_penalty = 35;
 969
 970         SELECT INTO items_longoverdue COUNT(*)
 971         FROM action.circulation circ
 972             JOIN actor.org_unit_full_path( max_longoverdue.org_unit ) fp
 973                 ON (circ.circ_lib = fp.id)
 974         WHERE circ.usr = match_user
 975             AND circ.checkin_time IS NULL
 976             AND (circ.stop_fines = 'LONGOVERDUE')
 977             AND xact_finish IS NULL;
 978
 979         IF items_longoverdue >= max_longoverdue.threshold::INT
 980                 AND 0 < max_longoverdue.threshold::INT THEN
 981             new_sp_row.usr := match_user;
 982             new_sp_row.org_unit := max_longoverdue.org_unit;
 983             new_sp_row.standing_penalty := 35;
 984             RETURN NEXT new_sp_row;
 985         END IF;
 986     END IF;
 987
 988
 989     -- Start over for collections warning
 990     SELECT INTO tmp_org * FROM actor.org_unit WHERE id = context_org;
 991
 992     -- Fail if the user has a collections-level fine balance
 993     LOOP
 994         tmp_grp := user_object.profile;
 995         LOOP
 996             SELECT * INTO max_fines FROM permission.grp_penalty_threshold WHERE grp = tmp_grp AND penalty = 4 AND org_unit = tmp_org.id;
 997
 998             IF max_fines.threshold IS NULL THEN
 999                 SELECT parent INTO tmp_grp FROM permission.grp_tree WHERE id = tmp_grp;
1000             ELSE
1001                 EXIT;
1002             END IF;
1003
1004             IF tmp_grp IS NULL THEN
1005                 EXIT;
1006             END IF;
1007         END LOOP;
1008
1009         IF max_fines.threshold IS NOT NULL OR tmp_org.parent_ou IS NULL THEN
1010             EXIT;
1011         END IF;
1012
1013         SELECT * INTO tmp_org FROM actor.org_unit WHERE id = tmp_org.parent_ou;
1014
1015     END LOOP;
1016
1017     IF max_fines.threshold IS NOT NULL THEN
1018
1019         RETURN QUERY
1020             SELECT  *
1021               FROM  actor.usr_standing_penalty
1022               WHERE usr = match_user
1023                     AND org_unit = max_fines.org_unit
1024                     AND (stop_date IS NULL or stop_date > NOW())
1025                     AND standing_penalty = 4;
1026
1027         SELECT INTO context_org_list ARRAY_AGG(id) FROM actor.org_unit_full_path( max_fines.org_unit );
1028
1029         SELECT  SUM(f.balance_owed) INTO current_fines
1030           FROM  money.materialized_billable_xact_summary f
1031                 JOIN (
1032                     SELECT  r.id
1033                       FROM  booking.reservation r
1034                       WHERE r.usr = match_user
1035                             AND r.pickup_lib IN (SELECT * FROM unnest(context_org_list))
1036                             AND r.xact_finish IS NULL
1037                                 UNION ALL
1038                     SELECT  g.id
1039                       FROM  money.grocery g
1040                       WHERE g.usr = match_user
1041                             AND g.billing_location IN (SELECT * FROM unnest(context_org_list))
1042                             AND g.xact_finish IS NULL
1043                                 UNION ALL
1044                     SELECT  circ.id
1045                       FROM  action.circulation circ
1046                       WHERE circ.usr = match_user
1047                             AND circ.circ_lib IN (SELECT * FROM unnest(context_org_list))
1048                             AND circ.xact_finish IS NULL ) l USING (id);
1049
1050         IF current_fines >= max_fines.threshold THEN
1051             new_sp_row.usr := match_user;
1052             new_sp_row.org_unit := max_fines.org_unit;
1053             new_sp_row.standing_penalty := 4;
1054             RETURN NEXT new_sp_row;
1055         END IF;
1056     END IF;
1057
1058     -- Start over for in collections
1059     SELECT INTO tmp_org * FROM actor.org_unit WHERE id = context_org;
1060
1061     -- Remove the in-collections penalty if the user has paid down enough
1062     -- This penalty is different, because this code is not responsible for creating
1063     -- new in-collections penalties, only for removing them
1064     LOOP
1065         tmp_grp := user_object.profile;
1066         LOOP
1067             SELECT * INTO max_fines FROM permission.grp_penalty_threshold WHERE grp = tmp_grp AND penalty = 30 AND org_unit = tmp_org.id;
1068
1069             IF max_fines.threshold IS NULL THEN
1070                 SELECT parent INTO tmp_grp FROM permission.grp_tree WHERE id = tmp_grp;
1071             ELSE
1072                 EXIT;
1073             END IF;
1074
1075             IF tmp_grp IS NULL THEN
1076                 EXIT;
1077             END IF;
1078         END LOOP;
1079
1080         IF max_fines.threshold IS NOT NULL OR tmp_org.parent_ou IS NULL THEN
1081             EXIT;
1082         END IF;
1083
1084         SELECT * INTO tmp_org FROM actor.org_unit WHERE id = tmp_org.parent_ou;
1085
1086     END LOOP;
1087
1088     IF max_fines.threshold IS NOT NULL THEN
1089
1090         SELECT INTO context_org_list ARRAY_AGG(id) FROM actor.org_unit_full_path( max_fines.org_unit );
1091
1092         -- first, see if the user had paid down to the threshold
1093         SELECT  SUM(f.balance_owed) INTO current_fines
1094           FROM  money.materialized_billable_xact_summary f
1095                 JOIN (
1096                     SELECT  r.id
1097                       FROM  booking.reservation r
1098                       WHERE r.usr = match_user
1099                             AND r.pickup_lib IN (SELECT * FROM unnest(context_org_list))
1100                             AND r.xact_finish IS NULL
1101                                 UNION ALL
1102                     SELECT  g.id
1103                       FROM  money.grocery g
1104                       WHERE g.usr = match_user
1105                             AND g.billing_location IN (SELECT * FROM unnest(context_org_list))
1106                             AND g.xact_finish IS NULL
1107                                 UNION ALL
1108                     SELECT  circ.id
1109                       FROM  action.circulation circ
1110                       WHERE circ.usr = match_user
1111                             AND circ.circ_lib IN (SELECT * FROM unnest(context_org_list))
1112                             AND circ.xact_finish IS NULL ) l USING (id);
1113
1114         IF current_fines IS NULL OR current_fines <= max_fines.threshold THEN
1115             -- patron has paid down enough
1116
1117             SELECT INTO tmp_penalty * FROM config.standing_penalty WHERE id = 30;
1118
1119             IF tmp_penalty.org_depth IS NOT NULL THEN
1120
1121                 -- since this code is not responsible for applying the penalty, it can't
1122                 -- guarantee the current context org will match the org at which the penalty
1123                 --- was applied.  search up the org tree until we hit the configured penalty depth
1124                 SELECT INTO tmp_org * FROM actor.org_unit WHERE id = context_org;
1125                 SELECT INTO tmp_depth depth FROM actor.org_unit_type WHERE id = tmp_org.ou_type;
1126
1127                 WHILE tmp_depth >= tmp_penalty.org_depth LOOP
1128
1129                     RETURN QUERY
1130                         SELECT  *
1131                           FROM  actor.usr_standing_penalty
1132                           WHERE usr = match_user
1133                                 AND org_unit = tmp_org.id
1134                                 AND (stop_date IS NULL or stop_date > NOW())
1135                                 AND standing_penalty = 30;
1136
1137                     IF tmp_org.parent_ou IS NULL THEN
1138                         EXIT;
1139                     END IF;
1140
1141                     SELECT * INTO tmp_org FROM actor.org_unit WHERE id = tmp_org.parent_ou;
1142                     SELECT INTO tmp_depth depth FROM actor.org_unit_type WHERE id = tmp_org.ou_type;
1143                 END LOOP;
1144
1145             ELSE
1146
1147                 -- no penalty depth is defined, look for exact matches
1148
1149                 RETURN QUERY
1150                     SELECT  *
1151                       FROM  actor.usr_standing_penalty
1152                       WHERE usr = match_user
1153                             AND org_unit = max_fines.org_unit
1154                             AND (stop_date IS NULL or stop_date > NOW())
1155                             AND standing_penalty = 30;
1156             END IF;
1157
1158         END IF;
1159
1160     END IF;
1161
1162     RETURN;
1163 END;
1164 $func$ LANGUAGE plpgsql;
1165
1166
1167
1168 COMMIT;
1169