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