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