further detail OR->connect arguments, and document other bits

[scpubgit/Object-Remote.git] / lib / Object / Remote / Connector / SSH.pm

diff --git a/lib/Object/Remote/Connector/SSH.pm b/lib/Object/Remote/Connector/SSH.pm
index fcfb445..0e0d820 100644 (file)
--- a/lib/Object/Remote/Connector/SSH.pm
+++ b/lib/Object/Remote/Connector/SSH.pm
@@ -2,6 +2,7 @@ package Object::Remote::Connector::SSH;
 
 use Object::Remote::ModuleSender;
 use Object::Remote::Handle;
+use String::ShellQuote;
 use Moo;
 
 with 'Object::Remote::Role::Connector::PerlInterpreter';
@@ -14,27 +15,14 @@ has ssh_options => (is => 'ro', default => sub { [ '-A' ] });
 
 has ssh_command => (is => 'ro', default => sub { 'ssh' });
 
-#TODO properly integrate if this works
-BEGIN { $ENV{TERM} = 'dumb'; } 
-
-sub _escape_shell_arg { 
-    my ($self, $str) = (@_);
-    $str =~ s/((?:^|[^\\])(?:\\\\)*)'/$1\\'/g;
-    return "$str";
-}
-
-
 sub _build_ssh_perl_command {
   my ($self) = @_;
-  my $perl_command = join('', @{$self->perl_command});
-  
-  #TODO non-trivial to escape properly for ssh and shell
-  #this "works" but is not right, needs to be replaced
-  #after testing
+  my $perl_command = $self->perl_command;
+
   return [
     do { my $c = $self->ssh_command; ref($c) ? @$c : $c },
     @{$self->ssh_options}, $self->ssh_to,
-    $self->_escape_shell_arg($perl_command),
+    shell_quote(@$perl_command),
   ];
 }
 
@@ -42,7 +30,7 @@ sub final_perl_command { shift->ssh_perl_command }
 
 no warnings 'once';
 
-push @Object::Remote::Connection::Guess, sub { 
+push @Object::Remote::Connection::Guess, sub {
   for ($_[0]) {
     # 0-9 a-z _ - first char, those or . subsequent - hostnamish
     if (defined and !ref and /^(?:.*?\@)?[\w\-][\w\-\.]/) {
@@ -54,3 +42,43 @@ push @Object::Remote::Connection::Guess, sub {
 };
 
 1;
+
+=head1 NAME
+
+Object::Remote::Connector::SSH - A connector for SSH servers
+
+=head1 DESCRIPTION
+
+Used to create a connector that talks to an SSH server. Invoked by
+L<Object::Remote/connect> if the connection spec looks like a hostname or
+user@hostname combo.
+
+=head1 ARGUMENTS
+
+Inherits arguments from L<Object::Remote::Role::Connector::PerlInterpreter> and
+provides the following:
+
+=head2 ssh_to
+
+When invoked via L<Object::Remote/connect>, specified via the connection spec,
+and not overridable.
+
+String that contains hostname or user@hostname to connect to.
+
+=head2 ssh_options
+
+An arrayref containing a list of strings to be passed to L<IPC::Open3> with
+options to be passed specifically to the ssh client. Defaults to C<-A>.
+
+=head2 ssh_command
+
+A string or arrayref of strings with the ssh command to be run. Defaults to
+C<ssh>.
+
+=head2 ssh_perl_command
+
+An arrayref containing a list of strings to be passed to L<IPC::Open3> to open
+the perl process. Defaults to constructing an ssh client incantation with the
+other arguments here.
+
+=cut