Class Irc::Bot::Plugins::BotModule
In: lib/rbot/plugins.rb
Parent: Object

BotModule is the base class for the modules that enhance the rbot functionality. Rather than subclassing BotModule, however, one should subclass either CoreBotModule (reserved for system modules) or Plugin (for user plugins).

A BotModule interacts with Irc events by defining one or more of the following methods, which get called as appropriate when the corresponding Irc event happens.

map(template, options)::

map!(template, options):map is the new, cleaner way to respond to specific message formats without littering your plugin code with regexps, and should be used instead of register() and privmsg() (see below) when possible.

The difference between map and map! is that map! will not register the new command as an alternative name for the plugin.

Examples: 'karmastats', :action => 'karma_stats'

  # while in the plugin...
  def karma_stats(m, params)
    m.reply "..."

  # the default action is the first component 'karma'

  # attributes can be pulled out of the match string 'karma for :key' 'karma :key'

  # while in the plugin...
  def karma(m, params)
    item = params[:key]
    m.reply 'karma for #{item}'

  # you can setup defaults, to make parameters optional 'karma :key', :defaults => {:key => 'defaultvalue'}

  # the default auth check is also against the first component
  # but that can be changed 'karmastats', :auth => 'karma'

  # maps can be restricted to public or private message: 'karmastats', :private => false 'karmastats', :public => false

See MessageMapper#map for more information on the template format and the allowed options.

listen(UserMessage):Called for all messages of any type. To differentiate them, use message.kind_of? It‘ll be either a PrivMessage, NoticeMessage, KickMessage, QuitMessage, PartMessage, JoinMessage, NickMessage, etc.
ctcp_listen(UserMessage):Called for all messages that contain a CTCP command. Use message.ctcp to get the CTCP command, and message.message to get the parameter string. To reply, use message.ctcp_reply, which sends a private NOTICE to the sender.
message(PrivMessage):Called for all PRIVMSG. Hook on this method if you need to handle PRIVMSGs regardless of whether they are addressed to the bot or not, and regardless of
privmsg(PrivMessage):Called for a PRIVMSG if the first word matches one the plugin register()ed for. Use m.plugin to get that word and m.params for the rest of the message, if applicable.
unreplied(PrivMessage):Called for a PRIVMSG which has not been replied to.
notice(NoticeMessage):Called for all Notices. Please notice that in general should not be replied to.
kick(KickMessage):Called when a user (or the bot) is kicked from a channel the bot is in.
invite(InviteMessage):Called when the bot is invited to a channel.
join(JoinMessage):Called when a user (or the bot) joins a channel
part(PartMessage):Called when a user (or the bot) parts a channel
quit(QuitMessage):Called when a user (or the bot) quits IRC
nick(NickMessage):Called when a user (or the bot) changes Nick
modechange(ModeChangeMessage):Called when a User or Channel mode is changed
topic(TopicMessage):Called when a user (or the bot) changes a channel topic
welcome(WelcomeMessage):Called when the welcome message is received on joining a server succesfully.
motd(MotdMessage):Called when the Message Of The Day is fully recevied from the server.
connect:Called when a server is joined successfully, but before autojoin channels are joined (no params)
set_language(String):Called when the user sets a new language whose name is the given String
save:Called when you are required to save your plugin‘s state, if you maintain data between sessions
cleanup:called before your plugin is "unloaded", prior to a plugin reload or bot quit - close any open files/connections or flush caches here



bot  [R]  the associated bot
handler  [R]  the message map handler
registry  [R]  the plugin registry

Public Class methods

Initialise your bot module. Always call super if you override this method, as important variables are set up for you:

@bot:the rbot instance
@registry:the botmodule‘s registry, which can be used to store permanent data (see Registry::Accessor for additional documentation)

Other instance variables which are defined and should not be overwritten byt the user, but aren‘t usually accessed directly, are:

@manager:the plugins manager instance
@botmodule_triggers:an Array of words this plugin register()ed itself for
@handler:the MessageMapper that handles this plugin‘s maps

Public Instance methods

Returns the symbol :BotModule

Signal to other BotModules that an even happened.

Method called to cleanup before the plugin is unloaded. If you overload this method to handle additional cleanup tasks, remember to call super() so that the default cleanup actions are taken care of as well.

Filename for a datafile built joining the botclass, plugin dirname and actual file name

Sets the default auth for command path cmd to val on channel chan: usually chan is either "*" for everywhere, public and private (in which case it can be omitted) or "?" for private communications

define a filter defaulting to the default filter group for this BotModule

Directory name to be joined to the botclass to access data files. By default this is the plugin name itself, but may be overridden, for example by plugins that share their datafiles or for backwards compatibilty

Auxiliary method called by map and map!

Sometimes plugins need to create a new fake message based on an existing message: for example, this is done by alias, linkbot, reaction and remotectl.

This method simplifies the message creation, including a recursion depth check.

In the options you can specify the :bot, the :server, the :source, the :target, the message :class and whether or not to :delegate. To initialize these entries from an existing message, you can use :from

Additionally, if :from is given, the reply method of created message is overriden to reply to :from instead. The in_thread attribute for created mesage is also copied from :from

If you don‘t specify a :from you should specify a :source.

read accessor for the default filter group for this BotModule

write accessor for the default filter group for this BotModule

Method called to flush the registry, thus ensuring that the botmodule‘s permanent data is committed to disk

Handle an Irc::PrivMessage for which this BotModule has a map. The method is called automatically and there is usually no need to call it explicitly.

Return a help string for your module. For complex modules, you may wish to break your help into topics, and return a list of available topics if topic is nil. plugin is passed containing the matching prefix for this message - if your plugin handles multiple prefixes, make sure you return the correct help for the prefix requested

load filters associated with the BotModule by looking in the path(s) specified by the :path option, defaulting to

  • Config::datadir/filters/<name>.rb
  • botclass/filters/<name>.rb

(note that as <name> we use dirname() rather than name(), since we‘re looking for datafiles; this is only relevant for the very few plugins whose dirname differs from name)

This is the preferred way to register the BotModule so that it responds to appropriately-formed messages on Irc.

This is the same as map but doesn‘t register the new command as an alternative name for the plugin.

Return an identifier for this plugin, defaults to a list of the message prefixes handled (used for error messages etc)

Changing the value of @priority directly will cause problems, Please use priority=.

Define the priority of the module. During event delegation, lower priority modules will be called first. Default priority is 1

Gets the default command path which would be given to command cmd

Register the plugin as a handler for messages prefixed cmd.

This can be called multiple times for a plugin to handle multiple message prefixes.

This command is now superceded by the map() command, which should be used instead whenever possible.

Just calls name

Intern the name

Default usage method provided as a utility for simple plugins. The MessageMapper uses ‘usage’ as its default fallback method.