Open-ILS/src/perlmods/lib/OpenILS/Application/Trigger/Event.pm

   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;
   9 use Safe;
  10
  11 my $log = 'OpenSRF::Utils::Logger';
  12
  13 sub new {
  14     my $class = shift;
  15     my $id = shift;
  16     my $editor = shift;
  17     my $nochanges = shift; # no guarantees, yet...
  18     $class = ref($class) || $class;
  19
  20     my $standalone = $editor ? 0 : 1;
  21     $editor ||= new_editor();
  22
  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 );
  28         return $id;
  29     }
  30
  31     my $self = bless { id => $id, editor => $editor, standalone => $standalone, nochanges => $nochanges } => $class;
  32
  33     return $self->init()
  34 }
  35
  36 sub init {
  37     my $self = shift;
  38     my $id = shift;
  39
  40     return $self if ($self->event);
  41
  42     $self->id( $id );
  43     $self->environment( {} );
  44
  45     if (!$self->id) {
  46         $log->error("No Event ID provided");
  47         die "No Event ID provided";
  48     }
  49
  50     return $self if (!$self->id);
  51
  52     if ($self->standalone) {
  53         $self->editor->xact_begin || return undef;
  54     }
  55
  56     $self->event(
  57         $self->editor->retrieve_action_trigger_event([
  58             $self->id, {
  59                 flesh => 2,
  60                 flesh_fields => {
  61                     atev    => [ qw/event_def/ ],
  62                     atevdef => [ qw/hook env params/ ]
  63                 }
  64             }
  65         ])
  66     );
  67
  68     if ($self->standalone) {
  69         $self->editor->xact_rollback || return undef;
  70     }
  71
  72     $self->user_data(OpenSRF::Utils::JSON->JSON2perl( $self->event->user_data ))
  73         if (defined( $self->event->user_data ));
  74
  75     if ($self->event->state eq 'valid') {
  76         $self->valid(1);
  77     } elsif ($self->event->state eq 'invalid') {
  78         $self->valid(0);
  79     } elsif ($self->event->state eq 'reacting') {
  80         $self->valid(1);
  81     } elsif ($self->event->state eq 'reacted') {
  82         $self->valid(1);
  83         $self->reacted(1);
  84     } elsif ($self->event->state eq 'cleaning') {
  85         $self->valid(1);
  86         $self->reacted(1);
  87     } elsif ($self->event->state eq 'complete') {
  88         $self->valid(1);
  89         $self->reacted(1);
  90         $self->cleanedup(1);
  91     } elsif ($self->event->state eq 'error') {
  92         $self->valid(0);
  93         $self->reacted(0);
  94         $self->cleanedup(0);
  95     }
  96
  97     unless ($self->nochanges) {
  98         $self->update_state('found') || die 'Unable to update event state';
  99     }
 100
 101     my $class = $self->_fm_class_by_hint( $self->event->event_def->hook->core_type );
 102
 103     my $meth = "retrieve_" . $class;
 104     $meth =~ s/Fieldmapper:://;
 105     $meth =~ s/::/_/;
 106
 107     if ($self->standalone) {
 108         $self->editor->xact_begin || return undef;
 109     }
 110
 111     $self->target( $self->editor->$meth( $self->event->target ) );
 112
 113     if ($self->standalone) {
 114         $self->editor->xact_rollback || return undef;
 115     }
 116
 117     unless ($self->target) {
 118         $self->update_state('invalid') unless $self->nochanges;
 119         $self->valid(0);
 120     }
 121
 122     return $self;
 123 }
 124
 125 sub cleanup {
 126     my $self = shift;
 127     my $env = shift || $self->environment;
 128
 129     return $self if (defined $self->cleanedup);
 130
 131     if (defined $self->reacted) {
 132         $self->update_state( 'cleaning') || die 'Unable to update event state';
 133         try {
 134             my $cleanup = $self->reacted ? $self->event->event_def->cleanup_success : $self->event->event_def->cleanup_failure;
 135             if($cleanup) {
 136                 $self->cleanedup(
 137                     OpenILS::Application::Trigger::ModRunner::Cleanup
 138                         ->new( $cleanup, $env)
 139                         ->run
 140                         ->final_result
 141                 );
 142             } else {
 143                 $self->cleanedup(1);
 144             }
 145         } otherwise {
 146             $log->error("Event cleanup failed with ". shift() );
 147             $self->update_state( 'error' ) || die 'Unable to update event state';
 148         };
 149
 150         if ($self->cleanedup) {
 151             $self->update_state( 'complete' ) || die 'Unable to update event state';
 152         } else {
 153             $self->update_state( 'error' ) || die 'Unable to update event state';
 154         }
 155
 156     } else {
 157         $self->{cleanedup} = undef;
 158     }
 159     return $self;
 160 }
 161
 162 sub react {
 163     my $self = shift;
 164     my $env = shift || $self->environment;
 165
 166     return $self if (defined $self->reacted);
 167
 168     if ($self->valid) {
 169         if ($self->event->event_def->group_field) { # can't react individually to a grouped definition
 170             $self->{reacted} = undef;
 171         } else {
 172             $self->update_state( 'reacting') || die 'Unable to update event state';
 173             try {
 174                 $self->reacted(
 175                     OpenILS::Application::Trigger::ModRunner::Reactor
 176                         ->new( $self->event->event_def->reactor, $env )
 177                         ->run
 178                         ->final_result
 179                 );
 180             } otherwise {
 181                 $log->error("Event reacting failed with ". shift() );
 182                 $self->update_state( 'error' ) || die 'Unable to update event state';
 183             };
 184
 185             if (defined $self->reacted) {
 186                 $self->update_state( 'reacted' ) || die 'Unable to update event state';
 187             } else {
 188                 $self->update_state( 'error' ) || die 'Unable to update event state';
 189             }
 190         }
 191     } else {
 192         $self->{reacted} = undef;
 193     }
 194     return $self;
 195 }
 196
 197 sub validate {
 198     my $self = shift;
 199
 200     return $self if (defined $self->valid);
 201
 202     if ($self->build_environment->environment->{complete}) {
 203         $self->update_state( 'validating') || die 'Unable to update event state';
 204         try {
 205             $self->valid(
 206                 OpenILS::Application::Trigger::ModRunner::Validator
 207                     ->new( $self->event->event_def->validator, $self->environment )
 208                     ->run
 209                     ->final_result
 210             );
 211         } otherwise {
 212             $log->error("Event validation failed with ". shift() );
 213             $self->update_state( 'error' ) || die 'Unable to update event state';
 214         };
 215
 216         if (defined $self->valid) {
 217             if ($self->valid) {
 218                 $self->update_state( 'valid' ) || die 'Unable to update event state';
 219             } else {
 220                 $self->update_state( 'invalid' ) || die 'Unable to update event state';
 221             }
 222         } else {
 223             $self->update_state( 'error' ) || die 'Unable to update event state';
 224         }
 225     } else {
 226         $self->{valid} = undef
 227     }
 228
 229     return $self;
 230 }
 231
 232 sub revalidate_test {
 233     my $self = shift;
 234
 235     if ($self->build_environment->environment->{complete}) {
 236         try {
 237             $self->valid(
 238                 OpenILS::Application::Trigger::ModRunner::Validator->new(
 239                     $self->event->event_def->validator,
 240                     $self->environment
 241                 )->run->final_result
 242             );
 243         } otherwise {
 244             $log->error("Event revalidation failed with ". shift());
 245         };
 246
 247         return 1 if defined $self->valid and $self->valid;
 248         return 0;
 249     }
 250
 251     $logger->error(
 252         "revalidate: could not build environment for event " .
 253         $self->event->id
 254     );
 255     return 0;
 256 }
 257
 258 sub cleanedup {
 259     my $self = shift;
 260     return undef unless (ref $self);
 261
 262     my $c = shift;
 263     $self->{cleanedup} = $c if (defined $c);
 264     return $self->{cleanedup};
 265 }
 266
 267 sub user_data {
 268     my $self = shift;
 269     return undef unless (ref $self);
 270
 271     my $r = shift;
 272     $self->{user_data} = $r if (defined $r);
 273     return $self->{user_data};
 274 }
 275
 276 sub reacted {
 277     my $self = shift;
 278     return undef unless (ref $self);
 279
 280     my $r = shift;
 281     $self->{reacted} = $r if (defined $r);
 282     return $self->{reacted};
 283 }
 284
 285 sub valid {
 286     my $self = shift;
 287     return undef unless (ref $self);
 288
 289     my $v = shift;
 290     $self->{valid} = $v if (defined $v);
 291     return $self->{valid};
 292 }
 293
 294 sub event {
 295     my $self = shift;
 296     return undef unless (ref $self);
 297
 298     my $e = shift;
 299     $self->{event} = $e if (defined $e);
 300     return $self->{event};
 301 }
 302
 303 sub id {
 304     my $self = shift;
 305     return undef unless (ref $self);
 306
 307     my $i = shift;
 308     $self->{id} = $i if (defined $i);
 309     return $self->{id};
 310 }
 311
 312 sub environment {
 313     my $self = shift;
 314     return undef unless (ref $self);
 315
 316     my $e = shift;
 317     $self->{environment} = $e if (defined $e);
 318     return $self->{environment};
 319 }
 320
 321 sub editor {
 322     my $self = shift;
 323     return undef unless (ref $self);
 324
 325     my $e = shift;
 326     $self->{editor} = $e if (defined $e);
 327     return $self->{editor};
 328 }
 329
 330 sub nochanges {
 331     # no guarantees, yet.
 332     my $self = shift;
 333     return undef unless (ref $self);
 334
 335     my $e = shift;
 336     $self->{nochanges} = $e if (defined $e);
 337     return $self->{nochanges};
 338 }
 339
 340 sub unfind {
 341     my $self = shift;
 342     return undef unless (ref $self);
 343
 344     die 'Cannot unfind a reacted event' if (defined $self->reacted);
 345
 346     $self->update_state( 'pending' ) || die 'Unable to update event state';
 347     $self->{id} = undef;
 348     $self->{event} = undef;
 349     $self->{environment} = undef;
 350     return $self;
 351 }
 352
 353 sub target {
 354     my $self = shift;
 355     return undef unless (ref $self);
 356
 357     my $t = shift;
 358     $self->{target} = $t if (defined $t);
 359     return $self->{target};
 360 }
 361
 362 sub standalone {
 363     my $self = shift;
 364     return undef unless (ref $self);
 365
 366     my $t = shift;
 367     $self->{standalone} = $t if (defined $t);
 368     return $self->{standalone};
 369 }
 370
 371 sub update_state {
 372     my $self = shift;
 373     return undef unless ($self && ref $self);
 374
 375     my $state = shift;
 376     return undef unless ($state);
 377
 378     my $fields = shift;
 379
 380     if ($self->standalone) {
 381         $self->editor->xact_begin || return undef;
 382     }
 383
 384     my $e = $self->editor->retrieve_action_trigger_event( $self->id );
 385     if (!$e) {
 386         $log->error( "Could not retrieve object ".$self->id." for update" ) if (!$e);
 387         return undef;
 388     }
 389
 390     if ($fields && ref($fields)) {
 391         $e->$_($$fields{$_}) for (keys %$fields);
 392     }
 393
 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( $$ );
 398     $e->state( $state );
 399
 400     $e->clear_start_time() if ($e->state eq 'pending');
 401     $e->complete_time( 'now' ) if ($e->state eq 'complete');
 402
 403     my $ok = $self->editor->update_action_trigger_event( $e );
 404     if (!$ok) {
 405         $self->editor->xact_rollback if ($self->standalone);
 406         $log->error( "Update of event ".$self->id." failed" );
 407         return undef;
 408     } else {
 409         $e = $self->editor->data;
 410         $e = $self->editor->retrieve_action_trigger_event( $e ) if (!ref($e));
 411         if (!$e) {
 412             $log->error( "Update of event ".$self->id." did not return an object" );
 413             return undef;
 414         }
 415         $log->info( "Update of event ".$e->id." suceeded" );
 416         $ok = $self->editor->xact_commit if ($self->standalone);
 417     }
 418
 419     if ($ok) {
 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 );
 424     }
 425
 426     return $ok || undef;
 427 }
 428
 429 my $current_environment;
 430
 431 sub build_environment {
 432     my $self = shift;
 433     return $self if ($self->environment->{complete});
 434
 435     $self->update_state( 'collecting') || die 'Unable to update event state';
 436
 437     try {
 438
 439         my $compartment = new Safe;
 440         $compartment->permit(':default','require','dofile','caller');
 441         $compartment->share('$current_environment');
 442
 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;
 448
 449         $current_environment = $self->environment;
 450
 451         $self->environment->{params}{ $_->param } = $compartment->reval($_->value) for ( @{$self->event->event_def->params} );
 452
 453         for my $e ( @{$self->event->event_def->env} ) {
 454             my (@label, @path);
 455             @path = split(/\./, $e->path) if ($e->path);
 456             @label = split(/\./, $e->label) if ($e->label);
 457
 458             $self->_object_by_path( $self->target, $e->collector, \@label, \@path );
 459         }
 460
 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);
 465         }
 466
 467         $self->environment->{complete} = 1;
 468     } otherwise {
 469         $log->error( shift() );
 470         $self->update_state( 'error' ) || die 'Unable to update event state';
 471     };
 472
 473     if ($self->environment->{complete}) {
 474         $self->update_state( 'collected' ) || die 'Unable to update event state';
 475     } else {
 476         $self->update_state( 'error' ) || die 'Unable to update event state';
 477     }
 478
 479     return $self;
 480 }
 481
 482 sub _fm_class_by_hint {
 483     my $self = shift;
 484     my $hint = shift;
 485
 486     my ($class) = grep {
 487         OpenILS::Application->publish_fieldmapper->{$_}->{hint} eq $hint
 488     } keys %{ OpenILS::Application->publish_fieldmapper };
 489
 490     return $class;
 491 }
 492
 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 $fhint ( keys %$shash ) {
 500                 my $hhash = $$shash{$fhint};
 501                 for my $step ( keys %$hhash ) {
 502                     my $fhash = $$hhash{$step};
 503                     for my $ffield ( keys %$fhash ) {
 504                         my $lhash = $$fhash{$ffield};
 505                         for my $lfield ( keys %$lhash ) {
 506                             delete $$lhash{$lfield};
 507                         }
 508                         delete $$fhash{$ffield};
 509                     }
 510                     delete $$hhash{$step};
 511                 }
 512                 delete $$shash{$fhint};
 513             }
 514             delete $$phash{$path};
 515         }
 516         delete $_object_by_path_cache{$did};
 517     }
 518 }
 519
 520 sub _object_by_path {
 521     my $self = shift;
 522     my $context = shift;
 523     my $collector = shift;
 524     my $label = shift;
 525     my $path = shift;
 526     my $ed = shift;
 527     my $red = shift;
 528
 529     my $outer = 0;
 530     if (!$ed) {
 531         $ed = new_editor(xact=>1);
 532         $outer = 1;
 533     }
 534
 535     my $step = shift(@$path);
 536
 537     my $fhint = OpenILS::Application->publish_fieldmapper->{$context->class_name}{links}{$step}{class};
 538     my $fclass = $self->_fm_class_by_hint( $fhint );
 539
 540     OpenSRF::EX::ERROR->throw(
 541         "$step is not a field on ".$context->class_name."  Please repair the environment.")
 542         unless $fhint;
 543
 544     my $ffield = OpenILS::Application->publish_fieldmapper->{$context->class_name}{links}{$step}{key};
 545     my $rtype = OpenILS::Application->publish_fieldmapper->{$context->class_name}{links}{$step}{reltype};
 546
 547     my $meth = 'retrieve_';
 548     my $multi = 0;
 549     my $lfield = $step;
 550     if ($rtype ne 'has_a') {
 551         $meth = 'search_';
 552         $multi = 1;
 553         $lfield = $context->Identity;
 554     }
 555
 556     $meth .= $fclass;
 557     $meth =~ s/Fieldmapper:://;
 558     $meth =~ s/::/_/g;
 559
 560     my $obj = $context->$step();
 561
 562     $logger->debug(
 563         sprintf "_object_by_path(): meth=%s, obj=%s, multi=%s, step=%s, lfield=%s",
 564         map {defined($_)? $_ : ''} ($meth,  $obj,   $multi,   $step,   $lfield)
 565     );
 566
 567     if (!ref $obj) {
 568
 569         my $lval = $context->$lfield();
 570
 571         if(defined $lval) {
 572
 573             my $def_id = $self->event->event_def->id;
 574             my $str_path = join('.', @$path);
 575
 576             $obj = $_object_by_path_cache{$def_id}{$str_path}{$fhint}{$step}{$ffield}{$lval} ||
 577                 (
 578                     (grep /cstore/, @{
 579                         OpenILS::Application->publish_fieldmapper->{$fclass}{controller}
 580                     }) ? $ed : ($red ||= new_rstore_editor(xact=>1))
 581                 )->$meth( ($multi) ? { $ffield => $lval } : $lval);
 582
 583             $_object_by_path_cache{$def_id}{$str_path}{$fhint}{$step}{$ffield}{$lval} ||= $obj;
 584         }
 585     }
 586
 587     if (@$path) {
 588
 589         my $obj_list = [];
 590         if (!$multi) {
 591             $obj_list = [$obj] if ($obj);
 592         } else {
 593             $obj_list = $obj;
 594         }
 595
 596         for (@$obj_list) {
 597             my @path_clone = @$path;
 598             $self->_object_by_path( $_, $collector, $label, \@path_clone, $ed, $red );
 599         }
 600
 601         $obj = $$obj_list[0] if (!$multi || $rtype eq 'might_have');
 602         $context->$step( $obj ) if ($obj && (!$label || !@$label));
 603
 604     } else {
 605
 606         if ($collector) {
 607             my $obj_list = [$obj] if ($obj && !$multi);
 608             $obj_list = $obj if ($multi);
 609
 610             my @new_obj_list;
 611             for my $o ( @$obj_list ) {
 612                 push @new_obj_list,
 613                     OpenILS::Application::Trigger::ModRunner::Collector
 614                         ->new( $collector, $o )
 615                         ->run
 616                         ->final_result
 617             }
 618
 619             if (!$multi) {
 620                 $obj = $new_obj_list[0];
 621             } else {
 622                 $obj = \@new_obj_list;
 623             }
 624         }
 625
 626         if ($label && @$label) {
 627             my $node = $self->environment;
 628             my $i = 0; my $max = scalar(@$label);
 629             for (; $i < $max; $i++) {
 630                 my $part = $$label[$i];
 631                 $$node{$part} ||= {};
 632                 $node = $$node{$part};
 633             }
 634             $$node{$$label[-1]} = $obj;
 635         } else {
 636             $obj = $$obj[0] if $rtype eq 'might_have';
 637             $context->$step( $obj ) if ($obj);
 638         }
 639     }
 640
 641     if ($outer) {
 642         $ed->rollback;
 643         $red->rollback if $red;
 644     }
 645     return $obj;
 646 }
 647
 648 1;