-# $Header: /home/cvs/cvsroot/freeside/rt/lib/RT/Interface/CLI.pm,v 1.1 2002-08-12 06:17:08 ivan Exp $
-# RT is (c) 1996-2001 Jesse Vincent <jesse@fsck.com>
+# BEGIN BPS TAGGED BLOCK {{{
+#
+# COPYRIGHT:
+#
+# This software is Copyright (c) 1996-2013 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 }}}
package RT::Interface::CLI;
-
use strict;
+use warnings;
+use RT;
-
-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.1 $ =~ /\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 &LoadConfig &DBConnect
- &GetCurrentUser &GetMessageContent &debug);
-}
+use base 'Exporter';
+our @EXPORT_OK = qw(CleanEnv GetCurrentUser GetMessageContent debug loc);
=head1 NAME
=head1 SYNOPSIS
- use lib "!!RT_LIB_PATH!!";
- use lib "!!RT_ETC_PATH!!";
+ use lib "/path/to/rt/libraries/";
- use RT::Interface::CLI qw(CleanEnv LoadConfig DBConnect
- GetCurrentUser GetMessageContent);
+ use RT::Interface::CLI qw(CleanEnv
+ GetCurrentUser GetMessageContent loc);
#Clean out all the nasties from the environment
CleanEnv();
- #Load etc/config.pm and drop privs
- LoadConfig();
+ #let's talk to RT'
+ use RT;
- #Connect to the database and get RT::SystemUser and RT::Nobody loaded
- DBConnect();
+ #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::TestHarness);
-ok(require RT::Interface::CLI);
-
-=end testing
=cut
=head2 CleanEnv
-Removes some of the nastiest nasties from the user\'s environment.
+Removes some of the nastiest nasties from the user's environment.
=cut
-=head2 LoadConfig
-
-Loads RT's config file and then drops setgid privileges.
-
-=cut
-
-sub LoadConfig {
-
- #This drags in RT's config.pm
- use config;
-
-}
+{
+ my $CurrentUser; # shared betwen GetCurrentUser and loc
-=head2 DBConnect
-
- Calls RT::Init, which creates a database connection and then creates $RT::Nobody
- and $RT::SystemUser
-
-=cut
-
-
-sub DBConnect {
- use RT;
- RT::Init();
-}
-
-
-
-# {{{ sub GetCurrentUser
=head2 GetCurrentUser
loaded with that user. if the current user isn't found, returns a copy of RT::Nobody.
=cut
+
sub GetCurrentUser {
- my ($Gecos, $CurrentUser);
-
require RT::CurrentUser;
#Instantiate a user object
- $Gecos=(getpwuid($<))[0];
+ 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 = RT::CurrentUser->new();
$CurrentUser->LoadByGecos($Gecos);
unless ($CurrentUser->Id) {
$RT::Logger->debug("No user with a unix login of '$Gecos' was found. ");
}
+
return($CurrentUser);
}
-# }}}
-# {{{ sub GetMessageContent
+
+
+=head2 loc
+
+ Synonym of $CurrentUser->loc().
+
+=cut
+
+sub loc {
+ die "No current user yet" unless $CurrentUser ||= RT::CurrentUser->new;
+ return $CurrentUser->loc(@_);
+}
+
+}
+
+
=head2 GetMessageContent
#Load the sourcefile, if it's been handed to us
if ($source) {
- open (SOURCE, "<$source");
- @lines = (<SOURCE>);
- close (SOURCE);
+ open( SOURCE, '<', $source ) or die $!;
+ @lines = (<SOURCE>) or die $!;
+ close (SOURCE) or die $!;
}
elsif ($args{'Content'}) {
@lines = split('\n',$args{'Content'});
for (@lines) {
print $fh $_;
}
- close ($fh);
+ close ($fh) or die $!;
#Edit the file if we need to
if ($edit) {
unless ($ENV{'EDITOR'}) {
- $RT::Logger->crit('No $EDITOR variable defined'. "\n");
+ $RT::Logger->crit('No $EDITOR variable defined');
return undef;
}
system ($ENV{'EDITOR'}, $filename);
}
- open (READ, "<$filename");
+ open( READ, '<', $filename ) or die $!;
my @newlines = (<READ>);
- close (READ);
+ close (READ) or die $!;
unlink ($filename) unless (debug());
return(\@newlines);
}
-# }}}
-# {{{ sub debug
sub debug {
my $val = shift;
my ($debug);
if ($val) {
- $RT::Logger->debug($val."\n");
+ $RT::Logger->debug($val);
if ($debug) {
print STDERR "$val\n";
}
}
}
-# }}}
+sub ShowHelp {
+ my $self = shift;
+ my %args = @_;
+ require Pod::Usage;
+ Pod::Usage::pod2usage(
+ -message => $args{'Message'},
+ -exitval => $args{'ExitValue'} || 0,
+ -verbose => 99,
+ -sections => $args{'Sections'} || ($args{'ExitValue'}
+ ? 'NAME|USAGE'
+ : 'NAME|USAGE|OPTIONS|DESCRIPTION'
+ ),
+ );
+}
+RT::Base->_ImportOverlays();
1;