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