1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
module Irc
# base class for all rbot plugins
# certain methods will be called if they are provided, if you define one of
# the following methods, it will be called as appropriate:
#
# 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.
#
# privmsg(PrivMessage)::
# called for a PRIVMSG if the first word matches one
# the plugin register()d for. Use m.plugin to get
# that word and m.params for the rest of the message,
# if applicable.
#
# kick(KickMessage)::
# Called when a user (or the bot) is kicked from a
# channel the bot is in.
#
# 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
# topic(TopicMessage)::
# Called when a user (or the bot) changes a channel
# topic
#
# 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
class Plugin
# initialise your plugin. Always call super if you override this method,
# as important variables are set up for you
def initialize
@bot = Plugins.bot
@names = Array.new
@registry = BotRegistryAccessor.new(@bot, self.class.to_s.gsub(/^.*::/, ""))
end
# return an identifier for this plugin, defaults to a list of the message
# prefixes handled (used for error messages etc)
def name
@names.join("|")
end
# 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 your
# return the correct help for the prefix requested
def help(plugin, topic)
"no help"
end
# register the plugin as a handler for messages prefixed +name+
# this can be called multiple times for a plugin to handle multiple
# message prefixes
def register(name)
Plugins.plugins[name] = self
@names << name
end
# is this plugin listening to all messages?
def listen?
@listen
end
end
# class to manage multiple plugins and delegate messages to them for
# handling
class Plugins
# hash of registered message prefixes and associated plugins
@@plugins = Hash.new
# associated IrcBot class
@@bot = nil
# bot:: associated IrcBot class
# dirlist:: array of directories to scan (in order) for plugins
#
# create a new plugin handler, scanning for plugins in +dirlist+
def initialize(bot, dirlist)
@@bot = bot
@dirs = dirlist
scan
end
# access to associated bot
def Plugins.bot
@@bot
end
# access to list of plugins
def Plugins.plugins
@@plugins
end
# load plugins from pre-assigned list of directories
def scan
dirs = Array.new
dirs << File.dirname(__FILE__) + "/plugins"
dirs += @dirs
dirs.each {|dir|
if(FileTest.directory?(dir))
d = Dir.new(dir)
d.each {|file|
next if(file =~ /^\./)
next unless(file =~ /\.rb$/)
@tmpfilename = "#{dir}/#{file}"
# create a new, anonymous module to "house" the plugin
plugin_module = Module.new
begin
plugin_string = IO.readlines(@tmpfilename).join("")
puts "loading module: #{@tmpfilename}"
plugin_module.module_eval(plugin_string)
rescue StandardError, NameError, LoadError, SyntaxError => err
puts "plugin #{@tmpfilename} load failed: " + err
puts err.backtrace.join("\n")
end
}
end
}
end
# call the save method for each active plugin
def save
@@plugins.values.uniq.each {|p|
next unless(p.respond_to?("save"))
begin
p.save
rescue StandardError, NameError, SyntaxError => err
puts "plugin #{p.name} save() failed: " + err
puts err.backtrace.join("\n")
end
}
end
# call the cleanup method for each active plugin
def cleanup
@@plugins.values.uniq.each {|p|
next unless(p.respond_to?("cleanup"))
begin
p.cleanup
rescue StandardError, NameError, SyntaxError => err
puts "plugin #{p.name} cleanup() failed: " + err
puts err.backtrace.join("\n")
end
}
end
# drop all plugins and rescan plugins on disk
# calls save and cleanup for each plugin before dropping them
def rescan
save
cleanup
@@plugins = Hash.new
scan
end
# return list of help topics (plugin names)
def helptopics
if(@@plugins.length > 0)
# return " [plugins: " + @@plugins.keys.sort.join(", ") + "]"
return " [#{length} plugins: " + @@plugins.values.uniq.collect{|p| p.name}.sort.join(", ") + "]"
else
return " [no plugins active]"
end
end
def length
@@plugins.values.uniq.length
end
# return help for +topic+ (call associated plugin's help method)
def help(topic="")
if(topic =~ /^(\S+)\s*(.*)$/)
key = $1
params = $2
if(@@plugins.has_key?(key))
begin
return @@plugins[key].help(key, params)
rescue StandardError, NameError, SyntaxError => err
puts "plugin #{@@plugins[key].name} help() failed: " + err
puts err.backtrace.join("\n")
end
else
return false
end
end
end
# see if each plugin handles +method+, and if so, call it, passing
# +message+ as a parameter
def delegate(method, message)
@@plugins.values.uniq.each {|p|
if(p.respond_to? method)
begin
p.send method, message
rescue StandardError, NameError, SyntaxError => err
puts "plugin #{p.name} #{method}() failed: " + err
puts err.backtrace.join("\n")
end
end
}
end
# see if we have a plugin that wants to handle this message, if so, pass
# it to the plugin and return true, otherwise false
def privmsg(m)
return unless(m.plugin)
if (@@plugins.has_key?(m.plugin) &&
@@plugins[m.plugin].respond_to?("privmsg") &&
@@bot.auth.allow?(m.plugin, m.source, m.replyto))
begin
@@plugins[m.plugin].privmsg(m)
rescue StandardError, NameError, SyntaxError => err
puts "plugin #{@@plugins[m.plugin].name} privmsg() failed: " + err
puts err.backtrace.join("\n")
end
return true
end
return false
end
end
end
|
