ChangeLog

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