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