ChangeLog

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