X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=rt%2Fbin%2Frt-crontool.in;h=37e74f1c19eb3d1aea40d41e21162ce31e2d1941;hp=9881120fad7162b79e5ff18bbb0c1b83e0127e0f;hb=de9d037528895f7151a9aead6724ce2df95f9586;hpb=ef20b2b6b1feb47ad02b5ff7525f1a0fd11d0fa4 diff --git a/rt/bin/rt-crontool.in b/rt/bin/rt-crontool.in index 9881120fa..37e74f1c1 100644 --- a/rt/bin/rt-crontool.in +++ b/rt/bin/rt-crontool.in @@ -1,41 +1,41 @@ #!@PERL@ # BEGIN BPS TAGGED BLOCK {{{ -# +# # COPYRIGHT: -# -# This software is Copyright (c) 1996-2007 Best Practical Solutions, LLC -# -# +# +# This software is Copyright (c) 1996-2017 Best Practical Solutions, LLC +# +# # (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., 51 Franklin Street, Fifth Floor, Boston, MA # 02110-1301 or visit their web page on the internet at -# http://www.gnu.org/copyleft/gpl.html. -# -# +# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html. +# +# # 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 @@ -44,72 +44,100 @@ # 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 warnings; use Carp; -use lib ("@LOCAL_LIB_PATH@", "@RT_LIB_PATH@"); +# fix lib paths, some may be relative +BEGIN { # BEGIN RT CMD BOILERPLATE + require File::Spec; + require Cwd; + my @libs = ("@RT_LIB_PATH@", "@LOCAL_LIB_PATH@"); + my $bin_path; + + for my $lib (@libs) { + unless ( File::Spec->file_name_is_absolute($lib) ) { + $bin_path ||= ( File::Spec->splitpath(Cwd::abs_path(__FILE__)) )[1]; + $lib = File::Spec->catfile( $bin_path, File::Spec->updir, $lib ); + } + unshift @INC, $lib; + } -package RT; +} -use Getopt::Long; +use RT; -use RT::Interface::CLI qw(CleanEnv GetCurrentUser GetMessageContent loc); -use RT::Tickets; -use RT::Template; +use Getopt::Long; -#Clean out all the nasties from the environment -CleanEnv(); +use RT::Interface::CLI qw(GetCurrentUser loc); + +my ( $search, $condition, $actions, $search_arg, $condition_arg, $actions_arg, + $template, $template_id, $transaction, $transaction_type, $help, $log, $verbose ); +GetOptions( + "search=s" => \$search, + "search-arg=s" => \$search_arg, + "condition=s" => \$condition, + "condition-arg=s" => \$condition_arg, + "action-arg=s@" => \$actions_arg, + "action=s@" => \$actions, + "template=s" => \$template, + "template-id=s" => \$template_id, + "transaction=s" => \$transaction, + "transaction-type=s" => \$transaction_type, + "log=s" => \$log, + "verbose|v" => \$verbose, + "help" => \$help, +); # Load the config file RT::LoadConfig(); +# adjust logging to the screen according to options +RT->Config->Set( LogToSTDERR => $log ) if $log; + #Connect to the database and get RT::SystemUser and RT::Nobody loaded RT::Init(); +require RT::Tickets; +require RT::Template; + #Get the current user all loaded my $CurrentUser = GetCurrentUser(); +# show help even if there is no current user +help() if $help; + unless ( $CurrentUser->Id ) { - print loc("No RT user found. Please consult your RT administrator.\n"); + 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, $transaction, $transaction_type, $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, - "transaction=s" => \$transaction, - "transaction-type=s" => \$transaction_type, - "help" => \$help, - "verbose|v" => \$verbose ); - -help() if $help or not $search or not $action; - -$transaction ||= 'first'; -unless ( $transaction =~ /^(first|last)$/i ) { - print STDERR loc("--transaction argument could be only 'first' or 'last'"); +help() unless $search && $actions; + +$transaction = lc( $transaction||'' ); +if ( $transaction && $transaction !~ /^(first|all|last)$/i ) { + print STDERR loc("--transaction argument could be only 'first', 'last' or 'all'"); + exit 1; +} + +if ( $template && $template_id ) { + print STDERR loc("--template-id is deprecated argument and can not be used with --template"); exit 1; } -$transaction = lc($transaction) eq 'first'? 'ASC': 'DESC'; +elsif ( $template_id ) { +# don't warn + $template = $template_id; +} # We _must_ have a search object load_module($search); -load_module($action) if ($action); +for my $action (@$actions) { + load_module($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); -} my $void_scrip = RT::Scrip->new( $CurrentUser ); my $void_scrip_action = RT::ScripAction->new( $CurrentUser ); @@ -117,24 +145,42 @@ my $void_scrip_action = RT::ScripAction->new( $CurrentUser ); #find a bunch of tickets my $tickets = RT::Tickets->new($CurrentUser); -my $search = $search->new( +$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); + print $ticket->Id() . ":\n" if ($verbose); + + my $template_obj = get_template( $ticket ); + + if ( $transaction ) { + my $txns = get_transactions($ticket); + my $found = 0; + while ( my $txn = $txns->Next ) { + print "\t".loc("Using transaction #[_1]...", $txn->id)."\n" + if $verbose; + process($ticket, $txn, $template_obj); + $found = 1; + } + print "\t".loc("Couldn't find suitable transaction, skipping")."\n" + if $verbose && !$found; + } else { + print "\t".loc("Processing without transaction, some conditions and actions may fail. Consider using --transaction argument")."\n" + if $verbose; + + process($ticket, undef, $template_obj); + } +} - my $transaction = get_transaction($ticket); - print loc("Using transaction #[_1]...", $transaction->id) - if $verbose && $transaction; +sub process { + my $ticket = shift; + my $transaction = shift; + my $template_obj = shift; # perform some more advanced check if ($condition) { @@ -149,82 +195,115 @@ while ( my $ticket = $tickets->Next() ) { # if the condition doesn't apply, get out of here - next unless ( $condition_obj->IsApplicable ); - print loc("Condition matches...") if ($verbose); + return unless $condition_obj->IsApplicable; + print "\t".loc("Condition matches...")."\n" if $verbose; } - #prepare our action - my $action_obj = $action->new( - TicketObj => $ticket, - TransactionObj => $transaction, - TemplateObj => $template_obj, - Argument => $action_arg, - ScripObj => $void_scrip, - ScripActionObj => $void_scrip_action, - CurrentUser => $CurrentUser, - ); + my $i = 0; + for my $action (@$actions) { - #if our preparation, move onto the next ticket - next unless ( $action_obj->Prepare ); - print loc("Action prepared...") if ($verbose); + # Given the current index of the actions array, see + # if there is still a corresponding element in the + # actions_arg array. If so, then use that argument, + # else use undef. + my $action_argument = ($i <= $#$actions_arg) ? $actions_arg->[$i] : undef; + $i++; - #commit our action. - next unless ( $action_obj->Commit ); - print loc("Action committed.\n") if ($verbose); -} + # prepare our action + my $action_obj = $action->new( + TicketObj => $ticket, + TransactionObj => $transaction, + TemplateObj => $template_obj, + Argument => $action_argument, + ScripObj => $void_scrip, + ScripActionObj => $void_scrip_action, + CurrentUser => $CurrentUser, + ); -=head2 get_transaction + # if our preparation failed, move onto the next action + next unless $action_obj->Prepare; + print "\t".loc("Action prepared...")."\n" if $verbose; -Takes ticket and returns its transaction acording to command -line arguments C<--transaction> and <--transaction-type>. + # commit our action. + next unless $action_obj->Commit; + print "\t".loc("Action committed.")."\n" if $verbose; + } +} -=cut +# =head2 get_transactions +# +# Takes ticket and returns L object with transactions +# of the ticket according to command line arguments C<--transaction> +# and <--transaction-type>. +# +# =cut -sub get_transaction { +sub get_transactions { my $ticket = shift; my $txns = $ticket->Transactions; + my $order = $transaction eq 'last'? 'DESC': 'ASC'; $txns->OrderByCols( - { FIELD => 'Created', ORDER => $transaction }, - { FIELD => 'id', ORDER => $transaction }, + { FIELD => 'Created', ORDER => $order }, + { FIELD => 'id', ORDER => $order }, ); - $txns->Limit( FIELD => 'Type', VALUE => $transaction_type ) - if $transaction_type; - $txns->RowsPerPage(1); - return $txns->First; + if ( $transaction_type ) { + $transaction_type =~ s/^\s+//; + $transaction_type =~ s/\s+$//; + foreach my $type ( split /\s*,\s*/, $transaction_type ) { + $txns->Limit( FIELD => 'Type', VALUE => $type, ENTRYAGGREGATOR => 'OR' ); + } + } + $txns->RowsPerPage(1) unless $transaction eq 'all'; + return $txns; } -# {{{ load_module - -=head2 load_module +# =head2 get_template +# +# Takes a ticket and returns a template according to command line options. +# +# =cut -Loads a perl module, dying nicely if it can't find it. +sub get_template { + my $ticket = shift; + return undef unless $template; + + unless ( $template =~ /\D/ ) { + # by id + my $template_obj = RT::Template->new( RT->SystemUser ); + $template_obj->Load( $template ); + die "Failed to load template '$template'" + unless $template_obj->id; + return $template_obj; + } -=cut + my $queue = $ticket->Queue; -sub load_module { - my $modname = shift; - eval "require $modname"; - if ($@) { - die loc( "Failed to load module [_1]. ([_2])", $modname, $@ ); + my $res = RT::Template->new( RT->SystemUser ); + $res->LoadQueueTemplate( Queue => $queue, Name => $template ); + unless ( $res->id ) { + $res->LoadGlobalTemplate( $template ); + die "Failed to load template '$template', either for queue #$queue or global" + unless $res->id; } - + return $res; } -# }}} - -# {{{ loc -=head2 loc LIST - -Localize this string, with the current user's currentuser object +# =head2 load_module +# +# Loads a perl module, dying nicely if it can't find it. +# +# =cut -=cut +sub load_module { + my $modname = shift; + unless ($modname->require) { + my $error = $@; + die loc( "Failed to load module [_1]. ([_2])", $modname, $error ); + } -sub loc { - $CurrentUser->loc(@_); } -# }}} sub help { @@ -232,35 +311,37 @@ sub help { . "\n"; print loc("It takes several arguments:") . "\n\n"; - print " " + 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" ) + print " " + . loc( "[_1] - An argument to pass to [_2]", "--search-arg", "--search" ) . "\n"; - print " " + 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" ) + print " " + . loc( "[_1] - An argument to pass to [_2]", "--condition-arg", "--condition" ) . "\n"; - print " " - . loc( "[_1] - Specify the action module you want to use", "--action" ) + print " " + . loc( "[_1] - Specify the action module you want to use. This option may be repeated to apply multiple actions to found tickets.", "--action" ) . "\n"; - print " " - . loc( "[_1] - An argument to pass to [_2]", "--action-argument", "--action" ) + print " " + . loc( "[_1] - An argument to pass to [_2]. This option may be repeated to pass corresponding arguments to multiple calls of [_2].", "--action-arg", "--action" ) . "\n"; - print " " - . loc( "[_1] - Specify id of the template you want to use", "--template-id" ) + print " " + . loc( "[_1] - Specify name or id of template(s) you want to use", "--template" ) . "\n"; - print " " - . loc( "[_1] - Specify if you want to use either 'first' or 'last' transaction", "--transaction" ) + print " " + . loc( "[_1] - Specify if you want to use either 'first', 'last' or 'all' transactions", "--transaction" ) . "\n"; - print " " - . loc( "[_1] - Specify the type of a transaction you want to use", "--transaction-type" ) + print " " + . loc( "[_1] - Specify the comma separated list of transactions' types you want to use", "--transaction-type" ) . "\n"; - print " " + print " " + . loc( "[_1] - Adjust LogToSTDERR config option", "--log" ) . "\n"; + print " " . loc( "[_1] - Output status updates to STDOUT", "--verbose" ) . "\n"; print "\n"; print "\n"; @@ -273,13 +354,13 @@ sub help { 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:" + . loc( "The following command will find all active tickets in the queue 'general' and set their priority to 99 if they are overdue:" ) . "\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 " --condition RT::Condition::Overdue \\\n"; print " --action RT::Action::SetPriority --action-arg 99 \\\n"; print " --verbose\n"; @@ -287,12 +368,94 @@ sub help { 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"; - - - - - + print" --action RT::Action::EscalatePriority\n"; exit(0); } + +__END__ + +=head1 NAME + +rt-crontool - a tool to act on tickets from an external scheduling tool + +=head1 SYNOPSIS + + # find all active tickets in the queue 'general' and set their priority to 99 if they are overdue: + rt-crontool \ + --search RT::Search::ActiveTicketsInQueue --search-arg general \ + --condition RT::Condition::Overdue \ + --action RT::Action::SetPriority --action-arg 99 \ + --verbose + + # Escalate tickets + rt-crontool \ + --search RT::Search::ActiveTicketsInQueue --search-arg general \ + --action RT::Action::EscalatePriority + +=head1 DESCRIPTION + +This script is a tool to act on tickets from an external scheduling tool, such +as cron. + +Security: + +This tool allows the user to run arbitrary perl modules from within RT. If +this tool were setgid, a hostile local user could use this tool to gain +administrative access to RT. It is incredibly important that nonprivileged +users not be allowed to run this tool. It is suggested that you create a +non-privileged unix user with the correct group membership and RT access to +run this tool. + + +=head1 OPTIONS + +=over + +=item search + +Specify the search module you want to use + +=item search-arg + +An argument to pass to --search + +=item condition + +Specify the condition module you want to use + +=item condition-arg + +An argument to pass to --condition + +=item action + +Specify the action module you want to use. This option may be repeated to apply multiple actions to found tickets. + +=item action-arg + +An argument to pass to --action. This option may be repeated to pass corresponding arguments to multiple calls of --action. + +=item template + +Specify name or id of template(s) you want to use + +=item transaction + +Specify if you want to use either 'first', 'last' or 'all' transactions + + +=item transaction-type + +Specify the comma separated list of transactions' types you want to use + +=item log + +Adjust LogToSTDERR config option + +=item verbose + +Output status updates to STDOUT + +=back +