ChangeLog

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