rt/devel/tools/rt-attributes-editor

   1 #!/usr/bin/env perl
   2 # BEGIN BPS TAGGED BLOCK {{{
   3 #
   4 # COPYRIGHT:
   5 #
   6 # This software is Copyright (c) 1996-2015 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 use warnings;
  51 use Term::EditorEdit;
  52 use Getopt::Long;
  53 my ($help, $key, $id);
  54 GetOptions('help|h' => \$help, 'key|k=s' => \$key, 'id=i' => \$id);
  55
  56 if ( $help || !$id ) {
  57     require Pod::Usage;
  58     Pod::Usage::pod2usage({ verbose => 2 });
  59     exit;
  60 }
  61
  62 require RT;
  63 RT::LoadConfig();
  64 RT::Init();
  65
  66 require RT::Attribute;
  67 my $attr = RT::Attribute->new( RT->SystemUser );
  68 $attr->Load( $id );
  69 unless ( $attr->id ) {
  70     print STDERR "Couldn't load attribute #$id\n";
  71     exit 1;
  72 }
  73
  74 my $orig;
  75 if ($key) {
  76     if (ref($attr->Content) ne 'HASH') {
  77         print STDERR "The attribute's content must be a hashref for editing keys\n";
  78         exit 1;
  79     }
  80     $orig = $attr->Content->{$key} || '';
  81 }
  82 else {
  83     use Data::Dumper;
  84     $orig = Dumper( $attr->Content );
  85 }
  86
  87 my $edit = Term::EditorEdit->edit(document => $orig);
  88
  89 if ($edit ne $orig) {
  90     if ($key) {
  91         my $content = $attr->Content;
  92         $content->{$key} = $edit;
  93         $attr->SetContent($content);
  94         print "Attribute key saved.\n";
  95     }
  96     else {
  97         my $VAR1; eval $edit;
  98         if ($@) {
  99             print STDERR "Your change had an error: $@";
 100             exit 1;
 101         }
 102         $attr->SetContent($VAR1);
 103         print "Attribute saved.\n";
 104     }
 105 }
 106 else {
 107     print "Aborted.\n"
 108 }
 109
 110 __END__
 111
 112 =head1 NAME
 113
 114 rt-attributes-editor - edit the content of an attribute
 115
 116 =head1 SYNOPSIS
 117
 118     # edit the Perl dump of attribute 2's content
 119     rt-attributes-editor --id 2
 120
 121     # edit the dump of attribute 2's content (hash key: Query)
 122     # note: this will error if the attribute content is not a hashref
 123     rt-attributes-editor --id 2 --key Query
 124
 125 =head1 DESCRIPTION
 126
 127 This script deserializes and puts the content of an attribute defined
 128 by <attribute id> into the preferred editor set in C<$EDITOR>. May be
 129 useful for developers to editing attributes by hand if there is any
 130 trouble editing it from the UI.