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