rt-crontool.in 10.6 KB
Newer Older
1
#!@PERL@
2
# BEGIN BPS TAGGED BLOCK {{{
3
# 
4
# COPYRIGHT:
Jesse Vincent's avatar
Jesse Vincent committed
5
6
# 
# This software is Copyright (c) 1996-2008 Best Practical Solutions, LLC
7
#                                          <jesse@bestpractical.com>
8
# 
9
10
11
12
# (Except where explicitly superseded by other copyright notices)
# 
# 
# LICENSE:
13
14
15
16
# 
# 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
17
# from www.gnu.org.
18
19
20
21
22
23
# 
# 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.
# 
24
25
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
Jesse Vincent's avatar
Jesse Vincent committed
26
27
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301 or visit their web page on the internet at
Ruslan Zakirov's avatar
Ruslan Zakirov committed
28
# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
29
30
31
32
33
34
35
36
37
# 
# 
# 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.)
38
# 
39
40
41
42
43
44
45
46
# 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.
47
# 
48
# END BPS TAGGED BLOCK }}}
49
50
51
use strict;
use Carp;

52
53
54
55
# fix lib paths, some may be relative
BEGIN {
    require File::Spec;
    my @libs = ("@RT_LIB_PATH@", "@LOCAL_LIB_PATH@");
Jesse Vincent's avatar
Jesse Vincent committed
56
57
    my $bin_path;

58
59
    for my $lib (@libs) {
        unless ( File::Spec->file_name_is_absolute($lib) ) {
Jesse Vincent's avatar
Jesse Vincent committed
60
61
62
63
64
65
66
67
68
69
70
            unless ($bin_path) {
                if ( File::Spec->file_name_is_absolute(__FILE__) ) {
                    $bin_path = ( File::Spec->splitpath(__FILE__) )[1];
                }
                else {
                    require FindBin;
                    no warnings "once";
                    $bin_path = $FindBin::Bin;
                }
            }
            $lib = File::Spec->catfile( $bin_path, File::Spec->updir, $lib );
71
72
73
74
75
        }
        unshift @INC, $lib;
    }

}
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

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,
Ruslan Zakirov's avatar
Ruslan Zakirov committed
103
104
105
106
107
108
109
110
111
112
113
114
     $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 );
115

116
help() if $help or not $search or not $action;
117

118
119
120
$transaction = lc( $transaction||'' );
if ( $transaction && $transaction !~ /^(first|all|last)$/i ) {
    print STDERR loc("--transaction argument could be only 'first', 'last' or 'all'");
Ruslan Zakirov's avatar
Ruslan Zakirov committed
121
122
123
    exit 1;
}

124
125
126
127
128
129
130
131
# 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) {
132
133
    $template_obj = RT::Template->new($CurrentUser);
    $template_obj->Load($template_id);
134
}
Ruslan Zakirov's avatar
Ruslan Zakirov committed
135
136
my $void_scrip = RT::Scrip->new( $CurrentUser );
my $void_scrip_action = RT::ScripAction->new( $CurrentUser );
137
138
139
140
141

#At the appointed time:

#find a bunch of tickets
my $tickets = RT::Tickets->new($CurrentUser);
Jesse Vincent's avatar
Jesse Vincent committed
142
143
144
145
146
my $search  = $search->new(
    TicketsObj  => $tickets,
    Argument    => $search_arg,
    CurrentUser => $CurrentUser
);
147
148
149
150
151
152
153
154

$search->Prepare();

# TicketsFound is an RT::Tickets object
my $tickets = $search->TicketsObj;

#for each ticket we've found
while ( my $ticket = $tickets->Next() ) {
155
    print $ticket->Id() . ": " if ($verbose);
156

157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
    if ( $transaction ) {
        my $txns = get_transactions($ticket);
        my $found = 0;
        while ( my $txn = $txns->Next ) {
            print loc("Using transaction #[_1]...", $txn->id)
                if $verbose;
            process($ticket, $txn);
            $found = 1;
        }
        print loc("Couldn't find suitable transaction, skipping")
            if $verbose && !$found;
    } else {
        print loc("Processing without transaction, some conditions and actions may fail. Consider using --transaction argument")
            if $verbose;

        process($ticket);
    }
}

