3 # Copyright (c) 1995-2003 Graham Barr <gbarr@pobox.com>. All rights reserved.
4 # This program is free software; you can redistribute it and/or
5 # modify it under the same terms as Perl itself.
7 # Documentation (at end) improved 1996 by Nathan Torkington <gnat@frii.com>.
14 use vars qw(@ISA $VERSION);
22 use Fcntl qw(O_WRONLY O_RDONLY O_APPEND O_CREAT O_TRUNC);
23 # use AutoLoader qw(AUTOLOAD);
25 $VERSION = "2.74"; # $Id: //depot/libnet/Net/FTP.pm#84 $
26 @ISA = qw(Exporter Net::Cmd IO::Socket::INET);
28 # Someday I will "use constant", when I am not bothered to much about
29 # compatability with older releases of perl
31 use vars qw($TELNET_IAC $TELNET_IP $TELNET_DM);
32 ($TELNET_IAC,$TELNET_IP,$TELNET_DM) = (255,244,242);
34 # Name is too long for AutoLoad, it clashes with pasv_xfer
35 sub pasv_xfer_unique {
36 my($sftp,$sfile,$dftp,$dfile) = @_;
37 $sftp->pasv_xfer($sfile,$dftp,$dfile,1);
41 # make a constant so code is fast'ish
42 my $is_os390 = $^O eq 'os390';
43 *trEBCDIC = sub () { $is_os390 }
47 # Having problems with AutoLoader
59 $peer=delete $arg{Host};
64 my $fire_type = undef;
66 if(exists($arg{Firewall}) || Net::Config->requires_firewall($peer))
68 $fire = $arg{Firewall}
70 || $NetConfig{ftp_firewall}
77 $fire_type = $arg{FirewallType}
78 || $ENV{FTP_FIREWALL_TYPE}
79 || $NetConfig{firewall_type}
84 my $ftp = $pkg->SUPER::new(PeerAddr => $peer,
85 PeerPort => $arg{Port} || 'ftp(21)',
86 LocalAddr => $arg{'LocalAddr'},
88 Timeout => defined $arg{Timeout}
93 ${*$ftp}{'net_ftp_host'} = $host; # Remote hostname
94 ${*$ftp}{'net_ftp_type'} = 'A'; # ASCII/binary/etc mode
95 ${*$ftp}{'net_ftp_blksize'} = abs($arg{'BlockSize'} || 10240);
97 ${*$ftp}{'net_ftp_localaddr'} = $arg{'LocalAddr'};
99 ${*$ftp}{'net_ftp_firewall'} = $fire
101 ${*$ftp}{'net_ftp_firewall_type'} = $fire_type
102 if(defined $fire_type);
104 ${*$ftp}{'net_ftp_passive'} = int
107 : exists $ENV{FTP_PASSIVE}
110 ? $NetConfig{ftp_ext_passive}
111 : $NetConfig{ftp_int_passive}; # Whew! :-)
113 $ftp->hash(exists $arg{Hash} ? $arg{Hash} : 0, 1024);
117 $ftp->debug(exists $arg{Debug} ? $arg{Debug} : undef);
119 unless ($ftp->response() == CMD_OK)
130 ## User interface methods
136 ${*$me}{'net_ftp_host'};
141 my $ftp = shift; # self
145 delete ${*$ftp}{'net_ftp_hash'};
148 ($h,$b) = (ref($h)? $h : \*STDERR, $b || 1024);
149 select((select($h), $|=1)[0]);
150 $b = 512 if $b < 512;
151 ${*$ftp}{'net_ftp_hash'} = [$h, $b];
164 sub ascii { shift->type('A',@_); }
165 sub binary { shift->type('I',@_); }
169 carp "TYPE E is unsupported, shall default to I";
175 carp "TYPE L is unsupported, shall default to I";
179 # Allow the user to send a command directly, BE CAREFUL !!
186 $ftp->command( uc $cmd, @_);
194 $ftp->command("SITE", @_);
203 # Server Y2K bug workaround
205 # sigh; some idiotic FTP servers use ("19%d",tm.tm_year) instead of
206 # ("%d",tm.tm_year+1900). This results in an extra digit in the
207 # string returned. To account for this we allow an optional extra
208 # digit in the year. Then if the first two digits are 19 we use the
209 # remainder, otherwise we subtract 1900 from the whole year.
211 $ftp->_MDTM($file) && $ftp->message =~ /((\d\d)(\d\d\d?))(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)/
212 ? timegm($8,$7,$6,$5,$4-1,$2 eq '19' ? $3 : ($1-1900))
220 if($ftp->supported("SIZE")) {
221 return $ftp->_SIZE($file)
222 ? ($ftp->message =~ /(\d+)\s*(bytes?\s*)?$/)[0]
225 elsif($ftp->supported("STAT")) {
228 unless $ftp->_STAT($file) && (@msg = $ftp->message) == 3;
230 foreach $line (@msg) {
231 return (split(/\s+/,$line))[4]
232 if $line =~ /^[-rwxSsTt]{10}/
236 my @files = $ftp->dir($file);
238 return (split(/\s+/,$1))[4]
239 if $files[0] =~ /^([-rwxSsTt]{10}.*)$/;
246 my($ftp,$user,$pass,$acct) = @_;
247 my($ok,$ruser,$fwtype);
249 unless (defined $user) {
252 my $rc = Net::Netrc->lookup(${*$ftp}{'net_ftp_host'});
254 ($user,$pass,$acct) = $rc->lpa()
258 $user ||= "anonymous";
261 $fwtype = ${*$ftp}{'net_ftp_firewall_type'}
262 || $NetConfig{'ftp_firewall_type'}
265 if ($fwtype && defined ${*$ftp}{'net_ftp_firewall'}) {
266 if ($fwtype == 1 || $fwtype == 7) {
267 $user .= '@' . ${*$ftp}{'net_ftp_host'};
272 my $rc = Net::Netrc->lookup(${*$ftp}{'net_ftp_firewall'});
274 my($fwuser,$fwpass,$fwacct) = $rc ? $rc->lpa() : ();
277 $user = join('@',$user,$fwuser,${*$ftp}{'net_ftp_host'});
278 $pass = $pass . '@' . $fwpass;
282 $user .= '@' . ${*$ftp}{'net_ftp_host'};
284 elsif ($fwtype == 6) {
285 $fwuser .= '@' . ${*$ftp}{'net_ftp_host'};
288 $ok = $ftp->_USER($fwuser);
290 return 0 unless $ok == CMD_OK || $ok == CMD_MORE;
292 $ok = $ftp->_PASS($fwpass || "");
294 return 0 unless $ok == CMD_OK || $ok == CMD_MORE;
296 $ok = $ftp->_ACCT($fwacct)
300 $ok = $ftp->command("SITE",${*$ftp}{'net_ftp_host'})->response;
302 elsif ($fwtype == 4) {
303 $ok = $ftp->command("OPEN",${*$ftp}{'net_ftp_host'})->response;
306 return 0 unless $ok == CMD_OK || $ok == CMD_MORE;
311 $ok = $ftp->_USER($user);
313 # Some dumb firewalls don't prefix the connection messages
314 $ok = $ftp->response()
315 if ($ok == CMD_OK && $ftp->code == 220 && $user =~ /\@/);
317 if ($ok == CMD_MORE) {
318 unless(defined $pass) {
321 my $rc = Net::Netrc->lookup(${*$ftp}{'net_ftp_host'}, $ruser);
323 ($ruser,$pass,$acct) = $rc->lpa()
326 $pass = '-anonymous@'
327 if (!defined $pass && (!defined($ruser) || $ruser =~ /^anonymous/o));
330 $ok = $ftp->_PASS($pass || "");
333 $ok = $ftp->_ACCT($acct)
334 if (defined($acct) && ($ok == CMD_MORE || $ok == CMD_OK));
336 if ($fwtype == 7 && $ok == CMD_OK && defined ${*$ftp}{'net_ftp_firewall'}) {
337 my($f,$auth,$resp) = _auth_id($ftp);
338 $ftp->authorize($auth,$resp) if defined($resp);
346 @_ == 2 or croak 'usage: $ftp->account( ACCT )';
349 $ftp->_ACCT($acct) == CMD_OK;
353 my($ftp,$auth,$resp) = @_;
355 unless(defined $resp)
359 $auth ||= eval { (getpwuid($>))[0] } || $ENV{NAME};
361 my $rc = Net::Netrc->lookup(${*$ftp}{'net_ftp_firewall'}, $auth)
362 || Net::Netrc->lookup(${*$ftp}{'net_ftp_firewall'});
364 ($auth,$resp) = $rc->lpa()
372 @_ >= 1 || @_ <= 3 or croak 'usage: $ftp->authorize( [AUTH [, RESP]])';
374 my($ftp,$auth,$resp) = &_auth_id;
376 my $ok = $ftp->_AUTH($auth || "");
378 $ok = $ftp->_RESP($resp || "")
379 if ($ok == CMD_MORE);
386 @_ == 3 or croak 'usage: $ftp->rename(FROM, TO)';
388 my($ftp,$from,$to) = @_;
398 my $oldval = ${*$ftp}{'net_ftp_type'};
401 unless (defined $type);
404 unless ($ftp->_TYPE($type,@_));
406 ${*$ftp}{'net_ftp_type'} = join(" ",$type,@_);
415 my $oldval = ${*$ftp}{'net_ftp_allo'};
418 unless (defined $size);
421 unless ($ftp->_ALLO($size,@_));
423 ${*$ftp}{'net_ftp_allo'} = join(" ",$size,@_);
432 send($ftp,pack("CCC", $TELNET_IAC, $TELNET_IP, $TELNET_IAC),MSG_OOB);
434 $ftp->command(pack("C",$TELNET_DM) . "ABOR");
436 ${*$ftp}{'net_ftp_dataconn'}->close()
437 if defined ${*$ftp}{'net_ftp_dataconn'};
441 $ftp->status == CMD_OK;
446 my($ftp,$remote,$local,$where) = @_;
448 my($loc,$len,$buf,$resp,$data);
451 my $localfd = ref($local) || ref(\$local) eq "GLOB";
453 ($local = $remote) =~ s#^.*/##
454 unless(defined $local);
456 croak("Bad remote filename '$remote'\n")
457 if $remote =~ /[\r\n]/s;
459 ${*$ftp}{'net_ftp_rest'} = $where if defined $where;
461 delete ${*$ftp}{'net_ftp_port'};
462 delete ${*$ftp}{'net_ftp_pasv'};
464 $data = $ftp->retr($remote) or
475 unless(sysopen($loc, $local, O_CREAT | O_WRONLY | (${*$ftp}{'net_ftp_rest'} ? O_APPEND : O_TRUNC)))
477 carp "Cannot open Local file $local: $!\n";
483 if($ftp->type eq 'I' && !binmode($loc))
485 carp "Cannot binmode Local file $local: $!\n";
487 close($loc) unless $localfd;
492 my($count,$hashh,$hashb,$ref) = (0);
494 ($hashh,$hashb) = @$ref
495 if($ref = ${*$ftp}{'net_ftp_hash'});
497 my $blksize = ${*$ftp}{'net_ftp_blksize'};
498 local $\; # Just in case
502 last unless $len = $data->read($buf,$blksize);
504 if (trEBCDIC && $ftp->type ne 'I')
506 $buf = $ftp->toebcdic($buf);
512 print $hashh "#" x (int($count / $hashb));
515 unless(print $loc $buf)
517 carp "Cannot write to Local file $local: $!\n";
525 print $hashh "\n" if $hashh;
531 carp "Cannot close file $local (perhaps disk space) $!\n";
536 unless ($data->close()) # implied $ftp->response
538 carp "Unable to close datastream";
547 @_ == 1 || @_ == 2 or croak 'usage: $ftp->cwd( [ DIR ] )';
551 $dir = "/" unless defined($dir) && $dir =~ /\S/;
560 @_ == 1 or croak 'usage: $ftp->cdup()';
566 @_ == 1 || croak 'usage: $ftp->pwd()';
573 # rmdir( $ftp, $dir, [ $recurse ] )
575 # Removes $dir on remote host via FTP.
576 # $ftp is handle for remote host
578 # If $recurse is TRUE, the directory and deleted recursively.
579 # This means all of its contents and subdirectories.
581 # Initial version contributed by Dinkum Software
585 @_ == 2 || @_ == 3 or croak('usage: $ftp->rmdir( DIR [, RECURSE ] )');
588 my ($ftp, $dir, $recurse) = @_ ;
592 if $ok = $ftp->_RMD( $dir ) or !$recurse;
594 # Try to delete the contents
595 # Get a list of all the files in the directory
596 my @filelist = grep { !/^\.{1,2}$/ } $ftp->ls($dir);
599 unless @filelist; # failed, it is probably not a directory
601 # Go thru and delete each file or the directory
603 foreach $file (map { m,/, ? $_ : "$dir/$_" } @filelist)
605 next # successfully deleted the file
606 if $ftp->delete($file);
608 # Failed to delete it, assume its a directory
609 # Recurse and ignore errors, the final rmdir() will
610 # fail on any errors here
612 unless $ok = $ftp->rmdir($file, 1) ;
615 # Directory should be empty
616 # Try to remove the directory again
617 # Pass results directly to caller
618 # If any of the prior deletes failed, this
619 # rmdir() will fail because directory is not empty
620 return $ftp->_RMD($dir) ;
625 @_ == 2 || croak 'usage: $ftp->restart( BYTE_OFFSET )';
627 my($ftp,$where) = @_;
629 ${*$ftp}{'net_ftp_rest'} = $where;
637 @_ == 2 || @_ == 3 or croak 'usage: $ftp->mkdir( DIR [, RECURSE ] )';
639 my($ftp,$dir,$recurse) = @_;
641 $ftp->_MKD($dir) || $recurse or
648 my @path = split(m#(?=/+)#, $dir);
654 $path .= shift @path;
658 $path = $ftp->_extract_path($path);
661 # If the creation of the last element was not successful, see if we
662 # can cd to it, if so then return path
666 my($status,$message) = ($ftp->status,$ftp->message);
669 if($pwd && $ftp->cwd($dir))
678 $ftp->set_status($status,$message);
687 @_ == 2 || croak 'usage: $ftp->delete( FILENAME )';
692 sub put { shift->_store_cmd("stor",@_) }
693 sub put_unique { shift->_store_cmd("stou",@_) }
694 sub append { shift->_store_cmd("appe",@_) }
696 sub nlst { shift->_data_cmd("NLST",@_) }
697 sub list { shift->_data_cmd("LIST",@_) }
698 sub retr { shift->_data_cmd("RETR",@_) }
699 sub stor { shift->_data_cmd("STOR",@_) }
700 sub stou { shift->_data_cmd("STOU",@_) }
701 sub appe { shift->_data_cmd("APPE",@_) }
705 my($ftp,$cmd,$local,$remote) = @_;
706 my($loc,$sock,$len,$buf);
709 my $localfd = ref($local) || ref(\$local) eq "GLOB";
711 unless(defined $remote)
713 croak 'Must specify remote filename with stream input'
716 require File::Basename;
717 $remote = File::Basename::basename($local);
719 if( defined ${*$ftp}{'net_ftp_allo'} )
721 delete ${*$ftp}{'net_ftp_allo'};
724 # if the user hasn't already invoked the alloc method since the last
725 # _store_cmd call, figure out if the local file is a regular file(not
726 # a pipe, or device) and if so get the file size from stat, and send
727 # an ALLO command before sending the STOR, STOU, or APPE command.
728 my $size = do { local $^W; -f $local && -s _ }; # no ALLO if sending data from a pipe
729 $ftp->_ALLO($size) if $size;
731 croak("Bad remote filename '$remote'\n")
732 if $remote =~ /[\r\n]/s;
742 unless(sysopen($loc, $local, O_RDONLY))
744 carp "Cannot open Local file $local: $!\n";
749 if($ftp->type eq 'I' && !binmode($loc))
751 carp "Cannot binmode Local file $local: $!\n";
755 delete ${*$ftp}{'net_ftp_port'};
756 delete ${*$ftp}{'net_ftp_pasv'};
758 $sock = $ftp->_data_cmd($cmd, $remote) or
761 $remote = ($ftp->message =~ /FILE:\s*(.*)/)[0]
762 if 'STOU' eq uc $cmd;
764 my $blksize = ${*$ftp}{'net_ftp_blksize'};
766 my($count,$hashh,$hashb,$ref) = (0);
768 ($hashh,$hashb) = @$ref
769 if($ref = ${*$ftp}{'net_ftp_hash'});
773 last unless $len = read($loc,$buf="",$blksize);
775 if (trEBCDIC && $ftp->type ne 'I')
777 $buf = $ftp->toascii($buf);
783 print $hashh "#" x (int($count / $hashb));
788 unless(defined($wlen = $sock->write($buf,$len)) && $wlen == $len)
793 print $hashh "\n" if $hashh;
798 print $hashh "\n" if $hashh;
806 if ('STOU' eq uc $cmd and $ftp->message =~ m/unique\s+file\s*name\s*:\s*(.*)\)|"(.*)"/)
808 require File::Basename;
809 $remote = File::Basename::basename($+)
817 @_ == 1 || @_ == 2 or croak 'usage: $ftp->port([PORT])';
822 delete ${*$ftp}{'net_ftp_intern_port'};
824 unless(defined $port)
826 # create a Listen socket at same address as the command socket
828 ${*$ftp}{'net_ftp_listen'} ||= IO::Socket::INET->new(Listen => 5,
830 Timeout => $ftp->timeout,
831 LocalAddr => $ftp->sockhost,
834 my $listen = ${*$ftp}{'net_ftp_listen'};
836 my($myport, @myaddr) = ($listen->sockport, split(/\./,$listen->sockhost));
838 $port = join(',', @myaddr, $myport >> 8, $myport & 0xff);
840 ${*$ftp}{'net_ftp_intern_port'} = 1;
843 $ok = $ftp->_PORT($port);
845 ${*$ftp}{'net_ftp_port'} = $port;
850 sub ls { shift->_list_cmd("NLST",@_); }
851 sub dir { shift->_list_cmd("LIST",@_); }
855 @_ == 1 or croak 'usage: $ftp->pasv()';
859 delete ${*$ftp}{'net_ftp_intern_port'};
861 $ftp->_PASV && $ftp->message =~ /(\d+(,\d+)+)/
862 ? ${*$ftp}{'net_ftp_pasv'} = $1
869 ${*$ftp}{'net_ftp_unique'} || undef;
873 @_ == 2 or croak 'usage: $ftp->supported( CMD )';
876 my $hash = ${*$ftp}{'net_ftp_supported'} ||= {};
879 if exists $hash->{$cmd};
881 return $hash->{$cmd} = 0
882 unless $ftp->_HELP($cmd);
884 my $text = $ftp->message;
885 if($text =~ /following\s+commands/i) {
887 while($text =~ /(\*?)(\w+)(\*?)/sg) {
888 $hash->{"\U$2"} = !length("$1$3");
892 $hash->{$cmd} = $text !~ /unimplemented/i;
899 ## Deprecated methods
904 carp "Use of Net::FTP::lsl deprecated, use 'dir'"
911 carp "Use of Net::FTP::authorise deprecated, use 'authorize'"
923 my($ftp, $path) = @_;
925 # This tries to work both with and without the quote doubling
926 # convention (RFC 959 requires it, but the first 3 servers I checked
927 # didn't implement it). It will fail on a server which uses a quote in
928 # the message which isn't a part of or surrounding the path.
930 $ftp->message =~ /(?:^|\s)\"(.*)\"(?:$|\s)/ &&
931 ($path = $1) =~ s/\"\"/\"/g;
937 ## Communication methods
944 my $pkg = "Net::FTP::" . $ftp->type;
946 eval "require " . $pkg;
950 delete ${*$ftp}{'net_ftp_dataconn'};
952 if(defined ${*$ftp}{'net_ftp_pasv'})
954 my @port = map { 0+$_ } split(/,/,${*$ftp}{'net_ftp_pasv'});
956 $data = $pkg->new(PeerAddr => join(".",@port[0..3]),
957 PeerPort => $port[4] * 256 + $port[5],
958 LocalAddr => ${*$ftp}{'net_ftp_localaddr'},
962 elsif(defined ${*$ftp}{'net_ftp_listen'})
964 $data = ${*$ftp}{'net_ftp_listen'}->accept($pkg);
965 close(delete ${*$ftp}{'net_ftp_listen'});
971 $data->timeout($ftp->timeout);
972 ${*$ftp}{'net_ftp_dataconn'} = $data;
973 ${*$data}{'net_ftp_cmd'} = $ftp;
974 ${*$data}{'net_ftp_blksize'} = ${*$ftp}{'net_ftp_blksize'};
985 delete ${*$ftp}{'net_ftp_port'};
986 delete ${*$ftp}{'net_ftp_pasv'};
988 my $data = $ftp->_data_cmd($cmd,@_);
991 unless(defined $data);
994 bless $data, "Net::FTP::A"; # Force ASCII mode
998 my $blksize = ${*$ftp}{'net_ftp_blksize'};
1000 while($data->read($databuf,$blksize)) {
1004 my $list = [ split(/\n/,$buf) ];
1010 for (@$list) { $_ = $ftp->toebcdic($_) }
1013 wantarray ? @{$list}
1022 my $where = delete ${*$ftp}{'net_ftp_rest'} || 0;
1026 croak("Bad argument '$arg'\n")
1027 if $arg =~ /[\r\n]/s;
1030 if(${*$ftp}{'net_ftp_passive'} &&
1031 !defined ${*$ftp}{'net_ftp_pasv'} &&
1032 !defined ${*$ftp}{'net_ftp_port'})
1036 $ok = defined $ftp->pasv;
1037 $ok = $ftp->_REST($where)
1042 $ftp->command($cmd,@_);
1043 $data = $ftp->_dataconn();
1044 $ok = CMD_INFO == $ftp->response();
1048 if $data && $cmd =~ /RETR|LIST|NLST/;
1058 unless (defined ${*$ftp}{'net_ftp_port'} ||
1059 defined ${*$ftp}{'net_ftp_pasv'});
1061 $ok = $ftp->_REST($where)
1067 $ftp->command($cmd,@_);
1070 if(defined ${*$ftp}{'net_ftp_pasv'});
1072 $ok = CMD_INFO == $ftp->response();
1075 unless exists ${*$ftp}{'net_ftp_intern_port'};
1078 my $data = $ftp->_dataconn();
1081 if $data && $cmd =~ /RETR|LIST|NLST/;
1087 close(delete ${*$ftp}{'net_ftp_listen'});
1093 ## Over-ride methods (Net::Cmd)
1096 sub debug_text { $_[2] =~ /^(pass|resp|acct)/i ? "$1 ....\n" : $_[2]; }
1102 delete ${*$ftp}{'net_ftp_port'};
1103 $ftp->SUPER::command(@_);
1109 my $code = $ftp->SUPER::response();
1111 delete ${*$ftp}{'net_ftp_pasv'}
1112 if ($code != CMD_MORE && $code != CMD_INFO);
1119 return ($1, $2 eq "-")
1120 if $_[1] =~ s/^(\d\d\d)(.?)//o;
1124 # Darn MS FTP server is a load of CRAP !!!!
1126 unless ${*$ftp}{'net_cmd_code'} + 0;
1128 (${*$ftp}{'net_cmd_code'},1);
1132 ## Allow 2 servers to talk directly
1136 my($sftp,$sfile,$dftp,$dfile,$unique) = @_;
1138 ($dfile = $sfile) =~ s#.*/##
1139 unless(defined $dfile);
1141 my $port = $sftp->pasv or
1144 $dftp->port($port) or
1148 unless($unique ? $dftp->stou($dfile) : $dftp->stor($dfile));
1150 unless($sftp->retr($sfile) && $sftp->response == CMD_INFO) {
1151 $sftp->retr($sfile);
1157 $dftp->pasv_wait($sftp);
1162 @_ == 2 or croak 'usage: $ftp->pasv_wait(NON_PASV_FTP)';
1164 my($ftp, $non_pasv) = @_;
1165 my($file,$rin,$rout);
1167 vec($rin='',fileno($ftp),1) = 1;
1168 select($rout=$rin, undef, undef, undef);
1171 $non_pasv->response();
1174 unless $ftp->ok() && $non_pasv->ok();
1177 if $ftp->message =~ /unique file name:\s*(\S*)\s*\)/;
1180 if $non_pasv->message =~ /unique file name:\s*(\S*)\s*\)/;
1185 sub cmd { shift->command(@_)->response() }
1187 ########################################
1192 sub _ABOR { shift->command("ABOR")->response() == CMD_OK }
1193 sub _ALLO { shift->command("ALLO",@_)->response() == CMD_OK}
1194 sub _CDUP { shift->command("CDUP")->response() == CMD_OK }
1195 sub _NOOP { shift->command("NOOP")->response() == CMD_OK }
1196 sub _PASV { shift->command("PASV")->response() == CMD_OK }
1197 sub _QUIT { shift->command("QUIT")->response() == CMD_OK }
1198 sub _DELE { shift->command("DELE",@_)->response() == CMD_OK }
1199 sub _CWD { shift->command("CWD", @_)->response() == CMD_OK }
1200 sub _PORT { shift->command("PORT",@_)->response() == CMD_OK }
1201 sub _RMD { shift->command("RMD", @_)->response() == CMD_OK }
1202 sub _MKD { shift->command("MKD", @_)->response() == CMD_OK }
1203 sub _PWD { shift->command("PWD", @_)->response() == CMD_OK }
1204 sub _TYPE { shift->command("TYPE",@_)->response() == CMD_OK }
1205 sub _RNTO { shift->command("RNTO",@_)->response() == CMD_OK }
1206 sub _RESP { shift->command("RESP",@_)->response() == CMD_OK }
1207 sub _MDTM { shift->command("MDTM",@_)->response() == CMD_OK }
1208 sub _SIZE { shift->command("SIZE",@_)->response() == CMD_OK }
1209 sub _HELP { shift->command("HELP",@_)->response() == CMD_OK }
1210 sub _STAT { shift->command("STAT",@_)->response() == CMD_OK }
1211 sub _APPE { shift->command("APPE",@_)->response() == CMD_INFO }
1212 sub _LIST { shift->command("LIST",@_)->response() == CMD_INFO }
1213 sub _NLST { shift->command("NLST",@_)->response() == CMD_INFO }
1214 sub _RETR { shift->command("RETR",@_)->response() == CMD_INFO }
1215 sub _STOR { shift->command("STOR",@_)->response() == CMD_INFO }
1216 sub _STOU { shift->command("STOU",@_)->response() == CMD_INFO }
1217 sub _RNFR { shift->command("RNFR",@_)->response() == CMD_MORE }
1218 sub _REST { shift->command("REST",@_)->response() == CMD_MORE }
1219 sub _USER { shift->command("user",@_)->response() } # A certain brain dead firewall :-)
1220 sub _PASS { shift->command("PASS",@_)->response() }
1221 sub _ACCT { shift->command("ACCT",@_)->response() }
1222 sub _AUTH { shift->command("AUTH",@_)->response() }
1224 sub _SMNT { shift->unsupported(@_) }
1225 sub _MODE { shift->unsupported(@_) }
1226 sub _SYST { shift->unsupported(@_) }
1227 sub _STRU { shift->unsupported(@_) }
1228 sub _REIN { shift->unsupported(@_) }
1236 Net::FTP - FTP Client class
1242 $ftp = Net::FTP->new("some.host.name", Debug => 0)
1243 or die "Cannot connect to some.host.name: $@";
1245 $ftp->login("anonymous",'-anonymous@')
1246 or die "Cannot login ", $ftp->message;
1249 or die "Cannot change working directory ", $ftp->message;
1251 $ftp->get("that.file")
1252 or die "get failed ", $ftp->message;
1258 C<Net::FTP> is a class implementing a simple FTP client in Perl as
1259 described in RFC959. It provides wrappers for a subset of the RFC959
1264 FTP stands for File Transfer Protocol. It is a way of transferring
1265 files between networked machines. The protocol defines a client
1266 (whose commands are provided by this module) and a server (not
1267 implemented in this module). Communication is always initiated by the
1268 client, and the server responds with a message and a status code (and
1269 sometimes with data).
1271 The FTP protocol allows files to be sent to or fetched from the
1272 server. Each transfer involves a B<local file> (on the client) and a
1273 B<remote file> (on the server). In this module, the same file name
1274 will be used for both local and remote if only one is specified. This
1275 means that transferring remote file C</path/to/file> will try to put
1276 that file in C</path/to/file> locally, unless you specify a local file
1279 The protocol also defines several standard B<translations> which the
1280 file can undergo during transfer. These are ASCII, EBCDIC, binary,
1281 and byte. ASCII is the default type, and indicates that the sender of
1282 files will translate the ends of lines to a standard representation
1283 which the receiver will then translate back into their local
1284 representation. EBCDIC indicates the file being transferred is in
1285 EBCDIC format. Binary (also known as image) format sends the data as
1286 a contiguous bit stream. Byte format transfers the data as bytes, the
1287 values of which remain the same regardless of differences in byte size
1288 between the two machines (in theory - in practice you should only use
1289 this if you really know what you're doing).
1295 =item new ([ HOST ] [, OPTIONS ])
1297 This is the constructor for a new Net::FTP object. C<HOST> is the
1298 name of the remote host to which an FTP connection is required.
1300 C<HOST> is optional. If C<HOST> is not given then it may instead be
1301 passed as the C<Host> option described below.
1303 C<OPTIONS> are passed in a hash like fashion, using key and value pairs.
1304 Possible options are:
1306 B<Host> - FTP host to connect to. It may be a single scalar, as defined for
1307 the C<PeerAddr> option in L<IO::Socket::INET>, or a reference to
1308 an array with hosts to try in turn. The L</host> method will return the value
1309 which was used to connect to the host.
1312 B<Firewall> - The name of a machine which acts as an FTP firewall. This can be
1313 overridden by an environment variable C<FTP_FIREWALL>. If specified, and the
1314 given host cannot be directly connected to, then the
1315 connection is made to the firewall machine and the string C<@hostname> is
1316 appended to the login identifier. This kind of setup is also refered to
1319 B<FirewallType> - The type of firewall running on the machine indicated by
1320 B<Firewall>. This can be overridden by an environment variable
1321 C<FTP_FIREWALL_TYPE>. For a list of permissible types, see the description of
1322 ftp_firewall_type in L<Net::Config>.
1324 B<BlockSize> - This is the block size that Net::FTP will use when doing
1325 transfers. (defaults to 10240)
1327 B<Port> - The port number to connect to on the remote machine for the
1330 B<Timeout> - Set a timeout value (defaults to 120)
1332 B<Debug> - debug level (see the debug method in L<Net::Cmd>)
1334 B<Passive> - If set to a non-zero value then all data transfers will be done
1335 using passive mode. This is not usually required except for some I<dumb>
1336 servers, and some firewall configurations. This can also be set by the
1337 environment variable C<FTP_PASSIVE>.
1339 B<Hash> - If given a reference to a file handle (e.g., C<\*STDERR>),
1340 print hash marks (#) on that filehandle every 1024 bytes. This
1341 simply invokes the C<hash()> method for you, so that hash marks
1342 are displayed for all transfers. You can, of course, call C<hash()>
1343 explicitly whenever you'd like.
1345 B<LocalAddr> - Local address to use for all socket connections, this
1346 argument will be passed to L<IO::Socket::INET>
1348 If the constructor fails undef will be returned and an error message will
1355 Unless otherwise stated all methods return either a I<true> or I<false>
1356 value, with I<true> meaning that the operation was a success. When a method
1357 states that it returns a value, failure will be returned as I<undef> or an
1362 =item login ([LOGIN [,PASSWORD [, ACCOUNT] ] ])
1364 Log into the remote FTP server with the given login information. If
1365 no arguments are given then the C<Net::FTP> uses the C<Net::Netrc>
1366 package to lookup the login information for the connected host.
1367 If no information is found then a login of I<anonymous> is used.
1368 If no password is given and the login is I<anonymous> then I<anonymous@>
1369 will be used for password.
1371 If the connection is via a firewall then the C<authorize> method will
1372 be called with no arguments.
1374 =item authorize ( [AUTH [, RESP]])
1376 This is a protocol used by some firewall ftp proxies. It is used
1377 to authorise the user to send data out. If both arguments are not specified
1378 then C<authorize> uses C<Net::Netrc> to do a lookup.
1382 Send a SITE command to the remote server and wait for a response.
1384 Returns most significant digit of the response code.
1388 Transfer file in ASCII. CRLF translation will be done if required
1392 Transfer file in binary mode. No transformation will be done.
1394 B<Hint>: If both server and client machines use the same line ending for
1395 text files, then it will be faster to transfer all files in binary mode.
1397 =item rename ( OLDNAME, NEWNAME )
1399 Rename a file on the remote FTP server from C<OLDNAME> to C<NEWNAME>. This
1400 is done by sending the RNFR and RNTO commands.
1402 =item delete ( FILENAME )
1404 Send a request to the server to delete C<FILENAME>.
1406 =item cwd ( [ DIR ] )
1408 Attempt to change directory to the directory given in C<$dir>. If
1409 C<$dir> is C<"..">, the FTP C<CDUP> command is used to attempt to
1410 move up one directory. If no directory is given then an attempt is made
1411 to change the directory to the root directory.
1415 Change directory to the parent of the current directory.
1419 Returns the full pathname of the current directory.
1421 =item restart ( WHERE )
1423 Set the byte offset at which to begin the next data transfer. Net::FTP simply
1424 records this value and uses it when during the next data transfer. For this
1425 reason this method will not return an error, but setting it may cause
1426 a subsequent data transfer to fail.
1428 =item rmdir ( DIR [, RECURSE ])
1430 Remove the directory with the name C<DIR>. If C<RECURSE> is I<true> then
1431 C<rmdir> will attempt to delete everything inside the directory.
1433 =item mkdir ( DIR [, RECURSE ])
1435 Create a new directory with the name C<DIR>. If C<RECURSE> is I<true> then
1436 C<mkdir> will attempt to create all the directories in the given path.
1438 Returns the full pathname to the new directory.
1440 =item alloc ( SIZE [, RECORD_SIZE] )
1442 The alloc command allows you to give the ftp server a hint about the size
1443 of the file about to be transfered using the ALLO ftp command. Some storage
1444 systems use this to make intelligent decisions about how to store the file.
1445 The C<SIZE> argument represents the size of the file in bytes. The
1446 C<RECORD_SIZE> argument indicates a mazimum record or page size for files
1447 sent with a record or page structure.
1449 The size of the file will be determined, and sent to the server
1450 automatically for normal files so that this method need only be called if
1451 you are transfering data from a socket, named pipe, or other stream not
1452 associated with a normal file.
1454 =item ls ( [ DIR ] )
1456 Get a directory listing of C<DIR>, or the current directory.
1458 In an array context, returns a list of lines returned from the server. In
1459 a scalar context, returns a reference to a list.
1461 =item dir ( [ DIR ] )
1463 Get a directory listing of C<DIR>, or the current directory in long format.
1465 In an array context, returns a list of lines returned from the server. In
1466 a scalar context, returns a reference to a list.
1468 =item get ( REMOTE_FILE [, LOCAL_FILE [, WHERE]] )
1470 Get C<REMOTE_FILE> from the server and store locally. C<LOCAL_FILE> may be
1471 a filename or a filehandle. If not specified, the file will be stored in
1472 the current directory with the same leafname as the remote file.
1474 If C<WHERE> is given then the first C<WHERE> bytes of the file will
1475 not be transfered, and the remaining bytes will be appended to
1476 the local file if it already exists.
1478 Returns C<LOCAL_FILE>, or the generated local file name if C<LOCAL_FILE>
1479 is not given. If an error was encountered undef is returned.
1481 =item put ( LOCAL_FILE [, REMOTE_FILE ] )
1483 Put a file on the remote server. C<LOCAL_FILE> may be a name or a filehandle.
1484 If C<LOCAL_FILE> is a filehandle then C<REMOTE_FILE> must be specified. If
1485 C<REMOTE_FILE> is not specified then the file will be stored in the current
1486 directory with the same leafname as C<LOCAL_FILE>.
1488 Returns C<REMOTE_FILE>, or the generated remote filename if C<REMOTE_FILE>
1491 B<NOTE>: If for some reason the transfer does not complete and an error is
1492 returned then the contents that had been transfered will not be remove
1495 =item put_unique ( LOCAL_FILE [, REMOTE_FILE ] )
1497 Same as put but uses the C<STOU> command.
1499 Returns the name of the file on the server.
1501 =item append ( LOCAL_FILE [, REMOTE_FILE ] )
1503 Same as put but appends to the file on the remote server.
1505 Returns C<REMOTE_FILE>, or the generated remote filename if C<REMOTE_FILE>
1508 =item unique_name ()
1510 Returns the name of the last file stored on the server using the
1515 Returns the I<modification time> of the given file
1519 Returns the size in bytes for the given file as stored on the remote server.
1521 B<NOTE>: The size reported is the size of the stored file on the remote server.
1522 If the file is subsequently transfered from the server in ASCII mode
1523 and the remote server and local machine have different ideas about
1524 "End Of Line" then the size of file on the local machine after transfer
1527 =item supported ( CMD )
1529 Returns TRUE if the remote server supports the given command.
1531 =item hash ( [FILEHANDLE_GLOB_REF],[ BYTES_PER_HASH_MARK] )
1533 Called without parameters, or with the first argument false, hash marks
1534 are suppressed. If the first argument is true but not a reference to a
1535 file handle glob, then \*STDERR is used. The second argument is the number
1536 of bytes per hash mark printed, and defaults to 1024. In all cases the
1537 return value is a reference to an array of two: the filehandle glob reference
1538 and the bytes per hash mark.
1542 The following methods can return different results depending on
1543 how they are called. If the user explicitly calls either
1544 of the C<pasv> or C<port> methods then these methods will
1545 return a I<true> or I<false> value. If the user does not
1546 call either of these methods then the result will be a
1547 reference to a C<Net::FTP::dataconn> based object.
1551 =item nlst ( [ DIR ] )
1553 Send an C<NLST> command to the server, with an optional parameter.
1555 =item list ( [ DIR ] )
1557 Same as C<nlst> but using the C<LIST> command
1561 Begin the retrieval of a file called C<FILE> from the remote server.
1565 Tell the server that you wish to store a file. C<FILE> is the
1566 name of the new file that should be created.
1570 Same as C<stor> but using the C<STOU> command. The name of the unique
1571 file which was created on the server will be available via the C<unique_name>
1572 method after the data connection has been closed.
1576 Tell the server that we want to append some data to the end of a file
1577 called C<FILE>. If this file does not exist then create it.
1581 If for some reason you want to have complete control over the data connection,
1582 this includes generating it and calling the C<response> method when required,
1583 then the user can use these methods to do so.
1585 However calling these methods only affects the use of the methods above that
1586 can return a data connection. They have no effect on methods C<get>, C<put>,
1587 C<put_unique> and those that do not require data connections.
1591 =item port ( [ PORT ] )
1593 Send a C<PORT> command to the server. If C<PORT> is specified then it is sent
1594 to the server. If not, then a listen socket is created and the correct information
1599 Tell the server to go into passive mode. Returns the text that represents the
1600 port on which the server is listening, this text is in a suitable form to
1601 sent to another ftp server using the C<port> method.
1605 The following methods can be used to transfer files between two remote
1606 servers, providing that these two servers can connect directly to each other.
1610 =item pasv_xfer ( SRC_FILE, DEST_SERVER [, DEST_FILE ] )
1612 This method will do a file transfer between two remote ftp servers. If
1613 C<DEST_FILE> is omitted then the leaf name of C<SRC_FILE> will be used.
1615 =item pasv_xfer_unique ( SRC_FILE, DEST_SERVER [, DEST_FILE ] )
1617 Like C<pasv_xfer> but the file is stored on the remote server using
1620 =item pasv_wait ( NON_PASV_SERVER )
1622 This method can be used to wait for a transfer to complete between a passive
1623 server and a non-passive server. The method should be called on the passive
1624 server with the C<Net::FTP> object for the non-passive server passed as an
1629 Abort the current data transfer.
1633 Send the QUIT command to the remote FTP server and close the socket connection.
1637 =head2 Methods for the adventurous
1639 C<Net::FTP> inherits from C<Net::Cmd> so methods defined in C<Net::Cmd> may
1640 be used to send commands to the remote FTP server.
1644 =item quot (CMD [,ARGS])
1646 Send a command, that Net::FTP does not directly support, to the remote
1647 server and wait for a response.
1649 Returns most significant digit of the response code.
1651 B<WARNING> This call should only be used on commands that do not require
1652 data connections. Misuse of this method can hang the connection.
1656 =head1 THE dataconn CLASS
1658 Some of the methods defined in C<Net::FTP> return an object which will
1659 be derived from this class.The dataconn class itself is derived from
1660 the C<IO::Socket::INET> class, so any normal IO operations can be performed.
1661 However the following methods are defined in the dataconn class and IO should
1662 be performed using these.
1666 =item read ( BUFFER, SIZE [, TIMEOUT ] )
1668 Read C<SIZE> bytes of data from the server and place it into C<BUFFER>, also
1669 performing any <CRLF> translation necessary. C<TIMEOUT> is optional, if not
1670 given, the timeout value from the command connection will be used.
1672 Returns the number of bytes read before any <CRLF> translation.
1674 =item write ( BUFFER, SIZE [, TIMEOUT ] )
1676 Write C<SIZE> bytes of data from C<BUFFER> to the server, also
1677 performing any <CRLF> translation necessary. C<TIMEOUT> is optional, if not
1678 given, the timeout value from the command connection will be used.
1680 Returns the number of bytes written before any <CRLF> translation.
1684 Returns the number of bytes read so far.
1688 Abort the current data transfer.
1692 Close the data connection and get a response from the FTP server. Returns
1693 I<true> if the connection was closed successfully and the first digit of
1694 the response from the server was a '2'.
1698 =head1 UNIMPLEMENTED
1700 The following RFC959 commands have not been implemented:
1706 Mount a different file system structure without changing login or
1707 accounting information.
1711 Ask the server for "helpful information" (that's what the RFC says) on
1712 the commands it accepts.
1716 Specifies transfer mode (stream, block or compressed) for file to be
1721 Request remote server system identification.
1725 Request remote server status.
1729 Specifies file structure for file to be transferred.
1733 Reinitialize the connection, flushing all I/O and account information.
1737 =head1 REPORTING BUGS
1739 When reporting bugs/problems please include as much information as possible.
1740 It may be difficult for me to reproduce the problem as almost every setup
1743 A small script which yields the problem will probably be of help. It would
1744 also be useful if this script was run with the extra options C<Debug => 1>
1745 passed to the constructor, and the output sent with the bug report. If you
1746 cannot include a small script then please include a Debug trace from a
1747 run of your program which does yield the problem.
1751 Graham Barr <gbarr@pobox.com>
1758 ftp(1), ftpd(8), RFC 959
1759 http://www.cis.ohio-state.edu/htbin/rfc/rfc959.html
1763 For an example of the use of Net::FTP see
1767 =item http://www.csh.rit.edu/~adam/Progs/
1769 C<autoftp> is a program that can retrieve, send, or list files via
1770 the FTP protocol in a non-interactive manner.
1776 Henry Gabryjelski <henryg@WPI.EDU> - for the suggestion of creating directories
1779 Nathan Torkington <gnat@frii.com> - for some input on the documentation.
1781 Roderick Schertler <roderick@gate.net> - for various inputs
1785 Copyright (c) 1995-2003 Graham Barr. All rights reserved.
1786 This program is free software; you can redistribute it and/or modify it
1787 under the same terms as Perl itself.