Why not adopt me?

This distribution is up for adoption! If you're interested then please contact the PAUSE module admins via email.

NAME

POE::Component::IRC::Plugin::HTML::AttributeInfo - HTML attribute info lookup from IRC

SYNOPSIS

use strict;
use warnings;

use POE qw(Component::IRC  Component::IRC::Plugin::HTML::AttributeInfo);

my $irc = POE::Component::IRC->spawn(
    nick        => 'HTMLAttrBot',
    server      => '127.0.0.1',
    port        => 6667,
    ircname     => 'HTML Attributes Lookup Bot',
    plugin_debug => 1,
);

POE::Session->create(
    package_states => [
        main => [ qw(_start  irc_001) ],
    ],
);

$poe_kernel->run;

sub _start {
    $irc->yield( register => 'all' );

    $irc->plugin_add(
        'HTMLAttributeInfo' =>
            POE::Component::IRC::Plugin::HTML::AttributeInfo->new
    );

    $irc->yield( connect => {} );
}

sub irc_001 {
    $irc->yield( join => '#zofbot' );
}


<Zoffix> HTMLAttrBot, attr list attributes table
<HTMLAttrBot> Element TABLE has the following attributes: align,
              bgcolor, border, cellpadding, cellspacing, class, dir,
              frame, id, lang, onclick, ondblclick, onkeydown,
              onkeypress, onkeyup, onmousedown, onmousemove,
              onmouseout, onmouseover, onmouseup, rules, style,
              summary, title, width

<Zoffix> HTMLAttrBot, attr list elements cellspacing
<HTMLAttrBot> Attribute cellspacing applies to elements: TABLE

<Zoffix> HTMLAttrBot, attr type class
<HTMLAttrBot> Attribute class's value is of type: CDATA

<Zoffix> HTMLAttrBot, attr default width
<HTMLAttrBot> Attribute width's default values are: #IMPLIED [ HR,
              IFRAME, IMG, OBJECT, TABLE, TD, TH, COL, COLGROUP, PRE ];
              #REQUIRED [ APPLET ]

<Zoffix> HTMLAttrBot, attr deprecated width
<HTMLAttrBot> Attribute width is deprecated on element(s): APPLET, HR,
              PRE, TD, TH and NOT deprecated on element(s): COL,
              COLGROUP, IFRAME, IMG, OBJECT, TABLE

<Zoffix> HTMLAttrBot, attr dtd style
<HTMLAttrBot> Attribute style appears in DTD: HTML 4.01 Strict

<Zoffix> HTMLAttrBot, attr comment style
<HTMLAttrBot> Comment for style is: associated style info

<Zoffix> HTMLAttrBot, attr comment name
<HTMLAttrBot> Attribute name has the following comments: N/A: [ BUTTON,
              TEXTAREA ]; allows applets to find each other: [ APPLET
              ]; field name: [ SELECT ]; for reference by usemap: [ MAP
              ]; metainformation name: [ META ]; name of form for
              scripting: [ FORM ]; name of frame for targetting: [
              FRAME, IFRAME ]; name of image for scripting: [ IMG ];
              named link end: [
<HTMLAttrBot> A ]; property name: [ PARAM ]; submit as part of form: [
              INPUT, OBJECT ]

<Zoffix> HTMLAttrBot, attr total
<HTMLAttrBot> I know of 119 attributes in total

<Zoffix> HTMLAttrBot, attr blah
<HTMLAttrBot> Invalid command in HTML Attributes plugin

DESCRIPTION

This module is a POE::Component::IRC plugin which uses POE::Component::IRC::Plugin for its base. It provides interface to to lookup information regarding HTML element attributes. It accepts input from public channel events, /notice messages as well as /msg (private messages); although that can be configured at will.

The functionality and arguments for each of plugin's command is described in section about triggers constructor's argument.

CONSTRUCTOR

`new`

# plain and simple
$irc->plugin_add(
    'HTMLAttributeInfo' =>
        POE::Component::IRC::Plugin::HTML::AttributeInfo->new
);

