]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blob - ChangeLog
sendmsg improvements: plugins can now choose what to do with overlong messages withou...
[user/henk/code/ruby/rbot.git] / ChangeLog
1 2007-02-05  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
2
3         * sendmsg improvements: the bot sendmsg() method and all the methods
4         that rely on it (say(), notice(), and message methods such as reply())
5         now accept an option hash to customize its behaviour.
6                 * :newlines, which can be set to either :split or :join,
7                 depending on whether newlines in messages should be used as
8                 split-points, or should be be replaced by some string (defined
9                 in the :join_with option)
10                 * :max_lines, which determines the maximum number of lines to be
11                 sent by each messages. Last line is truncated (see next
12                 options). Set to nil to have no limits.
13                 * :overlong, which determines the behaviour when overlong lines
14                 are to be sent; possible values are :split or :truncate.
15                 * If :overlong is set to :split, :split_at determines the
16                 string/regexp to split at; default is /\s+/, other usual
17                 choice could be /\s+\|\s+/.
18                 * If :overlong is set to :split, the :purge_split option
19                 determines whether the :split_at expression should be removed
20                 from the next lines (defaults to true).
21                 * If :overlong is set to :truncate, the value of the option
22                 :truncate_text is replaced at the end of the truncated line
23
24 2007-02-03  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
25
26         * Plugin message mapper: Enhancements to the :requirements option.
27         When the requirement of a parameter is a regular expression with
28         capturing groups /(...)/, the corresponding map parameters will be
29         assigned (by default) the first non-nil capture instead of the whole
30         regular expression. If a specific capture group is desired instead,
31         the requirement should be in the form
32                 [/some regexp/, integer_index_of_the_desired_group]
33         or in the form
34                 {
35                 :regexp => /some regexp/,
36                 :index => integer_index_of_the_desired_group
37                 }
38         and a nil index will still give the default behavior.
39         If you want the whole regular expression to be the matched parameter
40         value, there are three options: use an index of 0, wrap the whole
41         regular expression in a capturing group, or use non-capturing groups
42         /(?:...)/. The latter is preferred because it's much faster.
43         When exploiting the capturing groups feature, please try to remember
44         to use /\s+/ instead of plain spaces / /, unless it's absolutely
45         necessary to have single spaces.
46
47 2007-02-02  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
48
49         * Plugin message mapper: Requirements (as set by the :requirements
50         hash) are now embedded in the regular expression matcher rather than
51         being cheked separately afterwards.
52
53 2007-01-30  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
54
55         * New IRC Framework: Server methods to retrieve a Channel or User are
56         now more robust to empty or nil nicks and channel names passed as
57         parameters.
58
59 2007-01-29  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
60
61         * Timer rescheduling: it is now possible to reschedule the period
62         any particular Action is taken by issuing the command
63                 @bot.timer.reschedule(handle, new_period)
64         where +handle+ is a timer handle returned by the @bot.timer.add() that
65         created the action, and new_period is the new period for the Action.
66
67 2007-01-23  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
68
69         * Reduced saving: the salut, lart, and quotes plugin now only save
70         their datafiles if anything changed since last time. This speeds up
71         operations such as saving and rescanning; it also allow hand-editing
72         of the data files while the bot is running, since a rescan will load
73         the changed data files without overwriting them with a useless save
74         before. Of course this only works if there are no pending changes in
75         the running bot.
76
77 2007-01-12  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
78
79         * Server timeout: rework the server timeout code. Instead of PINGing
80         the server unconditionally every server.ping_timeout seconds, we only
81         PING it if we don't receive anything in the user-chosen timeout (lazy
82         PING). The code rewrite also seems to have fixed the "bot stalling
83         doing nothing" problem, which seemed to have been a consequence of
84         @socket.select not having a timeout.
85
86 2006-11-01  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
87
88         * SSL support: patch from Robin H. Johnson <robbat2@gentoo.org>
89
90 2006-10-28  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
91
92         * A-Z game: try to guess the word the bot is thinking of: every miss
93         helps by reducing the range of allowed words, until it's so small
94         around the correct one that you can't miss it.
95
96 2006-10-27  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
97
98         * Flood protection: first attempt at penalty-based flood protection.
99         This should make rbot much less prone to Excess Floods *and* still
100         serve normally without excessive delays.
101
102 2006-10-25  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
103
104         * HttpUtil: Strings returned by get_cached now have a cached? method
105         which returns true or false depending on whether the result was taken
106         from the cache or not; this can be exploited by plugins that parse the
107         result in some particular way, since they can now skip the parsing
108         stage if they cache the parse result.
109
110 2006-10-24  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
111
112         * HttpUtil: initial implementation of proper caching based on
113         last-modified and etag HTTP headers
114
115 2006-10-17  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
116
117         * Salut plugin: handles (multilingual) salutations (hello/goodbye)
118
119 2006-10-15  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
120
121         * Language stuff: plugins can now handle language changes in a natural
122         fashion. lart is the first plugin to make use of this. NOTE: this
123         is not (yet) backwards compatible: the old larts/praises files from
124         previous rbot setups have to be renamed manually
125         * Language stuff: italian translations
126         * Utils.safe_save(filename): allows 'safe' saving of a file: it needs a
127         block, to which it will yield a temporary file on which operations can
128         be carried out. When the block returns, the tempfile will be renamed to
129         the given filename
130
131 2006-09-21  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
132
133         * New Auth Framework: restore backwards compatibility: 'auth
134         <masterpassword>' and 'login owner <masterpassword>' both work.
135         * Topic plugin: cleanups. Implement 'topic undo'. 'topic undo' after a
136         'topic undo' undoes the last undo.
137
138 2006-09-09  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
139
140         * New Auth Framework: rbot was opping anyone who asked for it (opme
141         plugin). Fixed, and cleaned up.
142
143 2006-09-01  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
144
145         * New Auth Framework: document and fine tune permissions view the auth
146         core botmodule.
147         * Version: when run from a svn checkout, the bot now tries to report
148         which svn revision it's at, and if there are local changes
149
150 2006-08-31  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
151
152         * Nickserv plugin: bot will now try to inform nickserv when password
153         is changed. Moreover it's not necessary to specify the nick anymore if
154         you want to change the password for the current bot nick. Also do some
155         internal cleanups while we're at it.
156
157 2006-08-29  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
158
159         * Script plugin: new (UNSAFE!) echo functions. Just like eval, but
160         m.replies the result of the evaluation.
161         * New Auth Framework: config keys now have their own permissions. So
162         you can allow people to view or edit only some of the config values.
163         auth.password defaults to false. Still needs some work.
164
165 2006-08-26  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
166
167         * Plugin message mapper: new implementation. Multi-word parameters now
168         need not be the last, and it is possible to retrieve the entire
169         substring with preserved whitespace by using to_s. Also, parts of the
170         map string can be bracketed to make them optional. Examples:
171                 remind :user [about] *stuff
172         will respond to
173                 remind me about washing my teeth
174         and also to
175                 remind me washing my teeth
176         It is possible to have parameters in brackets, in which case they will
177         be optional too, and default to nil or [] (resp. single- and
178         multi-word parameters) unless an alternative is provided in the
179         :defaults hash for the message map options.
180         * Script plugin: new (UNSAFE!) eval function. Not documented in help.
181         Not permitted by default.
182
183 2006-08-25 Mark Kretschmann <markey@web.de>
184
185         * Added quiz plugin, a multiplayer trivia quiz game.
186
187 2006-08-20  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
188
189         * Topic plugin: fix a bug that prevented it from loading
190         correctly.
191         * New IRC Framework: make sure that NOTICEs and PRIVMSGs do not
192         raise an exception when the target is in one of the special forms
193         #<mask> or $<mask>. Needs some work, though, since this case should be
194         handled specifically.
195
196 2006-08-17  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
197
198         * Fix help: It got broken while rearranging the plugin stuff, now it's
199         properly fixed.
200         * New Auth Framework: forgot to create the InvalidPassword exception.
201         It's a RuntimeError now.
202         * Fix help: this time for real (or so I hope).
203         * New IRC Framework: topic plugin now works correctly.
204         * New Auth Framework: nickserv plugin now defaults to false for its
205         auth, so that only owner can do stuff with it
206         * New Auth Framework: fix horrible typo, assignment instead of
207         equality test when checking for the username during login.
208         * Keywords plugin: tell and forget work again without 'keyword' before
209         them.
210
211 2006-08-12  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
212
213         * Subregistry: force prefix to be a String with to_s
214
215 2006-08-11  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
216
217         * AutoOp plugin: adapted to the new IRC framework.
218         * AutoOp plugin: trigger autoop on nick change too.
219         * New Auth Framework: allow? method now informs a user when they don't
220         have permission to do what they asked for.
221         * New nickreply and nickokay methods: they act like the old reply
222         method, but include the nick of the user the bot is replying to when
223         talking in public. The usual reply method can be configured to act
224         like this as default.
225
226 2006-08-10  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
227
228         * Fix a bug in new IRC Framework: the list of channels a quitting user was
229         on was not built correctly, causing an exception when the user was not
230         in the first channel in the list of channels.
231         * Fix a bug in new Auth Framework: BotUser's name is changed via
232         username=, not name=.
233         * New HalfLife 2 plugin from ocr: queries online servers for online
234         status and number of users.
235
236 2006-08-07  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
237
238         * Add kick method to kernel: plugins can now use
239                 @bot.kick channel, user, reason
240         to kick a user from a channel
241         * RSS plugin: fix rewatch_rss method
242         * RSS plugin: the different ways to represent channels before and
243         after the New IRC Framework was causing strange problems such as
244         watched feed not being listed as such, undeletable watches, double
245         watches etc. Fix this by checking both for the Channel objects and
246         their to_s form when checking for watches or deleting them.
247
248 2006-08-06  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
249
250         * Updating the ChangeLog again: describe the new stuff in trunk which
251         will be made available in the next release. Use Gnu style for new
252         changelog entries (yyyy-mm-dd name <email address>\n<tab> ...):
253         there's a macro for this since at least Vim 6.x and higher, called by
254         <Leader>o (default leader: slash (\))
255         * New IRC Framework: Server, Channels, User, Netmasks etc are all
256         proper Ruby objects. The better organization will allow multi-server
257         connections to be implemented more easily
258         * Modularize core: split the internal functionality from what can be
259         implemented as botmodules (which work just the same as plugins). Move
260         Configuration, Basics and Auth out of the 'kernel' into core
261         botmodules.
262         * New Auth Framework: BotUsers are now Ruby objects with attached
263         PermissionSets which define what the BotUser can do, by channel if
264         necessary. The new framework allows very fine-grained control while
265         still being very easy to manage for elementary usage. BotUser data can
266         be exported and imported, but no backwards compatibility has been
267         implemented yet. Most plugins still have to be updated to the new
268         command-path-based mechanism.
269
270 Sun Aug 06 17:33:55 BST 2006  Tom Gilbert <tom@linuxbrit.co.uk>
271
272   * 0.9.10 released
273         * Changes: Lots of new and updated plugins, including one to poll RSS feeds.
274         A first step towards a better auth system (total revamp due in 0.9.11).
275         Improvements to network and server code which should provide greater
276         stability. A new message queueing mechanism with bitrate throttling. A new
277         logging framework for debugging and tracing the activities of the bot. A
278         new split-db registry system for better performance and transactional
279         usage of bdb for resilience. More integration with Nickserv where
280         available including optional automatic ghost-killing.
281
282 Wed Sep 07 20:16:46 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
283
284   * Fixed quit, broke it last commit
285         * Fixed trap() for win32
286
287 Sun Aug 21 13:29:55 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
288
289   * fix for bug in quakenet plugin (trac #14)
290         * multiple fixes for unescaped bot nick in regexp's (trac #13)
291
292 Fri Aug 12 20:51:38 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
293
294   * fix up autoop plugin a bit
295
296 Thu Aug 11 00:13:11 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
297
298   * Added two plugins from Robin Kearney <robin@riviera.org.uk>
299         * Threat (US threat level :P)
300         * bash (bash.org quotes)
301
302 Thu Aug 11 00:04:31 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
303
304   * Patches from "Alexey I. Froloff" <raorn@altlinux.ru>
305         * Do not use "/home/#{Etc.getlogin}/" for default home directory, use
306         "#{Etc.getpwnam(Etc.getlogin).dir}/" instead.
307         * Do not try to load same plugin from different locations.  Added ability
308         to disable system-wide plugins - create PLUGIN.rb.disabled in user's
309         plugins directory.
310         * For example, to disable freshmeat plugin installed in /usr/share/rbot/plugins/freshmeat.rb one can create empty file ~/.rbot/plugins/freshmeat.rb.disabled
311
312 Mon Aug 08 23:08:01 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
313
314   * new markov plugin for random inane chat
315
316 Sun Aug 07 18:20:24 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
317
318   * stop insult plugin being used to insult the bot
319
320 Sun Aug 07 17:53:06 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
321
322   * workaround for people without YAML::load_file
323         * quit message for restart
324
325 Sun Aug 07 15:11:07 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
326
327   * fix address_prefix, broken in 0.9.9, reported by ruskie.
328
329 Sat Aug 06 00:54:34 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
330
331   * Released 0.9.9
332
333 Fri Aug 05 23:55:20 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
334
335   * few more tweaks preparing to release 0.9.9
336
337 Thu Aug 04 23:03:30 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
338
339   * Improved ircd recognition of rfc2812.rb
340         * de-string'd, de-cap'd rfc2812.rb, looks less shouty now
341         * moved the Q auth stuff (for quakenet) into a new qauth plugin (untested!)
342         * finish fixing the httputil
343
344 Thu Aug 04 00:11:52 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
345
346   * Tweaked the debug() stuff a bit. Need to do this more cleanly really
347         * Added a fair bit of documentation for some of the new features
348
349 Wed Aug 03 15:25:07 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
350
351   * Added french language file (TODO most of the plugins just talk english)
352         * The way the Enum configs were set up, it wasn't possible to add language
353         files to rbot at runtime (the directory was only scanned at startup). Now
354         you can set a values Proc, which is called to return a list of allowed
355         values whenever it's queried.
356         * Added Config module for determining where we were installed.
357         Unfortunately rubygems is a total whore in this regard, and I hope the
358         current hackery I have to do to support it becomes redundant in the
359         future.
360
361 Wed Aug 03 00:31:41 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
362
363   * Added Rakefile, tweaked gemspec
364
365 Tue Aug 02 16:27:36 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
366
367   * Fixed the new http.proxy* settings, they work!
368         * Fixed a bug with auth-checking for the config module
369         * misc tweaks
370
371 Sun Jul 31 02:20:08 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
372
373   * Updated docgen to generate rdoc again with the new repo structure
374         * added new restart command to the core bot, quits irc and reexecs the
375         bot, to pick up new code/libraries etc.
376
377 Sat Jul 30 22:33:36 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
378
379   * Config items are now objects, various types are available.
380         * The config wizard will now use registered config items if :wizard is set
381     to true for those items. It will ask questions in the order they were
382                 registered.
383         * The config module now works for doing runtime configuration.
384         * misc refactoring
385
386 Sat Jul 30 01:19:32 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
387
388   * config module for configuring the running bot via IRC
389         * BotConfig.register method for various modules and any plugin to register
390         bot configuration which the new config module will expose for them.
391         * various other tweaks as I continue to refactor..
392
393 Fri Jul 29 13:07:56 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
394
395   * Moved some stuff out of util.rb into the plugins that actually need
396         them. Those methods didn't belong in util as they were plugin-specific.
397         * moved a few more plugins to use map() where appropriate
398         * made the url plugin only store unique urls
399
400 Thu Jul 28 23:45:26 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
401
402   * Reworked the Timer module. The Timer now has a smart thread manager to
403         start/stop the tick() thread. This means the timer isn't called every 0.1
404         seconds to see what needs doing, which is much more efficient
405   * reworked the ircsocket queue mechanism to use a Timer
406         * reworked the nickserv plugin to use maps
407         * made server.reconnect_wait configurable
408         * added Class tracing mechanism to bin/rbot, use --trace Classname for
409         debugging
410
411 Tue Jul 26 14:41:34 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
412
413   * Prevent multiple plugin registrations of the same name
414         * reworking the config system to use yaml for persistence
415         * reworking the config system key names
416         * on first startup, the bot will prompt for the essential startup config
417         * new config module for configuring the bot at runtime
418         * new config module includes new configurables, for example changing the
419         bot's language at runtime.
420         * various other fixes
421         * New way of mapping plugins to strings, using maps. These may be
422         familiar to rails users. This is to reduce the amount of regexps plugins
423         currently need to do to parse arguments. The old method (privmsg) is still
424         supported, of course. Example plugin now:
425           def MyPlugin < Plugin
426                   def foo(m, params)
427                           m.reply "bar"
428                         end
429
430                         def complexfoo(m, params)
431                           m.reply "qux! (#{params[:bar]} #{params[:baz]})"
432                         end
433                 end
434                 plugin = MyPlugin.new
435                 # simple map
436                 plugin.map 'foo'
437
438     # this will match "rbot: foo somestring otherstring" and pass the
439                 # parameters as a hash using the names in the map.
440                 plugin.map 'foo :bar :baz', :action => 'complexfoo'
441                 # this means :foo is an optional parameter
442                 plugin.map 'foo :foo', :defaults => {:foo => 'bar'}
443     # you can also gobble up into an array
444                 plugin.map 'foo *bar' # params[:bar] will be an array of string elements
445     # and you can validate, here the first param must be a number
446                 plugin.map 'foo :bar', :requirements => {:foo => /^\d+$/}
447
448
449 Sat Jul 23 01:39:08 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
450
451   * Changed BotConfig to use yaml storage, method syntax instead of hash for
452         get/set, to allow more flexibility and encapsulation
453         * Added convenience method Message.okay (m.okay is the same as the
454         old-style @bot.okay m.replyto)
455
456 Wed Jul 20 23:30:01 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
457
458   * Move some core plugins to use the new httputil
459         * fix wserver's redirection handling for relative (i.e. broken) redirects
460         * fix tube plugin's html parsing
461
462 Wed Jul 20 01:18:06 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
463
464         * Add new httputil object to the bot object, to be used by plugins etc
465         that wish to make http requests. It sets up all the proxies etc for them
466         according to bot config.
467
468 Sat Jul 16 02:23:13 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
469
470   * Apply most of Rene's patch and fix various plugins.
471         * New plugin: autoop (auto ops via hostmask)
472         * New feature: karmastats
473
474 Wed Oct 13 16:16:31 BST 2004  Tom Gilbert <tom@linuxbrit.co.uk>
475
476   * Fix bug with quotes plugin where it gets confused and sees both a quote
477   and a keyword, both plugins are triggered by, for example "addquote foo is
478   bar"
479   * fixed this by implementing the "has_responded" flag on a message. When a
480   plugin replied to a message (or it manually sets m.replied to true), the
481   keywords plugin will honour that flag and not examine the message for
482   keywords. This flag can also be checked by listen plugins that don't want to
483   interfere with other plugin commands.
484
485 Mon Oct 11 00:37:52 BST 2004  Tom Gilbert <tom@linuxbrit.co.uk>
486
487   * Fixes to the NickServ plugin
488
489 Sat Oct 09 23:23:24 BST 2004  Tom Gilbert <tom@linuxbrit.co.uk>
490
491   * Keyword searching
492
493 Fri Oct 08 00:40:07 BST 2004  Tom Gilbert <tom@linuxbrit.co.uk>
494
495   * fixed insult plugin
496   * fixed excuse plugin
497
498 Thu Oct 07 23:28:05 BST 2004  Tom Gilbert <tom@linuxbrit.co.uk>
499
500   * searching for urls in the url plugin
501   * roshambo (rock/paper/scissors) plugin from Hans Fugal <hans@fugal.net>
502
503 Sat Apr 17 20:56:50 BST 2004  Tom Gilbert <tom@linuxbrit.co.uk>
504
505   * Oh, found new tv plugin in my inbox from ages ago, but it's still not
506   working so I guess it changed again since then
507   * New eightball plugin from Daniel Free
508
509 Sat Apr 17 20:44:43 BST 2004  Tom Gilbert <tom@linuxbrit.co.uk>
510
511   * Fixed the babelfish parser so translate works again.
512   * Misc other fixes
513   * Note some plugins are broken (excuse,insult) because the server they use
514     went away. I don't know of a replacement right now.
515   * tv plugin seems broken, perhaps the html changed.
516
517 Thu Jan 15 21:37:38 GMT 2004  Tom Gilbert <tom@linuxbrit.co.uk>
518
519   * Fixes for ruby 1.8
520
521 0.9.8
522 * new plugin from Alan Third <alan@idiocy.org>, allows you to search and list
523   UK TV programmes.
524
525 0.9.7
526 * various plugin updates
527 * fix (again) for C to F temp conversion in weather plugin
528 * channel topic patch from Peter Suschlik, gives plugin better access to topic
529   changes and related information
530
531 0.9.6
532 * changes to layout of slashdot plugin output
533 * freshmeat plugin, show latest updates or search
534 * fix to C to F temp conversion in weather plugin
535 * status command returns some bot status
536 * fortune plugin
537 * using BDB::Btree everywhere now, instead of BDB::Hash, because the Btree api
538   allows me to set my own key comparison function. This is needed to keep
539   supporting case insensitivity (vital for IRC), which was sadly broken in
540   0.9.5 :( All existing dbs will be upgraded automatically.
541 * roulette plugin - play russian roulette :) also keeps game stats.
542 * new config option, NO_KEYWORD_ADDRESS. If set to "true", the bot will always
543   respond to keywords it knows even when not addressed and the message doesn't
544   start with '. Message must end with "?" however.
545 * hopefully fixed welcome message parsing from certain server types
546
547 0.9.5
548 * plugin object registry
549   This provides persistant storage for plugins via a hash interface. The
550   default mode is an object store, so you can store ruby objects and reference
551   them with hash keys. This is because the default store/restore methods of
552   the plugins' RegistryAccessor are calls to Marshal.dump and Marshal.restore,
553   for example:
554     blah = Hash.new
555     blah[:foo] = "fum"
556     @registry[:blah] = blah
557   then, even after the bot is shut down and disconnected, on the next run you
558   can access the blah object as it was, with:
559     blah = @registry[:blah]
560   The registry can of course be used to store simple strings, fixnums, etc as
561   well, and should be useful to store or cache plugin data or dynamic plugin
562   configuration. 
563
564   If you don't need to store objects, and strictly want a persistant hash of
565   strings, you can override the store/restore methods to suit your needs, for
566   example (in your plugin):
567     def initialize
568       class << @registry
569         def store(val)
570           val
571         end
572         def restore(val)
573           val
574         end
575       end
576     end
577   Your plugins section of the registry is private, it has its own namespace
578   (derived from the plugin's class name, so change it and lose your data).
579   Calls to registry.each etc, will only iterate over your namespace.
580
581   The nickserv and karma plugins use the new registry and should serve as a
582   useful example. Basic usage of the registry is simple, just treat it as a
583   hash, with values that never die (unless you delete() them).
584 * Change to the nickserv plugin. The old method of putting the nickserv
585   password in rbot.conf was useless for multiple nicks or easy updates. The
586   plugin now uses the plugin registry to store passwords for any nicks it
587   owns. The plugin can be told to register the current nick (supply a password
588   or it'll generate one), identify for the current nick (if the password is
589   known), and can be told the passwords for other nicks. If NickServ asks the
590   bot to identify, it will automatically do so if it knows the appropriate
591   password.
592 * karma plugin now uses the plugin registry, it should automatically import
593   your existing, stored karma data into the registry.
594 * The babelfish plugin now caches results in the bot registry to speed up
595   common lookups.
596 * New message types and plugin methods to grab them,
597   quit(QuitMessage):   Called when a user (or the bot) quits IRC
598   nick(NickMessage):   Called when a user (or the bot) changes Nick
599   topic(TopicMessage): Called when a user (or the bot) changes a channel topic
600 * A plugin's listen() method will now receive any kind of Message, e.g.
601   PrivMessage, NoticeMessage, NickMessage, JoinMessage, etc
602 * New plugins:
603   seen: the usual "seen" stuff: 
604         rbot: seen giblet?
605         giblet was last seen xxx ago doing xxx
606   cal:  calls the unix cal program to display a calendar
607   math: evaluates mathematical expressions:
608         rbot: math 2+2
609         rbot: math 4 to the power of 8
610         rbot: math ((232+432) - 4) / 2
611         (ported from infobot. Thanks to Kevin Lenzo, who wrote the
612         original infobot math module)
613   slashdot: displays latest headlines or searches for articles
614   url:  stores urls mentioned in channels for regurgitation later
615   weather: grabs and parses METAR weather data, will remember the last weather
616            code you asked for so you don't have to :)
617 * New utility function, Util.http_get(url) for getting remote data via http,
618   just dumps response.body into a string and returns it, or nil if anything at
619   all goes wrong. Useful for simple plugins.
620 * random quit messages if none specified, messages set in language description
621   file
622 * keywords are now stored in bdb databases - your old keywords.rbot will be
623   imported. Static keywords (fact packs) are also stored in bdb databases, and
624   rbot will automatically convert any text .fact file dropped in the confdir's
625   keywords subdirectory, at startup, into a bdb file. If both a db and a text
626   file exist of the same name (except the extension), the text file will be
627   imported and merged into the database.
628   static keywords will be looked up in each factpack db in turn, in
629   alphabetical filename order - so you can prioritise using the filename if
630   you wish.
631 * fixed a bug with autsplitting long sent lines, the last line was often being
632   split unnecessarily.
633
634 0.9.4
635 * Massive cleanup of rfc2812.rb, contributed by Lars Christensen
636   <dsl8950@vip.cybercity.dk>, gets rid of a lot of regexps
637 * Fixed bug reading static keyword files - "foo <=is=> bar" may not have
638   worked for a couple of releases, only "foo<=is=>bar" was working - this was
639   not intended and should be fixed now
640 * Experimental send queue, to prevent the bot from flooding out, the delay
641   between sending messages to the server defaults to 2s, but is configurable
642   in conf.rbot, set SENDQ_DELAY (0 to disable queueing). You can also set/get
643   the value from the bot, "rbot: options get sendq_delay", and 
644   "rbot: options set sendq_delay 1.5", if you have sufficient auth for "config"
645   This is a bursting sendq, most ircd's allow bursts of up to 5
646   lines, with non-burst limits of 512 bytes/2 seconds. To set the burst limit,
647   configure SENDQ_BURST in conf.rbot, or do the same kind of stuff with
648   "rbot: options set sendq_burst 2", etc.
649   The defaults are 2s/4 burst, which seem to work okay for me.
650 * support for multiple, customisable, addressing prefixes. Set ADDRESS_PREFIX
651   in conf.rbot to a space separate list of addressing prefixes, e.g
652   ADDRESS_PREFIX = | ! =>
653   Would mean that all of the following in channel messages would cause the bot
654   to respond:
655               rbot: version
656               |version
657               !version
658               =>version
659 * bb plugin removed, bb is nearly over and it doesn't work 100% anyway
660 * Two plugins from brailsmt (from #ruby-lang on openprojects), a stats plugin
661   which monitors usage of 1-word sentences, and lart, which allows you to ask
662   rbot to lart people - with an optional reason - larts are user-definable and
663   can be added on the fly.
664 * made google.rb work for people with 1.6 ruby's net/http
665
666 0.9.3
667
668 * fix quit messages
669 * new plugin for handling nickserv-protected nicks, use NICKSERV_PASSWORD in
670   the config file.
671 * fixes to a few other buglets
672 * new plugin to grab bigbrother headlines, still buggy and only useful for UK
673   folks who love bb :-)
674 * fixes to various plugins
675 * Patch from akira yamada <akira@ruby-lang.org>
676   DNS plugin: Use resolv-replace if found, do lookup in new thread
677   Fix bug joining channels with keys
678
679 0.9.2
680
681 * better "connect failure" error message
682 * better option parsing, and --debug option
683 * access to bot's online help via commandline, eg:
684   ./rbot.rb --help
685   ./rbot.rb --help core
686   ./rbot.rb --help "core save"
687 * Fix broken help from last point release
688 * Plugin API modification and cleanup. You no longer need to set @listen to
689   true in order to get all NOTICE and PRIVMSGs, you just need to define the
690   method. The method is now called listen(), renamed from listener(). This
691   should be the last time the plugin api is changed incompatibly.
692 * New plugin method kick(). Use it to see kicks (duh :))
693 * New plugin methods join(), part(). Obvious uses.
694 * Example plugin autorejoin.rb, uses kick event to rejoin channel and insult
695   kicker
696 * fix bug in remind plugins "remind me no more" recognition.
697
698 0.9.1
699
700 * Fix welcome message recognition for certain IRCd's.
701
702 0.9
703
704 * Allow keyword definitions which end in '?', like this:
705   bot: foo is bar\?
706 * rdoc documentation!
707 * fixed broken address regexp, "rbot: .foo" was being treated as an addressed
708   form of "foo" (lost the .)
709 * fix stupid bug in last release (looking for wrong default conf dir)
710
711 0.8
712
713 * Tarball layout change. modules all in rbot/ now, and the rbot/ default
714   configuration moved to rbotconf/. This lets the thing run from an unpacked
715   tarball while also being ready to run with the modules installed somewhere
716   else.
717 * change hashbang to /usr/bin/env ruby, in order to use PATH looking for ruby,
718   it's BSD friendly!
719 * allow "botnick : foo" style addressing, and even "botnick... foo"
720 * slap plugin (contributed by oct)
721 * renamed bot.send to bot.sendmsg, I didn't really want to override send() ;D
722   (thanks Kero)
723
724 0.7.1
725 * Made sane for packagers. Looks in the right places for plugins and language
726   files now, so extra effort shouldn't be needed there.
727
728 0.7
729
730 * Fixed "nick taken on join" bug
731 * Dice plugin patch from David Dorward
732 * fix searchquote regexp
733 * conf.rbot: PASSWORD -> SERVER_PASSWORD, to prevent confusion with PASSWD,
734   which is for master auth.
735
736 0.6
737
738 * Fixed addquote (was incrementing quote ID twice)
739 * now strips colour/bold escapes from incoming messages (rbot was ignoring
740   messages addressed using a bolded colon, for example).
741 * minor bugfixes
742 * more language breadth
743 * Addressing works better now
744 * Can autojoin channels with keys, conf.rbot line is:
745   autojoin_channels #chan1, #chan2, #chan3 key, #chan4 key, #chan5
746 * dice plugin fixes
747
748 0.5
749
750 * Initial release