1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2005 Best Practical Solutions, LLC
6 # <jesse@bestpractical.com>
8 # (Except where explicitly superseded by other copyright notices)
13 # This work is made available to you under the terms of Version 2 of
14 # the GNU General Public License. A copy of that license should have
15 # been provided with this software, but in any event can be snarfed
18 # This work is distributed in the hope that it will be useful, but
19 # WITHOUT ANY WARRANTY; without even the implied warranty of
20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 # General Public License for more details.
23 # You should have received a copy of the GNU General Public License
24 # along with this program; if not, write to the Free Software
25 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28 # CONTRIBUTION SUBMISSION POLICY:
30 # (The following paragraph is not intended to limit the rights granted
31 # to you to modify and distribute this software under the terms of
32 # the GNU General Public License and is only of importance to you if
33 # you choose to contribute your changes and enhancements to the
34 # community by submitting them to Best Practical Solutions, LLC.)
36 # By intentionally submitting any modifications, corrections or
37 # derivatives to this work, or any other work intended for use with
38 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
39 # you are the copyright holder for those contributions and you grant
40 # Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
41 # royalty-free, perpetual, license to use, copy, create derivative
42 # works based on those contributions, and sublicense and distribute
43 # those contributions and any derivatives thereof.
45 # END BPS TAGGED BLOCK }}}
49 package RT::Interface::CLI;
55 use vars qw ($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
57 # set the version for version checking
58 $VERSION = do { my @r = (q$Revision: 1.1.1.3 $ =~ /\d+/g); sprintf "%d."."%02d" x $#r, @r }; # must be all one line, for MakeMaker
62 # your exported package globals go here,
63 # as well as any optionally exported functions
64 @EXPORT_OK = qw(&CleanEnv
65 &GetCurrentUser &GetMessageContent &debug &loc);
70 RT::Interface::CLI - helper functions for creating a commandline RT interface
74 use lib "/path/to/rt/libraries/";
76 use RT::Interface::CLI qw(CleanEnv
77 GetCurrentUser GetMessageContent loc);
79 #Clean out all the nasties from the environment
85 #Load RT's config file
88 # Connect to the database. set up loggign
91 #Get the current user all loaded
92 my $CurrentUser = GetCurrentUser();
94 print loc('Hello!'); # Synonym of $CuurentUser->loc('Hello!');
103 ok(require RT::Interface::CLI);
112 Removes some of the nastiest nasties from the user\'s environment.
117 $ENV{'PATH'} = '/bin:/usr/bin'; # or whatever you need
118 $ENV{'CDPATH'} = '' if defined $ENV{'CDPATH'};
119 $ENV{'SHELL'} = '/bin/sh' if defined $ENV{'SHELL'};
120 $ENV{'ENV'} = '' if defined $ENV{'ENV'};
121 $ENV{'IFS'} = '' if defined $ENV{'IFS'};
129 my $CurrentUser; # shared betwen GetCurrentUser and loc
131 # {{{ sub GetCurrentUser
133 =head2 GetCurrentUser
135 Figures out the uid of the current user and returns an RT::CurrentUser object
136 loaded with that user. if the current user isn't found, returns a copy of RT::Nobody.
142 require RT::CurrentUser;
144 #Instantiate a user object
146 my $Gecos= ($^O eq 'MSWin32') ? Win32::LoginName() : (getpwuid($<))[0];
148 #If the current user is 0, then RT will assume that the User object
149 #is that of the currentuser.
151 $CurrentUser = new RT::CurrentUser();
152 $CurrentUser->LoadByGecos($Gecos);
154 unless ($CurrentUser->Id) {
155 $RT::Logger->debug("No user with a unix login of '$Gecos' was found. ");
158 return($CurrentUser);
167 Synonym of $CurrentUser->loc().
172 die "No current user yet" unless $CurrentUser ||= RT::CurrentUser->new;
173 return $CurrentUser->loc(@_);
180 # {{{ sub GetMessageContent
182 =head2 GetMessageContent
184 Takes two arguments a source file and a boolean "edit". If the source file
185 is undef or "", assumes an empty file. Returns an edited file as an
190 sub GetMessageContent {
191 my %args = ( Source => undef,
194 CurrentUser => undef,
196 my $source = $args{'Source'};
198 my $edit = $args{'Edit'};
200 my $currentuser = $args{'CurrentUser'};
203 use File::Temp qw/ tempfile/;
205 #Load the sourcefile, if it's been handed to us
207 open (SOURCE, "<$source");
211 elsif ($args{'Content'}) {
212 @lines = split('\n',$args{'Content'});
215 my ($fh, $filename) = tempfile();
223 #Edit the file if we need to
226 unless ($ENV{'EDITOR'}) {
227 $RT::Logger->crit('No $EDITOR variable defined'. "\n");
230 system ($ENV{'EDITOR'}, $filename);
233 open (READ, "<$filename");
234 my @newlines = (<READ>);
237 unlink ($filename) unless (debug());
250 $RT::Logger->debug($val."\n");
252 print STDERR "$val\n";
263 eval "require RT::Interface::CLI_Vendor";
264 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Interface/CLI_Vendor.pm});
265 eval "require RT::Interface::CLI_Local";
266 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Interface/CLI_Local.pm});