LP#1549505: schema and IDL for statistical poularity ratings
authorMike Rylander <mrylander@gmail.com>
Fri, 8 Jan 2016 03:00:20 +0000 (22:00 -0500)
committerGalen Charlton <gmc@esilibrary.com>
Wed, 24 Feb 2016 22:31:26 +0000 (17:31 -0500)
Signed-off-by: Mike Rylander <mrylander@gmail.com>
Signed-off-by: Galen Charlton <gmc@esilibrary.com>
Open-ILS/examples/fm_IDL.xml
Open-ILS/src/sql/Pg/upgrade/XXXX.schema.statisitcal-ratings.sql [new file with mode: 0644]

index 42b66f2..06dfb63 100644 (file)
@@ -239,6 +239,98 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
                </permacrud>
        </class>
 
+       <class  id="rrbs" 
+            controller="open-ils.cstore open-ils.pcrud" 
+            oils_obj:fieldmapper="rating::record_badge_score" 
+            oils_persist:tablename="rating.record_badge_score" 
+            reporter:label="Statistical Popularity Badge">
+               <fields oils_persist:primary="id" 
+                oils_persist:sequence="rating.record_badge_score_id_seq">
+                       <field reporter:label="ID" name="id" reporter:datatype="id" reporter:selector="name"/>
+                       <field reporter:label="Badge" name="badge" reporter:datatype="link"/>
+                       <field reporter:label="Record" name="record" reporter:datatype="link"/>
+                       <field reporter:label="Score" name="score" reporter:datatype="int"/>
+               </fields>
+        <links>
+            <link field="badge" reltype="has_a" key="id" map="" class="rb"/>
+            <link field="record" reltype="has_a" key="id" map="" class="bre"/>
+        </links>
+               <permacrud xmlns="http://open-ils.org/spec/opensrf/IDL/permacrud/v1">
+                       <actions>
+                               <retrieve/>
+                       </actions>
+               </permacrud>
+       </class>
+
+       <class  id="rp" 
+            controller="open-ils.cstore open-ils.pcrud" 
+            oils_obj:fieldmapper="rating::popularity_parameter" 
+            oils_persist:tablename="rating.popularity_parameter" 
+            reporter:label="Statistical Popularity Parameter">
+               <fields oils_persist:primary="id" 
+                oils_persist:sequence="rating.popularity_parameter_id_seq">
+                       <field reporter:label="ID" name="id" reporter:datatype="id" reporter:selector="name"/>
+                       <field reporter:label="Name" name="name" reporter:datatype="text"/>
+                       <field reporter:label="Description" name="description" reporter:datatype="text"/>
+                       <field reporter:label="Population Function" name="func" reporter:datatype="text"/>
+                       <field reporter:label="Require Horizon" name="require_horizon" reporter:datatype="bool"/>
+                       <field reporter:label="Require Percentile" name="require_percentile" reporter:datatype="bool"/>
+                       <field reporter:label="Require Importance" name="require_importance" reporter:datatype="bool"/>
+               </fields>
+               <permacrud xmlns="http://open-ils.org/spec/opensrf/IDL/permacrud/v1">
+                       <actions>
+                               <create permission="CREATE_POP_PARAMETER" global_required="true"/>
+                               <retrieve/>
+                               <update permission="UPDATE_POP_PARAMETER" global_required="true"/>
+                               <delete permission="DELETE_POP_PARAMETER" global_required="true"/>
+                       </actions>
+               </permacrud>
+       </class>
+
+       <class  id="rb" 
+            controller="open-ils.cstore open-ils.pcrud" 
+            oils_obj:fieldmapper="rating::badge" 
+            oils_persist:tablename="rating.badge" 
+            reporter:label="Statistical Popularity Badge">
+               <fields oils_persist:primary="id" 
+                oils_persist:sequence="rating.badge_id_seq">
+                       <field reporter:label="ID" name="id" reporter:datatype="id" reporter:selector="name"/>
+                       <field reporter:label="Name" name="name" reporter:datatype="text"/>
+                       <field reporter:label="Description" name="description" reporter:datatype="text"/>
+                       <field reporter:label="Scope" name="scope" reporter:datatype="org_unit"/>
+                       <field reporter:label="Weight" name="weight" reporter:datatype="int"/>
+                       <field reporter:label="Age Horizon" name="horizon_age" reporter:datatype="text"/>
+                       <field reporter:label="Importance Horizon" name="importance_age" reporter:datatype="text"/>
+                       <field reporter:label="Importance Interval" name="importance_interval" reporter:datatype="text"/>
+                       <field reporter:label="Importance Scale" name="importance_scale" reporter:datatype="text"/>
+                       <field reporter:label="Percentile" name="percentile" reporter:datatype="int"/>
+                       <field reporter:label="Attribute Filter" name="attr_filter" reporter:datatype="text"/>
+                       <field reporter:label="Circ Mod Filter" name="circ_mod_filter" reporter:datatype="link"/>
+                       <field reporter:label="Bib Source Filter" name="src_filter" reporter:datatype="link"/>
+                       <field reporter:label="Location Group Filter" name="loc_grp_filter" reporter:datatype="link"/>
+                       <field reporter:label="Recalculation Interval" name="recalc_interval" reporter:datatype="text"/>
+                       <field reporter:label="Fixed Rating" name="fixed_rating" reporter:datatype="int"/>
+                       <field reporter:label="Discard Value Count" name="discard" reporter:datatype="int"/>
+                       <field reporter:label="Last Refresh Time" name="last_calc" reporter:datatype="timestamp"/>
+                       <field reporter:label="Popularity Parameter" name="popularity_parameter" reporter:datatype="link"/>
+               </fields>
+               <links>
+                       <link field="scope" reltype="has_a" key="id" map="" class="aou"/>
+                       <link field="popularity_parameter" reltype="has_a" key="id" map="" class="rp"/>
+                       <link field="src_filter" reltype="has_a" key="id" map="" class="cbs"/>
+                       <link field="circ_mod_filter" reltype="has_a" key="code" map="" class="ccm"/>
+                       <link field="loc_grp_filter" reltype="has_a" key="id" map="" class="acpl"/>
+               </links>
+               <permacrud xmlns="http://open-ils.org/spec/opensrf/IDL/permacrud/v1">
+                       <actions>
+                               <create permission="CREATE_POP_BADGE" global_required="true"/>
+                               <retrieve/>
+                               <update permission="UPDATE_POP_BADGE" global_required="true"/>
+                               <delete permission="DELETE_POP_BADGE" global_required="true"/>
+                       </actions>
+               </permacrud>
+       </class>
+
        <class  id="vibtg" 
             controller="open-ils.cstore open-ils.pcrud" 
             oils_obj:fieldmapper="vandelay::import_bib_trash_group" 
