ChangeLog

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