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