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