rt/sbin/rt-dump-database

   1 #!/usr/bin/perl -w
   2 # BEGIN BPS TAGGED BLOCK {{{
   3 #
   4 # COPYRIGHT:
   5 #
   6 # This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC
   7 #                                          <sales@bestpractical.com>
   8 #
   9 # (Except where explicitly superseded by other copyright notices)
  10 #
  11 #
  12 # LICENSE:
  13 #
  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
  17 # from www.gnu.org.
  18 #
  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.
  23 #
  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.
  29 #
  30 #
  31 # CONTRIBUTION SUBMISSION POLICY:
  32 #
  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.)
  38 #
  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.
  47 #
  48 # END BPS TAGGED BLOCK }}}
  49 use strict;
  50
  51 # As we specify that XML is UTF-8 and we output it to STDOUT, we must be sure
  52 # it is UTF-8 so further XMLin will not break
  53 binmode(STDOUT, ":utf8");
  54
  55 # fix lib paths, some may be relative
  56 BEGIN {
  57     require File::Spec;
  58     my @libs = ("lib", "local/lib");
  59     my $bin_path;
  60
  61     for my $lib (@libs) {
  62         unless ( File::Spec->file_name_is_absolute($lib) ) {
  63             unless ($bin_path) {
  64                 if ( File::Spec->file_name_is_absolute(__FILE__) ) {
  65                     $bin_path = ( File::Spec->splitpath(__FILE__) )[1];
  66                 }
  67                 else {
  68                     require FindBin;
  69                     no warnings "once";
  70                     $bin_path = $FindBin::Bin;
  71                 }
  72             }
  73             $lib = File::Spec->catfile( $bin_path, File::Spec->updir, $lib );
  74         }
  75         unshift @INC, $lib;
  76     }
  77
  78 }
  79
  80 use RT;
  81 use XML::Simple;
  82
  83 RT::LoadConfig();
  84 RT::Init();
  85
  86 my $LocalOnly = @ARGV ? shift(@ARGV) : 1;
  87
  88 my %RV;
  89 my %Ignore = (
  90     All => [qw(
  91         id Created Creator LastUpdated LastUpdatedBy
  92     )],
  93     Templates => [qw(
  94         TranslationOf
  95     )],
  96 );
  97
  98 my $SystemUserId = $RT::SystemUser->Id;
  99 my @classes = qw(
 100     Users Groups Queues ScripActions ScripConditions
 101     Templates Scrips ACL CustomFields
 102 );
 103 foreach my $class (@classes) {
 104     require "RT/$class.pm";
 105     my $objects = "RT::$class"->new($RT::SystemUser);
 106     $objects->{find_disabled_rows} = 1;
 107     $objects->UnLimit;
 108
 109     if ($class eq 'CustomFields') {
 110         $objects->OrderByCols(
 111             { FIELD => 'LookupType' },
 112             { FIELD => 'SortOrder' },
 113             { FIELD => 'Id' },
 114         );
 115     }
 116     else {
 117         $objects->OrderBy( FIELD => 'Id' );
 118     }
 119
 120     if ($LocalOnly) {
 121         next if $class eq 'ACL'; # XXX - would go into infinite loop - XXX
 122         $objects->Limit( FIELD => 'LastUpdatedBy', OPERATOR => '!=', VALUE => $SystemUserId )
 123             unless $class eq 'Groups';
 124         $objects->Limit( FIELD => 'Id', OPERATOR => '!=', VALUE => $SystemUserId )
 125             if $class eq 'Users';
 126         $objects->Limit( FIELD => 'Domain', OPERATOR => '=', VALUE => 'UserDefined' )
 127             if $class eq 'Groups';
 128     }
 129
 130     my %fields;
 131     while (my $obj = $objects->Next) {
 132         next if $obj->can('LastUpdatedBy') and $obj->LastUpdatedBy == $SystemUserId;
 133
 134         if (!%fields) {
 135             %fields = map { $_ => 1 } keys %{$obj->_ClassAccessible};
 136             delete @fields{
 137                 @{$Ignore{$class}||=[]},
 138                 @{$Ignore{All}||=[]},
 139             };
 140         }
 141
 142         my $rv;
 143         # next if $obj-> # skip default names
 144         foreach my $field (sort keys %fields) {
 145             my $value = $obj->__Value($field);
 146             $rv->{$field} = $value if ( defined ($value) && length($value) );
 147         }
 148         delete $rv->{Disabled} unless $rv->{Disabled};
 149
 150         foreach my $record (map { /ACL/ ? 'ACE' : substr($_, 0, -1) } @classes) {
 151             foreach my $key (map "$record$_", ('', 'Id')) {
 152                 next unless exists $rv->{$key};
 153                 my $id = $rv->{$key} or next;
 154                 my $obj = "RT::$record"->new($RT::SystemUser);
 155                 $obj->LoadByCols( Id => $id ) or next;
 156                 $rv->{$key} = $obj->__Value('Name') || 0;
 157             }
 158         }
 159
 160         if ($class eq 'Users' and defined $obj->Privileged) {
 161             $rv->{Privileged} = int($obj->Privileged);
 162         }
 163         elsif ($class eq 'CustomFields') {
 164             my $values = $obj->Values;
 165             while (my $value = $values->Next) {
 166                 push @{$rv->{Values}}, {
 167                     map { ($_ => $value->__Value($_)) } qw(
 168                         Name Description SortOrder
 169                     ),
 170                 };
 171             }
 172         }
 173
 174         if (eval { require RT::Attributes; 1 }) {
 175             my $attributes = $obj->Attributes;
 176             while (my $attribute = $attributes->Next) {
 177                 my $content = $attribute->Content;
 178                 $rv->{Attributes}{$attribute->Name} = $content if length($content);
 179             }
 180         }
 181
 182         push @{$RV{$class}}, $rv;
 183     }
 184 }
 185
 186 print(<< ".");
 187 no strict; use XML::Simple; *_ = XMLin(do { local \$/; readline(DATA) }, ForceArray => [qw(
 188  @classes Values
 189 )], NoAttr => 1, SuppressEmpty => ''); *\$_ = (\$_{\$_} || []) for keys \%_; 1; # vim: ft=xml
 190 __DATA__
 191 .
 192
 193 print XMLout(
 194     { map { ($_ => ($RV{$_} || [])) } @classes },
 195     RootName => 'InitialData',
 196     NoAttr => 1,
 197     SuppressEmpty => '',
 198     XMLDecl => '<?xml version="1.0" encoding="UTF-8"?>',
 199 );