ChangeLog

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