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