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