2 # BEGIN BPS TAGGED BLOCK {{{
6 # This software is Copyright (c) 1996-2017 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 }}}
51 rt-shredder - Script which wipe out tickets from RT DB
55 rt-shredder --plugin list
56 rt-shredder --plugin help-Tickets
57 rt-shredder --plugin 'Tickets=query,Queue="general" and Status="deleted"'
59 rt-shredder --sqldump unshred.sql --plugin ...
60 rt-shredder --force --plugin ...
64 rt-shredder - is script that allow you to wipe out objects
65 from RT DB. This script uses API that L<RT::Shredder> module adds to RT.
66 Script can be used as example of usage of the shredder API.
70 You can use several options to control which objects script
75 =head2 --sqldump <filename>
77 Outputs INSERT queries into file. This dump can be used to restore data
80 By default creates files named F<< <ISO_date>-XXXX.sql >> in the current
83 =head2 --object (DEPRECATED)
85 Option has been deprecated, use plugin C<Objects> instead.
87 =head2 --plugin '<plugin name>[=<arg>,<val>[;<arg>,<val>]...]'
89 You can use plugins to select RT objects with various conditions.
90 See also --plugin list and --plugin help options.
94 Output list of the available plugins.
96 =head2 --plugin help-<plugin name>
98 Outputs help for specified plugin.
102 Script doesn't ask any questions.
111 use warnings FATAL => 'all';
113 # fix lib paths, some may be relative
114 BEGIN { # BEGIN RT CMD BOILERPLATE
117 my @libs = ("@RT_LIB_PATH@", "@LOCAL_LIB_PATH@");
120 for my $lib (@libs) {
121 unless ( File::Spec->file_name_is_absolute($lib) ) {
122 $bin_path ||= ( File::Spec->splitpath(Cwd::abs_path(__FILE__)) )[1];
123 $lib = File::Spec->catfile( $bin_path, File::Spec->updir, $lib );
132 require RT::Shredder;
134 use Getopt::Long qw(GetOptions);
137 use RT::Shredder::Plugin ();
138 # prefetch list of plugins
139 our %plugins = RT::Shredder::Plugin->List;
144 my $shredder = RT::Shredder->new;
147 my $plugin = eval { $shredder->AddDumpPlugin( Arguments => {
148 file_name => $opt{'sqldump'},
152 print STDERR "ERROR: Couldn't open SQL dump file: $@\n";
153 exit 1 if $opt{'sqldump'};
155 print STDERR "WARNING: It's strongly recommended to use '--sqldump <filename>' option\n";
156 unless( $opt{'force'} ) {
157 exit 0 unless prompt_yN( "Do you want to proceed?" );
160 print "SQL dump file is '". $plugin->FileName ."'\n";
164 my @objs = process_plugins( $shredder );
165 prompt_delete_objs( \@objs ) unless $opt{'force'};
167 $shredder->PutObjects( Objects => $_ ) foreach @objs;
168 eval { $shredder->WipeoutAll };
170 require RT::Shredder::Exceptions;
171 if( my $e = RT::Shredder::Exception::Info->caught ) {
172 print "\nERROR: $e\n\n";
178 sub prompt_delete_objs
182 print "Objects list is empty, try refine search options\n";
185 my $list = "Next ". scalar( @$objs ) ." objects would be deleted:\n";
186 foreach my $o( @$objs ) {
187 $list .= "\t". $o->UID ." object\n";
190 exit(0) unless prompt_yN( "Do you want to proceed?" );
196 print "$text [y/N] ";
197 unless( <STDIN> =~ /^(?:y|yes)$/i ) {
205 require RT::Shredder::POD;
206 RT::Shredder::POD::shredder_cli( $0, \*STDOUT );
213 Getopt::Long::Configure( "pass_through" );
215 if( GetOptions( 'object=s' => \@objs ) && @objs ) {
216 print STDERR "Option --object had been deprecated, use plugin 'Objects' instead\n";
221 if( GetOptions( 'plugin=s' => \@plugins ) && @plugins ) {
222 $opt{'plugin'} = \@plugins;
223 foreach my $str( @plugins ) {
224 if( $str =~ /^\s*list\s*$/ ) {
226 } elsif( $str =~ /^\s*help-(\w+)\s*$/ ) {
227 show_plugin_help( $1 );
228 } elsif( $str =~ /^(\w+)(=.*)?$/ && !$plugins{$1} ) {
229 print "Couldn't find plugin '$1'\n";
235 # other options make no sense without previouse
236 usage() unless keys %opt;
238 if( GetOptions( 'force' => \$tmp ) && $tmp ) {
242 if( GetOptions( 'sqldump=s' => \$tmp ) && $tmp ) {
243 $opt{'sqldump'} = $tmp;
250 my $shredder = shift;
253 foreach my $str( @{ $opt{'plugin'} } ) {
254 my $plugin = RT::Shredder::Plugin->new;
255 my( $status, $msg ) = $plugin->LoadByString( $str );
257 print STDERR "Couldn't load plugin\n";
258 print STDERR "Error: $msg\n";
261 if ( lc $plugin->Type eq 'search' ) {
262 push @res, _process_search_plugin( $shredder, $plugin );
264 elsif ( lc $plugin->Type eq 'dump' ) {
265 _process_dump_plugin( $shredder, $plugin );
268 return RT::Shredder->CastObjectsToRecords( Objects => \@res );
271 sub _process_search_plugin {
272 my ($shredder, $plugin) = @_;
273 my ($status, @objs) = $plugin->Run;
275 print STDERR "Couldn't run plugin\n";
276 print STDERR "Error: $objs[1]\n";
281 ($status, $msg) = $plugin->SetResolvers( Shredder => $shredder );
283 print STDERR "Couldn't set conflicts resolver\n";
284 print STDERR "Error: $msg\n";
290 sub _process_dump_plugin {
291 my ($shredder, $plugin) = @_;
292 $shredder->AddDumpPlugin(
299 print "Plugins list:\n";
300 print "\t$_\n" foreach( grep !/^Base$/, keys %plugins );
307 require RT::Shredder::POD;
308 unless( $plugins{ $name } ) {
309 print "Couldn't find plugin '$name'\n";
312 RT::Shredder::POD::plugin_cli( $plugins{'Base'}, \*STDOUT, 1 );
313 RT::Shredder::POD::plugin_cli( $plugins{ $name }, \*STDOUT );