ChangeLog

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