ChangeLog

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