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