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/$logger/;
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
50 my %hook_hash = map { ($_->key, $_) } @$hooks;
52 my $orgs = $editor->json_query({ from => [ 'actor.org_unit_ancestors' => $location ] });
53 my $defs = $editor->search_action_trigger_event_definition(
54 { hook => [ keys %hook_hash ],
55 owner => [ map { $_->{id} } @$orgs ],
60 for my $def ( @$defs ) {
62 my $date = DateTime->now;
64 if ($hook_hash{$def->hook}->passive eq 'f') {
66 if (my $dfield = $def->delay_field) {
67 if ($target->$dfield()) {
68 $date = DateTime::Format::ISO8601->new->parse_datetime( clense_ISO8601($target->$dfield) );
74 $date->add( seconds => interval_to_seconds($def->delay) );
77 my $event = Fieldmapper::action_trigger::event->new();
78 $event->target( $ident_value );
79 $event->event_def( $def->id );
80 $event->run_time( $date->strftime( '%F %T%z' ) );
82 $editor->create_action_trigger_event( $event );
84 $client->respond( $event->id );
91 __PACKAGE__->register_method(
92 api_name => 'open-ils.trigger.event.autocreate',
93 method => 'create_active_events_for_object',
99 sub create_event_for_object_and_def {
102 my $definitions = shift;
104 my $location = shift;
106 my $ident = $target->Identity;
107 my $ident_value = $target->$ident();
109 my @active = ($self->api_name =~ /inactive/o) ? () : ( active => 't' );
111 my $editor = new_editor(xact=>1);
113 my $orgs = $editor->json_query({ from => [ 'actor.org_unit_ancestors' => $location ] });
114 my $defs = $editor->search_action_trigger_event_definition(
115 { id => $definitions,
116 owner => [ map { $_->{id} } @$orgs ],
121 my $hooks = $editor->search_action_trigger_hook(
122 { key => [ map { $_->hook } @$defs ],
123 core_type => $target->json_hint
127 my %hook_hash = map { ($_->key, $_) } @$hooks;
129 for my $def ( @$defs ) {
131 my $date = DateTime->now;
133 if ($hook_hash{$def->hook}->passive eq 'f') {
135 if (my $dfield = $def->delay_field) {
136 if ($target->$dfield()) {
137 $date = DateTime::Format::ISO8601->new->parse_datetime( clense_ISO8601($target->$dfield) );
143 $date->add( seconds => interval_to_seconds($def->delay) );
146 my $event = Fieldmapper::action_trigger::event->new();
147 $event->target( $ident_value );
148 $event->event_def( $def->id );
149 $event->run_time( $date->strftime( '%F %T%z' ) );
151 $editor->create_action_trigger_event( $event );
153 $client->respond( $event->id );
160 __PACKAGE__->register_method(
161 api_name => 'open-ils.trigger.event.autocreate.by_definition',
162 method => 'create_event_for_object_and_def',
167 __PACKAGE__->register_method(
168 api_name => 'open-ils.trigger.event.autocreate.by_definition.include_inactive',
169 method => 'create_event_for_object_and_def',
176 # Retrieves events by object, or object type + filter
177 # $object : a target object or object type (class hint)
179 # $filter : an optional hash of filters ... top level keys:
181 # filters on the atev objects, such as states or null-ness of timing
182 # fields. contains the effective default of:
183 # { state => 'pending' }
184 # an example, which overrides the default, and will find
185 # stale 'found' events:
186 # { state => 'found', update_time => { '<' => 'yesterday' } }
189 # filters on the atevdef object. contains the effective default of:
193 # filters on the hook object. no defaults, but there is a pinned,
194 # unchangeable filter based on the passed hint or object type (see
195 # $object above). an example for finding passive events:
199 # filters against the target field on the event. this can contain
200 # either an array of target ids (if you passed an object type, and
201 # not an object) or can contain a json_query that will return exactly
202 # a list of target-type ids. If you pass an object, the pkey value of
203 # that object will be used as a filter in addition to the filter passed
204 # in here. example filter for circs of user 1234 that are open:
205 # { select => { circ => ['id'] },
209 # checkin_time => undef,
211 # { stop_fines => undef },
212 # { stop_fines => { 'not in' => ['LOST','LONGOVERDUE','CLAIMSRETURNED'] } }
216 sub events_by_target {
220 my $filter = shift || {};
221 my $flesh_fields = shift || {};
222 my $flesh_depth = shift || 1;
224 my $obj_class = ref($object) || _fm_class_by_hint($object);
225 my $obj_hint = ref($object) ? _fm_hint_by_class(ref($object)) : $object;
227 my $object_ident_field = $obj_class->Identity;
230 select => { atev => ["id"] },
237 ath => { field => "key", fkey => "hook" }
243 "+ath" => { core_type => $obj_hint },
244 "+atevdef" => { active => 't' },
245 "+atev" => { state => 'pending' }
247 order_by => { "atev" => [ 'run_time', 'add_time' ] }
251 # allow multiple 'target' filters
252 $query->{where}->{'+atev'}->{'-and'} = [];
254 # if we got a real object, filter on its pkey value
255 if (ref($object)) { # pass an object, require that target
256 push @{ $query->{where}->{'+atev'}->{'-and'} },
257 { target => $object->$object_ident_field }
260 # we have a fancy complex target filter or a list of target ids
261 if ($$filter{target}) {
262 push @{ $query->{where}->{'+atev'}->{'-and'} },
263 { target => {in => $$filter{target} } };
266 # pass no target filter or object, you get no events
267 if (!@{ $query->{where}->{'+atev'}->{'-and'} }) {
271 # any hook filters, other than the required core_type filter
272 if ($$filter{hook}) {
273 $query->{where}->{'+ath'}->{$_} = $$filter{hook}{$_}
274 for (grep { $_ ne 'core_type' } keys %{$$filter{hook}});
277 # any event_def filters. defaults to { active => 't' }
278 if ($$filter{event_def}) {
279 $query->{where}->{'+atevdef'}->{$_} = $$filter{event_def}{$_}
280 for (keys %{$$filter{event_def}});
283 # any event filters. defaults to { state => 'pending' }.
284 # don't overwrite '-and' used for multiple target filters above
285 if ($$filter{event}) {
286 $query->{where}->{'+atev'}->{$_} = $$filter{event}{$_}
287 for (grep { $_ ne '-and' } keys %{$$filter{event}});
290 my $e = new_editor();
292 my $events = $e->json_query($query);
294 $flesh_fields->{atev} = ['event_def'] unless $flesh_fields->{atev};
296 for my $id (@$events) {
297 my $event = $e->retrieve_action_trigger_event([
299 {flesh => $flesh_depth, flesh_fields => $flesh_fields}
302 (my $meth = $obj_class) =~ s/^Fieldmapper:://o;
304 $meth = 'retrieve_'.$meth;
306 $event->target($e->$meth($event->target));
307 $client->respond($event);
312 __PACKAGE__->register_method(
313 api_name => 'open-ils.trigger.events_by_target',
314 method => 'events_by_target',
320 sub _fm_hint_by_class {
322 return Fieldmapper->publish_fieldmapper->{$class}->{hint};
325 sub _fm_class_by_hint {
329 Fieldmapper->publish_fieldmapper->{$_}->{hint} eq $hint
330 } keys %{ Fieldmapper->publish_fieldmapper };
335 sub create_batch_events {
339 my $location_field = shift; # where to look for event_def.owner filtering ... circ_lib, for instance, where hook.core_type = circ
340 my $filter = shift || {};
341 my $granularity = shift;
343 my $active = ($self->api_name =~ /active/o) ? 1 : 0;
344 if ($active && !keys(%$filter)) {
345 $log->info("Active batch event creation requires a target filter but none was supplied to create_batch_events");
349 return undef unless ($key && $location_field);
351 my $editor = new_editor(xact=>1);
352 my $hooks = $editor->search_action_trigger_hook(
353 { passive => $active ? 'f' : 't', key => $key }
356 my %hook_hash = map { ($_->key, $_) } @$hooks;
358 my $defs = $editor->search_action_trigger_event_definition(
359 { hook => [ keys %hook_hash ], active => 't' },
362 my $orig_filter_and = [];
363 if ($$filter{'-and'}) {
364 for my $f ( @{ $$filter{'-and'} } ) {
365 push @$orig_filter_and, $f;
369 for my $def ( @$defs ) {
371 my $date = DateTime->now->subtract( seconds => interval_to_seconds($def->delay) );
373 # we may need to do some work to backport this to 1.2
374 $filter->{ $location_field } = { 'in' =>
376 select => { aou => [{ column => 'id', transform => 'actor.org_unit_descendants', result_field => 'id' }] },
378 where => { id => $def->owner }
382 my $run_time = 'now';
387 ->add( seconds => interval_to_seconds($def->delay) )
388 ->strftime( '%F %T%z' );
390 if ($def->max_delay) {
391 my @times = sort {$a <=> $b} interval_to_seconds($def->delay), interval_to_seconds($def->max_delay);
392 $filter->{ $def->delay_field } = {
394 DateTime->now->subtract( seconds => $times[1] )->strftime( '%F %T%z' ),
395 DateTime->now->subtract( seconds => $times[0] )->strftime( '%F %T%z' )
399 $filter->{ $def->delay_field } = {
400 '<=' => DateTime->now->subtract( seconds => interval_to_seconds($def->delay) )->strftime( '%F %T%z' )
405 my $class = _fm_class_by_hint($hook_hash{$def->hook}->core_type);
407 # filter where this target has an event (and it's pending, for active hooks)
408 $$filter{'-and'} = [];
409 for my $f ( @$orig_filter_and ) {
410 push @{ $$filter{'-and'} }, $f;
413 push @{ $filter->{'-and'} }, {
417 event_def => $def->id,
418 target => { '=' => { '+' . $hook_hash{$def->hook}->core_type => $class->Identity } },
419 ($active ? (state => 'pending') : ())
424 $class =~ s/^Fieldmapper:://o;
427 my $method = 'search_'. $class;
428 my $object_ids = $editor->$method( $filter, {idlist => 1, timeout => 1800} );
430 for my $o_id (@$object_ids) {
432 my $event = Fieldmapper::action_trigger::event->new();
433 $event->target( $o_id );
434 $event->event_def( $def->id );
435 $event->run_time( $run_time );
436 $event->granularity($granularity) if (defined $granularity);
438 $editor->create_action_trigger_event( $event );
440 $client->respond( $event->id );
448 __PACKAGE__->register_method(
449 api_name => 'open-ils.trigger.passive.event.autocreate.batch',
450 method => 'create_batch_events',
456 __PACKAGE__->register_method(
457 api_name => 'open-ils.trigger.active.event.autocreate.batch',
458 method => 'create_batch_events',
464 sub fire_single_event {
467 my $event_id = shift;
469 my $e = OpenILS::Application::Trigger::Event->new($event_id);
471 if ($e->validate->valid) {
472 $logger->info("Event is valid, reacting...");
476 $e->editor->disconnect;
480 reacted => $e->reacted,
481 cleanedup => $e->cleanedup,
485 __PACKAGE__->register_method(
486 api_name => 'open-ils.trigger.event.fire',
487 method => 'fire_single_event',
492 sub fire_event_group {
497 my $e = OpenILS::Application::Trigger::EventGroup->new(@$events);
499 if ($e->validate->valid) {
500 $logger->info("Event group is valid, reacting...");
504 $e->editor->disconnect;
508 reacted => $e->reacted,
509 cleanedup => $e->cleanedup,
510 events => [map { $_->event } @{$e->events}]
513 __PACKAGE__->register_method(
514 api_name => 'open-ils.trigger.event_group.fire',
515 method => 'fire_event_group',
523 my $granularity = shift;
525 my $editor = new_editor();
527 my $query = [{ state => 'pending', run_time => {'<' => 'now'} }, { order_by => { atev => [ qw/run_time add_time/] }, 'join' => 'atevdef' }];
529 if (defined $granularity) {
530 $query->[0]->{'+atevdef'} = {'-or' => [ {granularity => $granularity}, {granularity => undef} ] };
532 $query->[0]->{'+atevdef'} = {granularity => undef};
535 return $editor->search_action_trigger_event(
536 $query, { idlist=> 1, timeout => 1800 }
539 __PACKAGE__->register_method(
540 api_name => 'open-ils.trigger.event.find_pending',
541 method => 'pending_events',
548 my $granularity = shift;
550 my ($events) = $self->method_lookup('open-ils.trigger.event.find_pending')->run($granularity);
552 my %groups = ( '*' => [] );
554 for my $e_id ( @$events ) {
555 $logger->info("trigger: processing event $e_id");
557 # let the client know we're still chugging along TODO add osrf support for method_lookup $client's
558 $client->status( new OpenSRF::DomainObject::oilsContinueStatus );
562 $e = OpenILS::Application::Trigger::Event->new($e_id);
564 $logger->error("Event creation failed with ".shift());
570 $e->build_environment;
572 $logger->error("Event environment building failed with ".shift());
575 if (my $group = $e->event->event_def->group_field) {
577 # split the grouping link steps
578 my @steps = split /\./, $group;
580 # find the grouping object
581 my $node = $e->target;
582 $node = $node->$_() for ( @steps );
584 # get the pkey value for the grouping object on this event
585 my $node_ident = $node->Identity;
586 my $ident_value = $node->$node_ident();
588 # push this event onto the event+grouping_pkey_value stack
589 $groups{$e->event->event_def->id}{$ident_value} ||= [];
590 push @{ $groups{$e->event->event_def->id}{$ident_value} }, $e;
592 # it's a non-grouped event
593 push @{ $groups{'*'} }, $e;
596 $e->editor->disconnect;
601 __PACKAGE__->register_method(
602 api_name => 'open-ils.trigger.event.find_pending_by_group',
603 method => 'grouped_events',
610 my $granularity = shift;
612 my ($groups) = $self->method_lookup('open-ils.trigger.event.find_pending_by_group')->run($granularity);
614 for my $def ( keys %$groups ) {
616 for my $event ( @{ $$groups{'*'} } ) {
620 ->method_lookup('open-ils.trigger.event.fire')
624 $logger->error("event firing failed with ".shift());
628 my $defgroup = $$groups{$def};
629 for my $ident ( keys %$defgroup ) {
633 ->method_lookup('open-ils.trigger.event_group.fire')
634 ->run($$defgroup{$ident})
637 $logger->error("event firing failed with ".shift());
645 __PACKAGE__->register_method(
646 api_name => 'open-ils.trigger.event.run_all_pending',
647 method => 'run_all_events',