# juicy flavor
$irc->plugin_add(
    'HTMLAttributeInfo' =>
        POE::Component::IRC::Plugin::HTML::AttributeInfo->new(
            auto             => 1,
            response_event   => 'irc_html_attribute',
            banned           => [ qr/aol\.com$/i ],
            root             => [ qr/mah.net$/i ],
            addressed        => 1,
            line_length      => 350,
            trigger          => qr/^attr\s+(?=\S+)/i,
            triggers         => {
                list_attr   => qr/^ l (?:ist)? \s* a (?:ttr (?:ibute s? )? )? \s+ (?=\S+) /xi,
                list_el     => qr/^ l (?:ist)? \s* e (?:l (?:ements?)? )? \s+ (?=\S+) /xi,
                type        => qr/^ t (?: ype )? \s+ (?=\S+) /xi,
                default     => qr/^ d (?: efault )? (?: \s+ values? )? \s+ (?=\S+) /xi,
                deprecated  => qr/^ de (?: precated )? \s+ (?=\S+) /xi,
                dtd         => qr/^ dtd \s+ (?=\S+) /xi,
                comment     => qr/^ c (?:omment s?)? \s+ (?=\S+) /xi,
                total       => qr/^ to (?:tal)? /xi,
            },
            listen_for_input => [ qw(public notice privmsg) ],
            eat              => 1,
            debug            => 0,
        )
);

The new() method constructs and returns a new POE::Component::IRC::Plugin::HTML::AttributeInfo 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. Note: you can change all these arguments dynamically by accessing your plugin object as a hashref; in other words, if you want to ban a user on the fly you can do: push @{ $your_plugin_object->{banned} }, qr/\Quser!mask@foos.com/; . 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_html_attribute

