/ 
POE-Component-IRC-5.90
River stage three • 54 direct dependents • 109 total dependents
/ POE::Component::IRC::Plugin::DCC

NAME

POE::Component::IRC::Plugin::DCC - a PoCo-IRC plugin providing DCC support

SYNOPSIS

# send a file
my $file = '/home/user/secret.pdf';
my $recipient = 'that_guy';
$irc->dcc($recipient => SEND => $file);

# receive a file
sub irc_dcc_request {
    my ($user, $type, $port, $cookie, $file, $size) = @_[ARG0..$#_];
    return if $type ne 'SEND';

    my $irc = $_[SENDER]->get_heap();
    my $nick = (split /!/, $user)[0];
    print "$nick wants to send me '$file' (size: $size) on port $port\n");
    $irc->yield(dcc_accept => $cookie);
}

DESCRIPTION

This plugin provides the IRC commands needed to make use of DCC. It is used internally by POE::Component::IRC so there's no need to add it manually.

METHODS

new

Takes no arguments.

Returns a plugin object suitable for feeding to POE::Component::IRC's plugin_add() method.

dccports

Sets the TCP ports that can be used for DCC sends. Takes one argument, an arrayref containing the port numbers.

nataddr

Sets the public NAT address to be used for DCC sends.

COMMANDS

The plugin responds to the following POE::Component::IRC commands.

dcc

Send a DCC SEND or CHAT request to another person. Takes at least two arguments: the nick!user@host of the person to send the request to and the type of DCC request (SEND or CHAT). For SEND requests, be sure to add a third argument for the filename you want to send. Optionally, you can add a fourth argument for the DCC transfer blocksize, but the default of 1024 should usually be fine.

Incidentally, you can send other weird nonstandard kinds of DCCs too; just put something besides 'SEND' or 'CHAT' (say, 'FOO') in the type field, and you'll get back irc_dcc_* events when activity happens on its DCC connection.

If you are behind a firewall or Network Address Translation, you may want to consult POE::Component::IRC's connect for some parameters that are useful with this command.

dcc_accept

Accepts an incoming DCC connection from another host. First argument: the magic cookie from an irc_dcc_request event. In the case of a DCC GET, the second argument can optionally specify a new name for the destination file of the DCC transfer, instead of using the sender's name for it. (See the irc_dcc_request section below for more details.)

dcc_resume

Resumes a DCC SEND file transfer. First argument: the magic cookie from an irc_dcc_request event. An optional second argument provides the name of the file to which you want to write.

dcc_chat

Sends lines of data to the person on the other side of a DCC CHAT connection. Takes any number of arguments: the magic cookie from an irc_dcc_start event, followed by the data you wish to send. (It'll be separated by newlines for you.)

dcc_close

Terminates a DCC SEND or GET connection prematurely, and causes DCC CHAT connections to close gracefully. Takes one argument: the magic cookie from an irc_dcc_start or irc_dcc_request event.

OUTPUT

irc_dcc_request

Note: This event is actually emitted by POE::Filter::IRC::Compat, but documented here to keep all the DCC documentation in one place. In case you were wondering.

You receive this event when another IRC client sends you a DCC (e.g. SEND or CHAT) request out of the blue. You can examine the request and decide whether or not to accept it (with dcc_accept) here. In the case of DCC SENDs, you can also request to resume the file with dcc_resume.

ARG0: the peer's nickname
ARG1: the port which the peer is listening on
ARG2: the DCC type
ARG3: this connection's "magic cookie"
ARG4: the file name
ARG5: the file size (SEND only)

irc_dcc_chat

Notifies you that one line of text has been received from the client on the other end of a DCC CHAT connection.

ARG0: this connection's "magic cookie"
ARG1: the peer's nickname
ARG2: the port number
ARG3: the text they sent

irc_dcc_done

You receive this event when a DCC connection terminates normally. Abnormal terminations are reported by irc_dcc_error.

ARG0: this connection's "magic cookie"
ARG1: the peer's nickname
ARG2: the DCC type
ARG3: the port number
ARG4: the filename
ARG5: file size (SEND/GET only)
ARG6: transferred file size (SEND/GET only, should be same as ARG5)

irc_dcc_failed

You get this event when a DCC connection fails for some reason.

ARG0: the operation that failed
ARG1: the error number
ARG2: the error string
ARG3: this connection's "magic cookie"

irc_dcc_error

You get this event whenever a DCC connection or connection attempt terminates unexpectedly or suffers some fatal error.

ARG0: this connection's "magic cookie"
ARG1: the error string
ARG2: the peer's nickname
ARG3: the DCC type
ARG4: the port number
ARG5: the file name
ARG6: expected file size
ARG7: tranferred file size

irc_dcc_get

Notifies you that another block of data has been successfully transferred from the client on the other end of your DCC GET connection.

ARG0: this connection's "magic cookie"
ARG1: the peer's nickname
ARG2: the port number
ARG3: the file name
ARG4: the file size
ARG5: transferred file size

irc_dcc_send

Notifies you that another block of data has been successfully transferred from you to the client on the other end of a DCC SEND connection.

ARG0: this connection's "magic cookie"
ARG1: the peer's nickname
ARG2: the port number
ARG3: the file name
ARG4: the file size
ARG5: transferred file size

irc_dcc_start

This event notifies you that a DCC connection has been successfully established.

ARG0: this connection's "magic cookie"
ARG1: the peer's nickname
ARG2: the DCC type
ARG3: the port number
ARG4: the file name (SEND/GET only)
ARG5: the file size (SEND/GET only)

AUTHOR

Dennis 'fimmtiu' Taylor, et al.