ChangeLog

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