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