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