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