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