1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2013 Best Practical Solutions, LLC
6 # <sales@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., 51 Franklin Street, Fifth Floor, Boston, MA
26 # 02110-1301 or visit their web page on the internet at
27 # http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
30 # CONTRIBUTION SUBMISSION POLICY:
32 # (The following paragraph is not intended to limit the rights granted
33 # to you to modify and distribute this software under the terms of
34 # the GNU General Public License and is only of importance to you if
35 # you choose to contribute your changes and enhancements to the
36 # community by submitting them to Best Practical Solutions, LLC.)
38 # By intentionally submitting any modifications, corrections or
39 # derivatives to this work, or any other work intended for use with
40 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
41 # you are the copyright holder for those contributions and you grant
42 # Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
43 # royalty-free, perpetual, license to use, copy, create derivative
44 # works based on those contributions, and sublicense and distribute
45 # those contributions and any derivatives thereof.
47 # END BPS TAGGED BLOCK }}}
52 package RT::Interface::CLI;
58 use vars qw ($VERSION @EXPORT @EXPORT_OK %EXPORT_TAGS);
60 # set the version for version checking
61 $VERSION = do { my @r = (q$Revision: 1.1.1.10 $ =~ /\d+/g); sprintf "%d."."%02d" x $#r, @r }; # must be all one line, for MakeMaker
63 # your exported package globals go here,
64 # as well as any optionally exported functions
65 @EXPORT_OK = qw(&CleanEnv
66 &GetCurrentUser &GetMessageContent &debug &loc);
71 RT::Interface::CLI - helper functions for creating a commandline RT interface
75 use lib "/path/to/rt/libraries/";
77 use RT::Interface::CLI qw(CleanEnv
78 GetCurrentUser GetMessageContent loc);
80 #Clean out all the nasties from the environment
86 #Load RT's config file
89 # Connect to the database. set up loggign
92 #Get the current user all loaded
93 my $CurrentUser = GetCurrentUser();
95 print loc('Hello!'); # Synonym of $CuurentUser->loc('Hello!');
108 Removes some of the nastiest nasties from the user\'s environment.
113 $ENV{'PATH'} = '/bin:/usr/bin'; # or whatever you need
114 $ENV{'CDPATH'} = '' if defined $ENV{'CDPATH'};
115 $ENV{'SHELL'} = '/bin/sh' if defined $ENV{'SHELL'};
116 $ENV{'ENV'} = '' if defined $ENV{'ENV'};
117 $ENV{'IFS'} = '' if defined $ENV{'IFS'};
125 my $CurrentUser; # shared betwen GetCurrentUser and loc
127 # {{{ sub GetCurrentUser
129 =head2 GetCurrentUser
131 Figures out the uid of the current user and returns an RT::CurrentUser object
132 loaded with that user. if the current user isn't found, returns a copy of RT::Nobody.
138 require RT::CurrentUser;
140 #Instantiate a user object
142 my $Gecos= ($^O eq 'MSWin32') ? Win32::LoginName() : (getpwuid($<))[0];
144 #If the current user is 0, then RT will assume that the User object
145 #is that of the currentuser.
147 $CurrentUser = new RT::CurrentUser();
148 $CurrentUser->LoadByGecos($Gecos);
150 unless ($CurrentUser->Id) {
151 $RT::Logger->debug("No user with a unix login of '$Gecos' was found. ");
154 return($CurrentUser);
163 Synonym of $CurrentUser->loc().
168 die "No current user yet" unless $CurrentUser ||= RT::CurrentUser->new;
169 return $CurrentUser->loc(@_);
176 # {{{ sub GetMessageContent
178 =head2 GetMessageContent
180 Takes two arguments a source file and a boolean "edit". If the source file
181 is undef or "", assumes an empty file. Returns an edited file as an
186 sub GetMessageContent {
187 my %args = ( Source => undef,
190 CurrentUser => undef,
192 my $source = $args{'Source'};
194 my $edit = $args{'Edit'};
196 my $currentuser = $args{'CurrentUser'};
199 use File::Temp qw/ tempfile/;
201 #Load the sourcefile, if it's been handed to us
203 open( SOURCE, '<', $source ) or die $!;
204 @lines = (<SOURCE>) or die $!;
205 close (SOURCE) or die $!;
207 elsif ($args{'Content'}) {
208 @lines = split('\n',$args{'Content'});
211 my ($fh, $filename) = tempfile();
217 close ($fh) or die $!;
219 #Edit the file if we need to
222 unless ($ENV{'EDITOR'}) {
223 $RT::Logger->crit('No $EDITOR variable defined');
226 system ($ENV{'EDITOR'}, $filename);
229 open( READ, '<', $filename ) or die $!;
230 my @newlines = (<READ>);
231 close (READ) or die $!;
233 unlink ($filename) unless (debug());
246 $RT::Logger->debug($val);
248 print STDERR "$val\n";
259 RT::Base->_ImportOverlays();