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