2 # BEGIN BPS TAGGED BLOCK {{{
6 # This software is Copyright (c) 1996-2015 Best Practical Solutions, LLC
7 # <sales@bestpractical.com>
9 # (Except where explicitly superseded by other copyright notices)
14 # This work is made available to you under the terms of Version 2 of
15 # the GNU General Public License. A copy of that license should have
16 # been provided with this software, but in any event can be snarfed
19 # This work is distributed in the hope that it will be useful, but
20 # WITHOUT ANY WARRANTY; without even the implied warranty of
21 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 # General Public License for more details.
24 # You should have received a copy of the GNU General Public License
25 # along with this program; if not, write to the Free Software
26 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
27 # 02110-1301 or visit their web page on the internet at
28 # http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
31 # CONTRIBUTION SUBMISSION POLICY:
33 # (The following paragraph is not intended to limit the rights granted
34 # to you to modify and distribute this software under the terms of
35 # the GNU General Public License and is only of importance to you if
36 # you choose to contribute your changes and enhancements to the
37 # community by submitting them to Best Practical Solutions, LLC.)
39 # By intentionally submitting any modifications, corrections or
40 # derivatives to this work, or any other work intended for use with
41 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
42 # you are the copyright holder for those contributions and you grant
43 # Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
44 # royalty-free, perpetual, license to use, copy, create derivative
45 # works based on those contributions, and sublicense and distribute
46 # those contributions and any derivatives thereof.
48 # END BPS TAGGED BLOCK }}}
53 # fix lib paths, some may be relative
54 BEGIN { # BEGIN RT CMD BOILERPLATE
57 my @libs = ("@RT_LIB_PATH@", "@LOCAL_LIB_PATH@");
61 unless ( File::Spec->file_name_is_absolute($lib) ) {
62 $bin_path ||= ( File::Spec->splitpath(Cwd::abs_path(__FILE__)) )[1];
63 $lib = File::Spec->catfile( $bin_path, File::Spec->updir, $lib );
74 use RT::Interface::CLI qw(GetCurrentUser loc);
76 my ( $search, $condition, $action, $search_arg, $condition_arg, $action_arg,
77 $template, $template_id, $transaction, $transaction_type, $help, $log, $verbose );
79 "search=s" => \$search,
80 "search-arg=s" => \$search_arg,
81 "condition=s" => \$condition,
82 "condition-arg=s" => \$condition_arg,
83 "action-arg=s" => \$action_arg,
84 "action=s" => \$action,
85 "template=s" => \$template,
86 "template-id=s" => \$template_id,
87 "transaction=s" => \$transaction,
88 "transaction-type=s" => \$transaction_type,
90 "verbose|v" => \$verbose,
94 # Load the config file
97 # adjust logging to the screen according to options
98 RT->Config->Set( LogToSTDERR => $log ) if $log;
100 #Connect to the database and get RT::SystemUser and RT::Nobody loaded
104 require RT::Template;
106 #Get the current user all loaded
107 my $CurrentUser = GetCurrentUser();
109 # show help even if there is no current user
112 unless ( $CurrentUser->Id ) {
113 print loc("No RT user found. Please consult your RT administrator.") . "\n";
117 help() unless $search && $action;
119 $transaction = lc( $transaction||'' );
120 if ( $transaction && $transaction !~ /^(first|all|last)$/i ) {
121 print STDERR loc("--transaction argument could be only 'first', 'last' or 'all'");
125 if ( $template && $template_id ) {
126 print STDERR loc("--template-id is deprecated argument and can not be used with --template");
129 elsif ( $template_id ) {
131 $template = $template_id;
134 # We _must_ have a search object
135 load_module($search);
136 load_module($action) if ($action);
137 load_module($condition) if ($condition);
139 my $void_scrip = RT::Scrip->new( $CurrentUser );
140 my $void_scrip_action = RT::ScripAction->new( $CurrentUser );
142 #At the appointed time:
144 #find a bunch of tickets
145 my $tickets = RT::Tickets->new($CurrentUser);
146 $search = $search->new(
147 TicketsObj => $tickets,
148 Argument => $search_arg,
149 CurrentUser => $CurrentUser
153 #for each ticket we've found
154 while ( my $ticket = $tickets->Next() ) {
155 print $ticket->Id() . ":\n" if ($verbose);
157 my $template_obj = get_template( $ticket );
159 if ( $transaction ) {
160 my $txns = get_transactions($ticket);
162 while ( my $txn = $txns->Next ) {
163 print "\t".loc("Using transaction #[_1]...", $txn->id)."\n"
165 process($ticket, $txn, $template_obj);
168 print "\t".loc("Couldn't find suitable transaction, skipping")."\n"
169 if $verbose && !$found;
171 print "\t".loc("Processing without transaction, some conditions and actions may fail. Consider using --transaction argument")."\n"
174 process($ticket, undef, $template_obj);
180 my $transaction = shift;
181 my $template_obj = shift;
183 # perform some more advanced check
185 my $condition_obj = $condition->new(
186 TransactionObj => $transaction,
187 TicketObj => $ticket,
188 ScripObj => $void_scrip,
189 TemplateObj => $template_obj,
190 Argument => $condition_arg,
191 CurrentUser => $CurrentUser,
194 # if the condition doesn't apply, get out of here
196 return unless $condition_obj->IsApplicable;
197 print "\t".loc("Condition matches...")."\n" if $verbose;
201 my $action_obj = $action->new(
202 TicketObj => $ticket,
203 TransactionObj => $transaction,
204 TemplateObj => $template_obj,
205 Argument => $action_arg,
206 ScripObj => $void_scrip,
207 ScripActionObj => $void_scrip_action,
208 CurrentUser => $CurrentUser,
211 #if our preparation, move onto the next ticket
212 return unless $action_obj->Prepare;
213 print "\t".loc("Action prepared...")."\n" if $verbose;
216 return unless $action_obj->Commit;
217 print "\t".loc("Action committed.")."\n" if $verbose;
220 # =head2 get_transactions
222 # Takes ticket and returns L<RT::Transactions> object with transactions
223 # of the ticket according to command line arguments C<--transaction>
224 # and <--transaction-type>.
228 sub get_transactions {
230 my $txns = $ticket->Transactions;
231 my $order = $transaction eq 'last'? 'DESC': 'ASC';
233 { FIELD => 'Created', ORDER => $order },
234 { FIELD => 'id', ORDER => $order },
236 if ( $transaction_type ) {
237 $transaction_type =~ s/^\s+//;
238 $transaction_type =~ s/\s+$//;
239 foreach my $type ( split /\s*,\s*/, $transaction_type ) {
240 $txns->Limit( FIELD => 'Type', VALUE => $type, ENTRYAGGREGATOR => 'OR' );
243 $txns->RowsPerPage(1) unless $transaction eq 'all';
247 # =head2 get_template
249 # Takes a ticket and returns a template according to command line options.
255 return undef unless $template;
257 unless ( $template =~ /\D/ ) {
259 my $template_obj = RT::Template->new( RT->SystemUser );
260 $template_obj->Load( $template );
261 die "Failed to load template '$template'"
262 unless $template_obj->id;
263 return $template_obj;
266 my $queue = $ticket->Queue;
268 my $res = RT::Template->new( RT->SystemUser );
269 $res->LoadQueueTemplate( Queue => $queue, Name => $template );
270 unless ( $res->id ) {
271 $res->LoadGlobalTemplate( $template );
272 die "Failed to load template '$template', either for queue #$queue or global"
281 # Loads a perl module, dying nicely if it can't find it.
287 unless ($modname->require) {
289 die loc( "Failed to load module [_1]. ([_2])", $modname, $error );
297 print loc( "[_1] is a tool to act on tickets from an external scheduling tool, such as cron.", $0 )
299 print loc("It takes several arguments:") . "\n\n";
302 . loc( "[_1] - Specify the search module you want to use", "--search" )
305 . loc( "[_1] - An argument to pass to [_2]", "--search-arg", "--search" )
309 . loc( "[_1] - Specify the condition module you want to use", "--condition" )
312 . loc( "[_1] - An argument to pass to [_2]", "--condition-arg", "--condition" )
315 . loc( "[_1] - Specify the action module you want to use", "--action" )
318 . loc( "[_1] - An argument to pass to [_2]", "--action-arg", "--action" )
321 . loc( "[_1] - Specify name or id of template(s) you want to use", "--template" )
324 . loc( "[_1] - Specify if you want to use either 'first', 'last' or 'all' transactions", "--transaction" )
327 . loc( "[_1] - Specify the comma separated list of transactions' types you want to use", "--transaction-type" )
330 . loc( "[_1] - Adjust LogToSTDERR config option", "--log" ) . "\n";
332 . loc( "[_1] - Output status updates to STDOUT", "--verbose" ) . "\n";
335 print loc("Security:")."\n";
336 print loc("This tool allows the user to run arbitrary perl modules from within RT.")." ".
337 loc("If this tool were setgid, a hostile local user could use this tool to gain administrative access to RT.")." ".
338 loc("It is incredibly important that nonprivileged users not be allowed to run this tool."). " " .
339 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";
341 print loc("Example:");
344 . loc( "The following command will find all active tickets in the queue 'general' and set their priority to 99 if they are overdue:"
348 print " bin/rt-crontool \\\n";
349 print " --search RT::Search::ActiveTicketsInQueue --search-arg general \\\n";
350 print " --condition RT::Condition::Overdue \\\n";
351 print " --action RT::Action::SetPriority --action-arg 99 \\\n";
352 print " --verbose\n";
355 print loc("Escalate tickets"). "\n";
356 print " bin/rt-crontool \\\n";
357 print " --search RT::Search::ActiveTicketsInQueue --search-arg general \\\n";
358 print" --action RT::Action::EscalatePriority\n";
372 rt-crontool - a tool to act on tickets from an external scheduling tool
376 # find all active tickets in the queue 'general' and set their priority to 99 if they are overdue:
378 --search RT::Search::ActiveTicketsInQueue --search-arg general \
379 --condition RT::Condition::Overdue \
380 --action RT::Action::SetPriority --action-arg 99 \
385 --search RT::Search::ActiveTicketsInQueue --search-arg general \
386 --action RT::Action::EscalatePriority
390 This script is a tool to act on tickets from an external scheduling tool, such
395 This tool allows the user to run arbitrary perl modules from within RT. If
396 this tool were setgid, a hostile local user could use this tool to gain
397 administrative access to RT. It is incredibly important that nonprivileged
398 users not be allowed to run this tool. It is suggested that you create a
399 non-privileged unix user with the correct group membership and RT access to
409 Specify the search module you want to use
413 An argument to pass to --search
417 Specify the condition module you want to use
421 An argument to pass to --condition
425 Specify the action module you want to use
429 An argument to pass to --action
433 Specify name or id of template(s) you want to use
437 Specify if you want to use either 'first', 'last' or 'all' transactions
440 =item transaction-type
442 Specify the comma separated list of transactions' types you want to use
446 Adjust LogToSTDERR config option
450 Output status updates to STDOUT