ChangeLog

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