summaryrefslogtreecommitdiff
path: root/rt/devel/tools/rt-attributes-editor
blob: 92caeaf128c4d608395a9128b239f42d9010d0a2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
#!/usr/bin/env perl
# BEGIN BPS TAGGED BLOCK {{{
#
# COPYRIGHT:
#
# This software is Copyright (c) 1996-2012 Best Practical Solutions, LLC
#                                          <sales@bestpractical.com>
#
# (Except where explicitly superseded by other copyright notices)
#
#
# LICENSE:
#
# This work is made available to you under the terms of Version 2 of
# the GNU General Public License. A copy of that license should have
# been provided with this software, but in any event can be snarfed
# from www.gnu.org.
#
# This work is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301 or visit their web page on the internet at
# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
#
#
# CONTRIBUTION SUBMISSION POLICY:
#
# (The following paragraph is not intended to limit the rights granted
# to you to modify and distribute this software under the terms of
# the GNU General Public License and is only of importance to you if
# you choose to contribute your changes and enhancements to the
# community by submitting them to Best Practical Solutions, LLC.)
#
# By intentionally submitting any modifications, corrections or
# derivatives to this work, or any other work intended for use with
# Request Tracker, to Best Practical Solutions, LLC, you confirm that
# you are the copyright holder for those contributions and you grant
# Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
# royalty-free, perpetual, license to use, copy, create derivative
# works based on those contributions, and sublicense and distribute
# those contributions and any derivatives thereof.
#
# END BPS TAGGED BLOCK }}}
use strict;
use warnings;
use Term::EditorEdit;
use Getopt::Long;
my ($help, $key, $id);
GetOptions('help|h' => \$help, 'key|k=s' => \$key, 'id=i' => \$id);

if ( $help || !$id ) {
    require Pod::Usage;
    Pod::Usage::pod2usage({ verbose => 2 });
    exit;
}

require RT;
RT::LoadConfig();
RT::Init();

require RT::Attribute;
my $attr = RT::Attribute->new( RT->SystemUser );
$attr->Load( $id );
unless ( $attr->id ) {
    print STDERR "Couldn't load attribute #$id\n";
    exit 1;
}

my $orig;
if ($key) {
    if (ref($attr->Content) ne 'HASH') {
        print STDERR "The attribute's content must be a hashref for editing keys\n";
        exit 1;
    }
    $orig = $attr->Content->{$key} || '';
}
else {
    use Data::Dumper;
    $orig = Dumper( $attr->Content );
}

my $edit = Term::EditorEdit->edit(document => $orig);

if ($edit ne $orig) {
    if ($key) {
        my $content = $attr->Content;
        $content->{$key} = $edit;
        $attr->SetContent($content);
        print "Attribute key saved.\n";
    }
    else {
        my $VAR1; eval $edit;
        if ($@) {
            print STDERR "Your change had an error: $@";
            exit 1;
        }
        $attr->SetContent($VAR1);
        print "Attribute saved.\n";
    }
}
else {
    print "Aborted.\n"
}

__END__

=head1 NAME

rt-attributes-editor - edit the content of an attribute 

=head1 SYNOPSIS

    # edit the Perl dump of attribute 2's content
    rt-attributes-editor --id 2

    # edit the dump of attribute 2's content (hash key: Query)
    # note: this will error if the attribute content is not a hashref
    rt-attributes-editor --id 2 --key Query

=head1 DESCRIPTION

This script deserializes and puts the content of an attribute defined
by <attribute id> into the preferred editor set in C<$EDITOR>. May be
useful for developers to editing attributes by hand if there is any
trouble editing it from the UI.