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 } );
35 $scp->get("filename") or die $scp->{errstr};
36 $scp->put("filename") or die $scp->{errstr};
39 $scp->scp($source, $destination);
42 $scp = Net::SCP->new("hostname");
51 Simple wrappers around ssh and scp commands.
57 =item scp SOURCE, DESTINATION
59 Can be called either as a subroutine or a method; however, the subroutine
60 interface is depriciated.
62 Calls scp in batch mode, with the B<-B> B<-p> B<-q> and B<-r> options.
63 Returns false upon error, with a text error message accessable in
66 Returns false and sets the B<errstr> attribute if there is an error.
71 my $self = ref($_[0]) ? shift : {};
72 my($src, $dest, $interact) = @_;
74 $flags .= 'r' unless &_islocal($src) && ! -d $src;
75 my @cmd = ( $scp, $flags, $src, $dest );
76 if ( ( defined($interact) && $interact )
77 || ( defined($self->{interact}) && $self->{interact} ) ) {
78 print join(' ', @cmd), "\n";
80 $self->{errstr} = "User declined";
86 my($reader, $writer, $error ) =
87 ( new IO::Handle, new IO::Handle, new IO::Handle );
88 $writer->autoflush(1);# $error->autoflush(1);
89 my $pid = open3($writer, $reader, $error, @cmd );
92 my $errstr = join('', <$error>);
93 #chomp(my $errstr = <$error>);
94 $self->{errstr} = $errstr;
101 =item iscp SOURCE, DESTINATION
103 Can be called either as a subroutine or a method; however, the subroutine
104 interface is depriciated.
106 Prints the scp command to be execute, waits for the user to confirm, and
107 (optionally) executes scp, with the B<-p> and B<-r> flags.
109 Returns false and sets the B<errstr> attribute if there is an error.
116 $self->{'interact'} = 1;
124 print "Proceed [y/N]:";
125 my $x = scalar(<STDIN>);
139 =item new HOSTNAME [ USER ] | HASHREF
141 This is the constructor for a new Net::SCP object. You must specify a
142 hostname, and may optionally provide a user. Alternatively, you may pass a
143 hashref of named params, with the following keys:
148 cwd - current working directory on remote server
154 my $class = ref($proto) || $proto;
161 'user' => ( scalar(@_) ? shift : '' ),
166 bless($self, $class);
171 Compatibility method. Optionally sets the user.
176 my($self, $user) = @_;
177 $self->{'user'} = $user if $user;
182 Sets the cwd (used for a subsequent get or put request without a full pathname).
187 my($self, $cwd) = @_;
188 $self->{'cwd'} = $cwd || '/';
191 =item get REMOTE_FILE [, LOCAL_FILE]
193 Uses scp to transfer REMOTE_FILE from the remote host. If a local filename is
194 omitted, uses the basename of the remote file.
199 my($self, $remote, $local) = @_;
200 $remote = $self->{'cwd'}. "/$remote" if $self->{'cwd'} && $remote !~ /^\//;
201 $local ||= basename($remote);
202 my $source = $self->{'host'}. ":$remote";
203 $source = $self->{'user'}. '@'. $source if $self->{'user'};
209 Returns the size in bytes for the given file as stored on the remote server.
210 Returns 0 on error, and sets the B<errstr> attribute. In the case of an actual
211 zero-length file on the remote server, the special value '0e0' is returned,
212 which evaluates to zero when used as a number, but is true.
214 (Implementation note: An ssh connection is established to the remote machine
215 and wc is used to determine the file size.)
220 my($self, $file) = @_;
221 $file = $self->{'cwd'}. "/$file" if $self->{'cwd'} && $file !~ /^\//;
222 my $host = $self->{'host'};
223 $host = $self->{'user'}. '@'. $host if $self->{'user'};
224 my($reader, $writer, $error ) =
225 ( new IO::Handle, new IO::Handle, new IO::Handle );
226 $writer->autoflush(1);# $error->autoflush(1);
227 #sshopen2($host, $reader, $writer, 'wc', '-c ', shell_quote($file) );
229 sshopen3($host, $writer, $reader, $error, 'wc', '-c ', shell_quote($file) );
232 chomp(my $errstr = <$error>);
233 $self->{errstr} = $errstr || "wc exited with status ". $?>>8;
236 chomp( my $size = <$reader> || 0 );
237 if ( $size =~ /^\s*(\d+)/ ) {
240 $self->{errstr} = "unparsable output from remote wc: $size";
246 =item put LOCAL_FILE [, REMOTE_FILE]
248 Uses scp to trasnfer LOCAL_FILE to the remote host. If a remote filename is
249 omitted, uses the basename of the local file.
254 my($self, $local, $remote) = @_;
255 $remote ||= basename($local);
256 $remote = $self->{'cwd'}. "/$remote" if $self->{'cwd'} && $remote !~ /^\//;
257 my $dest = $self->{'host'}. ":$remote";
258 $dest = $self->{'user'}. '@'. $dest if $self->{'user'};
259 warn "scp $local $dest\n";
265 Compatibility method: does nothing; returns true.
275 Ivan Kohler <ivan-netscp_pod@420.am>
276 Anthony Deaver <bishop@projectmagnus.org>
278 Thanks to Jon Gunnip <jon@soundbite.com> for fixing a bug with size().
282 Still has no-OO cruft.
284 In order to work around some problems with commercial SSH2, if the source file
285 is on the local system, and is not a directory, the B<-r> flag is omitted.
287 It's probably better just to use SSH1 or OpenSSH <http://www.openssh.com/>
289 The Net::FTP-style OO stuff is kinda lame. And incomplete.