2 * Copyright (C) 2009 Equinox Software, Inc.
3 * Mike Rylander <miker@esilibrary.com>
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; either version 2
8 * of the License, or (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
17 DROP SCHEMA IF EXISTS action_trigger CASCADE;
21 CREATE SCHEMA action_trigger;
23 CREATE TABLE action_trigger.hook (
25 core_type TEXT NOT NULL,
27 passive BOOL NOT NULL DEFAULT FALSE
29 INSERT INTO action_trigger.hook (key,core_type,description) VALUES ('checkout','circ','Item checked out to user');
30 INSERT INTO action_trigger.hook (key,core_type,description) VALUES ('checkin','circ','Item checked in');
31 INSERT INTO action_trigger.hook (key,core_type,description) VALUES ('lost','circ','Circulating Item marked Lost');
32 INSERT INTO action_trigger.hook (key,core_type,description) VALUES ('lost.found','circ','Lost Circulating Item checked in');
33 INSERT INTO action_trigger.hook (key,core_type,description) VALUES ('lost.auto','circ','Circulating Item automatically marked lost');
34 INSERT INTO action_trigger.hook (key,core_type,description) VALUES ('claims_returned','circ','Circulating Item marked Claims Returned');
35 INSERT INTO action_trigger.hook (key,core_type,description) VALUES ('claims_returned.found','circ','Claims Returned Circulating Item is checked in');
36 INSERT INTO action_trigger.hook (key,core_type,description) VALUES ('missing','acp','Item marked Missing');
37 INSERT INTO action_trigger.hook (key,core_type,description) VALUES ('missing.found','acp','Missing Item checked in');
38 INSERT INTO action_trigger.hook (key,core_type,description) VALUES ('transit.start','acp','An Item is placed into transit');
39 INSERT INTO action_trigger.hook (key,core_type,description) VALUES ('transit.finish','acp','An Item is received from a transit');
40 INSERT INTO action_trigger.hook (key,core_type,description) VALUES ('hold_request.success','ahr','A hold is successfully placed');
41 INSERT INTO action_trigger.hook (key,core_type,description) VALUES ('hold_request.failure','ahr','A hold is attempted but not successfully placed');
42 INSERT INTO action_trigger.hook (key,core_type,description) VALUES ('hold.capture','ahr','A targeted Item is captured for a hold');
43 INSERT INTO action_trigger.hook (key,core_type,description) VALUES ('hold.available','ahr','A held item is ready for pickup');
44 INSERT INTO action_trigger.hook (key,core_type,description) VALUES ('hold_transit.start','ahtc','A hold-captured Item is placed into transit');
45 INSERT INTO action_trigger.hook (key,core_type,description) VALUES ('hold_transit.finish','ahtc','A hold-captured Item is received from a transit');
46 INSERT INTO action_trigger.hook (key,core_type,description,passive) VALUES ('checkout.due','circ','Checked out Item is Due',TRUE);
47 INSERT INTO action_trigger.hook (key,core_type,description,passive) VALUES ('penalty.PATRON_EXCEEDS_FINES','ausp','Patron has exceeded allowed fines',TRUE);
48 INSERT INTO action_trigger.hook (key,core_type,description,passive) VALUES ('penalty.PATRON_EXCEEDS_OVERDUE_COUNT','ausp','Patron has exceeded allowed overdue count',TRUE);
49 INSERT INTO action_trigger.hook (key,core_type,description,passive) VALUES ('penalty.PATRON_EXCEEDS_CHECKOUT_COUNT','ausp','Patron has exceeded allowed checkout count',TRUE);
50 INSERT INTO action_trigger.hook (key,core_type,description,passive) VALUES ('penalty.PATRON_EXCEEDS_COLLECTIONS_WARNING','ausp','Patron has exceeded maximum fine amount for collections department warning',TRUE);
51 INSERT INTO action_trigger.hook (key,core_type,description,passive) VALUES ('acqpo.activated','acqpo','Purchase order was activated',FALSE);
52 INSERT INTO action_trigger.hook (key,core_type,description) VALUES ('format.po.html','acqpo','Formats a Purchase Order as an HTML document');
53 INSERT INTO action_trigger.hook (key,core_type,description) VALUES ('format.po.pdf','acqpo','Formats a Purchase Order as a PDF document');
54 INSERT INTO action_trigger.hook (key,core_type,description) VALUES ('damaged','acp','Item marked damaged');
55 INSERT INTO action_trigger.hook (key,core_type,description) VALUES ('checkout.damaged','circ','A circulating item is marked damaged and the patron is fined');
56 INSERT INTO action_trigger.hook (key,core_type,description) VALUES ('renewal','circ','Item renewed to user');
58 -- and much more, I'm sure
60 -- Specialized collection modules. Given an FM object, gather some info and return a scalar or ref.
61 CREATE TABLE action_trigger.collector (
62 module TEXT PRIMARY KEY, -- All live under the OpenILS::Trigger::Collector:: namespace
65 INSERT INTO action_trigger.collector (module,description) VALUES ('fourty_two','Returns the answer to life, the universe and everything');
66 --INSERT INTO action_trigger.collector (module,description) VALUES ('CircCountsByCircMod','Count of Circulations for a User, broken down by circulation modifier');
68 -- Simple tests on an FM object from hook.core_type to test for "should we still do this."
69 CREATE TABLE action_trigger.validator (
70 module TEXT PRIMARY KEY, -- All live under the OpenILS::Trigger::Validator:: namespace
73 INSERT INTO action_trigger.validator (module,description) VALUES ('fourty_two','Returns the answer to life, the universe and everything');
74 INSERT INTO action_trigger.validator (module,description) VALUES ('NOOP_True','Always returns true -- validation always passes');
75 INSERT INTO action_trigger.validator (module,description) VALUES ('NOOP_False','Always returns false -- validation always fails');
76 INSERT INTO action_trigger.validator (module,description) VALUES ('CircIsOpen','Check that the circulation is still open');
77 INSERT INTO action_trigger.validator (module,description) VALUES ('HoldIsAvailable','Check that an item is on the hold shelf');
78 INSERT INTO action_trigger.validator (module,description) VALUES ('CircIsOverdue','Check that the circulation is overdue');
79 INSERT INTO action_trigger.validator (module,description) VALUES ('MaxPassiveDelayAge','Check that the event is not too far past the delay_field time -- requires a max_delay_age interval parameter');
80 INSERT INTO action_trigger.validator (module,description) VALUES ('MinPassiveTargetAge','Check that the target is old enough to be used by this event -- requires a min_target_age interval parameter, and accepts an optional target_age_field to specify what time to use for offsetting');
82 -- After an event passes validation (action_trigger.validator), the reactor processes it.
83 CREATE TABLE action_trigger.reactor (
84 module TEXT PRIMARY KEY, -- All live under the OpenILS::Trigger::Reactor:: namespace
88 INSERT INTO action_trigger.reactor (module,description) VALUES
92 'Returns the answer to life, the universe and everything',
97 INSERT INTO action_trigger.reactor (module,description) VALUES
101 'Always returns true -- reaction always passes',
106 INSERT INTO action_trigger.reactor (module,description) VALUES
110 'Always returns false -- reaction always fails',
115 INSERT INTO action_trigger.reactor (module,description) VALUES
119 'Send an email based on a user-defined template',
125 -- TODO: build a PDF generator
126 --INSERT INTO action_trigger.reactor (module,description) VALUES
127 --( 'GenerateBatchOverduePDF',
128 -- oils_i18n_gettext(
129 -- 'GenerateBatchOverduePDF',
130 -- 'Output a batch PDF of overdue notices for printing',
136 INSERT INTO action_trigger.reactor (module,description) VALUES
140 'Marks a circulation and associated item as lost',
145 INSERT INTO action_trigger.reactor (module,description) VALUES
149 'Applies a billing with a pre-defined amount to a circulation',
154 INSERT INTO action_trigger.reactor (module,description) VALUES
158 'Processes the configured template',
164 -- After an event is reacted to (either success or failure) a cleanup module is run against the resulting environment
165 CREATE TABLE action_trigger.cleanup (
166 module TEXT PRIMARY KEY, -- All live under the OpenILS::Trigger::Cleanup:: namespace
169 INSERT INTO action_trigger.cleanup (module,description) VALUES ('fourty_two','Returns the answer to life, the universe and everything');
170 INSERT INTO action_trigger.cleanup (module,description) VALUES ('NOOP_True','Always returns true -- cleanup always passes');
171 INSERT INTO action_trigger.cleanup (module,description) VALUES ('NOOP_False','Always returns false -- cleanup always fails');
172 INSERT INTO action_trigger.cleanup (module,description) VALUES ('ClearAllPending','Remove all future, pending notifications for this target');
174 CREATE TABLE action_trigger.event_definition (
175 id SERIAL PRIMARY KEY,
176 active BOOL NOT NULL DEFAULT TRUE,
177 owner INT NOT NULL REFERENCES actor.org_unit (id) DEFERRABLE INITIALLY DEFERRED,
179 hook TEXT NOT NULL REFERENCES action_trigger.hook (key) DEFERRABLE INITIALLY DEFERRED,
180 validator TEXT NOT NULL REFERENCES action_trigger.validator (module) DEFERRABLE INITIALLY DEFERRED,
181 reactor TEXT NOT NULL REFERENCES action_trigger.reactor (module) DEFERRABLE INITIALLY DEFERRED,
182 cleanup_success TEXT REFERENCES action_trigger.cleanup (module) DEFERRABLE INITIALLY DEFERRED,
183 cleanup_failure TEXT REFERENCES action_trigger.cleanup (module) DEFERRABLE INITIALLY DEFERRED,
184 delay INTERVAL NOT NULL DEFAULT '5 minutes',
186 repeat_delay INTERVAL,
188 opt_in_setting TEXT REFERENCES config.usr_setting_type (name) DEFERRABLE INITIALLY DEFERRED,
189 delay_field TEXT, -- for instance, xact_start on a circ hook ... look for fields on hook.core_type where datatype=timestamp? If not set, delay from now()
190 group_field TEXT, -- field from this.hook.core_type to batch event targets together on, fed into reactor a group at a time.
191 template TEXT, -- the TT block. will have an 'environment' hash (or array of hashes, grouped events) built up by validator and collector(s), which can be modified.
192 granularity TEXT, -- could specify a batch which is the only time these events should actually run
194 message_template TEXT,
195 message_usr_path TEXT,
196 message_library_path TEXT,
198 retention_interval INTERVAL,
200 CONSTRAINT ev_def_owner_hook_val_react_clean_delay_once UNIQUE (owner, hook, validator, reactor, delay, delay_field),
201 CONSTRAINT ev_def_name_owner_once UNIQUE (owner, name)
204 CREATE OR REPLACE FUNCTION action_trigger.check_valid_retention_interval()
205 RETURNS TRIGGER AS $_$
208 * 1. Retention intervals are always allowed on active hooks.
209 * 2. On passive hooks, retention intervals are only allowed
210 * when the event definition has a max_delay value and the
211 * retention_interval value is greater than the difference
212 * beteween the delay and max_delay values.
214 PERFORM TRUE FROM action_trigger.hook
215 WHERE key = NEW.hook AND NOT passive;
221 IF NEW.max_delay IS NOT NULL THEN
222 IF EXTRACT(EPOCH FROM NEW.retention_interval) >
223 ABS(EXTRACT(EPOCH FROM (NEW.max_delay - NEW.delay))) THEN
224 RETURN NEW; -- all good
226 RAISE EXCEPTION 'retention_interval is too short';
229 RAISE EXCEPTION 'retention_interval requires max_delay';
232 $_$ LANGUAGE PLPGSQL;
234 CREATE TRIGGER is_valid_retention_interval
235 BEFORE INSERT OR UPDATE ON action_trigger.event_definition
236 FOR EACH ROW WHEN (NEW.retention_interval IS NOT NULL)
237 EXECUTE PROCEDURE action_trigger.check_valid_retention_interval();
239 CREATE TABLE action_trigger.environment (
240 id SERIAL PRIMARY KEY,
241 event_def INT NOT NULL REFERENCES action_trigger.event_definition (id) DEFERRABLE INITIALLY DEFERRED,
242 path TEXT, -- fields to flesh. given a hook with a core_type of circ, imagine circ_lib.parent_ou expanding to
243 -- {flesh: 2, flesh_fields: {circ: ['circ_lib'], aou: ['parent_ou']}} ... default is to flesh all
245 collector TEXT REFERENCES action_trigger.collector (module) DEFERRABLE INITIALLY DEFERRED, -- if set, given the object at 'path', return some data
246 -- to be stashed at environment.<label>
247 label TEXT CHECK (label NOT IN ('result','target','event')),
248 CONSTRAINT env_event_label_once UNIQUE (event_def,label)
251 CREATE TABLE action_trigger.event_output (
252 id BIGSERIAL PRIMARY KEY,
253 create_time TIMESTAMPTZ NOT NULL DEFAULT NOW(),
254 is_error BOOLEAN NOT NULL DEFAULT FALSE,
258 CREATE TABLE action_trigger.event (
259 id BIGSERIAL PRIMARY KEY,
260 target BIGINT NOT NULL, -- points at the id from class defined by event_def.hook.core_type
261 event_def INT REFERENCES action_trigger.event_definition (id) DEFERRABLE INITIALLY DEFERRED,
262 add_time TIMESTAMPTZ NOT NULL DEFAULT NOW(),
263 run_time TIMESTAMPTZ NOT NULL,
264 start_time TIMESTAMPTZ,
265 update_time TIMESTAMPTZ,
266 complete_time TIMESTAMPTZ,
268 state TEXT NOT NULL DEFAULT 'pending' CHECK (state IN ('pending','invalid','found','collecting','collected','validating','valid','reacting','reacted','cleaning','complete','error')),
269 user_data TEXT CHECK (user_data IS NULL OR is_json( user_data )),
270 template_output BIGINT REFERENCES action_trigger.event_output (id),
271 error_output BIGINT REFERENCES action_trigger.event_output (id),
272 async_output BIGINT REFERENCES action_trigger.event_output (id)
274 CREATE INDEX atev_target_def_idx ON action_trigger.event (target,event_def);
275 CREATE INDEX atev_def_state ON action_trigger.event (event_def,state);
277 CREATE TABLE action_trigger.event_params (
278 id BIGSERIAL PRIMARY KEY,
279 event_def INT NOT NULL REFERENCES action_trigger.event_definition (id) DEFERRABLE INITIALLY DEFERRED,
280 param TEXT NOT NULL, -- the key under environment.event.params to store the output of ...
281 value TEXT NOT NULL, -- ... the eval() output of this. Has access to environment (and, well, all of perl)
282 CONSTRAINT event_params_event_def_param_once UNIQUE (event_def,param)
285 CREATE OR REPLACE FUNCTION action_trigger.purge_events() RETURNS VOID AS $_$
287 * Deleting expired events without simultaneously deleting their outputs
288 * creates orphaned outputs. Deleting their outputs and all of the events
289 * linking back to them, plus any outputs those events link to is messy and
290 * inefficient. It's simpler to handle them in 2 sweeping steps.
292 * 1. Delete expired events.
293 * 2. Delete orphaned event outputs.
295 * This has the added benefit of removing outputs that may have been
296 * orphaned by some other process. Such outputs are not usuable by
299 * This does not guarantee that all events within an event group are
300 * purged at the same time. In such cases, the remaining events will
301 * be purged with the next instance of the purge (or soon thereafter).
302 * This is another nod toward efficiency over completeness of old
303 * data that's circling the bit bucket anyway.
307 DELETE FROM action_trigger.event WHERE id IN (
309 FROM action_trigger.event evt
310 JOIN action_trigger.event_definition def ON (def.id = evt.event_def)
311 WHERE def.retention_interval IS NOT NULL
312 AND evt.state <> 'pending'
313 AND evt.update_time < (NOW() - def.retention_interval)
316 WITH linked_outputs AS (
317 SELECT templates.id AS id FROM (
318 SELECT DISTINCT(template_output) AS id
319 FROM action_trigger.event WHERE template_output IS NOT NULL
321 SELECT DISTINCT(error_output) AS id
322 FROM action_trigger.event WHERE error_output IS NOT NULL
324 SELECT DISTINCT(async_output) AS id
325 FROM action_trigger.event WHERE async_output IS NOT NULL
327 ) DELETE FROM action_trigger.event_output
328 WHERE id NOT IN (SELECT id FROM linked_outputs);
331 $_$ LANGUAGE PLPGSQL;