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