ChangeLog

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