2 # BEGIN BPS TAGGED BLOCK {{{
6 # This software is Copyright (c) 1996-2012 Best Practical Solutions, LLC
7 # <sales@bestpractical.com>
9 # (Except where explicitly superseded by other copyright notices)
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
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.
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.
31 # CONTRIBUTION SUBMISSION POLICY:
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.)
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.
48 # END BPS TAGGED BLOCK }}}
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" );
55 # fix lib paths, some may be relative
58 my @libs = ( "/opt/rt3/lib", "/opt/rt3/local/lib" );
62 unless ( File::Spec->file_name_is_absolute($lib) ) {
64 if ( File::Spec->file_name_is_absolute(__FILE__) ) {
65 $bin_path = ( File::Spec->splitpath(__FILE__) )[1];
69 $bin_path = $FindBin::Bin;
72 $lib = File::Spec->catfile( $bin_path, File::Spec->updir, $lib );
81 GetOptions( \%opt, "help|h" );
85 Pod::Usage::pod2usage( { verbose => 2 } );
95 my $LocalOnly = @ARGV ? shift(@ARGV) : 1;
101 id Created Creator LastUpdated LastUpdatedBy
111 my $SystemUserId = RT->SystemUser->Id;
113 Users Groups Queues ScripActions ScripConditions
114 Templates Scrips ACL CustomFields
116 foreach my $class (@classes) {
117 require "RT/$class.pm";
118 my $objects = "RT::$class"->new( RT->SystemUser );
119 $objects->{find_disabled_rows} = 1;
122 if ( $class eq 'CustomFields' ) {
123 $objects->OrderByCols(
124 { FIELD => 'LookupType' },
125 { FIELD => 'SortOrder' },
129 $objects->OrderBy( FIELD => 'Id' );
133 next if $class eq 'ACL'; # XXX - would go into infinite loop - XXX
135 FIELD => 'LastUpdatedBy',
137 VALUE => $SystemUserId
138 ) unless $class eq 'Groups';
142 VALUE => $SystemUserId
143 ) if $class eq 'Users';
147 VALUE => 'UserDefined'
148 ) if $class eq 'Groups';
152 while ( my $obj = $objects->Next ) {
154 if $obj->can('LastUpdatedBy')
155 and $obj->LastUpdatedBy == $SystemUserId;
158 %fields = map { $_ => 1 } keys %{ $obj->_ClassAccessible };
159 delete @fields{ @{ $Ignore{$class} ||= [] },
160 @{ $Ignore{All} ||= [] }, };
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) );
170 delete $rv->{Disabled} unless $rv->{Disabled};
172 foreach my $record ( map { /ACL/ ? 'ACE' : substr( $_, 0, -1 ) }
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;
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($_) ) }
192 Name Description SortOrder
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
207 push @{ $RV{$class} }, $rv;
212 no strict; use XML::Simple; *_ = XMLin(do { local \$/; readline(DATA) }, ForceArray => [qw(
214 )], NoAttr => 1, SuppressEmpty => ''); *\$_ = (\$_{\$_} || []) for keys \%_; 1; # vim: ft=xml
218 print XML::Simple::XMLout(
219 { map { ( $_ => ( $RV{$_} || [] ) ) } @classes },
220 RootName => 'InitialData',
223 XMLDecl => '<?xml version="1.0" encoding="UTF-8"?>',
230 rt-dump-metadata - dump configuration metadata from an RT database
234 rt-dump-metdata [ 0 ]
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.
244 When run without arguments, the metadata dump will only include 'local'
245 configuration changes, i.e. those done manually in the web interface.
247 When run with the argument '0', the dump will include all configuration
250 This is NOT a tool for backing up an RT database.