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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
|
require 'singleton'
module Irc
BotConfig.register BotConfigArrayValue.new('plugins.blacklist',
:default => [], :wizard => false, :requires_rescan => true,
:desc => "Plugins that should not be loaded")
module Plugins
require 'rbot/messagemapper'
=begin
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:
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. The difference
between map and map! is that map! will not register the new command
as an alternative name for the plugin.
Examples:
plugin.map 'karmastats', :action => 'karma_stats'
# while in the plugin...
def karma_stats(m, params)
m.reply "..."
end
# the default action is the first component
plugin.map 'karma'
# attributes can be pulled out of the match string
plugin.map 'karma for :key'
plugin.map 'karma :key'
# while in the plugin...
def karma(m, params)
item = params[:key]
m.reply 'karma for #{item}'
end
# you can setup defaults, to make parameters optional
plugin.map 'karma :key', :defaults => {:key => 'defaultvalue'}
# the default auth check is also against the first component
# but that can be changed
plugin.map 'karmastats', :auth => 'karma'
# maps can be restricted to public or private message:
plugin.map 'karmastats', :private false,
plugin.map 'karmastats', :public false,
end
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.
unreplied(PrivMessage)::
Called for a PRIVMSG which has not been replied to.
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
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
=end
class BotModule
attr_reader :bot # the associated bot
# initialise your bot module. Always call super if you override this method,
# as important variables are set up for you
def initialize
@manager = Plugins::manager
@bot = @manager.bot
@botmodule_triggers = Array.new
@handler = MessageMapper.new(self)
@registry = BotRegistryAccessor.new(@bot, self.class.to_s.gsub(/^.*::/, ""))
@manager.add_botmodule(self)
if self.respond_to?('set_language')
self.set_language(@bot.lang.language)
end
end
def botmodule_class
:BotModule
end
def flush_registry
# debug "Flushing #{@registry}"
@registry.flush
end
def cleanup
# debug "Closing #{@registry}"
@registry.close
end
def handle(m)
@handler.handle(m)
end
def call_event(ev, *args)
@bot.plugins.delegate('event_' + ev.to_s.gsub(/[^\w\?!]+/, '_'), *args)
end
def map(*args)
@handler.map(self, *args)
# register this map
name = @handler.last.items[0]
self.register name, :auth => nil
unless self.respond_to?('privmsg')
def self.privmsg(m)
handle(m)
end
end
end
def map!(*args)
@handler.map(self, *args)
# register this map
name = @handler.last.items[0]
self.register name, :auth => nil, :hidden => true
unless self.respond_to?('privmsg')
def self.privmsg(m)
handle(m)
end
end
end
# 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
#
def default_auth(cmd, val, chan="*")
case cmd
when "*", ""
c = nil
else
c = cmd
end
Auth::defaultbotuser.set_default_permission(propose_default_path(c), val)
end
# Gets the default command path which would be given to command _cmd_
def propose_default_path(cmd)
[name, cmd].compact.join("::")
end
# return an identifier for this plugin, defaults to a list of the message
# prefixes handled (used for error messages etc)
def name
self.class.to_s.downcase.sub(/^#<module:.*?>::/,"").sub(/(plugin|module)?$/,"")
end
# just calls name
def to_s
name
end
# intern the name
def to_sym
self.name.to_sym
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 you
# 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(cmd, opts={})
raise ArgumentError, "Second argument must be a hash!" unless opts.kind_of?(Hash)
who = @manager.who_handles?(cmd)
if who
raise "Command #{cmd} is already handled by #{who.botmodule_class} #{who}" if who != self
return
end
if opts.has_key?(:auth)
@manager.register(self, cmd, opts[:auth])
else
@manager.register(self, cmd, propose_default_path(cmd))
end
@botmodule_triggers << cmd unless opts.fetch(:hidden, false)
end
# default usage method provided as a utility for simple plugins. The
# MessageMapper uses 'usage' as its default fallback method.
def usage(m, params = {})
m.reply(_("incorrect usage, ask for help using '%{command}'") % {:command => "#{@bot.nick}: help #{m.plugin}"})
end
end
class CoreBotModule < BotModule
def botmodule_class
:CoreBotModule
end
end
class Plugin < BotModule
def botmodule_class
:Plugin
end
end
# Singleton to manage multiple plugins and delegate messages to them for
# handling
class PluginManagerClass
include Singleton
attr_reader :bot
attr_reader :botmodules
def initialize
@botmodules = {
:CoreBotModule => [],
:Plugin => []
}
@names_hash = Hash.new
@commandmappers = Hash.new
@dirs = []
@failed = Array.new
@ignored = Array.new
bot_associate(nil)
end
# Reset lists of botmodules
def reset_botmodule_lists
@botmodules[:CoreBotModule].clear
@botmodules[:Plugin].clear
@names_hash.clear
@commandmappers.clear
@failures_shown = false
end
# Associate with bot _bot_
def bot_associate(bot)
reset_botmodule_lists
@bot = bot
end
# Returns the botmodule with the given _name_
def [](name)
@names_hash[name.to_sym]
end
# Returns +true+ if _cmd_ has already been registered as a command
def who_handles?(cmd)
return nil unless @commandmappers.has_key?(cmd.to_sym)
return @commandmappers[cmd.to_sym][:botmodule]
end
# Registers botmodule _botmodule_ with command _cmd_ and command path _auth_path_
def register(botmodule, cmd, auth_path)
raise TypeError, "First argument #{botmodule.inspect} is not of class BotModule" unless botmodule.kind_of?(BotModule)
@commandmappers[cmd.to_sym] = {:botmodule => botmodule, :auth => auth_path}
end
def add_botmodule(botmodule)
raise TypeError, "Argument #{botmodule.inspect} is not of class BotModule" unless botmodule.kind_of?(BotModule)
kl = botmodule.botmodule_class
if @names_hash.has_key?(botmodule.to_sym)
case self[botmodule].botmodule_class
when kl
raise "#{kl} #{botmodule} already registered!"
else
raise "#{self[botmodule].botmodule_class} #{botmodule} already registered, cannot re-register as #{kl}"
end
end
@botmodules[kl] << botmodule
@names_hash[botmodule.to_sym] = botmodule
end
# Returns an array of the loaded plugins
def core_modules
@botmodules[:CoreBotModule]
end
# Returns an array of the loaded plugins
def plugins
@botmodules[:Plugin]
end
# Returns a hash of the registered message prefixes and associated
# plugins
def commands
@commandmappers
end
# Makes a string of error _err_ by adding text _str_
def report_error(str, err)
([str, err.inspect] + err.backtrace).join("\n")
end
# This method is the one that actually loads a module from the
# file _fname_
#
# _desc_ is a simple description of what we are loading (plugin/botmodule/whatever)
#
# It returns the Symbol :loaded on success, and an Exception
# on failure
#
def load_botmodule_file(fname, desc=nil)
# create a new, anonymous module to "house" the plugin
# the idea here is to prevent namespace pollution. perhaps there
# is another way?
plugin_module = Module.new
desc = desc.to_s + " " if desc
begin
plugin_string = IO.readlines(fname).join("")
debug "loading #{desc}#{fname}"
plugin_module.module_eval(plugin_string, fname)
return :loaded
rescue Exception => err
# rescue TimeoutError, StandardError, NameError, LoadError, SyntaxError => err
warning report_error("#{desc}#{fname} load failed", err)
bt = err.backtrace.select { |line|
line.match(/^(\(eval\)|#{fname}):\d+/)
}
bt.map! { |el|
el.gsub(/^\(eval\)(:\d+)(:in `.*')?(:.*)?/) { |m|
"#{fname}#{$1}#{$3}"
}
}
msg = err.to_str.gsub(/^\(eval\)(:\d+)(:in `.*')?(:.*)?/) { |m|
"#{fname}#{$1}#{$3}"
}
newerr = err.class.new(msg)
newerr.set_backtrace(bt)
return newerr
end
end
private :load_botmodule_file
# add one or more directories to the list of directories to
# load botmodules from
#
# TODO find a way to specify necessary plugins which _must_ be loaded
#
def add_botmodule_dir(*dirlist)
@dirs += dirlist
debug "Botmodule loading path: #{@dirs.join(', ')}"
end
def clear_botmodule_dirs
@dirs.clear
debug "Botmodule loading path cleared"
end
# load plugins from pre-assigned list of directories
def scan
@failed.clear
@ignored.clear
processed = Hash.new
@bot.config['plugins.blacklist'].each { |p|
pn = p + ".rb"
processed[pn.intern] = :blacklisted
}
dirs = @dirs
dirs.each {|dir|
if(FileTest.directory?(dir))
d = Dir.new(dir)
d.sort.each {|file|
next if(file =~ /^\./)
if processed.has_key?(file.intern)
@ignored << {:name => file, :dir => dir, :reason => processed[file.intern]}
next
end
if(file =~ /^(.+\.rb)\.disabled$/)
# GB: Do we want to do this? This means that a disabled plugin in a directory
# will disable in all subsequent directories. This was probably meant
# to be used before plugins.blacklist was implemented, so I think
# we don't need this anymore
processed[$1.intern] = :disabled
@ignored << {:name => $1, :dir => dir, :reason => processed[$1.intern]}
next
end
next unless(file =~ /\.rb$/)
did_it = load_botmodule_file("#{dir}/#{file}", "plugin")
case did_it
when Symbol
processed[file.intern] = did_it
when Exception
@failed << { :name => file, :dir => dir, :reason => did_it }
end
}
end
}
debug "finished loading plugins: #{status(true)}"
end
# call the save method for each active plugin
def save
delegate 'flush_registry'
delegate 'save'
end
# call the cleanup method for each active plugin
def cleanup
delegate 'cleanup'
reset_botmodule_lists
end
# drop all plugins and rescan plugins on disk
# calls save and cleanup for each plugin before dropping them
def rescan
save
cleanup
scan
end
def status(short=false)
output = []
if self.core_length > 0
if short
output << n_("%{count} core module loaded", "%{count} core modules loaded",
self.core_length) % {:count => self.core_length}
else
output << n_("%{count} core module: %{list}",
"%{count} core modules: %{list}", self.core_length) %
{ :count => self.core_length,
:list => core_modules.collect{ |p| p.name}.sort.join(", ") }
end
else
output << _("no core botmodules loaded")
end
# Active plugins first
if(self.length > 0)
if short
output << n_("%{count} plugin loaded", "%{count} plugins loaded",
self.length) % {:count => self.length}
else
output << n_("%{count} plugin: %{list}",
"%{count} plugins: %{list}", self.length) %
{ :count => self.length,
:list => core_modules.collect{ |p| p.name}.sort.join(", ") }
end
else
output << "no plugins active"
end
# Ignored plugins next
unless @ignored.empty? or @failures_shown
if short
output << n_("%{highlight}%{count} plugin ignored%{highlight}",
"%{highlight}%{count} plugins ignored%{highlight}",
@ignored.length) %
{ :count => @ignored.length, :highlight => Underline }
else
output << n_("%{highlight}%{count} plugin ignored%{highlight}: use %{bold}%{command}%{bold} to see why",
"%{highlight}%{count} plugins ignored%{highlight}: use %{bold}%{command}%{bold} to see why",
@ignored.length) %
{ :count => @ignored.length, :highlight => Underline,
:bold => Bold, :command => "help ignored plugins"}
end
end
# Failed plugins next
unless @failed.empty? or @failures_shown
if short
output << n_("%{highlight}%{count} plugin failed to load%{highlight}",
"%{highlight}%{count} plugins failed to load%{highlight}",
@ignored.length) %
{ :count => @ignored.length, :highlight => Reverse }
else
output << n_("%{highlight}%{count} plugin failed to load%{highlight}: use %{bold}%{command}%{bold} to see why",
"%{highlight}%{count} plugins failed to load%{highlight}: use %{bold}%{command}%{bold} to see why",
@ignored.length) %
{ :count => @ignored.length, :highlight => Reverse,
:bold => Bold, :command => "#{Bold}help failed plugins#{Bold}"}
end
end
output.join '; '
end
# return list of help topics (plugin names)
def helptopics
rv = status
@failures_shown = true
rv
end
def length
plugins.length
end
def core_length
core_modules.length
end
# return help for +topic+ (call associated plugin's help method)
def help(topic="")
case topic
when /fail(?:ed)?\s*plugins?.*(trace(?:back)?s?)?/
# debug "Failures: #{@failed.inspect}"
return _("no plugins failed to load") if @failed.empty?
return @failed.collect { |p|
_('%{highlight}%{plugin}%{highlight} in %{dir}failed with error %{exception}: %{reason}') % {
:highlight => Bold, :plugin => p[:name], :dir => p[:dir],
:exception => p[:reason].class, :reason => p[:reason],
} + if $1 && !p[:reason].backtrace.empty?
_('at %{backtrace}') % {:backtrace => p[:reason].backtrace.join(', ')}
else
''
end
}.join("\n")
when /ignored?\s*plugins?/
return _('no plugins were ignored') if @ignored.empty?
tmp = Hash.new
@ignored.each do |p|
reason = p[:loaded] ? _('overruled by previous') : _(p[:reason].to_s)
((tmp[p[:dir]] ||= Hash.new)[reason] ||= Array.new).push(p[:name])
end
return tmp.map do |dir, reasons|
# FIXME get rid of these string concatenations to make gettext easier
s = reasons.map { |r, list|
list.map { |_| _.sub(/\.rb$/, '') }.join(', ') + " (#{r})"
}.join('; ')
"in #{dir}: #{s}"
end.join('; ')
when /^(\S+)\s*(.*)$/
key = $1
params = $2
# Let's see if we can match a plugin by the given name
(core_modules + plugins).each { |p|
next unless p.name == key
begin
return p.help(key, params)
rescue Exception => err
#rescue TimeoutError, StandardError, NameError, SyntaxError => err
error report_error("#{p.botmodule_class} #{p.name} help() failed:", err)
end
}
# Nope, let's see if it's a command, and ask for help at the corresponding botmodule
k = key.to_sym
if commands.has_key?(k)
p = commands[k][:botmodule]
begin
return p.help(key, params)
rescue Exception => err
#rescue TimeoutError, StandardError, NameError, SyntaxError => err
error report_error("#{p.botmodule_class} #{p.name} help() failed:", err)
end
end
end
return false
end
# see if each plugin handles +method+, and if so, call it, passing
# +message+ as a parameter
def delegate(method, *args)
# debug "Delegating #{method.inspect}"
ret = Array.new
[core_modules, plugins].each { |pl|
pl.each {|p|
if(p.respond_to? method)
begin
# debug "#{p.botmodule_class} #{p.name} responds"
ret.push p.send(method, *args)
rescue Exception => err
raise if err.kind_of?(SystemExit)
error report_error("#{p.botmodule_class} #{p.name} #{method}() failed:", err)
raise if err.kind_of?(BDB::Fatal)
end
end
}
}
return ret
# debug "Finished delegating #{method.inspect}"
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)
# debug "Delegating privmsg #{m.message.inspect} from #{m.source} to #{m.replyto} with pluginkey #{m.plugin.inspect}"
return unless m.plugin
k = m.plugin.to_sym
if commands.has_key?(k)
p = commands[k][:botmodule]
a = commands[k][:auth]
# We check here for things that don't check themselves
# (e.g. mapped things)
# debug "Checking auth ..."
if a.nil? || @bot.auth.allow?(a, m.source, m.replyto)
# debug "Checking response ..."
if p.respond_to?("privmsg")
begin
# debug "#{p.botmodule_class} #{p.name} responds"
p.privmsg(m)
rescue Exception => err
raise if err.kind_of?(SystemExit)
error report_error("#{p.botmodule_class} #{p.name} privmsg() failed:", err)
raise if err.kind_of?(BDB::Fatal)
end
# debug "Successfully delegated #{m.message}"
return true
else
# debug "#{p.botmodule_class} #{p.name} is registered, but it doesn't respond to privmsg()"
end
else
# debug "#{p.botmodule_class} #{p.name} is registered, but #{m.source} isn't allowed to call #{m.plugin.inspect} on #{m.replyto}"
end
end
# debug "Finished delegating privmsg with key #{m.plugin.inspect}" + ( pl.empty? ? "" : " to #{pl.values.first[:botmodule].botmodule_class}s" )
return false
# debug "Finished delegating privmsg with key #{m.plugin.inspect}"
end
end
# Returns the only PluginManagerClass instance
def Plugins.manager
return PluginManagerClass.instance
end
end
end
|