4 use vars qw($VERSION @ISA @EXPORT_OK $scp);
8 use String::ShellQuote;
10 use Net::SSH qw(sshopen3);
14 @EXPORT_OK = qw( scp iscp );
21 Net::SCP - Perl extension for secure copy protocol
26 use Net::SCP qw(scp iscp);
27 scp($source, $destination);
28 iscp($source, $destination); #shows command, asks for confirmation, and
29 #allows user to type a password on tty
32 $scp = Net::SCP->new( "hostname", "username" );
34 $scp = Net::SCP->new( { "host"=>$hostname, "user"=>$username } );
40 $scp->get("filename") or die $scp->{errstr};
41 $scp->put("filename") or die $scp->{errstr};
44 $scp = Net::SCP->new("hostname");
53 Simple wrappers around ssh and scp commands.
59 =item scp SOURCE, DESTINATION
61 Can be called either as a subroutine or a method; however, the subroutine
62 interface is depriciated.
64 Calls scp in batch mode, with the B<-B> B<-p> B<-q> and B<-r> options.
65 Returns false upon error, with a text error message accessable in
68 Returns false and sets the B<errstr> attribute if there is an error.
73 my $self = ref($_[0]) ? shift : {};
74 my($src, $dest, $interact) = @_;
76 $flags .= 'r' unless &_islocal($src) && ! -d $src;
77 my @cmd = ( $scp, $flags, $src, $dest );
78 if ( ( defined($interact) && $interact )
79 || ( defined($self->{interact}) && $self->{interact} ) ) {
80 print join(' ', @cmd), "\n";
82 $self->{errstr} = "User declined";
88 my($reader, $writer, $error ) =
89 ( new IO::Handle, new IO::Handle, new IO::Handle );
90 $writer->autoflush(1);# $error->autoflush(1);
91 my $pid = open3($writer, $reader, $error, @cmd );
94 chomp(my $errstr = <$error>);
95 $self->{errstr} = $errstr;
102 =item iscp SOURCE, DESTINATION
104 Can be called either as a subroutine or a method; however, the subroutine
105 interface is depriciated.
107 Prints the scp command to be execute, waits for the user to confirm, and
108 (optionally) executes scp, with the B<-p> and B<-r> flags.
110 Returns false and sets the B<errstr> attribute if there is an error.
117 $self->set( 'interact' => 1 );
125 print "Proceed [y/N]:";
126 my $x = scalar(<STDIN>);
140 =item new HOSTNAME [ USER ] | HASHREF
142 This is the constructor for a new Net::SCP object. You must specify a
143 hostname, and may optionally provide a user. Alternatively, you may pass a
144 hashref of named params, with the following keys:
150 cwd - current working directory on remote server
156 my $class = ref($proto) || $proto;
163 'user' => ( scalar(@_) ? shift : '' ),
169 bless($self, $class);
174 Compatibility method. Optionally sets the user.
179 my($self, $user) = @_;
180 $self->{'user'} = $user;
185 Sets the cwd (used for a subsequent get or put request without a full pathname).
190 my($self, $cwd) = @_;
191 $self->{'cwd'} = $cwd || '/';
194 =item get REMOTE_FILE [, LOCAL_FILE]
196 Uses scp to transfer REMOTE_FILE from the remote host. If a local filename is
197 omitted, uses the basename of the remote file.
202 my($self, $remote, $local) = @_;
203 $remote = $self->{'cwd'}. "/$remote" if $self->{'cwd'} && $remote !~ /^\//;
204 $local ||= basename($remote);
205 my $source = $self->{'host'}. ":$remote";
206 $source = $self->{'user'}. '@'. $source if $self->{'user'};
212 Returns the size in bytes for the given file as stored on the remote server.
213 Returns 0 on error, and sets the B<errstr> attribute. In the case of an actual
214 zero-length file on the remote server, the special value '0e0' is returned,
215 which evaluates to zero when used as a number, but is true.
217 (Implementation note: An ssh connection is established to the remote machine
218 and wc is used to determine the file size.)
223 my($self, $file) = @_;
224 $file = $self->{'cwd'}. "/$file" if $self->{'cwd'} && $file !~ /^\//;
225 my $host = $self->{'host'};
226 $host = $self->{'user'}. '@'. $host if $self->{'user'};
227 my($reader, $writer, $error ) =
228 ( new IO::Handle, new IO::Handle, new IO::Handle );
229 $writer->autoflush(1);# $error->autoflush(1);
230 #sshopen2($host, $reader, $writer, 'wc', '-c ', shell_quote($file) );
232 sshopen3($host, $writer, $reader, $error, 'wc', '-c ', shell_quote($file) );
235 chomp(my $errstr = <$error>);
236 $self->{errstr} = $errstr || "wc exited with status ". $?>>8;
239 chomp( my $size = <$reader> || 0 );
240 if ( $size =~ /^\s*(\d+)/ ) {
243 $self->{errstr} = "unparsable output from remote wc: $size";
249 =item put LOCAL_FILE [, REMOTE_FILE]
251 Uses scp to trasnfer LOCAL_FILE to the remote host. If a remote filename is
252 omitted, uses the basename of the local file.
257 my($self, $local, $remote) = @_;
258 $remote ||= basename($local);
259 $remote = $self->{'cwd'}. "/$remote" if $self->{'cwd'} && $remote !~ /^\//;
260 my $dest = $self->{'host'}. ":$remote";
261 $dest = $self->{'user'}. '@'. $dest if $self->{'user'};
262 warn "scp $local $dest\n";
268 Compatibility method: does nothing; returns true.
278 Ivan Kohler <ivan-netscp_pod@420.am>
279 Anthony Deaver <bishop@projectmagnus.org>
281 Thanks to Jon Gunnip <jon@soundbite.com> for fixing a bug with size().
285 Still has no-OO cruft.
287 In order to work around some problems with commercial SSH2, if the source file
288 is on the local system, and is not a directory, the B<-r> flag is omitted.
290 It's probably better just to use SSH1 or OpenSSH <http://www.openssh.com/>
292 The Net::FTP-style OO stuff is kinda lame. And incomplete.