1 2006-08-26 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
3 * Plugin message mapper: new implementation. Multi-word parameters now
4 need not be the last, and it is possible to retrieve the entire
5 substring with preserved whitespace by using to_s. Also, parts of the
6 map string can be bracketed to make them optional. Examples:
7 remind :user [about] *stuff
9 remind me about washing my teeth
11 remind me washing my teeth
12 It is possible to have parameters in brackets, in which case they will
13 be optional too, and default to nil or [] (resp. single- and
14 multi-word parameters) unless an alternative is provided in the
15 :defaults hash for the message map options.
17 2006-08-25 Mark Kretschmann <markey@web.de>
19 * Added quiz plugin, a multiplayer trivia quiz game.
21 2006-08-20 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
23 * Topic plugin: fix a bug that prevented it from loading
25 * New IRC Framework: make sure that NOTICEs and PRIVMSGs do not
26 raise an exception when the target is in one of the special forms
27 #<mask> or $<mask>. Needs some work, though, since this case should be
30 2006-08-17 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
32 * Fix help: It got broken while rearranging the plugin stuff, now it's
34 * New Auth Framework: forgot to create the InvalidPassword exception.
35 It's a RuntimeError now.
36 * Fix help: this time for real (or so I hope).
37 * New IRC Framework: topic plugin now works correctly.
38 * New Auth Framework: nickserv plugin now defaults to false for its
39 auth, so that only owner can do stuff with it
40 * New Auth Framework: fix horrible typo, assignment instead of
41 equality test when checking for the username during login.
42 * Keywords plugin: tell and forget work again without 'keyword' before
45 2006-08-12 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
47 * Subregistry: force prefix to be a String with to_s
49 2006-08-11 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
51 * AutoOp plugin: adapted to the new IRC framework.
52 * AutoOp plugin: trigger autoop on nick change too.
53 * New Auth Framework: allow? method now informs a user when they don't
54 have permission to do what they asked for.
55 * New nickreply and nickokay methods: they act like the old reply
56 method, but include the nick of the user the bot is replying to when
57 talking in public. The usual reply method can be configured to act
60 2006-08-10 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
62 * Fix a bug in new IRC Framework: the list of channels a quitting user was
63 on was not built correctly, causing an exception when the user was not
64 in the first channel in the list of channels.
65 * Fix a bug in new Auth Framework: BotUser's name is changed via
67 * New HalfLife 2 plugin from ocr: queries online servers for online
68 status and number of users.
70 2006-08-07 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
72 * Add kick method to kernel: plugins can now use
73 @bot.kick channel, user, reason
74 to kick a user from a channel
75 * RSS plugin: fix rewatch_rss method
76 * RSS plugin: the different ways to represent channels before and
77 after the New IRC Framework was causing strange problems such as
78 watched feed not being listed as such, undeletable watches, double
79 watches etc. Fix this by checking both for the Channel objects and
80 their to_s form when checking for watches or deleting them.
82 2006-08-06 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
84 * Updating the ChangeLog again: describe the new stuff in trunk which
85 will be made available in the next release. Use Gnu style for new
86 changelog entries (yyyy-mm-dd name <email address>\n<tab> ...):
87 there's a macro for this since at least Vim 6.x and higher, called by
88 <Leader>o (default leader: slash (\))
89 * New IRC Framework: Server, Channels, User, Netmasks etc are all
90 proper Ruby objects. The better organization will allow multi-server
91 connections to be implemented more easily
92 * Modularize core: split the internal functionality from what can be
93 implemented as botmodules (which work just the same as plugins). Move
94 Configuration, Basics and Auth out of the 'kernel' into core
96 * New Auth Framework: BotUsers are now Ruby objects with attached
97 PermissionSets which define what the BotUser can do, by channel if
98 necessary. The new framework allows very fine-grained control while
99 still being very easy to manage for elementary usage. BotUser data can
100 be exported and imported, but no backwards compatibility has been
101 implemented yet. Most plugins still have to be updated to the new
102 command-path-based mechanism.
104 Sun Aug 06 17:33:55 BST 2006 Tom Gilbert <tom@linuxbrit.co.uk>
107 * Changes: Lots of new and updated plugins, including one to poll RSS feeds.
108 A first step towards a better auth system (total revamp due in 0.9.11).
109 Improvements to network and server code which should provide greater
110 stability. A new message queueing mechanism with bitrate throttling. A new
111 logging framework for debugging and tracing the activities of the bot. A
112 new split-db registry system for better performance and transactional
113 usage of bdb for resilience. More integration with Nickserv where
114 available including optional automatic ghost-killing.
116 Wed Sep 07 20:16:46 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
118 * Fixed quit, broke it last commit
119 * Fixed trap() for win32
121 Sun Aug 21 13:29:55 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
123 * fix for bug in quakenet plugin (trac #14)
124 * multiple fixes for unescaped bot nick in regexp's (trac #13)
126 Fri Aug 12 20:51:38 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
128 * fix up autoop plugin a bit
130 Thu Aug 11 00:13:11 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
132 * Added two plugins from Robin Kearney <robin@riviera.org.uk>
133 * Threat (US threat level :P)
134 * bash (bash.org quotes)
136 Thu Aug 11 00:04:31 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
138 * Patches from "Alexey I. Froloff" <raorn@altlinux.ru>
139 * Do not use "/home/#{Etc.getlogin}/" for default home directory, use
140 "#{Etc.getpwnam(Etc.getlogin).dir}/" instead.
141 * Do not try to load same plugin from different locations. Added ability
142 to disable system-wide plugins - create PLUGIN.rb.disabled in user's
144 * For example, to disable freshmeat plugin installed in /usr/share/rbot/plugins/freshmeat.rb one can create empty file ~/.rbot/plugins/freshmeat.rb.disabled
146 Mon Aug 08 23:08:01 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
148 * new markov plugin for random inane chat
150 Sun Aug 07 18:20:24 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
152 * stop insult plugin being used to insult the bot
154 Sun Aug 07 17:53:06 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
156 * workaround for people without YAML::load_file
157 * quit message for restart
159 Sun Aug 07 15:11:07 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
161 * fix address_prefix, broken in 0.9.9, reported by ruskie.
163 Sat Aug 06 00:54:34 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
167 Fri Aug 05 23:55:20 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
169 * few more tweaks preparing to release 0.9.9
171 Thu Aug 04 23:03:30 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
173 * Improved ircd recognition of rfc2812.rb
174 * de-string'd, de-cap'd rfc2812.rb, looks less shouty now
175 * moved the Q auth stuff (for quakenet) into a new qauth plugin (untested!)
176 * finish fixing the httputil
178 Thu Aug 04 00:11:52 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
180 * Tweaked the debug() stuff a bit. Need to do this more cleanly really
181 * Added a fair bit of documentation for some of the new features
183 Wed Aug 03 15:25:07 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
185 * Added french language file (TODO most of the plugins just talk english)
186 * The way the Enum configs were set up, it wasn't possible to add language
187 files to rbot at runtime (the directory was only scanned at startup). Now
188 you can set a values Proc, which is called to return a list of allowed
189 values whenever it's queried.
190 * Added Config module for determining where we were installed.
191 Unfortunately rubygems is a total whore in this regard, and I hope the
192 current hackery I have to do to support it becomes redundant in the
195 Wed Aug 03 00:31:41 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
197 * Added Rakefile, tweaked gemspec
199 Tue Aug 02 16:27:36 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
201 * Fixed the new http.proxy* settings, they work!
202 * Fixed a bug with auth-checking for the config module
205 Sun Jul 31 02:20:08 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
207 * Updated docgen to generate rdoc again with the new repo structure
208 * added new restart command to the core bot, quits irc and reexecs the
209 bot, to pick up new code/libraries etc.
211 Sat Jul 30 22:33:36 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
213 * Config items are now objects, various types are available.
214 * The config wizard will now use registered config items if :wizard is set
215 to true for those items. It will ask questions in the order they were
217 * The config module now works for doing runtime configuration.
220 Sat Jul 30 01:19:32 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
222 * config module for configuring the running bot via IRC
223 * BotConfig.register method for various modules and any plugin to register
224 bot configuration which the new config module will expose for them.
225 * various other tweaks as I continue to refactor..
227 Fri Jul 29 13:07:56 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
229 * Moved some stuff out of util.rb into the plugins that actually need
230 them. Those methods didn't belong in util as they were plugin-specific.
231 * moved a few more plugins to use map() where appropriate
232 * made the url plugin only store unique urls
234 Thu Jul 28 23:45:26 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
236 * Reworked the Timer module. The Timer now has a smart thread manager to
237 start/stop the tick() thread. This means the timer isn't called every 0.1
238 seconds to see what needs doing, which is much more efficient
239 * reworked the ircsocket queue mechanism to use a Timer
240 * reworked the nickserv plugin to use maps
241 * made server.reconnect_wait configurable
242 * added Class tracing mechanism to bin/rbot, use --trace Classname for
245 Tue Jul 26 14:41:34 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
247 * Prevent multiple plugin registrations of the same name
248 * reworking the config system to use yaml for persistence
249 * reworking the config system key names
250 * on first startup, the bot will prompt for the essential startup config
251 * new config module for configuring the bot at runtime
252 * new config module includes new configurables, for example changing the
253 bot's language at runtime.
254 * various other fixes
255 * New way of mapping plugins to strings, using maps. These may be
256 familiar to rails users. This is to reduce the amount of regexps plugins
257 currently need to do to parse arguments. The old method (privmsg) is still
258 supported, of course. Example plugin now:
259 def MyPlugin < Plugin
264 def complexfoo(m, params)
265 m.reply "qux! (#{params[:bar]} #{params[:baz]})"
268 plugin = MyPlugin.new
272 # this will match "rbot: foo somestring otherstring" and pass the
273 # parameters as a hash using the names in the map.
274 plugin.map 'foo :bar :baz', :action => 'complexfoo'
275 # this means :foo is an optional parameter
276 plugin.map 'foo :foo', :defaults => {:foo => 'bar'}
277 # you can also gobble up into an array
278 plugin.map 'foo *bar' # params[:bar] will be an array of string elements
279 # and you can validate, here the first param must be a number
280 plugin.map 'foo :bar', :requirements => {:foo => /^\d+$/}
283 Sat Jul 23 01:39:08 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
285 * Changed BotConfig to use yaml storage, method syntax instead of hash for
286 get/set, to allow more flexibility and encapsulation
287 * Added convenience method Message.okay (m.okay is the same as the
288 old-style @bot.okay m.replyto)
290 Wed Jul 20 23:30:01 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
292 * Move some core plugins to use the new httputil
293 * fix wserver's redirection handling for relative (i.e. broken) redirects
294 * fix tube plugin's html parsing
296 Wed Jul 20 01:18:06 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
298 * Add new httputil object to the bot object, to be used by plugins etc
299 that wish to make http requests. It sets up all the proxies etc for them
300 according to bot config.
302 Sat Jul 16 02:23:13 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
304 * Apply most of Rene's patch and fix various plugins.
305 * New plugin: autoop (auto ops via hostmask)
306 * New feature: karmastats
308 Wed Oct 13 16:16:31 BST 2004 Tom Gilbert <tom@linuxbrit.co.uk>
310 * Fix bug with quotes plugin where it gets confused and sees both a quote
311 and a keyword, both plugins are triggered by, for example "addquote foo is
313 * fixed this by implementing the "has_responded" flag on a message. When a
314 plugin replied to a message (or it manually sets m.replied to true), the
315 keywords plugin will honour that flag and not examine the message for
316 keywords. This flag can also be checked by listen plugins that don't want to
317 interfere with other plugin commands.
319 Mon Oct 11 00:37:52 BST 2004 Tom Gilbert <tom@linuxbrit.co.uk>
321 * Fixes to the NickServ plugin
323 Sat Oct 09 23:23:24 BST 2004 Tom Gilbert <tom@linuxbrit.co.uk>
327 Fri Oct 08 00:40:07 BST 2004 Tom Gilbert <tom@linuxbrit.co.uk>
329 * fixed insult plugin
330 * fixed excuse plugin
332 Thu Oct 07 23:28:05 BST 2004 Tom Gilbert <tom@linuxbrit.co.uk>
334 * searching for urls in the url plugin
335 * roshambo (rock/paper/scissors) plugin from Hans Fugal <hans@fugal.net>
337 Sat Apr 17 20:56:50 BST 2004 Tom Gilbert <tom@linuxbrit.co.uk>
339 * Oh, found new tv plugin in my inbox from ages ago, but it's still not
340 working so I guess it changed again since then
341 * New eightball plugin from Daniel Free
343 Sat Apr 17 20:44:43 BST 2004 Tom Gilbert <tom@linuxbrit.co.uk>
345 * Fixed the babelfish parser so translate works again.
347 * Note some plugins are broken (excuse,insult) because the server they use
348 went away. I don't know of a replacement right now.
349 * tv plugin seems broken, perhaps the html changed.
351 Thu Jan 15 21:37:38 GMT 2004 Tom Gilbert <tom@linuxbrit.co.uk>
356 * new plugin from Alan Third <alan@idiocy.org>, allows you to search and list
360 * various plugin updates
361 * fix (again) for C to F temp conversion in weather plugin
362 * channel topic patch from Peter Suschlik, gives plugin better access to topic
363 changes and related information
366 * changes to layout of slashdot plugin output
367 * freshmeat plugin, show latest updates or search
368 * fix to C to F temp conversion in weather plugin
369 * status command returns some bot status
371 * using BDB::Btree everywhere now, instead of BDB::Hash, because the Btree api
372 allows me to set my own key comparison function. This is needed to keep
373 supporting case insensitivity (vital for IRC), which was sadly broken in
374 0.9.5 :( All existing dbs will be upgraded automatically.
375 * roulette plugin - play russian roulette :) also keeps game stats.
376 * new config option, NO_KEYWORD_ADDRESS. If set to "true", the bot will always
377 respond to keywords it knows even when not addressed and the message doesn't
378 start with '. Message must end with "?" however.
379 * hopefully fixed welcome message parsing from certain server types
382 * plugin object registry
383 This provides persistant storage for plugins via a hash interface. The
384 default mode is an object store, so you can store ruby objects and reference
385 them with hash keys. This is because the default store/restore methods of
386 the plugins' RegistryAccessor are calls to Marshal.dump and Marshal.restore,
390 @registry[:blah] = blah
391 then, even after the bot is shut down and disconnected, on the next run you
392 can access the blah object as it was, with:
393 blah = @registry[:blah]
394 The registry can of course be used to store simple strings, fixnums, etc as
395 well, and should be useful to store or cache plugin data or dynamic plugin
398 If you don't need to store objects, and strictly want a persistant hash of
399 strings, you can override the store/restore methods to suit your needs, for
400 example (in your plugin):
411 Your plugins section of the registry is private, it has its own namespace
412 (derived from the plugin's class name, so change it and lose your data).
413 Calls to registry.each etc, will only iterate over your namespace.
415 The nickserv and karma plugins use the new registry and should serve as a
416 useful example. Basic usage of the registry is simple, just treat it as a
417 hash, with values that never die (unless you delete() them).
418 * Change to the nickserv plugin. The old method of putting the nickserv
419 password in rbot.conf was useless for multiple nicks or easy updates. The
420 plugin now uses the plugin registry to store passwords for any nicks it
421 owns. The plugin can be told to register the current nick (supply a password
422 or it'll generate one), identify for the current nick (if the password is
423 known), and can be told the passwords for other nicks. If NickServ asks the
424 bot to identify, it will automatically do so if it knows the appropriate
426 * karma plugin now uses the plugin registry, it should automatically import
427 your existing, stored karma data into the registry.
428 * The babelfish plugin now caches results in the bot registry to speed up
430 * New message types and plugin methods to grab them,
431 quit(QuitMessage): Called when a user (or the bot) quits IRC
432 nick(NickMessage): Called when a user (or the bot) changes Nick
433 topic(TopicMessage): Called when a user (or the bot) changes a channel topic
434 * A plugin's listen() method will now receive any kind of Message, e.g.
435 PrivMessage, NoticeMessage, NickMessage, JoinMessage, etc
437 seen: the usual "seen" stuff:
439 giblet was last seen xxx ago doing xxx
440 cal: calls the unix cal program to display a calendar
441 math: evaluates mathematical expressions:
443 rbot: math 4 to the power of 8
444 rbot: math ((232+432) - 4) / 2
445 (ported from infobot. Thanks to Kevin Lenzo, who wrote the
446 original infobot math module)
447 slashdot: displays latest headlines or searches for articles
448 url: stores urls mentioned in channels for regurgitation later
449 weather: grabs and parses METAR weather data, will remember the last weather
450 code you asked for so you don't have to :)
451 * New utility function, Util.http_get(url) for getting remote data via http,
452 just dumps response.body into a string and returns it, or nil if anything at
453 all goes wrong. Useful for simple plugins.
454 * random quit messages if none specified, messages set in language description
456 * keywords are now stored in bdb databases - your old keywords.rbot will be
457 imported. Static keywords (fact packs) are also stored in bdb databases, and
458 rbot will automatically convert any text .fact file dropped in the confdir's
459 keywords subdirectory, at startup, into a bdb file. If both a db and a text
460 file exist of the same name (except the extension), the text file will be
461 imported and merged into the database.
462 static keywords will be looked up in each factpack db in turn, in
463 alphabetical filename order - so you can prioritise using the filename if
465 * fixed a bug with autsplitting long sent lines, the last line was often being
469 * Massive cleanup of rfc2812.rb, contributed by Lars Christensen
470 <dsl8950@vip.cybercity.dk>, gets rid of a lot of regexps
471 * Fixed bug reading static keyword files - "foo <=is=> bar" may not have
472 worked for a couple of releases, only "foo<=is=>bar" was working - this was
473 not intended and should be fixed now
474 * Experimental send queue, to prevent the bot from flooding out, the delay
475 between sending messages to the server defaults to 2s, but is configurable
476 in conf.rbot, set SENDQ_DELAY (0 to disable queueing). You can also set/get
477 the value from the bot, "rbot: options get sendq_delay", and
478 "rbot: options set sendq_delay 1.5", if you have sufficient auth for "config"
479 This is a bursting sendq, most ircd's allow bursts of up to 5
480 lines, with non-burst limits of 512 bytes/2 seconds. To set the burst limit,
481 configure SENDQ_BURST in conf.rbot, or do the same kind of stuff with
482 "rbot: options set sendq_burst 2", etc.
483 The defaults are 2s/4 burst, which seem to work okay for me.
484 * support for multiple, customisable, addressing prefixes. Set ADDRESS_PREFIX
485 in conf.rbot to a space separate list of addressing prefixes, e.g
486 ADDRESS_PREFIX = | ! =>
487 Would mean that all of the following in channel messages would cause the bot
493 * bb plugin removed, bb is nearly over and it doesn't work 100% anyway
494 * Two plugins from brailsmt (from #ruby-lang on openprojects), a stats plugin
495 which monitors usage of 1-word sentences, and lart, which allows you to ask
496 rbot to lart people - with an optional reason - larts are user-definable and
497 can be added on the fly.
498 * made google.rb work for people with 1.6 ruby's net/http
503 * new plugin for handling nickserv-protected nicks, use NICKSERV_PASSWORD in
505 * fixes to a few other buglets
506 * new plugin to grab bigbrother headlines, still buggy and only useful for UK
507 folks who love bb :-)
508 * fixes to various plugins
509 * Patch from akira yamada <akira@ruby-lang.org>
510 DNS plugin: Use resolv-replace if found, do lookup in new thread
511 Fix bug joining channels with keys
515 * better "connect failure" error message
516 * better option parsing, and --debug option
517 * access to bot's online help via commandline, eg:
519 ./rbot.rb --help core
520 ./rbot.rb --help "core save"
521 * Fix broken help from last point release
522 * Plugin API modification and cleanup. You no longer need to set @listen to
523 true in order to get all NOTICE and PRIVMSGs, you just need to define the
524 method. The method is now called listen(), renamed from listener(). This
525 should be the last time the plugin api is changed incompatibly.
526 * New plugin method kick(). Use it to see kicks (duh :))
527 * New plugin methods join(), part(). Obvious uses.
528 * Example plugin autorejoin.rb, uses kick event to rejoin channel and insult
530 * fix bug in remind plugins "remind me no more" recognition.
534 * Fix welcome message recognition for certain IRCd's.
538 * Allow keyword definitions which end in '?', like this:
540 * rdoc documentation!
541 * fixed broken address regexp, "rbot: .foo" was being treated as an addressed
542 form of "foo" (lost the .)
543 * fix stupid bug in last release (looking for wrong default conf dir)
547 * Tarball layout change. modules all in rbot/ now, and the rbot/ default
548 configuration moved to rbotconf/. This lets the thing run from an unpacked
549 tarball while also being ready to run with the modules installed somewhere
551 * change hashbang to /usr/bin/env ruby, in order to use PATH looking for ruby,
553 * allow "botnick : foo" style addressing, and even "botnick... foo"
554 * slap plugin (contributed by oct)
555 * renamed bot.send to bot.sendmsg, I didn't really want to override send() ;D
559 * Made sane for packagers. Looks in the right places for plugins and language
560 files now, so extra effort shouldn't be needed there.
564 * Fixed "nick taken on join" bug
565 * Dice plugin patch from David Dorward
566 * fix searchquote regexp
567 * conf.rbot: PASSWORD -> SERVER_PASSWORD, to prevent confusion with PASSWD,
568 which is for master auth.
572 * Fixed addquote (was incrementing quote ID twice)
573 * now strips colour/bold escapes from incoming messages (rbot was ignoring
574 messages addressed using a bolded colon, for example).
576 * more language breadth
577 * Addressing works better now
578 * Can autojoin channels with keys, conf.rbot line is:
579 autojoin_channels #chan1, #chan2, #chan3 key, #chan4 key, #chan5