1 package OpenILS::Application::Trigger;
2 use strict; use warnings;
3 use OpenILS::Application;
4 use base qw/OpenILS::Application/;
6 use OpenSRF::EX qw/:try/;
8 use OpenSRF::AppSession;
9 use OpenSRF::Utils::SettingsClient;
10 use OpenSRF::Utils::Logger qw/:level/;
11 use OpenSRF::Utils qw/:datetime/;
14 use DateTime::Format::ISO8601;
16 use OpenILS::Utils::Fieldmapper;
17 use OpenILS::Utils::CStoreEditor q/:funcs/;
18 use OpenILS::Application::Trigger::Event;
19 use OpenILS::Application::Trigger::EventGroup;
22 my $log = 'OpenSRF::Utils::Logger';
27 sub create_active_events_for_object {
34 my $ident = $target->Identity;
35 my $ident_value = $target->$ident();
37 my $editor = new_editor(xact=>1);
39 my $hooks = $editor->search_action_trigger_hook(
41 core_type => $target->json_hint
45 my %hook_hash = map { ($_->key, $_) } @$hooks;
47 my $orgs = $editor->json_query({ from => [ 'actor.org_unit_ancestors' => $location ] });
48 my $defs = $editor->search_action_trigger_event_definition(
49 { hook => [ keys %hook_hash ],
50 owner => [ map { $_->{id} } @$orgs ],
55 for my $def ( @$defs ) {
57 my $date = DateTime->now;
59 if ($hook_hash{$def->hook}->passive eq 'f') {
61 if (my $dfield = $def->delay_field) {
62 if ($target->$dfield()) {
63 $date = DateTime::Format::ISO8601->new->parse_datetime( clense_ISO8601($target->$dfield) );
69 $date->add( seconds => interval_to_seconds($def->delay) );
72 my $event = Fieldmapper::action_trigger::event->new();
73 $event->target( $ident_value );
74 $event->event_def( $def->id );
75 $event->run_time( $date->strftime( '%F %T%z' ) );
77 $editor->create_action_trigger_event( $event );
79 $client->respond( $event->id );
86 __PACKAGE__->register_method(
87 api_name => 'open-ils.trigger.event.autocreate',
88 method => 'create_active_events_for_object',
95 # Retrieves events by object, or object type + filter
96 # $object : a target object or object type (class hint)
98 # $filter : an optional hash of filters ... top level keys:
100 # filters on the atev objects, such as states or null-ness of timing
101 # fields. contains the effective default of:
102 # { state => 'pending' }
103 # an example, which overrides the default, and will find
104 # stale 'found' events:
105 # { state => 'found', update_time => { '<' => 'yesterday' } }
108 # filters on the atevdef object. contains the effective default of:
112 # filters on the hook object. no defaults, but there is a pinned,
113 # unchangeable filter based on the passed hint or object type (see
114 # $object above). an example for finding passive events:
118 # filters against the target field on the event. this can contain
119 # either an array of target ids (if you passed an object type, and
120 # not an object) or can contain a json_query that will return exactly
121 # a list of target-type ids. If you pass an object, the pkey value of
122 # that object will be used as a filter in addition to the filter passed
123 # in here. example filter for circs of user 1234 that are open:
124 # { select => { circ => ['id'] },
128 # checkin_time => undef,
130 # { stop_fines => undef },
131 # { stop_fines => { 'not in' => ['LOST','LONGOVERDUE','CLAIMSRETURNED'] } }
135 sub events_by_target {
139 my $filter = shift || {};
140 my $flesh_fields = shift || {};
141 my $flesh_depth = shift || 1;
143 my $obj_class = ref($object) || _fm_class_by_hint($object);
144 my $obj_hint = ref($object) ? _fm_hint_by_class(ref($object)) : $object;
146 my $object_ident_field = $obj_class->Identity;
149 select => { atev => ["id"] },
156 ath => { field => "key", fkey => "hook" }
162 "+ath" => { core_type => $obj_hint },
163 "+atevdef" => { active => 't' },
164 "+atev" => { state => 'pending' }
166 order_by => { "+atev" => [ 'run_time' ] },
171 # allow multiple 'target' filters
172 $query->{where}->{'+atev'}->{'-and'} = [];
174 # if we got a real object, filter on its pkey value
175 if (ref($object)) { # pass an object, require that target
176 push @{ $query->{where}->{'+atev'}->{'-and'} },
177 { target => $object->$object_ident_field }
180 # we have a fancy complex target filter or a list of target ids
181 if ($$filter{target}) {
182 push @{ $query->{where}->{'+atev'}->{'-and'} },
183 { target => {in => $$filter{target} } };
186 # pass no target filter or object, you get no events
187 if (!@{ $query->{where}->{'+atev'}->{'-and'} }) {
191 # any hook filters, other than the required core_type filter
192 if ($$filter{hook}) {
193 $query->{where}->{'+ath'}->{$_} = $$filter{hook}{$_}
194 for (grep { $_ ne 'core_type' } keys %{$$filter{hook}});
197 # any event_def filters. defaults to { active => 't' }
198 if ($$filter{event_def}) {
199 $query->{where}->{'+atevdef'}->{$_} = $$filter{event_def}{$_}
200 for (keys %{$$filter{event_def}});
203 # any event filters. defaults to { state => 'pending' }.
204 # don't overwrite '-and' used for multiple target filters above
205 if ($$filter{event}) {
206 $query->{where}->{'+atev'}->{$_} = $$filter{event}{$_}
207 for (grep { $_ ne '-and' } keys %{$$filter{event}});
210 my $e = new_editor();
212 my $events = $e->json_query($query);
214 $flesh_fields->{atev} = ['event_def'] unless $flesh_fields->{atev};
216 for my $id (@$events) {
217 my $event = $e->retrieve_action_trigger_event([
219 {flesh => $flesh_depth, flesh_fields => $flesh_fields}
222 (my $meth = $obj_class) =~ s/^Fieldmapper:://o;
224 $meth = 'retrieve_'.$meth;
226 $event->target($e->$meth($event->target));
227 $client->respond($event);
232 __PACKAGE__->register_method(
233 api_name => 'open-ils.trigger.events_by_target',
234 method => 'events_by_target',
240 sub _fm_hint_by_class {
242 return Fieldmapper->publish_fieldmapper->{$class}->{hint};
245 sub _fm_class_by_hint {
249 Fieldmapper->publish_fieldmapper->{$_}->{hint} eq $hint
250 } keys %{ Fieldmapper->publish_fieldmapper };
255 sub create_batch_events {
259 my $location_field = shift; # where to look for event_def.owner filtering ... circ_lib, for instance, where hook.core_type = circ
260 my $filter = shift || {};
262 my $active = ($self->api_name =~ /active/o) ? 1 : 0;
263 if ($active && !keys(%$filter)) {
264 $log->info("Active batch event creation requires a target filter but none was supplied to create_batch_events");
268 return undef unless ($key && $location_field);
270 my $editor = new_editor(xact=>1);
271 my $hooks = $editor->search_action_trigger_hook(
272 { passive => $active ? 'f' : 't', key => $key }
275 my %hook_hash = map { ($_->key, $_) } @$hooks;
277 my $defs = $editor->search_action_trigger_event_definition(
278 { hook => [ keys %hook_hash ], active => 't' },
281 for my $def ( @$defs ) {
283 my $date = DateTime->now->subtract( seconds => interval_to_seconds($def->delay) );
285 # we may need to do some work to backport this to 1.2
286 $filter->{ $location_field } = { 'in' =>
288 select => { aou => [{ column => 'id', transform => 'actor.org_unit_descendents', result_field => 'id' }] },
290 where => { id => $def->owner }
294 my $run_time = 'now';
299 ->add( seconds => interval_to_seconds($def->delay) )
300 ->strftime( '%F %T%z' )
303 $filter->{ $def->delay_field } = {
306 ->subtract( seconds => interval_to_seconds($def->delay) )
307 ->strftime( '%F %T%z' )
311 my $class = _fm_class_by_hint($hook_hash{$def->hook}->core_type);
312 $class =~ s/^Fieldmapper:://o;
315 my $method = 'search_'. $class;
316 my $objects = $editor->$method( $filter );
318 for my $o (@$objects) {
320 my $ident = $o->Identity;
321 my $ident_value = $o->$ident();
325 # only allow one pending event of type $def for each target
326 $previous = $editor->search_action_trigger_event({
327 event_def => $def->id,
328 target => $ident_value,
333 # only allow one event of type $def for each target
334 $previous = $editor->search_action_trigger_event({
335 event_def => $def->id,
336 target => $ident_value
341 next if (ref($previous) && @$previous);
343 my $event = Fieldmapper::action_trigger::event->new();
344 $event->target( $ident_value );
345 $event->event_def( $def->id );
346 $event->run_time( $run_time );
348 $editor->create_action_trigger_event( $event );
350 $client->respond( $event->id );
358 __PACKAGE__->register_method(
359 api_name => 'open-ils.trigger.passive.event.autocreate.batch',
360 method => 'create_batch_events',
366 __PACKAGE__->register_method(
367 api_name => 'open-ils.trigger.active.event.autocreate.batch',
368 method => 'create_batch_events',
375 sub fire_single_event {
378 my $event_id = shift;
380 my $e = OpenILS::Application::Trigger::Event->new($event_id);
382 if ($e->validate->valid) {
388 reacted => $e->reacted,
389 cleanedup => $e->cleanedup,
393 __PACKAGE__->register_method(
394 api_name => 'open-ils.trigger.event.fire',
395 method => 'fire_single_event',
400 sub fire_event_group {
405 my $e = OpenILS::Application::Trigger::EventGroup->new(@$events);
407 if ($e->validate->valid) {
413 reacted => $e->reacted,
414 cleanedup => $e->cleanedup,
415 events => [map { $_->event } @{$e->events}]
418 __PACKAGE__->register_method(
419 api_name => 'open-ils.trigger.event_group.fire',
420 method => 'fire_event_group',
429 my $editor = new_editor();
431 return $editor->search_action_trigger_event([
432 { state => 'pending', run_time => {'<' => 'now'} },
436 __PACKAGE__->register_method(
437 api_name => 'open-ils.trigger.event.find_pending',
438 method => 'pending_events',
447 my ($events) = $self->method_lookup('open-ils.trigger.event.find_pending')->run();
449 my %groups = ( '*' => [] );
451 for my $e_id ( @$events ) {
452 my $e = OpenILS::Application::Trigger::Event->new($e_id);
453 if ($e->validate->valid) {
454 if (my $group = $e->event->event_def->group_field) {
456 # split the grouping link steps
457 my @steps = split '.', $group;
459 # find the grouping object
460 my $node = $e->target;
461 $node = $node->$_() for ( @steps );
463 # get the pkey value for the grouping object on this event
464 my $node_ident = $node->Identity;
465 my $ident_value = $node->$node_ident();
467 # push this event onto the event+grouping_pkey_value stack
468 $groups{$e->event->event_def->id}{$ident_value} ||= [];
469 push @{ $groups{$e->event->event_def->id}{$ident_value} }, $e;
471 # it's a non-grouped event
472 push @{ $groups{'*'} }, $e;
479 __PACKAGE__->register_method(
480 api_name => 'open-ils.trigger.event.find_pending_by_group',
481 method => 'grouped_events',
489 my ($groups) = $self->method_lookup('open-ils.trigger.event.find_pending_by_group')->run();
491 for my $def ( %$groups ) {
493 for my $event ( @{ $$groups{'*'} } ) {
496 ->method_lookup('open-ils.trigger.event.fire')
501 my $defgroup = $$groups{$def};
502 for my $ident ( keys %$defgroup ) {
505 ->method_lookup('open-ils.trigger.event_group.fire')
506 ->run($$defgroup{$ident})
514 __PACKAGE__->register_method(
515 api_name => 'open-ils.trigger.event.run_all_pending',
516 method => 'run_all_events',