1 package OpenILS::Application::Trigger::Event;
2 use strict; use warnings;
3 use OpenSRF::EX qw/:try/;
4 use OpenSRF::Utils::JSON;
5 use OpenSRF::Utils::Logger qw/$logger/;
6 use OpenILS::Utils::Fieldmapper;
7 use OpenILS::Utils::CStoreEditor q/:funcs/;
8 use OpenILS::Application::Trigger::ModRunner;
11 my $log = 'OpenSRF::Utils::Logger';
17 my $nochanges = shift; # no guarantees, yet...
18 $class = ref($class) || $class;
20 my $standalone = $editor ? 0 : 1;
21 $editor ||= new_editor();
23 if (ref($id) && ref($id) eq $class) {
24 $id->environment->{EventProcessor} = $id
25 if ($id->environment->{complete}); # in case it came over an opensrf tube
26 $id->editor( $editor );
27 $id->standalone( $standalone );
31 my $self = bless { id => $id, editor => $editor, standalone => $standalone, nochanges => $nochanges } => $class;
40 return $self if ($self->event);
43 $self->environment( {} );
46 $log->error("No Event ID provided");
47 die "No Event ID provided";
50 return $self if (!$self->id);
52 if ($self->standalone) {
53 $self->editor->xact_begin || return undef;
57 $self->editor->retrieve_action_trigger_event([
61 atev => [ qw/event_def/ ],
62 atevdef => [ qw/hook env params/ ]
68 if ($self->standalone) {
69 $self->editor->xact_rollback || return undef;
72 $self->user_data(OpenSRF::Utils::JSON->JSON2perl( $self->event->user_data ))
73 if (defined( $self->event->user_data ));
75 if ($self->event->state eq 'valid') {
77 } elsif ($self->event->state eq 'invalid') {
79 } elsif ($self->event->state eq 'reacting') {
81 } elsif ($self->event->state eq 'reacted') {
84 } elsif ($self->event->state eq 'cleaning') {
87 } elsif ($self->event->state eq 'complete') {
91 } elsif ($self->event->state eq 'error') {
97 unless ($self->nochanges) {
98 $self->update_state('found') || die 'Unable to update event state';
101 my $class = $self->_fm_class_by_hint( $self->event->event_def->hook->core_type );
103 my $meth = "retrieve_" . $class;
104 $meth =~ s/Fieldmapper:://;
107 if ($self->standalone) {
108 $self->editor->xact_begin || return undef;
111 $self->target( $self->editor->$meth( $self->event->target ) );
113 if ($self->standalone) {
114 $self->editor->xact_rollback || return undef;
117 unless ($self->target) {
118 $self->update_state('invalid') unless $self->nochanges;
127 my $env = shift || $self->environment;
129 return $self if (defined $self->cleanedup);
131 if (defined $self->reacted) {
132 $self->update_state( 'cleaning') || die 'Unable to update event state';
134 my $cleanup = $self->reacted ? $self->event->event_def->cleanup_success : $self->event->event_def->cleanup_failure;
137 OpenILS::Application::Trigger::ModRunner::Cleanup
138 ->new( $cleanup, $env)
146 $log->error("Event cleanup failed with ". shift() );
147 $self->update_state( 'error' ) || die 'Unable to update event state';
150 if ($self->cleanedup) {
151 $self->update_state( 'complete' ) || die 'Unable to update event state';
153 $self->update_state( 'error' ) || die 'Unable to update event state';
157 $self->{cleanedup} = undef;
164 my $env = shift || $self->environment;
166 return $self if (defined $self->reacted);
169 if ($self->event->event_def->group_field) { # can't react individually to a grouped definition
170 $self->{reacted} = undef;
172 $self->update_state( 'reacting') || die 'Unable to update event state';
175 OpenILS::Application::Trigger::ModRunner::Reactor
176 ->new( $self->event->event_def->reactor, $env )
181 $log->error("Event reacting failed with ". shift() );
182 $self->update_state( 'error' ) || die 'Unable to update event state';
185 if (defined $self->reacted) {
186 $self->update_state( 'reacted' ) || die 'Unable to update event state';
188 $self->update_state( 'error' ) || die 'Unable to update event state';
192 $self->{reacted} = undef;
200 return $self if (defined $self->valid);
202 if ($self->build_environment->environment->{complete}) {
203 $self->update_state( 'validating') || die 'Unable to update event state';
206 OpenILS::Application::Trigger::ModRunner::Validator
207 ->new( $self->event->event_def->validator, $self->environment )
212 $log->error("Event validation failed with ". shift() );
213 $self->update_state( 'error' ) || die 'Unable to update event state';
216 if (defined $self->valid) {
218 $self->update_state( 'valid' ) || die 'Unable to update event state';
220 $self->update_state( 'invalid' ) || die 'Unable to update event state';
223 $self->update_state( 'error' ) || die 'Unable to update event state';
226 $self->{valid} = undef
232 sub revalidate_test {
235 if ($self->build_environment->environment->{complete}) {
238 OpenILS::Application::Trigger::ModRunner::Validator->new(
239 $self->event->event_def->validator,
244 $log->error("Event revalidation failed with ". shift());
247 return 1 if defined $self->valid and $self->valid;
252 "revalidate: could not build environment for event " .
260 return undef unless (ref $self);
263 $self->{cleanedup} = $c if (defined $c);
264 return $self->{cleanedup};
269 return undef unless (ref $self);
272 $self->{user_data} = $r if (defined $r);
273 return $self->{user_data};
278 return undef unless (ref $self);
281 $self->{reacted} = $r if (defined $r);
282 return $self->{reacted};
287 return undef unless (ref $self);
290 $self->{valid} = $v if (defined $v);
291 return $self->{valid};
296 return undef unless (ref $self);
299 $self->{event} = $e if (defined $e);
300 return $self->{event};
305 return undef unless (ref $self);
308 $self->{id} = $i if (defined $i);
314 return undef unless (ref $self);
317 $self->{environment} = $e if (defined $e);
318 return $self->{environment};
323 return undef unless (ref $self);
326 $self->{editor} = $e if (defined $e);
327 return $self->{editor};
331 # no guarantees, yet.
333 return undef unless (ref $self);
336 $self->{nochanges} = $e if (defined $e);
337 return $self->{nochanges};
342 return undef unless (ref $self);
344 die 'Cannot unfind a reacted event' if (defined $self->reacted);
346 $self->update_state( 'pending' ) || die 'Unable to update event state';
348 $self->{event} = undef;
349 $self->{environment} = undef;
355 return undef unless (ref $self);
358 $self->{target} = $t if (defined $t);
359 return $self->{target};
364 return undef unless (ref $self);
367 $self->{standalone} = $t if (defined $t);
368 return $self->{standalone};
373 return undef unless ($self && ref $self);
376 return undef unless ($state);
380 if ($self->standalone) {
381 $self->editor->xact_begin || return undef;
384 my $e = $self->editor->retrieve_action_trigger_event( $self->id );
386 $log->error( "Could not retrieve object ".$self->id." for update" ) if (!$e);
390 if ($fields && ref($fields)) {
391 $e->$_($$fields{$_}) for (keys %$fields);
394 $log->info( "Retrieved object ".$self->id." for update" );
395 $e->start_time( 'now' ) unless $e->start_time;
396 $e->update_time( 'now' );
397 $e->update_process( $$ );
400 $e->clear_start_time() if ($e->state eq 'pending');
401 $e->complete_time( 'now' ) if ($e->state eq 'complete');
403 my $ok = $self->editor->update_action_trigger_event( $e );
405 $self->editor->xact_rollback if ($self->standalone);
406 $log->error( "Update of event ".$self->id." failed" );
409 $e = $self->editor->data;
410 $e = $self->editor->retrieve_action_trigger_event( $e ) if (!ref($e));
412 $log->error( "Update of event ".$self->id." did not return an object" );
415 $log->info( "Update of event ".$e->id." suceeded" );
416 $ok = $self->editor->xact_commit if ($self->standalone);
420 $self->event->start_time( $e->start_time );
421 $self->event->update_time( $e->update_time );
422 $self->event->update_process( $e->update_process );
423 $self->event->state( $e->state );
429 my $current_environment;
431 sub build_environment {
433 return $self if ($self->environment->{complete});
435 $self->update_state( 'collecting') || die 'Unable to update event state';
439 my $compartment = new Safe;
440 $compartment->permit(':default','require','dofile','caller');
441 $compartment->share('$current_environment');
443 $self->environment->{EventProcessor} = $self;
444 $self->environment->{target} = $self->target;
445 $self->environment->{event} = $self->event;
446 $self->environment->{template} = $self->event->event_def->template;
447 $self->environment->{user_data} = $self->user_data;
449 $current_environment = $self->environment;
451 $self->environment->{params}{ $_->param } = $compartment->reval($_->value) for ( @{$self->event->event_def->params} );
453 for my $e ( @{$self->event->event_def->env} ) {
455 @path = split(/\./, $e->path) if ($e->path);
456 @label = split(/\./, $e->label) if ($e->label);
458 $self->_object_by_path( $self->target, $e->collector, \@label, \@path );
461 if ($self->event->event_def->group_field) {
462 my @group_path = split(/\./, $self->event->event_def->group_field);
463 pop(@group_path); # the last part is a field, should not get fleshed
464 my $group_object = $self->_object_by_path( $self->target, undef, [], \@group_path ) if (@group_path);
467 $self->environment->{complete} = 1;
469 $log->error( shift() );
470 $self->update_state( 'error' ) || die 'Unable to update event state';
473 if ($self->environment->{complete}) {
474 $self->update_state( 'collected' ) || die 'Unable to update event state';
476 $self->update_state( 'error' ) || die 'Unable to update event state';
482 sub _fm_class_by_hint {
487 OpenILS::Application->publish_fieldmapper->{$_}->{hint} eq $hint
488 } keys %{ OpenILS::Application->publish_fieldmapper };
493 my %_object_by_path_cache = ();
494 sub ClearObjectCache {
495 for my $did ( keys %_object_by_path_cache ) {
496 my $phash = $_object_by_path_cache{$did};
497 for my $path ( keys %$phash ) {
498 my $shash = $$phash{$path};
499 for my $step ( keys %$shash ) {
500 my $fhash = $$shash{$step};
501 for my $ffield ( keys %$fhash ) {
502 my $lhash = $$fhash{$ffield};
503 for my $lfield ( keys %$lhash ) {
504 delete $$lhash{$lfield};
506 delete $$fhash{$ffield};
508 delete $$shash{$step};
510 delete $$phash{$path};
512 delete $_object_by_path_cache{$did};
516 sub _object_by_path {
519 my $collector = shift;
527 $ed = new_editor(xact=>1);
531 my $step = shift(@$path);
533 my $fhint = OpenILS::Application->publish_fieldmapper->{$context->class_name}{links}{$step}{class};
534 my $fclass = $self->_fm_class_by_hint( $fhint );
536 OpenSRF::EX::ERROR->throw(
537 "$step is not a field on ".$context->class_name." Please repair the environment.")
540 my $ffield = OpenILS::Application->publish_fieldmapper->{$context->class_name}{links}{$step}{key};
541 my $rtype = OpenILS::Application->publish_fieldmapper->{$context->class_name}{links}{$step}{reltype};
543 my $meth = 'retrieve_';
546 if ($rtype ne 'has_a') {
549 $lfield = $context->Identity;
553 $meth =~ s/Fieldmapper:://;
556 my $obj = $context->$step();
559 sprintf "_object_by_path(): meth=%s, obj=%s, multi=%s, step=%s, lfield=%s",
560 map {defined($_)? $_ : ''} ($meth, $obj, $multi, $step, $lfield)
565 my $lval = $context->$lfield();
569 my $def_id = $self->event->event_def->id;
570 my $str_path = join('.', @$path);
572 $obj = $_object_by_path_cache{$def_id}{$str_path}{$step}{$ffield}{$lval} ||
575 OpenILS::Application->publish_fieldmapper->{$fclass}{controller}
576 }) ? $ed : ($red ||= new_rstore_editor(xact=>1))
577 )->$meth( ($multi) ? { $ffield => $lval } : $lval);
579 $_object_by_path_cache{$def_id}{$str_path}{$step}{$ffield}{$lval} ||= $obj;
587 $obj_list = [$obj] if ($obj);
593 my @path_clone = @$path;
594 $self->_object_by_path( $_, $collector, $label, \@path_clone, $ed, $red );
597 $obj = $$obj_list[0] if (!$multi || $rtype eq 'might_have');
598 $context->$step( $obj ) if ($obj && (!$label || !@$label));
603 my $obj_list = [$obj] if ($obj && !$multi);
604 $obj_list = $obj if ($multi);
607 for my $o ( @$obj_list ) {
609 OpenILS::Application::Trigger::ModRunner::Collector
610 ->new( $collector, $o )
616 $obj = $new_obj_list[0];
618 $obj = \@new_obj_list;
622 if ($label && @$label) {
623 my $node = $self->environment;
624 my $i = 0; my $max = scalar(@$label);
625 for (; $i < $max; $i++) {
626 my $part = $$label[$i];
627 $$node{$part} ||= {};
628 $node = $$node{$part};
630 $$node{$$label[-1]} = $obj;
632 $obj = $$obj[0] if $rtype eq 'might_have';
633 $context->$step( $obj ) if ($obj);
639 $red->rollback if $red;