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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
# BEGIN LICENSE BLOCK
#
# Copyright (c) 1996-2003 Jesse Vincent <jesse@bestpractical.com>
#
# (Except where explictly superceded by other copyright notices)
#
# 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.
#
# Unless otherwise specified, all modifications, corrections or
# extensions to this work which alter its source code become the
# property of Best Practical Solutions, LLC when submitted for
# inclusion in the work.
#
#
# END LICENSE BLOCK
use strict;
use RT;
package RT::Interface::CLI;
BEGIN {
use Exporter ();
use vars qw ($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
# set the version for version checking
$VERSION = do { my @r = (q$Revision: 1.2 $ =~ /\d+/g); sprintf "%d."."%02d" x $#r, @r }; # must be all one line, for MakeMaker
@ISA = qw(Exporter);
# your exported package globals go here,
# as well as any optionally exported functions
@EXPORT_OK = qw(&CleanEnv
&GetCurrentUser &GetMessageContent &debug &loc);
}
=head1 NAME
RT::Interface::CLI - helper functions for creating a commandline RT interface
=head1 SYNOPSIS
use lib "/path/to/rt/libraries/";
use RT::Interface::CLI qw(CleanEnv
GetCurrentUser GetMessageContent loc);
#Clean out all the nasties from the environment
CleanEnv();
#let's talk to RT'
use RT;
#Load RT's config file
RT::LoadConfig();
# Connect to the database. set up loggign
RT::Init();
#Get the current user all loaded
my $CurrentUser = GetCurrentUser();
print loc('Hello!'); # Synonym of $CuurentUser->loc('Hello!');
=head1 DESCRIPTION
=head1 METHODS
=begin testing
ok(require RT::Interface::CLI);
=end testing
=cut
=head2 CleanEnv
Removes some of the nastiest nasties from the user\'s environment.
=cut
sub CleanEnv {
$ENV{'PATH'} = '/bin:/usr/bin'; # or whatever you need
$ENV{'CDPATH'} = '' if defined $ENV{'CDPATH'};
$ENV{'SHELL'} = '/bin/sh' if defined $ENV{'SHELL'};
$ENV{'ENV'} = '' if defined $ENV{'ENV'};
$ENV{'IFS'} = '' if defined $ENV{'IFS'};
}
{
my $CurrentUser; # shared betwen GetCurrentUser and loc
# {{{ sub GetCurrentUser
=head2 GetCurrentUser
Figures out the uid of the current user and returns an RT::CurrentUser object
loaded with that user. if the current user isn't found, returns a copy of RT::Nobody.
=cut
sub GetCurrentUser {
require RT::CurrentUser;
#Instantiate a user object
my $Gecos= ($^O eq 'MSWin32') ? Win32::LoginName() : (getpwuid($<))[0];
#If the current user is 0, then RT will assume that the User object
#is that of the currentuser.
$CurrentUser = new RT::CurrentUser();
$CurrentUser->LoadByGecos($Gecos);
unless ($CurrentUser->Id) {
$RT::Logger->debug("No user with a unix login of '$Gecos' was found. ");
}
return($CurrentUser);
}
# }}}
# {{{ sub loc
=head2 loc
Synonym of $CurrentUser->loc().
=cut
sub loc {
die "No current user yet" unless $CurrentUser ||= RT::CurrentUser->new;
return $CurrentUser->loc(@_);
}
# }}}
}
# {{{ sub GetMessageContent
=head2 GetMessageContent
Takes two arguments a source file and a boolean "edit". If the source file
is undef or "", assumes an empty file. Returns an edited file as an
array of lines.
=cut
sub GetMessageContent {
my %args = ( Source => undef,
Content => undef,
Edit => undef,
CurrentUser => undef,
@_);
my $source = $args{'Source'};
my $edit = $args{'Edit'};
my $currentuser = $args{'CurrentUser'};
my @lines;
use File::Temp qw/ tempfile/;
#Load the sourcefile, if it's been handed to us
if ($source) {
open (SOURCE, "<$source");
@lines = (<SOURCE>);
close (SOURCE);
}
elsif ($args{'Content'}) {
@lines = split('\n',$args{'Content'});
}
#get us a tempfile.
my ($fh, $filename) = tempfile();
#write to a tmpfile
for (@lines) {
print $fh $_;
}
close ($fh);
#Edit the file if we need to
if ($edit) {
unless ($ENV{'EDITOR'}) {
$RT::Logger->crit('No $EDITOR variable defined'. "\n");
return undef;
}
system ($ENV{'EDITOR'}, $filename);
}
open (READ, "<$filename");
my @newlines = (<READ>);
close (READ);
unlink ($filename) unless (debug());
return(\@newlines);
}
# }}}
# {{{ sub debug
sub debug {
my $val = shift;
my ($debug);
if ($val) {
$RT::Logger->debug($val."\n");
if ($debug) {
print STDERR "$val\n";
}
}
if ($debug) {
return(1);
}
}
# }}}
eval "require RT::Interface::CLI_Vendor";
die $@ if ($@ && $@ !~ qr{^Can't locate RT/Interface/CLI_Vendor.pm});
eval "require RT::Interface::CLI_Local";
die $@ if ($@ && $@ !~ qr{^Can't locate RT/Interface/CLI_Local.pm});
1;
|
