3 require 'rbot/messagemapper'
5 # base class for all rbot plugins
6 # certain methods will be called if they are provided, if you define one of
7 # the following methods, it will be called as appropriate:
9 # map(template, options)::
10 # map is the new, cleaner way to respond to specific message formats
11 # without littering your plugin code with regexps. examples:
13 # plugin.map 'karmastats', :action => 'karma_stats'
15 # # while in the plugin...
16 # def karma_stats(m, params)
20 # # the default action is the first component
23 # # attributes can be pulled out of the match string
24 # plugin.map 'karma for :key'
25 # plugin.map 'karma :key'
27 # # while in the plugin...
28 # def karma(m, params)
30 # m.reply 'karma for #{item}'
33 # # you can setup defaults, to make parameters optional
34 # plugin.map 'karma :key', :defaults => {:key => 'defaultvalue'}
36 # # the default auth check is also against the first component
37 # # but that can be changed
38 # plugin.map 'karmastats', :auth => 'karma'
40 # # maps can be restricted to public or private message:
41 # plugin.map 'karmastats', :private false,
42 # plugin.map 'karmastats', :public false,
45 # To activate your maps, you simply register them
46 # plugin.register_maps
47 # This also sets the privmsg handler to use the map lookups for
48 # handling messages. You can still use listen(), kick() etc methods
50 # listen(UserMessage)::
51 # Called for all messages of any type. To
52 # differentiate them, use message.kind_of? It'll be
53 # either a PrivMessage, NoticeMessage, KickMessage,
54 # QuitMessage, PartMessage, JoinMessage, NickMessage,
57 # privmsg(PrivMessage)::
58 # called for a PRIVMSG if the first word matches one
59 # the plugin register()d for. Use m.plugin to get
60 # that word and m.params for the rest of the message,
64 # Called when a user (or the bot) is kicked from a
65 # channel the bot is in.
68 # Called when a user (or the bot) joins a channel
71 # Called when a user (or the bot) parts a channel
74 # Called when a user (or the bot) quits IRC
77 # Called when a user (or the bot) changes Nick
78 # topic(TopicMessage)::
79 # Called when a user (or the bot) changes a channel
82 # connect():: Called when a server is joined successfully, but
83 # before autojoin channels are joined (no params)
85 # save:: Called when you are required to save your plugin's
86 # state, if you maintain data between sessions
88 # cleanup:: called before your plugin is "unloaded", prior to a
89 # plugin reload or bot quit - close any open
90 # files/connections or flush caches here
92 attr_reader :bot # the associated bot
93 # initialise your plugin. Always call super if you override this method,
94 # as important variables are set up for you
98 @handler = MessageMapper.new(self)
99 @registry = BotRegistryAccessor.new(@bot, self.class.to_s.gsub(/^.*::/, ""))
103 # debug "Flushing #{@registry}"
108 # debug "Closing #{@registry}"
115 name = @handler.last.items[0]
117 unless self.respond_to?('privmsg')
124 # return an identifier for this plugin, defaults to a list of the message
125 # prefixes handled (used for error messages etc)
130 # return a help string for your module. for complex modules, you may wish
131 # to break your help into topics, and return a list of available topics if
132 # +topic+ is nil. +plugin+ is passed containing the matching prefix for
133 # this message - if your plugin handles multiple prefixes, make sure your
134 # return the correct help for the prefix requested
135 def help(plugin, topic)
139 # register the plugin as a handler for messages prefixed +name+
140 # this can be called multiple times for a plugin to handle multiple
143 return if Plugins.plugins.has_key?(name)
144 Plugins.plugins[name] = self
148 # default usage method provided as a utility for simple plugins. The
149 # MessageMapper uses 'usage' as its default fallback method.
150 def usage(m, params = {})
151 m.reply "incorrect usage, ask for help using '#{@bot.nick}: help #{m.plugin}'"
156 # class to manage multiple plugins and delegate messages to them for
159 # hash of registered message prefixes and associated plugins
161 # associated IrcBot class
164 # bot:: associated IrcBot class
165 # dirlist:: array of directories to scan (in order) for plugins
167 # create a new plugin handler, scanning for plugins in +dirlist+
168 def initialize(bot, dirlist)
174 # access to associated bot
179 # access to list of plugins
184 # load plugins from pre-assigned list of directories
186 processed = Array.new
188 dirs << Config::datadir + "/plugins"
190 dirs.reverse.each {|dir|
191 if(FileTest.directory?(dir))
194 next if(file =~ /^\./)
195 next if(processed.include?(file))
196 if(file =~ /^(.+\.rb)\.disabled$/)
200 next unless(file =~ /\.rb$/)
201 tmpfilename = "#{dir}/#{file}"
203 # create a new, anonymous module to "house" the plugin
204 # the idea here is to prevent namespace pollution. perhaps there
206 plugin_module = Module.new
209 plugin_string = IO.readlines(tmpfilename).join("")
210 debug "loading plugin #{tmpfilename}"
211 plugin_module.module_eval(plugin_string)
213 rescue Exception => err
214 # rescue TimeoutError, StandardError, NameError, LoadError, SyntaxError => err
215 warning "plugin #{tmpfilename} load failed: " + err.inspect
216 warning err.backtrace.join("\n")
223 # call the save method for each active plugin
225 delegate 'flush_registry'
229 # call the cleanup method for each active plugin
234 # drop all plugins and rescan plugins on disk
235 # calls save and cleanup for each plugin before dropping them
243 # return list of help topics (plugin names)
245 if(@@plugins.length > 0)
246 # return " [plugins: " + @@plugins.keys.sort.join(", ") + "]"
247 return " [#{length} plugins: " + @@plugins.values.uniq.collect{|p| p.name}.sort.join(", ") + "]"
249 return " [no plugins active]"
254 @@plugins.values.uniq.length
257 # return help for +topic+ (call associated plugin's help method)
259 if(topic =~ /^(\S+)\s*(.*)$/)
262 if(@@plugins.has_key?(key))
264 return @@plugins[key].help(key, params)
265 rescue Exception => err
266 #rescue TimeoutError, StandardError, NameError, SyntaxError => err
267 error "plugin #{@@plugins[key].name} help() failed: #{err.class}: #{err}"
268 error err.backtrace.join("\n")
276 # see if each plugin handles +method+, and if so, call it, passing
277 # +message+ as a parameter
278 def delegate(method, *args)
279 @@plugins.values.uniq.each {|p|
280 if(p.respond_to? method)
283 rescue Exception => err
284 #rescue TimeoutError, StandardError, NameError, SyntaxError => err
285 error "plugin #{p.name} #{method}() failed: #{err.class}: #{err}"
286 error err.backtrace.join("\n")
292 # see if we have a plugin that wants to handle this message, if so, pass
293 # it to the plugin and return true, otherwise false
295 return unless(m.plugin)
296 if (@@plugins.has_key?(m.plugin) &&
297 @@plugins[m.plugin].respond_to?("privmsg") &&
298 @@bot.auth.allow?(m.plugin, m.source, m.replyto))
300 @@plugins[m.plugin].privmsg(m)
301 rescue Exception => err
302 #rescue TimeoutError, StandardError, NameError, SyntaxError => err
303 error "plugin #{@@plugins[m.plugin].name} privmsg() failed: #{err.class}: #{err}"
304 error err.backtrace.join("\n")