1 package OpenILS::Application::Trigger::Event;
2 use OpenSRF::EX qw/:try/;
4 use OpenSRF::Utils::Logger qw/:logger/;
6 use OpenILS::Utils::Fieldmapper;
7 use OpenILS::Utils::CStoreEditor q/:funcs/;
8 use OpenILS::Application::Trigger::ModRunner;
10 my $log = 'OpenSRF::Utils::Logger';
16 $class = ref($class) || $class;
18 return $id if (ref($id) && ref($id) == $class);
20 my $standalone = $editor ? 0 : 1;
21 $editor ||= new_editor();
23 my $self = bless { id => $id, editor => $editor, standalone => $standalone } => $class;
32 return $self if ($self->event);
35 $self->environment( {} );
38 $log->error("No Event ID provided");
39 die "No Event ID provided";
42 return $self if (!$self->id);
45 $self->editor->retrieve_action_trigger_event([
49 atev => [ qw/event_def/ ],
50 atevdef => [ qw/hook env params/ ]
56 if ($self->event->state eq 'valid') {
58 } elsif ($self->event->state eq 'invalid') {
60 } elsif ($self->event->state eq 'reacting') {
62 } elsif ($self->event->state eq 'reacted') {
65 } elsif ($self->event->state eq 'cleaning') {
68 } elsif ($self->event->state eq 'complete') {
72 } elsif ($self->event->state eq 'error') {
79 $self->update_state('found') || die 'Unable to update event state';
81 my $class = $self->_fm_class_by_hint( $self->event->event_def->hook->core_type );
83 my $meth = "retrieve_" . $class;
84 $meth =~ s/Fieldmapper:://;
87 $self->target( $self->editor->$meth( $self->event->target ) );
94 my $env = shift || $self->environment;
96 return $self if (defined $self->cleanedup);
98 if (defined $self->reacted) {
99 $self->update_state( 'cleaning') || die 'Unable to update event state';
101 my $cleanup = $self->reacted ? $self->event->event_def->cleanup_success : $self->event->event_def->cleanup_failure;
104 OpenILS::Application::Trigger::ModRunner::Cleanup
105 ->new( $cleanup, $env)
113 $log->error( shift() );
114 $self->update_state( 'error' ) || die 'Unable to update event state';
117 if ($self->cleanedup) {
118 $self->update_state( 'complete' ) || die 'Unable to update event state';
120 $self->update_state( 'error' ) || die 'Unable to update event state';
124 $self->{cleanedup} = undef;
131 my $env = shift || $self->environment;
133 return $self if (defined $self->reacted);
136 if ($self->event->event_def->group_field) { # can't react individually to a grouped definition
137 $self->{reacted} = undef;
139 $self->update_state( 'reacting') || die 'Unable to update event state';
142 OpenILS::Application::Trigger::ModRunner::Reactor
143 ->new( $self->event->event_def->reactor, $env )
148 $log->error( shift() );
149 $self->update_state( 'error' ) || die 'Unable to update event state';
152 if (defined $self->reacted) {
153 $self->update_state( 'reacted' ) || die 'Unable to update event state';
155 $self->update_state( 'error' ) || die 'Unable to update event state';
159 $self->{reacted} = undef;
167 return $self if (defined $self->valid);
169 if ($self->build_environment->environment->{complete}) {
170 $self->update_state( 'validating') || die 'Unable to update event state';
173 OpenILS::Application::Trigger::ModRunner::Validator
174 ->new( $self->event->event_def->validator, $self->environment )
179 $log->error( shift() );
180 $self->update_state( 'error' ) || die 'Unable to update event state';
183 if (defined $self->valid) {
185 $self->update_state( 'valid' ) || die 'Unable to update event state';
187 $self->update_state( 'invalid' ) || die 'Unable to update event state';
190 $self->update_state( 'error' ) || die 'Unable to update event state';
193 $self->{valid} = undef
201 return undef unless (ref $self);
204 $self->{cleanedup} = $c if (defined $c);
205 return $self->{cleanedup};
210 return undef unless (ref $self);
213 $self->{reacted} = $r if (defined $r);
214 return $self->{reacted};
219 return undef unless (ref $self);
222 $self->{valid} = $v if (defined $v);
223 return $self->{valid};
228 return undef unless (ref $self);
231 $self->{event} = $e if (defined $e);
232 return $self->{event};
237 return undef unless (ref $self);
240 $self->{id} = $i if (defined $i);
246 return undef unless (ref $self);
249 $self->{environment} = $e if (defined $e);
250 return $self->{environment};
255 return undef unless (ref $self);
258 $self->{editor} = $e if (defined $e);
259 return $self->{editor};
264 return undef unless (ref $self);
266 die 'Cannot unfind a reacted event' if (defined $self->reacted);
268 $self->update_state( 'pending' ) || die 'Unable to update event state';
270 $self->{event} = undef;
271 $self->{environment} = undef;
277 return undef unless (ref $self);
280 $self->{target} = $t if (defined $t);
281 return $self->{target};
286 return undef unless (ref $self);
289 $self->{standalone} = $t if (defined $t);
290 return $self->{standalone};
295 return undef unless ($self && ref $self);
298 return undef unless ($state);
302 if ($self->standalone) {
303 $self->editor->xact_begin || return undef;
306 my $e = $self->editor->retrieve_action_trigger_event( $self->id );
308 $log->error( "Could not retrieve object ".$self->id." for update" ) if (!$e);
312 if ($fields && ref($fields)) {
313 $e->$_($$fields{$_}) for (keys %$fields);
316 $log->info( "Retrieved object ".$self->id." for update" );
317 $e->start_time( 'now' ) unless $e->start_time;
318 $e->update_time( 'now' );
319 $e->update_process( $$ );
322 $e->clear_start_time() if ($e->state eq 'pending');
324 my $ok = $self->editor->update_action_trigger_event( $e );
326 $self->editor->xact_rollback if ($self->standalone);
327 $log->error( "Update of event ".$self->id." failed" );
330 $e = $self->editor->data;
331 $e = $self->editor->retrieve_action_trigger_event( $e ) if (!ref($e));
333 $log->error( "Update of event ".$self->id." did not return an object" );
336 $log->info( "Update of event ".$e->id." suceeded" );
337 $ok = $self->editor->xact_commit if ($self->standalone);
341 $self->event->start_time( $e->start_time );
342 $self->event->update_time( $e->update_time );
343 $self->event->update_process( $e->update_process );
344 $self->event->state( $e->state );
350 sub build_environment {
352 return $self if ($self->environment->{complete});
354 $self->update_state( 'collecting') || die 'Unable to update event state';
358 $self->environment->{target} = $self->target;
359 $self->environment->{event} = $self->event;
360 $self->environment->{template} = $self->event->event_def->template;
362 $self->environment->{params}{ $_->param } = eval $_->value for ( @{$self->event->event_def->params} );
364 for my $e ( @{$self->event->event_def->env} ) {
366 @path = split(/\./, $e->path) if ($e->path);
367 @label = split(/\./, $e->label) if ($e->label);
369 $self->_object_by_path( $self->target, $e->collector, \@label, \@path );
372 if ($self->event->event_def->group_field) {
373 my @group_path = split(/\./, $self->event->event_def->group_field);
374 my $group_object = $self->_object_by_path( $self->target, undef, [], \@group_path );
377 $self->environment->{complete} = 1;
379 $log->error( shift() );
380 $self->update_state( 'error' ) || die 'Unable to update event state';
383 if ($self->environment->{complete}) {
384 $self->update_state( 'collected' ) || die 'Unable to update event state';
386 $self->update_state( 'error' ) || die 'Unable to update event state';
392 sub _fm_class_by_hint {
397 Fieldmapper->publish_fieldmapper->{$_}->{hint} eq $hint
398 } keys %{ Fieldmapper->publish_fieldmapper };
403 sub _object_by_path {
406 my $collector = shift;
410 my $step = shift(@$path);
412 my $fhint = Fieldmapper->publish_fieldmapper->{$context->class_name}{links}{$step}{class};
413 my $fclass = $self->_fm_class_by_hint( $fhint );
415 my $ffield = Fieldmapper->publish_fieldmapper->{$context->class_name}{links}{$step}{key};
416 my $rtype = Fieldmapper->publish_fieldmapper->{$context->class_name}{links}{$step}{reltype};
418 my $meth = 'retrieve_';
421 if ($rtype ne 'has_a') {
424 $lfield = $context->Identity;
428 $meth =~ s/Fieldmapper:://;
431 my $ed = grep( /open-ils.cstore/, @{$fclass->Controller} ) ?
435 my $obj = $context->$step();
440 { $ffield => $context->$lfield() } :
448 if (!$multi || $rtype eq 'might_have') {
449 $obj_list = [$obj] if ($obj);
454 $self->_object_by_path( $_, $collector, $label, $path ) for (@$obj_list);
456 $obj = $$obj_list[0] if (!$multi || $rtype eq 'might_have');
457 $context->$step( $obj ) if ($obj && (!$label || !@$label));
462 my $obj_list = [$obj] if ($obj && !$multi);
463 $obj_list = $obj if ($multi);
466 for my $o ( @$obj_list ) {
468 OpenILS::Application::Trigger::ModRunner::Collector
469 ->new( $collector, $o )
475 $obj = $new_obj_list[0];
477 $obj = \@new_obj_list;
481 if ($label && @$label) {
482 my $node = $self->environment;
483 my $i = 0; my $max = scalar(@$label);
484 for (; $i < $max; $i++) {
485 my $part = $$label[$i];
486 $$node{$part} ||= {};
487 $node = $$node{$part};
489 $$node{$$label[-1]} = $obj;
491 $context->$step( $obj ) if ($obj);