ChangeLog

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