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