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