1 2006-08-11 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
3 * AutoOp plugin: adapted to the new IRC framework.
4 * AutoOp plugin: trigger autoop on nick change too.
5 * New Auth Framework: allow? method now informs a user when they don't
6 have permission to do what they asked for.
7 * New nickreply and nickokay methods: they act like the old reply
8 method, but include the nick of the user the bot is replying to when
9 talking in public. The usual reply method can be configured to act
12 2006-08-10 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
14 * Fix a bug in new IRC Framework: the list of channels a quitting user was
15 on was not built correctly, causing an exception when the user was not
16 in the first channel in the list of channels.
17 * Fix a bug in new Auth Framework: BotUser's name is changed via
19 * New HalfLife 2 plugin from ocr: queries online servers for online
20 status and number of users.
22 2006-08-07 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
24 * Add kick method to kernel: plugins can now use
25 @bot.kick channel, user, reason
26 to kick a user from a channel
27 * RSS plugin: fix rewatch_rss method
28 * RSS plugin: the different ways to represent channels before and
29 after the New IRC Framework was causing strange problems such as
30 watched feed not being listed as such, undeletable watches, double
31 watches etc. Fix this by checking both for the Channel objects and
32 their to_s form when checking for watches or deleting them.
34 2006-08-06 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
36 * Updating the ChangeLog again: describe the new stuff in trunk which
37 will be made available in the next release. Use Gnu style for new
38 changelog entries (yyyy-mm-dd name <email address>\n<tab> ...):
39 there's a macro for this since at least Vim 6.x and higher, called by
40 <Leader>o (default leader: slash (\))
41 * New IRC Framework: Server, Channels, User, Netmasks etc are all
42 proper Ruby objects. The better organization will allow multi-server
43 connections to be implemented more easily
44 * Modularize core: split the internal functionality from what can be
45 implemented as botmodules (which work just the same as plugins). Move
46 Configuration, Basics and Auth out of the 'kernel' into core
48 * New Auth Framework: BotUsers are now Ruby objects with attached
49 PermissionSets which define what the BotUser can do, by channel if
50 necessary. The new framework allows very fine-grained control while
51 still being very easy to manage for elementary usage. BotUser data can
52 be exported and imported, but no backwards compatibility has been
53 implemented yet. Most plugins still have to be updated to the new
54 command-path-based mechanism.
56 Sun Aug 06 17:33:55 BST 2006 Tom Gilbert <tom@linuxbrit.co.uk>
59 * Changes: Lots of new and updated plugins, including one to poll RSS feeds.
60 A first step towards a better auth system (total revamp due in 0.9.11).
61 Improvements to network and server code which should provide greater
62 stability. A new message queueing mechanism with bitrate throttling. A new
63 logging framework for debugging and tracing the activities of the bot. A
64 new split-db registry system for better performance and transactional
65 usage of bdb for resilience. More integration with Nickserv where
66 available including optional automatic ghost-killing.
68 Wed Sep 07 20:16:46 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
70 * Fixed quit, broke it last commit
71 * Fixed trap() for win32
73 Sun Aug 21 13:29:55 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
75 * fix for bug in quakenet plugin (trac #14)
76 * multiple fixes for unescaped bot nick in regexp's (trac #13)
78 Fri Aug 12 20:51:38 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
80 * fix up autoop plugin a bit
82 Thu Aug 11 00:13:11 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
84 * Added two plugins from Robin Kearney <robin@riviera.org.uk>
85 * Threat (US threat level :P)
86 * bash (bash.org quotes)
88 Thu Aug 11 00:04:31 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
90 * Patches from "Alexey I. Froloff" <raorn@altlinux.ru>
91 * Do not use "/home/#{Etc.getlogin}/" for default home directory, use
92 "#{Etc.getpwnam(Etc.getlogin).dir}/" instead.
93 * Do not try to load same plugin from different locations. Added ability
94 to disable system-wide plugins - create PLUGIN.rb.disabled in user's
96 * For example, to disable freshmeat plugin installed in /usr/share/rbot/plugins/freshmeat.rb one can create empty file ~/.rbot/plugins/freshmeat.rb.disabled
98 Mon Aug 08 23:08:01 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
100 * new markov plugin for random inane chat
102 Sun Aug 07 18:20:24 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
104 * stop insult plugin being used to insult the bot
106 Sun Aug 07 17:53:06 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
108 * workaround for people without YAML::load_file
109 * quit message for restart
111 Sun Aug 07 15:11:07 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
113 * fix address_prefix, broken in 0.9.9, reported by ruskie.
115 Sat Aug 06 00:54:34 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
119 Fri Aug 05 23:55:20 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
121 * few more tweaks preparing to release 0.9.9
123 Thu Aug 04 23:03:30 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
125 * Improved ircd recognition of rfc2812.rb
126 * de-string'd, de-cap'd rfc2812.rb, looks less shouty now
127 * moved the Q auth stuff (for quakenet) into a new qauth plugin (untested!)
128 * finish fixing the httputil
130 Thu Aug 04 00:11:52 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
132 * Tweaked the debug() stuff a bit. Need to do this more cleanly really
133 * Added a fair bit of documentation for some of the new features
135 Wed Aug 03 15:25:07 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
137 * Added french language file (TODO most of the plugins just talk english)
138 * The way the Enum configs were set up, it wasn't possible to add language
139 files to rbot at runtime (the directory was only scanned at startup). Now
140 you can set a values Proc, which is called to return a list of allowed
141 values whenever it's queried.
142 * Added Config module for determining where we were installed.
143 Unfortunately rubygems is a total whore in this regard, and I hope the
144 current hackery I have to do to support it becomes redundant in the
147 Wed Aug 03 00:31:41 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
149 * Added Rakefile, tweaked gemspec
151 Tue Aug 02 16:27:36 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
153 * Fixed the new http.proxy* settings, they work!
154 * Fixed a bug with auth-checking for the config module
157 Sun Jul 31 02:20:08 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
159 * Updated docgen to generate rdoc again with the new repo structure
160 * added new restart command to the core bot, quits irc and reexecs the
161 bot, to pick up new code/libraries etc.
163 Sat Jul 30 22:33:36 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
165 * Config items are now objects, various types are available.
166 * The config wizard will now use registered config items if :wizard is set
167 to true for those items. It will ask questions in the order they were
169 * The config module now works for doing runtime configuration.
172 Sat Jul 30 01:19:32 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
174 * config module for configuring the running bot via IRC
175 * BotConfig.register method for various modules and any plugin to register
176 bot configuration which the new config module will expose for them.
177 * various other tweaks as I continue to refactor..
179 Fri Jul 29 13:07:56 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
181 * Moved some stuff out of util.rb into the plugins that actually need
182 them. Those methods didn't belong in util as they were plugin-specific.
183 * moved a few more plugins to use map() where appropriate
184 * made the url plugin only store unique urls
186 Thu Jul 28 23:45:26 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
188 * Reworked the Timer module. The Timer now has a smart thread manager to
189 start/stop the tick() thread. This means the timer isn't called every 0.1
190 seconds to see what needs doing, which is much more efficient
191 * reworked the ircsocket queue mechanism to use a Timer
192 * reworked the nickserv plugin to use maps
193 * made server.reconnect_wait configurable
194 * added Class tracing mechanism to bin/rbot, use --trace Classname for
197 Tue Jul 26 14:41:34 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
199 * Prevent multiple plugin registrations of the same name
200 * reworking the config system to use yaml for persistence
201 * reworking the config system key names
202 * on first startup, the bot will prompt for the essential startup config
203 * new config module for configuring the bot at runtime
204 * new config module includes new configurables, for example changing the
205 bot's language at runtime.
206 * various other fixes
207 * New way of mapping plugins to strings, using maps. These may be
208 familiar to rails users. This is to reduce the amount of regexps plugins
209 currently need to do to parse arguments. The old method (privmsg) is still
210 supported, of course. Example plugin now:
211 def MyPlugin < Plugin
216 def complexfoo(m, params)
217 m.reply "qux! (#{params[:bar]} #{params[:baz]})"
220 plugin = MyPlugin.new
224 # this will match "rbot: foo somestring otherstring" and pass the
225 # parameters as a hash using the names in the map.
226 plugin.map 'foo :bar :baz', :action => 'complexfoo'
227 # this means :foo is an optional parameter
228 plugin.map 'foo :foo', :defaults => {:foo => 'bar'}
229 # you can also gobble up into an array
230 plugin.map 'foo *bar' # params[:bar] will be an array of string elements
231 # and you can validate, here the first param must be a number
232 plugin.map 'foo :bar', :requirements => {:foo => /^\d+$/}
235 Sat Jul 23 01:39:08 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
237 * Changed BotConfig to use yaml storage, method syntax instead of hash for
238 get/set, to allow more flexibility and encapsulation
239 * Added convenience method Message.okay (m.okay is the same as the
240 old-style @bot.okay m.replyto)
242 Wed Jul 20 23:30:01 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
244 * Move some core plugins to use the new httputil
245 * fix wserver's redirection handling for relative (i.e. broken) redirects
246 * fix tube plugin's html parsing
248 Wed Jul 20 01:18:06 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
250 * Add new httputil object to the bot object, to be used by plugins etc
251 that wish to make http requests. It sets up all the proxies etc for them
252 according to bot config.
254 Sat Jul 16 02:23:13 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
256 * Apply most of Rene's patch and fix various plugins.
257 * New plugin: autoop (auto ops via hostmask)
258 * New feature: karmastats
260 Wed Oct 13 16:16:31 BST 2004 Tom Gilbert <tom@linuxbrit.co.uk>
262 * Fix bug with quotes plugin where it gets confused and sees both a quote
263 and a keyword, both plugins are triggered by, for example "addquote foo is
265 * fixed this by implementing the "has_responded" flag on a message. When a
266 plugin replied to a message (or it manually sets m.replied to true), the
267 keywords plugin will honour that flag and not examine the message for
268 keywords. This flag can also be checked by listen plugins that don't want to
269 interfere with other plugin commands.
271 Mon Oct 11 00:37:52 BST 2004 Tom Gilbert <tom@linuxbrit.co.uk>
273 * Fixes to the NickServ plugin
275 Sat Oct 09 23:23:24 BST 2004 Tom Gilbert <tom@linuxbrit.co.uk>
279 Fri Oct 08 00:40:07 BST 2004 Tom Gilbert <tom@linuxbrit.co.uk>
281 * fixed insult plugin
282 * fixed excuse plugin
284 Thu Oct 07 23:28:05 BST 2004 Tom Gilbert <tom@linuxbrit.co.uk>
286 * searching for urls in the url plugin
287 * roshambo (rock/paper/scissors) plugin from Hans Fugal <hans@fugal.net>
289 Sat Apr 17 20:56:50 BST 2004 Tom Gilbert <tom@linuxbrit.co.uk>
291 * Oh, found new tv plugin in my inbox from ages ago, but it's still not
292 working so I guess it changed again since then
293 * New eightball plugin from Daniel Free
295 Sat Apr 17 20:44:43 BST 2004 Tom Gilbert <tom@linuxbrit.co.uk>
297 * Fixed the babelfish parser so translate works again.
299 * Note some plugins are broken (excuse,insult) because the server they use
300 went away. I don't know of a replacement right now.
301 * tv plugin seems broken, perhaps the html changed.
303 Thu Jan 15 21:37:38 GMT 2004 Tom Gilbert <tom@linuxbrit.co.uk>
308 * new plugin from Alan Third <alan@idiocy.org>, allows you to search and list
312 * various plugin updates
313 * fix (again) for C to F temp conversion in weather plugin
314 * channel topic patch from Peter Suschlik, gives plugin better access to topic
315 changes and related information
318 * changes to layout of slashdot plugin output
319 * freshmeat plugin, show latest updates or search
320 * fix to C to F temp conversion in weather plugin
321 * status command returns some bot status
323 * using BDB::Btree everywhere now, instead of BDB::Hash, because the Btree api
324 allows me to set my own key comparison function. This is needed to keep
325 supporting case insensitivity (vital for IRC), which was sadly broken in
326 0.9.5 :( All existing dbs will be upgraded automatically.
327 * roulette plugin - play russian roulette :) also keeps game stats.
328 * new config option, NO_KEYWORD_ADDRESS. If set to "true", the bot will always
329 respond to keywords it knows even when not addressed and the message doesn't
330 start with '. Message must end with "?" however.
331 * hopefully fixed welcome message parsing from certain server types
334 * plugin object registry
335 This provides persistant storage for plugins via a hash interface. The
336 default mode is an object store, so you can store ruby objects and reference
337 them with hash keys. This is because the default store/restore methods of
338 the plugins' RegistryAccessor are calls to Marshal.dump and Marshal.restore,
342 @registry[:blah] = blah
343 then, even after the bot is shut down and disconnected, on the next run you
344 can access the blah object as it was, with:
345 blah = @registry[:blah]
346 The registry can of course be used to store simple strings, fixnums, etc as
347 well, and should be useful to store or cache plugin data or dynamic plugin
350 If you don't need to store objects, and strictly want a persistant hash of
351 strings, you can override the store/restore methods to suit your needs, for
352 example (in your plugin):
363 Your plugins section of the registry is private, it has its own namespace
364 (derived from the plugin's class name, so change it and lose your data).
365 Calls to registry.each etc, will only iterate over your namespace.
367 The nickserv and karma plugins use the new registry and should serve as a
368 useful example. Basic usage of the registry is simple, just treat it as a
369 hash, with values that never die (unless you delete() them).
370 * Change to the nickserv plugin. The old method of putting the nickserv
371 password in rbot.conf was useless for multiple nicks or easy updates. The
372 plugin now uses the plugin registry to store passwords for any nicks it
373 owns. The plugin can be told to register the current nick (supply a password
374 or it'll generate one), identify for the current nick (if the password is
375 known), and can be told the passwords for other nicks. If NickServ asks the
376 bot to identify, it will automatically do so if it knows the appropriate
378 * karma plugin now uses the plugin registry, it should automatically import
379 your existing, stored karma data into the registry.
380 * The babelfish plugin now caches results in the bot registry to speed up
382 * New message types and plugin methods to grab them,
383 quit(QuitMessage): Called when a user (or the bot) quits IRC
384 nick(NickMessage): Called when a user (or the bot) changes Nick
385 topic(TopicMessage): Called when a user (or the bot) changes a channel topic
386 * A plugin's listen() method will now receive any kind of Message, e.g.
387 PrivMessage, NoticeMessage, NickMessage, JoinMessage, etc
389 seen: the usual "seen" stuff:
391 giblet was last seen xxx ago doing xxx
392 cal: calls the unix cal program to display a calendar
393 math: evaluates mathematical expressions:
395 rbot: math 4 to the power of 8
396 rbot: math ((232+432) - 4) / 2
397 (ported from infobot. Thanks to Kevin Lenzo, who wrote the
398 original infobot math module)
399 slashdot: displays latest headlines or searches for articles
400 url: stores urls mentioned in channels for regurgitation later
401 weather: grabs and parses METAR weather data, will remember the last weather
402 code you asked for so you don't have to :)
403 * New utility function, Util.http_get(url) for getting remote data via http,
404 just dumps response.body into a string and returns it, or nil if anything at
405 all goes wrong. Useful for simple plugins.
406 * random quit messages if none specified, messages set in language description
408 * keywords are now stored in bdb databases - your old keywords.rbot will be
409 imported. Static keywords (fact packs) are also stored in bdb databases, and
410 rbot will automatically convert any text .fact file dropped in the confdir's
411 keywords subdirectory, at startup, into a bdb file. If both a db and a text
412 file exist of the same name (except the extension), the text file will be
413 imported and merged into the database.
414 static keywords will be looked up in each factpack db in turn, in
415 alphabetical filename order - so you can prioritise using the filename if
417 * fixed a bug with autsplitting long sent lines, the last line was often being
421 * Massive cleanup of rfc2812.rb, contributed by Lars Christensen
422 <dsl8950@vip.cybercity.dk>, gets rid of a lot of regexps
423 * Fixed bug reading static keyword files - "foo <=is=> bar" may not have
424 worked for a couple of releases, only "foo<=is=>bar" was working - this was
425 not intended and should be fixed now
426 * Experimental send queue, to prevent the bot from flooding out, the delay
427 between sending messages to the server defaults to 2s, but is configurable
428 in conf.rbot, set SENDQ_DELAY (0 to disable queueing). You can also set/get
429 the value from the bot, "rbot: options get sendq_delay", and
430 "rbot: options set sendq_delay 1.5", if you have sufficient auth for "config"
431 This is a bursting sendq, most ircd's allow bursts of up to 5
432 lines, with non-burst limits of 512 bytes/2 seconds. To set the burst limit,
433 configure SENDQ_BURST in conf.rbot, or do the same kind of stuff with
434 "rbot: options set sendq_burst 2", etc.
435 The defaults are 2s/4 burst, which seem to work okay for me.
436 * support for multiple, customisable, addressing prefixes. Set ADDRESS_PREFIX
437 in conf.rbot to a space separate list of addressing prefixes, e.g
438 ADDRESS_PREFIX = | ! =>
439 Would mean that all of the following in channel messages would cause the bot
445 * bb plugin removed, bb is nearly over and it doesn't work 100% anyway
446 * Two plugins from brailsmt (from #ruby-lang on openprojects), a stats plugin
447 which monitors usage of 1-word sentences, and lart, which allows you to ask
448 rbot to lart people - with an optional reason - larts are user-definable and
449 can be added on the fly.
450 * made google.rb work for people with 1.6 ruby's net/http
455 * new plugin for handling nickserv-protected nicks, use NICKSERV_PASSWORD in
457 * fixes to a few other buglets
458 * new plugin to grab bigbrother headlines, still buggy and only useful for UK
459 folks who love bb :-)
460 * fixes to various plugins
461 * Patch from akira yamada <akira@ruby-lang.org>
462 DNS plugin: Use resolv-replace if found, do lookup in new thread
463 Fix bug joining channels with keys
467 * better "connect failure" error message
468 * better option parsing, and --debug option
469 * access to bot's online help via commandline, eg:
471 ./rbot.rb --help core
472 ./rbot.rb --help "core save"
473 * Fix broken help from last point release
474 * Plugin API modification and cleanup. You no longer need to set @listen to
475 true in order to get all NOTICE and PRIVMSGs, you just need to define the
476 method. The method is now called listen(), renamed from listener(). This
477 should be the last time the plugin api is changed incompatibly.
478 * New plugin method kick(). Use it to see kicks (duh :))
479 * New plugin methods join(), part(). Obvious uses.
480 * Example plugin autorejoin.rb, uses kick event to rejoin channel and insult
482 * fix bug in remind plugins "remind me no more" recognition.
486 * Fix welcome message recognition for certain IRCd's.
490 * Allow keyword definitions which end in '?', like this:
492 * rdoc documentation!
493 * fixed broken address regexp, "rbot: .foo" was being treated as an addressed
494 form of "foo" (lost the .)
495 * fix stupid bug in last release (looking for wrong default conf dir)
499 * Tarball layout change. modules all in rbot/ now, and the rbot/ default
500 configuration moved to rbotconf/. This lets the thing run from an unpacked
501 tarball while also being ready to run with the modules installed somewhere
503 * change hashbang to /usr/bin/env ruby, in order to use PATH looking for ruby,
505 * allow "botnick : foo" style addressing, and even "botnick... foo"
506 * slap plugin (contributed by oct)
507 * renamed bot.send to bot.sendmsg, I didn't really want to override send() ;D
511 * Made sane for packagers. Looks in the right places for plugins and language
512 files now, so extra effort shouldn't be needed there.
516 * Fixed "nick taken on join" bug
517 * Dice plugin patch from David Dorward
518 * fix searchquote regexp
519 * conf.rbot: PASSWORD -> SERVER_PASSWORD, to prevent confusion with PASSWD,
520 which is for master auth.
524 * Fixed addquote (was incrementing quote ID twice)
525 * now strips colour/bold escapes from incoming messages (rbot was ignoring
526 messages addressed using a bolded colon, for example).
528 * more language breadth
529 * Addressing works better now
530 * Can autojoin channels with keys, conf.rbot line is:
531 autojoin_channels #chan1, #chan2, #chan3 key, #chan4 key, #chan5