diff --git a/Open-ILS/src/sql/Pg/upgrade/XXXX.schema.statisitcal-ratings.sql b/Open-ILS/src/sql/Pg/upgrade/XXXX.schema.statisitcal-ratings.sql
new file mode 100644 (file)
index 0000000..e35c75b
--- /dev/null
@@ -0,0 +1,542 @@
+
+BEGIN;
+
+CREATE SCHEMA rating;
+
+CREATE TABLE rating.popularity_parameter (
+    id          INT     PRIMARY KEY,
+    name        TEXT    NOT NULL UNIQUE, -- i18n
+    description TEXT,
+    func        TEXT,
+    require_horizon     BOOL    NOT NULL DEFAULT FALSE,
+    require_importance  BOOL    NOT NULL DEFAULT FALSE,
+    require_percentile  BOOL    NOT NULL DEFAULT FALSE
+);
+
+INSERT INTO rating.popularity_parameter (id,name,func,require_horizon,require_importance,require_percentile) VALUES
+    (1,'Holds Filled Over Time','rating.holds_filled_over_time',TRUE,FALSE,TRUE),
+    (2,'Holds Requested Over Time','rating.holds_placed_over_time',TRUE,FALSE,TRUE),
+    (3,'Current Hold Count','rating.current_hold_count',FALSE,FALSE,TRUE),
+    (4,'Circulations Over Time','rating.circs_over_time',TRUE,FALSE,TRUE),
+    (5,'Current Circulation Count','rating.current_circ_count',FALSE,FALSE,TRUE),
+    (6,'Out/Total Ratio','rating.checked_out_total_ratio',FALSE,FALSE,TRUE),
+    (7,'Holds/Total Ratio','rating.holds_total_ratio',FALSE,FALSE,TRUE),
+    (8,'Holds/Holdable Ratio','rating.holds_holdable_ratio',FALSE,FALSE,TRUE),
+    (9,'Percent of Time Circulating','rating.percent_time_circulating',FALSE,FALSE,TRUE),
+    (10,'Bibliographic Record Age (days, newer is better)','rating.bib_record_age',TRUE,FALSE,TRUE),
+    (11,'Publication Age (days, newer is better)','rating.bib_pub_age',TRUE,FALSE,TRUE),
+    (12,'On-line Bib has attributes','rating.generic_fixed_rating_by_uri',FALSE,FALSE,FALSE),
+    (13,'Bib has attributes and copies','rating.generic_fixed_rating_by_copy',FALSE,FALSE,FALSE),
+    (14,'Bib has attributes and copies or URIs','rating.generic_fixed_rating_by_copy_or_uri',FALSE,FALSE,FALSE),
+    (15,'Bib has attributes','rating.generic_fixed_rating_global',FALSE,FALSE,FALSE);
+
+CREATE TABLE rating.badge (
+    id                      SERIAL      PRIMARY KEY,
+    name                    TEXT        NOT NULL,
+    description             TEXT,
+    scope                   INT         NOT NULL REFERENCES actor.org_unit (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
+    weight                  INT         NOT NULL DEFAULT 1,
+    horizon_age             INTERVAL,
+    importance_age          INTERVAL,
+    importance_interval     INTERVAL    NOT NULL DEFAULT '1 day',
+    importance_scale        NUMERIC     CHECK (importance_scale IS NULL OR importance_scale > 0.0),
+    recalc_interval         INTERVAL    NOT NULL DEFAULT '1 month',
+    attr_filter             TEXT,
+    src_filter              INT         REFERENCES config.bib_source (id) ON UPDATE CASCADE ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
+    circ_mod_filter         TEXT        REFERENCES config.circ_modifier (code) ON UPDATE CASCADE ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
+    loc_grp_filter          INT         REFERENCES asset.copy_location_group (id) ON UPDATE CASCADE ON DELETE SET NULL DEFERRABLE INITIALLY DEFERRED,
+    popularity_parameter    INT         NOT NULL REFERENCES rating.popularity_parameter (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
+    fixed_rating            INT         CHECK (fixed_rating IS NULL OR fixed_rating BETWEEN -5 AND 5),
+    percentile              NUMERIC     CHECK (percentile IS NULL OR (percentile >= 50.0 AND percentile < 100.0)),
+    discard                 INT         NOT NULL DEFAULT 0, 
+    last_calc               TIMESTAMPTZ,
+    CONSTRAINT unique_name_scope UNIQUE (name,scope)
+);
+
+CREATE TABLE rating.record_badge_score (
+    id          BIGSERIAL   PRIMARY KEY,
+    record      BIGINT      NOT NULL REFERENCES biblio.record_entry (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
+    badge       INT         NOT NULL REFERENCES rating.badge (id) ON UPDATE CASCADE ON DELETE CASCADE DEFERRABLE INITIALLY DEFERRED,
+    score       INT         NOT NULL CHECK (score BETWEEN -5 AND 5),
+    CONSTRAINT unique_record_badge UNIQUE (record,badge)
+);
+CREATE INDEX record_badge_score_badge_idx ON rating.record_badge_score (badge);
+CREATE INDEX record_badge_score_record_idx ON rating.record_badge_score (record);
+
+CREATE VIEW rating.generic_bib_population_global AS
+    WITH    org_scope AS (
+                SELECT  id,
+                        array_agg(tree) AS orgs
+                  FROM  (SELECT id,
+                                (actor.org_unit_descendants(id)).id AS tree
+                          FROM  actor.org_unit
+                        ) x
+                  GROUP BY 1
+            ),
+            badge_data AS (
+                SELECT  *,
+                        metabib.compile_composite_attr(COALESCE(attr_filter,'{}')) AS afilter
+                  FROM  rating.badge
+            )
+    SELECT  DISTINCT ON (b.id)
+            b.id AS bib,
+            badge_data.id AS badge,
+            s.orgs
+      FROM  biblio.record_entry b
+            JOIN metabib.record_attr_vector_list r ON (b.id = r.source)
+            JOIN badge_data ON (
+                badge_data.circ_mod_filter IS NULL
+                AND (badge_data.src_filter IS NULL OR b.source = badge_data.src_filter)
+                AND (badge_data.attr_filter IS NULL OR r.vlist @@ badge_data.afilter)
+            )
+            JOIN org_scope s ON (badge_data.scope = s.id);
+
+CREATE VIEW rating.generic_bib_population_by_copy AS
+    WITH    org_scope AS (
+                SELECT  id,
+                        array_agg(tree) AS orgs
+                  FROM  (SELECT id,
+                                (actor.org_unit_descendants(id)).id AS tree
+                          FROM  actor.org_unit
+                        ) x
+                  GROUP BY 1
+            ),
+            badge_data AS (
+                SELECT  *,
+                        metabib.compile_composite_attr(COALESCE(attr_filter,'{}')) AS afilter
+                  FROM  rating.badge
+            )
+    SELECT  DISTINCT ON (b.id)
+            b.id AS bib,
+            badge_data.id AS badge,
+            s.orgs
+      FROM  biblio.record_entry b
+            JOIN metabib.record_attr_vector_list r ON (b.id = r.source)
+            JOIN asset.call_number cn ON (cn.record = b.id AND NOT cn.deleted)
+            JOIN asset.copy cp ON (cp.call_number = cn.id AND NOT cp.deleted)
+            JOIN org_scope s ON (cn.owning_lib = ANY (s.orgs))
+            JOIN badge_data ON (
+                badge_data.scope = s.id
+                AND (badge_data.src_filter IS NULL OR b.source = badge_data.src_filter)
+                AND (badge_data.circ_mod_filter IS NULL OR cp.circ_modifier = badge_data.circ_mod_filter)
+                AND (badge_data.attr_filter IS NULL OR r.vlist @@ badge_data.afilter)
+            )
+            LEFT JOIN asset.copy_location_group_map lg ON (cp.location = lg.location)
+      WHERE (badge_data.loc_grp_filter IS NULL OR lg.lgroup = badge_data.loc_grp_filter);
+
+CREATE VIEW rating.generic_bib_population_by_uri AS
+    WITH    org_scope AS (
+                SELECT  id,
+                        array_agg(tree) AS orgs
+                  FROM  (SELECT id,
+                                (actor.org_unit_descendants(id)).id AS tree
+                          FROM  actor.org_unit
+                        ) x
+                  GROUP BY 1
+            ),
+            badge_data AS (
+                SELECT  *,
+                        metabib.compile_composite_attr(COALESCE(attr_filter,'{}')) AS afilter
+                  FROM  rating.badge
+            )
+    SELECT  DISTINCT ON (b.id)
+            b.id AS bib,
+            badge_data.id AS badge,
+            s.orgs
+      FROM  biblio.record_entry b
+            JOIN metabib.record_attr_vector_list r ON (b.id = r.source)
+            JOIN asset.call_number cn ON (cn.record = b.id AND cn.label = '##URI##' AND NOT cn.deleted)
+            JOIN asset.uri_call_number_map urim ON (urim.call_number = cn.id)
+            JOIN asset.uri uri ON (urim.uri = uri.id AND uri.active)
+            JOIN org_scope s ON (cn.owning_lib = ANY (s.orgs))
+            JOIN badge_data ON (
+                badge_data.scope = s.id
+                AND badge_data.circ_mod_filter IS NULL
+                AND (badge_data.src_filter IS NULL OR b.source = badge_data.src_filter)
+                AND (badge_data.attr_filter IS NULL OR r.vlist @@ badge_data.afilter)
+            );
+
+CREATE VIEW rating.generic_bib_population_by_copy_or_uri AS
+    WITH    org_scope AS (
+                SELECT  id,
+                        array_agg(tree) AS orgs
+                  FROM  (SELECT id,
+                                (actor.org_unit_descendants(id)).id AS tree
+                          FROM  actor.org_unit
+                        ) x
+                  GROUP BY 1
+            ),
+            badge_data AS (
+                SELECT  *,
+                        metabib.compile_composite_attr(COALESCE(attr_filter,'{}')) AS afilter
+                  FROM  rating.badge
+            )
+    SELECT  DISTINCT ON (b.id)
+            b.id AS bib,
+            badge_data.id AS badge,
+            s.orgs
+      FROM  biblio.record_entry b
+            JOIN metabib.record_attr_vector_list r ON (b.id = r.source)
+            JOIN asset.call_number cn ON (cn.record = b.id AND NOT cn.deleted)
+            JOIN org_scope s ON (cn.owning_lib = ANY (s.orgs))
+            JOIN badge_data ON (
+                badge_data.scope = s.id
+                AND (badge_data.src_filter IS NULL OR b.source = badge_data.src_filter)
+                AND (badge_data.attr_filter IS NULL OR r.vlist @@ badge_data.afilter)
+            )
+            LEFT JOIN asset.copy cp ON (cp.call_number = cn.id AND NOT cp.deleted)
+            LEFT JOIN asset.uri_call_number_map urim ON (urim.call_number = cn.id)
+            LEFT JOIN asset.uri uri ON (urim.uri = uri.id AND uri.active)
+            LEFT JOIN asset.copy_location_group_map lg ON (cp.location = lg.location)
+      WHERE (badge_data.loc_grp_filter IS NULL OR lg.lgroup = badge_data.loc_grp_filter)
+            AND (uri.id IS NOT NULL OR cp.id IS NOT NULL)
+            AND (badge_data.circ_mod_filter IS NULL OR cp.circ_modifier = badge_data.circ_mod_filter);
+
+
+CREATE OR REPLACE FUNCTION rating.recalculate_badge_score ( badge_id INT ) RETURNS VOID AS $f$
+DECLARE
+    badge_row           rating.badge%ROWTYPE;
+    param           rating.popularity_parameter%ROWTYPE;
+BEGIN
+
+    -- Find what we're doing    
+    SELECT * INTO badge_row FROM rating.badge WHERE id = badge_id;
+    SELECT * INTO param FROM rating.popularity_parameter WHERE id = badge_row.popularity_parameter;
+
+    -- If it's a fixed-rating badge, just do it ...
+    IF badge_row.fixed_rating IS NOT NULL THEN
+        DELETE FROM rating.record_badge_score WHERE badge = badge_id;
+        EXECUTE $e$
+            INSERT INTO rating.record_badge_score (record, badge, score)
+                SELECT bib, $1, $2, FROM $e$ || param.func || $e$($1)$e$
+        USING badge_id, badge_row.fixed_rating;
+
+        RETURN;
+    END IF;
+    -- else, calculate!
+
+    -- Make a session-local scratchpad for calculating scores
+    CREATE TEMP TABLE record_score_scratchpad (
+        bib     BIGINT,
+        value   NUMERIC
+    ) ON COMMIT DROP;
+
+    -- Gather raw values
+    EXECUTE $e$
+        INSERT INTO record_score_scratchpad (bib, value)
+            SELECT * FROM $e$ || param.func || $e$($1)$e$
+    USING badge_id;
+
+    IF badge_row.discard > 0 OR badge_row.percentile IS NOT NULL THEN
+        -- To speed up discard-common
+        CREATE INDEX record_score_scratchpad_score_idx ON record_score_scratchpad (value);
+        ANALYZE record_score_scratchpad;
+    END IF;
+
+    IF badge_row.discard > 0 THEN -- Remove common low values (trim the long tail)
+        DELETE FROM record_score_scratchpad WHERE value IN (
+            SELECT DISTINCT value FROM record_score_scratchpad ORDER BY value LIMIT badge_row.discard
+        );
+    END IF;
+
+    IF badge_row.percentile IS NOT NULL THEN -- Cut population down to exceptional records
+        DELETE FROM record_score_scratchpad WHERE value <= (
+            SELECT value FROM (
+                SELECT  value,
+                        CUME_DIST() OVER (ORDER BY value) AS p
+                  FROM  record_score_scratchpad
+            ) x WHERE p < badge_row.percentile / 100.0 ORDER BY p DESC LIMIT 1
+        );
+    END IF;
+
+
+    -- And, finally, push new data in
+    DELETE FROM rating.record_badge_score WHERE badge = badge_id;
+    INSERT INTO rating.record_badge_score (badge, record, score)
+        SELECT  badge_id,
+                bib,
+                GREATEST(ROUND((CUME_DIST() OVER (ORDER BY value)) * 5), 1) AS value
+          FROM  record_score_scratchpad;
+
+    DROP TABLE record_score_scratchpad;
+
+    RETURN;
+END;
+$f$ LANGUAGE PLPGSQL;
+
+CREATE OR REPLACE FUNCTION rating.holds_filled_over_time(badge_id INT)
+    RETURNS TABLE (record BIGINT, value NUMERIC) AS $f$
+DECLARE
+    badge   rating.badge%ROWTYPE;
+    iage    INT     := 1;
+    iint    INT     := NULL;
+    iscale  NUMERIC := NULL;
+BEGIN
+
+    SELECT * INTO badge FROM rating.badge WHERE id = badge_id;
+
+    IF badge.horizon_age IS NULL THEN
+        RAISE EXCEPTION 'Badge "%" with id % requires a horizon age but has none.',
+            badge.name,
+            badge.id;
+    END IF;
+
+    iint := EXTRACT(EPOCH FROM badge.importance_interval);
+    IF badge.importance_age IS NOT NULL THEN
+        iage := (EXTRACT(EPOCH FROM badge.importance_age) / iint)::INT;
+    END IF;
+
+    -- if iscale is smaller than 1, scaling slope will be shallow ... BEWARE!
+    iscale := COALESCE(badge.importance_scale, 1.0);
+
+    RETURN QUERY
+     SELECT bib,
+            SUM( holds * GREATEST( iscale * (iage - hage), 1.0 ))
+      FROM (
+         SELECT pop.bib AS bib,
+                (1 + EXTRACT(EPOCH FROM h.fulfillment_time) / iint)::INT AS hage,
+                COUNT(h.id)::INT AS holds
+          FROM  action.hold_request h
+                JOIN reporter.hold_request_record rhrr ON (rhrr.id = h.id)
+                JOIN rating.generic_bib_population_by_copy pop ON (rhrr.bib_record = pop.bib AND pop.badge = badge.id)
+          WHERE h.fulfillment_time >= NOW() - badge.horizon_age
+                AND h.request_lib = ANY (pop.orgs)
+          GROUP BY 1, 2
+      ) x
+      GROUP BY 1;
+END;
+$f$ LANGUAGE PLPGSQL STABLE STRICT;
+
+CREATE OR REPLACE FUNCTION rating.holds_placed_over_time(badge_id INT)
+    RETURNS TABLE (record BIGINT, value NUMERIC) AS $f$
+DECLARE
+    badge   rating.badge%ROWTYPE;
+    iage    INT     := 1;
+    iint    INT     := NULL;
+    iscale  NUMERIC := NULL;
+BEGIN
+
+    SELECT * INTO badge FROM rating.badge WHERE id = badge_id;
+
+    IF badge.horizon_age IS NULL THEN
+        RAISE EXCEPTION 'Badge "%" with id % requires a horizon age but has none.',
+            badge.name,
+            badge.id;
+    END IF;
+
+    iint := EXTRACT(EPOCH FROM badge.importance_interval);
+    IF badge.importance_age IS NOT NULL THEN
+        iage := (EXTRACT(EPOCH FROM badge.importance_age) / iint)::INT;
+    END IF;
+
+    -- if iscale is smaller than 1, scaling slope will be shallow ... BEWARE!
+    iscale := COALESCE(badge.importance_scale, 1.0);
+
+    RETURN QUERY
+     SELECT bib,
+            SUM( holds * GREATEST( iscale * (iage - hage), 1.0 ))
+      FROM (
+         SELECT pop.bib AS bib,
+                (1 + EXTRACT(EPOCH FROM h.fulfillment_time) / iint)::INT AS hage,
+                COUNT(h.id)::INT AS holds
+          FROM  action.hold_request h
+                JOIN reporter.hold_request_record rhrr ON (rhrr.id = h.id)
+                JOIN rating.generic_bib_population_by_copy pop ON (rhrr.bib_record = pop.bib AND pop.badge = badge.id)
+          WHERE h.request_time >= NOW() - badge.horizon_age
+                AND h.request_lib = ANY (pop.orgs)
+          GROUP BY 1, 2
+      ) x
+      GROUP BY 1;
+END;
+$f$ LANGUAGE PLPGSQL STABLE STRICT;
+
+CREATE OR REPLACE FUNCTION rating.current_hold_count(INT)
+    RETURNS TABLE (record BIGINT, value NUMERIC) AS $f$
+    SELECT  pop.bib AS bib,
+            COUNT(h.id)::NUMERIC AS holds
+      FROM  action.hold_request h
+            JOIN reporter.hold_request_record rhrr ON (rhrr.id = h.id)
+            JOIN rating.generic_bib_population_by_copy pop ON (rhrr.bib_record = pop.bib AND pop.badge = $1)
+      WHERE h.fulfillment_time IS NULL
+            AND h.request_lib = ANY (pop.orgs)
+      GROUP BY 1
+$f$ LANGUAGE SQL STABLE STRICT;
+
+CREATE OR REPLACE FUNCTION rating.circs_over_time(badge_id INT)
+    RETURNS TABLE (record BIGINT, value NUMERIC) AS $f$
+DECLARE
+    badge   rating.badge%ROWTYPE;
+    iage    INT     := 1;
+    iint    INT     := NULL;
+    iscale  NUMERIC := NULL;
+BEGIN
+
+    SELECT * INTO badge FROM rating.badge WHERE id = badge_id;
+
+    IF badge.horizon_age IS NULL THEN
+        RAISE EXCEPTION 'Badge "%" with id % requires a horizon age but has none.',
+            badge.name,
+            badge.id;
+    END IF;
+
+    iint := EXTRACT(EPOCH FROM badge.importance_interval);
+    IF badge.importance_age IS NOT NULL THEN
+        iage := (EXTRACT(EPOCH FROM badge.importance_age) / iint)::INT;
+    END IF;
+
+    -- if iscale is smaller than 1, scaling slope will be shallow ... BEWARE!
+    iscale := COALESCE(badge.importance_scale, 1.0);
+
+    RETURN QUERY
+     SELECT bib,
+            SUM( circs * GREATEST( iscale * (iage - cage), 1.0 ))
+      FROM (
+         SELECT b.id AS bib,
+                (1 + EXTRACT(EPOCH FROM c.xact_start) / iint)::INT AS cage,
+                COUNT(c.id)::INT AS circs
+          FROM  action.circulation c
+                JOIN asset.copy cp ON (cp.id = c.target_copy)
+                JOIN asset.call_number cn ON (cn.id = cp.call_number)
+                JOIN rating.generic_bib_population_by_copy pop ON (cn.record = pop.bib AND pop.badge = badge.id)
+          WHERE c.xact_start >= NOW() - badge.horizon_age
+                AND cn.owning_lib = ANY (pop.orgs)
+                AND c.phone_renewal IS FALSE  -- we don't count renewals
+                AND c.desk_renewal IS FALSE
+                AND c.opac_renewal IS FALSE
+          GROUP BY 1, 2
+      ) x
+      GROUP BY 1;
+END;
+$f$ LANGUAGE PLPGSQL STABLE STRICT;
+
+CREATE OR REPLACE FUNCTION rating.current_circ_count(INT)
+    RETURNS TABLE (record BIGINT, value NUMERIC) AS $f$
+    SELECT  pop.bib AS bib,
+            COUNT(c.id)::NUMERIC AS circs
+      FROM  action.circulation c
+            JOIN asset.copy cp ON (cp.id = c.target_copy)
+            JOIN asset.call_number cn ON (cn.id = cp.call_number)
+            JOIN rating.generic_bib_population_by_copy pop ON (cn.record = pop.bib AND pop.badge = $1)
+      WHERE c.checkin_time IS NULL
+            AND cn.owning_lib = ANY (pop.orgs)
+      GROUP BY 1
+$f$ LANGUAGE SQL STABLE STRICT;
+
+CREATE OR REPLACE FUNCTION rating.checked_out_total_ratio(INT)
+    RETURNS TABLE (record BIGINT, value NUMERIC) AS $f$
+    SELECT  bib,
+            SUM(checked_out)::NUMERIC / SUM(total)::NUMERIC
+      FROM  (SELECT cn.record AS bib,
+                    (cp.status = 1)::INT AS checked_out,
+                    1 AS total
+              FROM  asset.copy cp
+                    JOIN asset.call_number cn ON (cn.id = cp.call_number)
+                    JOIN rating.generic_bib_population_by_copy pop ON (cn.record = pop.bib AND pop.badge = $1)
+              WHERE cn.owning_lib = ANY (pop.orgs)
+            ) x
+      GROUP BY 1
+$f$ LANGUAGE SQL STABLE STRICT;
+
+CREATE OR REPLACE FUNCTION rating.holds_total_ratio(INT)
+    RETURNS TABLE (record BIGINT, value NUMERIC) AS $f$
+    SELECT  cn.record AS bib,
+            COUNT(DISTINCT m.hold)::NUMERIC / COUNT(DISTINCT cp.id)::NUMERIC
+      FROM  asset.copy cp
+            JOIN asset.call_number cn ON (cn.id = cp.call_number)
+            JOIN rating.generic_bib_population_by_copy pop ON (cn.record = pop.bib AND pop.badge = $1)
+            LEFT JOIN action.hold_copy_map m ON (m.target_copy = cp.id)
+      WHERE cn.owning_lib = ANY (pop.orgs)
+      GROUP BY 1
+$f$ LANGUAGE SQL STABLE STRICT;
+
+CREATE OR REPLACE FUNCTION rating.holds_holdable_ratio(INT)
+    RETURNS TABLE (record BIGINT, value NUMERIC) AS $f$
+    SELECT  cn.record AS bib,
+            COUNT(DISTINCT m.hold)::NUMERIC / COUNT(DISTINCT cp.id)::NUMERIC
+      FROM  asset.copy cp
+            JOIN asset.copy_location cl ON (cl.id = cp.location)
+            JOIN config.copy_status cs ON (cs.id = cp.status)
+            JOIN asset.call_number cn ON (cn.id = cp.call_number)
+            JOIN rating.generic_bib_population_by_copy pop ON (cn.record = pop.bib AND pop.badge = $1)
+            LEFT JOIN action.hold_copy_map m ON (m.target_copy = cp.id)
+      WHERE cn.owning_lib = ANY (pop.orgs)
+            AND cp.holdable IS TRUE
+            AND cl.holdable IS TRUE
+            AND cs.holdable IS TRUE
+      GROUP BY 1
+$f$ LANGUAGE SQL STABLE STRICT;
+
+CREATE OR REPLACE FUNCTION rating.bib_record_age(INT)
+    RETURNS TABLE (record BIGINT, value NUMERIC) AS $f$
+    SELECT  pop.bib AS bib,
+            1.0 / EXTRACT(EPOCH FROM AGE(b.create_date))::NUMERIC + 1.0
+      FROM  rating.generic_bib_population_by_copy_or_uri pop
+            JOIN biblio.record_entry b ON (b.id = pop.bib)
+      WHERE pop.badge = $1
+$f$ LANGUAGE SQL STABLE STRICT;
+
+CREATE OR REPLACE FUNCTION rating.bib_pub_age(INT)
+    RETURNS TABLE (record BIGINT, value NUMERIC) AS $f$
+    SELECT  pop.bib AS bib,
+            s.value::NUMERIC
+      FROM  rating.generic_bib_population_by_copy_or_uri pop
+            JOIN metabib.record_sorter s ON (
+                s.source = pop.bib
+                AND s.attr = 'pubdate'
+                AND s.value ~ '^\d+$'
+            )
+      WHERE pop.badge = $1
+$f$ LANGUAGE SQL STABLE STRICT;
+
+CREATE OR REPLACE FUNCTION rating.percent_time_circulating(INT)
+    RETURNS TABLE (record BIGINT, value NUMERIC) AS $f$
+    SELECT  bib,
+            SUM(circ_time)::NUMERIC / SUM(age)::NUMERIC
+      FROM  (SELECT cn.record AS bib,
+                    cp.id,
+                    EXTRACT( EPOCH FROM AGE(cp.active_date) ) + 1 AS age,
+                    SUM(  -- time copy spent circulating
+                        EXTRACT(
+                            EPOCH FROM
+                            AGE(
+                                COALESCE(circ.checkin_time, NOW()),
+                                circ.xact_start
+                            )
+                        )
+                    )::NUMERIC AS circ_time
+              FROM  asset.copy cp
+                    JOIN asset.call_number cn ON (cn.id = cp.call_number)
+                    JOIN rating.generic_bib_population_by_copy pop ON (cn.record = pop.bib AND pop.badge = $1)
+                    LEFT JOIN action.all_circulation circ ON (circ.target_copy = cp.id)
+              WHERE cn.owning_lib = ANY (pop.orgs)
+              GROUP BY 1,2,3
+            ) x
+      GROUP BY 1
+$f$ LANGUAGE SQL STABLE STRICT;
+
+CREATE OR REPLACE FUNCTION rating.generic_fixed_rating_by_copy(INT)
+    RETURNS TABLE (record BIGINT, value NUMERIC) AS $f$
+SELECT bib, 1.0
+  FROM  rating.generic_bib_population_by_copy pop
+  WHERE pop.badge = $1;
+$f$ LANGUAGE SQL STABLE STRICT;
+
+CREATE OR REPLACE FUNCTION rating.generic_fixed_rating_by_uri(INT)
+    RETURNS TABLE (record BIGINT, value NUMERIC) AS $f$
+SELECT bib, 1.0
+  FROM  rating.generic_bib_population_by_uri pop
+  WHERE pop.badge = $1;
+$f$ LANGUAGE SQL STABLE STRICT;
+
+CREATE OR REPLACE FUNCTION rating.generic_fixed_rating_global(INT)
+    RETURNS TABLE (record BIGINT, value NUMERIC) AS $f$
+SELECT bib, 1.0
+  FROM  rating.generic_bib_population_global pop
+  WHERE pop.badge = $1;
+$f$ LANGUAGE SQL STABLE STRICT;
+
+CREATE INDEX hold_fulfillment_time_idx ON action.hold_request (fulfillment_time) WHERE fulfillment_time IS NOT NULL;
+CREATE INDEX hold_request_time_idx ON action.hold_request (request_time);
+
+COMMIT;
+