ChangeLog

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