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