sub _STOU { shift->command("STOU", @_)->response() == CMD_INFO }sub _RNFR { shift->command("RNFR", @_)->response() == CMD_MORE }sub _REST { shift->command("REST", @_)->response() == CMD_MORE }sub _PASS { shift->command("PASS", @_)->response() }sub _ACCT { shift->command("ACCT", @_)->response() }sub _AUTH { shift->command("AUTH", @_)->response() }sub _USER {  my $ftp = shift;  my $ok  = $ftp->command("USER", @_)->response();  # A certain brain dead firewall :-)  $ok = $ftp->command("user", @_)->response()    unless $ok == CMD_MORE or $ok == CMD_OK;  $ok;}sub _SMNT { shift->unsupported(@_) }sub _MODE { shift->unsupported(@_) }sub _SYST { shift->unsupported(@_) }sub _STRU { shift->unsupported(@_) }sub _REIN { shift->unsupported(@_) }1;__END__=head1 NAMENet::FTP - FTP Client class=head1 SYNOPSIS    use Net::FTP;    $ftp = Net::FTP->new("some.host.name", Debug => 0)      or die "Cannot connect to some.host.name: $@";    $ftp->login("anonymous",'-anonymous@')      or die "Cannot login ", $ftp->message;    $ftp->cwd("/pub")      or die "Cannot change working directory ", $ftp->message;    $ftp->get("that.file")      or die "get failed ", $ftp->message;    $ftp->quit;=head1 DESCRIPTIONC<Net::FTP> is a class implementing a simple FTP client in Perl asdescribed in RFC959.  It provides wrappers for a subset of the RFC959commands.=head1 OVERVIEWFTP stands for File Transfer Protocol.  It is a way of transferringfiles between networked machines.  The protocol defines a client(whose commands are provided by this module) and a server (notimplemented in this module).  Communication is always initiated by theclient, and the server responds with a message and a status code (andsometimes with data).The FTP protocol allows files to be sent to or fetched from theserver.  Each transfer involves a B<local file> (on the client) and aB<remote file> (on the server).  In this module, the same file namewill be used for both local and remote if only one is specified.  Thismeans that transferring remote file C</path/to/file> will try to putthat file in C</path/to/file> locally, unless you specify a local filename.The protocol also defines several standard B<translations> which thefile can undergo during transfer.  These are ASCII, EBCDIC, binary,and byte.  ASCII is the default type, and indicates that the sender offiles will translate the ends of lines to a standard representationwhich the receiver will then translate back into their localrepresentation.  EBCDIC indicates the file being transferred is inEBCDIC format.  Binary (also known as image) format sends the data asa contiguous bit stream.  Byte format transfers the data as bytes, thevalues of which remain the same regardless of differences in byte sizebetween the two machines (in theory - in practice you should only usethis if you really know what you're doing).=head1 CONSTRUCTOR=over 4=item new ([ HOST ] [, OPTIONS ])This is the constructor for a new Net::FTP object. C<HOST> is thename of the remote host to which an FTP connection is required.C<HOST> is optional. If C<HOST> is not given then it may instead bepassed as the C<Host> option described below. C<OPTIONS> are passed in a hash like fashion, using key and value pairs.Possible options are:B<Host> - FTP host to connect to. It may be a single scalar, as defined forthe C<PeerAddr> option in L<IO::Socket::INET>, or a reference toan array with hosts to try in turn. The L</host> method will return the valuewhich was used to connect to the host.B<Firewall> - The name of a machine which acts as an FTP firewall. This can beoverridden by an environment variable C<FTP_FIREWALL>. If specified, and thegiven host cannot be directly connected to, then theconnection is made to the firewall machine and the string C<@hostname> isappended to the login identifier. This kind of setup is also referred toas an ftp proxy.B<FirewallType> - The type of firewall running on the machine indicated byB<Firewall>. This can be overridden by an environment variableC<FTP_FIREWALL_TYPE>. For a list of permissible types, see the description offtp_firewall_type in L<Net::Config>.B<BlockSize> - This is the block size that Net::FTP will use when doingtransfers. (defaults to 10240)B<Port> - The port number to connect to on the remote machine for theFTP connectionB<Timeout> - Set a timeout value (defaults to 120)B<Debug> - debug level (see the debug method in L<Net::Cmd>)B<Passive> - If set to a non-zero value then all data transfers willbe done using passive mode. If set to zero then data transfers will bedone using active mode.  If the machine is connected to the Internetdirectly, both passive and active mode should work equally well.Behind most firewall and NAT configurations passive mode has a betterchance of working.  However, in some rare firewall configurations,active mode actually works when passive mode doesn't.  Some really oldFTP servers might not implement passive transfers.  If not specified,then the transfer mode is set by the environment variableC<FTP_PASSIVE> or if that one is not set by the settings done by theF<libnetcfg> utility.  If none of these apply then passive mode isused.B<Hash> - If given a reference to a file handle (e.g., C<\*STDERR>),print hash marks (#) on that filehandle every 1024 bytes.  Thissimply invokes the C<hash()> method for you, so that hash marksare displayed for all transfers.  You can, of course, call C<hash()>explicitly whenever you'd like.B<LocalAddr> - Local address to use for all socket connections, thisargument will be passed to L<IO::Socket::INET>If the constructor fails undef will be returned and an error message willbe in $@=back=head1 METHODSUnless otherwise stated all methods return either a I<true> or I<false>value, with I<true> meaning that the operation was a success. When a methodstates that it returns a value, failure will be returned as I<undef> or anempty list.=over 4=item login ([LOGIN [,PASSWORD [, ACCOUNT] ] ])Log into the remote FTP server with the given login information. Ifno arguments are given then the C<Net::FTP> uses the C<Net::Netrc>package to lookup the login information for the connected host.If no information is found then a login of I<anonymous> is used.If no password is given and the login is I<anonymous> then I<anonymous@>will be used for password.If the connection is via a firewall then the C<authorize> method willbe called with no arguments.=item authorize ( [AUTH [, RESP]])This is a protocol used by some firewall ftp proxies. It is usedto authorise the user to send data out.  If both arguments are not specifiedthen C<authorize> uses C<Net::Netrc> to do a lookup.=item site (ARGS)Send a SITE command to the remote server and wait for a response.Returns most significant digit of the response code.=item asciiTransfer file in ASCII. CRLF translation will be done if required=item binaryTransfer file in binary mode. No transformation will be done.B<Hint>: If both server and client machines use the same line ending fortext files, then it will be faster to transfer all files in binary mode.=item rename ( OLDNAME, NEWNAME )Rename a file on the remote FTP server from C<OLDNAME> to C<NEWNAME>. Thisis done by sending the RNFR and RNTO commands.=item delete ( FILENAME )Send a request to the server to delete C<FILENAME>.=item cwd ( [ DIR ] )Attempt to change directory to the directory given in C<$dir>.  IfC<$dir> is C<"..">, the FTP C<CDUP> command is used to attempt tomove up one directory. If no directory is given then an attempt is madeto change the directory to the root directory.=item cdup ()Change directory to the parent of the current directory.=item pwd ()Returns the full pathname of the current directory.=item restart ( WHERE )Set the byte offset at which to begin the next data transfer. Net::FTP simplyrecords this value and uses it when during the next data transfer. For thisreason this method will not return an error, but setting it may causea subsequent data transfer to fail.=item rmdir ( DIR [, RECURSE ])Remove the directory with the name C<DIR>. If C<RECURSE> is I<true> thenC<rmdir> will attempt to delete everything inside the directory.=item mkdir ( DIR [, RECURSE ])Create a new directory with the name C<DIR>. If C<RECURSE> is I<true> thenC<mkdir> will attempt to create all the directories in the given path.Returns the full pathname to the new directory.=item alloc ( SIZE [, RECORD_SIZE] )The alloc command allows you to give the ftp server a hint about the sizeof the file about to be transferred using the ALLO ftp command. Some storagesystems use this to make intelligent decisions about how to store the file.The C<SIZE> argument represents the size of the file in bytes. TheC<RECORD_SIZE> argument indicates a maximum record or page size for filessent with a record or page structure.The size of the file will be determined, and sent to the serverautomatically for normal files so that this method need only be called ifyou are transferring data from a socket, named pipe, or other stream notassociated with a normal file.=item ls ( [ DIR ] )Get a directory listing of C<DIR>, or the current directory.In an array context, returns a list of lines returned from the server. Ina scalar context, returns a reference to a list.=item dir ( [ DIR ] )Get a directory listing of C<DIR>, or the current directory in long format.In an array context, returns a list of lines returned from the server. Ina scalar context, returns a reference to a list.=item get ( REMOTE_FILE [, LOCAL_FILE [, WHERE]] )Get C<REMOTE_FILE> from the server and store locally. C<LOCAL_FILE> may bea filename or a filehandle. If not specified, the file will be stored inthe current directory with the same leafname as the remote file.If C<WHERE> is given then the first C<WHERE> bytes of the file willnot be transferred, and the remaining bytes will be appended tothe local file if it already exists.Returns C<LOCAL_FILE>, or the generated local file name if C<LOCAL_FILE>is not given. If an error was encountered undef is returned.=item put ( LOCAL_FILE [, REMOTE_FILE ] )Put a file on the remote server. C<LOCAL_FILE> may be a name or a filehandle.If C<LOCAL_FILE> is a filehandle then C<REMOTE_FILE> must be specified. IfC<REMOTE_FILE> is not specified then the file will be stored in the currentdirectory with the same leafname as C<LOCAL_FILE>.Returns C<REMOTE_FILE>, or the generated remote filename if C<REMOTE_FILE>is not given.B<NOTE>: If for some reason the transfer does not complete and an error isreturned then the contents that had been transferred will not be removeautomatically.=item put_unique ( LOCAL_FILE [, REMOTE_FILE ] )Same as put but uses the C<STOU> command.Returns the name of the file on the server.=item append ( LOCAL_FILE [, REMOTE_FILE ] )Same as put but appends to the file on the remote server.Returns C<REMOTE_FILE>, or the generated remote filename if C<REMOTE_FILE>is not given.=item unique_name ()Returns the name of the last file stored on the server using theC<STOU> command.=item mdtm ( FILE )Returns the I<modification time> of the given file=item size ( FILE )Returns the size in bytes for the given file as stored on the remote server.B<NOTE>: The size reported is the size of the stored file on the remote server.If the file is subsequently transferred from the server in ASCII modeand the remote server and local machine have different ideas about"End Of Line" then the size of file on the local machine after transfermay be different.=item supported ( CMD )Returns TRUE if the remote server supports the given command.=item hash ( [FILEHANDLE_GLOB_REF],[ BYTES_PER_HASH_MARK] )Called without parameters, or with the first argument false, hash marksare suppressed.  If the first argument is true but not a reference to a file handle glob, then \*STDERR is used.  The second argument is the numberof bytes per hash mark printed, and defaults to 1024.  In all cases thereturn value is a reference to an array of two:  the filehandle glob referenceand the bytes per hash mark.=item feature ( NAME )Determine if the server supports the specified feature. The returnvalue is a list of lines the server responded with to describe theoptions that it supports for the given feature. If the feature isunsupported then the empty list is returned.  if ($ftp->feature( 'MDTM' )) {    # Do something  }  if (grep { /\bTLS\b/ } $ftp->feature('AUTH')) {    # Server supports TLS  }=backThe following methods can return different results depending onhow they are called. If the user explicitly calls eitherof the C<pasv> or C<port> methods then these methods willreturn a I<true> or I<false> value. If the user does notcall either of these methods then the result will be areference to a C<Net::FTP::dataconn> based object.=over 4=item nlst ( [ DIR ] )Send an C<NLST> command to the server, with an optional parameter.=item list ( [ DIR ] )Same as C<nlst> but using the C<LIST> command=item retr ( FILE )Begin the retrieval of a file called C<FILE> from the remote server.=item stor ( FILE )Tell the server that you wish to store a file. C<FILE> is thename of the new file that should be created.=item stou ( FILE )Same as C<stor> but using the C<STOU> command. The name of the uniquefile which was created on the server will be available via the C<unique_name>method after the data connection has been closed.=item appe ( FILE )Tell the server that we want to append some data to the end of a filecalled C<FILE>. If this file does not exist then create it.=backIf for some reason you want to have complete control over the data connection,this includes generating it and calling the C<response> method when required,then the user can use these methods to do so.However calling these methods only affects the use of the methods above thatcan return a data connection. They have no effect on methods C<get>, C<put>,C<put_unique> and those that do not require data connections.=over 4=item port ( [ PORT ] )Send a C<PORT> command to the server. If C<PORT> is specified then it is sentto the server. If not, then a listen socket is created and the correct informationsent to the server.=item pasv ()Tell the server to go into passive mode. Returns the text that represents theport on which the server is listening, this text is in a suitable form tosent to another ftp server using the C<port> method.=backThe following methods can be used to transfer files between two remoteservers, providing that these two servers can connect directly to each other.=over 4=item pasv_xfer ( SRC_FILE, DEST_SERVER [, DEST_FILE ] )This method will do a file transfer between two remote ftp servers. IfC<DEST_FILE> is omitted then the leaf name of C<SRC_FILE> will be used.=item pasv_xfer_unique ( SRC_FILE, DEST_SERVER [, DEST_FILE ] )Like C<pasv_xfer> but the file is stored on the remote server usingthe STOU command.=item pasv_wait ( NON_PASV_SERVER )This method can be used to wait for a transfer to complete between a passiveserver and a non-passive server. The method should be called on the passiveserver with the C<Net::FTP> object for the non-passive server passed as anargument.=item abort ()Abort the current data transfer.=item quit ()Send the QUIT command to the remote FTP server and close the socket connection.=back=head2 Methods for the adventurousC<Net::FTP> inherits from C<Net::Cmd> so methods defined in C<Net::Cmd> maybe used to send commands to the remote FTP server.=over 4=item quot (CMD [,ARGS])Send a command, that Net::FTP does not directly support, to the remoteserver and wait for a response.Returns most significant digit of the response code.B<WARNING> This call should only be used on commands that do not requiredata connections. Misuse of this method can hang the connection.=back=head1 THE dataconn CLASSSome of the methods defined in C<Net::FTP> return an object which willbe derived from this class.The dataconn class itself is derived fromthe C<IO::Socket::INET> class, so any normal IO operations can be performed.However the following methods are defined in the dataconn class and IO shouldbe performed using these.=over 4=item read ( BUFFER, SIZE [, TIMEOUT ] )Read C<SIZE> bytes of data from the server and place it into C<BUFFER>, alsoperforming any <CRLF> translation necessary. C<TIMEOUT> is optional, if notgiven, the timeout value from the command connection will be used.Returns the number of bytes read before any <CRLF> translation.=item write ( BUFFER, SIZE [, TIMEOUT ] )Write C<SIZE> bytes of data from C<BUFFER> to the server, alsoperforming any <CRLF> translation necessary. C<TIMEOUT> is optional, if notgiven, the timeout value from the command connection will be used.Returns the number of bytes written before any <CRLF> translation.=item bytes_read ()Returns the number of bytes read so far.=item abort ()Abort the current data transfer.=item close ()Close the data connection and get a response from the FTP server. ReturnsI<true> if the connection was closed successfully and the first digit ofthe response from the server was a '2'.=back=head1 UNIMPLEMENTEDThe following RFC959 commands have not been implemented:=over 4=item B<SMNT>Mount a different file system structure without changing login oraccounting information.=item B<HELP>Ask the server for "helpful information" (that's what the RFC says) onthe commands it accepts.=item B<MODE>Specifies transfer mode (stream, block or compressed) for file to betransferred.=item B<SYST>Request remote server system identification.=item B<STAT>Request remote server status.=item B<STRU>Specifies file structure for file to be transferred.=item B<REIN>Reinitialize the connection, flushing all I/O and account information.=back=head1 REPORTING BUGSWhen reporting bugs/problems please include as much information as possible.It may be difficult for me to reproduce the problem as almost every setupis different.A small script which yields the problem will probably be of help. It wouldalso be useful if this script was run with the extra options C<Debug => 1>passed to the constructor, and the output sent with the bug report. If youcannot include a small script then please include a Debug trace from arun of your program which does yield the problem.=head1 AUTHORGraham Barr <gbarr@pobox.com>=head1 SEE ALSOL<Net::Netrc>L<Net::Cmd>ftp(1), ftpd(8), RFC 959http://www.cis.ohio-state.edu/htbin/rfc/rfc959.html=head1 USE EXAMPLESFor an example of the use of Net::FTP see=over 4=item http://www.csh.rit.edu/~adam/Progs/C<autoftp> is a program that can retrieve, send, or list files viathe FTP protocol in a non-interactive manner.=back=head1 CREDITSHenry Gabryjelski <henryg@WPI.EDU> - for the suggestion of creating directoriesrecursively.Nathan Torkington <gnat@frii.com> - for some input on the documentation.Roderick Schertler <roderick@gate.net> - for various inputs=head1 COPYRIGHTCopyright (c) 1995-2004 Graham Barr. All rights reserved.This program is free software; you can redistribute it and/or modify itunder the same terms as Perl itself.=cut