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