NAME
Bot::Net::Mixin::Bot::IRCD - mixin class for building IRC daemon bots
SYNOPSIS
# Build an Eliza chatbot directly on the server
use strict;
use warnings;
package MyBotNet::Bot::ElizaOnServer;
use Bot::Net::Bot;
use Bot::Net::Mixin::Bot::IRCD;
use Chatbot::Eliza; # available separately on CPAN
on _start => run {
# Make it easy for other sessions to talk to us
get(KERNEL)->alias_set('eliza');
};
on bot startup => run {
remember eliza => Chatbot::Eliza->new;
};
on bot message_to_me => run {
my $event = getARG0;
my $reply = recall('eliza')->transform( $event->message );
yield reply_to_sender => $message, $reply;
};
on bot quit => run {
# Clear the session alias for clean shutdown
get(KERNEL)->alias_remove('eliza');
};
1;Then in your server, you need something like this:
use strict;
use warnings;
package MyBotNet::Server::Main;
use Bot::Net::Server;
use Bot::Net::Mixin::Server::IRC;
use MyBotNet::Bot::ElizaOnServer;
on _start => run {
remember eliza => MyBotNet::Bot::ElizaOnServer->setup;
};
on server quit => run {
# Clean up for clean shutdown
forget 'eliza';
};
1;DESCRIPTION
Some bots are best run direclty on the server itself. This is generally useful for handling channel or nick management services and other administrative tasks. A typical bot should run as a separate entity whenever possible. See Bot::Net::Mixin::Bot::IRC.
Unlike stand-alone bots, an IRC daemon bot cannot be run using the botnet command. Instead, they must be installed by a specific server and then are run as part of server startup via the botnet command.
METHODS
default_configuration PACKAGE
Returns a bas configuration for an IRC daemon bot.
BOT STATES
The following states are available for your bot to implement.
on bot connected
This is emitted as soon as the nick spoofing and initial channel setup has been setup.
on bot message_to_group EVENT
This state occurs when the bot observes a message sent to a channel it is in, but the message is not directed at the bot (i.e., is not prefixed with "MyNick:").
The EVENT is a Bot::Net::Message object setup to contain the group message.
on bot message_to_me EVENT
This state occurs when either the bot observes a message sent to a channel that it is in that has been prefixed with "MyNick:" or a private message was sent directly to the bot.
The EVENT is a Bot::Net::Message object setup for either a group or private message depending on which occurred. If a public message the "MyNick:" part of the message will have been stripped.
MIXIN STATES
on _start
Tells the server to spoof the bot's nick and registers to receive daemon events. It also sets up an alias for the session so that the server and other server bots may talk to your bot directly. The alias is set according to the "alias" configuration parameter.
It ends by firing the "on bot connected" state.
on ircd_daemon_privmsg USERHOST, NICK, MESSAGE
Handles IRC messasges sent directly to the bot. This then emits the additional bot state "on bot message_to_me". It will be passed a single argument, the Bot::Net::Message containting the message received.
ircd_daemon_public USERHOST, CHANNEL, MESSAGE
Handles any public messages stated in a channel the bot is in. It will emit either a "on bot message_to_group" state or "on bot message_to_me" state depending on whether or not the message was prefixed with "MyNick:".
Both events will receive a single argument, the Bot::Net::Message representing the message sent. The message will have the "MyNick:" prefix stripped on teh "on bot message_to_me" message.
send_to DESTINATION, MESSAGE
This sends the given MESSAGE to the given DESTINATION.
The DESTINATION may be one of the following:
#channel-
The name of a channel to send to. In this case, no special modifications will be made to the message.
nick-
The name of a nick to send to. In this case, no special modifications will be made to the message.
[ #channel1, #channel2, nick1, nick2 ]-
A list of channels and nicks to send to. In this case, no special modifications will be made to the message.
{ #channel1 => nick1, #channel2 => [ nick1, nick2 ] }-
A hash of channels pointing to nicks. The nicks may be either a single nick or an array of nicks. In this case, the messages will have the given nick (or nicks) prepended to every message sent (except continuations).
If MESSAGE contains new lines (\n), then the message will be broken up and sent in pieces.
If any message that would be sent to the server approaches the 512 byte limit on IRC messages, the line will be broken. The broken line will have a backslash (\) appended at the break point of the message to signal the recipient that the line was broken. A line may be broken multiple times.
on reply_to_sender EVENT, MESSAGE
Sends the MESSAGE back to the nick that sent the given EVENT. The EVENT should be a Bot::Net::Message object. The MESSAGE may be broken up and chunked as specified in "send_to".
This method will reply back to a user in all the channels it received the message in if the EVENT was sent to a channel (or group of channels) or will send privately back if the EVENT was private.
on reply_to_sender_privately EVENT, MESSAGE
Sends the MESSAGE back to the nick that sent the given EVENT, but via a private message directly to their nick, even if the original EVENT took place as a channel message.
on reply_to_sender_group EVENT, CHANNEL, MESSAGE
Sends the MESSAGE back to the nick that sent the given EVENT, but via the public group name in the CHANNEL argument.
on reply_to_general EVENT, MESSAGE
This is similar to "reply_to_sender", except that if sent to a channel, the sender will not be identified by nick.
on bot quit
This causes the IRC client to close down the connection and quit.
AUTHORS
Andrew Sterling Hanenkamp <hanenkamp@cpan.org>
COPYRIGHT AND LICENSE
Copyright 2007 Boomer Consulting, Inc. All Rights Reserved.
This program is free software and may be modified and distributed under the same terms as Perl itself.