sub process {
    my $ticket = shift;
    my $transaction = shift;
Ruslan Zakirov's avatar
Ruslan Zakirov committed
179

180
181
    # perform some more advanced check
    if ($condition) {
Ruslan Zakirov's avatar
Ruslan Zakirov committed
182
183
184
185
186
187
188
189
        my $condition_obj = $condition->new(
            TransactionObj => $transaction,
            TicketObj      => $ticket,
            ScripObj       => $void_scrip,
            TemplateObj    => $template_obj,
            Argument       => $condition_arg,
            CurrentUser    => $CurrentUser,
        );
190
191
192

        # if the condition doesn't apply, get out of here

193
194
        return unless $condition_obj->IsApplicable;
        print loc("Condition matches...") if $verbose;
195
196
197
    }

    #prepare our action
Jesse Vincent's avatar
Jesse Vincent committed
198
    my $action_obj = $action->new(
Ruslan Zakirov's avatar
Ruslan Zakirov committed
199
200
201
202
203
204
205
        TicketObj      => $ticket,
        TransactionObj => $transaction,
        TemplateObj    => $template_obj,
        Argument       => $action_arg,
        ScripObj       => $void_scrip,
        ScripActionObj => $void_scrip_action,
        CurrentUser    => $CurrentUser,
Jesse Vincent's avatar
Jesse Vincent committed
206
    );
207
208

    #if our preparation, move onto the next ticket
209
210
    return unless $action_obj->Prepare;
    print loc("Action prepared...") if $verbose;
211
212

    #commit our action.
213
214
    return unless $action_obj->Commit;
    print loc("Action committed.\n") if $verbose;
215
216
}

217
=head2 get_transactions
Ruslan Zakirov's avatar
Ruslan Zakirov committed
218

219
220
221
Takes ticket and returns L<RT::Transactions> object with transactions
of the ticket according to command line arguments C<--transaction>
and <--transaction-type>.
Ruslan Zakirov's avatar
Ruslan Zakirov committed
222
223
224

=cut

225
sub get_transactions {
Ruslan Zakirov's avatar
Ruslan Zakirov committed
226
227
    my $ticket = shift;
    my $txns = $ticket->Transactions;
228
    my $order = $transaction eq 'last'? 'DESC': 'ASC';
Ruslan Zakirov's avatar
Ruslan Zakirov committed
229
    $txns->OrderByCols(
230
231
        { FIELD => 'Created', ORDER => $order },
        { FIELD => 'id', ORDER => $order },
Ruslan Zakirov's avatar
Ruslan Zakirov committed
232
    );
233
234
235
236
237
238
239
240
241
    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;
Ruslan Zakirov's avatar
Ruslan Zakirov committed
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
# {{{ 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 "	"
287
      . loc( "[_1] - An argument to pass to [_2]", "--search-arg", "--search" )
288
289
290
291
292
293
      . "\n";

    print "	"
      . loc( "[_1] - Specify the condition module you want to use", "--condition" )
      . "\n";
    print "	"
294
      . loc( "[_1] - An argument to pass to [_2]", "--condition-arg", "--condition" )
295
296
297
298
299
      . "\n";
    print "	"
      . loc( "[_1] - Specify the action module you want to use", "--action" )
      . "\n";
    print "	"
300
      . loc( "[_1] - An argument to pass to [_2]", "--action-arg", "--action" )
301
      . "\n";
Ruslan Zakirov's avatar
Ruslan Zakirov committed
302
303
304
305
    print "	"
      . loc( "[_1] - Specify id of the template you want to use", "--template-id" )
      . "\n";
    print "	"
306
      . loc( "[_1] - Specify if you want to use either 'first', 'last' or 'all' transactions", "--transaction" )
Ruslan Zakirov's avatar
Ruslan Zakirov committed
307
308
      . "\n";
    print "	"
309
      . loc( "[_1] - Specify the comma separated list of transactions' types you want to use", "--transaction-type" )
Ruslan Zakirov's avatar
Ruslan Zakirov committed
310
      . "\n";
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
    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";

Alex Vandiver's avatar
Alex Vandiver committed
328
329
330
    print " bin/rt-crontool \\\n";
    print "  --search RT::Search::ActiveTicketsInQueue  --search-arg general \\\n";
    print "  --condition RT::Condition::UntouchedInHours --condition-arg 4 \\\n";
331
332
333
    print "  --action RT::Action::SetPriority --action-arg 99 \\\n";
    print "  --verbose\n";

Jesse Vincent's avatar
Jesse Vincent committed
334
    print "\n";
Alex Vandiver's avatar
Alex Vandiver committed
335
336
337
338
    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";
Jesse Vincent's avatar
Jesse Vincent committed
339
340
341
342
343
 
 
 


344
345
346

    exit(0);
}