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

   1 package OpenILS::Application::Trigger;
   2 use strict; use warnings;
   3 use OpenILS::Application;
   4 use base qw/OpenILS::Application/;
   5
   6 use OpenSRF::EX qw/:try/;
   7
   8 use OpenSRF::AppSession;
   9 use OpenSRF::Utils::SettingsClient;
  10 use OpenSRF::Utils::Logger qw/$logger/;
  11 use OpenSRF::Utils qw/:datetime/;
  12
  13 use DateTime;
  14 use DateTime::Format::ISO8601;
  15
  16 use OpenILS::Utils::Fieldmapper;
  17 use OpenILS::Utils::CStoreEditor q/:funcs/;
  18 use OpenILS::Application::Trigger::Event;
  19 use OpenILS::Application::Trigger::EventGroup;
  20
  21
  22 my $log = 'OpenSRF::Utils::Logger';
  23
  24 sub initialize {}
  25 sub child_init {}
  26
  27 sub create_active_events_for_object {
  28     my $self = shift;
  29     my $client = shift;
  30     my $key = shift;
  31     my $target = shift;
  32     my $location = shift;
  33
  34     my $ident = $target->Identity;
  35     my $ident_value = $target->$ident();
  36
  37     my $editor = new_editor(xact=>1);
  38
  39     my $hooks = $editor->search_action_trigger_hook(
  40         { key       => $key,
  41           core_type => $target->json_hint
  42         }
  43     );
  44
  45     unless(@$hooks) {
  46         $editor->rollback;
  47         return undef;
  48     }
  49
  50     my %hook_hash = map { ($_->key, $_) } @$hooks;
  51
  52     my $orgs = $editor->json_query({ from => [ 'actor.org_unit_ancestors' => $location ] });
  53     my $defs = $editor->search_action_trigger_event_definition(
  54         { hook   => [ keys %hook_hash ],
  55           owner  => [ map { $_->{id} } @$orgs  ],
  56           active => 't'
  57         }
  58     );
  59
  60     for my $def ( @$defs ) {
  61
  62         my $date = DateTime->now;
  63
  64         if ($hook_hash{$def->hook}->passive eq 'f') {
  65
  66             if (my $dfield = $def->delay_field) {
  67                 if ($target->$dfield()) {
  68                     $date = DateTime::Format::ISO8601->new->parse_datetime( clense_ISO8601($target->$dfield) );
  69                 } else {
  70                     next;
  71                 }
  72             }
  73
  74             $date->add( seconds => interval_to_seconds($def->delay) );
  75         }
  76
  77         my $event = Fieldmapper::action_trigger::event->new();
  78         $event->target( $ident_value );
  79         $event->event_def( $def->id );
  80         $event->run_time( $date->strftime( '%F %T%z' ) );
  81
  82         $editor->create_action_trigger_event( $event );
  83
  84         $client->respond( $event->id );
  85     }
  86
  87     $editor->commit;
  88
  89     return undef;
  90 }
  91 __PACKAGE__->register_method(
  92     api_name => 'open-ils.trigger.event.autocreate',
  93     method   => 'create_active_events_for_object',
  94     api_level=> 1,
  95     stream   => 1,
  96     argc     => 3
  97 );
  98
  99 sub create_event_for_object_and_def {
 100     my $self = shift;
 101     my $client = shift;
 102     my $definitions = shift;
 103     my $target = shift;
 104     my $location = shift;
 105
 106     my $ident = $target->Identity;
 107     my $ident_value = $target->$ident();
 108
 109     my @active = ($self->api_name =~ /inactive/o) ? () : ( active => 't' );
 110
 111     my $editor = new_editor(xact=>1);
 112
 113     my $orgs = $editor->json_query({ from => [ 'actor.org_unit_ancestors' => $location ] });
 114     my $defs = $editor->search_action_trigger_event_definition(
 115         { id => $definitions,
 116           owner  => [ map { $_->{id} } @$orgs  ],
 117           @active
 118         }
 119     );
 120
 121     my $hooks = $editor->search_action_trigger_hook(
 122         { key       => [ map { $_->hook } @$defs ],
 123           core_type => $target->json_hint
 124         }
 125     );
 126
 127     my %hook_hash = map { ($_->key, $_) } @$hooks;
 128
 129     for my $def ( @$defs ) {
 130
 131         my $date = DateTime->now;
 132
 133         if ($hook_hash{$def->hook}->passive eq 'f') {
 134
 135             if (my $dfield = $def->delay_field) {
 136                 if ($target->$dfield()) {
 137                     $date = DateTime::Format::ISO8601->new->parse_datetime( clense_ISO8601($target->$dfield) );
 138                 } else {
 139                     next;
 140                 }
 141             }
 142
 143             $date->add( seconds => interval_to_seconds($def->delay) );
 144         }
 145
 146         my $event = Fieldmapper::action_trigger::event->new();
 147         $event->target( $ident_value );
 148         $event->event_def( $def->id );
 149         $event->run_time( $date->strftime( '%F %T%z' ) );
 150
 151         $editor->create_action_trigger_event( $event );
 152
 153         $client->respond( $event->id );
 154     }
 155
 156     $editor->commit;
 157
 158     return undef;
 159 }
 160 __PACKAGE__->register_method(
 161     api_name => 'open-ils.trigger.event.autocreate.by_definition',
 162     method   => 'create_event_for_object_and_def',
 163     api_level=> 1,
 164     stream   => 1,
 165     argc     => 3
 166 );
 167 __PACKAGE__->register_method(
 168     api_name => 'open-ils.trigger.event.autocreate.by_definition.include_inactive',
 169     method   => 'create_event_for_object_and_def',
 170     api_level=> 1,
 171     stream   => 1,
 172     argc     => 3
 173 );
 174
 175
 176 # Retrieves events by object, or object type + filter
 177 #  $object : a target object or object type (class hint)
 178 #
 179 #  $filter : an optional hash of filters ... top level keys:
 180 #     event
 181 #        filters on the atev objects, such as states or null-ness of timing
 182 #        fields. contains the effective default of:
 183 #          { state => 'pending' }
 184 #        an example, which overrides the default, and will find
 185 #        stale 'found' events:
 186 #          { state => 'found', update_time => { '<' => 'yesterday' } }
 187 #
 188 #      event_def
 189 #        filters on the atevdef object. contains the effective default of:
 190 #          { active => 't' }
 191 #
 192 #      hook
 193 #        filters on the hook object. no defaults, but there is a pinned,
 194 #        unchangeable filter based on the passed hint or object type (see
 195 #        $object above). an example for finding passive events:
 196 #          { passive => 't' }
 197 #
 198 #     target
 199 #        filters against the target field on the event. this can contain
 200 #        either an array of target ids (if you passed an object type, and
 201 #        not an object) or can contain a json_query that will return exactly
 202 #        a list of target-type ids.  If you pass an object, the pkey value of
 203 #        that object will be used as a filter in addition to the filter passed
 204 #        in here.  example filter for circs of user 1234 that are open:
 205 #          { select => { circ => ['id'] },
 206 #            from => 'circ',
 207 #            where => {
 208 #              usr => 1234,
 209 #              checkin_time => undef,
 210 #              '-or' => [
 211 #                { stop_fines => undef },
 212 #                { stop_fines => { 'not in' => ['LOST','LONGOVERDUE','CLAIMSRETURNED'] } }
 213 #              ]
 214 #            }
 215
 216 sub events_by_target {
 217     my $self = shift;
 218     my $client = shift;
 219     my $object = shift;
 220     my $filter = shift || {};
 221     my $flesh_fields = shift || {};
 222     my $flesh_depth = shift || 1;
 223
 224     my $obj_class = ref($object) || _fm_class_by_hint($object);
 225     my $obj_hint = ref($object) ? _fm_hint_by_class(ref($object)) : $object;
 226
 227     my $object_ident_field = $obj_class->Identity;
 228
 229     my $query = {
 230         select => { atev => ["id"] },
 231         from   => {
 232             atev => {
 233                 atevdef => {
 234                     field => "id",
 235                     fkey => "event_def",
 236                     join => {
 237                         ath => { field => "key", fkey => "hook" }
 238                     }
 239                 }
 240             }
 241         },
 242         where  => {
 243             "+ath"  => { core_type => $obj_hint },
 244             "+atevdef" => { active => 't' },
 245             "+atev" => { state => 'pending' }
 246         },
 247         order_by => { "+atev" => [ 'run_time', 'add_time' ] },
 248         distinct => 1
 249     };
 250
 251
 252     # allow multiple 'target' filters
 253     $query->{where}->{'+atev'}->{'-and'} = [];
 254
 255     # if we got a real object, filter on its pkey value
 256     if (ref($object)) { # pass an object, require that target
 257         push @{ $query->{where}->{'+atev'}->{'-and'} },
 258             { target => $object->$object_ident_field }
 259     }
 260
 261     # we have a fancy complex target filter or a list of target ids
 262     if ($$filter{target}) {
 263         push @{ $query->{where}->{'+atev'}->{'-and'} },
 264             { target => {in => $$filter{target} } };
 265     }
 266
 267     # pass no target filter or object, you get no events
 268     if (!@{ $query->{where}->{'+atev'}->{'-and'} }) {
 269         return undef;
 270     }
 271
 272     # any hook filters, other than the required core_type filter
 273     if ($$filter{hook}) {
 274         $query->{where}->{'+ath'}->{$_} = $$filter{hook}{$_}
 275             for (grep { $_ ne 'core_type' } keys %{$$filter{hook}});
 276     }
 277
 278     # any event_def filters.  defaults to { active => 't' }
 279     if ($$filter{event_def}) {
 280         $query->{where}->{'+atevdef'}->{$_} = $$filter{event_def}{$_}
 281             for (keys %{$$filter{event_def}});
 282     }
 283
 284     # any event filters.  defaults to { state => 'pending' }.
 285     # don't overwrite '-and' used for multiple target filters above
 286     if ($$filter{event}) {
 287         $query->{where}->{'+atev'}->{$_} = $$filter{event}{$_}
 288             for (grep { $_ ne '-and' } keys %{$$filter{event}});
 289     }
 290
 291     my $e = new_editor();
 292
 293     my $events = $e->json_query($query);
 294
 295     $flesh_fields->{atev} = ['event_def'] unless $flesh_fields->{atev};
 296
 297     for my $id (@$events) {
 298         my $event = $e->retrieve_action_trigger_event([
 299             $id->{id},
 300             {flesh => $flesh_depth, flesh_fields => $flesh_fields}
 301         ]);
 302
 303         (my $meth = $obj_class) =~ s/^Fieldmapper:://o;
 304         $meth =~ s/::/_/go;
 305         $meth = 'retrieve_'.$meth;
 306
 307         $event->target($e->$meth($event->target));
 308         $client->respond($event);
 309     }
 310
 311     return undef;
 312 }
 313 __PACKAGE__->register_method(
 314     api_name => 'open-ils.trigger.events_by_target',
 315     method   => 'events_by_target',
 316     api_level=> 1,
 317     stream   => 1,
 318     argc     => 2
 319 );
 320
 321 sub _fm_hint_by_class {
 322     my $class = shift;
 323     return Fieldmapper->publish_fieldmapper->{$class}->{hint};
 324 }
 325
 326 sub _fm_class_by_hint {
 327     my $hint = shift;
 328
 329     my ($class) = grep {
 330         Fieldmapper->publish_fieldmapper->{$_}->{hint} eq $hint
 331     } keys %{ Fieldmapper->publish_fieldmapper };
 332
 333     return $class;
 334 }
 335
 336 sub create_batch_events {
 337     my $self = shift;
 338     my $client = shift;
 339     my $key = shift;
 340     my $location_field = shift; # where to look for event_def.owner filtering ... circ_lib, for instance, where hook.core_type = circ
 341     my $filter = shift || {};
 342     my $granularity = shift;
 343
 344     my $active = ($self->api_name =~ /active/o) ? 1 : 0;
 345     if ($active && !keys(%$filter)) {
 346         $log->info("Active batch event creation requires a target filter but none was supplied to create_batch_events");
 347         return undef;
 348     }
 349
 350     return undef unless ($key && $location_field);
 351
 352     my $editor = new_editor(xact=>1);
 353     my $hooks = $editor->search_action_trigger_hook(
 354         { passive => $active ? 'f' : 't', key => $key }
 355     );
 356
 357     my %hook_hash = map { ($_->key, $_) } @$hooks;
 358
 359     my $defs = $editor->search_action_trigger_event_definition(
 360         { hook   => [ keys %hook_hash ], active => 't' },
 361     );
 362
 363     my $orig_filter_and = [];
 364     if ($$filter{'-and'}) {
 365         for my $f ( @{ $$filter{'-and'} } ) {
 366             push @$orig_filter_and, $f;
 367         }
 368     }
 369
 370     for my $def ( @$defs ) {
 371
 372         my $date = DateTime->now->subtract( seconds => interval_to_seconds($def->delay) );
 373
 374         # we may need to do some work to backport this to 1.2
 375         $filter->{ $location_field } = { 'in' =>
 376             {
 377                 select  => { aou => [{ column => 'id', transform => 'actor.org_unit_descendants', result_field => 'id' }] },
 378                 from    => 'aou',
 379                 where   => { id => $def->owner }
 380             }
 381         };
 382
 383         my $run_time = 'now';
 384         if ($active) {
 385             $run_time =
 386                 DateTime
 387                     ->now
 388                     ->add( seconds => interval_to_seconds($def->delay) )
 389                     ->strftime( '%F %T%z' );
 390         } else {
 391             if ($def->max_delay) {
 392                 my @times = sort {$a <=> $b} interval_to_seconds($def->delay), interval_to_seconds($def->max_delay);
 393                 $filter->{ $def->delay_field } = {
 394                     'between' => [
 395                         DateTime->now->subtract( seconds => $times[1] )->strftime( '%F %T%z' ),
 396                         DateTime->now->subtract( seconds => $times[0] )->strftime( '%F %T%z' )
 397                     ]
 398                 };
 399             } else {
 400                 $filter->{ $def->delay_field } = {
 401                     '<=' => DateTime->now->subtract( seconds => interval_to_seconds($def->delay) )->strftime( '%F %T%z' )
 402                 };
 403             }
 404         }
 405
 406         my $class = _fm_class_by_hint($hook_hash{$def->hook}->core_type);
 407
 408         # filter where this target has an event (and it's pending, for active hooks)
 409         $$filter{'-and'} = [];
 410         for my $f ( @$orig_filter_and ) {
 411             push @{ $$filter{'-and'} }, $f;
 412         }
 413
 414         push @{ $filter->{'-and'} }, {
 415             '-not-exists' => {
 416                 from  => 'atev',
 417                 where => {
 418                     event_def => $def->id,
 419                     target    => { '=' => { '+' . $hook_hash{$def->hook}->core_type => $class->Identity } },
 420                     ($active ? (state  => 'pending') : ())
 421                 }
 422             }
 423         };
 424
 425         $class =~ s/^Fieldmapper:://o;
 426         $class =~ s/::/_/go;
 427
 428         my $method = 'search_'. $class;
 429         my $object_ids = $editor->$method( $filter, {idlist => 1, timeout => 1800} );
 430
 431         for my $o_id (@$object_ids) {
 432
 433             my $event = Fieldmapper::action_trigger::event->new();
 434             $event->target( $o_id );
 435             $event->event_def( $def->id );
 436             $event->run_time( $run_time );
 437             $event->granularity($granularity) if (defined $granularity);
 438
 439             $editor->create_action_trigger_event( $event );
 440
 441             $client->respond( $event->id );
 442         }
 443     }
 444
 445     $editor->commit;
 446
 447     return undef;
 448 }
 449 __PACKAGE__->register_method(
 450     api_name => 'open-ils.trigger.passive.event.autocreate.batch',
 451     method   => 'create_batch_events',
 452     api_level=> 1,
 453     stream   => 1,
 454     argc     => 2
 455 );
 456
 457 __PACKAGE__->register_method(
 458     api_name => 'open-ils.trigger.active.event.autocreate.batch',
 459     method   => 'create_batch_events',
 460     api_level=> 1,
 461     stream   => 1,
 462     argc     => 2
 463 );
 464
 465 sub fire_single_event {
 466     my $self = shift;
 467     my $client = shift;
 468     my $event_id = shift;
 469
 470     my $e = OpenILS::Application::Trigger::Event->new($event_id);
 471
 472     if ($e->validate->valid) {
 473         $logger->info("Event is valid, reacting...");
 474         $e->react->cleanup;
 475     }
 476
 477     $e->editor->disconnect;
 478
 479     return {
 480         valid     => $e->valid,
 481         reacted   => $e->reacted,
 482         cleanedup => $e->cleanedup,
 483         event     => $e->event
 484     };
 485 }
 486 __PACKAGE__->register_method(
 487     api_name => 'open-ils.trigger.event.fire',
 488     method   => 'fire_single_event',
 489     api_level=> 1,
 490     argc     => 1
 491 );
 492
 493 sub fire_event_group {
 494     my $self = shift;
 495     my $client = shift;
 496     my $events = shift;
 497
 498     my $e = OpenILS::Application::Trigger::EventGroup->new(@$events);
 499
 500     if ($e->validate->valid) {
 501         $logger->info("Event group is valid, reacting...");
 502         $e->react->cleanup;
 503     }
 504
 505     $e->editor->disconnect;
 506
 507     return {
 508         valid     => $e->valid,
 509         reacted   => $e->reacted,
 510         cleanedup => $e->cleanedup,
 511         events    => [map { $_->event } @{$e->events}]
 512     };
 513 }
 514 __PACKAGE__->register_method(
 515     api_name => 'open-ils.trigger.event_group.fire',
 516     method   => 'fire_event_group',
 517     api_level=> 1,
 518     argc     => 1
 519 );
 520
 521 sub pending_events {
 522     my $self = shift;
 523     my $client = shift;
 524     my $granularity = shift;
 525
 526     my $editor = new_editor();
 527
 528     my $query = [{ state => 'pending', run_time => {'<' => 'now'} }, { order_by => { atev => [ qw/run_time add_time/] } }];
 529
 530     if (defined $granularity) {
 531         $query->[0]->{'-or'} = [ {granularity => $granularity}, {granularity => undef} ];
 532     } else {
 533         $query->[0]->{granularity} = undef;
 534     }
 535
 536     return $editor->search_action_trigger_event(
 537         $query, { idlist=> 1, timeout => 1800 }
 538     );
 539 }
 540 __PACKAGE__->register_method(
 541     api_name => 'open-ils.trigger.event.find_pending',
 542     method   => 'pending_events',
 543     api_level=> 1
 544 );
 545
 546 sub grouped_events {
 547     my $self = shift;
 548     my $client = shift;
 549     my $granularity = shift;
 550
 551     my ($events) = $self->method_lookup('open-ils.trigger.event.find_pending')->run($granularity);
 552
 553     my %groups = ( '*' => [] );
 554
 555     for my $e_id ( @$events ) {
 556
 557         my $e;
 558         try {
 559            $e = OpenILS::Application::Trigger::Event->new($e_id);
 560         } catch Error with {
 561             $logger->error("Event creation failed with ".shift());
 562         };
 563
 564         next unless $e;
 565         my $valid;
 566
 567         try {
 568             $valid = $e->validate->valid;
 569         } catch Error with {
 570             $logger->error("Event validation failed with ".shift());
 571         };
 572
 573         if ($valid) {
 574
 575             if (my $group = $e->event->event_def->group_field) {
 576
 577                 # split the grouping link steps
 578                 my @steps = split /\./, $group;
 579
 580                 # find the grouping object
 581                 my $node = $e->target;
 582                 $node = $node->$_() for ( @steps );
 583
 584                 # get the pkey value for the grouping object on this event
 585                 my $node_ident = $node->Identity;
 586                 my $ident_value = $node->$node_ident();
 587
 588                 # push this event onto the event+grouping_pkey_value stack
 589                 $groups{$e->event->event_def->id}{$ident_value} ||= [];
 590                 push @{ $groups{$e->event->event_def->id}{$ident_value} }, $e;
 591             } else {
 592                 # it's a non-grouped event
 593                 push @{ $groups{'*'} }, $e;
 594             }
 595         }
 596         $e->editor->disconnect;
 597     }
 598
 599     return \%groups;
 600 }
 601 __PACKAGE__->register_method(
 602     api_name => 'open-ils.trigger.event.find_pending_by_group',
 603     method   => 'grouped_events',
 604     api_level=> 1
 605 );
 606
 607 sub run_all_events {
 608     my $self = shift;
 609     my $client = shift;
 610     my $granularity = shift;
 611
 612     my ($groups) = $self->method_lookup('open-ils.trigger.event.find_pending_by_group')->run($granularity);
 613
 614     for my $def ( %$groups ) {
 615         if ($def eq '*') {
 616             for my $event ( @{ $$groups{'*'} } ) {
 617                 try {
 618                     $client->respond(
 619                         $self
 620                             ->method_lookup('open-ils.trigger.event.fire')
 621                             ->run($event)
 622                     );
 623                 } catch Error with {
 624                     $logger->error("event firing failed with ".shift());
 625                 };
 626             }
 627         } else {
 628             my $defgroup = $$groups{$def};
 629             for my $ident ( keys %$defgroup ) {
 630                 try {
 631                     $client->respond(
 632                         $self
 633                             ->method_lookup('open-ils.trigger.event_group.fire')
 634                             ->run($$defgroup{$ident})
 635                     );
 636                 } catch Error with {
 637                     $logger->error("event firing failed with ".shift());
 638                 };
 639             }
 640         }
 641     }
 642
 643
 644 }
 645 __PACKAGE__->register_method(
 646     api_name => 'open-ils.trigger.event.run_all_pending',
 647     method   => 'run_all_events',
 648     api_level=> 1
 649 );
 650
 651
 652 1;