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 }}}
52 rt-shredder - Script which wipe out tickets from RT DB
56 rt-shredder --plugin list
57 rt-shredder --plugin help-Tickets
58 rt-shredder --plugin 'Tickets=query,Queue="general" and Status="deleted"'
60 rt-shredder --sqldump unshred.sql --plugin ...
61 rt-shredder --force --plugin ...
65 rt-shredder - is script that allow you to wipe out objects
66 from RT DB. This script uses API that L<RT::Shredder> module adds to RT.
67 Script can be used as example of usage of the shredder API.
71 You can use several options to control which objects script
76 =head2 --sqldump <filename>
78 Outputs INSERT queries into file. This dump can be used to restore data
81 By default creates files named F<< <ISO_date>-XXXX.sql >> in the current
84 =head2 --object (DEPRECATED)
86 Option has been deprecated, use plugin C<Objects> instead.
88 =head2 --plugin '<plugin name>[=<arg>,<val>[;<arg>,<val>]...]'
90 You can use plugins to select RT objects with various conditions.
91 See also --plugin list and --plugin help options.
95 Output list of the available plugins.
97 =head2 --plugin help-<plugin name>
99 Outputs help for specified plugin.
103 Script doesn't ask any questions.
112 use warnings FATAL => 'all';
114 # fix lib paths, some may be relative
115 BEGIN { # BEGIN RT CMD BOILERPLATE
118 my @libs = ("@RT_LIB_PATH@", "@LOCAL_LIB_PATH@");
121 for my $lib (@libs) {
122 unless ( File::Spec->file_name_is_absolute($lib) ) {
123 $bin_path ||= ( File::Spec->splitpath(Cwd::abs_path(__FILE__)) )[1];
124 $lib = File::Spec->catfile( $bin_path, File::Spec->updir, $lib );
133 require RT::Shredder;
135 use Getopt::Long qw(GetOptions);
138 use RT::Shredder::Plugin ();
139 # prefetch list of plugins
140 our %plugins = RT::Shredder::Plugin->List;
145 my $shredder = RT::Shredder->new;
148 my $plugin = eval { $shredder->AddDumpPlugin( Arguments => {
149 file_name => $opt{'sqldump'},
153 print STDERR "ERROR: Couldn't open SQL dump file: $@\n";
154 exit 1 if $opt{'sqldump'};
156 print STDERR "WARNING: It's strongly recommended to use '--sqldump <filename>' option\n";
157 unless( $opt{'force'} ) {
158 exit 0 unless prompt_yN( "Do you want to proceed?" );
161 print "SQL dump file is '". $plugin->FileName ."'\n";
165 my @objs = process_plugins( $shredder );
166 prompt_delete_objs( \@objs ) unless $opt{'force'};
168 $shredder->PutObjects( Objects => $_ ) foreach @objs;
169 eval { $shredder->WipeoutAll };
171 require RT::Shredder::Exceptions;
172 if( my $e = RT::Shredder::Exception::Info->caught ) {
173 print "\nERROR: $e\n\n";
179 sub prompt_delete_objs
183 print "Objects list is empty, try refine search options\n";
186 my $list = "Next ". scalar( @$objs ) ." objects would be deleted:\n";
187 foreach my $o( @$objs ) {
188 $list .= "\t". $o->UID ." object\n";
191 exit(0) unless prompt_yN( "Do you want to proceed?" );
197 print "$text [y/N] ";
198 unless( <STDIN> =~ /^(?:y|yes)$/i ) {
206 require RT::Shredder::POD;
207 RT::Shredder::POD::shredder_cli( $0, \*STDOUT );
214 Getopt::Long::Configure( "pass_through" );
216 if( GetOptions( 'object=s' => \@objs ) && @objs ) {
217 print STDERR "Option --object had been deprecated, use plugin 'Objects' instead\n";
222 if( GetOptions( 'plugin=s' => \@plugins ) && @plugins ) {
223 $opt{'plugin'} = \@plugins;
224 foreach my $str( @plugins ) {
225 if( $str =~ /^\s*list\s*$/ ) {
227 } elsif( $str =~ /^\s*help-(\w+)\s*$/ ) {
228 show_plugin_help( $1 );
229 } elsif( $str =~ /^(\w+)(=.*)?$/ && !$plugins{$1} ) {
230 print "Couldn't find plugin '$1'\n";
236 # other options make no sense without previouse
237 usage() unless keys %opt;
239 if( GetOptions( 'force' => \$tmp ) && $tmp ) {
243 if( GetOptions( 'sqldump=s' => \$tmp ) && $tmp ) {
244 $opt{'sqldump'} = $tmp;
251 my $shredder = shift;
254 foreach my $str( @{ $opt{'plugin'} } ) {
255 my $plugin = RT::Shredder::Plugin->new;
256 my( $status, $msg ) = $plugin->LoadByString( $str );
258 print STDERR "Couldn't load plugin\n";
259 print STDERR "Error: $msg\n";
262 if ( lc $plugin->Type eq 'search' ) {
263 push @res, _process_search_plugin( $shredder, $plugin );
265 elsif ( lc $plugin->Type eq 'dump' ) {
266 _process_dump_plugin( $shredder, $plugin );
269 return RT::Shredder->CastObjectsToRecords( Objects => \@res );
272 sub _process_search_plugin {
273 my ($shredder, $plugin) = @_;
274 my ($status, @objs) = $plugin->Run;
276 print STDERR "Couldn't run plugin\n";
277 print STDERR "Error: $objs[1]\n";
282 ($status, $msg) = $plugin->SetResolvers( Shredder => $shredder );
284 print STDERR "Couldn't set conflicts resolver\n";
285 print STDERR "Error: $msg\n";
291 sub _process_dump_plugin {
292 my ($shredder, $plugin) = @_;
293 $shredder->AddDumpPlugin(
300 print "Plugins list:\n";
301 print "\t$_\n" foreach( grep !/^Base$/, keys %plugins );
308 require RT::Shredder::POD;
309 unless( $plugins{ $name } ) {
310 print "Couldn't find plugin '$name'\n";
313 RT::Shredder::POD::plugin_cli( $plugins{'Base'}, \*STDOUT, 1 );
314 RT::Shredder::POD::plugin_cli( $plugins{ $name }, \*STDOUT );