ChangeLog

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