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