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',
94 sub create_event_for_object_and_def {
97 my $definitions = shift;
101 my $ident = $target->Identity;
102 my $ident_value = $target->$ident();
104 my @active = ($self->api_name =~ /inactive/o) ? () : ( active => 't' );
106 my $editor = new_editor(xact=>1);
108 my $orgs = $editor->json_query({ from => [ 'actor.org_unit_ancestors' => $location ] });
109 my $defs = $editor->search_action_trigger_event_definition(
110 { id => $definitions,
111 owner => [ map { $_->{id} } @$orgs ],
116 my $hooks = $editor->search_action_trigger_hook(
117 { key => [ map { $_->hook } @$defs ],
118 core_type => $target->json_hint
122 my %hook_hash = map { ($_->key, $_) } @$hooks;
124 for my $def ( @$defs ) {
126 my $date = DateTime->now;
128 if ($hook_hash{$def->hook}->passive eq 'f') {
130 if (my $dfield = $def->delay_field) {
131 if ($target->$dfield()) {
132 $date = DateTime::Format::ISO8601->new->parse_datetime( clense_ISO8601($target->$dfield) );
138 $date->add( seconds => interval_to_seconds($def->delay) );
141 my $event = Fieldmapper::action_trigger::event->new();
142 $event->target( $ident_value );
143 $event->event_def( $def->id );
144 $event->run_time( $date->strftime( '%F %T%z' ) );
146 $editor->create_action_trigger_event( $event );
148 $client->respond( $event->id );
155 __PACKAGE__->register_method(
156 api_name => 'open-ils.trigger.event.autocreate.by_definition',
157 method => 'create_event_for_object_and_def',
162 __PACKAGE__->register_method(
163 api_name => 'open-ils.trigger.event.autocreate.by_definition.include_inactive',
164 method => 'create_event_for_object_and_def',
171 # Retrieves events by object, or object type + filter
172 # $object : a target object or object type (class hint)
174 # $filter : an optional hash of filters ... top level keys:
176 # filters on the atev objects, such as states or null-ness of timing
177 # fields. contains the effective default of:
178 # { state => 'pending' }
179 # an example, which overrides the default, and will find
180 # stale 'found' events:
181 # { state => 'found', update_time => { '<' => 'yesterday' } }
184 # filters on the atevdef object. contains the effective default of:
188 # filters on the hook object. no defaults, but there is a pinned,
189 # unchangeable filter based on the passed hint or object type (see
190 # $object above). an example for finding passive events:
194 # filters against the target field on the event. this can contain
195 # either an array of target ids (if you passed an object type, and
196 # not an object) or can contain a json_query that will return exactly
197 # a list of target-type ids. If you pass an object, the pkey value of
198 # that object will be used as a filter in addition to the filter passed
199 # in here. example filter for circs of user 1234 that are open:
200 # { select => { circ => ['id'] },
204 # checkin_time => undef,
206 # { stop_fines => undef },
207 # { stop_fines => { 'not in' => ['LOST','LONGOVERDUE','CLAIMSRETURNED'] } }
211 sub events_by_target {
215 my $filter = shift || {};
216 my $flesh_fields = shift || {};
217 my $flesh_depth = shift || 1;
219 my $obj_class = ref($object) || _fm_class_by_hint($object);
220 my $obj_hint = ref($object) ? _fm_hint_by_class(ref($object)) : $object;
222 my $object_ident_field = $obj_class->Identity;
225 select => { atev => ["id"] },
232 ath => { field => "key", fkey => "hook" }
238 "+ath" => { core_type => $obj_hint },
239 "+atevdef" => { active => 't' },
240 "+atev" => { state => 'pending' }
242 order_by => { "+atev" => [ 'run_time' ] },
247 # allow multiple 'target' filters
248 $query->{where}->{'+atev'}->{'-and'} = [];
250 # if we got a real object, filter on its pkey value
251 if (ref($object)) { # pass an object, require that target
252 push @{ $query->{where}->{'+atev'}->{'-and'} },
253 { target => $object->$object_ident_field }
256 # we have a fancy complex target filter or a list of target ids
257 if ($$filter{target}) {
258 push @{ $query->{where}->{'+atev'}->{'-and'} },
259 { target => {in => $$filter{target} } };
262 # pass no target filter or object, you get no events
263 if (!@{ $query->{where}->{'+atev'}->{'-and'} }) {
267 # any hook filters, other than the required core_type filter
268 if ($$filter{hook}) {
269 $query->{where}->{'+ath'}->{$_} = $$filter{hook}{$_}
270 for (grep { $_ ne 'core_type' } keys %{$$filter{hook}});
273 # any event_def filters. defaults to { active => 't' }
274 if ($$filter{event_def}) {
275 $query->{where}->{'+atevdef'}->{$_} = $$filter{event_def}{$_}
276 for (keys %{$$filter{event_def}});
279 # any event filters. defaults to { state => 'pending' }.
280 # don't overwrite '-and' used for multiple target filters above
281 if ($$filter{event}) {
282 $query->{where}->{'+atev'}->{$_} = $$filter{event}{$_}
283 for (grep { $_ ne '-and' } keys %{$$filter{event}});
286 my $e = new_editor();
288 my $events = $e->json_query($query);
290 $flesh_fields->{atev} = ['event_def'] unless $flesh_fields->{atev};
292 for my $id (@$events) {
293 my $event = $e->retrieve_action_trigger_event([
295 {flesh => $flesh_depth, flesh_fields => $flesh_fields}
298 (my $meth = $obj_class) =~ s/^Fieldmapper:://o;
300 $meth = 'retrieve_'.$meth;
302 $event->target($e->$meth($event->target));
303 $client->respond($event);
308 __PACKAGE__->register_method(
309 api_name => 'open-ils.trigger.events_by_target',
310 method => 'events_by_target',
316 sub _fm_hint_by_class {
318 return Fieldmapper->publish_fieldmapper->{$class}->{hint};
321 sub _fm_class_by_hint {
325 Fieldmapper->publish_fieldmapper->{$_}->{hint} eq $hint
326 } keys %{ Fieldmapper->publish_fieldmapper };
331 sub create_batch_events {
335 my $location_field = shift; # where to look for event_def.owner filtering ... circ_lib, for instance, where hook.core_type = circ
336 my $filter = shift || {};
338 my $active = ($self->api_name =~ /active/o) ? 1 : 0;
339 if ($active && !keys(%$filter)) {
340 $log->info("Active batch event creation requires a target filter but none was supplied to create_batch_events");
344 return undef unless ($key && $location_field);
346 my $editor = new_editor(xact=>1);
347 my $hooks = $editor->search_action_trigger_hook(
348 { passive => $active ? 'f' : 't', key => $key }
351 my %hook_hash = map { ($_->key, $_) } @$hooks;
353 my $defs = $editor->search_action_trigger_event_definition(
354 { hook => [ keys %hook_hash ], active => 't' },
357 for my $def ( @$defs ) {
359 my $date = DateTime->now->subtract( seconds => interval_to_seconds($def->delay) );
361 # we may need to do some work to backport this to 1.2
362 $filter->{ $location_field } = { 'in' =>
364 select => { aou => [{ column => 'id', transform => 'actor.org_unit_descendants', result_field => 'id' }] },
366 where => { id => $def->owner }
370 my $run_time = 'now';
375 ->add( seconds => interval_to_seconds($def->delay) )
376 ->strftime( '%F %T%z' );
378 $filter->{ $def->delay_field } = {
381 ->subtract( seconds => interval_to_seconds($def->delay) )
382 ->strftime( '%F %T%z' )
386 my $class = _fm_class_by_hint($hook_hash{$def->hook}->core_type);
387 $class =~ s/^Fieldmapper:://o;
390 my $method = 'search_'. $class;
391 my $objects = $editor->$method( $filter );
393 for my $o (@$objects) {
395 my $ident = $o->Identity;
396 my $ident_value = $o->$ident();
400 # only allow one pending event of type $def for each target
401 $previous = $editor->search_action_trigger_event({
402 event_def => $def->id,
403 target => $ident_value,
408 # only allow one event of type $def for each target
409 $previous = $editor->search_action_trigger_event({
410 event_def => $def->id,
411 target => $ident_value
416 next if (ref($previous) && @$previous);
418 my $event = Fieldmapper::action_trigger::event->new();
419 $event->target( $ident_value );
420 $event->event_def( $def->id );
421 $event->run_time( $run_time );
423 $editor->create_action_trigger_event( $event );
425 $client->respond( $event->id );
433 __PACKAGE__->register_method(
434 api_name => 'open-ils.trigger.passive.event.autocreate.batch',
435 method => 'create_batch_events',
441 __PACKAGE__->register_method(
442 api_name => 'open-ils.trigger.active.event.autocreate.batch',
443 method => 'create_batch_events',
450 sub fire_single_event {
453 my $event_id = shift;
455 my $e = OpenILS::Application::Trigger::Event->new($event_id);
457 if ($e->validate->valid) {
463 reacted => $e->reacted,
464 cleanedup => $e->cleanedup,
468 __PACKAGE__->register_method(
469 api_name => 'open-ils.trigger.event.fire',
470 method => 'fire_single_event',
475 sub fire_event_group {
480 my $e = OpenILS::Application::Trigger::EventGroup->new(@$events);
482 if ($e->validate->valid) {
488 reacted => $e->reacted,
489 cleanedup => $e->cleanedup,
490 events => [map { $_->event } @{$e->events}]
493 __PACKAGE__->register_method(
494 api_name => 'open-ils.trigger.event_group.fire',
495 method => 'fire_event_group',
504 my $editor = new_editor();
506 return $editor->search_action_trigger_event(
507 { state => 'pending', run_time => {'<' => 'now'} },
511 __PACKAGE__->register_method(
512 api_name => 'open-ils.trigger.event.find_pending',
513 method => 'pending_events',
522 my ($events) = $self->method_lookup('open-ils.trigger.event.find_pending')->run();
524 my %groups = ( '*' => [] );
526 for my $e_id ( @$events ) {
527 my $e = OpenILS::Application::Trigger::Event->new($e_id);
528 if ($e->validate->valid) {
529 if (my $group = $e->event->event_def->group_field) {
531 # split the grouping link steps
532 my @steps = split '.', $group;
534 # find the grouping object
535 my $node = $e->target;
536 $node = $node->$_() for ( @steps );
538 # get the pkey value for the grouping object on this event
539 my $node_ident = $node->Identity;
540 my $ident_value = $node->$node_ident();
542 # push this event onto the event+grouping_pkey_value stack
543 $groups{$e->event->event_def->id}{$ident_value} ||= [];
544 push @{ $groups{$e->event->event_def->id}{$ident_value} }, $e;
546 # it's a non-grouped event
547 push @{ $groups{'*'} }, $e;
554 __PACKAGE__->register_method(
555 api_name => 'open-ils.trigger.event.find_pending_by_group',
556 method => 'grouped_events',
564 my ($groups) = $self->method_lookup('open-ils.trigger.event.find_pending_by_group')->run();
566 for my $def ( %$groups ) {
568 for my $event ( @{ $$groups{'*'} } ) {
571 ->method_lookup('open-ils.trigger.event.fire')
576 my $defgroup = $$groups{$def};
577 for my $ident ( keys %$defgroup ) {
580 ->method_lookup('open-ils.trigger.event_group.fire')
581 ->run($$defgroup{$ident})
589 __PACKAGE__->register_method(
590 api_name => 'open-ils.trigger.event.run_all_pending',
591 method => 'run_all_events',