ChangeLog

   1 Sun Aug 06 17:33:55 BST 2006  Tom Gilbert <tom@linuxbrit.co.uk>
   2
   3   * 0.9.10 released
   4         * Changes: Lots of new and updated plugins, including one to poll RSS feeds.
   5         A first step towards a better auth system (total revamp due in 0.9.11).
   6         Improvements to network and server code which should provide greater
   7         stability. A new message queueing mechanism with bitrate throttling. A new
   8         logging framework for debugging and tracing the activities of the bot. A
   9         new split-db registry system for better performance and transactional
  10         usage of bdb for resilience. More integration with Nickserv where
  11         available including optional automatic ghost-killing.
  12
  13 Wed Sep 07 20:16:46 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
  14
  15   * Fixed quit, broke it last commit
  16         * Fixed trap() for win32
  17
  18 Sun Aug 21 13:29:55 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
  19
  20   * fix for bug in quakenet plugin (trac #14)
  21         * multiple fixes for unescaped bot nick in regexp's (trac #13)
  22
  23 Fri Aug 12 20:51:38 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
  24
  25   * fix up autoop plugin a bit
  26
  27 Thu Aug 11 00:13:11 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
  28
  29   * Added two plugins from Robin Kearney <robin@riviera.org.uk>
  30         * Threat (US threat level :P)
  31         * bash (bash.org quotes)
  32
  33 Thu Aug 11 00:04:31 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
  34
  35   * Patches from "Alexey I. Froloff" <raorn@altlinux.ru>
  36         * Do not use "/home/#{Etc.getlogin}/" for default home directory, use
  37         "#{Etc.getpwnam(Etc.getlogin).dir}/" instead.
  38         * Do not try to load same plugin from different locations.  Added ability
  39         to disable system-wide plugins - create PLUGIN.rb.disabled in user's
  40         plugins directory.
  41         * For example, to disable freshmeat plugin installed in /usr/share/rbot/plugins/freshmeat.rb one can create empty file ~/.rbot/plugins/freshmeat.rb.disabled
  42
  43 Mon Aug 08 23:08:01 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
  44
  45   * new markov plugin for random inane chat
  46
  47 Sun Aug 07 18:20:24 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
  48
  49   * stop insult plugin being used to insult the bot
  50
  51 Sun Aug 07 17:53:06 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
  52
  53   * workaround for people without YAML::load_file
  54         * quit message for restart
  55
  56 Sun Aug 07 15:11:07 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
  57
  58   * fix address_prefix, broken in 0.9.9, reported by ruskie.
  59
  60 Sat Aug 06 00:54:34 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
  61
  62   * Released 0.9.9
  63
  64 Fri Aug 05 23:55:20 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
  65
  66   * few more tweaks preparing to release 0.9.9
  67
  68 Thu Aug 04 23:03:30 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
  69
  70   * Improved ircd recognition of rfc2812.rb
  71         * de-string'd, de-cap'd rfc2812.rb, looks less shouty now
  72         * moved the Q auth stuff (for quakenet) into a new qauth plugin (untested!)
  73         * finish fixing the httputil
  74
  75 Thu Aug 04 00:11:52 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
  76
  77   * Tweaked the debug() stuff a bit. Need to do this more cleanly really
  78         * Added a fair bit of documentation for some of the new features
  79
  80 Wed Aug 03 15:25:07 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
  81
  82   * Added french language file (TODO most of the plugins just talk english)
  83         * The way the Enum configs were set up, it wasn't possible to add language
  84         files to rbot at runtime (the directory was only scanned at startup). Now
  85         you can set a values Proc, which is called to return a list of allowed
  86         values whenever it's queried.
  87         * Added Config module for determining where we were installed.
  88         Unfortunately rubygems is a total whore in this regard, and I hope the
  89         current hackery I have to do to support it becomes redundant in the
  90         future.
  91
  92 Wed Aug 03 00:31:41 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
  93
  94   * Added Rakefile, tweaked gemspec
  95
  96 Tue Aug 02 16:27:36 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
  97
  98   * Fixed the new http.proxy* settings, they work!
  99         * Fixed a bug with auth-checking for the config module
 100         * misc tweaks
 101
 102 Sun Jul 31 02:20:08 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 103
 104   * Updated docgen to generate rdoc again with the new repo structure
 105         * added new restart command to the core bot, quits irc and reexecs the
 106         bot, to pick up new code/libraries etc.
 107
 108 Sat Jul 30 22:33:36 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 109
 110   * Config items are now objects, various types are available.
 111         * The config wizard will now use registered config items if :wizard is set
 112     to true for those items. It will ask questions in the order they were
 113                 registered.
 114         * The config module now works for doing runtime configuration.
 115         * misc refactoring
 116
 117 Sat Jul 30 01:19:32 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 118
 119   * config module for configuring the running bot via IRC
 120         * BotConfig.register method for various modules and any plugin to register
 121         bot configuration which the new config module will expose for them.
 122         * various other tweaks as I continue to refactor..
 123
 124 Fri Jul 29 13:07:56 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 125
 126   * Moved some stuff out of util.rb into the plugins that actually need
 127         them. Those methods didn't belong in util as they were plugin-specific.
 128         * moved a few more plugins to use map() where appropriate
 129         * made the url plugin only store unique urls
 130
 131 Thu Jul 28 23:45:26 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 132
 133   * Reworked the Timer module. The Timer now has a smart thread manager to
 134         start/stop the tick() thread. This means the timer isn't called every 0.1
 135         seconds to see what needs doing, which is much more efficient
 136   * reworked the ircsocket queue mechanism to use a Timer
 137         * reworked the nickserv plugin to use maps
 138         * made server.reconnect_wait configurable
 139         * added Class tracing mechanism to bin/rbot, use --trace Classname for
 140         debugging
 141
 142 Tue Jul 26 14:41:34 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 143
 144   * Prevent multiple plugin registrations of the same name
 145         * reworking the config system to use yaml for persistence
 146         * reworking the config system key names
 147         * on first startup, the bot will prompt for the essential startup config
 148         * new config module for configuring the bot at runtime
 149         * new config module includes new configurables, for example changing the
 150         bot's language at runtime.
 151         * various other fixes
 152         * New way of mapping plugins to strings, using maps. These may be
 153         familiar to rails users. This is to reduce the amount of regexps plugins
 154         currently need to do to parse arguments. The old method (privmsg) is still
 155         supported, of course. Example plugin now:
 156           def MyPlugin < Plugin
 157                   def foo(m, params)
 158                           m.reply "bar"
 159                         end
 160
 161                         def complexfoo(m, params)
 162                           m.reply "qux! (#{params[:bar]} #{params[:baz]})"
 163                         end
 164                 end
 165                 plugin = MyPlugin.new
 166                 # simple map
 167                 plugin.map 'foo'
 168
 169     # this will match "rbot: foo somestring otherstring" and pass the
 170                 # parameters as a hash using the names in the map.
 171                 plugin.map 'foo :bar :baz', :action => 'complexfoo'
 172                 # this means :foo is an optional parameter
 173                 plugin.map 'foo :foo', :defaults => {:foo => 'bar'}
 174     # you can also gobble up into an array
 175                 plugin.map 'foo *bar' # params[:bar] will be an array of string elements
 176     # and you can validate, here the first param must be a number
 177                 plugin.map 'foo :bar', :requirements => {:foo => /^\d+$/}
 178
 179
 180 Sat Jul 23 01:39:08 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 181
 182   * Changed BotConfig to use yaml storage, method syntax instead of hash for
 183         get/set, to allow more flexibility and encapsulation
 184         * Added convenience method Message.okay (m.okay is the same as the
 185         old-style @bot.okay m.replyto)
 186
 187 Wed Jul 20 23:30:01 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 188
 189   * Move some core plugins to use the new httputil
 190         * fix wserver's redirection handling for relative (i.e. broken) redirects
 191         * fix tube plugin's html parsing
 192
 193 Wed Jul 20 01:18:06 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 194
 195         * Add new httputil object to the bot object, to be used by plugins etc
 196         that wish to make http requests. It sets up all the proxies etc for them
 197         according to bot config.
 198
 199 Sat Jul 16 02:23:13 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 200
 201   * Apply most of Rene's patch and fix various plugins.
 202         * New plugin: autoop (auto ops via hostmask)
 203         * New feature: karmastats
 204
 205 Wed Oct 13 16:16:31 BST 2004  Tom Gilbert <tom@linuxbrit.co.uk>
 206
 207   * Fix bug with quotes plugin where it gets confused and sees both a quote
 208   and a keyword, both plugins are triggered by, for example "addquote foo is
 209   bar"
 210   * fixed this by implementing the "has_responded" flag on a message. When a
 211   plugin replied to a message (or it manually sets m.replied to true), the
 212   keywords plugin will honour that flag and not examine the message for
 213   keywords. This flag can also be checked by listen plugins that don't want to
 214   interfere with other plugin commands.
 215
 216 Mon Oct 11 00:37:52 BST 2004  Tom Gilbert <tom@linuxbrit.co.uk>
 217
 218   * Fixes to the NickServ plugin
 219
 220 Sat Oct 09 23:23:24 BST 2004  Tom Gilbert <tom@linuxbrit.co.uk>
 221
 222   * Keyword searching
 223
 224 Fri Oct 08 00:40:07 BST 2004  Tom Gilbert <tom@linuxbrit.co.uk>
 225
 226   * fixed insult plugin
 227   * fixed excuse plugin
 228
 229 Thu Oct 07 23:28:05 BST 2004  Tom Gilbert <tom@linuxbrit.co.uk>
 230
 231   * searching for urls in the url plugin
 232   * roshambo (rock/paper/scissors) plugin from Hans Fugal <hans@fugal.net>
 233
 234 Sat Apr 17 20:56:50 BST 2004  Tom Gilbert <tom@linuxbrit.co.uk>
 235
 236   * Oh, found new tv plugin in my inbox from ages ago, but it's still not
 237   working so I guess it changed again since then
 238   * New eightball plugin from Daniel Free
 239
 240 Sat Apr 17 20:44:43 BST 2004  Tom Gilbert <tom@linuxbrit.co.uk>
 241
 242   * Fixed the babelfish parser so translate works again.
 243   * Misc other fixes
 244   * Note some plugins are broken (excuse,insult) because the server they use
 245     went away. I don't know of a replacement right now.
 246   * tv plugin seems broken, perhaps the html changed.
 247
 248 Thu Jan 15 21:37:38 GMT 2004  Tom Gilbert <tom@linuxbrit.co.uk>
 249
 250   * Fixes for ruby 1.8
 251
 252 0.9.8
 253 * new plugin from Alan Third <alan@idiocy.org>, allows you to search and list
 254   UK TV programmes.
 255
 256 0.9.7
 257 * various plugin updates
 258 * fix (again) for C to F temp conversion in weather plugin
 259 * channel topic patch from Peter Suschlik, gives plugin better access to topic
 260   changes and related information
 261
 262 0.9.6
 263 * changes to layout of slashdot plugin output
 264 * freshmeat plugin, show latest updates or search
 265 * fix to C to F temp conversion in weather plugin
 266 * status command returns some bot status
 267 * fortune plugin
 268 * using BDB::Btree everywhere now, instead of BDB::Hash, because the Btree api
 269   allows me to set my own key comparison function. This is needed to keep
 270   supporting case insensitivity (vital for IRC), which was sadly broken in
 271   0.9.5 :( All existing dbs will be upgraded automatically.
 272 * roulette plugin - play russian roulette :) also keeps game stats.
 273 * new config option, NO_KEYWORD_ADDRESS. If set to "true", the bot will always
 274   respond to keywords it knows even when not addressed and the message doesn't
 275   start with '. Message must end with "?" however.
 276 * hopefully fixed welcome message parsing from certain server types
 277
 278 0.9.5
 279 * plugin object registry
 280   This provides persistant storage for plugins via a hash interface. The
 281   default mode is an object store, so you can store ruby objects and reference
 282   them with hash keys. This is because the default store/restore methods of
 283   the plugins' RegistryAccessor are calls to Marshal.dump and Marshal.restore,
 284   for example:
 285     blah = Hash.new
 286     blah[:foo] = "fum"
 287     @registry[:blah] = blah
 288   then, even after the bot is shut down and disconnected, on the next run you
 289   can access the blah object as it was, with:
 290     blah = @registry[:blah]
 291   The registry can of course be used to store simple strings, fixnums, etc as
 292   well, and should be useful to store or cache plugin data or dynamic plugin
 293   configuration.
 294
 295   If you don't need to store objects, and strictly want a persistant hash of
 296   strings, you can override the store/restore methods to suit your needs, for
 297   example (in your plugin):
 298     def initialize
 299       class << @registry
 300         def store(val)
 301           val
 302         end
 303         def restore(val)
 304           val
 305         end
 306       end
 307     end
 308   Your plugins section of the registry is private, it has its own namespace
 309   (derived from the plugin's class name, so change it and lose your data).
 310   Calls to registry.each etc, will only iterate over your namespace.
 311
 312   The nickserv and karma plugins use the new registry and should serve as a
 313   useful example. Basic usage of the registry is simple, just treat it as a
 314   hash, with values that never die (unless you delete() them).
 315 * Change to the nickserv plugin. The old method of putting the nickserv
 316   password in rbot.conf was useless for multiple nicks or easy updates. The
 317   plugin now uses the plugin registry to store passwords for any nicks it
 318   owns. The plugin can be told to register the current nick (supply a password
 319   or it'll generate one), identify for the current nick (if the password is
 320   known), and can be told the passwords for other nicks. If NickServ asks the
 321   bot to identify, it will automatically do so if it knows the appropriate
 322   password.
 323 * karma plugin now uses the plugin registry, it should automatically import
 324   your existing, stored karma data into the registry.
 325 * The babelfish plugin now caches results in the bot registry to speed up
 326   common lookups.
 327 * New message types and plugin methods to grab them,
 328   quit(QuitMessage):   Called when a user (or the bot) quits IRC
 329   nick(NickMessage):   Called when a user (or the bot) changes Nick
 330   topic(TopicMessage): Called when a user (or the bot) changes a channel topic
 331 * A plugin's listen() method will now receive any kind of Message, e.g.
 332   PrivMessage, NoticeMessage, NickMessage, JoinMessage, etc
 333 * New plugins:
 334   seen: the usual "seen" stuff:
 335         rbot: seen giblet?
 336         giblet was last seen xxx ago doing xxx
 337   cal:  calls the unix cal program to display a calendar
 338   math: evaluates mathematical expressions:
 339         rbot: math 2+2
 340         rbot: math 4 to the power of 8
 341         rbot: math ((232+432) - 4) / 2
 342         (ported from infobot. Thanks to Kevin Lenzo, who wrote the
 343         original infobot math module)
 344   slashdot: displays latest headlines or searches for articles
 345   url:  stores urls mentioned in channels for regurgitation later
 346   weather: grabs and parses METAR weather data, will remember the last weather
 347            code you asked for so you don't have to :)
 348 * New utility function, Util.http_get(url) for getting remote data via http,
 349   just dumps response.body into a string and returns it, or nil if anything at
 350   all goes wrong. Useful for simple plugins.
 351 * random quit messages if none specified, messages set in language description
 352   file
 353 * keywords are now stored in bdb databases - your old keywords.rbot will be
 354   imported. Static keywords (fact packs) are also stored in bdb databases, and
 355   rbot will automatically convert any text .fact file dropped in the confdir's
 356   keywords subdirectory, at startup, into a bdb file. If both a db and a text
 357   file exist of the same name (except the extension), the text file will be
 358   imported and merged into the database.
 359   static keywords will be looked up in each factpack db in turn, in
 360   alphabetical filename order - so you can prioritise using the filename if
 361   you wish.
 362 * fixed a bug with autsplitting long sent lines, the last line was often being
 363   split unnecessarily.
 364
 365 0.9.4
 366 * Massive cleanup of rfc2812.rb, contributed by Lars Christensen
 367   <dsl8950@vip.cybercity.dk>, gets rid of a lot of regexps
 368 * Fixed bug reading static keyword files - "foo <=is=> bar" may not have
 369   worked for a couple of releases, only "foo<=is=>bar" was working - this was
 370   not intended and should be fixed now
 371 * Experimental send queue, to prevent the bot from flooding out, the delay
 372   between sending messages to the server defaults to 2s, but is configurable
 373   in conf.rbot, set SENDQ_DELAY (0 to disable queueing). You can also set/get
 374   the value from the bot, "rbot: options get sendq_delay", and
 375   "rbot: options set sendq_delay 1.5", if you have sufficient auth for "config"
 376   This is a bursting sendq, most ircd's allow bursts of up to 5
 377   lines, with non-burst limits of 512 bytes/2 seconds. To set the burst limit,
 378   configure SENDQ_BURST in conf.rbot, or do the same kind of stuff with
 379   "rbot: options set sendq_burst 2", etc.
 380   The defaults are 2s/4 burst, which seem to work okay for me.
 381 * support for multiple, customisable, addressing prefixes. Set ADDRESS_PREFIX
 382   in conf.rbot to a space separate list of addressing prefixes, e.g
 383   ADDRESS_PREFIX = | ! =>
 384   Would mean that all of the following in channel messages would cause the bot
 385   to respond:
 386               rbot: version
 387               |version
 388               !version
 389               =>version
 390 * bb plugin removed, bb is nearly over and it doesn't work 100% anyway
 391 * Two plugins from brailsmt (from #ruby-lang on openprojects), a stats plugin
 392   which monitors usage of 1-word sentences, and lart, which allows you to ask
 393   rbot to lart people - with an optional reason - larts are user-definable and
 394   can be added on the fly.
 395 * made google.rb work for people with 1.6 ruby's net/http
 396
 397 0.9.3
 398
 399 * fix quit messages
 400 * new plugin for handling nickserv-protected nicks, use NICKSERV_PASSWORD in
 401   the config file.
 402 * fixes to a few other buglets
 403 * new plugin to grab bigbrother headlines, still buggy and only useful for UK
 404   folks who love bb :-)
 405 * fixes to various plugins
 406 * Patch from akira yamada <akira@ruby-lang.org>
 407   DNS plugin: Use resolv-replace if found, do lookup in new thread
 408   Fix bug joining channels with keys
 409
 410 0.9.2
 411
 412 * better "connect failure" error message
 413 * better option parsing, and --debug option
 414 * access to bot's online help via commandline, eg:
 415   ./rbot.rb --help
 416   ./rbot.rb --help core
 417   ./rbot.rb --help "core save"
 418 * Fix broken help from last point release
 419 * Plugin API modification and cleanup. You no longer need to set @listen to
 420   true in order to get all NOTICE and PRIVMSGs, you just need to define the
 421   method. The method is now called listen(), renamed from listener(). This
 422   should be the last time the plugin api is changed incompatibly.
 423 * New plugin method kick(). Use it to see kicks (duh :))
 424 * New plugin methods join(), part(). Obvious uses.
 425 * Example plugin autorejoin.rb, uses kick event to rejoin channel and insult
 426   kicker
 427 * fix bug in remind plugins "remind me no more" recognition.
 428
 429 0.9.1
 430
 431 * Fix welcome message recognition for certain IRCd's.
 432
 433 0.9
 434
 435 * Allow keyword definitions which end in '?', like this:
 436   bot: foo is bar\?
 437 * rdoc documentation!
 438 * fixed broken address regexp, "rbot: .foo" was being treated as an addressed
 439   form of "foo" (lost the .)
 440 * fix stupid bug in last release (looking for wrong default conf dir)
 441
 442 0.8
 443
 444 * Tarball layout change. modules all in rbot/ now, and the rbot/ default
 445   configuration moved to rbotconf/. This lets the thing run from an unpacked
 446   tarball while also being ready to run with the modules installed somewhere
 447   else.
 448 * change hashbang to /usr/bin/env ruby, in order to use PATH looking for ruby,
 449   it's BSD friendly!
 450 * allow "botnick : foo" style addressing, and even "botnick... foo"
 451 * slap plugin (contributed by oct)
 452 * renamed bot.send to bot.sendmsg, I didn't really want to override send() ;D
 453   (thanks Kero)
 454
 455 0.7.1
 456 * Made sane for packagers. Looks in the right places for plugins and language
 457   files now, so extra effort shouldn't be needed there.
 458
 459 0.7
 460
 461 * Fixed "nick taken on join" bug
 462 * Dice plugin patch from David Dorward
 463 * fix searchquote regexp
 464 * conf.rbot: PASSWORD -> SERVER_PASSWORD, to prevent confusion with PASSWD,
 465   which is for master auth.
 466
 467 0.6
 468
 469 * Fixed addquote (was incrementing quote ID twice)
 470 * now strips colour/bold escapes from incoming messages (rbot was ignoring
 471   messages addressed using a bolded colon, for example).
 472 * minor bugfixes
 473 * more language breadth
 474 * Addressing works better now
 475 * Can autojoin channels with keys, conf.rbot line is:
 476   autojoin_channels #chan1, #chan2, #chan3 key, #chan4 key, #chan5
 477 * dice plugin fixes
 478
 479 0.5
 480
 481 * Initial release