NAME POE::Component::IRC::Plugin::WWW::Google::Time - access time data from Google via IRC SYNOPSIS use strict; use warnings; use POE qw(Component::IRC Component::IRC::Plugin::WWW::Google::Time); my $irc = POE::Component::IRC->spawn( nick => 'GoogleTimeBot', server => 'irc.freenode.net', port => 6667, ircname => 'GoogleTimeBot', ); POE::Session->create( package_states => [ main => [ qw(_start irc_001) ], ], ); $poe_kernel->run; sub _start { $irc->yield( register => 'all' ); $irc->plugin_add( 'google_time' => POE::Component::IRC::Plugin::WWW::Google::Time->new ); $irc->yield( connect => {} ); } sub irc_001 { $_[KERNEL]->post( $_[SENDER] => join => '#zofbot' ); } GoogleTimeBot time Nonexistant Zoffix, could not find time data for that location GoogleTimeBot time China Zoffix, it is Sunday, 12:02pm (CST) in China DESCRIPTION This module is a POE::Component::IRC plugin which uses POE::Component::IRC::Plugin for its base. It provides interface to fetch time data for various locations from Google. It accepts input from public channel events, "/notice" messages as well as "/msg" (private messages); although that can be configured at will. CONSTRUCTOR "new" # plain and simple $irc->plugin_add( 'google_time' => POE::Component::IRC::Plugin::WWW::Google::Time->new ); # juicy flavor $irc->plugin_add( 'google_time' => POE::Component::IRC::Plugin::WWW::Google::Time->new( auto => 1, response_event => 'irc_google_time', banned => [ qr/aol\.com$/i ], addressed => 1, root => [ qr/mah.net$/i ], trigger => qr/^time\s+(?=\S)/i, triggers => { public => qr/^time\s+(?=\S)/i, notice => qr/^time\s+(?=\S)/i, privmsg => qr/^time\s+(?=\S)/i, }, listen_for_input => [ qw(public notice privmsg) ], eat => 1, debug => 0, ) ); The "new()" method constructs and returns a new "POE::Component::IRC::Plugin::WWW::Google::Time" object suitable to be fed to POE::Component::IRC's "plugin_add" method. The constructor takes a few arguments, but *all of them are optional*. The possible arguments/values are as follows: "auto" ->new( auto => 0 ); Optional. Takes either true or false values, specifies whether or not the plugin should auto respond to requests. When the "auto" argument is set to a true value plugin will respond to the requesting person with the results automatically. When the "auto" argument is set to a false value plugin will not respond and you will have to listen to the events emited by the plugin to retrieve the results (see EMITED EVENTS section and "response_event" argument for details). Defaults to: 1. "response_event" ->new( response_event => 'event_name_to_recieve_results' ); Optional. Takes a scalar string specifying the name of the event to emit when the results of the request are ready. See EMITED EVENTS section for more information. Defaults to: "irc_google_time" "banned" ->new( banned => [ qr/aol\.com$/i ] ); Optional. Takes an arrayref of regexes as a value. If the usermask of the person (or thing) making the request matches any of the regexes listed in the "banned" arrayref, plugin will ignore the request. Defaults to: "[]" (no bans are set). "root" ->new( root => [ qr/\Qjust.me.and.my.friend.net\E$/i ] ); Optional. As opposed to "banned" argument, the "root" argument allows access only to people whose usermasks match any of the regexen you specify in the arrayref the argument takes as a value. By default: it is not specified. Note: as opposed to "banned" specifying an empty arrayref to "root" argument will restrict access to everyone. "trigger" ->new( trigger => qr/^time\s+(?=\S)/i ); Optional. Takes a regex as an argument. Messages matching this regex, irrelevant of the type of the message, will be considered as requests. See also addressed option below which is enabled by default as well as trigggers option which is more specific. Note: the trigger will be removed from the message, therefore make sure your trigger doesn't match the actual data that needs to be processed. Defaults to: "qr/^time\s+(?=\S)/i" "triggers" ->new( triggers => { public => qr/^time\s+(?=\S)/i, notice => qr/^time\s+(?=\S)/i, privmsg => qr/^time\s+(?=\S)/i, } ); Optional. Takes a hashref as an argument which may contain either one or all of keys public, notice and privmsg which indicates the type of messages: channel messages, notices and private messages respectively. The values of those keys are regexes of the same format and meaning as for the "trigger" argument (see above). Messages matching this regex will be considered as requests. The difference is that only messages of type corresponding to the key of "triggers" hashref are checked for the trigger. Note: the "trigger" will be matched irrelevant of the setting in "triggers", thus you can have one global and specific "local" triggers. See also addressed option below which is enabled by default as well as trigggers option which is more specific. Note: the trigger will be removed from the message, therefore make sure your trigger doesn't match the actual data that needs to be processed. Defaults to: "qr/^time\s+(?=\S)/i" "addressed" ->new( addressed => 1 ); Optional. Takes either true or false values. When set to a true value all the public messages must be *addressed to the bot*. In other words, if your bot's nickname is "Nick" and your trigger is "qr/^trig\s+/" you would make the request by saying "Nick, trig EXAMPLE". When addressed mode is turned on, the bot's nickname, including any whitespace and common punctuation character will be removed before matching the "trigger" (see above). When "addressed" argument it set to a false value, public messages will only have to match "trigger" regex in order to make a request. Note: this argument has no effect on "/notice" and "/msg" requests. Defaults to: 1 "listen_for_input" ->new( listen_for_input => [ qw(public notice privmsg) ] ); Optional. Takes an arrayref as a value which can contain any of the three elements, namely "public", "notice" and "privmsg" which indicate which kind of input plugin should respond to. When the arrayref contains "public" element, plugin will respond to requests sent from messages in public channels (see "addressed" argument above for specifics). When the arrayref contains "notice" element plugin will respond to requests sent to it via "/notice" messages. When the arrayref contains "privmsg" element, the plugin will respond to requests sent to it via "/msg" (private messages). You can specify any of these. In other words, setting "( listen_for_input =" [ qr(notice privmsg) ] )> will enable functionality only via "/notice" and "/msg" messages. Defaults to: "[ qw(public notice privmsg) ]" "eat" ->new( eat => 0 ); Optional. If set to a false value plugin will return a "PCI_EAT_NONE" after responding. If eat is set to a true value, plugin will return a "PCI_EAT_ALL" after responding. See POE::Component::IRC::Plugin documentation for more information if you are interested. Defaults to: 1 "debug" ->new( debug => 1 ); Optional. Takes either a true or false value. When "debug" argument is set to a true value some debugging information will be printed out. When "debug" argument is set to a false value no debug info will be printed. Defaults to: 0. EMITED EVENTS "response_event" $VAR1 = { 'what' => 'Toronto', 'who' => 'Zoffix!n=Zoffix@unaffiliated/zoffix', 'type' => 'public', 'channel' => '#zofbot', 'message' => 'GoogleTimeBot time Toronto', 'result' => { 'time' => '12:23am', 'day_of_week' => 'Sunday', 'time_zone' => 'EDT', 'where' => 'Toronto, Ontario' } }; $VAR1 = { 'what' => 'NonExistant', 'who' => 'Zoffix!n=Zoffix@unaffiliated/zoffix', 'error' => 'Could not find time data for that location', 'type' => 'public', 'channel' => '#zofbot', 'message' => 'GoogleTimeBot time NonExistant' }; The event handler set up to handle the event, name of which you've specified in the "response_event" argument to the constructor (it defaults to "irc_google_time") will recieve input every time request is completed. The input will come in $_[ARG0] on a form of a hashref. The possible keys/values of that hashrefs are as follows: "result" 'result' => { 'time' => '12:23am', 'day_of_week' => 'Sunday', 'time_zone' => 'EDT', 'where' => 'Toronto, Ontario' } The "result" key will (upon success, that is when "error" key is not present) contain a hashref which is the same as the return value of "get_time()" method of WWW::Google::Time. See WWW::Google::Time for more information. "error" { 'error' => 'Could not find time data for that location', } The "error" key will be present if a network error occured or google doesn't have time data for the location given. The key will contain the description of the error. "who" { 'who' => 'Zoffix!Zoffix@i.love.debian.org', } The "who" key will contain the user mask of the user who sent the request. "what" { 'what' => 'Toronto', } The "what" key will contain user's message after stripping the "trigger" (see CONSTRUCTOR). "message" { 'message' => 'GoogleTimeBot time Toronto' } The "message" key will contain the actual message which the user sent; that is before the trigger is stripped. "type" { 'type' => 'public', } The "type" key will contain the "type" of the message the user have sent. This will be either "public", "privmsg" or "notice". "channel" { 'channel' => '#zofbot', } The "channel" key will contain the name of the channel where the message originated. This will only make sense if "type" key contains "public". SEE ALSO WWW::Google::Time, POE::Component::WWW::Google::Time AUTHOR Zoffix Znet, "" (, , ) BUGS Please report any bugs or feature requests to "bug-poe-component-irc-plugin-www-google-time at rt.cpan.org", or through the web interface at . I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. SUPPORT You can find documentation for this module with the perldoc command. perldoc POE::Component::IRC::Plugin::WWW::Google::Time You can also look for information at: * RT: CPAN's request tracker * AnnoCPAN: Annotated CPAN documentation * CPAN Ratings * Search CPAN COPYRIGHT & LICENSE Copyright 2008 Zoffix Znet, all rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.