`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.

`line_length`

->new( line_length => 350, );

Optional. Some commands emit quite a lot of output. The plugin will split the output into several messages if the length of the output is more than line_length characters. Defaults to: 350

`trigger`

->new( trigger => qr/^attr\s+(?=\S+)/i );

Optional. Takes a regex as an argument. Messages matching this regex will be considered as requests. See also addressed option below which is enabled by default. 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/^attr\s+(?=\S+)/i

`triggers`

triggers         => {
    list_attr   => qr/^ l (?:ist)? \s* a (?:ttr (?:ibute s? )? )? \s+ (?=\S+) /xi,
    list_el     => qr/^ l (?:ist)? \s* e (?:l (?:ement s?)? )? \s+ (?=\S+) /xi,
    type        => qr/^ t (?: ype )? \s+ (?=\S+) /xi,
    default     => qr/^ d (?: efault )? (?: \s+ value s? )? \s+ (?=\S+) /xi,
    deprecated  => qr/^ de (?: precated )? \s+ (?=\S+) /xi,
    dtd         => qr/^ dtd \s+ (?=\S+) /xi,
    comment     => qr/^ c (?:omment s?)? \s+ (?=\S+) /xi,
    total       => qr/^ to (?:tal)? /xi,
},

Optional. After the trigger (see above) is stripped the plugin will match the input on command regexes specified via triggers (note the plural form) argument; if none match the user will be informed about using an invalid command to the plugin. The triggers argument takes a hashref as a value; keys of that hashref are command names and values are regexes (qr//) which trigger the command. Note: anything matching the regex will be stripped from the input so make sure it doesn't match actual data. Note 2: if you are redefining the triggers you must specify entire hashref. The possible keys/values are as follows:

`list_attr`

{ list_attr => qr/^ l (?:ist)? \s* a (?:ttr (?:ibute s? )? )? \s+ (?=\S+) /xi, }

<Zoffix> HTMLAttrBot, attr list attributes table
<HTMLAttrBot> Element TABLE has the following attributes: align,
              bgcolor, border, cellpadding, cellspacing, class, dir,
              frame, id, lang, onclick, ondblclick, onkeydown,
              onkeypress, onkeyup, onmousedown, onmousemove,
              onmouseout, onmouseover, onmouseup, rules, style,
              summary, title, width

The list_attr command lists all the attributes which the given element may have. Trigger defaults to: qr/^ l (?:ist)? \s* a (?:ttr (?:ibute s? )? )? \s+ (?=\S+) /xi

`list_el`

{ list_el => qr/^ l (?:ist)? \s* e (?:l (?:ement s?)? )? \s+ (?=\S+) /xi, }

<Zoffix> HTMLAttrBot, attr list elements cellspacing
<HTMLAttrBot> Attribute cellspacing applies to elements: TABLE

The list_el command lists all the elements to which given attribute applies. Trigger defaults to: qr/^ l (?:ist)? \s* e (?:l (?:ement s?)? )? \s+ (?=\S+) /xi

`type`

{ type => qr/^ t (?: ype )? \s+ (?=\S+) /xi, }

<Zoffix> HTMLAttrBot, attr type class
<HTMLAttrBot> Attribute class's value is of type: CDATA

The type command lists the type of values the given attribute may have. Trigger defaults to: qr/^ t (?: ype )? \s+ (?=\S+) /xi

`default`

{ default => qr/^ d (?: efault )? (?: \s+ value s? )? \s+ (?=\S+) /xi, }

<Zoffix> HTMLAttrBot, attr default width
<HTMLAttrBot> Attribute width's default values are: #IMPLIED [ HR,
              IFRAME, IMG, OBJECT, TABLE, TD, TH, COL, COLGROUP, PRE ];
              #REQUIRED [ APPLET ]

The default command list possible default values for the given attribute. Trigger defaults to: qr/^ d (?: efault )? (?: \s+ value s? )? \s+ (?=\S+) /xi

`deprecated`

{ deprecated => qr/^ de (?: precated )? \s+ (?=\S+) /xi, }

<Zoffix> HTMLAttrBot, attr deprecated width
<HTMLAttrBot> Attribute width is deprecated on element(s): APPLET, HR,
              PRE, TD, TH and NOT deprecated on element(s): COL,
              COLGROUP, IFRAME, IMG, OBJECT, TABLE

The deprecated command tells whether or not the given attribute is deprecated. Trigger defaults to: qr/^ de (?: precated )? \s+ (?=\S+) /xi

`dtd`

{ dtd => qr/^ dtd \s+ (?=\S+) /xi, }

<Zoffix> HTMLAttrBot, attr dtd style
<HTMLAttrBot> Attribute style appears in DTD: HTML 4.01 Strict

The dtd command lists the DTDs (Document Type Definitions) under which the given attribute is defined. Trigger defaults to: qr/^ dtd \s+ (?=\S+) /xi

`comment`

{ comment => qr/^ c (?:omment s?)? \s+ (?=\S+) /xi, }

<Zoffix> HTMLAttrBot, attr comment style
<HTMLAttrBot> Comment for style is: associated style info

<Zoffix> HTMLAttrBot, attr comment name
<HTMLAttrBot> Attribute name has the following comments: N/A: [ BUTTON,
              TEXTAREA ]; allows applets to find each other: [ APPLET
              ]; field name: [ SELECT ]; for reference by usemap: [ MAP
              ]; metainformation name: [ META ]; name of form for
              scripting: [ FORM ]; name of frame for targetting: [
              FRAME, IFRAME ]; name of image for scripting: [ IMG ];
              named link end: [
<HTMLAttrBot> A ]; property name: [ PARAM ]; submit as part of form: [
              INPUT, OBJECT ]

The comment command lists the "comments" for the given attribute. Trigger defaults to: qr/^ c (?:omment s?)? \s+ (?=\S+) /xi

`total`

{ total => qr/^ to (?:tal)? /xi, }

<Zoffix> HTMLAttrBot, attr total
<HTMLAttrBot> I know of 119 attributes in total

The total command doesn't do much; it does not take any input and only lists the number of attributes which are known to the plugin. Trigger defaults to: qr/^ to (?:tal)? /xi

`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 dtd title. 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 = {
    'out' => [
        'Attribute width is deprecated on element(s): APPLET, HR, PRE,
        TD, TH and NOT deprecated on element(s): COL, COLGROUP, IFRAME,
        IMG, OBJECT, TABLE'
    ],
    'who' => 'Zoffix!Zoffix@irc.zoffix.com',
    'what' => 'de width',
    'type' => 'public',
    'channel' => '#zofbot',
    'message' => 'HTMLAttrBot, attr de width'
};

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_html_attribute) will recieve input every time request is completed. The input will come in $_[ARG0] in a form of a hashref. The possible keys/values of that hashref are as follows:

