0.04 Added ssh_cmd

[Net-SSH.git] / SSH.pm

diff --git a/SSH.pm b/SSH.pm
index 81ee35b..990fa20 100644 (file)
--- a/SSH.pm
+++ b/SSH.pm
@@ -1,14 +1,17 @@
 package Net::SSH;
 
 use strict;
-use vars qw($VERSION @ISA @EXPORT_OK $ssh);
+use vars qw($VERSION @ISA @EXPORT_OK $ssh $DEBUG);
 use Exporter;
+use IO::File;
 use IPC::Open2;
 use IPC::Open3;
 
 @ISA = qw(Exporter);
-@EXPORT_OK = qw( ssh issh sshopen2 sshopen3 );
-$VERSION = '0.01';
+@EXPORT_OK = qw( ssh issh ssh_cmd sshopen2 sshopen3 );
+$VERSION = '0.04';
+
+$DEBUG = 0;
 
 $ssh = "ssh";
 
@@ -24,9 +27,11 @@ Net::SSH - Perl extension for secure shell
 
   issh('user@hostname', $command);
 
+  ssh_cmd('user@hostname', $command);
+
   sshopen2('user@hostname', $reader, $writer, $command);
 
-  sshopen3('user@hostname', $reader, $writer, $error, $command);
+  sshopen3('user@hostname', $writer, $reader, $error, $command);
 
 =head1 DESCRIPTION
 
@@ -44,7 +49,9 @@ Calls ssh in batch mode.
 
 sub ssh {
   my($host, @command) = @_;
-  my @cmd = ($ssh, '-o', 'BatchMode yes', $host, @command);
+  my @cmd = ($ssh, '-o', 'BatchMode=yes', $host, @command);
+  warn "[Net::SSH::ssh] executing ". join(' ', @cmd). "\n"
+    if $DEBUG;
   system(@cmd);
 }
 
@@ -64,6 +71,34 @@ sub issh {
   }
 }
 
+=item ssh_cmd [USER@]HOST, COMMAND [, ARGS ... ]
+
+Calls ssh in batch mode.  Dies if data occurs on the error stream.  Warns
+of data on the output stream.
+
+=cut
+
+sub ssh_cmd {
+  my($host, @command) = @_;
+
+  my $reader = IO::File->new();
+  my $writer = IO::File->new();
+  my $error = IO::File->new();
+
+  sshopen3( $host, $reader, $writer, $error, @command ) or die $!;
+
+  local $/ = undef;
+    my $output_stream = <$writer>;
+  my $error_stream = <$error>;
+  if ( length $error_stream ) {
+    die "[Net:SSH::ssh_cmd] STDERR $error_stream";
+  }
+  if ( length $output_stream ) {
+    warn "[Net::SSH::ssh_cmd] STDOUT $output_stream";
+  }
+
+}
+
 =item sshopen2 [USER@]HOST, READER, WRITER, COMMAND [, ARGS ... ]
 
 Connects the supplied filehandles to the ssh process (in batch mode).
@@ -72,7 +107,7 @@ Connects the supplied filehandles to the ssh process (in batch mode).
 
 sub sshopen2 {
   my($host, $reader, $writer, @command) = @_;
-  open2($reader, $writer, $ssh, '-o', 'Batchmode yes', $host, @command);
+  open2($reader, $writer, $ssh, '-o', 'BatchMode=yes', $host, @command);
 }
 
 =item sshopen3 HOST, WRITER, READER, ERROR, COMMAND [, ARGS ... ]
@@ -83,7 +118,7 @@ Connects the supplied filehandles to the ssh process (in batch mode).
 
 sub sshopen3 {
   my($host, $writer, $reader, $error, @command) = @_;
-  open3($writer, $reader, $error, $ssh, '-o', 'Batchmode yes', $host, @command);
+  open3($writer, $reader, $error, $ssh, '-o', 'BatchMode=yes', $host, @command);
 }
 
 sub _yesno {
@@ -94,19 +129,63 @@ sub _yesno {
 
 =back
 
+=head1 EXAMPLE
+
+  use Net::SSH qw(sshopen2);
+  use strict;
+
+  my $user = "username";
+  my $host = "hostname";
+  my $cmd = "command";
+
+  sshopen2("$user\@$host", *READER, *WRITER, "$cmd") || die "ssh: $!";
+
+  while (<READER>) {
+      chomp();
+      print "$_\n";
+  }
+
+  close(READER);
+  close(WRITER);
+
+=head1 FREQUENTLY ASKED QUESTIONS
+
+Q: How do you supply a password to connect with ssh within a perl script
+using the Net::SSH module?
+
+A: You don't.  Use RSA or DSA keys.  See the ssh-keygen(1) manpage.
+
+Q: My script is "leaking" ssh processes.
+
+A: See L<perlfaq8/"How do I avoid zombies on a Unix system">, L<IPC::Open2>,
+L<IPC::Open3> and L<perlfunc/waitpid>.
+
 =head1 AUTHOR
 
-Ivan Kohler <ivan-netssh@420.am>
+Ivan Kohler <ivan-netssh_pod@420.am>
+
+=head1 CREDITS
+
+ John Harrison <japh@in-ta.net> contributed an example for the documentation.
+
+=head1 COPYRIGHT
+
+Copyright (c) 2000 Ivan Kohler.
+Copyright (c) 2000 Silicon Interactive Software Design.
+Copyright (c) 2000 Freeside Internet Services, LLC
+All rights reserved.
+This program is free software; you can redistribute it and/or modify it under
+the same terms as Perl itself.
 
 =head1 BUGS
 
 Not OO.
 
-Look at IPC::Session?
+Look at IPC::Session (also fsh)
 
 =head1 SEE ALSO
 
-ssh(1), L<IPC::Open2>, L<IPC::Open3>
+ssh-keygen(1), ssh(1), L<IO::File>, L<IPC::Open2>, L<IPC::Open3>
 
 =cut