1 package OpenILS::Application::Trigger::Event;
2 use strict; use warnings;
3 use OpenSRF::EX qw/:try/;
5 use OpenSRF::Utils::Logger qw/:logger/;
7 use OpenILS::Utils::Fieldmapper;
8 use OpenILS::Utils::CStoreEditor q/:funcs/;
9 use OpenILS::Application::Trigger::ModRunner;
13 my $log = 'OpenSRF::Utils::Logger';
19 $class = ref($class) || $class;
21 return $id if (ref($id) && ref($id) eq $class);
23 my $standalone = $editor ? 0 : 1;
24 $editor ||= new_editor();
26 my $self = bless { id => $id, editor => $editor, standalone => $standalone } => $class;
35 return $self if ($self->event);
38 $self->environment( {} );
41 $log->error("No Event ID provided");
42 die "No Event ID provided";
45 return $self if (!$self->id);
48 $self->editor->retrieve_action_trigger_event([
52 atev => [ qw/event_def/ ],
53 atevdef => [ qw/hook env params/ ]
59 if ($self->event->state eq 'valid') {
61 } elsif ($self->event->state eq 'invalid') {
63 } elsif ($self->event->state eq 'reacting') {
65 } elsif ($self->event->state eq 'reacted') {
68 } elsif ($self->event->state eq 'cleaning') {
71 } elsif ($self->event->state eq 'complete') {
75 } elsif ($self->event->state eq 'error') {
82 $self->update_state('found') || die 'Unable to update event state';
84 my $class = $self->_fm_class_by_hint( $self->event->event_def->hook->core_type );
86 my $meth = "retrieve_" . $class;
87 $meth =~ s/Fieldmapper:://;
90 $self->target( $self->editor->$meth( $self->event->target ) );
97 my $env = shift || $self->environment;
99 return $self if (defined $self->cleanedup);
101 if (defined $self->reacted) {
102 $self->update_state( 'cleaning') || die 'Unable to update event state';
104 my $cleanup = $self->reacted ? $self->event->event_def->cleanup_success : $self->event->event_def->cleanup_failure;
107 OpenILS::Application::Trigger::ModRunner::Cleanup
108 ->new( $cleanup, $env)
116 $log->error( shift() );
117 $self->update_state( 'error' ) || die 'Unable to update event state';
120 if ($self->cleanedup) {
121 $self->update_state( 'complete' ) || die 'Unable to update event state';
123 $self->update_state( 'error' ) || die 'Unable to update event state';
127 $self->{cleanedup} = undef;
134 my $env = shift || $self->environment;
136 return $self if (defined $self->reacted);
139 if ($self->event->event_def->group_field) { # can't react individually to a grouped definition
140 $self->{reacted} = undef;
142 $self->update_state( 'reacting') || die 'Unable to update event state';
145 OpenILS::Application::Trigger::ModRunner::Reactor
146 ->new( $self->event->event_def->reactor, $env )
151 $log->error( shift() );
152 $self->update_state( 'error' ) || die 'Unable to update event state';
155 if (defined $self->reacted) {
156 $self->update_state( 'reacted' ) || die 'Unable to update event state';
158 $self->update_state( 'error' ) || die 'Unable to update event state';
162 $self->{reacted} = undef;
170 return $self if (defined $self->valid);
172 if ($self->build_environment->environment->{complete}) {
173 $self->update_state( 'validating') || die 'Unable to update event state';
176 OpenILS::Application::Trigger::ModRunner::Validator
177 ->new( $self->event->event_def->validator, $self->environment )
182 $log->error( shift() );
183 $self->update_state( 'error' ) || die 'Unable to update event state';
186 if (defined $self->valid) {
188 $self->update_state( 'valid' ) || die 'Unable to update event state';
190 $self->update_state( 'invalid' ) || die 'Unable to update event state';
193 $self->update_state( 'error' ) || die 'Unable to update event state';
196 $self->{valid} = undef
204 return undef unless (ref $self);
207 $self->{cleanedup} = $c if (defined $c);
208 return $self->{cleanedup};
213 return undef unless (ref $self);
216 $self->{reacted} = $r if (defined $r);
217 return $self->{reacted};
222 return undef unless (ref $self);
225 $self->{valid} = $v if (defined $v);
226 return $self->{valid};
231 return undef unless (ref $self);
234 $self->{event} = $e if (defined $e);
235 return $self->{event};
240 return undef unless (ref $self);
243 $self->{id} = $i if (defined $i);
249 return undef unless (ref $self);
252 $self->{environment} = $e if (defined $e);
253 return $self->{environment};
258 return undef unless (ref $self);
261 $self->{editor} = $e if (defined $e);
262 return $self->{editor};
267 return undef unless (ref $self);
269 die 'Cannot unfind a reacted event' if (defined $self->reacted);
271 $self->update_state( 'pending' ) || die 'Unable to update event state';
273 $self->{event} = undef;
274 $self->{environment} = undef;
280 return undef unless (ref $self);
283 $self->{target} = $t if (defined $t);
284 return $self->{target};
289 return undef unless (ref $self);
292 $self->{standalone} = $t if (defined $t);
293 return $self->{standalone};
298 return undef unless ($self && ref $self);
301 return undef unless ($state);
305 if ($self->standalone) {
306 $self->editor->xact_begin || return undef;
309 my $e = $self->editor->retrieve_action_trigger_event( $self->id );
311 $log->error( "Could not retrieve object ".$self->id." for update" ) if (!$e);
315 if ($fields && ref($fields)) {
316 $e->$_($$fields{$_}) for (keys %$fields);
319 $log->info( "Retrieved object ".$self->id." for update" );
320 $e->start_time( 'now' ) unless $e->start_time;
321 $e->update_time( 'now' );
322 $e->update_process( $$ );
325 $e->clear_start_time() if ($e->state eq 'pending');
327 my $ok = $self->editor->update_action_trigger_event( $e );
329 $self->editor->xact_rollback if ($self->standalone);
330 $log->error( "Update of event ".$self->id." failed" );
333 $e = $self->editor->data;
334 $e = $self->editor->retrieve_action_trigger_event( $e ) if (!ref($e));
336 $log->error( "Update of event ".$self->id." did not return an object" );
339 $log->info( "Update of event ".$e->id." suceeded" );
340 $ok = $self->editor->xact_commit if ($self->standalone);
344 $self->event->start_time( $e->start_time );
345 $self->event->update_time( $e->update_time );
346 $self->event->update_process( $e->update_process );
347 $self->event->state( $e->state );
353 my $current_environment;
355 sub build_environment {
357 return $self if ($self->environment->{complete});
359 $self->update_state( 'collecting') || die 'Unable to update event state';
363 my $compartment = new Safe;
364 $compartment->permit(':default',':load');
365 $compartment->share('$current_environment');
367 $self->environment->{EventProcessor} = $self;
368 $self->environment->{target} = $self->target;
369 $self->environment->{event} = $self->event;
370 $self->environment->{template} = $self->event->event_def->template;
372 $current_environment = $self->environment;
374 $self->environment->{params}{ $_->param } = $compartment->reval($_->value) for ( @{$self->event->event_def->params} );
376 for my $e ( @{$self->event->event_def->env} ) {
378 @path = split(/\./, $e->path) if ($e->path);
379 @label = split(/\./, $e->label) if ($e->label);
381 $self->_object_by_path( $self->target, $e->collector, \@label, \@path );
384 if ($self->event->event_def->group_field) {
385 my @group_path = split(/\./, $self->event->event_def->group_field);
386 my $group_object = $self->_object_by_path( $self->target, undef, [], \@group_path );
389 $self->environment->{complete} = 1;
391 $log->error( shift() );
392 $self->update_state( 'error' ) || die 'Unable to update event state';
395 if ($self->environment->{complete}) {
396 $self->update_state( 'collected' ) || die 'Unable to update event state';
398 $self->update_state( 'error' ) || die 'Unable to update event state';
404 sub _fm_class_by_hint {
409 Fieldmapper->publish_fieldmapper->{$_}->{hint} eq $hint
410 } keys %{ Fieldmapper->publish_fieldmapper };
415 sub _object_by_path {
418 my $collector = shift;
422 my $step = shift(@$path);
424 my $fhint = Fieldmapper->publish_fieldmapper->{$context->class_name}{links}{$step}{class};
425 my $fclass = $self->_fm_class_by_hint( $fhint );
427 my $ffield = Fieldmapper->publish_fieldmapper->{$context->class_name}{links}{$step}{key};
428 my $rtype = Fieldmapper->publish_fieldmapper->{$context->class_name}{links}{$step}{reltype};
430 my $meth = 'retrieve_';
433 if ($rtype ne 'has_a') {
436 $lfield = $context->Identity;
440 $meth =~ s/Fieldmapper:://;
443 my $ed = grep( /open-ils.cstore/, @{$fclass->Controller} ) ?
447 my $obj = $context->$step();
452 { $ffield => $context->$lfield() } :
461 $obj_list = [$obj] if ($obj);
467 my @path_clone = @$path;
468 $self->_object_by_path( $_, $collector, $label, \@path_clone );
471 $obj = $$obj_list[0] if (!$multi || $rtype eq 'might_have');
472 $context->$step( $obj ) if ($obj && (!$label || !@$label));
477 my $obj_list = [$obj] if ($obj && !$multi);
478 $obj_list = $obj if ($multi);
481 for my $o ( @$obj_list ) {
483 OpenILS::Application::Trigger::ModRunner::Collector
484 ->new( $collector, $o )
490 $obj = $new_obj_list[0];
492 $obj = \@new_obj_list;
496 if ($label && @$label) {
497 my $node = $self->environment;
498 my $i = 0; my $max = scalar(@$label);
499 for (; $i < $max; $i++) {
500 my $part = $$label[$i];
501 $$node{$part} ||= {};
502 $node = $$node{$part};
504 $$node{$$label[-1]} = $obj;
506 $obj = $$obj[0] if $rtype eq 'might_have';
507 $context->$step( $obj ) if ($obj);