rt-crontool.in 7.36 KB
Newer Older
1
#!@PERL@
2
# BEGIN BPS TAGGED BLOCK {{{
3
# 
4
5
# COPYRIGHT:
#  
6
# This software is Copyright (c) 1996-2007 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
Ruslan Zakirov's avatar
Ruslan Zakirov committed
26
27
28
# 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.
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
use lib ("@LOCAL_LIB_PATH@", "@RT_LIB_PATH@");
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

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 );

91
help() if $help or not $search or not $action;
92
93
94
95
96
97
98
99
100

# 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) {
101
102
    $template_obj = RT::Template->new($CurrentUser);
    $template_obj->Load($template_id);
103
104
105
106
107
108
}

#At the appointed time:

#find a bunch of tickets
my $tickets = RT::Tickets->new($CurrentUser);
Jesse Vincent's avatar
Jesse Vincent committed
109
110
111
112
113
my $search  = $search->new(
    TicketsObj  => $tickets,
    Argument    => $search_arg,
    CurrentUser => $CurrentUser
);
114
115
116
117
118
119
120
121

$search->Prepare();

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

#for each ticket we've found
while ( my $ticket = $tickets->Next() ) {
122
    print $ticket->Id() . ": " if ($verbose);
123
124
125
126

    # perform some more advanced check
    if ($condition) {
        my $condition_obj = $condition->new( TicketObj => $ticket,
Jesse Vincent's avatar
Jesse Vincent committed
127
128
                                             Argument  => $condition_arg,
                                             CurrentUser => $CurrentUser );
129
130
131
132
133
134
135
136

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

        next unless ( $condition_obj->IsApplicable );
        print loc("Condition matches...") if ($verbose);
    }

    #prepare our action
Jesse Vincent's avatar
Jesse Vincent committed
137
138
139
140
141
142
    my $action_obj = $action->new(
        TicketObj   => $ticket,
        TemplateObj => $template_obj,
        Argument    => $action_arg,
        CurrentUser => $CurrentUser
    );
143
144
145
146
147
148
149

    #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 );
150
    print loc("Action committed.\n") if ($verbose);
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
}

# {{{ 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";

Alex Vandiver's avatar
Alex Vandiver committed
228
229
230
    print " bin/rt-crontool \\\n";
    print "  --search RT::Search::ActiveTicketsInQueue  --search-arg general \\\n";
    print "  --condition RT::Condition::UntouchedInHours --condition-arg 4 \\\n";
231
232
233
    print "  --action RT::Action::SetPriority --action-arg 99 \\\n";
    print "  --verbose\n";

Jesse Vincent's avatar
Jesse Vincent committed
234
    print "\n";
Alex Vandiver's avatar
Alex Vandiver committed
235
236
237
238
    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
239
240
241
242
243
 
 
 


244
245
246

    exit(0);
}