/ 
App-Pocoirc-0.02
River stage zero No dependents
/ App::Pocoirc

NAME

App::Pocoirc - The guts of pocoirc

DESCRIPTION

This distribution provides a generic way to launch IRC clients which use POE::Component::IRC. The main features are:

  • Prints useful status information (to your terminal and/or a log file)

  • Will daemonize if you so wish

  • Supports a configuration file

  • Offers a user friendly way to pass arguments to POE::Component::IRC

  • Supports multiple IRC components and lets you specify which plugins to load locally (one object per component) or globally (single object)

CONFIGURATION

nick: foobar1234
username: foobar

global_plugins:
  - [CTCP]

local_plugins:
  - [BotTraffic]

networks:
  - name:   freenode
    server: irc.freenode.net
    local_plugins:
      - [AutoJoin, { Channels: ['#foodsfdsf'] } ]

  - name:   magnet
    server: irc.perl.org
    nick:   hlagherf32fr

The configuration file is in YAML or JSON format. It consists of a hash containing global_plugins, local_plugins, networks, lib, log_file, and default parameters to POE::Component::IRC. Only networks is required.

lib is an array of directories containing Perl modules (e.g. plugins). Just like Perl's -I.

log_file is the path to a log to which status messages will be written.

network

The network option should be an array of network hashes. A network hash consists of name, local_plugins, and parameters to POE::Component::IRC. Only name and server (a POE::Component::IRC parameter) are required. The POE::Component::IRC parameters specified in this hash will override the ones specified at the top level.

Plugins

The global_plugins and local_plugins options should consist of an array containing the short plugin class name (e.g. 'AutoJoin') and optionally a hash of arguments to that plugin. App::Pocoirc will first try to load POE::Component::IRC::Plugin::your_plugin before trying to load your_plugin.

The plugins in global_plugins will be instantiated once and then added to all IRC components. Note: not all plugins are designed to be used with multiple IRC components simultaneously

If you specify local_plugins at the top level, it will serve as a default list of local plugins, which can be overridden in a network hash.

OUTPUT

Here is some example output from the program:

$ pocoirc -c example/config.yml
2010-06-25 20:21:37 Started
2010-06-25 20:21:37 Constructing global plugins
2010-06-25 20:21:37 [freenode] Constructing local plugins
2010-06-25 20:21:37 [freenode] Spawning IRC component
2010-06-25 20:21:37 [magnet] Constructing local plugins
2010-06-25 20:21:37 [magnet] Spawning IRC component
2010-06-25 20:21:37 [freenode] Registering plugins
2010-06-25 20:21:37 [freenode] Connecting to IRC
2010-06-25 20:21:37 [magnet] Registering plugins
2010-06-25 20:21:37 [magnet] Connecting to IRC
2010-06-25 20:21:37 [freenode] Added plugin Whois3
2010-06-25 20:21:37 [freenode] Added plugin ISupport3
2010-06-25 20:21:37 [freenode] Added plugin DCC3
2010-06-25 20:21:37 [magnet] Added plugin Whois6
2010-06-25 20:21:37 [magnet] Added plugin ISupport6
2010-06-25 20:21:37 [magnet] Added plugin DCC6
2010-06-25 20:21:37 [freenode] Added plugin CTCP2
2010-06-25 20:21:37 [freenode] Added plugin AutoJoin2
2010-06-25 20:21:37 [magnet] Added plugin CTCP2
2010-06-25 20:21:37 [magnet] Added plugin BotTraffic2
2010-06-25 20:21:38 [freenode] Connected to server 213.92.8.4
2010-06-25 20:21:38 [freenode] Server notice: *** Looking up your hostname...
2010-06-25 20:21:38 [freenode] Server notice: *** Checking Ident
2010-06-25 20:21:38 [freenode] Server notice: *** Found your hostname
2010-06-25 20:21:38 [magnet] Connected to server 209.221.142.115
2010-06-25 20:21:38 [magnet] Server notice: *** Looking up your hostname...
2010-06-25 20:21:38 [magnet] Server notice: *** Checking Ident
2010-06-25 20:21:39 [magnet] Server notice: *** Found your hostname
2010-06-25 20:21:49 [freenode] Server notice: *** No Ident response
2010-06-25 20:21:49 [freenode] Logged in to server calvino.freenode.net with nick foobar1234
2010-06-25 20:21:49 [magnet] Server notice: *** No Ident response
2010-06-25 20:21:49 [magnet] Logged in to server magnet.llarian.net with nick hlagherf32fr
2010-06-25 20:21:51 [freenode] Joined channel #foodsfdsf
2010-06-25 20:21:55 Caught interrupt signal, exiting...
2010-06-25 20:21:55 [freenode] Quit from IRC (Client Quit)
2010-06-25 20:21:55 [freenode] Error from IRC server: Closing Link: 194-144-99-91.du.xdsl.is (Client Quit)
2010-06-25 20:21:55 [freenode] Disconnected from server 213.92.8.4
2010-06-25 20:21:55 [freenode] Shutting down
2010-06-25 20:21:55 [freenode] Deleted plugin DCC3
2010-06-25 20:21:55 [freenode] Deleted plugin AutoJoin2
2010-06-25 20:21:55 [freenode] Deleted plugin CTCP2
2010-06-25 20:21:55 [freenode] Deleted plugin Whois3
2010-06-25 20:21:55 [freenode] Deleted plugin ISupport3
2010-06-25 20:21:55 [magnet] Error from IRC server: Closing Link: 194-144-99-91.du.xdsl.is ()
2010-06-25 20:21:55 [magnet] Disconnected from server 209.221.142.115
2010-06-25 20:21:55 [magnet] Shutting down
2010-06-25 20:21:55 [magnet] Deleted plugin BotTraffic2
2010-06-25 20:21:55 [magnet] Deleted plugin DCC6
2010-06-25 20:21:55 [magnet] Deleted plugin ISupport6
2010-06-25 20:21:55 [magnet] Deleted plugin CTCP2
2010-06-25 20:21:55 [magnet] Deleted plugin Whois6

TODO

  • Check if a plugin is already loaded before calling require() on it

AUTHOR

Hinrik Örn Sigurðsson, hinrik.sig@gmail.com

LICENSE AND COPYRIGHT

Copyright 2010 Hinrik Örn Sigurðsson

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