1 2007-02-20 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
3 * Timers: failing timer actions don't prevent the global timer ticker
4 from functioning properly.
5 * Shiritori plugin: new word game, contributed by Yaohan Chen
6 <yaohan.chen@gmail.com>. People take turns to continue a chain of
7 words by saying words that begin with the final letter(s) of the
9 * IRC messages are not UTF-8: Most of the string processing across
10 rbot is done against IRC messages, which do not have a well-defined
11 encoding. Although many clients are now using UTF-8, there is no
12 guarantee that an arbitrary string received from IRC will be UTF-8
13 encoded. We have to force ASCII (byte-wise/charset agnostic) matching
14 because otherwise some strings can give problems: in particular, for
15 example, the bytesequence "\340\350\354\362\371" (that is the aeiou
16 vowels, each with a grave accent) will cause the string to be
17 considered up to the "\354" (i with grave accent) only: so either the
18 rest of the message is ignored, or the matching fails.
20 2007-02-18 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
22 * Plugin: Provide a plugin.header file with boilerplate plugin
23 title/author/copyright/license information. Authors of new plugins are
24 encouraged to use it. Many existing plugins have been changed to
26 * NickServ plugin: delegate #identified() to other plugins after
27 successfull identification. Also provide #identified?() method to test
28 if the bot has successfully identified. Not perfect yet (gets reset
31 2007-02-15 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
33 * Plugin: new unreplied() method to handle PRIVMSGs which have not
35 * Regexp: more regexp madness. BasicUserMessage and derivate classes
36 now have a new method parse_channel_list() to parse list of channel
39 2007-02-12 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
41 * Remote Service Provider: from an idea by halorgium <rbot@spork.in>,
42 initial steps towards a DRb-based remote service provider for rbot.
43 When complete, it will give plugins the ability to listen to
44 'messages' from remote clients connected to the bot, allowing for such
45 things as svn notification without RSS polling, remote control of
46 the bot, or even (why not?) botnets.
47 * Remote Service Provider: BotModules can now include the
48 RemoteBotModule interface that provides them with the remote_map()
49 method that works just like the map() method, but for remote commands
50 * Remote Service Provider: Remote clients can now login remotely
51 before executing commands. This in fact integrates the remote access
52 auth security with the User/BotUser used on IRC itself.
54 2007-02-08 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
56 * Languages: Japanese support with language files, salutations, larts
57 and praises, thanks to hagabaka (Yaohan Chen <yaohan.chen@gmail.com>)
59 2007-02-05 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
61 * sendmsg improvements: the bot sendmsg() method and all the methods
62 that rely on it (say(), notice(), and message methods such as reply())
63 now accept an option hash to customize its behaviour.
64 * :newlines, which can be set to either :split or :join,
65 depending on whether newlines in messages should be used as
66 split-points, or should be be replaced by some string (defined
67 in the :join_with option)
68 * :max_lines, which determines the maximum number of lines to be
69 sent by each messages. Last line is truncated (see next
70 options). Set to nil to have no limits.
71 * :overlong, which determines the behaviour when overlong lines
72 are to be sent; possible values are :split or :truncate.
73 * If :overlong is set to :split, :split_at determines the
74 string/regexp to split at; default is /\s+/, other usual
75 choice could be /\s+\|\s+/.
76 * If :overlong is set to :split, the :purge_split option
77 determines whether the :split_at expression should be removed
78 from the next lines (defaults to true).
79 * If :overlong is set to :truncate, the value of the option
80 :truncate_text is replaced at the end of the truncated line
81 * LinkBot plugin: initial commit of a plugin to handle messages from
82 eggdrops and other bots that act as cross-network channel links.
83 Suggested by hagabaka (Yaohan Chen <yaohan.chen@gmail.com>)
86 2007-02-03 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
88 * Plugin message mapper: Enhancements to the :requirements option.
89 When the requirement of a parameter is a regular expression with
90 capturing groups /(...)/, the corresponding map parameters will be
91 assigned (by default) the first non-nil capture instead of the whole
92 regular expression. If a specific capture group is desired instead,
93 the requirement should be in the form
94 [/some regexp/, integer_index_of_the_desired_group]
97 :regexp => /some regexp/,
98 :index => integer_index_of_the_desired_group
100 and a nil index will still give the default behavior.
101 If you want the whole regular expression to be the matched parameter
102 value, there are three options: use an index of 0, wrap the whole
103 regular expression in a capturing group, or use non-capturing groups
104 /(?:...)/. The latter is preferred because it's much faster.
105 When exploiting the capturing groups feature, please try to remember
106 to use /\s+/ instead of plain spaces / /, unless it's absolutely
107 necessary to have single spaces.
109 2007-02-02 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
111 * Plugin message mapper: Requirements (as set by the :requirements
112 hash) are now embedded in the regular expression matcher rather than
113 being cheked separately afterwards.
115 2007-01-30 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
117 * New IRC Framework: Server methods to retrieve a Channel or User are
118 now more robust to empty or nil nicks and channel names passed as
121 2007-01-29 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
123 * Timer rescheduling: it is now possible to reschedule the period
124 any particular Action is taken by issuing the command
125 @bot.timer.reschedule(handle, new_period)
126 where +handle+ is a timer handle returned by the @bot.timer.add() that
127 created the action, and new_period is the new period for the Action.
129 2007-01-23 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
131 * Reduced saving: the salut, lart, and quotes plugin now only save
132 their datafiles if anything changed since last time. This speeds up
133 operations such as saving and rescanning; it also allow hand-editing
134 of the data files while the bot is running, since a rescan will load
135 the changed data files without overwriting them with a useless save
136 before. Of course this only works if there are no pending changes in
139 2007-01-12 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
141 * Server timeout: rework the server timeout code. Instead of PINGing
142 the server unconditionally every server.ping_timeout seconds, we only
143 PING it if we don't receive anything in the user-chosen timeout (lazy
144 PING). The code rewrite also seems to have fixed the "bot stalling
145 doing nothing" problem, which seemed to have been a consequence of
146 @socket.select not having a timeout.
148 2006-11-01 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
150 * SSL support: patch from Robin H. Johnson <robbat2@gentoo.org>
152 2006-10-28 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
154 * A-Z game: try to guess the word the bot is thinking of: every miss
155 helps by reducing the range of allowed words, until it's so small
156 around the correct one that you can't miss it.
158 2006-10-27 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
160 * Flood protection: first attempt at penalty-based flood protection.
161 This should make rbot much less prone to Excess Floods *and* still
162 serve normally without excessive delays.
164 2006-10-25 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
166 * HttpUtil: Strings returned by get_cached now have a cached? method
167 which returns true or false depending on whether the result was taken
168 from the cache or not; this can be exploited by plugins that parse the
169 result in some particular way, since they can now skip the parsing
170 stage if they cache the parse result.
172 2006-10-24 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
174 * HttpUtil: initial implementation of proper caching based on
175 last-modified and etag HTTP headers
177 2006-10-17 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
179 * Salut plugin: handles (multilingual) salutations (hello/goodbye)
181 2006-10-15 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
183 * Language stuff: plugins can now handle language changes in a natural
184 fashion. lart is the first plugin to make use of this. NOTE: this
185 is not (yet) backwards compatible: the old larts/praises files from
186 previous rbot setups have to be renamed manually
187 * Language stuff: italian translations
188 * Utils.safe_save(filename): allows 'safe' saving of a file: it needs a
189 block, to which it will yield a temporary file on which operations can
190 be carried out. When the block returns, the tempfile will be renamed to
193 2006-09-21 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
195 * New Auth Framework: restore backwards compatibility: 'auth
196 <masterpassword>' and 'login owner <masterpassword>' both work.
197 * Topic plugin: cleanups. Implement 'topic undo'. 'topic undo' after a
198 'topic undo' undoes the last undo.
200 2006-09-09 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
202 * New Auth Framework: rbot was opping anyone who asked for it (opme
203 plugin). Fixed, and cleaned up.
205 2006-09-01 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
207 * New Auth Framework: document and fine tune permissions view the auth
209 * Version: when run from a svn checkout, the bot now tries to report
210 which svn revision it's at, and if there are local changes
212 2006-08-31 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
214 * Nickserv plugin: bot will now try to inform nickserv when password
215 is changed. Moreover it's not necessary to specify the nick anymore if
216 you want to change the password for the current bot nick. Also do some
217 internal cleanups while we're at it.
219 2006-08-29 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
221 * Script plugin: new (UNSAFE!) echo functions. Just like eval, but
222 m.replies the result of the evaluation.
223 * New Auth Framework: config keys now have their own permissions. So
224 you can allow people to view or edit only some of the config values.
225 auth.password defaults to false. Still needs some work.
227 2006-08-26 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
229 * Plugin message mapper: new implementation. Multi-word parameters now
230 need not be the last, and it is possible to retrieve the entire
231 substring with preserved whitespace by using to_s. Also, parts of the
232 map string can be bracketed to make them optional. Examples:
233 remind :user [about] *stuff
235 remind me about washing my teeth
237 remind me washing my teeth
238 It is possible to have parameters in brackets, in which case they will
239 be optional too, and default to nil or [] (resp. single- and
240 multi-word parameters) unless an alternative is provided in the
241 :defaults hash for the message map options.
242 * Script plugin: new (UNSAFE!) eval function. Not documented in help.
243 Not permitted by default.
245 2006-08-25 Mark Kretschmann <markey@web.de>
247 * Added quiz plugin, a multiplayer trivia quiz game.
249 2006-08-20 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
251 * Topic plugin: fix a bug that prevented it from loading
253 * New IRC Framework: make sure that NOTICEs and PRIVMSGs do not
254 raise an exception when the target is in one of the special forms
255 #<mask> or $<mask>. Needs some work, though, since this case should be
256 handled specifically.
258 2006-08-17 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
260 * Fix help: It got broken while rearranging the plugin stuff, now it's
262 * New Auth Framework: forgot to create the InvalidPassword exception.
263 It's a RuntimeError now.
264 * Fix help: this time for real (or so I hope).
265 * New IRC Framework: topic plugin now works correctly.
266 * New Auth Framework: nickserv plugin now defaults to false for its
267 auth, so that only owner can do stuff with it
268 * New Auth Framework: fix horrible typo, assignment instead of
269 equality test when checking for the username during login.
270 * Keywords plugin: tell and forget work again without 'keyword' before
273 2006-08-12 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
275 * Subregistry: force prefix to be a String with to_s
277 2006-08-11 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
279 * AutoOp plugin: adapted to the new IRC framework.
280 * AutoOp plugin: trigger autoop on nick change too.
281 * New Auth Framework: allow? method now informs a user when they don't
282 have permission to do what they asked for.
283 * New nickreply and nickokay methods: they act like the old reply
284 method, but include the nick of the user the bot is replying to when
285 talking in public. The usual reply method can be configured to act
286 like this as default.
288 2006-08-10 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
290 * Fix a bug in new IRC Framework: the list of channels a quitting user was
291 on was not built correctly, causing an exception when the user was not
292 in the first channel in the list of channels.
293 * Fix a bug in new Auth Framework: BotUser's name is changed via
294 username=, not name=.
295 * New HalfLife 2 plugin from ocr: queries online servers for online
296 status and number of users.
298 2006-08-07 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
300 * Add kick method to kernel: plugins can now use
301 @bot.kick channel, user, reason
302 to kick a user from a channel
303 * RSS plugin: fix rewatch_rss method
304 * RSS plugin: the different ways to represent channels before and
305 after the New IRC Framework was causing strange problems such as
306 watched feed not being listed as such, undeletable watches, double
307 watches etc. Fix this by checking both for the Channel objects and
308 their to_s form when checking for watches or deleting them.
310 2006-08-06 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
312 * Updating the ChangeLog again: describe the new stuff in trunk which
313 will be made available in the next release. Use Gnu style for new
314 changelog entries (yyyy-mm-dd name <email address>\n<tab> ...):
315 there's a macro for this since at least Vim 6.x and higher, called by
316 <Leader>o (default leader: slash (\))
317 * New IRC Framework: Server, Channels, User, Netmasks etc are all
318 proper Ruby objects. The better organization will allow multi-server
319 connections to be implemented more easily
320 * Modularize core: split the internal functionality from what can be
321 implemented as botmodules (which work just the same as plugins). Move
322 Configuration, Basics and Auth out of the 'kernel' into core
324 * New Auth Framework: BotUsers are now Ruby objects with attached
325 PermissionSets which define what the BotUser can do, by channel if
326 necessary. The new framework allows very fine-grained control while
327 still being very easy to manage for elementary usage. BotUser data can
328 be exported and imported, but no backwards compatibility has been
329 implemented yet. Most plugins still have to be updated to the new
330 command-path-based mechanism.
332 Sun Aug 06 17:33:55 BST 2006 Tom Gilbert <tom@linuxbrit.co.uk>
335 * Changes: Lots of new and updated plugins, including one to poll RSS feeds.
336 A first step towards a better auth system (total revamp due in 0.9.11).
337 Improvements to network and server code which should provide greater
338 stability. A new message queueing mechanism with bitrate throttling. A new
339 logging framework for debugging and tracing the activities of the bot. A
340 new split-db registry system for better performance and transactional
341 usage of bdb for resilience. More integration with Nickserv where
342 available including optional automatic ghost-killing.
344 Wed Sep 07 20:16:46 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
346 * Fixed quit, broke it last commit
347 * Fixed trap() for win32
349 Sun Aug 21 13:29:55 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
351 * fix for bug in quakenet plugin (trac #14)
352 * multiple fixes for unescaped bot nick in regexp's (trac #13)
354 Fri Aug 12 20:51:38 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
356 * fix up autoop plugin a bit
358 Thu Aug 11 00:13:11 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
360 * Added two plugins from Robin Kearney <robin@riviera.org.uk>
361 * Threat (US threat level :P)
362 * bash (bash.org quotes)
364 Thu Aug 11 00:04:31 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
366 * Patches from "Alexey I. Froloff" <raorn@altlinux.ru>
367 * Do not use "/home/#{Etc.getlogin}/" for default home directory, use
368 "#{Etc.getpwnam(Etc.getlogin).dir}/" instead.
369 * Do not try to load same plugin from different locations. Added ability
370 to disable system-wide plugins - create PLUGIN.rb.disabled in user's
372 * For example, to disable freshmeat plugin installed in /usr/share/rbot/plugins/freshmeat.rb one can create empty file ~/.rbot/plugins/freshmeat.rb.disabled
374 Mon Aug 08 23:08:01 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
376 * new markov plugin for random inane chat
378 Sun Aug 07 18:20:24 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
380 * stop insult plugin being used to insult the bot
382 Sun Aug 07 17:53:06 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
384 * workaround for people without YAML::load_file
385 * quit message for restart
387 Sun Aug 07 15:11:07 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
389 * fix address_prefix, broken in 0.9.9, reported by ruskie.
391 Sat Aug 06 00:54:34 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
395 Fri Aug 05 23:55:20 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
397 * few more tweaks preparing to release 0.9.9
399 Thu Aug 04 23:03:30 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
401 * Improved ircd recognition of rfc2812.rb
402 * de-string'd, de-cap'd rfc2812.rb, looks less shouty now
403 * moved the Q auth stuff (for quakenet) into a new qauth plugin (untested!)
404 * finish fixing the httputil
406 Thu Aug 04 00:11:52 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
408 * Tweaked the debug() stuff a bit. Need to do this more cleanly really
409 * Added a fair bit of documentation for some of the new features
411 Wed Aug 03 15:25:07 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
413 * Added french language file (TODO most of the plugins just talk english)
414 * The way the Enum configs were set up, it wasn't possible to add language
415 files to rbot at runtime (the directory was only scanned at startup). Now
416 you can set a values Proc, which is called to return a list of allowed
417 values whenever it's queried.
418 * Added Config module for determining where we were installed.
419 Unfortunately rubygems is a total whore in this regard, and I hope the
420 current hackery I have to do to support it becomes redundant in the
423 Wed Aug 03 00:31:41 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
425 * Added Rakefile, tweaked gemspec
427 Tue Aug 02 16:27:36 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
429 * Fixed the new http.proxy* settings, they work!
430 * Fixed a bug with auth-checking for the config module
433 Sun Jul 31 02:20:08 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
435 * Updated docgen to generate rdoc again with the new repo structure
436 * added new restart command to the core bot, quits irc and reexecs the
437 bot, to pick up new code/libraries etc.
439 Sat Jul 30 22:33:36 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
441 * Config items are now objects, various types are available.
442 * The config wizard will now use registered config items if :wizard is set
443 to true for those items. It will ask questions in the order they were
445 * The config module now works for doing runtime configuration.
448 Sat Jul 30 01:19:32 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
450 * config module for configuring the running bot via IRC
451 * BotConfig.register method for various modules and any plugin to register
452 bot configuration which the new config module will expose for them.
453 * various other tweaks as I continue to refactor..
455 Fri Jul 29 13:07:56 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
457 * Moved some stuff out of util.rb into the plugins that actually need
458 them. Those methods didn't belong in util as they were plugin-specific.
459 * moved a few more plugins to use map() where appropriate
460 * made the url plugin only store unique urls
462 Thu Jul 28 23:45:26 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
464 * Reworked the Timer module. The Timer now has a smart thread manager to
465 start/stop the tick() thread. This means the timer isn't called every 0.1
466 seconds to see what needs doing, which is much more efficient
467 * reworked the ircsocket queue mechanism to use a Timer
468 * reworked the nickserv plugin to use maps
469 * made server.reconnect_wait configurable
470 * added Class tracing mechanism to bin/rbot, use --trace Classname for
473 Tue Jul 26 14:41:34 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
475 * Prevent multiple plugin registrations of the same name
476 * reworking the config system to use yaml for persistence
477 * reworking the config system key names
478 * on first startup, the bot will prompt for the essential startup config
479 * new config module for configuring the bot at runtime
480 * new config module includes new configurables, for example changing the
481 bot's language at runtime.
482 * various other fixes
483 * New way of mapping plugins to strings, using maps. These may be
484 familiar to rails users. This is to reduce the amount of regexps plugins
485 currently need to do to parse arguments. The old method (privmsg) is still
486 supported, of course. Example plugin now:
487 def MyPlugin < Plugin
492 def complexfoo(m, params)
493 m.reply "qux! (#{params[:bar]} #{params[:baz]})"
496 plugin = MyPlugin.new
500 # this will match "rbot: foo somestring otherstring" and pass the
501 # parameters as a hash using the names in the map.
502 plugin.map 'foo :bar :baz', :action => 'complexfoo'
503 # this means :foo is an optional parameter
504 plugin.map 'foo :foo', :defaults => {:foo => 'bar'}
505 # you can also gobble up into an array
506 plugin.map 'foo *bar' # params[:bar] will be an array of string elements
507 # and you can validate, here the first param must be a number
508 plugin.map 'foo :bar', :requirements => {:foo => /^\d+$/}
511 Sat Jul 23 01:39:08 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
513 * Changed BotConfig to use yaml storage, method syntax instead of hash for
514 get/set, to allow more flexibility and encapsulation
515 * Added convenience method Message.okay (m.okay is the same as the
516 old-style @bot.okay m.replyto)
518 Wed Jul 20 23:30:01 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
520 * Move some core plugins to use the new httputil
521 * fix wserver's redirection handling for relative (i.e. broken) redirects
522 * fix tube plugin's html parsing
524 Wed Jul 20 01:18:06 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
526 * Add new httputil object to the bot object, to be used by plugins etc
527 that wish to make http requests. It sets up all the proxies etc for them
528 according to bot config.
530 Sat Jul 16 02:23:13 BST 2005 Tom Gilbert <tom@linuxbrit.co.uk>
532 * Apply most of Rene's patch and fix various plugins.
533 * New plugin: autoop (auto ops via hostmask)
534 * New feature: karmastats
536 Wed Oct 13 16:16:31 BST 2004 Tom Gilbert <tom@linuxbrit.co.uk>
538 * Fix bug with quotes plugin where it gets confused and sees both a quote
539 and a keyword, both plugins are triggered by, for example "addquote foo is
541 * fixed this by implementing the "has_responded" flag on a message. When a
542 plugin replied to a message (or it manually sets m.replied to true), the
543 keywords plugin will honour that flag and not examine the message for
544 keywords. This flag can also be checked by listen plugins that don't want to
545 interfere with other plugin commands.
547 Mon Oct 11 00:37:52 BST 2004 Tom Gilbert <tom@linuxbrit.co.uk>
549 * Fixes to the NickServ plugin
551 Sat Oct 09 23:23:24 BST 2004 Tom Gilbert <tom@linuxbrit.co.uk>
555 Fri Oct 08 00:40:07 BST 2004 Tom Gilbert <tom@linuxbrit.co.uk>
557 * fixed insult plugin
558 * fixed excuse plugin
560 Thu Oct 07 23:28:05 BST 2004 Tom Gilbert <tom@linuxbrit.co.uk>
562 * searching for urls in the url plugin
563 * roshambo (rock/paper/scissors) plugin from Hans Fugal <hans@fugal.net>
565 Sat Apr 17 20:56:50 BST 2004 Tom Gilbert <tom@linuxbrit.co.uk>
567 * Oh, found new tv plugin in my inbox from ages ago, but it's still not
568 working so I guess it changed again since then
569 * New eightball plugin from Daniel Free
571 Sat Apr 17 20:44:43 BST 2004 Tom Gilbert <tom@linuxbrit.co.uk>
573 * Fixed the babelfish parser so translate works again.
575 * Note some plugins are broken (excuse,insult) because the server they use
576 went away. I don't know of a replacement right now.
577 * tv plugin seems broken, perhaps the html changed.
579 Thu Jan 15 21:37:38 GMT 2004 Tom Gilbert <tom@linuxbrit.co.uk>
584 * new plugin from Alan Third <alan@idiocy.org>, allows you to search and list
588 * various plugin updates
589 * fix (again) for C to F temp conversion in weather plugin
590 * channel topic patch from Peter Suschlik, gives plugin better access to topic
591 changes and related information
594 * changes to layout of slashdot plugin output
595 * freshmeat plugin, show latest updates or search
596 * fix to C to F temp conversion in weather plugin
597 * status command returns some bot status
599 * using BDB::Btree everywhere now, instead of BDB::Hash, because the Btree api
600 allows me to set my own key comparison function. This is needed to keep
601 supporting case insensitivity (vital for IRC), which was sadly broken in
602 0.9.5 :( All existing dbs will be upgraded automatically.
603 * roulette plugin - play russian roulette :) also keeps game stats.
604 * new config option, NO_KEYWORD_ADDRESS. If set to "true", the bot will always
605 respond to keywords it knows even when not addressed and the message doesn't
606 start with '. Message must end with "?" however.
607 * hopefully fixed welcome message parsing from certain server types
610 * plugin object registry
611 This provides persistant storage for plugins via a hash interface. The
612 default mode is an object store, so you can store ruby objects and reference
613 them with hash keys. This is because the default store/restore methods of
614 the plugins' RegistryAccessor are calls to Marshal.dump and Marshal.restore,
618 @registry[:blah] = blah
619 then, even after the bot is shut down and disconnected, on the next run you
620 can access the blah object as it was, with:
621 blah = @registry[:blah]
622 The registry can of course be used to store simple strings, fixnums, etc as
623 well, and should be useful to store or cache plugin data or dynamic plugin
626 If you don't need to store objects, and strictly want a persistant hash of
627 strings, you can override the store/restore methods to suit your needs, for
628 example (in your plugin):
639 Your plugins section of the registry is private, it has its own namespace
640 (derived from the plugin's class name, so change it and lose your data).
641 Calls to registry.each etc, will only iterate over your namespace.
643 The nickserv and karma plugins use the new registry and should serve as a
644 useful example. Basic usage of the registry is simple, just treat it as a
645 hash, with values that never die (unless you delete() them).
646 * Change to the nickserv plugin. The old method of putting the nickserv
647 password in rbot.conf was useless for multiple nicks or easy updates. The
648 plugin now uses the plugin registry to store passwords for any nicks it
649 owns. The plugin can be told to register the current nick (supply a password
650 or it'll generate one), identify for the current nick (if the password is
651 known), and can be told the passwords for other nicks. If NickServ asks the
652 bot to identify, it will automatically do so if it knows the appropriate
654 * karma plugin now uses the plugin registry, it should automatically import
655 your existing, stored karma data into the registry.
656 * The babelfish plugin now caches results in the bot registry to speed up
658 * New message types and plugin methods to grab them,
659 quit(QuitMessage): Called when a user (or the bot) quits IRC
660 nick(NickMessage): Called when a user (or the bot) changes Nick
661 topic(TopicMessage): Called when a user (or the bot) changes a channel topic
662 * A plugin's listen() method will now receive any kind of Message, e.g.
663 PrivMessage, NoticeMessage, NickMessage, JoinMessage, etc
665 seen: the usual "seen" stuff:
667 giblet was last seen xxx ago doing xxx
668 cal: calls the unix cal program to display a calendar
669 math: evaluates mathematical expressions:
671 rbot: math 4 to the power of 8
672 rbot: math ((232+432) - 4) / 2
673 (ported from infobot. Thanks to Kevin Lenzo, who wrote the
674 original infobot math module)
675 slashdot: displays latest headlines or searches for articles
676 url: stores urls mentioned in channels for regurgitation later
677 weather: grabs and parses METAR weather data, will remember the last weather
678 code you asked for so you don't have to :)
679 * New utility function, Util.http_get(url) for getting remote data via http,
680 just dumps response.body into a string and returns it, or nil if anything at
681 all goes wrong. Useful for simple plugins.
682 * random quit messages if none specified, messages set in language description
684 * keywords are now stored in bdb databases - your old keywords.rbot will be
685 imported. Static keywords (fact packs) are also stored in bdb databases, and
686 rbot will automatically convert any text .fact file dropped in the confdir's
687 keywords subdirectory, at startup, into a bdb file. If both a db and a text
688 file exist of the same name (except the extension), the text file will be
689 imported and merged into the database.
690 static keywords will be looked up in each factpack db in turn, in
691 alphabetical filename order - so you can prioritise using the filename if
693 * fixed a bug with autsplitting long sent lines, the last line was often being
697 * Massive cleanup of rfc2812.rb, contributed by Lars Christensen
698 <dsl8950@vip.cybercity.dk>, gets rid of a lot of regexps
699 * Fixed bug reading static keyword files - "foo <=is=> bar" may not have
700 worked for a couple of releases, only "foo<=is=>bar" was working - this was
701 not intended and should be fixed now
702 * Experimental send queue, to prevent the bot from flooding out, the delay
703 between sending messages to the server defaults to 2s, but is configurable
704 in conf.rbot, set SENDQ_DELAY (0 to disable queueing). You can also set/get
705 the value from the bot, "rbot: options get sendq_delay", and
706 "rbot: options set sendq_delay 1.5", if you have sufficient auth for "config"
707 This is a bursting sendq, most ircd's allow bursts of up to 5
708 lines, with non-burst limits of 512 bytes/2 seconds. To set the burst limit,
709 configure SENDQ_BURST in conf.rbot, or do the same kind of stuff with
710 "rbot: options set sendq_burst 2", etc.
711 The defaults are 2s/4 burst, which seem to work okay for me.
712 * support for multiple, customisable, addressing prefixes. Set ADDRESS_PREFIX
713 in conf.rbot to a space separate list of addressing prefixes, e.g
714 ADDRESS_PREFIX = | ! =>
715 Would mean that all of the following in channel messages would cause the bot
721 * bb plugin removed, bb is nearly over and it doesn't work 100% anyway
722 * Two plugins from brailsmt (from #ruby-lang on openprojects), a stats plugin
723 which monitors usage of 1-word sentences, and lart, which allows you to ask
724 rbot to lart people - with an optional reason - larts are user-definable and
725 can be added on the fly.
726 * made google.rb work for people with 1.6 ruby's net/http
731 * new plugin for handling nickserv-protected nicks, use NICKSERV_PASSWORD in
733 * fixes to a few other buglets
734 * new plugin to grab bigbrother headlines, still buggy and only useful for UK
735 folks who love bb :-)
736 * fixes to various plugins
737 * Patch from akira yamada <akira@ruby-lang.org>
738 DNS plugin: Use resolv-replace if found, do lookup in new thread
739 Fix bug joining channels with keys
743 * better "connect failure" error message
744 * better option parsing, and --debug option
745 * access to bot's online help via commandline, eg:
747 ./rbot.rb --help core
748 ./rbot.rb --help "core save"
749 * Fix broken help from last point release
750 * Plugin API modification and cleanup. You no longer need to set @listen to
751 true in order to get all NOTICE and PRIVMSGs, you just need to define the
752 method. The method is now called listen(), renamed from listener(). This
753 should be the last time the plugin api is changed incompatibly.
754 * New plugin method kick(). Use it to see kicks (duh :))
755 * New plugin methods join(), part(). Obvious uses.
756 * Example plugin autorejoin.rb, uses kick event to rejoin channel and insult
758 * fix bug in remind plugins "remind me no more" recognition.
762 * Fix welcome message recognition for certain IRCd's.
766 * Allow keyword definitions which end in '?', like this:
768 * rdoc documentation!
769 * fixed broken address regexp, "rbot: .foo" was being treated as an addressed
770 form of "foo" (lost the .)
771 * fix stupid bug in last release (looking for wrong default conf dir)
775 * Tarball layout change. modules all in rbot/ now, and the rbot/ default
776 configuration moved to rbotconf/. This lets the thing run from an unpacked
777 tarball while also being ready to run with the modules installed somewhere
779 * change hashbang to /usr/bin/env ruby, in order to use PATH looking for ruby,
781 * allow "botnick : foo" style addressing, and even "botnick... foo"
782 * slap plugin (contributed by oct)
783 * renamed bot.send to bot.sendmsg, I didn't really want to override send() ;D
787 * Made sane for packagers. Looks in the right places for plugins and language
788 files now, so extra effort shouldn't be needed there.
792 * Fixed "nick taken on join" bug
793 * Dice plugin patch from David Dorward
794 * fix searchquote regexp
795 * conf.rbot: PASSWORD -> SERVER_PASSWORD, to prevent confusion with PASSWD,
796 which is for master auth.
800 * Fixed addquote (was incrementing quote ID twice)
801 * now strips colour/bold escapes from incoming messages (rbot was ignoring
802 messages addressed using a bolded colon, for example).
804 * more language breadth
805 * Addressing works better now
806 * Can autojoin channels with keys, conf.rbot line is:
807 autojoin_channels #chan1, #chan2, #chan3 key, #chan4 key, #chan5