/usr/bin/rt-crontool-4 is in request-tracker4 4.2.8-3+deb8u3.
This file is owned by root:root, with mode 0o755.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 | #!/usr/bin/perl
# BEGIN BPS TAGGED BLOCK {{{
#
# COPYRIGHT:
#
# This software is Copyright (c) 1996-2014 Best Practical Solutions, LLC
# <sales@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., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301 or visit their web page on the internet at
# 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
# 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 warnings;
use Carp;
# fix lib paths, some may be relative
BEGIN { # BEGIN RT CMD BOILERPLATE
require File::Spec;
require Cwd;
my @libs = ("/usr/share/request-tracker4/lib", "/usr/local/share/request-tracker4/lib");
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;
}
}
use RT;
use Getopt::Long;
use RT::Interface::CLI qw(CleanEnv GetCurrentUser GetMessageContent loc);
my ( $search, $condition, $action, $search_arg, $condition_arg, $action_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" => \$action_arg,
"action=s" => \$action,
"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();
# Clean out all the nasties from the environment
CleanEnv();
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";
exit(1);
}
help() unless $search && $action;
$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;
}
elsif ( $template_id ) {
# don't warn
$template = $template_id;
}
# We _must_ have a search object
load_module($search);
load_module($action) if ($action);
load_module($condition) if ($condition);
my $void_scrip = RT::Scrip->new( $CurrentUser );
my $void_scrip_action = RT::ScripAction->new( $CurrentUser );
#At the appointed time:
#find a bunch of tickets
my $tickets = RT::Tickets->new($CurrentUser);
$search = $search->new(
TicketsObj => $tickets,
Argument => $search_arg,
CurrentUser => $CurrentUser
);
$search->Prepare();
#for each ticket we've found
while ( my $ticket = $tickets->Next() ) {
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);
}
}
sub process {
my $ticket = shift;
my $transaction = shift;
my $template_obj = shift;
# perform some more advanced check
if ($condition) {
my $condition_obj = $condition->new(
TransactionObj => $transaction,
TicketObj => $ticket,
ScripObj => $void_scrip,
TemplateObj => $template_obj,
Argument => $condition_arg,
CurrentUser => $CurrentUser,
);
# if the condition doesn't apply, get out of here
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,
);
#if our preparation, move onto the next ticket
return unless $action_obj->Prepare;
print "\t".loc("Action prepared...")."\n" if $verbose;
#commit our action.
return unless $action_obj->Commit;
print "\t".loc("Action committed.")."\n" if $verbose;
}
# =head2 get_transactions
#
# Takes ticket and returns L<RT::Transactions> object with transactions
# of the ticket according to command line arguments C<--transaction>
# and <--transaction-type>.
#
# =cut
sub get_transactions {
my $ticket = shift;
my $txns = $ticket->Transactions;
my $order = $transaction eq 'last'? 'DESC': 'ASC';
$txns->OrderByCols(
{ FIELD => 'Created', ORDER => $order },
{ FIELD => 'id', ORDER => $order },
);
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;
}
# =head2 get_template
#
# Takes a ticket and returns a template according to command line options.
#
# =cut
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;
}
my $queue = $ticket->Queue;
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;
}
# =head2 load_module
#
# Loads a perl module, dying nicely if it can't find it.
#
# =cut
sub load_module {
my $modname = shift;
unless ($modname->require) {
my $error = $@;
die loc( "Failed to load module [_1]. ([_2])", $modname, $error );
}
}
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-arg", "--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-arg", "--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-arg", "--action" )
. "\n";
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', 'last' or 'all' transactions", "--transaction" )
. "\n";
print " "
. loc( "[_1] - Specify the comma separated list of transactions' types you want to use", "--transaction-type" )
. "\n";
print " "
. loc( "[_1] - Adjust LogToSTDERR config option", "--log" ) . "\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 are overdue:"
)
. "\n\n";
print " bin/rt-crontool \\\n";
print " --search RT::Search::ActiveTicketsInQueue --search-arg general \\\n";
print " --condition RT::Condition::Overdue \\\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);
}
__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
=item action-arg
An argument to pass to --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
|