3 # Copyright (c) 1995-8 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.70"; # $Id: //depot/libnet/Net/FTP.pm#76 $
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
58 my $fire_type = undef;
60 if(exists($arg{Firewall}) || Net::Config->requires_firewall($peer))
62 $fire = $arg{Firewall}
64 || $NetConfig{ftp_firewall}
71 $fire_type = $arg{FirewallType}
72 || $ENV{FTP_FIREWALL_TYPE}
73 || $NetConfig{firewall_type}
78 my $ftp = $pkg->SUPER::new(PeerAddr => $peer,
79 PeerPort => $arg{Port} || 'ftp(21)',
80 LocalAddr => $arg{'LocalAddr'},
82 Timeout => defined $arg{Timeout}
87 ${*$ftp}{'net_ftp_host'} = $host; # Remote hostname
88 ${*$ftp}{'net_ftp_type'} = 'A'; # ASCII/binary/etc mode
89 ${*$ftp}{'net_ftp_blksize'} = abs($arg{'BlockSize'} || 10240);
91 ${*$ftp}{'net_ftp_localaddr'} = $arg{'LocalAddr'};
93 ${*$ftp}{'net_ftp_firewall'} = $fire
95 ${*$ftp}{'net_ftp_firewall_type'} = $fire_type
96 if(defined $fire_type);
98 ${*$ftp}{'net_ftp_passive'} = int
101 : exists $ENV{FTP_PASSIVE}
104 ? $NetConfig{ftp_ext_passive}
105 : $NetConfig{ftp_int_passive}; # Whew! :-)
107 $ftp->hash(exists $arg{Hash} ? $arg{Hash} : 0, 1024);
111 $ftp->debug(exists $arg{Debug} ? $arg{Debug} : undef);
113 unless ($ftp->response() == CMD_OK)
124 ## User interface methods
128 my $ftp = shift; # self
132 delete ${*$ftp}{'net_ftp_hash'};
135 ($h,$b) = (ref($h)? $h : \*STDERR, $b || 1024);
136 select((select($h), $|=1)[0]);
137 $b = 512 if $b < 512;
138 ${*$ftp}{'net_ftp_hash'} = [$h, $b];
151 sub ascii { shift->type('A',@_); }
152 sub binary { shift->type('I',@_); }
156 carp "TYPE E is unsupported, shall default to I";
162 carp "TYPE L is unsupported, shall default to I";
166 # Allow the user to send a command directly, BE CAREFUL !!
173 $ftp->command( uc $cmd, @_);
181 $ftp->command("SITE", @_);
190 # Server Y2K bug workaround
192 # sigh; some idiotic FTP servers use ("19%d",tm.tm_year) instead of
193 # ("%d",tm.tm_year+1900). This results in an extra digit in the
194 # string returned. To account for this we allow an optional extra
195 # digit in the year. Then if the first two digits are 19 we use the
196 # remainder, otherwise we subtract 1900 from the whole year.
198 $ftp->_MDTM($file) && $ftp->message =~ /((\d\d)(\d\d\d?))(\d\d)(\d\d)(\d\d)(\d\d)(\d\d)/
199 ? timegm($8,$7,$6,$5,$4-1,$2 eq '19' ? $3 : ($1-1900))
207 if($ftp->supported("SIZE")) {
208 return $ftp->_SIZE($file)
209 ? ($ftp->message =~ /(\d+)$/)[0]
212 elsif($ftp->supported("STAT")) {
215 unless $ftp->_STAT($file) && (@msg = $ftp->message) == 3;
217 foreach $line (@msg) {
218 return (split(/\s+/,$line))[4]
219 if $line =~ /^[-rwx]{10}/
223 my @files = $ftp->dir($file);
225 return (split(/\s+/,$1))[4]
226 if $files[0] =~ /^([-rwx]{10}.*)$/;
233 my($ftp,$user,$pass,$acct) = @_;
234 my($ok,$ruser,$fwtype);
236 unless (defined $user) {
239 my $rc = Net::Netrc->lookup(${*$ftp}{'net_ftp_host'});
241 ($user,$pass,$acct) = $rc->lpa()
245 $user ||= "anonymous";
248 $fwtype = ${*$ftp}{'net_ftp_firewall_type'}
249 || $NetConfig{'ftp_firewall_type'}
252 if ($fwtype && defined ${*$ftp}{'net_ftp_firewall'}) {
253 if ($fwtype == 1 || $fwtype == 7) {
254 $user .= '@' . ${*$ftp}{'net_ftp_host'};
259 my $rc = Net::Netrc->lookup(${*$ftp}{'net_ftp_firewall'});
261 my($fwuser,$fwpass,$fwacct) = $rc ? $rc->lpa() : ();
264 $user = join('@',$user,$fwuser,${*$ftp}{'net_ftp_host'});
265 $pass = $pass . '@' . $fwpass;
269 $user .= '@' . ${*$ftp}{'net_ftp_host'};
271 elsif ($fwtype == 6) {
272 $fwuser .= '@' . ${*$ftp}{'net_ftp_host'};
275 $ok = $ftp->_USER($fwuser);
277 return 0 unless $ok == CMD_OK || $ok == CMD_MORE;
279 $ok = $ftp->_PASS($fwpass || "");
281 return 0 unless $ok == CMD_OK || $ok == CMD_MORE;
283 $ok = $ftp->_ACCT($fwacct)
287 $ok = $ftp->command("SITE",${*$ftp}{'net_ftp_host'})->response;
289 elsif ($fwtype == 4) {
290 $ok = $ftp->command("OPEN",${*$ftp}{'net_ftp_host'})->response;
293 return 0 unless $ok == CMD_OK || $ok == CMD_MORE;
298 $ok = $ftp->_USER($user);
300 # Some dumb firewalls don't prefix the connection messages
301 $ok = $ftp->response()
302 if ($ok == CMD_OK && $ftp->code == 220 && $user =~ /\@/);
304 if ($ok == CMD_MORE) {
305 unless(defined $pass) {
308 my $rc = Net::Netrc->lookup(${*$ftp}{'net_ftp_host'}, $ruser);
310 ($ruser,$pass,$acct) = $rc->lpa()
313 $pass = '-anonymous@'
314 if (!defined $pass && (!defined($ruser) || $ruser =~ /^anonymous/o));
317 $ok = $ftp->_PASS($pass || "");
320 $ok = $ftp->_ACCT($acct)
321 if (defined($acct) && ($ok == CMD_MORE || $ok == CMD_OK));
323 if ($fwtype == 7 && $ok == CMD_OK && defined ${*$ftp}{'net_ftp_firewall'}) {
324 my($f,$auth,$resp) = _auth_id($ftp);
325 $ftp->authorize($auth,$resp) if defined($resp);
333 @_ == 2 or croak 'usage: $ftp->account( ACCT )';
336 $ftp->_ACCT($acct) == CMD_OK;
340 my($ftp,$auth,$resp) = @_;
342 unless(defined $resp)
346 $auth ||= eval { (getpwuid($>))[0] } || $ENV{NAME};
348 my $rc = Net::Netrc->lookup(${*$ftp}{'net_ftp_firewall'}, $auth)
349 || Net::Netrc->lookup(${*$ftp}{'net_ftp_firewall'});
351 ($auth,$resp) = $rc->lpa()
359 @_ >= 1 || @_ <= 3 or croak 'usage: $ftp->authorize( [AUTH [, RESP]])';
361 my($ftp,$auth,$resp) = &_auth_id;
363 my $ok = $ftp->_AUTH($auth || "");
365 $ok = $ftp->_RESP($resp || "")
366 if ($ok == CMD_MORE);
373 @_ == 3 or croak 'usage: $ftp->rename(FROM, TO)';
375 my($ftp,$from,$to) = @_;
385 my $oldval = ${*$ftp}{'net_ftp_type'};
388 unless (defined $type);
391 unless ($ftp->_TYPE($type,@_));
393 ${*$ftp}{'net_ftp_type'} = join(" ",$type,@_);
402 my $oldval = ${*$ftp}{'net_ftp_allo'};
405 unless (defined $size);
408 unless ($ftp->_ALLO($size,@_));
410 ${*$ftp}{'net_ftp_allo'} = join(" ",$size,@_);
419 send($ftp,pack("CCC", $TELNET_IAC, $TELNET_IP, $TELNET_IAC),MSG_OOB);
421 $ftp->command(pack("C",$TELNET_DM) . "ABOR");
423 ${*$ftp}{'net_ftp_dataconn'}->close()
424 if defined ${*$ftp}{'net_ftp_dataconn'};
428 $ftp->status == CMD_OK;
433 my($ftp,$remote,$local,$where) = @_;
435 my($loc,$len,$buf,$resp,$data);
438 my $localfd = ref($local) || ref(\$local) eq "GLOB";
440 ($local = $remote) =~ s#^.*/##
441 unless(defined $local);
443 croak("Bad remote filename '$remote'\n")
444 if $remote =~ /[\r\n]/s;
446 ${*$ftp}{'net_ftp_rest'} = $where
449 delete ${*$ftp}{'net_ftp_port'};
450 delete ${*$ftp}{'net_ftp_pasv'};
452 $data = $ftp->retr($remote) or
463 unless(sysopen($loc, $local, O_CREAT | O_WRONLY | ($where ? O_APPEND : O_TRUNC)))
465 carp "Cannot open Local file $local: $!\n";
471 if($ftp->type eq 'I' && !binmode($loc))
473 carp "Cannot binmode Local file $local: $!\n";
475 close($loc) unless $localfd;
480 my($count,$hashh,$hashb,$ref) = (0);
482 ($hashh,$hashb) = @$ref
483 if($ref = ${*$ftp}{'net_ftp_hash'});
485 my $blksize = ${*$ftp}{'net_ftp_blksize'};
486 local $\; # Just in case
490 last unless $len = $data->read($buf,$blksize);
492 if (trEBCDIC && $ftp->type ne 'I')
494 $buf = $ftp->toebcdic($buf);
500 print $hashh "#" x (int($count / $hashb));
503 unless(print $loc $buf)
505 carp "Cannot write to Local file $local: $!\n";
513 print $hashh "\n" if $hashh;
519 carp "Cannot close file $local (perhaps disk space) $!\n";
524 unless ($data->close()) # implied $ftp->response
526 carp "Unable to close datastream";
535 @_ == 1 || @_ == 2 or croak 'usage: $ftp->cwd( [ DIR ] )';
539 $dir = "/" unless defined($dir) && $dir =~ /\S/;
548 @_ == 1 or croak 'usage: $ftp->cdup()';
554 @_ == 1 || croak 'usage: $ftp->pwd()';
561 # rmdir( $ftp, $dir, [ $recurse ] )
563 # Removes $dir on remote host via FTP.
564 # $ftp is handle for remote host
566 # If $recurse is TRUE, the directory and deleted recursively.
567 # This means all of its contents and subdirectories.
569 # Initial version contributed by Dinkum Software
573 @_ == 2 || @_ == 3 or croak('usage: $ftp->rmdir( DIR [, RECURSE ] )');
576 my ($ftp, $dir, $recurse) = @_ ;
580 if $ok = $ftp->_RMD( $dir ) or !$recurse;
582 # Try to delete the contents
583 # Get a list of all the files in the directory
584 my $filelist = $ftp->ls($dir);
587 unless $filelist && @$filelist; # failed, it is probably not a directory
589 # Go thru and delete each file or the directory
591 foreach $file (map { m,/, ? $_ : "$dir/$_" } @$filelist)
593 next # successfully deleted the file
594 if $ftp->delete($file);
596 # Failed to delete it, assume its a directory
597 # Recurse and ignore errors, the final rmdir() will
598 # fail on any errors here
600 unless $ok = $ftp->rmdir($file, 1) ;
603 # Directory should be empty
604 # Try to remove the directory again
605 # Pass results directly to caller
606 # If any of the prior deletes failed, this
607 # rmdir() will fail because directory is not empty
608 return $ftp->_RMD($dir) ;
613 @_ == 2 || croak 'usage: $ftp->restart( BYTE_OFFSET )';
615 my($ftp,$where) = @_;
617 ${*$ftp}{'net_ftp_rest'} = $where;
625 @_ == 2 || @_ == 3 or croak 'usage: $ftp->mkdir( DIR [, RECURSE ] )';
627 my($ftp,$dir,$recurse) = @_;
629 $ftp->_MKD($dir) || $recurse or
636 my @path = split(m#(?=/+)#, $dir);
642 $path .= shift @path;
646 $path = $ftp->_extract_path($path);
649 # If the creation of the last element was not successful, see if we
650 # can cd to it, if so then return path
654 my($status,$message) = ($ftp->status,$ftp->message);
657 if($pwd && $ftp->cwd($dir))
666 $ftp->set_status($status,$message);
675 @_ == 2 || croak 'usage: $ftp->delete( FILENAME )';
680 sub put { shift->_store_cmd("stor",@_) }
681 sub put_unique { shift->_store_cmd("stou",@_) }
682 sub append { shift->_store_cmd("appe",@_) }
684 sub nlst { shift->_data_cmd("NLST",@_) }
685 sub list { shift->_data_cmd("LIST",@_) }
686 sub retr { shift->_data_cmd("RETR",@_) }
687 sub stor { shift->_data_cmd("STOR",@_) }
688 sub stou { shift->_data_cmd("STOU",@_) }
689 sub appe { shift->_data_cmd("APPE",@_) }
693 my($ftp,$cmd,$local,$remote) = @_;
694 my($loc,$sock,$len,$buf);
697 my $localfd = ref($local) || ref(\$local) eq "GLOB";
699 unless(defined $remote)
701 croak 'Must specify remote filename with stream input'
704 require File::Basename;
705 $remote = File::Basename::basename($local);
707 if( defined ${*$ftp}{'net_ftp_allo'} )
709 delete ${*$ftp}{'net_ftp_allo'};
712 # if the user hasn't already invoked the alloc method since the last
713 # _store_cmd call, figure out if the local file is a regular file(not
714 # a pipe, or device) and if so get the file size from stat, and send
715 # an ALLO command before sending the STOR, STOU, or APPE command.
716 $ftp->_ALLO(-s _) if -f $loc; # no ALLO if sending data from a pipe
718 croak("Bad remote filename '$remote'\n")
719 if $remote =~ /[\r\n]/s;
729 unless(sysopen($loc, $local, O_RDONLY))
731 carp "Cannot open Local file $local: $!\n";
736 if($ftp->type eq 'I' && !binmode($loc))
738 carp "Cannot binmode Local file $local: $!\n";
742 delete ${*$ftp}{'net_ftp_port'};
743 delete ${*$ftp}{'net_ftp_pasv'};
745 $sock = $ftp->_data_cmd($cmd, $remote) or
748 $remote = ($ftp->message =~ /FILE:\s*(.*)/)[0]
749 if 'STOU' eq uc $cmd;
751 my $blksize = ${*$ftp}{'net_ftp_blksize'};
753 my($count,$hashh,$hashb,$ref) = (0);
755 ($hashh,$hashb) = @$ref
756 if($ref = ${*$ftp}{'net_ftp_hash'});
760 last unless $len = read($loc,$buf="",$blksize);
762 if (trEBCDIC && $ftp->type ne 'I')
764 $buf = $ftp->toascii($buf);
770 print $hashh "#" x (int($count / $hashb));
775 unless(defined($wlen = $sock->write($buf,$len)) && $wlen == $len)
780 print $hashh "\n" if $hashh;
785 print $hashh "\n" if $hashh;
793 if ('STOU' eq uc $cmd and $ftp->message =~ m/unique\s+file\s*name\s*:\s*(.*)\)|"(.*)"/)
795 require File::Basename;
796 $remote = File::Basename::basename($+)
804 @_ == 1 || @_ == 2 or croak 'usage: $ftp->port([PORT])';
809 delete ${*$ftp}{'net_ftp_intern_port'};
811 unless(defined $port)
813 # create a Listen socket at same address as the command socket
815 ${*$ftp}{'net_ftp_listen'} ||= IO::Socket::INET->new(Listen => 5,
817 Timeout => $ftp->timeout,
818 LocalAddr => $ftp->sockhost,
821 my $listen = ${*$ftp}{'net_ftp_listen'};
823 my($myport, @myaddr) = ($listen->sockport, split(/\./,$listen->sockhost));
825 $port = join(',', @myaddr, $myport >> 8, $myport & 0xff);
827 ${*$ftp}{'net_ftp_intern_port'} = 1;
830 $ok = $ftp->_PORT($port);
832 ${*$ftp}{'net_ftp_port'} = $port;
837 sub ls { shift->_list_cmd("NLST",@_); }
838 sub dir { shift->_list_cmd("LIST",@_); }
842 @_ == 1 or croak 'usage: $ftp->pasv()';
846 delete ${*$ftp}{'net_ftp_intern_port'};
848 $ftp->_PASV && $ftp->message =~ /(\d+(,\d+)+)/
849 ? ${*$ftp}{'net_ftp_pasv'} = $1
856 ${*$ftp}{'net_ftp_unique'} || undef;
860 @_ == 2 or croak 'usage: $ftp->supported( CMD )';
863 my $hash = ${*$ftp}{'net_ftp_supported'} ||= {};
866 if exists $hash->{$cmd};
868 return $hash->{$cmd} = 0
869 unless $ftp->_HELP($cmd);
871 my $text = $ftp->message;
872 if($text =~ /following\s+commands/i) {
874 while($text =~ /(\*?)(\w+)(\*?)/sg) {
875 $hash->{"\U$2"} = !length("$1$3");
879 $hash->{$cmd} = $text !~ /unimplemented/i;
886 ## Deprecated methods
891 carp "Use of Net::FTP::lsl deprecated, use 'dir'"
898 carp "Use of Net::FTP::authorise deprecated, use 'authorize'"
910 my($ftp, $path) = @_;
912 # This tries to work both with and without the quote doubling
913 # convention (RFC 959 requires it, but the first 3 servers I checked
914 # didn't implement it). It will fail on a server which uses a quote in
915 # the message which isn't a part of or surrounding the path.
917 $ftp->message =~ /(?:^|\s)\"(.*)\"(?:$|\s)/ &&
918 ($path = $1) =~ s/\"\"/\"/g;
924 ## Communication methods
931 my $pkg = "Net::FTP::" . $ftp->type;
933 eval "require " . $pkg;
937 delete ${*$ftp}{'net_ftp_dataconn'};
939 if(defined ${*$ftp}{'net_ftp_pasv'})
941 my @port = split(/,/,${*$ftp}{'net_ftp_pasv'});
943 $data = $pkg->new(PeerAddr => join(".",@port[0..3]),
944 PeerPort => $port[4] * 256 + $port[5],
945 LocalAddr => ${*$ftp}{'net_ftp_localaddr'},
949 elsif(defined ${*$ftp}{'net_ftp_listen'})
951 $data = ${*$ftp}{'net_ftp_listen'}->accept($pkg);
952 close(delete ${*$ftp}{'net_ftp_listen'});
958 $data->timeout($ftp->timeout);
959 ${*$ftp}{'net_ftp_dataconn'} = $data;
960 ${*$data}{'net_ftp_cmd'} = $ftp;
961 ${*$data}{'net_ftp_blksize'} = ${*$ftp}{'net_ftp_blksize'};
972 delete ${*$ftp}{'net_ftp_port'};
973 delete ${*$ftp}{'net_ftp_pasv'};
975 my $data = $ftp->_data_cmd($cmd,@_);
978 unless(defined $data);
981 bless $data, "Net::FTP::A"; # Force ASCII mode
985 my $blksize = ${*$ftp}{'net_ftp_blksize'};
987 while($data->read($databuf,$blksize)) {
991 my $list = [ split(/\n/,$buf) ];
997 for (@$list) { $_ = $ftp->toebcdic($_) }
1000 wantarray ? @{$list}
1009 my $where = delete ${*$ftp}{'net_ftp_rest'} || 0;
1013 croak("Bad argument '$arg'\n")
1014 if $arg =~ /[\r\n]/s;
1017 if(${*$ftp}{'net_ftp_passive'} &&
1018 !defined ${*$ftp}{'net_ftp_pasv'} &&
1019 !defined ${*$ftp}{'net_ftp_port'})
1023 $ok = defined $ftp->pasv;
1024 $ok = $ftp->_REST($where)
1029 $ftp->command($cmd,@_);
1030 $data = $ftp->_dataconn();
1031 $ok = CMD_INFO == $ftp->response();
1035 if $data && $cmd =~ /RETR|LIST|NLST/;
1045 unless (defined ${*$ftp}{'net_ftp_port'} ||
1046 defined ${*$ftp}{'net_ftp_pasv'});
1048 $ok = $ftp->_REST($where)
1054 $ftp->command($cmd,@_);
1057 if(defined ${*$ftp}{'net_ftp_pasv'});
1059 $ok = CMD_INFO == $ftp->response();
1062 unless exists ${*$ftp}{'net_ftp_intern_port'};
1065 my $data = $ftp->_dataconn();
1068 if $data && $cmd =~ /RETR|LIST|NLST/;
1074 close(delete ${*$ftp}{'net_ftp_listen'});
1080 ## Over-ride methods (Net::Cmd)
1083 sub debug_text { $_[2] =~ /^(pass|resp|acct)/i ? "$1 ....\n" : $_[2]; }
1089 delete ${*$ftp}{'net_ftp_port'};
1090 $ftp->SUPER::command(@_);
1096 my $code = $ftp->SUPER::response();
1098 delete ${*$ftp}{'net_ftp_pasv'}
1099 if ($code != CMD_MORE && $code != CMD_INFO);
1106 return ($1, $2 eq "-")
1107 if $_[1] =~ s/^(\d\d\d)(.?)//o;
1111 # Darn MS FTP server is a load of CRAP !!!!
1113 unless ${*$ftp}{'net_cmd_code'} + 0;
1115 (${*$ftp}{'net_cmd_code'},1);
1119 ## Allow 2 servers to talk directly
1123 my($sftp,$sfile,$dftp,$dfile,$unique) = @_;
1125 ($dfile = $sfile) =~ s#.*/##
1126 unless(defined $dfile);
1128 my $port = $sftp->pasv or
1131 $dftp->port($port) or
1135 unless($unique ? $dftp->stou($dfile) : $dftp->stor($dfile));
1137 unless($sftp->retr($sfile) && $sftp->response == CMD_INFO) {
1138 $sftp->retr($sfile);
1144 $dftp->pasv_wait($sftp);
1149 @_ == 2 or croak 'usage: $ftp->pasv_wait(NON_PASV_FTP)';
1151 my($ftp, $non_pasv) = @_;
1152 my($file,$rin,$rout);
1154 vec($rin='',fileno($ftp),1) = 1;
1155 select($rout=$rin, undef, undef, undef);
1158 $non_pasv->response();
1161 unless $ftp->ok() && $non_pasv->ok();
1164 if $ftp->message =~ /unique file name:\s*(\S*)\s*\)/;
1167 if $non_pasv->message =~ /unique file name:\s*(\S*)\s*\)/;
1172 sub cmd { shift->command(@_)->response() }
1174 ########################################
1179 sub _ABOR { shift->command("ABOR")->response() == CMD_OK }
1180 sub _ALLO { shift->command("ALLO",@_)->response() == CMD_OK}
1181 sub _CDUP { shift->command("CDUP")->response() == CMD_OK }
1182 sub _NOOP { shift->command("NOOP")->response() == CMD_OK }
1183 sub _PASV { shift->command("PASV")->response() == CMD_OK }
1184 sub _QUIT { shift->command("QUIT")->response() == CMD_OK }
1185 sub _DELE { shift->command("DELE",@_)->response() == CMD_OK }
1186 sub _CWD { shift->command("CWD", @_)->response() == CMD_OK }
1187 sub _PORT { shift->command("PORT",@_)->response() == CMD_OK }
1188 sub _RMD { shift->command("RMD", @_)->response() == CMD_OK }
1189 sub _MKD { shift->command("MKD", @_)->response() == CMD_OK }
1190 sub _PWD { shift->command("PWD", @_)->response() == CMD_OK }
1191 sub _TYPE { shift->command("TYPE",@_)->response() == CMD_OK }
1192 sub _RNTO { shift->command("RNTO",@_)->response() == CMD_OK }
1193 sub _RESP { shift->command("RESP",@_)->response() == CMD_OK }
1194 sub _MDTM { shift->command("MDTM",@_)->response() == CMD_OK }
1195 sub _SIZE { shift->command("SIZE",@_)->response() == CMD_OK }
1196 sub _HELP { shift->command("HELP",@_)->response() == CMD_OK }
1197 sub _STAT { shift->command("STAT",@_)->response() == CMD_OK }
1198 sub _APPE { shift->command("APPE",@_)->response() == CMD_INFO }
1199 sub _LIST { shift->command("LIST",@_)->response() == CMD_INFO }
1200 sub _NLST { shift->command("NLST",@_)->response() == CMD_INFO }
1201 sub _RETR { shift->command("RETR",@_)->response() == CMD_INFO }
1202 sub _STOR { shift->command("STOR",@_)->response() == CMD_INFO }
1203 sub _STOU { shift->command("STOU",@_)->response() == CMD_INFO }
1204 sub _RNFR { shift->command("RNFR",@_)->response() == CMD_MORE }
1205 sub _REST { shift->command("REST",@_)->response() == CMD_MORE }
1206 sub _USER { shift->command("user",@_)->response() } # A certain brain dead firewall :-)
1207 sub _PASS { shift->command("PASS",@_)->response() }
1208 sub _ACCT { shift->command("ACCT",@_)->response() }
1209 sub _AUTH { shift->command("AUTH",@_)->response() }
1211 sub _SMNT { shift->unsupported(@_) }
1212 sub _MODE { shift->unsupported(@_) }
1213 sub _SYST { shift->unsupported(@_) }
1214 sub _STRU { shift->unsupported(@_) }
1215 sub _REIN { shift->unsupported(@_) }
1223 Net::FTP - FTP Client class
1229 $ftp = Net::FTP->new("some.host.name", Debug => 0)
1230 or die "Cannot connect to some.host.name: $@";
1232 $ftp->login("anonymous",'-anonymous@')
1233 or die "Cannot login ", $ftp->message;
1236 or die "Cannot change working directory ", $ftp->message;
1238 $ftp->get("that.file")
1239 or die "get failed ", $ftp->message;
1245 C<Net::FTP> is a class implementing a simple FTP client in Perl as
1246 described in RFC959. It provides wrappers for a subset of the RFC959
1251 FTP stands for File Transfer Protocol. It is a way of transferring
1252 files between networked machines. The protocol defines a client
1253 (whose commands are provided by this module) and a server (not
1254 implemented in this module). Communication is always initiated by the
1255 client, and the server responds with a message and a status code (and
1256 sometimes with data).
1258 The FTP protocol allows files to be sent to or fetched from the
1259 server. Each transfer involves a B<local file> (on the client) and a
1260 B<remote file> (on the server). In this module, the same file name
1261 will be used for both local and remote if only one is specified. This
1262 means that transferring remote file C</path/to/file> will try to put
1263 that file in C</path/to/file> locally, unless you specify a local file
1266 The protocol also defines several standard B<translations> which the
1267 file can undergo during transfer. These are ASCII, EBCDIC, binary,
1268 and byte. ASCII is the default type, and indicates that the sender of
1269 files will translate the ends of lines to a standard representation
1270 which the receiver will then translate back into their local
1271 representation. EBCDIC indicates the file being transferred is in
1272 EBCDIC format. Binary (also known as image) format sends the data as
1273 a contiguous bit stream. Byte format transfers the data as bytes, the
1274 values of which remain the same regardless of differences in byte size
1275 between the two machines (in theory - in practice you should only use
1276 this if you really know what you're doing).
1282 =item new (HOST [,OPTIONS])
1284 This is the constructor for a new Net::FTP object. C<HOST> is the
1285 name of the remote host to which an FTP connection is required.
1287 C<OPTIONS> are passed in a hash like fashion, using key and value pairs.
1288 Possible options are:
1290 B<Firewall> - The name of a machine which acts as an FTP firewall. This can be
1291 overridden by an environment variable C<FTP_FIREWALL>. If specified, and the
1292 given host cannot be directly connected to, then the
1293 connection is made to the firewall machine and the string C<@hostname> is
1294 appended to the login identifier. This kind of setup is also refered to
1297 B<FirewallType> - The type of firewall running on the machine indicated by
1298 B<Firewall>. This can be overridden by an environment variable
1299 C<FTP_FIREWALL_TYPE>. For a list of permissible types, see the description of
1300 ftp_firewall_type in L<Net::Config>.
1302 B<BlockSize> - This is the block size that Net::FTP will use when doing
1303 transfers. (defaults to 10240)
1305 B<Port> - The port number to connect to on the remote machine for the
1308 B<Timeout> - Set a timeout value (defaults to 120)
1310 B<Debug> - debug level (see the debug method in L<Net::Cmd>)
1312 B<Passive> - If set to a non-zero value then all data transfers will be done
1313 using passive mode. This is not usually required except for some I<dumb>
1314 servers, and some firewall configurations. This can also be set by the
1315 environment variable C<FTP_PASSIVE>.
1317 B<Hash> - If given a reference to a file handle (e.g., C<\*STDERR>),
1318 print hash marks (#) on that filehandle every 1024 bytes. This
1319 simply invokes the C<hash()> method for you, so that hash marks
1320 are displayed for all transfers. You can, of course, call C<hash()>
1321 explicitly whenever you'd like.
1323 B<LocalAddr> - Local address to use for all socket connections, this
1324 argument will be passed to L<IO::Socket::INET>
1326 If the constructor fails undef will be returned and an error message will
1333 Unless otherwise stated all methods return either a I<true> or I<false>
1334 value, with I<true> meaning that the operation was a success. When a method
1335 states that it returns a value, failure will be returned as I<undef> or an
1340 =item login ([LOGIN [,PASSWORD [, ACCOUNT] ] ])
1342 Log into the remote FTP server with the given login information. If
1343 no arguments are given then the C<Net::FTP> uses the C<Net::Netrc>
1344 package to lookup the login information for the connected host.
1345 If no information is found then a login of I<anonymous> is used.
1346 If no password is given and the login is I<anonymous> then I<anonymous@>
1347 will be used for password.
1349 If the connection is via a firewall then the C<authorize> method will
1350 be called with no arguments.
1352 =item authorize ( [AUTH [, RESP]])
1354 This is a protocol used by some firewall ftp proxies. It is used
1355 to authorise the user to send data out. If both arguments are not specified
1356 then C<authorize> uses C<Net::Netrc> to do a lookup.
1360 Send a SITE command to the remote server and wait for a response.
1362 Returns most significant digit of the response code.
1364 =item type (TYPE [, ARGS])
1366 This method will send the TYPE command to the remote FTP server
1367 to change the type of data transfer. The return value is the previous
1370 =item ascii ([ARGS]) binary([ARGS]) ebcdic([ARGS]) byte([ARGS])
1372 Synonyms for C<type> with the first arguments set correctly
1374 B<NOTE> ebcdic and byte are not fully supported.
1376 =item rename ( OLDNAME, NEWNAME )
1378 Rename a file on the remote FTP server from C<OLDNAME> to C<NEWNAME>. This
1379 is done by sending the RNFR and RNTO commands.
1381 =item delete ( FILENAME )
1383 Send a request to the server to delete C<FILENAME>.
1385 =item cwd ( [ DIR ] )
1387 Attempt to change directory to the directory given in C<$dir>. If
1388 C<$dir> is C<"..">, the FTP C<CDUP> command is used to attempt to
1389 move up one directory. If no directory is given then an attempt is made
1390 to change the directory to the root directory.
1394 Change directory to the parent of the current directory.
1398 Returns the full pathname of the current directory.
1400 =item restart ( WHERE )
1402 Set the byte offset at which to begin the next data transfer. Net::FTP simply
1403 records this value and uses it when during the next data transfer. For this
1404 reason this method will not return an error, but setting it may cause
1405 a subsequent data transfer to fail.
1409 Remove the directory with the name C<DIR>.
1411 =item mkdir ( DIR [, RECURSE ])
1413 Create a new directory with the name C<DIR>. If C<RECURSE> is I<true> then
1414 C<mkdir> will attempt to create all the directories in the given path.
1416 Returns the full pathname to the new directory.
1418 =item ls ( [ DIR ] )
1420 =item alloc ( SIZE [, RECORD_SIZE] )
1422 The alloc command allows you to give the ftp server a hint about the size
1423 of the file about to be transfered using the ALLO ftp command. Some storage
1424 systems use this to make intelligent decisions about how to store the file.
1425 The C<SIZE> argument represents the size of the file in bytes. The
1426 C<RECORD_SIZE> argument indicates a mazimum record or page size for files
1427 sent with a record or page structure.
1429 The size of the file will be determined, and sent to the server
1430 automatically for normal files so that this method need only be called if
1431 you are transfering data from a socket, named pipe, or other stream not
1432 associated with a normal file.
1434 Get a directory listing of C<DIR>, or the current directory.
1436 In an array context, returns a list of lines returned from the server. In
1437 a scalar context, returns a reference to a list.
1439 =item dir ( [ DIR ] )
1441 Get a directory listing of C<DIR>, or the current directory in long format.
1443 In an array context, returns a list of lines returned from the server. In
1444 a scalar context, returns a reference to a list.
1446 =item get ( REMOTE_FILE [, LOCAL_FILE [, WHERE]] )
1448 Get C<REMOTE_FILE> from the server and store locally. C<LOCAL_FILE> may be
1449 a filename or a filehandle. If not specified, the file will be stored in
1450 the current directory with the same leafname as the remote file.
1452 If C<WHERE> is given then the first C<WHERE> bytes of the file will
1453 not be transfered, and the remaining bytes will be appended to
1454 the local file if it already exists.
1456 Returns C<LOCAL_FILE>, or the generated local file name if C<LOCAL_FILE>
1457 is not given. If an error was encountered undef is returned.
1459 =item put ( LOCAL_FILE [, REMOTE_FILE ] )
1461 Put a file on the remote server. C<LOCAL_FILE> may be a name or a filehandle.
1462 If C<LOCAL_FILE> is a filehandle then C<REMOTE_FILE> must be specified. If
1463 C<REMOTE_FILE> is not specified then the file will be stored in the current
1464 directory with the same leafname as C<LOCAL_FILE>.
1466 Returns C<REMOTE_FILE>, or the generated remote filename if C<REMOTE_FILE>
1469 B<NOTE>: If for some reason the transfer does not complete and an error is
1470 returned then the contents that had been transfered will not be remove
1473 =item put_unique ( LOCAL_FILE [, REMOTE_FILE ] )
1475 Same as put but uses the C<STOU> command.
1477 Returns the name of the file on the server.
1479 =item append ( LOCAL_FILE [, REMOTE_FILE ] )
1481 Same as put but appends to the file on the remote server.
1483 Returns C<REMOTE_FILE>, or the generated remote filename if C<REMOTE_FILE>
1486 =item unique_name ()
1488 Returns the name of the last file stored on the server using the
1493 Returns the I<modification time> of the given file
1497 Returns the size in bytes for the given file as stored on the remote server.
1499 B<NOTE>: The size reported is the size of the stored file on the remote server.
1500 If the file is subsequently transfered from the server in ASCII mode
1501 and the remote server and local machine have different ideas about
1502 "End Of Line" then the size of file on the local machine after transfer
1505 =item supported ( CMD )
1507 Returns TRUE if the remote server supports the given command.
1509 =item hash ( [FILEHANDLE_GLOB_REF],[ BYTES_PER_HASH_MARK] )
1511 Called without parameters, or with the first argument false, hash marks
1512 are suppressed. If the first argument is true but not a reference to a
1513 file handle glob, then \*STDERR is used. The second argument is the number
1514 of bytes per hash mark printed, and defaults to 1024. In all cases the
1515 return value is a reference to an array of two: the filehandle glob reference
1516 and the bytes per hash mark.
1520 The following methods can return different results depending on
1521 how they are called. If the user explicitly calls either
1522 of the C<pasv> or C<port> methods then these methods will
1523 return a I<true> or I<false> value. If the user does not
1524 call either of these methods then the result will be a
1525 reference to a C<Net::FTP::dataconn> based object.
1529 =item nlst ( [ DIR ] )
1531 Send an C<NLST> command to the server, with an optional parameter.
1533 =item list ( [ DIR ] )
1535 Same as C<nlst> but using the C<LIST> command
1539 Begin the retrieval of a file called C<FILE> from the remote server.
1543 Tell the server that you wish to store a file. C<FILE> is the
1544 name of the new file that should be created.
1548 Same as C<stor> but using the C<STOU> command. The name of the unique
1549 file which was created on the server will be available via the C<unique_name>
1550 method after the data connection has been closed.
1554 Tell the server that we want to append some data to the end of a file
1555 called C<FILE>. If this file does not exist then create it.
1559 If for some reason you want to have complete control over the data connection,
1560 this includes generating it and calling the C<response> method when required,
1561 then the user can use these methods to do so.
1563 However calling these methods only affects the use of the methods above that
1564 can return a data connection. They have no effect on methods C<get>, C<put>,
1565 C<put_unique> and those that do not require data connections.
1569 =item port ( [ PORT ] )
1571 Send a C<PORT> command to the server. If C<PORT> is specified then it is sent
1572 to the server. If not, then a listen socket is created and the correct information
1577 Tell the server to go into passive mode. Returns the text that represents the
1578 port on which the server is listening, this text is in a suitable form to
1579 sent to another ftp server using the C<port> method.
1583 The following methods can be used to transfer files between two remote
1584 servers, providing that these two servers can connect directly to each other.
1588 =item pasv_xfer ( SRC_FILE, DEST_SERVER [, DEST_FILE ] )
1590 This method will do a file transfer between two remote ftp servers. If
1591 C<DEST_FILE> is omitted then the leaf name of C<SRC_FILE> will be used.
1593 =item pasv_xfer_unique ( SRC_FILE, DEST_SERVER [, DEST_FILE ] )
1595 Like C<pasv_xfer> but the file is stored on the remote server using
1598 =item pasv_wait ( NON_PASV_SERVER )
1600 This method can be used to wait for a transfer to complete between a passive
1601 server and a non-passive server. The method should be called on the passive
1602 server with the C<Net::FTP> object for the non-passive server passed as an
1607 Abort the current data transfer.
1611 Send the QUIT command to the remote FTP server and close the socket connection.
1615 =head2 Methods for the adventurous
1617 C<Net::FTP> inherits from C<Net::Cmd> so methods defined in C<Net::Cmd> may
1618 be used to send commands to the remote FTP server.
1622 =item quot (CMD [,ARGS])
1624 Send a command, that Net::FTP does not directly support, to the remote
1625 server and wait for a response.
1627 Returns most significant digit of the response code.
1629 B<WARNING> This call should only be used on commands that do not require
1630 data connections. Misuse of this method can hang the connection.
1634 =head1 THE dataconn CLASS
1636 Some of the methods defined in C<Net::FTP> return an object which will
1637 be derived from this class.The dataconn class itself is derived from
1638 the C<IO::Socket::INET> class, so any normal IO operations can be performed.
1639 However the following methods are defined in the dataconn class and IO should
1640 be performed using these.
1644 =item read ( BUFFER, SIZE [, TIMEOUT ] )
1646 Read C<SIZE> bytes of data from the server and place it into C<BUFFER>, also
1647 performing any <CRLF> translation necessary. C<TIMEOUT> is optional, if not
1648 given, the timeout value from the command connection will be used.
1650 Returns the number of bytes read before any <CRLF> translation.
1652 =item write ( BUFFER, SIZE [, TIMEOUT ] )
1654 Write C<SIZE> bytes of data from C<BUFFER> to the server, also
1655 performing any <CRLF> translation necessary. C<TIMEOUT> is optional, if not
1656 given, the timeout value from the command connection will be used.
1658 Returns the number of bytes written before any <CRLF> translation.
1662 Returns the number of bytes read so far.
1666 Abort the current data transfer.
1670 Close the data connection and get a response from the FTP server. Returns
1671 I<true> if the connection was closed successfully and the first digit of
1672 the response from the server was a '2'.
1676 =head1 UNIMPLEMENTED
1678 The following RFC959 commands have not been implemented:
1684 Mount a different file system structure without changing login or
1685 accounting information.
1689 Ask the server for "helpful information" (that's what the RFC says) on
1690 the commands it accepts.
1694 Specifies transfer mode (stream, block or compressed) for file to be
1699 Request remote server system identification.
1703 Request remote server status.
1707 Specifies file structure for file to be transferred.
1711 Reinitialize the connection, flushing all I/O and account information.
1715 =head1 REPORTING BUGS
1717 When reporting bugs/problems please include as much information as possible.
1718 It may be difficult for me to reproduce the problem as almost every setup
1721 A small script which yields the problem will probably be of help. It would
1722 also be useful if this script was run with the extra options C<Debug => 1>
1723 passed to the constructor, and the output sent with the bug report. If you
1724 cannot include a small script then please include a Debug trace from a
1725 run of your program which does yield the problem.
1729 Graham Barr <gbarr@pobox.com>
1736 ftp(1), ftpd(8), RFC 959
1737 http://www.cis.ohio-state.edu/htbin/rfc/rfc959.html
1741 For an example of the use of Net::FTP see
1745 =item http://www.csh.rit.edu/~adam/Progs/autoftp-2.0.tar.gz
1747 C<autoftp> is a program that can retrieve, send, or list files via
1748 the FTP protocol in a non-interactive manner.
1754 Henry Gabryjelski <henryg@WPI.EDU> - for the suggestion of creating directories
1757 Nathan Torkington <gnat@frii.com> - for some input on the documentation.
1759 Roderick Schertler <roderick@gate.net> - for various inputs
1763 Copyright (c) 1995-1998 Graham Barr. All rights reserved.
1764 This program is free software; you can redistribute it and/or modify it
1765 under the same terms as Perl itself.
1769 I<$Id: //depot/libnet/Net/FTP.pm#76 $>