ChangeLog

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