rt/share/html/Admin/Tools/Shredder/index.html

   1 %# BEGIN BPS TAGGED BLOCK {{{
   2 %#
   3 %# COPYRIGHT:
   4 %#
   5 %# This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC
   6 %#                                          <sales@bestpractical.com>
   7 %#
   8 %# (Except where explicitly superseded by other copyright notices)
   9 %#
  10 %#
  11 %# LICENSE:
  12 %#
  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
  16 %# from www.gnu.org.
  17 %#
  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.
  22 %#
  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.
  28 %#
  29 %#
  30 %# CONTRIBUTION SUBMISSION POLICY:
  31 %#
  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.)
  37 %#
  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.
  46 %#
  47 %# END BPS TAGGED BLOCK }}}
  48 <%ARGS>
  49 $Plugin => ''
  50 $Search => ''
  51 $Wipeout => ''
  52 @WipeoutObject => ()
  53 </%ARGS>
  54 <& /Admin/Elements/Header, Title => $title &>
  55 <& /Admin/Elements/ToolTabs,
  56     current_tab => 'Admin/Tools/Shredder',
  57     current_subtab => 'Admin/Tools/Shredder',
  58     Title => $title,
  59 &>
  60 <form id="shredder-search-form" action="<% RT->Config->Get('WebPath') %>/Admin/Tools/Shredder/" method="GET">
  61 <div id="shredder-select-plugin">
  62 <& /Elements/ListActions, actions => $messages{'Errors'} &>
  63 <& /Elements/ListActions, actions => $messages{'Success'} &>
  64 <& Elements/DumpFileLink, File => $dump_file &>
  65 <& Elements/SelectPlugin, Plugin => $Plugin, %ARGS &>
  66 <div id="shredder-submit-button" class="<% $Plugin? '': 'hidden' %>">
  67 <& /Elements/Submit, Name => 'Search', Label => loc('Search') &>
  68 </div>
  69 </div>
  70 <br />
  71 % if( $Search || $Wipeout ) {
  72 <& Elements/SelectObjects, Objects => \@objs &>
  73 % }
  74 </form>
  75 <%INIT>
  76
  77 require RT::Shredder;
  78 my $title = loc('Shredder');
  79 my %messages = ( Errors => [], Success => [] );
  80 my ($plugin_obj, @objs);
  81
  82 my $catch_non_fatals = sub {
  83     require RT::Shredder::Exceptions;
  84     if ( my $e = RT::Shredder::Exception::Info->caught ) {
  85         push @{ $messages{Errors} }, "$e";
  86         $Search = ''; @objs = ();
  87         return 1;
  88     }
  89     if ( UNIVERSAL::isa( $@, 'Class::Exception' ) ) {
  90         $@->rethrow;
  91     } else {
  92         die $@;
  93     }
  94 };
  95
  96
  97 if( $Plugin ) { { # use additional block({}) to effectively exit block on errors
  98     use RT::Shredder::Plugin;
  99     $plugin_obj = new RT::Shredder::Plugin;
 100     my( $status, $msg ) = $plugin_obj->LoadByName( $Plugin );
 101     unless( $status ) {
 102         push @{ $messages{Errors} }, $msg;
 103         $Search = '';
 104         last;
 105     }
 106
 107     my %args;
 108     foreach my $k( keys %ARGS ) {
 109         next unless $k =~ /^\Q$Plugin\E:(.*)$/;
 110         $args{ $1 } = $ARGS{$k};
 111     }
 112     ( $status, $msg ) = $plugin_obj->HasSupportForArgs( keys %args );
 113     unless( $status ) {
 114         push @{ $messages{Errors} }, $msg;
 115         $Search = '';
 116         last;
 117     }
 118
 119     ($status, $msg) = eval { $plugin_obj->TestArgs( %args ) };
 120     $catch_non_fatals->() && last if $@;
 121     unless( $status ) {
 122         push @{ $messages{Errors} }, $msg;
 123         $Search = '';
 124         last;
 125     }
 126 } }
 127
 128 my $dump_file = '';
 129
 130 if( $Plugin && $Wipeout ) { { # use additional block({}) to effectively exit block on errors
 131     my $shredder = new RT::Shredder( force => 1 );
 132     my $backup_plugin = new RT::Shredder::Plugin;
 133     my ($status, $msg) = $backup_plugin->LoadByName('SQLDump');
 134     unless( $status ) {
 135         push @{ $messages{Errors} }, $msg;
 136         $Search = ''; @objs = ();
 137         last;
 138     }
 139     ($status, $msg) = $backup_plugin->TestArgs;
 140     unless( $status ) {
 141         push @{ $messages{Errors} }, $msg;
 142         $Search = ''; @objs = ();
 143         last;
 144     }
 145
 146     ($dump_file) = $backup_plugin->FileName;
 147     push @{ $messages{'Success'} }, "SQL dump file is '$dump_file'";
 148
 149     $shredder->AddDumpPlugin( Object => $backup_plugin );
 150
 151     $shredder->PutObjects( Objects => \@WipeoutObject );
 152     ($status, $msg) = $plugin_obj->SetResolvers( Shredder => $shredder );
 153     unless( $status ) {
 154         push @{ $messages{Errors} }, $msg;
 155         $Search = ''; @objs = ();
 156         last;
 157     }
 158     eval { $shredder->WipeoutAll };
 159     $catch_non_fatals->() && last if $@;
 160
 161     push @{ $messages{Success} }, loc('objects were successfuly removed');
 162 } }
 163
 164 if( $Plugin && ( $Search || $Wipeout ) ) { { # use additional block({}) to effectively exit block on errors
 165     my $status;
 166     ($status, @objs) = eval { $plugin_obj->Run };
 167     $catch_non_fatals->() && last if $@;
 168     unless( $status ) {
 169         push @{ $messages{Errors} }, $objs[0];
 170         $Search = ''; @objs = ();
 171         last;
 172     }
 173     push @{ $messages{Success} }, loc('executed plugin successfuly');
 174
 175     my $shredder = new RT::Shredder;
 176     foreach my $o( grep defined, splice @objs ) {
 177         eval { push @objs, $shredder->CastObjectsToRecords( Objects => $o ) };
 178         $catch_non_fatals->() && last if $@;
 179     }
 180     unless( @objs ) {
 181         push @{ $messages{Success} }, loc('plugin returned empty list');
 182     } else {
 183         push @{ $messages{Success} }, loc('see object list below');
 184     }
 185 } }
 186 </%INIT>