ChangeLog

   1 2007-02-12  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
   2
   3         * Remote Service Provider: from an idea by halorgium <rbot@spork.in>,
   4         initial steps towards a DRb-based remote service provider for rbot.
   5         When complete, it will give plugins the ability to listen to
   6         'messages' from remote clients connected to the bot, allowing for such
   7         things as svn notification without RSS polling, remote control of
   8         the bot, or even (why not?) botnets.
   9         * Remote Service Provider: BotModules can now include the
  10         RemoteBotModule interface that provides them with the remote_map()
  11         method that works just like the map() method, but for remote commands
  12
  13 2007-02-08  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
  14
  15         * Languages: Japanese support with language files, salutations, larts
  16         and praises, thanks to hagabaka (Yaohan Chen <yaohan.chen@gmail.com>)
  17
  18 2007-02-05  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
  19
  20         * sendmsg improvements: the bot sendmsg() method and all the methods
  21         that rely on it (say(), notice(), and message methods such as reply())
  22         now accept an option hash to customize its behaviour.
  23                 * :newlines, which can be set to either :split or :join,
  24                 depending on whether newlines in messages should be used as
  25                 split-points, or should be be replaced by some string (defined
  26                 in the :join_with option)
  27                 * :max_lines, which determines the maximum number of lines to be
  28                 sent by each messages. Last line is truncated (see next
  29                 options). Set to nil to have no limits.
  30                 * :overlong, which determines the behaviour when overlong lines
  31                 are to be sent; possible values are :split or :truncate.
  32                 * If :overlong is set to :split, :split_at determines the
  33                 string/regexp to split at; default is /\s+/, other usual
  34                 choice could be /\s+\|\s+/.
  35                 * If :overlong is set to :split, the :purge_split option
  36                 determines whether the :split_at expression should be removed
  37                 from the next lines (defaults to true).
  38                 * If :overlong is set to :truncate, the value of the option
  39                 :truncate_text is replaced at the end of the truncated line
  40         * LinkBot plugin: initial commit of a plugin to handle messages from
  41         eggdrops and other bots that act as cross-network channel links.
  42         Suggested by hagabaka (Yaohan Chen <yaohan.chen@gmail.com>)
  43
  44
  45 2007-02-03  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
  46
  47         * Plugin message mapper: Enhancements to the :requirements option.
  48         When the requirement of a parameter is a regular expression with
  49         capturing groups /(...)/, the corresponding map parameters will be
  50         assigned (by default) the first non-nil capture instead of the whole
  51         regular expression. If a specific capture group is desired instead,
  52         the requirement should be in the form
  53                 [/some regexp/, integer_index_of_the_desired_group]
  54         or in the form
  55                 {
  56                 :regexp => /some regexp/,
  57                 :index => integer_index_of_the_desired_group
  58                 }
  59         and a nil index will still give the default behavior.
  60         If you want the whole regular expression to be the matched parameter
  61         value, there are three options: use an index of 0, wrap the whole
  62         regular expression in a capturing group, or use non-capturing groups
  63         /(?:...)/. The latter is preferred because it's much faster.
  64         When exploiting the capturing groups feature, please try to remember
  65         to use /\s+/ instead of plain spaces / /, unless it's absolutely
  66         necessary to have single spaces.
  67
  68 2007-02-02  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
  69
  70         * Plugin message mapper: Requirements (as set by the :requirements
  71         hash) are now embedded in the regular expression matcher rather than
  72         being cheked separately afterwards.
  73
  74 2007-01-30  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
  75
  76         * New IRC Framework: Server methods to retrieve a Channel or User are
  77         now more robust to empty or nil nicks and channel names passed as
  78         parameters.
  79
  80 2007-01-29  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
  81
  82         * Timer rescheduling: it is now possible to reschedule the period
  83         any particular Action is taken by issuing the command
  84                 @bot.timer.reschedule(handle, new_period)
  85         where +handle+ is a timer handle returned by the @bot.timer.add() that
  86         created the action, and new_period is the new period for the Action.
  87
  88 2007-01-23  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
  89
  90         * Reduced saving: the salut, lart, and quotes plugin now only save
  91         their datafiles if anything changed since last time. This speeds up
  92         operations such as saving and rescanning; it also allow hand-editing
  93         of the data files while the bot is running, since a rescan will load
  94         the changed data files without overwriting them with a useless save
  95         before. Of course this only works if there are no pending changes in
  96         the running bot.
  97
  98 2007-01-12  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
  99
 100         * Server timeout: rework the server timeout code. Instead of PINGing
 101         the server unconditionally every server.ping_timeout seconds, we only
 102         PING it if we don't receive anything in the user-chosen timeout (lazy
 103         PING). The code rewrite also seems to have fixed the "bot stalling
 104         doing nothing" problem, which seemed to have been a consequence of
 105         @socket.select not having a timeout.
 106
 107 2006-11-01  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
 108
 109         * SSL support: patch from Robin H. Johnson <robbat2@gentoo.org>
 110
 111 2006-10-28  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
 112
 113         * A-Z game: try to guess the word the bot is thinking of: every miss
 114         helps by reducing the range of allowed words, until it's so small
 115         around the correct one that you can't miss it.
 116
 117 2006-10-27  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
 118
 119         * Flood protection: first attempt at penalty-based flood protection.
 120         This should make rbot much less prone to Excess Floods *and* still
 121         serve normally without excessive delays.
 122
 123 2006-10-25  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
 124
 125         * HttpUtil: Strings returned by get_cached now have a cached? method
 126         which returns true or false depending on whether the result was taken
 127         from the cache or not; this can be exploited by plugins that parse the
 128         result in some particular way, since they can now skip the parsing
 129         stage if they cache the parse result.
 130
 131 2006-10-24  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
 132
 133         * HttpUtil: initial implementation of proper caching based on
 134         last-modified and etag HTTP headers
 135
 136 2006-10-17  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
 137
 138         * Salut plugin: handles (multilingual) salutations (hello/goodbye)
 139
 140 2006-10-15  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
 141
 142         * Language stuff: plugins can now handle language changes in a natural
 143         fashion. lart is the first plugin to make use of this. NOTE: this
 144         is not (yet) backwards compatible: the old larts/praises files from
 145         previous rbot setups have to be renamed manually
 146         * Language stuff: italian translations
 147         * Utils.safe_save(filename): allows 'safe' saving of a file: it needs a
 148         block, to which it will yield a temporary file on which operations can
 149         be carried out. When the block returns, the tempfile will be renamed to
 150         the given filename
 151
 152 2006-09-21  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
 153
 154         * New Auth Framework: restore backwards compatibility: 'auth
 155         <masterpassword>' and 'login owner <masterpassword>' both work.
 156         * Topic plugin: cleanups. Implement 'topic undo'. 'topic undo' after a
 157         'topic undo' undoes the last undo.
 158
 159 2006-09-09  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
 160
 161         * New Auth Framework: rbot was opping anyone who asked for it (opme
 162         plugin). Fixed, and cleaned up.
 163
 164 2006-09-01  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
 165
 166         * New Auth Framework: document and fine tune permissions view the auth
 167         core botmodule.
 168         * Version: when run from a svn checkout, the bot now tries to report
 169         which svn revision it's at, and if there are local changes
 170
 171 2006-08-31  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
 172
 173         * Nickserv plugin: bot will now try to inform nickserv when password
 174         is changed. Moreover it's not necessary to specify the nick anymore if
 175         you want to change the password for the current bot nick. Also do some
 176         internal cleanups while we're at it.
 177
 178 2006-08-29  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
 179
 180         * Script plugin: new (UNSAFE!) echo functions. Just like eval, but
 181         m.replies the result of the evaluation.
 182         * New Auth Framework: config keys now have their own permissions. So
 183         you can allow people to view or edit only some of the config values.
 184         auth.password defaults to false. Still needs some work.
 185
 186 2006-08-26  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
 187
 188         * Plugin message mapper: new implementation. Multi-word parameters now
 189         need not be the last, and it is possible to retrieve the entire
 190         substring with preserved whitespace by using to_s. Also, parts of the
 191         map string can be bracketed to make them optional. Examples:
 192                 remind :user [about] *stuff
 193         will respond to
 194                 remind me about washing my teeth
 195         and also to
 196                 remind me washing my teeth
 197         It is possible to have parameters in brackets, in which case they will
 198         be optional too, and default to nil or [] (resp. single- and
 199         multi-word parameters) unless an alternative is provided in the
 200         :defaults hash for the message map options.
 201         * Script plugin: new (UNSAFE!) eval function. Not documented in help.
 202         Not permitted by default.
 203
 204 2006-08-25 Mark Kretschmann <markey@web.de>
 205
 206         * Added quiz plugin, a multiplayer trivia quiz game.
 207
 208 2006-08-20  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
 209
 210         * Topic plugin: fix a bug that prevented it from loading
 211         correctly.
 212         * New IRC Framework: make sure that NOTICEs and PRIVMSGs do not
 213         raise an exception when the target is in one of the special forms
 214         #<mask> or $<mask>. Needs some work, though, since this case should be
 215         handled specifically.
 216
 217 2006-08-17  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
 218
 219         * Fix help: It got broken while rearranging the plugin stuff, now it's
 220         properly fixed.
 221         * New Auth Framework: forgot to create the InvalidPassword exception.
 222         It's a RuntimeError now.
 223         * Fix help: this time for real (or so I hope).
 224         * New IRC Framework: topic plugin now works correctly.
 225         * New Auth Framework: nickserv plugin now defaults to false for its
 226         auth, so that only owner can do stuff with it
 227         * New Auth Framework: fix horrible typo, assignment instead of
 228         equality test when checking for the username during login.
 229         * Keywords plugin: tell and forget work again without 'keyword' before
 230         them.
 231
 232 2006-08-12  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
 233
 234         * Subregistry: force prefix to be a String with to_s
 235
 236 2006-08-11  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
 237
 238         * AutoOp plugin: adapted to the new IRC framework.
 239         * AutoOp plugin: trigger autoop on nick change too.
 240         * New Auth Framework: allow? method now informs a user when they don't
 241         have permission to do what they asked for.
 242         * New nickreply and nickokay methods: they act like the old reply
 243         method, but include the nick of the user the bot is replying to when
 244         talking in public. The usual reply method can be configured to act
 245         like this as default.
 246
 247 2006-08-10  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
 248
 249         * Fix a bug in new IRC Framework: the list of channels a quitting user was
 250         on was not built correctly, causing an exception when the user was not
 251         in the first channel in the list of channels.
 252         * Fix a bug in new Auth Framework: BotUser's name is changed via
 253         username=, not name=.
 254         * New HalfLife 2 plugin from ocr: queries online servers for online
 255         status and number of users.
 256
 257 2006-08-07  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
 258
 259         * Add kick method to kernel: plugins can now use
 260                 @bot.kick channel, user, reason
 261         to kick a user from a channel
 262         * RSS plugin: fix rewatch_rss method
 263         * RSS plugin: the different ways to represent channels before and
 264         after the New IRC Framework was causing strange problems such as
 265         watched feed not being listed as such, undeletable watches, double
 266         watches etc. Fix this by checking both for the Channel objects and
 267         their to_s form when checking for watches or deleting them.
 268
 269 2006-08-06  Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
 270
 271         * Updating the ChangeLog again: describe the new stuff in trunk which
 272         will be made available in the next release. Use Gnu style for new
 273         changelog entries (yyyy-mm-dd name <email address>\n<tab> ...):
 274         there's a macro for this since at least Vim 6.x and higher, called by
 275         <Leader>o (default leader: slash (\))
 276         * New IRC Framework: Server, Channels, User, Netmasks etc are all
 277         proper Ruby objects. The better organization will allow multi-server
 278         connections to be implemented more easily
 279         * Modularize core: split the internal functionality from what can be
 280         implemented as botmodules (which work just the same as plugins). Move
 281         Configuration, Basics and Auth out of the 'kernel' into core
 282         botmodules.
 283         * New Auth Framework: BotUsers are now Ruby objects with attached
 284         PermissionSets which define what the BotUser can do, by channel if
 285         necessary. The new framework allows very fine-grained control while
 286         still being very easy to manage for elementary usage. BotUser data can
 287         be exported and imported, but no backwards compatibility has been
 288         implemented yet. Most plugins still have to be updated to the new
 289         command-path-based mechanism.
 290
 291 Sun Aug 06 17:33:55 BST 2006  Tom Gilbert <tom@linuxbrit.co.uk>
 292
 293   * 0.9.10 released
 294         * Changes: Lots of new and updated plugins, including one to poll RSS feeds.
 295         A first step towards a better auth system (total revamp due in 0.9.11).
 296         Improvements to network and server code which should provide greater
 297         stability. A new message queueing mechanism with bitrate throttling. A new
 298         logging framework for debugging and tracing the activities of the bot. A
 299         new split-db registry system for better performance and transactional
 300         usage of bdb for resilience. More integration with Nickserv where
 301         available including optional automatic ghost-killing.
 302
 303 Wed Sep 07 20:16:46 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 304
 305   * Fixed quit, broke it last commit
 306         * Fixed trap() for win32
 307
 308 Sun Aug 21 13:29:55 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 309
 310   * fix for bug in quakenet plugin (trac #14)
 311         * multiple fixes for unescaped bot nick in regexp's (trac #13)
 312
 313 Fri Aug 12 20:51:38 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 314
 315   * fix up autoop plugin a bit
 316
 317 Thu Aug 11 00:13:11 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 318
 319   * Added two plugins from Robin Kearney <robin@riviera.org.uk>
 320         * Threat (US threat level :P)
 321         * bash (bash.org quotes)
 322
 323 Thu Aug 11 00:04:31 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 324
 325   * Patches from "Alexey I. Froloff" <raorn@altlinux.ru>
 326         * Do not use "/home/#{Etc.getlogin}/" for default home directory, use
 327         "#{Etc.getpwnam(Etc.getlogin).dir}/" instead.
 328         * Do not try to load same plugin from different locations.  Added ability
 329         to disable system-wide plugins - create PLUGIN.rb.disabled in user's
 330         plugins directory.
 331         * For example, to disable freshmeat plugin installed in /usr/share/rbot/plugins/freshmeat.rb one can create empty file ~/.rbot/plugins/freshmeat.rb.disabled
 332
 333 Mon Aug 08 23:08:01 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 334
 335   * new markov plugin for random inane chat
 336
 337 Sun Aug 07 18:20:24 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 338
 339   * stop insult plugin being used to insult the bot
 340
 341 Sun Aug 07 17:53:06 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 342
 343   * workaround for people without YAML::load_file
 344         * quit message for restart
 345
 346 Sun Aug 07 15:11:07 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 347
 348   * fix address_prefix, broken in 0.9.9, reported by ruskie.
 349
 350 Sat Aug 06 00:54:34 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 351
 352   * Released 0.9.9
 353
 354 Fri Aug 05 23:55:20 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 355
 356   * few more tweaks preparing to release 0.9.9
 357
 358 Thu Aug 04 23:03:30 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 359
 360   * Improved ircd recognition of rfc2812.rb
 361         * de-string'd, de-cap'd rfc2812.rb, looks less shouty now
 362         * moved the Q auth stuff (for quakenet) into a new qauth plugin (untested!)
 363         * finish fixing the httputil
 364
 365 Thu Aug 04 00:11:52 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 366
 367   * Tweaked the debug() stuff a bit. Need to do this more cleanly really
 368         * Added a fair bit of documentation for some of the new features
 369
 370 Wed Aug 03 15:25:07 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 371
 372   * Added french language file (TODO most of the plugins just talk english)
 373         * The way the Enum configs were set up, it wasn't possible to add language
 374         files to rbot at runtime (the directory was only scanned at startup). Now
 375         you can set a values Proc, which is called to return a list of allowed
 376         values whenever it's queried.
 377         * Added Config module for determining where we were installed.
 378         Unfortunately rubygems is a total whore in this regard, and I hope the
 379         current hackery I have to do to support it becomes redundant in the
 380         future.
 381
 382 Wed Aug 03 00:31:41 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 383
 384   * Added Rakefile, tweaked gemspec
 385
 386 Tue Aug 02 16:27:36 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 387
 388   * Fixed the new http.proxy* settings, they work!
 389         * Fixed a bug with auth-checking for the config module
 390         * misc tweaks
 391
 392 Sun Jul 31 02:20:08 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 393
 394   * Updated docgen to generate rdoc again with the new repo structure
 395         * added new restart command to the core bot, quits irc and reexecs the
 396         bot, to pick up new code/libraries etc.
 397
 398 Sat Jul 30 22:33:36 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 399
 400   * Config items are now objects, various types are available.
 401         * The config wizard will now use registered config items if :wizard is set
 402     to true for those items. It will ask questions in the order they were
 403                 registered.
 404         * The config module now works for doing runtime configuration.
 405         * misc refactoring
 406
 407 Sat Jul 30 01:19:32 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 408
 409   * config module for configuring the running bot via IRC
 410         * BotConfig.register method for various modules and any plugin to register
 411         bot configuration which the new config module will expose for them.
 412         * various other tweaks as I continue to refactor..
 413
 414 Fri Jul 29 13:07:56 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 415
 416   * Moved some stuff out of util.rb into the plugins that actually need
 417         them. Those methods didn't belong in util as they were plugin-specific.
 418         * moved a few more plugins to use map() where appropriate
 419         * made the url plugin only store unique urls
 420
 421 Thu Jul 28 23:45:26 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 422
 423   * Reworked the Timer module. The Timer now has a smart thread manager to
 424         start/stop the tick() thread. This means the timer isn't called every 0.1
 425         seconds to see what needs doing, which is much more efficient
 426   * reworked the ircsocket queue mechanism to use a Timer
 427         * reworked the nickserv plugin to use maps
 428         * made server.reconnect_wait configurable
 429         * added Class tracing mechanism to bin/rbot, use --trace Classname for
 430         debugging
 431
 432 Tue Jul 26 14:41:34 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 433
 434   * Prevent multiple plugin registrations of the same name
 435         * reworking the config system to use yaml for persistence
 436         * reworking the config system key names
 437         * on first startup, the bot will prompt for the essential startup config
 438         * new config module for configuring the bot at runtime
 439         * new config module includes new configurables, for example changing the
 440         bot's language at runtime.
 441         * various other fixes
 442         * New way of mapping plugins to strings, using maps. These may be
 443         familiar to rails users. This is to reduce the amount of regexps plugins
 444         currently need to do to parse arguments. The old method (privmsg) is still
 445         supported, of course. Example plugin now:
 446           def MyPlugin < Plugin
 447                   def foo(m, params)
 448                           m.reply "bar"
 449                         end
 450
 451                         def complexfoo(m, params)
 452                           m.reply "qux! (#{params[:bar]} #{params[:baz]})"
 453                         end
 454                 end
 455                 plugin = MyPlugin.new
 456                 # simple map
 457                 plugin.map 'foo'
 458
 459     # this will match "rbot: foo somestring otherstring" and pass the
 460                 # parameters as a hash using the names in the map.
 461                 plugin.map 'foo :bar :baz', :action => 'complexfoo'
 462                 # this means :foo is an optional parameter
 463                 plugin.map 'foo :foo', :defaults => {:foo => 'bar'}
 464     # you can also gobble up into an array
 465                 plugin.map 'foo *bar' # params[:bar] will be an array of string elements
 466     # and you can validate, here the first param must be a number
 467                 plugin.map 'foo :bar', :requirements => {:foo => /^\d+$/}
 468
 469
 470 Sat Jul 23 01:39:08 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 471
 472   * Changed BotConfig to use yaml storage, method syntax instead of hash for
 473         get/set, to allow more flexibility and encapsulation
 474         * Added convenience method Message.okay (m.okay is the same as the
 475         old-style @bot.okay m.replyto)
 476
 477 Wed Jul 20 23:30:01 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 478
 479   * Move some core plugins to use the new httputil
 480         * fix wserver's redirection handling for relative (i.e. broken) redirects
 481         * fix tube plugin's html parsing
 482
 483 Wed Jul 20 01:18:06 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 484
 485         * Add new httputil object to the bot object, to be used by plugins etc
 486         that wish to make http requests. It sets up all the proxies etc for them
 487         according to bot config.
 488
 489 Sat Jul 16 02:23:13 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
 490
 491   * Apply most of Rene's patch and fix various plugins.
 492         * New plugin: autoop (auto ops via hostmask)
 493         * New feature: karmastats
 494
 495 Wed Oct 13 16:16:31 BST 2004  Tom Gilbert <tom@linuxbrit.co.uk>
 496
 497   * Fix bug with quotes plugin where it gets confused and sees both a quote
 498   and a keyword, both plugins are triggered by, for example "addquote foo is
 499   bar"
 500   * fixed this by implementing the "has_responded" flag on a message. When a
 501   plugin replied to a message (or it manually sets m.replied to true), the
 502   keywords plugin will honour that flag and not examine the message for
 503   keywords. This flag can also be checked by listen plugins that don't want to
 504   interfere with other plugin commands.
 505
 506 Mon Oct 11 00:37:52 BST 2004  Tom Gilbert <tom@linuxbrit.co.uk>
 507
 508   * Fixes to the NickServ plugin
 509
 510 Sat Oct 09 23:23:24 BST 2004  Tom Gilbert <tom@linuxbrit.co.uk>
 511
 512   * Keyword searching
 513
 514 Fri Oct 08 00:40:07 BST 2004  Tom Gilbert <tom@linuxbrit.co.uk>
 515
 516   * fixed insult plugin
 517   * fixed excuse plugin
 518
 519 Thu Oct 07 23:28:05 BST 2004  Tom Gilbert <tom@linuxbrit.co.uk>
 520
 521   * searching for urls in the url plugin
 522   * roshambo (rock/paper/scissors) plugin from Hans Fugal <hans@fugal.net>
 523
 524 Sat Apr 17 20:56:50 BST 2004  Tom Gilbert <tom@linuxbrit.co.uk>
 525
 526   * Oh, found new tv plugin in my inbox from ages ago, but it's still not
 527   working so I guess it changed again since then
 528   * New eightball plugin from Daniel Free
 529
 530 Sat Apr 17 20:44:43 BST 2004  Tom Gilbert <tom@linuxbrit.co.uk>
 531
 532   * Fixed the babelfish parser so translate works again.
 533   * Misc other fixes
 534   * Note some plugins are broken (excuse,insult) because the server they use
 535     went away. I don't know of a replacement right now.
 536   * tv plugin seems broken, perhaps the html changed.
 537
 538 Thu Jan 15 21:37:38 GMT 2004  Tom Gilbert <tom@linuxbrit.co.uk>
 539
 540   * Fixes for ruby 1.8
 541
 542 0.9.8
 543 * new plugin from Alan Third <alan@idiocy.org>, allows you to search and list
 544   UK TV programmes.
 545
 546 0.9.7
 547 * various plugin updates
 548 * fix (again) for C to F temp conversion in weather plugin
 549 * channel topic patch from Peter Suschlik, gives plugin better access to topic
 550   changes and related information
 551
 552 0.9.6
 553 * changes to layout of slashdot plugin output
 554 * freshmeat plugin, show latest updates or search
 555 * fix to C to F temp conversion in weather plugin
 556 * status command returns some bot status
 557 * fortune plugin
 558 * using BDB::Btree everywhere now, instead of BDB::Hash, because the Btree api
 559   allows me to set my own key comparison function. This is needed to keep
 560   supporting case insensitivity (vital for IRC), which was sadly broken in
 561   0.9.5 :( All existing dbs will be upgraded automatically.
 562 * roulette plugin - play russian roulette :) also keeps game stats.
 563 * new config option, NO_KEYWORD_ADDRESS. If set to "true", the bot will always
 564   respond to keywords it knows even when not addressed and the message doesn't
 565   start with '. Message must end with "?" however.
 566 * hopefully fixed welcome message parsing from certain server types
 567
 568 0.9.5
 569 * plugin object registry
 570   This provides persistant storage for plugins via a hash interface. The
 571   default mode is an object store, so you can store ruby objects and reference
 572   them with hash keys. This is because the default store/restore methods of
 573   the plugins' RegistryAccessor are calls to Marshal.dump and Marshal.restore,
 574   for example:
 575     blah = Hash.new
 576     blah[:foo] = "fum"
 577     @registry[:blah] = blah
 578   then, even after the bot is shut down and disconnected, on the next run you
 579   can access the blah object as it was, with:
 580     blah = @registry[:blah]
 581   The registry can of course be used to store simple strings, fixnums, etc as
 582   well, and should be useful to store or cache plugin data or dynamic plugin
 583   configuration.
 584
 585   If you don't need to store objects, and strictly want a persistant hash of
 586   strings, you can override the store/restore methods to suit your needs, for
 587   example (in your plugin):
 588     def initialize
 589       class << @registry
 590         def store(val)
 591           val
 592         end
 593         def restore(val)
 594           val
 595         end
 596       end
 597     end
 598   Your plugins section of the registry is private, it has its own namespace
 599   (derived from the plugin's class name, so change it and lose your data).
 600   Calls to registry.each etc, will only iterate over your namespace.
 601
 602   The nickserv and karma plugins use the new registry and should serve as a
 603   useful example. Basic usage of the registry is simple, just treat it as a
 604   hash, with values that never die (unless you delete() them).
 605 * Change to the nickserv plugin. The old method of putting the nickserv
 606   password in rbot.conf was useless for multiple nicks or easy updates. The
 607   plugin now uses the plugin registry to store passwords for any nicks it
 608   owns. The plugin can be told to register the current nick (supply a password
 609   or it'll generate one), identify for the current nick (if the password is
 610   known), and can be told the passwords for other nicks. If NickServ asks the
 611   bot to identify, it will automatically do so if it knows the appropriate
 612   password.
 613 * karma plugin now uses the plugin registry, it should automatically import
 614   your existing, stored karma data into the registry.
 615 * The babelfish plugin now caches results in the bot registry to speed up
 616   common lookups.
 617 * New message types and plugin methods to grab them,
 618   quit(QuitMessage):   Called when a user (or the bot) quits IRC
 619   nick(NickMessage):   Called when a user (or the bot) changes Nick
 620   topic(TopicMessage): Called when a user (or the bot) changes a channel topic
 621 * A plugin's listen() method will now receive any kind of Message, e.g.
 622   PrivMessage, NoticeMessage, NickMessage, JoinMessage, etc
 623 * New plugins:
 624   seen: the usual "seen" stuff:
 625         rbot: seen giblet?
 626         giblet was last seen xxx ago doing xxx
 627   cal:  calls the unix cal program to display a calendar
 628   math: evaluates mathematical expressions:
 629         rbot: math 2+2
 630         rbot: math 4 to the power of 8
 631         rbot: math ((232+432) - 4) / 2
 632         (ported from infobot. Thanks to Kevin Lenzo, who wrote the
 633         original infobot math module)
 634   slashdot: displays latest headlines or searches for articles
 635   url:  stores urls mentioned in channels for regurgitation later
 636   weather: grabs and parses METAR weather data, will remember the last weather
 637            code you asked for so you don't have to :)
 638 * New utility function, Util.http_get(url) for getting remote data via http,
 639   just dumps response.body into a string and returns it, or nil if anything at
 640   all goes wrong. Useful for simple plugins.
 641 * random quit messages if none specified, messages set in language description
 642   file
 643 * keywords are now stored in bdb databases - your old keywords.rbot will be
 644   imported. Static keywords (fact packs) are also stored in bdb databases, and
 645   rbot will automatically convert any text .fact file dropped in the confdir's
 646   keywords subdirectory, at startup, into a bdb file. If both a db and a text
 647   file exist of the same name (except the extension), the text file will be
 648   imported and merged into the database.
 649   static keywords will be looked up in each factpack db in turn, in
 650   alphabetical filename order - so you can prioritise using the filename if
 651   you wish.
 652 * fixed a bug with autsplitting long sent lines, the last line was often being
 653   split unnecessarily.
 654
 655 0.9.4
 656 * Massive cleanup of rfc2812.rb, contributed by Lars Christensen
 657   <dsl8950@vip.cybercity.dk>, gets rid of a lot of regexps
 658 * Fixed bug reading static keyword files - "foo <=is=> bar" may not have
 659   worked for a couple of releases, only "foo<=is=>bar" was working - this was
 660   not intended and should be fixed now
 661 * Experimental send queue, to prevent the bot from flooding out, the delay
 662   between sending messages to the server defaults to 2s, but is configurable
 663   in conf.rbot, set SENDQ_DELAY (0 to disable queueing). You can also set/get
 664   the value from the bot, "rbot: options get sendq_delay", and
 665   "rbot: options set sendq_delay 1.5", if you have sufficient auth for "config"
 666   This is a bursting sendq, most ircd's allow bursts of up to 5
 667   lines, with non-burst limits of 512 bytes/2 seconds. To set the burst limit,
 668   configure SENDQ_BURST in conf.rbot, or do the same kind of stuff with
 669   "rbot: options set sendq_burst 2", etc.
 670   The defaults are 2s/4 burst, which seem to work okay for me.
 671 * support for multiple, customisable, addressing prefixes. Set ADDRESS_PREFIX
 672   in conf.rbot to a space separate list of addressing prefixes, e.g
 673   ADDRESS_PREFIX = | ! =>
 674   Would mean that all of the following in channel messages would cause the bot
 675   to respond:
 676               rbot: version
 677               |version
 678               !version
 679               =>version
 680 * bb plugin removed, bb is nearly over and it doesn't work 100% anyway
 681 * Two plugins from brailsmt (from #ruby-lang on openprojects), a stats plugin
 682   which monitors usage of 1-word sentences, and lart, which allows you to ask
 683   rbot to lart people - with an optional reason - larts are user-definable and
 684   can be added on the fly.
 685 * made google.rb work for people with 1.6 ruby's net/http
 686
 687 0.9.3
 688
 689 * fix quit messages
 690 * new plugin for handling nickserv-protected nicks, use NICKSERV_PASSWORD in
 691   the config file.
 692 * fixes to a few other buglets
 693 * new plugin to grab bigbrother headlines, still buggy and only useful for UK
 694   folks who love bb :-)
 695 * fixes to various plugins
 696 * Patch from akira yamada <akira@ruby-lang.org>
 697   DNS plugin: Use resolv-replace if found, do lookup in new thread
 698   Fix bug joining channels with keys
 699
 700 0.9.2
 701
 702 * better "connect failure" error message
 703 * better option parsing, and --debug option
 704 * access to bot's online help via commandline, eg:
 705   ./rbot.rb --help
 706   ./rbot.rb --help core
 707   ./rbot.rb --help "core save"
 708 * Fix broken help from last point release
 709 * Plugin API modification and cleanup. You no longer need to set @listen to
 710   true in order to get all NOTICE and PRIVMSGs, you just need to define the
 711   method. The method is now called listen(), renamed from listener(). This
 712   should be the last time the plugin api is changed incompatibly.
 713 * New plugin method kick(). Use it to see kicks (duh :))
 714 * New plugin methods join(), part(). Obvious uses.
 715 * Example plugin autorejoin.rb, uses kick event to rejoin channel and insult
 716   kicker
 717 * fix bug in remind plugins "remind me no more" recognition.
 718
 719 0.9.1
 720
 721 * Fix welcome message recognition for certain IRCd's.
 722
 723 0.9
 724
 725 * Allow keyword definitions which end in '?', like this:
 726   bot: foo is bar\?
 727 * rdoc documentation!
 728 * fixed broken address regexp, "rbot: .foo" was being treated as an addressed
 729   form of "foo" (lost the .)
 730 * fix stupid bug in last release (looking for wrong default conf dir)
 731
 732 0.8
 733
 734 * Tarball layout change. modules all in rbot/ now, and the rbot/ default
 735   configuration moved to rbotconf/. This lets the thing run from an unpacked
 736   tarball while also being ready to run with the modules installed somewhere
 737   else.
 738 * change hashbang to /usr/bin/env ruby, in order to use PATH looking for ruby,
 739   it's BSD friendly!
 740 * allow "botnick : foo" style addressing, and even "botnick... foo"
 741 * slap plugin (contributed by oct)
 742 * renamed bot.send to bot.sendmsg, I didn't really want to override send() ;D
 743   (thanks Kero)
 744
 745 0.7.1
 746 * Made sane for packagers. Looks in the right places for plugins and language
 747   files now, so extra effort shouldn't be needed there.
 748
 749 0.7
 750
 751 * Fixed "nick taken on join" bug
 752 * Dice plugin patch from David Dorward
 753 * fix searchquote regexp
 754 * conf.rbot: PASSWORD -> SERVER_PASSWORD, to prevent confusion with PASSWD,
 755   which is for master auth.
 756
 757 0.6
 758
 759 * Fixed addquote (was incrementing quote ID twice)
 760 * now strips colour/bold escapes from incoming messages (rbot was ignoring
 761   messages addressed using a bolded colon, for example).
 762 * minor bugfixes
 763 * more language breadth
 764 * Addressing works better now
 765 * Can autojoin channels with keys, conf.rbot line is:
 766   autojoin_channels #chan1, #chan2, #chan3 key, #chan4 key, #chan5
 767 * dice plugin fixes
 768
 769 0.5
 770
 771 * Initial release