sbin/rt-dump-metadata

   1 #!/usr/bin/perl -w
   2 # BEGIN BPS TAGGED BLOCK {{{
   3 #
   4 # COPYRIGHT:
   5 #
   6 # This software is Copyright (c) 1996-2012 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                 } else {
  67                     require FindBin;
  68                     no warnings "once";
  69                     $bin_path = $FindBin::Bin;
  70                 }
  71             }
  72             $lib = File::Spec->catfile( $bin_path, File::Spec->updir, $lib );
  73         }
  74         unshift @INC, $lib;
  75     }
  76
  77 }
  78
  79 use Getopt::Long;
  80 my %opt;
  81 GetOptions( \%opt, "help|h" );
  82
  83 if ( $opt{help} ) {
  84     require Pod::Usage;
  85     Pod::Usage::pod2usage( { verbose => 2 } );
  86     exit;
  87 }
  88
  89 require RT;
  90 require XML::Simple;
  91
  92 RT::LoadConfig();
  93 RT::Init();
  94
  95 my $LocalOnly = @ARGV ? shift(@ARGV) : 1;
  96
  97 my %RV;
  98 my %Ignore = (
  99     All => [
 100         qw(
 101             id Created Creator LastUpdated LastUpdatedBy
 102             )
 103            ],
 104     Templates => [
 105         qw(
 106             TranslationOf
 107             )
 108     ],
 109 );
 110
 111 my $SystemUserId = RT->SystemUser->Id;
 112 my @classes      = qw(
 113     Users Groups Queues ScripActions ScripConditions
 114     Templates Scrips ACL CustomFields
 115     );
 116 foreach my $class (@classes) {
 117     require "RT/$class.pm";
 118     my $objects = "RT::$class"->new( RT->SystemUser );
 119     $objects->{find_disabled_rows} = 1;
 120     $objects->UnLimit;
 121
 122     if ( $class eq 'CustomFields' ) {
 123         $objects->OrderByCols(
 124             { FIELD => 'LookupType' },
 125             { FIELD => 'SortOrder' },
 126             { FIELD => 'Id' },
 127         );
 128     } else {
 129         $objects->OrderBy( FIELD => 'Id' );
 130     }
 131
 132     if ($LocalOnly) {
 133         next if $class eq 'ACL';    # XXX - would go into infinite loop - XXX
 134         $objects->Limit(
 135             FIELD    => 'LastUpdatedBy',
 136             OPERATOR => '!=',
 137             VALUE    => $SystemUserId
 138         ) unless $class eq 'Groups';
 139         $objects->Limit(
 140             FIELD    => 'Id',
 141             OPERATOR => '!=',
 142             VALUE    => $SystemUserId
 143         ) if $class eq 'Users';
 144         $objects->Limit(
 145             FIELD    => 'Domain',
 146             OPERATOR => '=',
 147             VALUE    => 'UserDefined'
 148         ) if $class eq 'Groups';
 149     }
 150
 151     my %fields;
 152     while ( my $obj = $objects->Next ) {
 153         next
 154             if $obj->can('LastUpdatedBy')
 155                 and $obj->LastUpdatedBy == $SystemUserId;
 156
 157         if ( !%fields ) {
 158             %fields = map { $_ => 1 } keys %{ $obj->_ClassAccessible };
 159             delete @fields{ @{ $Ignore{$class} ||= [] },
 160                 @{ $Ignore{All} ||= [] }, };
 161         }
 162
 163         my $rv;
 164
 165         # next if $obj-> # skip default names
 166         foreach my $field ( sort keys %fields ) {
 167             my $value = $obj->__Value($field);
 168             $rv->{$field} = $value if ( defined($value) && length($value) );
 169         }
 170         delete $rv->{Disabled} unless $rv->{Disabled};
 171
 172         foreach my $record ( map { /ACL/ ? 'ACE' : substr( $_, 0, -1 ) }
 173             @classes )
 174         {
 175             foreach my $key ( map "$record$_", ( '', 'Id' ) ) {
 176                 next unless exists $rv->{$key};
 177                 my $id = $rv->{$key} or next;
 178                 my $obj = "RT::$record"->new( RT->SystemUser );
 179                 $obj->LoadByCols( Id => $id ) or next;
 180                 $rv->{$key} = $obj->__Value('Name') || 0;
 181             }
 182         }
 183
 184         if ( $class eq 'Users' and defined $obj->Privileged ) {
 185             $rv->{Privileged} = int( $obj->Privileged );
 186         } elsif ( $class eq 'CustomFields' ) {
 187             my $values = $obj->Values;
 188             while ( my $value = $values->Next ) {
 189                 push @{ $rv->{Values} }, {
 190                     map { ( $_ => $value->__Value($_) ) }
 191                         qw(
 192                         Name Description SortOrder
 193                         ),
 194                 };
 195             }
 196         }
 197
 198         if ( eval { require RT::Attributes; 1 } ) {
 199             my $attributes = $obj->Attributes;
 200             while ( my $attribute = $attributes->Next ) {
 201                 my $content = $attribute->Content;
 202                 $rv->{Attributes}{ $attribute->Name } = $content
 203                     if length($content);
 204             }
 205         }
 206
 207         push @{ $RV{$class} }, $rv;
 208     }
 209 }
 210
 211 print(<< ".");
 212 no strict; use XML::Simple; *_ = XMLin(do { local \$/; readline(DATA) }, ForceArray => [qw(
 213  @classes Values
 214 )], NoAttr => 1, SuppressEmpty => ''); *\$_ = (\$_{\$_} || []) for keys \%_; 1; # vim: ft=xml
 215 __DATA__
 216 .
 217
 218 print XML::Simple::XMLout(
 219     { map { ( $_ => ( $RV{$_} || [] ) ) } @classes },
 220     RootName      => 'InitialData',
 221     NoAttr        => 1,
 222     SuppressEmpty => '',
 223     XMLDecl       => '<?xml version="1.0" encoding="UTF-8"?>',
 224 );
 225
 226 __END__
 227
 228 =head1 NAME
 229
 230 rt-dump-metadata - dump configuration metadata from an RT database
 231
 232 =head1 SYNOPSIS
 233
 234     rt-dump-metdata [ 0 ]
 235
 236 =head1 DESCRIPTION
 237
 238 C<rt-dump-metadata> is a tool that dumps configuration metadata from the
 239 Request Tracker database into XML format, suitable for feeding into
 240 C<rt-setup-database>. To dump and load a full RT database, you should generally
 241 use the native database tools instead, as well as performing any necessary
 242 steps from UPGRADING.
 243
 244 When run without arguments, the metadata dump will only include 'local'
 245 configuration changes, i.e. those done manually in the web interface.
 246
 247 When run with the argument '0', the dump will include all configuration
 248 metadata.
 249
 250 This is NOT a tool for backing up an RT database.
 251