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