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