`out`

{
    'out' => [
        'Attribute width is deprecated on element(s): APPLET, HR, PRE,
        TD, TH and NOT deprecated on element(s): COL, COLGROUP, IFRAME,
        IMG, OBJECT, TABLE'
    ],
}

The out key will contain an arrayref which represents plugin's response (this is what you'd see as a message when auto option in constructor is on). This arrayref will contain several elements if the length of output is longer than line_length characters (see CONSTRUCTOR section).

`who`

{ 'who' => 'Zoffix!Zoffix@irc.zoffix.com', }

The who key will contain the usermask of the user who made the request.

`what`

{ 'what' => 'de width', }

The what key will contain user's message after trigger was stripped but before any of the triggers are stripped (see CONSTRUCTOR for description of trigger and triggers arguments)

`message`

{ 'message' => 'HTMLAttrBot, attr de width' }

The message key will contain user's full message (before any triggers are stripped).

`type`

{ 'type' => 'public', }

The type key will contain the "type" of the message sent by the requestor. The possible values are: public, notice and privmsg indicating that request was requested in public channel, via /notice and via /msg (private message) respectively.

`channel`

{ 'channel' => '#zofbot', }

The channel key will contain the name of the channel from which the request came. This will only make sense when type key (see above) contains public.

AUTHOR

Zoffix Znet, <zoffix at cpan.org> (http://zoffix.com, http://haslayout.net)

BUGS

Please report any bugs or feature requests to bug-poe-component-irc-plugin-html-attributeinfo at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=POE-Component-IRC-Plugin-HTML-AttributeInfo. 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::HTML::AttributeInfo

You can also look for information at:

RT: CPAN's request tracker

http://rt.cpan.org/NoAuth/Bugs.html?Dist=POE-Component-IRC-Plugin-HTML-AttributeInfo
AnnoCPAN: Annotated CPAN documentation

http://annocpan.org/dist/POE-Component-IRC-Plugin-HTML-AttributeInfo
CPAN Ratings

http://cpanratings.perl.org/d/POE-Component-IRC-Plugin-HTML-AttributeInfo
Search CPAN

http://search.cpan.org/dist/POE-Component-IRC-Plugin-HTML-AttributeInfo

COPYRIGHT & LICENSE

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

To install POE::Component::IRC::Plugin::HTML::AttributeInfo, copy and paste the appropriate command in to your terminal.

cpanm

cpanm POE::Component::IRC::Plugin::HTML::AttributeInfo

CPAN shell

perl -MCPAN -e shell
install POE::Component::IRC::Plugin::HTML::AttributeInfo

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

Why not adopt me?

NAME

SYNOPSIS

DESCRIPTION

CONSTRUCTOR

new

auto

response_event

banned

root

line_length

trigger

triggers

list_attr

list_el

type

default

deprecated

dtd

comment

total

addressed

listen_for_input

eat

debug

EMITED EVENTS

response_event

out

who

what

message

type

channel

AUTHOR

BUGS

SUPPORT

COPYRIGHT & LICENSE

Module Install Instructions

`new`

`auto`

`response_event`

`banned`

`root`

`line_length`

`trigger`

`triggers`

`list_attr`

`list_el`

`type`

`default`

`deprecated`

`dtd`

`comment`

`total`

`addressed`

`listen_for_input`

`eat`

`debug`

`response_event`

`out`

`who`

`what`

`message`

`type`

`channel`