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