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