1 files changed, 244 insertions, 0 deletions
diff --git a/rt/bin/rt-crontool.in b/rt/bin/rt-crontool.in
new file mode 100644
index 000000000..76b08c344
--- /dev/null
+++ b/rt/bin/rt-crontool.in
@@ -0,0 +1,244 @@
+#!@PERL@
+# BEGIN BPS TAGGED BLOCK {{{
+# 
+# COPYRIGHT:
+#  
+# This software is Copyright (c) 1996-2005 Best Practical Solutions, LLC 
+#                                          <jesse@bestpractical.com>
+# 
+# (Except where explicitly superseded by other copyright notices)
+# 
+# 
+# LICENSE:
+# 
+# This work is made available to you under the terms of Version 2 of
+# the GNU General Public License. A copy of that license should have
+# been provided with this software, but in any event can be snarfed
+# from www.gnu.org.
+# 
+# This work 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.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+# 
+# 
+# CONTRIBUTION SUBMISSION POLICY:
+# 
+# (The following paragraph is not intended to limit the rights granted
+# to you to modify and distribute this software under the terms of
+# the GNU General Public License and is only of importance to you if
+# you choose to contribute your changes and enhancements to the
+# community by submitting them to Best Practical Solutions, LLC.)
+# 
+# By intentionally submitting any modifications, corrections or
+# derivatives to this work, or any other work intended for use with
+# Request Tracker, to Best Practical Solutions, LLC, you confirm that
+# you are the copyright holder for those contributions and you grant
+# Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
+# royalty-free, perpetual, license to use, copy, create derivative
+# works based on those contributions, and sublicense and distribute
+# those contributions and any derivatives thereof.
+# 
+# END BPS TAGGED BLOCK }}}
+use strict;
+use Carp;
+
+use lib ("@LOCAL_LIB_PATH@", "@RT_LIB_PATH@");
+
+package RT;
+
+use Getopt::Long;
+
+use RT::Interface::CLI qw(CleanEnv GetCurrentUser GetMessageContent loc);
+use RT::Tickets;
+use RT::Template;
+
+#Clean out all the nasties from the environment
+CleanEnv();
+
+# Load the config file
+RT::LoadConfig();
+
+#Connect to the database and get RT::SystemUser and RT::Nobody loaded
+RT::Init();
+
+#Get the current user all loaded
+my $CurrentUser = GetCurrentUser();
+
+unless ( $CurrentUser->Id ) {
+    print loc("No RT user found. Please consult your RT administrator.\n");
+    exit(1);
+}
+
+my ( $search, $condition, $action, $search_arg, $condition_arg, $action_arg,
+     $template_id, $help, $verbose );
+GetOptions( "search=s"        => \$search,
+            "search-arg=s"    => \$search_arg,
+            "condition=s"     => \$condition,
+            "condition-arg=s" => \$condition_arg,
+            "action-arg=s"    => \$action_arg,
+            "action=s"        => \$action,
+	    "template-id=s"   => \$template_id,
+            "help"            => \$help,
+            "verbose|v"       => \$verbose );
+
+help() if $help or not $search or not $action;
+
+# We _must_ have a search object
+load_module($search);
+load_module($action)    if ($action);
+load_module($condition) if ($condition);
+
+# load template if specified
+my $template_obj;
+if ($template_id) {
+    $template_obj = RT::Template->new($CurrentUser);
+    $template_obj->Load($template_id);
+}
+
+#At the appointed time:
+
+#find a bunch of tickets
+my $tickets = RT::Tickets->new($CurrentUser);
+my $search  = $search->new(
+    TicketsObj  => $tickets,
+    Argument    => $search_arg,
+    CurrentUser => $CurrentUser
+);
+
+$search->Prepare();
+
+# TicketsFound is an RT::Tickets object
+my $tickets = $search->TicketsObj;
+
+#for each ticket we've found
+while ( my $ticket = $tickets->Next() ) {
+    print $ticket->Id() . ": " if ($verbose);
+
+    # perform some more advanced check
+    if ($condition) {
+        my $condition_obj = $condition->new( TicketObj => $ticket,
+                                             Argument  => $condition_arg,
+                                             CurrentUser => $CurrentUser );
+
+        # if the condition doesn't apply, get out of here
+
+        next unless ( $condition_obj->IsApplicable );
+        print loc("Condition matches...") if ($verbose);
+    }
+
+    #prepare our action
+    my $action_obj = $action->new(
+        TicketObj   => $ticket,
+        TemplateObj => $template_obj,
+        Argument    => $action_arg,
+        CurrentUser => $CurrentUser
+    );
+
+    #if our preparation, move onto the next ticket
+    next unless ( $action_obj->Prepare );
+    print loc("Action prepared...") if ($verbose);
+
+    #commit our action.
+    next unless ( $action_obj->Commit );
+    print loc("Action committed.\n") if ($verbose);
+}
+
+# {{{ load_module 
+
+=head2 load_module
+
+Loads a perl module, dying nicely if it can't find it.
+
+=cut
+
+sub load_module {
+    my $modname = shift;
+    eval "require $modname";
+    if ($@) {
+        die loc( "Failed to load module [_1]. ([_2])", $modname, $@ );
+    }
+
+}
+
+# }}}
+
+# {{{ loc 
+
+=head2 loc LIST
+
+Localize this string, with the current user's currentuser object
+
+=cut
+
+sub loc {
+    $CurrentUser->loc(@_);
+}
+
+# }}}
+
+sub help {
+
+    print loc( "[_1] is a tool to act on tickets from an external scheduling tool, such as cron.", $0 )
+      . "\n";
+    print loc("It takes several arguments:") . "\n\n";
+
+    print "	"
+      . loc( "[_1] - Specify the search module you want to use", "--search" )
+      . "\n";
+    print "	"
+      . loc( "[_1] - An argument to pass to [_2]", "--search-argument", "--search" )
+      . "\n";
+
+    print "	"
+      . loc( "[_1] - Specify the condition module you want to use", "--condition" )
+      . "\n";
+    print "	"
+      . loc( "[_1] - An argument to pass to [_2]", "--condition-argument", "--condition" )
+      . "\n";
+    print "	"
+      . loc( "[_1] - Specify the action module you want to use", "--action" )
+      . "\n";
+    print "	"
+      . loc( "[_1] - An argument to pass to [_2]", "--action-argument", "--action" )
+      . "\n";
+    print "	"
+      . loc( "[_1] - Output status updates to STDOUT", "--verbose" ) . "\n";
+    print "\n";
+    print "\n";
+    print loc("Security:")."\n";
+    print loc("This tool allows the user to run arbitrary perl modules from within RT.")." ". 
+        loc("If this tool were setgid, a hostile local user could use this tool to gain administrative access to RT.")." ".
+        loc("It is incredibly important that nonprivileged users not be allowed to run this tool."). " " . 
+        loc("It is suggested that you create a non-privileged unix user with the correct group membership and RT access to run this tool.")."\n";
+    print "\n";
+    print loc("Example:");
+    print "\n";
+    print " "
+      . loc( "The following command will find all active tickets in the queue 'general' and set their priority to 99 if they haven't been touched in 4 hours:"
+      )
+      . "\n\n";
+
+    print " bin/rt-crontool \\\n";
+    print "  --search RT::Search::ActiveTicketsInQueue  --search-arg general \\\n";
+    print "  --condition RT::Condition::UntouchedInHours --condition-arg 4 \\\n";
+    print "  --action RT::Action::SetPriority --action-arg 99 \\\n";
+    print "  --verbose\n";
+
+    print "\n";
+    print loc("Escalate tickets"). "\n";
+    print " bin/rt-crontool \\\n";
+    print "  --search RT::Search::ActiveTicketsInQueue  --search-arg general \\\n";
+    print "  --action RT::Action::EscalatePriority\n";
+ 
+ 
+ 
+
+
+
+    exit(0);
+}