ChangeLog

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