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