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