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 );
212 $usr_message->pub('t');
214 if ($self->editor->xact_begin) {
215 if ($self->editor->create_actor_usr_message( $usr_message )) {
216 $self->editor->xact_commit;
218 $self->editor->xact_rollback;
225 $log->error("Event reacting failed with ". shift() );
226 $self->update_state( 'error' ) || die 'Unable to update event state';
229 if (defined $self->reacted) {
230 $self->update_state( 'reacted' ) || die 'Unable to update event state';
232 $self->update_state( 'error' ) || die 'Unable to update event state';
236 $self->{reacted} = undef;
244 return $self if (defined $self->valid);
246 if ($self->build_environment->environment->{complete}) {
247 $self->update_state( 'validating') || die 'Unable to update event state';
250 OpenILS::Application::Trigger::ModRunner::Validator
251 ->new( $self->event->event_def->validator, $self->environment )
256 $log->error("Event validation failed with ". shift() );
257 $self->update_state( 'error' ) || die 'Unable to update event state';
260 if (defined $self->valid) {
262 $self->update_state( 'valid' ) || die 'Unable to update event state';
264 $self->update_state( 'invalid' ) || die 'Unable to update event state';
267 $self->update_state( 'error' ) || die 'Unable to update event state';
270 $self->{valid} = undef
276 sub revalidate_test {
279 if ($self->build_environment->environment->{complete}) {
282 OpenILS::Application::Trigger::ModRunner::Validator->new(
283 $self->event->event_def->validator,
288 $log->error("Event revalidation failed with ". shift());
291 return 1 if defined $self->valid and $self->valid;
296 "revalidate: could not build environment for event " .
304 return undef unless (ref $self);
307 $self->{cleanedup} = $c if (defined $c);
308 return $self->{cleanedup};
313 return undef unless (ref $self);
316 $self->{user_data} = $r if (defined $r);
317 return $self->{user_data};
322 return undef unless (ref $self);
325 $self->{reacted} = $r if (defined $r);
326 return $self->{reacted};
331 return undef unless (ref $self);
334 $self->{valid} = $v if (defined $v);
335 return $self->{valid};
340 return undef unless (ref $self);
343 $self->{event} = $e if (defined $e);
344 return $self->{event};
349 return undef unless (ref $self);
352 $self->{id} = $i if (defined $i);
358 return undef unless (ref $self);
361 $self->{environment} = $e if (defined $e);
362 return $self->{environment};
367 return undef unless (ref $self);
370 $self->{editor} = $e if (defined $e);
371 return $self->{editor};
375 # no guarantees, yet.
377 return undef unless (ref $self);
380 $self->{nochanges} = $e if (defined $e);
381 return $self->{nochanges};
386 return undef unless (ref $self);
388 die 'Cannot unfind a reacted event' if (defined $self->reacted);
390 $self->update_state( 'pending' ) || die 'Unable to update event state';
392 $self->{event} = undef;
393 $self->{environment} = undef;
399 return undef unless (ref $self);
402 $self->{target} = $t if (defined $t);
403 return $self->{target};
408 return undef unless (ref $self);
411 $self->{standalone} = $t if (defined $t);
412 return $self->{standalone};
417 return undef unless ($self && ref $self);
420 return undef unless ($state);
424 if ($self->standalone) {
425 $self->editor->xact_begin || return undef;
428 my $e = $self->editor->retrieve_action_trigger_event( $self->id );
430 $log->error( "Could not retrieve object ".$self->id." for update" ) if (!$e);
434 if ($fields && ref($fields)) {
435 $e->$_($$fields{$_}) for (keys %$fields);
438 $log->info( "Retrieved object ".$self->id." for update" );
439 $e->start_time( 'now' ) unless $e->start_time;
440 $e->update_time( 'now' );
441 $e->update_process( $$ );
444 $e->clear_start_time() if ($e->state eq 'pending');
445 $e->complete_time( 'now' ) if ($e->state eq 'complete');
447 my $ok = $self->editor->update_action_trigger_event( $e );
449 $self->editor->xact_rollback if ($self->standalone);
450 $log->error( "Update of event ".$self->id." failed" );
453 $e = $self->editor->data;
454 $e = $self->editor->retrieve_action_trigger_event( $e ) if (!ref($e));
456 $log->error( "Update of event ".$self->id." did not return an object" );
459 $log->info( "Update of event ".$e->id." suceeded" );
460 $ok = $self->editor->xact_commit if ($self->standalone);
464 $self->event->start_time( $e->start_time );
465 $self->event->update_time( $e->update_time );
466 $self->event->update_process( $e->update_process );
467 $self->event->state( $e->state );
473 my $current_environment;
475 sub build_environment {
477 return $self if ($self->environment->{complete});
479 $self->update_state( 'collecting') || die 'Unable to update event state';
483 my $compartment = new Safe;
484 $compartment->permit(':default','require','dofile','caller');
485 $compartment->share('$current_environment');
487 $self->environment->{EventProcessor} = $self;
488 $self->environment->{target} = $self->target;
489 $self->environment->{event} = $self->event;
490 $self->environment->{template} = $self->event->event_def->template;
491 $self->environment->{usr_message}{template} = $self->event->event_def->message_template;
492 $self->environment->{usr_message}{title} = $self->event->event_def->message_title;
493 $self->environment->{user_data} = $self->user_data;
495 # need to get the context user now...
496 if ($self->event->event_def->context_usr_path) {
497 my @usr_path = split(/\./, $self->event->event_def->context_usr_path);
498 $self->_object_by_path( $self->target, undef, [qw/context usr/], \@usr_path );
501 # ... so that we can see if the event output should use
502 # an alternative template in the patron's preferred locale
503 if ($self->environment->{context}->{usr}) {
504 my ($usr_locale, $alt_templates, $query_result, $new_template_id);
505 my $editor = new_editor(xact=>1);
506 $alt_templates = $editor->json_query({
507 select => { atevalt => ['id', 'locale'] },
510 event_def => $self->environment->{event}->event_def->id,
514 $usr_locale = $self->environment->{context}->{usr}->locale;
515 if ($alt_templates and @$alt_templates and $usr_locale) {
516 foreach (@$alt_templates) {
517 if ($_->{locale} eq $usr_locale) {
518 $new_template_id = $_->{id};
519 $self->environment->{tt_locale} = $_->{locale};
521 } else { #attempt a lanuage if not locale match
522 if ((split /\p{Dash}/,$_->{locale})[0] eq (split /\p{Dash}/,$usr_locale)[0]) {
523 $new_template_id = $_->{id};
524 $self->environment->{tt_locale} = $_->{locale};
529 if ($new_template_id) {
530 $query_result = $editor->json_query({
531 select => { atevalt => ['template','message_template','message_title'] },
533 where => { id => $new_template_id }
535 $self->environment->{template} = @$query_result[0]->{template};
536 $self->environment->{usr_message}{template} = @$query_result[0]->{message_template};
537 $self->environment->{usr_message}{title} = @$query_result[0]->{message_title};
540 $current_environment = $self->environment;
542 $self->environment->{params}{ $_->param } = $compartment->reval($_->value) for ( @{$self->event->event_def->params} );
544 for my $e ( @{$self->event->event_def->env} ) {
546 @path = split(/\./, $e->path) if ($e->path);
547 @label = split(/\./, $e->label) if ($e->label);
549 $self->_object_by_path( $self->target, $e->collector, \@label, \@path );
552 if ($self->event->event_def->group_field) {
553 my @group_path = split(/\./, $self->event->event_def->group_field);
554 pop(@group_path); # the last part is a field, should not get fleshed
555 my $group_object = $self->_object_by_path( $self->target, undef, [], \@group_path ) if (@group_path);
558 if ($self->event->event_def->message_usr_path and $self->environment->{usr_message}{template}) {
559 my @usr_path = split(/\./, $self->event->event_def->message_usr_path);
560 $self->_object_by_path( $self->target, undef, [qw/usr_message usr/], \@usr_path );
562 if ($self->event->event_def->message_library_path) {
563 my @library_path = split(/\./, $self->event->event_def->message_library_path);
564 $self->_object_by_path( $self->target, undef, [qw/usr_message sending_lib/], \@library_path );
566 $self->_object_by_path( $self->event->event_def, undef, [qw/usr_message sending_lib/], ['owner'] );
570 if ($self->event->event_def->context_bib_path) {
571 my @bib_path = split(/\./, $self->event->event_def->context_bib_path);
572 $self->_object_by_path( $self->target, undef, [qw/context bib/], \@bib_path );
573 if (ref $self->environment->{context}->{bib} eq 'ARRAY') {
574 $self->environment->{context}->{bib} = $self->environment->{context}->{bib}->[0];
576 if ($self->environment->{context}->{bib}->isa('Fieldmapper::biblio::record_entry')) {
577 $self->environment->{context}->{bib} = $self->environment->{context}->{bib}->id;
578 } elsif ($self->environment->{context}->{bib}->isa('Fieldmapper::reporter::hold_request_record')) {
579 $self->environment->{context}->{bib} = $self->environment->{context}->{bib}->bib_record;
583 if ($self->event->event_def->context_library_path) {
584 my @library_path = split(/\./, $self->event->event_def->context_library_path);
585 $self->_object_by_path( $self->target, undef, [qw/context org/], \@library_path );
587 $self->_object_by_path( $self->event->event_def, undef, [qw/context org/], ['owner'] );
590 if ($self->event->event_def->context_item_path) {
591 my @item_path = split(/\./, $self->event->event_def->context_item_path);
592 $self->_object_by_path( $self->target, undef, [qw/context item/], \@item_path );
596 $self->event->state, {
597 'context_item' => $self->environment->{context}->{item}
598 ? $self->environment->{context}->{item}->id
600 'context_user' => $self->environment->{context}->{usr}
601 ? $self->environment->{context}->{usr}->id
603 'context_library' => $self->environment->{context}->{org}
604 ? $self->environment->{context}->{org}->id
606 'context_bib' => $self->environment->{context}->{bib}
610 $self->environment->{complete} = 1;
612 $log->error( shift() );
613 $self->update_state( 'error' ) || die 'Unable to update event state';
616 if ($self->environment->{complete}) {
617 $self->update_state( 'collected' ) || die 'Unable to update event state';
619 $self->update_state( 'error' ) || die 'Unable to update event state';
625 sub _fm_class_by_hint {
630 OpenILS::Application->publish_fieldmapper->{$_}->{hint} eq $hint
631 } keys %{ OpenILS::Application->publish_fieldmapper };
636 my %_object_by_path_cache = ();
637 sub ClearObjectCache {
638 for my $did ( keys %_object_by_path_cache ) {
639 my $phash = $_object_by_path_cache{$did};
640 for my $path ( keys %$phash ) {
641 my $shash = $$phash{$path};
642 for my $fhint ( keys %$shash ) {
643 my $hhash = $$shash{$fhint};
644 for my $step ( keys %$hhash ) {
645 my $fhash = $$hhash{$step};
646 for my $ffield ( keys %$fhash ) {
647 my $lhash = $$fhash{$ffield};
648 for my $lfield ( keys %$lhash ) {
649 delete $$lhash{$lfield};
651 delete $$fhash{$ffield};
653 delete $$hhash{$step};
655 delete $$shash{$fhint};
657 delete $$phash{$path};
659 delete $_object_by_path_cache{$did};
663 sub _object_by_path {
666 my $collector = shift;
674 $ed = new_editor(xact=>1);
678 my $step = shift(@$path);
680 my $fhint = OpenILS::Application->publish_fieldmapper->{$context->class_name}{links}{$step}{class};
681 my $fclass = $self->_fm_class_by_hint( $fhint );
683 OpenSRF::EX::ERROR->throw(
684 "$step is not a field on ".$context->class_name." Please repair the environment.")
687 my $ffield = OpenILS::Application->publish_fieldmapper->{$context->class_name}{links}{$step}{key};
688 my $rtype = OpenILS::Application->publish_fieldmapper->{$context->class_name}{links}{$step}{reltype};
690 my $meth = 'retrieve_';
693 if ($rtype ne 'has_a') {
696 $lfield = $context->Identity;
700 $meth =~ s/Fieldmapper:://;
703 my $obj = $context->$step();
706 sprintf "_object_by_path(): meth=%s, obj=%s, multi=%s, step=%s, lfield=%s",
707 map {defined($_)? $_ : ''} ($meth, $obj, $multi, $step, $lfield)
712 my $lval = $context->$lfield();
716 my $def_id = $self->event->event_def->id;
717 my $str_path = join('.', @$path);
719 my @params = (($multi) ? { $ffield => $lval } : $lval);
720 @params = ([@params], {substream => 1}) if $meth =~ /^search/;
722 $obj = $_object_by_path_cache{$def_id}{$str_path}{$fhint}{$step}{$ffield}{$lval} ||
725 OpenILS::Application->publish_fieldmapper->{$fclass}{controller}
726 }) ? $ed : ($red ||= new_rstore_editor(xact=>1))
729 $_object_by_path_cache{$def_id}{$str_path}{$fhint}{$step}{$ffield}{$lval} ||= $obj;
737 $obj_list = [$obj] if ($obj);
743 my @path_clone = @$path;
744 $self->_object_by_path( $_, $collector, $label, \@path_clone, $ed, $red );
747 $obj = $$obj_list[0] if (!$multi || $rtype eq 'might_have');
748 $context->$step( $obj ) if ($obj && (!$label || !@$label));
753 my $obj_list = [$obj] if ($obj && !$multi);
754 $obj_list = $obj if ($multi);
757 for my $o ( @$obj_list ) {
759 OpenILS::Application::Trigger::ModRunner::Collector
760 ->new( $collector, $o )
766 $obj = $new_obj_list[0];
768 $obj = \@new_obj_list;
772 if ($label && @$label) {
773 my $node = $self->environment;
774 my $i = 0; my $max = scalar(@$label) - 1;
775 for (; $i < $max; $i++) {
776 my $part = $$label[$i];
777 $$node{$part} ||= {};
778 $node = $$node{$part};
780 $$node{$$label[-1]} = $obj;
782 $obj = $$obj[0] if $rtype eq 'might_have' and ref($obj) eq 'ARRAY';
783 $context->$step( $obj ) if ($obj);
789 $red->rollback if $red;