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 # if called as an instance method
18 unshift(@events,$class) if ref($class);
26 $_->update_state('invalid');
38 my $nochanges = shift; # no guarantees, yet...
39 $class = ref($class) || $class;
41 my $standalone = $editor ? 0 : 1;
42 $editor ||= new_editor();
44 if (ref($id) && ref($id) eq $class) {
45 $id->environment->{EventProcessor} = $id
46 if ($id->environment->{complete}); # in case it came over an opensrf tube
47 $id->editor( $editor );
48 $id->standalone( $standalone );
52 my $self = bless { id => $id, editor => $editor, standalone => $standalone, nochanges => $nochanges } => $class;
61 return $self if ($self->event);
64 $self->environment( {} );
67 $log->error("No Event ID provided");
68 die "No Event ID provided";
71 return $self if (!$self->id);
73 if ($self->standalone) {
74 $self->editor->xact_begin || return undef;
78 $self->editor->retrieve_action_trigger_event([
82 atev => [ qw/event_def/ ],
83 atevdef => [ qw/hook env params/ ]
89 if ($self->standalone) {
90 $self->editor->xact_rollback || return undef;
93 $self->user_data(OpenSRF::Utils::JSON->JSON2perl( $self->event->user_data ))
94 if (defined( $self->event->user_data ));
96 if ($self->event->state eq 'valid') {
98 } elsif ($self->event->state eq 'invalid') {
100 } elsif ($self->event->state eq 'reacting') {
102 } elsif ($self->event->state eq 'reacted') {
105 } elsif ($self->event->state eq 'cleaning') {
108 } elsif ($self->event->state eq 'complete') {
112 } elsif ($self->event->state eq 'error') {
118 unless ($self->nochanges) {
119 $self->update_state('found') || die 'Unable to update event state';
122 my $class = $self->_fm_class_by_hint( $self->event->event_def->hook->core_type );
124 my $meth = "retrieve_" . $class;
125 $meth =~ s/Fieldmapper:://;
128 if ($self->standalone) {
129 $self->editor->xact_begin || return undef;
132 $self->target( $self->editor->$meth( $self->event->target ) );
134 if ($self->standalone) {
135 $self->editor->xact_rollback || return undef;
138 unless ($self->target) {
139 $self->update_state('invalid') unless $self->nochanges;
148 my $env = shift || $self->environment;
150 return $self if (defined $self->cleanedup);
152 if (defined $self->reacted) {
153 $self->update_state( 'cleaning') || die 'Unable to update event state';
155 my $cleanup = $self->reacted ? $self->event->event_def->cleanup_success : $self->event->event_def->cleanup_failure;
158 OpenILS::Application::Trigger::ModRunner::Cleanup
159 ->new( $cleanup, $env)
167 $log->error("Event cleanup failed with ". shift() );
168 $self->update_state( 'error' ) || die 'Unable to update event state';
171 if ($self->cleanedup) {
172 $self->update_state( 'complete' ) || die 'Unable to update event state';
174 $self->update_state( 'error' ) || die 'Unable to update event state';
178 $self->{cleanedup} = undef;
185 my $env = shift || $self->environment;
187 return $self if (defined $self->reacted);
190 if ($self->event->event_def->group_field) { # can't react individually to a grouped definition
191 $self->{reacted} = undef;
193 $self->update_state( 'reacting') || die 'Unable to update event state';
195 my $reactor = OpenILS::Application::Trigger::ModRunner::Reactor->new(
196 $self->event->event_def->reactor,
200 $self->reacted( $reactor->run->final_result);
202 if ($env->{usr_message}{usr} && $env->{usr_message}{template}) {
203 my $message_template_output =
204 $reactor->pass('ProcessMessage')->run->final_result;
206 if ($message_template_output) {
207 my $usr_message = Fieldmapper::actor::usr_message->new;
208 $usr_message->title( $env->{usr_message}{title} || $self->event->event_def->name );
209 $usr_message->message( $message_template_output );
210 $usr_message->usr( $env->{usr_message}{usr}->id );
211 $usr_message->sending_lib( $env->{usr_message}{sending_lib}->id );
213 if ($self->editor->xact_begin) {
214 if ($self->editor->create_actor_usr_message( $usr_message )) {
215 $self->editor->xact_commit;
217 $self->editor->xact_rollback;
224 $log->error("Event reacting failed with ". shift() );
225 $self->update_state( 'error' ) || die 'Unable to update event state';
228 if (defined $self->reacted) {
229 $self->update_state( 'reacted' ) || die 'Unable to update event state';
231 $self->update_state( 'error' ) || die 'Unable to update event state';
235 $self->{reacted} = undef;
243 return $self if (defined $self->valid);
245 if ($self->build_environment->environment->{complete}) {
246 $self->update_state( 'validating') || die 'Unable to update event state';
249 OpenILS::Application::Trigger::ModRunner::Validator
250 ->new( $self->event->event_def->validator, $self->environment )
255 $log->error("Event validation failed with ". shift() );
256 $self->update_state( 'error' ) || die 'Unable to update event state';
259 if (defined $self->valid) {
261 $self->update_state( 'valid' ) || die 'Unable to update event state';
263 $self->update_state( 'invalid' ) || die 'Unable to update event state';
266 $self->update_state( 'error' ) || die 'Unable to update event state';
269 $self->{valid} = undef
275 sub revalidate_test {
278 if ($self->build_environment->environment->{complete}) {
281 OpenILS::Application::Trigger::ModRunner::Validator->new(
282 $self->event->event_def->validator,
287 $log->error("Event revalidation failed with ". shift());
290 return 1 if defined $self->valid and $self->valid;
295 "revalidate: could not build environment for event " .
303 return undef unless (ref $self);
306 $self->{cleanedup} = $c if (defined $c);
307 return $self->{cleanedup};
312 return undef unless (ref $self);
315 $self->{user_data} = $r if (defined $r);
316 return $self->{user_data};
321 return undef unless (ref $self);
324 $self->{reacted} = $r if (defined $r);
325 return $self->{reacted};
330 return undef unless (ref $self);
333 $self->{valid} = $v if (defined $v);
334 return $self->{valid};
339 return undef unless (ref $self);
342 $self->{event} = $e if (defined $e);
343 return $self->{event};
348 return undef unless (ref $self);
351 $self->{id} = $i if (defined $i);
357 return undef unless (ref $self);
360 $self->{environment} = $e if (defined $e);
361 return $self->{environment};
366 return undef unless (ref $self);
369 $self->{editor} = $e if (defined $e);
370 return $self->{editor};
374 # no guarantees, yet.
376 return undef unless (ref $self);
379 $self->{nochanges} = $e if (defined $e);
380 return $self->{nochanges};
385 return undef unless (ref $self);
387 die 'Cannot unfind a reacted event' if (defined $self->reacted);
389 $self->update_state( 'pending' ) || die 'Unable to update event state';
391 $self->{event} = undef;
392 $self->{environment} = undef;
398 return undef unless (ref $self);
401 $self->{target} = $t if (defined $t);
402 return $self->{target};
407 return undef unless (ref $self);
410 $self->{standalone} = $t if (defined $t);
411 return $self->{standalone};
416 return undef unless ($self && ref $self);
419 return undef unless ($state);
423 if ($self->standalone) {
424 $self->editor->xact_begin || return undef;
427 my $e = $self->editor->retrieve_action_trigger_event( $self->id );
429 $log->error( "Could not retrieve object ".$self->id." for update" ) if (!$e);
433 if ($fields && ref($fields)) {
434 $e->$_($$fields{$_}) for (keys %$fields);
437 $log->info( "Retrieved object ".$self->id." for update" );
438 $e->start_time( 'now' ) unless $e->start_time;
439 $e->update_time( 'now' );
440 $e->update_process( $$ );
443 $e->clear_start_time() if ($e->state eq 'pending');
444 $e->complete_time( 'now' ) if ($e->state eq 'complete');
446 my $ok = $self->editor->update_action_trigger_event( $e );
448 $self->editor->xact_rollback if ($self->standalone);
449 $log->error( "Update of event ".$self->id." failed" );
452 $e = $self->editor->data;
453 $e = $self->editor->retrieve_action_trigger_event( $e ) if (!ref($e));
455 $log->error( "Update of event ".$self->id." did not return an object" );
458 $log->info( "Update of event ".$e->id." suceeded" );
459 $ok = $self->editor->xact_commit if ($self->standalone);
463 $self->event->start_time( $e->start_time );
464 $self->event->update_time( $e->update_time );
465 $self->event->update_process( $e->update_process );
466 $self->event->state( $e->state );
472 my $current_environment;
474 sub build_environment {
476 return $self if ($self->environment->{complete});
478 $self->update_state( 'collecting') || die 'Unable to update event state';
482 my $compartment = new Safe;
483 $compartment->permit(':default','require','dofile','caller');
484 $compartment->share('$current_environment');
486 $self->environment->{EventProcessor} = $self;
487 $self->environment->{target} = $self->target;
488 $self->environment->{event} = $self->event;
489 $self->environment->{template} = $self->event->event_def->template;
490 $self->environment->{usr_message}{template} = $self->event->event_def->message_template;
491 $self->environment->{usr_message}{title} = $self->event->event_def->message_title;
492 $self->environment->{user_data} = $self->user_data;
494 $current_environment = $self->environment;
496 $self->environment->{params}{ $_->param } = $compartment->reval($_->value) for ( @{$self->event->event_def->params} );
498 for my $e ( @{$self->event->event_def->env} ) {
500 @path = split(/\./, $e->path) if ($e->path);
501 @label = split(/\./, $e->label) if ($e->label);
503 $self->_object_by_path( $self->target, $e->collector, \@label, \@path );
506 if ($self->event->event_def->group_field) {
507 my @group_path = split(/\./, $self->event->event_def->group_field);
508 pop(@group_path); # the last part is a field, should not get fleshed
509 my $group_object = $self->_object_by_path( $self->target, undef, [], \@group_path ) if (@group_path);
512 if ($self->event->event_def->message_usr_path and $self->environment->{usr_message}{template}) {
513 my @usr_path = split(/\./, $self->event->event_def->message_usr_path);
514 $self->_object_by_path( $self->target, undef, [qw/usr_message usr/], \@usr_path );
516 if ($self->event->event_def->message_library_path) {
517 my @library_path = split(/\./, $self->event->event_def->message_library_path);
518 $self->_object_by_path( $self->target, undef, [qw/usr_message sending_lib/], \@library_path );
520 $self->_object_by_path( $self->event->event_def, undef, [qw/usr_message sending_lib/], ['owner'] );
524 $self->environment->{complete} = 1;
526 $log->error( shift() );
527 $self->update_state( 'error' ) || die 'Unable to update event state';
530 if ($self->environment->{complete}) {
531 $self->update_state( 'collected' ) || die 'Unable to update event state';
533 $self->update_state( 'error' ) || die 'Unable to update event state';
539 sub _fm_class_by_hint {
544 OpenILS::Application->publish_fieldmapper->{$_}->{hint} eq $hint
545 } keys %{ OpenILS::Application->publish_fieldmapper };
550 my %_object_by_path_cache = ();
551 sub ClearObjectCache {
552 for my $did ( keys %_object_by_path_cache ) {
553 my $phash = $_object_by_path_cache{$did};
554 for my $path ( keys %$phash ) {
555 my $shash = $$phash{$path};
556 for my $fhint ( keys %$shash ) {
557 my $hhash = $$shash{$fhint};
558 for my $step ( keys %$hhash ) {
559 my $fhash = $$hhash{$step};
560 for my $ffield ( keys %$fhash ) {
561 my $lhash = $$fhash{$ffield};
562 for my $lfield ( keys %$lhash ) {
563 delete $$lhash{$lfield};
565 delete $$fhash{$ffield};
567 delete $$hhash{$step};
569 delete $$shash{$fhint};
571 delete $$phash{$path};
573 delete $_object_by_path_cache{$did};
577 sub _object_by_path {
580 my $collector = shift;
588 $ed = new_editor(xact=>1);
592 my $step = shift(@$path);
594 my $fhint = OpenILS::Application->publish_fieldmapper->{$context->class_name}{links}{$step}{class};
595 my $fclass = $self->_fm_class_by_hint( $fhint );
597 OpenSRF::EX::ERROR->throw(
598 "$step is not a field on ".$context->class_name." Please repair the environment.")
601 my $ffield = OpenILS::Application->publish_fieldmapper->{$context->class_name}{links}{$step}{key};
602 my $rtype = OpenILS::Application->publish_fieldmapper->{$context->class_name}{links}{$step}{reltype};
604 my $meth = 'retrieve_';
607 if ($rtype ne 'has_a') {
610 $lfield = $context->Identity;
614 $meth =~ s/Fieldmapper:://;
617 my $obj = $context->$step();
620 sprintf "_object_by_path(): meth=%s, obj=%s, multi=%s, step=%s, lfield=%s",
621 map {defined($_)? $_ : ''} ($meth, $obj, $multi, $step, $lfield)
626 my $lval = $context->$lfield();
630 my $def_id = $self->event->event_def->id;
631 my $str_path = join('.', @$path);
633 my @params = (($multi) ? { $ffield => $lval } : $lval);
634 @params = ([@params], {substream => 1}) if $meth =~ /^search/;
636 $obj = $_object_by_path_cache{$def_id}{$str_path}{$fhint}{$step}{$ffield}{$lval} ||
639 OpenILS::Application->publish_fieldmapper->{$fclass}{controller}
640 }) ? $ed : ($red ||= new_rstore_editor(xact=>1))
643 $_object_by_path_cache{$def_id}{$str_path}{$fhint}{$step}{$ffield}{$lval} ||= $obj;
651 $obj_list = [$obj] if ($obj);
657 my @path_clone = @$path;
658 $self->_object_by_path( $_, $collector, $label, \@path_clone, $ed, $red );
661 $obj = $$obj_list[0] if (!$multi || $rtype eq 'might_have');
662 $context->$step( $obj ) if ($obj && (!$label || !@$label));
667 my $obj_list = [$obj] if ($obj && !$multi);
668 $obj_list = $obj if ($multi);
671 for my $o ( @$obj_list ) {
673 OpenILS::Application::Trigger::ModRunner::Collector
674 ->new( $collector, $o )
680 $obj = $new_obj_list[0];
682 $obj = \@new_obj_list;
686 if ($label && @$label) {
687 my $node = $self->environment;
688 my $i = 0; my $max = scalar(@$label) - 1;
689 for (; $i < $max; $i++) {
690 my $part = $$label[$i];
691 $$node{$part} ||= {};
692 $node = $$node{$part};
694 $$node{$$label[-1]} = $obj;
696 $obj = $$obj[0] if $rtype eq 'might_have';
697 $context->$step( $obj ) if ($obj);
703 $red->rollback if $red;