#
# COPYRIGHT:
#
-# This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC
+# This software is Copyright (c) 1996-2016 Best Practical Solutions, LLC
# <sales@bestpractical.com>
#
# (Except where explicitly superseded by other copyright notices)
#
# END BPS TAGGED BLOCK }}}
-use strict;
-
-use RT;
package RT::Interface::CLI;
+use strict;
+use warnings;
+use RT::Base;
-
-BEGIN {
- use base 'Exporter';
- use vars qw ($VERSION @EXPORT @EXPORT_OK %EXPORT_TAGS);
-
- # set the version for version checking
- $VERSION = do { my @r = (q$Revision: 1.1.1.9 $ =~ /\d+/g); sprintf "%d."."%02d" x $#r, @r }; # must be all one line, for MakeMaker
-
- # your exported package globals go here,
- # as well as any optionally exported functions
- @EXPORT_OK = qw(&CleanEnv
- &GetCurrentUser &GetMessageContent &debug &loc);
-}
+use base 'Exporter';
+our @EXPORT_OK = qw(CleanEnv GetCurrentUser debug loc Init);
=head1 NAME
=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();
+ use lib "/opt/rt4/local/lib", "/opt/rt4/lib";
- #let's talk to RT'
- use RT;
+ use RT::Interface::CLI qw(GetCurrentUser Init loc);
- #Load RT's config file
- RT::LoadConfig();
+ # Process command-line arguments, load the configuration, and connect
+ # to the database
+ Init();
- # Connect to the database. set up loggign
- RT::Init();
-
- #Get the current user all loaded
+ # Get the current user all loaded
my $CurrentUser = GetCurrentUser();
- print loc('Hello!'); # Synonym of $CuurentUser->loc('Hello!');
+ print loc('Hello!'); # Synonym of $CurrentUser->loc('Hello!');
=head1 DESCRIPTION
=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
sub CleanEnv {
+ RT->Deprecated( Remove => "4.4" );
+
$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'};
+ $ENV{'IFS'} = '' if defined $ENV{'IFS'};
}
my $CurrentUser; # shared betwen GetCurrentUser and loc
-# {{{ sub GetCurrentUser
=head2 GetCurrentUser
=cut
sub GetCurrentUser {
-
+
require RT::CurrentUser;
-
+
#Instantiate a user object
-
- my $Gecos= ($^O eq 'MSWin32') ? Win32::LoginName() : (getpwuid($<))[0];
+
+ my $Gecos= (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. ");
+ $RT::Logger->error("No user with a GECOS (unix login) of '$Gecos' was found.");
}
return($CurrentUser);
}
-# }}}
-
-
-# {{{ sub loc
=head2 loc
die "No current user yet" unless $CurrentUser ||= RT::CurrentUser->new;
return $CurrentUser->loc(@_);
}
-# }}}
}
+sub debug {
+ RT->Deprecated( Remove => "4.4", Instead => '$RT::Logger->debug' );
+ $RT::Logger->debug(@_);
+}
+
+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'
+ ),
+ );
+}
-# {{{ sub GetMessageContent
+=head2 Init
-=head2 GetMessageContent
+A shim for L<Getopt::Long/GetOptions> which automatically adds a
+C<--help> option if it is not supplied. It then calls L<RT/LoadConfig>
+and L<RT/Init>.
-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.
+It sets the C<LogToSTDERR> setting to C<warning>, to ensure that the
+user sees all relevant warnings. It also adds C<--quiet> and
+C<--verbose> options, which adjust the C<LogToSTDERR> value to C<error>
+or C<debug>, respectively.
=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);
+sub Init {
+ require Getopt::Long;
+ require Pod::Usage;
+
+ my %exists;
+ my @args;
+ my $hash;
+ if (ref $_[0]) {
+ $hash = shift(@_);
+ for (@_) {
+ m/^([a-zA-Z0-9-]+)/;
+ $exists{$1}++;
+ push @args, $_ => \($hash->{$1});
+ }
+ } else {
+ $hash = {};
+ @args = @_;
+ while (@_) {
+ my $key = shift(@_);
+ $exists{$key}++;
+ shift(@_);
+ }
}
- 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');
- return undef;
- }
- system ($ENV{'EDITOR'}, $filename);
- }
-
- open (READ, "<$filename");
- my @newlines = (<READ>);
- close (READ);
-
- unlink ($filename) unless (debug());
- return(\@newlines);
-
-}
-# }}}
+ push @args, "help|h!" => \($hash->{help})
+ unless $exists{help};
-# {{{ sub debug
+ push @args, "verbose|v!" => \($hash->{verbose})
+ unless $exists{verbose};
-sub debug {
- my $val = shift;
- my ($debug);
- if ($val) {
- $RT::Logger->debug($val);
- if ($debug) {
- print STDERR "$val\n";
- }
+ push @args, "quiet|q!" => \($hash->{quiet})
+ unless $exists{quiet};
+
+ my $ok = Getopt::Long::GetOptions( @args );
+ Pod::Usage::pod2usage(1) if not $ok and not defined wantarray;
+
+ return unless $ok;
+
+ Pod::Usage::pod2usage({ verbose => 2})
+ if not $exists{help} and $hash->{help};
+
+ require RT;
+ RT::LoadConfig();
+
+ if (not $exists{quiet} and $hash->{quiet}) {
+ RT->Config->Set(LogToSTDERR => "error");
+ } elsif (not $exists{verbose} and $hash->{verbose}) {
+ RT->Config->Set(LogToSTDERR => "debug");
+ } else {
+ RT->Config->Set(LogToSTDERR => "warning");
}
- if ($debug) {
- return(1);
- }
-}
-# }}}
+ RT::Init();
+ $| = 1;
+
+ return $ok;
+}
-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});
+RT::Base->_ImportOverlays();
1;
projects / freeside.git / blobdiff