1 Thu Aug 04 23:03:30 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
3 * Improved ircd recognition of rfc2812.rb
4 * de-string'd, de-cap'd rfc2812.rb, looks less shouty now
5 * moved the Q auth stuff (for quakenet) into a new qauth plugin (untested!)
6 * finish fixing the httputil
8 Thu Aug 04 00:11:52 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
10 * Tweaked the debug() stuff a bit. Need to do this more cleanly really
11 * Added a fair bit of documentation for some of the new features
13 Wed Aug 03 15:25:07 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
15 * Added french language file (TODO most of the plugins just talk english)
16 * The way the Enum configs were set up, it wasn't possible to add language
17 files to rbot at runtime (the directory was only scanned at startup). Now
18 you can set a values Proc, which is called to return a list of allowed
19 values whenever it's queried.
20 * Added Config module for determining where we were installed.
21 Unfortunately rubygems is a total whore in this regard, and I hope the
22 current hackery I have to do to support it becomes redundant in the
25 Wed Aug 03 00:31:41 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
27 * Added Rakefile, tweaked gemspec
29 Tue Aug 02 16:27:36 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
31 * Fixed the new http.proxy* settings, they work!
32 * Fixed a bug with auth-checking for the config module
35 Sun Jul 31 02:20:08 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
37 * Updated docgen to generate rdoc again with the new repo structure
38 * added new restart command to the core bot, quits irc and reexecs the
39 bot, to pick up new code/libraries etc.
41 Sat Jul 30 22:33:36 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
43 * Config items are now objects, various types are available.
44 * The config wizard will now use registered config items if :wizard is set
45 to true for those items. It will ask questions in the order they were
47 * The config module now works for doing runtime configuration.
50 Sat Jul 30 01:19:32 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
52 * config module for configuring the running bot via IRC
53 * BotConfig.register method for various modules and any plugin to register
54 bot configuration which the new config module will expose for them.
55 * various other tweaks as I continue to refactor..
57 Fri Jul 29 13:07:56 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
59 * Moved some stuff out of util.rb into the plugins that actually need
60 them. Those methods didn't belong in util as they were plugin-specific.
61 * moved a few more plugins to use map() where appropriate
62 * made the url plugin only store unique urls
64 Thu Jul 28 23:45:26 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
66 * Reworked the Timer module. The Timer now has a smart thread manager to
67 start/stop the tick() thread. This means the timer isn't called every 0.1
68 seconds to see what needs doing, which is much more efficient
69 * reworked the ircsocket queue mechanism to use a Timer
70 * reworked the nickserv plugin to use maps
71 * made server.reconnect_wait configurable
72 * added Class tracing mechanism to bin/rbot, use --trace Classname for
75 Tue Jul 26 14:41:34 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
77 * Prevent multiple plugin registrations of the same name
78 * reworking the config system to use yaml for persistence
79 * reworking the config system key names
80 * on first startup, the bot will prompt for the essential startup config
81 * new config module for configuring the bot at runtime
82 * new config module includes new configurables, for example changing the
83 bot's language at runtime.
85 * New way of mapping plugins to strings, using maps. These may be
86 familiar to rails users. This is to reduce the amount of regexps plugins
87 currently need to do to parse arguments. The old method (privmsg) is still
88 supported, of course. Example plugin now:
94 def complexfoo(m, params)
95 m.reply "qux! (#{params[:bar]} #{params[:baz]})"
102 # this will match "rbot: foo somestring otherstring" and pass the
103 # parameters as a hash using the names in the map.
104 plugin.map 'foo :bar :baz', :action => 'complexfoo'
105 # this means :foo is an optional parameter
106 plugin.map 'foo :foo', :defaults => {:foo => 'bar'}
107 # you can also gobble up into an array
108 plugin.map 'foo *bar' # params[:bar] will be an array of string elements
109 # and you can validate, here the first param must be a number
110 plugin.map 'foo :bar', :requirements => {:foo => /^\d+$/}
113 Sat Jul 23 01:39:08 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
115 * Changed BotConfig to use yaml storage, method syntax instead of hash for
116 get/set, to allow more flexibility and encapsulation
117 * Added convenience method Message.okay (m.okay is the same as the
118 old-style @bot.okay m.replyto)
120 Wed Jul 20 23:30:01 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
122 * Move some core plugins to use the new httputil
123 * fix wserver's redirection handling for relative (i.e. broken) redirects
124 * fix tube plugin's html parsing
126 Wed Jul 20 01:18:06 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
128 * Add new httputil object to the bot object, to be used by plugins etc
129 that wish to make http requests. It sets up all the proxies etc for them
130 according to bot config.
132 Sat Jul 16 02:23:13 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
134 * Apply most of Rene's patch and fix various plugins.
135 * New plugin: autoop (auto ops via hostmask)
136 * New feature: karmastats
138 Wed Oct 13 16:16:31 BST 2004 Tom Gilbert <tom@linuxbrit.co.uk>
140 * Fix bug with quotes plugin where it gets confused and sees both a quote
141 and a keyword, both plugins are triggered by, for example "addquote foo is
143 * fixed this by implementing the "has_responded" flag on a message. When a
144 plugin replied to a message (or it manually sets m.replied to true), the
145 keywords plugin will honour that flag and not examine the message for
146 keywords. This flag can also be checked by listen plugins that don't want to
147 interfere with other plugin commands.
149 Mon Oct 11 00:37:52 BST 2004 Tom Gilbert <tom@linuxbrit.co.uk>
151 * Fixes to the NickServ plugin
153 Sat Oct 09 23:23:24 BST 2004 Tom Gilbert <tom@linuxbrit.co.uk>
157 Fri Oct 08 00:40:07 BST 2004 Tom Gilbert <tom@linuxbrit.co.uk>
159 * fixed insult plugin
160 * fixed excuse plugin
162 Thu Oct 07 23:28:05 BST 2004 Tom Gilbert <tom@linuxbrit.co.uk>
164 * searching for urls in the url plugin
165 * roshambo (rock/paper/scissors) plugin from Hans Fugal <hans@fugal.net>
167 Sat Apr 17 20:56:50 BST 2004 Tom Gilbert <tom@linuxbrit.co.uk>
169 * Oh, found new tv plugin in my inbox from ages ago, but it's still not
170 working so I guess it changed again since then
171 * New eightball plugin from Daniel Free
173 Sat Apr 17 20:44:43 BST 2004 Tom Gilbert <tom@linuxbrit.co.uk>
175 * Fixed the babelfish parser so translate works again.
177 * Note some plugins are broken (excuse,insult) because the server they use
178 went away. I don't know of a replacement right now.
179 * tv plugin seems broken, perhaps the html changed.
181 Thu Jan 15 21:37:38 GMT 2004 Tom Gilbert <tom@linuxbrit.co.uk>
186 * new plugin from Alan Third <alan@idiocy.org>, allows you to search and list
190 * various plugin updates
191 * fix (again) for C to F temp conversion in weather plugin
192 * channel topic patch from Peter Suschlik, gives plugin better access to topic
193 changes and related information
196 * changes to layout of slashdot plugin output
197 * freshmeat plugin, show latest updates or search
198 * fix to C to F temp conversion in weather plugin
199 * status command returns some bot status
201 * using BDB::Btree everywhere now, instead of BDB::Hash, because the Btree api
202 allows me to set my own key comparison function. This is needed to keep
203 supporting case insensitivity (vital for IRC), which was sadly broken in
204 0.9.5 :( All existing dbs will be upgraded automatically.
205 * roulette plugin - play russian roulette :) also keeps game stats.
206 * new config option, NO_KEYWORD_ADDRESS. If set to "true", the bot will always
207 respond to keywords it knows even when not addressed and the message doesn't
208 start with '. Message must end with "?" however.
209 * hopefully fixed welcome message parsing from certain server types
212 * plugin object registry
213 This provides persistant storage for plugins via a hash interface. The
214 default mode is an object store, so you can store ruby objects and reference
215 them with hash keys. This is because the default store/restore methods of
216 the plugins' RegistryAccessor are calls to Marshal.dump and Marshal.restore,
220 @registry[:blah] = blah
221 then, even after the bot is shut down and disconnected, on the next run you
222 can access the blah object as it was, with:
223 blah = @registry[:blah]
224 The registry can of course be used to store simple strings, fixnums, etc as
225 well, and should be useful to store or cache plugin data or dynamic plugin
228 If you don't need to store objects, and strictly want a persistant hash of
229 strings, you can override the store/restore methods to suit your needs, for
230 example (in your plugin):
241 Your plugins section of the registry is private, it has its own namespace
242 (derived from the plugin's class name, so change it and lose your data).
243 Calls to registry.each etc, will only iterate over your namespace.
245 The nickserv and karma plugins use the new registry and should serve as a
246 useful example. Basic usage of the registry is simple, just treat it as a
247 hash, with values that never die (unless you delete() them).
248 * Change to the nickserv plugin. The old method of putting the nickserv
249 password in rbot.conf was useless for multiple nicks or easy updates. The
250 plugin now uses the plugin registry to store passwords for any nicks it
251 owns. The plugin can be told to register the current nick (supply a password
252 or it'll generate one), identify for the current nick (if the password is
253 known), and can be told the passwords for other nicks. If NickServ asks the
254 bot to identify, it will automatically do so if it knows the appropriate
256 * karma plugin now uses the plugin registry, it should automatically import
257 your existing, stored karma data into the registry.
258 * The babelfish plugin now caches results in the bot registry to speed up
260 * New message types and plugin methods to grab them,
261 quit(QuitMessage): Called when a user (or the bot) quits IRC
262 nick(NickMessage): Called when a user (or the bot) changes Nick
263 topic(TopicMessage): Called when a user (or the bot) changes a channel topic
264 * A plugin's listen() method will now receive any kind of Message, e.g.
265 PrivMessage, NoticeMessage, NickMessage, JoinMessage, etc
267 seen: the usual "seen" stuff:
269 giblet was last seen xxx ago doing xxx
270 cal: calls the unix cal program to display a calendar
271 math: evaluates mathematical expressions:
273 rbot: math 4 to the power of 8
274 rbot: math ((232+432) - 4) / 2
275 (ported from infobot. Thanks to Kevin Lenzo, who wrote the
276 original infobot math module)
277 slashdot: displays latest headlines or searches for articles
278 url: stores urls mentioned in channels for regurgitation later
279 weather: grabs and parses METAR weather data, will remember the last weather
280 code you asked for so you don't have to :)
281 * New utility function, Util.http_get(url) for getting remote data via http,
282 just dumps response.body into a string and returns it, or nil if anything at
283 all goes wrong. Useful for simple plugins.
284 * random quit messages if none specified, messages set in language description
286 * keywords are now stored in bdb databases - your old keywords.rbot will be
287 imported. Static keywords (fact packs) are also stored in bdb databases, and
288 rbot will automatically convert any text .fact file dropped in the confdir's
289 keywords subdirectory, at startup, into a bdb file. If both a db and a text
290 file exist of the same name (except the extension), the text file will be
291 imported and merged into the database.
292 static keywords will be looked up in each factpack db in turn, in
293 alphabetical filename order - so you can prioritise using the filename if
295 * fixed a bug with autsplitting long sent lines, the last line was often being
299 * Massive cleanup of rfc2812.rb, contributed by Lars Christensen
300 <dsl8950@vip.cybercity.dk>, gets rid of a lot of regexps
301 * Fixed bug reading static keyword files - "foo <=is=> bar" may not have
302 worked for a couple of releases, only "foo<=is=>bar" was working - this was
303 not intended and should be fixed now
304 * Experimental send queue, to prevent the bot from flooding out, the delay
305 between sending messages to the server defaults to 2s, but is configurable
306 in conf.rbot, set SENDQ_DELAY (0 to disable queueing). You can also set/get
307 the value from the bot, "rbot: options get sendq_delay", and
308 "rbot: options set sendq_delay 1.5", if you have sufficient auth for "config"
309 This is a bursting sendq, most ircd's allow bursts of up to 5
310 lines, with non-burst limits of 512 bytes/2 seconds. To set the burst limit,
311 configure SENDQ_BURST in conf.rbot, or do the same kind of stuff with
312 "rbot: options set sendq_burst 2", etc.
313 The defaults are 2s/4 burst, which seem to work okay for me.
314 * support for multiple, customisable, addressing prefixes. Set ADDRESS_PREFIX
315 in conf.rbot to a space separate list of addressing prefixes, e.g
316 ADDRESS_PREFIX = | ! =>
317 Would mean that all of the following in channel messages would cause the bot
323 * bb plugin removed, bb is nearly over and it doesn't work 100% anyway
324 * Two plugins from brailsmt (from #ruby-lang on openprojects), a stats plugin
325 which monitors usage of 1-word sentences, and lart, which allows you to ask
326 rbot to lart people - with an optional reason - larts are user-definable and
327 can be added on the fly.
328 * made google.rb work for people with 1.6 ruby's net/http
333 * new plugin for handling nickserv-protected nicks, use NICKSERV_PASSWORD in
335 * fixes to a few other buglets
336 * new plugin to grab bigbrother headlines, still buggy and only useful for UK
337 folks who love bb :-)
338 * fixes to various plugins
339 * Patch from akira yamada <akira@ruby-lang.org>
340 DNS plugin: Use resolv-replace if found, do lookup in new thread
341 Fix bug joining channels with keys
345 * better "connect failure" error message
346 * better option parsing, and --debug option
347 * access to bot's online help via commandline, eg:
349 ./rbot.rb --help core
350 ./rbot.rb --help "core save"
351 * Fix broken help from last point release
352 * Plugin API modification and cleanup. You no longer need to set @listen to
353 true in order to get all NOTICE and PRIVMSGs, you just need to define the
354 method. The method is now called listen(), renamed from listener(). This
355 should be the last time the plugin api is changed incompatibly.
356 * New plugin method kick(). Use it to see kicks (duh :))
357 * New plugin methods join(), part(). Obvious uses.
358 * Example plugin autorejoin.rb, uses kick event to rejoin channel and insult
360 * fix bug in remind plugins "remind me no more" recognition.
364 * Fix welcome message recognition for certain IRCd's.
368 * Allow keyword definitions which end in '?', like this:
370 * rdoc documentation!
371 * fixed broken address regexp, "rbot: .foo" was being treated as an addressed
372 form of "foo" (lost the .)
373 * fix stupid bug in last release (looking for wrong default conf dir)
377 * Tarball layout change. modules all in rbot/ now, and the rbot/ default
378 configuration moved to rbotconf/. This lets the thing run from an unpacked
379 tarball while also being ready to run with the modules installed somewhere
381 * change hashbang to /usr/bin/env ruby, in order to use PATH looking for ruby,
383 * allow "botnick : foo" style addressing, and even "botnick... foo"
384 * slap plugin (contributed by oct)
385 * renamed bot.send to bot.sendmsg, I didn't really want to override send() ;D
389 * Made sane for packagers. Looks in the right places for plugins and language
390 files now, so extra effort shouldn't be needed there.
394 * Fixed "nick taken on join" bug
395 * Dice plugin patch from David Dorward
396 * fix searchquote regexp
397 * conf.rbot: PASSWORD -> SERVER_PASSWORD, to prevent confusion with PASSWD,
398 which is for master auth.
402 * Fixed addquote (was incrementing quote ID twice)
403 * now strips colour/bold escapes from incoming messages (rbot was ignoring
404 messages addressed using a bolded colon, for example).
406 * more language breadth
407 * Addressing works better now
408 * Can autojoin channels with keys, conf.rbot line is:
409 autojoin_channels #chan1, #chan2, #chan3 key, #chan4 key, #chan5