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