ChangeLog

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