ChangeLog

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