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