ChangeLog

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