general purpose action/trigger event creator and runner. see --help for usage

git-svn-id: svn://svn.open-ils.org/ILS/trunk@14611 dcc99617-32d9-48b4-a31d-7c20da2025e4

diff --git a/Open-ILS/src/support-scripts/action_trigger_runner.pl b/Open-ILS/src/support-scripts/action_trigger_runner.pl
new file mode 100755 (executable)
index 0000000..02e3738
--- /dev/null
+++ b/Open-ILS/src/support-scripts/action_trigger_runner.pl
@@ -0,0 +1,147 @@
+#!/usr/bin/perl
+# ---------------------------------------------------------------
+# Copyright (C) 2009 Equinox Software, Inc
+# Author: Bill Erickson <erickson@esilibrary.com>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# ---------------------------------------------------------------
+use strict;
+use warnings;
+use Getopt::Long;
+use OpenSRF::AppSession;
+use OpenSRF::Utils::JSON;
+require 'oils_header.pl';
+
+my $opt_lockfile = '/tmp/action-trigger-LOCK';
+my $opt_osrf_config = '/openils/conf/opensrf_core.xml';
+my $opt_run_pending = 0;
+my $opt_debug_stdout = 0;
+my $opt_help = 0;
+my $opt_custom_filter;
+my $opt_hooks;
+
+GetOptions(
+    'osrf-config=s' => \$opt_osrf_config,
+    'run-pending' => \$opt_run_pending,
+    'hooks=s' => \$opt_hooks,
+    'debug-stdout' => \$opt_debug_stdout,
+    'custom-filter=s' => \$opt_custom_filter,
+    'lock-file=s' => \$opt_lockfile,
+    'help' => \$opt_help,
+);
+
+
+# typical passive hook filters
+my %hook_handlers = (
+
+    # overdue circulations
+    'checkout.due' => {
+        context_org => 'circ_lib',
+        filter => {
+            checkin_time => undef, 
+            '-or' => [
+                {stop_fines => ['MAXFINES', 'LONGOVERDUE']}, 
+                {stop_fines => undef}
+            ]
+        }
+    }
+);
+
+sub help {
+    print <<HELP;
+
+$0 : Create and process action/trigger events
+
+    --osrf-config <config_file>
+        OpenSRF config file
+
+    --run-pending
+        Run pending action_trigger.event's
+
+    --hooks hook1[,hook2,hook3,...]
+        hooks to generate events for
+
+    --debug-stdout
+        Print server responses to stdout (as JSON) for debugging
+
+    --lock-file <file_name>
+        Lock file
+
+    --help
+        Show this help
+
+    Examples:
+
+        # To run all pending events.  This is what you tell CRON to run at regular intervals
+        perl $0 --osrf-config /openils/conf/opensrf_core.xml --run-pending
+
+        # To batch create all "checkout.due" events
+        perl $0 --osrf-config /openils/conf/opensrf_core.xml --hooks checkout.due
+
+HELP
+}
+
+
+# create events for the specified hooks using the configured filters and context orgs
+sub process_hooks {
+
+    my @hooks = ($opt_hooks) ? split(',', $opt_hooks) : ();
+    my $ses = OpenSRF::AppSession->create('open-ils.trigger');
+
+    for my $hook (@hooks) {
+    
+        my $config = $hook_handlers{$hook} or next;
+        my $method = 'open-ils.trigger.passive.event.autocreate.batch';
+        $method =~ s/passive/active/ if $config->{active};
+        
+        my $filter = ($opt_custom_filter) ? OpenSRF::Utils::JSON->JSON2Perl($opt_custom_filter) : $config->{filter};
+    
+        my $req = $ses->request($method, $hook, $config->{context_org}, $filter);
+        while(my $resp = $req->recv(timeout => 1800)) {
+            if($opt_debug_stdout) {
+                print OpenSRF::Utils::JSON->perl2JSON($resp->content) . "\n";
+            }
+        }
+    }
+}
+
+sub run_pending {
+    return unless $opt_run_pending;
+    my $ses = OpenSRF::AppSession->create('open-ils.trigger');
+    my $req = $ses->request('open-ils.trigger.event.run_all_pending');
+    while(my $resp = $req->recv(timeout => 600)) {
+        if($opt_debug_stdout) {
+            print OpenSRF::Utils::JSON->perl2JSON($resp->content) . "\n";
+        }
+    }
+}
+
+help() and exit if $opt_help;
+help() and exit unless ($opt_run_pending or $opt_hooks);
+
+# check / set the lockfile
+die "I'm already running with lockfile $opt_lockfile\n" if -e $opt_lockfile;
+open(F, ">$opt_lockfile") or die "Unable to open lockfile $opt_lockfile for writing\n";
+print F $$;
+close F;
+
+eval {
+    osrf_connect($opt_osrf_config);
+    process_hooks();
+    run_pending();
+};
+
+warn "$@\n" if $@;
+
+unlink $opt_lockfile;
+
+
+