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