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