1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2013 Best Practical Solutions, LLC
6 # <sales@bestpractical.com>
8 # (Except where explicitly superseded by other copyright notices)
13 # This work is made available to you under the terms of Version 2 of
14 # the GNU General Public License. A copy of that license should have
15 # been provided with this software, but in any event can be snarfed
18 # This work is distributed in the hope that it will be useful, but
19 # WITHOUT ANY WARRANTY; without even the implied warranty of
20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 # General Public License for more details.
23 # You should have received a copy of the GNU General Public License
24 # along with this program; if not, write to the Free Software
25 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
26 # 02110-1301 or visit their web page on the internet at
27 # http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
30 # CONTRIBUTION SUBMISSION POLICY:
32 # (The following paragraph is not intended to limit the rights granted
33 # to you to modify and distribute this software under the terms of
34 # the GNU General Public License and is only of importance to you if
35 # you choose to contribute your changes and enhancements to the
36 # community by submitting them to Best Practical Solutions, LLC.)
38 # By intentionally submitting any modifications, corrections or
39 # derivatives to this work, or any other work intended for use with
40 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
41 # you are the copyright holder for those contributions and you grant
42 # Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
43 # royalty-free, perpetual, license to use, copy, create derivative
44 # works based on those contributions, and sublicense and distribute
45 # those contributions and any derivatives thereof.
47 # END BPS TAGGED BLOCK }}}
58 RT::Shredder - Permanently wipeout data from RT
65 rt-shredder --force --plugin 'Tickets=query,Queue="General" and Status="deleted"'
69 RT::Shredder is extension to RT which allows you to permanently wipeout
70 data from the RT database. Shredder supports the wiping of almost
71 all RT objects (Tickets, Transactions, Attachments, Users...).
74 =head2 "Delete" vs "Wipeout"
76 RT uses the term "delete" to mean "deactivate". To avoid confusion,
77 RT::Shredder uses the term "Wipeout" to mean "permanently erase" (or
78 what most people would think of as "delete").
81 =head2 Why do you want this?
83 Normally in RT, "deleting" an item simply deactivates it and makes it
84 invisible from view. This is done to retain full history and
85 auditability of your tickets. For most RT users this is fine and they
86 have no need of RT::Shredder.
88 But in some large and heavily used RT instances the database can get
89 clogged up with junk, particularly spam. This can slow down searches
90 and bloat the size of the database. For these users, RT::Shredder
91 allows them to completely clear the database of this unwanted junk.
93 An additional use of Shredder is to obliterate sensitive information
94 (passwords, credit card numbers, ...) which might have made their way
98 =head2 Command line tools (CLI)
100 L<rt-shredder> is a program which allows you to wipe objects from
101 command line or with system tasks scheduler (cron, for example).
102 See also 'rt-shredder --help'.
105 =head2 Web based interface (WebUI)
107 Shredder's WebUI integrates into RT's WebUI. You can find it in the
108 Configuration->Tools->Shredder tab. The interface is similar to the
109 CLI and gives you the same functionality. You can find 'Shredder' link
110 at the bottom of tickets search results, so you could wipeout tickets
111 in the way similar to the bulk update.
114 =head1 DATA STORAGE AND BACKUPS
116 Shredder allows you to store data you wiped in files as scripts with SQL
119 =head3 Restoring from backup
121 Should you wipeout something you did not intend to the objects can be
122 restored by using the storage files. These files are a simple set of
123 SQL commands to re-insert your objects into the RT database.
125 1) Locate the appropriate shredder SQL dump file. In the WebUI, when
126 you use shredder, the path to the dump file is displayed. It also
127 gives the option to download the dump file after each wipeout. Or
128 it can be found in your C<$ShredderStoragePath>.
130 2) Load the shredder SQL dump into your RT database. The details will
131 be different for each database and RT configuration, consult your
132 database manual and RT config. For example, in MySQL...
134 mysql -u your_rt_user -p your_rt_database < /path/to/rt/var/data/shredder/dump.sql
136 That's it.i This will restore everything you'd deleted during a
137 shredding session when the file had been created.
141 =head2 $DependenciesLimit
143 Shredder stops with an error if the object has more than
144 C<$DependenciesLimit> dependencies. For example: a ticket has 1000
145 transactions or a transaction has 1000 attachments. This is protection
146 from bugs in shredder from wiping out your whole database, but
147 sometimes when you have big mail loops you may hit it.
149 Defaults to 1000. To change this (for example, to 10000) add the
150 following to your F<RT_SiteConfig.pm>:
152 Set( $DependenciesLimit, 10_000 );>
155 =head2 $ShredderStoragePath
157 Directory containing Shredder backup dumps; defaults to
158 F</opt/rt4/var/data/RT-Shredder> (assuming an /opt/rt4 installation).
160 To change this (for example, to /some/backup/path) add the following to
161 your F<RT_SiteConfig.pm>:
163 Set( $ShredderStoragePath, "/some/backup/path" );>
165 Be sure to specify an absolute path.
168 =head1 INFORMATION FOR DEVELOPERS
172 L<RT::Shredder> is an extension to RT which adds shredder methods to
173 RT objects and classes. The API is not well documented yet, but you
174 can find usage examples in L<rt-shredder> and the
175 F<lib/t/regression/shredder/*.t> test files.
177 However, here is a small example that do the same action as in CLI
178 example from L</SYNOPSIS>:
181 RT::Shredder::Init( force => 1 );
182 my $deleted = RT::Tickets->new( RT->SystemUser );
183 $deleted->{'allow_deleted_search'} = 1;
184 $deleted->LimitQueue( VALUE => 'general' );
185 $deleted->LimitStatus( VALUE => 'deleted' );
186 while( my $t = $deleted->Next ) {
191 =head2 RT::Shredder class' API
193 L<RT::Shredder> implements interfaces to objects cache, actions on the
194 objects in the cache and backups storage.
198 our $VERSION = '0.04';
203 # I can't use 'use lib' here since it breakes tests
204 # because test suite uses old RT::Shredder setup from
207 ### after: push @INC, qw(@RT_LIB_PATH@);
208 use RT::Shredder::Constants;
209 use RT::Shredder::Exceptions;
213 require RT::Shredder::Record;
215 require RT::Shredder::ACE;
216 require RT::Shredder::Attachment;
217 require RT::Shredder::CachedGroupMember;
218 require RT::Shredder::CustomField;
219 require RT::Shredder::CustomFieldValue;
220 require RT::Shredder::GroupMember;
221 require RT::Shredder::Group;
222 require RT::Shredder::Link;
223 require RT::Shredder::Principal;
224 require RT::Shredder::Queue;
225 require RT::Shredder::Scrip;
226 require RT::Shredder::ScripAction;
227 require RT::Shredder::ScripCondition;
228 require RT::Shredder::Template;
229 require RT::Shredder::ObjectCustomFieldValue;
230 require RT::Shredder::Ticket;
231 require RT::Shredder::Transaction;
232 require RT::Shredder::User;
235 our @SUPPORTED_OBJECTS = qw(
250 ObjectCustomFieldValue
260 RT::Shredder::Init( %default_options );
262 C<RT::Shredder::Init()> should be called before creating an
263 RT::Shredder object. It iniitalizes RT and loads the RT
266 %default_options are passed to every C<<RT::Shredder->new>> call.
281 my $shredder = RT::Shredder->new(%options);
283 Construct a new RT::Shredder object.
285 There currently are no %options.
292 my $self = bless( {}, ref $proto || $proto );
300 $self->{'opt'} = { %opt, @_ };
301 $self->{'cache'} = {};
302 $self->{'resolver'} = {};
303 $self->{'dump_plugins'} = [];
306 =head4 CastObjectsToRecords( Objects => undef )
308 Cast objects to the C<RT::Record> objects or its ancesstors.
309 Objects can be passed as SCALAR (format C<< <class>-<id> >>),
310 ARRAY, C<RT::Record> ancesstors or C<RT::SearchBuilder> ancesstor.
312 Most methods that takes C<Objects> argument use this method to
313 cast argument value to list of records.
315 Returns an array of records.
319 my @objs = $shredder->CastObjectsToRecords(
320 Objects => [ # ARRAY reference
321 'RT::Attachment-10', # SCALAR or SCALAR reference
322 $tickets, # RT::Tickets object (isa RT::SearchBuilder)
323 $user, # RT::User object (isa RT::Record)
329 sub CastObjectsToRecords
332 my %args = ( Objects => undef, @_ );
335 my $targets = delete $args{'Objects'};
337 RT::Shredder::Exception->throw( "Undefined Objects argument" );
340 if( UNIVERSAL::isa( $targets, 'RT::SearchBuilder' ) ) {
341 #XXX: try to use ->_DoSearch + ->ItemsArrayRef in feature
342 # like we do in Record with links, but change only when
343 # more tests would be available
344 while( my $tmp = $targets->Next ) { push @res, $tmp };
345 } elsif ( UNIVERSAL::isa( $targets, 'RT::Record' ) ) {
347 } elsif ( UNIVERSAL::isa( $targets, 'ARRAY' ) ) {
348 foreach( @$targets ) {
349 push @res, $self->CastObjectsToRecords( Objects => $_ );
351 } elsif ( UNIVERSAL::isa( $targets, 'SCALAR' ) || !ref $targets ) {
352 $targets = $$targets if ref $targets;
353 my ($class, $id) = split /-/, $targets;
354 RT::Shredder::Exception->throw( "Unsupported class $class" )
355 unless $class =~ /^\w+(::\w+)*$/;
356 $class = 'RT::'. $class unless $class =~ /^RTx?::/i;
357 eval "require $class";
358 die "Couldn't load '$class' module" if $@;
359 my $obj = $class->new( RT->SystemUser );
360 die "Couldn't construct new '$class' object" unless $obj;
362 unless ( $obj->id ) {
363 $RT::Logger->error( "Couldn't load '$class' object with id '$id'" );
364 RT::Shredder::Exception::Info->throw( 'CouldntLoadObject' );
366 die "Loaded object has different id" unless( $id eq $obj->id );
369 RT::Shredder::Exception->throw( "Unsupported type ". ref $targets );
376 =head4 PutObjects( Objects => undef )
378 Puts objects into cache.
380 Returns array of the cache entries.
382 See C<CastObjectsToRecords> method for supported types of the C<Objects>
390 my %args = ( Objects => undef, @_ );
393 for( $self->CastObjectsToRecords( Objects => delete $args{'Objects'} ) ) {
394 push @res, $self->PutObject( %args, Object => $_ )
400 =head4 PutObject( Object => undef )
402 Puts record object into cache and returns its cache entry.
404 B<NOTE> that this method support B<only C<RT::Record> object or its ancesstor
405 objects>, if you want put mutliple objects or objects represented by different
406 classes then use C<PutObjects> method instead.
413 my %args = ( Object => undef, @_ );
415 my $obj = $args{'Object'};
416 unless( UNIVERSAL::isa( $obj, 'RT::Record' ) ) {
417 RT::Shredder::Exception->throw( "Unsupported type '". (ref $obj || $obj || '(undef)')."'" );
420 my $str = $obj->_AsString;
421 return ($self->{'cache'}->{ $str } ||= { State => ON_STACK, Object => $obj } );
424 =head4 GetObject, GetState, GetRecord( String => ''| Object => '' )
426 Returns record object from cache, cache entry state or cache entry accordingly.
428 All three methods takes C<String> (format C<< <class>-<id> >>) or C<Object> argument.
429 C<String> argument has more priority than C<Object> so if it's not empty then methods
430 leave C<Object> argument unchecked.
432 You can read about possible states and their meanings in L<RT::Shredder::Constants> docs.
444 if( $args{'String'} && $args{'Object'} ) {
446 Carp::croak( "both String and Object args passed" );
448 return $args{'String'} if $args{'String'};
449 return $args{'Object'}->_AsString if UNIVERSAL::can($args{'Object'}, '_AsString' );
453 sub GetObject { return (shift)->GetRecord( @_ )->{'Object'} }
454 sub GetState { return (shift)->GetRecord( @_ )->{'State'} }
458 my $str = $self->_ParseRefStrArgs( @_ );
459 return $self->{'cache'}->{ $str };
462 =head3 Dependencies resolvers
464 =head4 PutResolver, GetResolvers and ApplyResolvers
466 TODO: These methods have no documentation.
479 unless( UNIVERSAL::isa( $args{'Code'} => 'CODE' ) ) {
480 die "Resolver '$args{Code}' is not code reference";
485 $self->{'resolver'}->{ $args{'BaseClass'} } ||= {}
486 )->{ $args{'TargetClass'} || '' } ||= []
488 unshift @$resolvers, $args{'Code'};
502 if( $args{'TargetClass'} && exists $self->{'resolver'}->{ $args{'BaseClass'} }->{ $args{'TargetClass'} } ) {
503 push @res, @{ $self->{'resolver'}->{ $args{'BaseClass'} }->{ $args{'TargetClass'} || '' } };
505 if( exists $self->{'resolver'}->{ $args{'BaseClass'} }->{ '' } ) {
506 push @res, @{ $self->{'resolver'}->{ $args{'BaseClass'} }->{''} };
515 my %args = ( Dependency => undef, @_ );
516 my $dep = $args{'Dependency'};
518 my @resolvers = $self->GetResolvers(
519 BaseClass => $dep->BaseClass,
520 TargetClass => $dep->TargetClass,
523 unless( @resolvers ) {
524 RT::Shredder::Exception::Info->throw(
526 error => "Couldn't find resolver for dependency '". $dep->AsString ."'",
531 BaseObject => $dep->BaseObject,
532 TargetObject => $dep->TargetObject,
533 ) foreach @resolvers;
542 foreach my $cache_val ( values %{ $self->{'cache'} } ) {
543 next if $cache_val->{'State'} & (WIPED | IN_WIPING);
544 $self->Wipeout( Object => $cache_val->{'Object'} );
553 die "Couldn't begin transaction" unless $RT::Handle->BeginTransaction;
554 $mark = $self->PushDumpMark or die "Couldn't get dump mark";
555 $self->_Wipeout( @_ );
556 $self->PopDumpMark( Mark => $mark );
557 die "Couldn't commit transaction" unless $RT::Handle->Commit;
561 $RT::Handle->Rollback('force');
562 $self->RollbackDumpTo( Mark => $mark ) if $mark;
563 die $error if RT::Shredder::Exception::Info->caught;
564 die "Couldn't wipeout object: $error";
571 my %args = ( CacheRecord => undef, Object => undef, @_ );
573 my $record = $args{'CacheRecord'};
574 $record = $self->PutObject( Object => $args{'Object'} ) unless $record;
575 return if $record->{'State'} & (WIPED | IN_WIPING);
577 $record->{'State'} |= IN_WIPING;
578 my $object = $record->{'Object'};
580 $self->DumpObject( Object => $object, State => 'before any action' );
582 unless( $object->BeforeWipeout ) {
583 RT::Shredder::Exception->throw( "BeforeWipeout check returned error" );
586 my $deps = $object->Dependencies( Shredder => $self );
588 WithFlags => DEPENDS_ON | VARIABLE,
589 Callback => sub { $self->ApplyResolvers( Dependency => $_[0] ) },
591 $self->DumpObject( Object => $object, State => 'after resolvers' );
594 WithFlags => DEPENDS_ON,
595 WithoutFlags => WIPE_AFTER | VARIABLE,
596 Callback => sub { $self->_Wipeout( Object => $_[0]->TargetObject ) },
598 $self->DumpObject( Object => $object, State => 'after wiping dependencies' );
601 $record->{'State'} |= WIPED; delete $record->{'Object'};
602 $self->DumpObject( Object => $object, State => 'after wipeout' );
605 WithFlags => DEPENDS_ON | WIPE_AFTER,
606 WithoutFlags => VARIABLE,
607 Callback => sub { $self->_Wipeout( Object => $_[0]->TargetObject ) },
609 $self->DumpObject( Object => $object, State => 'after late dependencies' );
614 sub ValidateRelations
619 foreach my $record( values %{ $self->{'cache'} } ) {
620 next if( $record->{'State'} & VALID );
621 $record->{'Object'}->ValidateRelations( Shredder => $self );
625 =head3 Data storage and backups
627 =head4 GetFileName( FileName => '<ISO DATETIME>-XXXX.sql', FromStorage => 1 )
629 Takes desired C<FileName> and flag C<FromStorage> then translate file name to absolute
632 * Default value of the C<FileName> option is C<< <ISO DATETIME>-XXXX.sql >>;
634 * if C<FileName> has C<XXXX> (exactly four uppercase C<X> letters) then it would be changed with digits from 0000 to 9999 range, with first one free value;
636 * if C<FileName> has C<%T> then it would be replaced with the current date and time in the C<YYYY-MM-DDTHH:MM:SS> format. Note that using C<%t> may still generate not unique names, using C<XXXX> recomended.
638 * if C<FromStorage> argument is true (default behaviour) then result path would always be relative to C<StoragePath>;
640 * if C<FromStorage> argument is false then result would be relative to the current dir unless it's already absolute path.
642 Returns an absolute path of the file.
645 # file from storage with default name format
646 my $fname = $shredder->GetFileName;
648 # file from storage with custom name format
649 my $fname = $shredder->GetFileName( FileName => 'shredder-XXXX.backup' );
651 # file with path relative to the current dir
652 my $fname = $shredder->GetFileName(
654 FileName => 'backups/shredder.sql',
657 # file with absolute path
658 my $fname = $shredder->GetFileName(
660 FileName => '/var/backups/shredder-XXXX.sql'
668 my %args = ( FileName => '', FromStorage => 1, @_ );
671 my $file = $args{'FileName'} || '%t-XXXX.sql';
672 if( $file =~ /\%t/i ) {
674 my $date_time = POSIX::strftime( "%Y%m%dT%H%M%S", gmtime );
675 $file =~ s/\%t/$date_time/gi;
678 # convert to absolute path
679 if( $args{'FromStorage'} ) {
680 $file = File::Spec->catfile( $self->StoragePath, $file );
681 } elsif( !File::Spec->file_name_is_absolute( $file ) ) {
682 $file = File::Spec->rel2abs( $file );
686 if( $file =~ /XXXX[^\/\\]*$/ ) {
687 my( $tmp, $i ) = ( $file, 0 );
691 $tmp =~ s/XXXX([^\/\\]*)$/sprintf("%04d", $i).$1/e;
692 } while( -e $tmp && $i < 9999 );
698 die "File '$file' exists, but is read-only";
701 unless( File::Spec->file_name_is_absolute( $file ) ) {
702 $file = File::Spec->rel2abs( $file );
706 my $dir = File::Spec->join( (File::Spec->splitpath( $file ))[0,1] );
707 unless( -e $dir && -d _) {
708 die "Base directory '$dir' for file '$file' doesn't exist";
711 die "Base directory '$dir' is not writable";
714 die "'$file' is not regular file";
722 Returns an absolute path to the storage dir. See
723 L</$ShredderStoragePath>.
725 See also description of the L</GetFileName> method.
731 return scalar( RT->Config->Get('ShredderStoragePath') )
732 || File::Spec->catdir( $RT::VarPath, qw(data RT-Shredder) );
735 my %active_dump_state = ();
738 my %args = ( Object => undef, Name => 'SQLDump', Arguments => undef, @_ );
740 my $plugin = $args{'Object'};
742 require RT::Shredder::Plugin;
743 $plugin = RT::Shredder::Plugin->new;
744 my( $status, $msg ) = $plugin->LoadByName( $args{'Name'} );
745 die "Couldn't load dump plugin: $msg\n" unless $status;
747 die "Plugin is not of correct type" unless lc $plugin->Type eq 'dump';
749 if ( my $pargs = $args{'Arguments'} ) {
750 my ($status, $msg) = $plugin->TestArgs( %$pargs );
751 die "Couldn't set plugin args: $msg\n" unless $status;
754 my @applies_to = $plugin->AppliesToStates;
755 die "Plugin doesn't apply to any state" unless @applies_to;
756 $active_dump_state{ lc $_ } = 1 foreach @applies_to;
758 push @{ $self->{'dump_plugins'} }, $plugin;
765 my %args = (Object => undef, State => undef, @_);
766 die "No state passed" unless $args{'State'};
767 return unless $active_dump_state{ lc $args{'State'} };
769 foreach (@{ $self->{'dump_plugins'} }) {
770 next unless grep lc $args{'State'} eq lc $_, $_->AppliesToStates;
771 my ($state, $msg) = $_->Run( %args );
772 die "Couldn't run plugin: $msg" unless $state;
776 { my $mark = 1; # XXX: integer overflows?
780 foreach (@{ $self->{'dump_plugins'} }) {
781 my ($state, $msg) = $_->PushMark( Mark => $mark );
782 die "Couldn't push mark: $msg" unless $state;
788 foreach (@{ $self->{'dump_plugins'} }) {
789 my ($state, $msg) = $_->PushMark( @_ );
790 die "Couldn't pop mark: $msg" unless $state;
795 foreach (@{ $self->{'dump_plugins'} }) {
796 my ($state, $msg) = $_->RollbackTo( @_ );
797 die "Couldn't rollback to mark: $msg" unless $state;
807 =head2 Database transactions support
809 Since 0.03_01 RT::Shredder uses database transactions and should be
810 much safer to run on production servers.
814 Mainstream RT doesn't use FKs, but at least I posted DDL script that creates them
815 in mysql DB, note that if you use FKs then this two valid keys don't allow delete
816 Tickets because of bug in MySQL:
818 ALTER TABLE Tickets ADD FOREIGN KEY (EffectiveId) REFERENCES Tickets(id);
819 ALTER TABLE CachedGroupMembers ADD FOREIGN KEY (Via) REFERENCES CachedGroupMembers(id);
821 L<http://bugs.mysql.com/bug.php?id=4042>
823 =head1 BUGS AND HOW TO CONTRIBUTE
825 We need your feedback in all cases: if you use it or not,
826 is it works for you or not.
830 Don't skip C<make test> step while install and send me reports if it's fails.
831 Add your own tests, it's easy enough if you've writen at list one perl script
832 that works with RT. Read more about testing in F<t/utils.pl>.
836 Send reports to L</AUTHOR> or to the RT mailing lists.
840 Many bugs in the docs: insanity, spelling, gramar and so on.
841 Patches are wellcome.
845 Please, see Todo file, it has some technical notes
846 about what I plan to do, when I'll do it, also it
847 describes some problems code has.
851 Since RT-3.7 shredder is a part of the RT distribution.
852 Versions of the RTx::Shredder extension could
853 be downloaded from the CPAN. Those work with older
854 RT versions or you can find repository at
855 L<https://opensvn.csie.org/rtx_shredder>
859 Ruslan U. Zakirov <Ruslan.Zakirov@gmail.com>
863 This program is free software; you can redistribute
864 it and/or modify it under the same terms as Perl itself.
866 The full text of the license can be found in the
871 L<rt-shredder>, L<rt-validator>