X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=rt%2Flib%2FRT%2FInterface%2FCLI.pm;h=ab90915930a65f30cc9a7dcf010efde64c88ad00;hp=5faa8ca083638802c18789c3c45271a91c2f8d52;hb=7322f2afedcc2f427e997d1535a503613a83f088;hpb=919e930aa9279b3c5cd12b593889cd6de79d67bf diff --git a/rt/lib/RT/Interface/CLI.pm b/rt/lib/RT/Interface/CLI.pm index 5faa8ca08..ab9091593 100644 --- a/rt/lib/RT/Interface/CLI.pm +++ b/rt/lib/RT/Interface/CLI.pm @@ -2,7 +2,7 @@ # # COPYRIGHT: # -# This software is Copyright (c) 1996-2015 Best Practical Solutions, LLC +# This software is Copyright (c) 1996-2016 Best Practical Solutions, LLC # # # (Except where explicitly superseded by other copyright notices) @@ -49,10 +49,11 @@ package RT::Interface::CLI; use strict; use warnings; -use RT; + +use RT::Base; use base 'Exporter'; -our @EXPORT_OK = qw(CleanEnv GetCurrentUser GetMessageContent debug loc); +our @EXPORT_OK = qw(CleanEnv GetCurrentUser debug loc Init); =head1 NAME @@ -60,27 +61,18 @@ our @EXPORT_OK = qw(CleanEnv GetCurrentUser GetMessageContent debug loc); =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 @@ -98,11 +90,13 @@ 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'}; } @@ -121,28 +115,26 @@ loaded with that user. if the current user isn't found, returns a copy of RT::N =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 = 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); } - - =head2 loc Synonym of $CurrentUser->loc(). @@ -156,82 +148,9 @@ sub loc { } - - -=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 ) or die $!; - @lines = () or die $!; - close (SOURCE) or die $!; - } - 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) or die $!; - - #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 ) or die $!; - my @newlines = (); - close (READ) or die $!; - - unlink ($filename) unless (debug()); - return(\@newlines); - -} - - - sub debug { - my $val = shift; - my ($debug); - if ($val) { - $RT::Logger->debug($val); - if ($debug) { - print STDERR "$val\n"; - } - } - if ($debug) { - return(1); - } + RT->Deprecated( Remove => "4.4", Instead => '$RT::Logger->debug' ); + $RT::Logger->debug(@_); } sub ShowHelp { @@ -249,6 +168,78 @@ sub ShowHelp { ); } +=head2 Init + +A shim for L which automatically adds a +C<--help> option if it is not supplied. It then calls L +and L. + +It sets the C setting to C, to ensure that the +user sees all relevant warnings. It also adds C<--quiet> and +C<--verbose> options, which adjust the C value to C +or C, respectively. + +=cut + +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(@_); + } + } + + push @args, "help|h!" => \($hash->{help}) + unless $exists{help}; + + push @args, "verbose|v!" => \($hash->{verbose}) + unless $exists{verbose}; + + 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"); + } + + RT::Init(); + + $| = 1; + + return $ok; +} + RT::Base->_ImportOverlays(); 1;