Upgrade to 4.0.10.
[usit-rt.git] / lib / RT / Shredder / Plugin / SQLDump.pm
1 # BEGIN BPS TAGGED BLOCK {{{
2 #
3 # COPYRIGHT:
4 #
5 # This software is Copyright (c) 1996-2013 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
49 package RT::Shredder::Plugin::SQLDump;
50
51 use strict;
52 use warnings;
53
54 use base qw(RT::Shredder::Plugin::Base::Dump);
55 use RT::Shredder;
56
57 sub AppliesToStates { return 'after wiping dependencies' }
58
59 sub SupportArgs
60 {
61     my $self = shift;
62     return $self->SUPER::SupportArgs, qw(file_name from_storage);
63 }
64
65 sub TestArgs
66 {
67     my $self = shift;
68     my %args = @_;
69     $args{'from_storage'} = 1 unless defined $args{'from_storage'};
70     my $file = $args{'file_name'} = RT::Shredder->GetFileName(
71         FileName    => $args{'file_name'},
72         FromStorage => delete $args{'from_storage'},
73     );
74     open $args{'file_handle'}, ">:raw", $file
75         or return (0, "Couldn't open '$file' for write: $!");
76
77     return $self->SUPER::TestArgs( %args );
78 }
79
80 sub FileName   { return $_[0]->{'opt'}{'file_name'}   }
81 sub FileHandle { return $_[0]->{'opt'}{'file_handle'} }
82
83 sub Run
84 {
85     my $self = shift;
86     return (0, 'no handle') unless my $fh = $self->{'opt'}{'file_handle'};
87
88     my %args = ( Object => undef, @_ );
89     my $query = $args{'Object'}->_AsInsertQuery;
90     $query .= "\n" unless $query =~ /\n$/;
91
92     return print $fh $query or return (0, "Couldn't write to filehandle");
93     return 1;
94 }
95
96 1;