POE::Component::Client::FTP - Implements an FTP client POE Component
use POE::Component::Client::FTP;
POE::Component::Client::FTP->spawn ( Alias => 'ftp', Username => 'test', Password => 'test', RemoteAddr => 'localhost', Events => [ qw( authenticated put_connected put_error put_closed get_connected get_data get_done size ) ] );
# we are authenticated sub authenticated { $poe_kernel->post('ftp', 'command', 'args'); }
# data connection is ready for data sub put_connected { my ($status, $line, $param) = @_[ARG0..ARG3];
open FILE, "/etc/passwd" or die $!; $poe_kernel->post('ftp', 'put_data', $_) while (<FILE>); close FILE; $poe_kernel->post('ftp', 'put_close'); }
# something bad happened sub put_error { my ($error, $param) = @_[ARG0,ARG1];
warn "ERROR: '$error' occured while trying to STOR '$param'"; }
# data connection closed sub put_closed { my ($param) = @_[ARG0]; }
# file on the way... sub get_connected { my ($filename) = @_[ARG0]; }
# getting data from the file... sub get_data { my ($data, $filename) = @_[ARG0,ARG1];
}
# and its done sub get_done { my ($filename) = @_[ARG0]; }
# response to a size command sub size { my ($code, $size, $filename) = @_[ARG0,ARG1,ARG2];
print "$filename was $size"; }
$poe_kernel->run();
Latest version and samples script can be found at: http://www.wush.net/poe/ftp
Client module for FTP
Untested.
After receiving a put_connected event you can post put_data events to send data to the server.
Closes the data connection. put_closed will be emit when connection is flushed and closed.
Output for connect consists of "connected" upon successful connection to server, and "connect_error" if the connection fails or times out. Upon failure, you can post a "connect" message to retry the connection.
Output for login is either "authenticated" if the login was accepted, or "login_error" if it was rejected.
Output is for "simple" ftp events is simply "event". Error cases are "event_error". ARG0 is the numeric code, ARG1 is the text response, and ARG2 is the parameter you made the call with. This is useful since commands such as size do not remind you of this in the server response.
Output for "complex" or data socket ftp commands is creates "event_connection" upon socket connection, "event_data" for each item of data, and "event_done" when all data is done being sent.
Output from put is "put_error" for an error creating a connection or "put_connected". If you receive "put_connected" you can post "put_data" commands to the component to have it write. A "put_done" command closes and writes. Upon completion, a "put_closed" or "put_error" is posted back to you.
the POE manpage, the perl manpage, the Net::FTP module, RFC 959
High level put and get functions which would accept filenames or filehandles. This may simplify creation of an ftp client or batch script.
Eventually a graphical ftp client might be interesting. Please email me if you decide to attempt this.
Allow get/put functions to be given filenames or filehandles instead of requiring the calling script to do standard file io in handlers.
To do the blocksize, I simply rely on the BlockSize parameter in the Wheel::ReadWrite. Although it is honored for receiving data, sending data is done as elements in the array. Possibly change Driver::SysRW or submit to the Wheel in proper sizes. Do not count on receive blocks coming in proper sizes.
FTP_ASCII and FTP_BINARY are not implemented. Use the 'type' command.
PORT does not know what ip address it is listening on. It gets 0.0.0.0. Use LocalAddr in the constructor and it all works fine.
Copyright (c) 2002 Michael Ching. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
2 POD Errors
The following errors were encountered while parsing the POD:
'=item' outside of any '=over'
You forgot a '=back' before '=head1'
To install POE::Component::Client::FTP, copy and paste the appropriate command in to your terminal.
cpanm
cpanm POE::Component::Client::FTP
CPAN shell
perl -MCPAN -e shell install POE::Component::Client::FTP
For more information on module installation, please visit the detailed CPAN module installation guide.