fixes from eean
[rbot] / ChangeLog
1 Wed Sep 07 20:16:46 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
2
3   * Fixed quit, broke it last commit
4         * Fixed trap() for win32
5
6 Sun Aug 21 13:29:55 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
7
8   * fix for bug in quakenet plugin (trac #14)
9         * multiple fixes for unescaped bot nick in regexp's (trac #13)
10
11 Fri Aug 12 20:51:38 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
12
13   * fix up autoop plugin a bit
14
15 Thu Aug 11 00:13:11 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
16
17   * Added two plugins from Robin Kearney <robin@riviera.org.uk>
18         * Threat (US threat level :P)
19         * bash (bash.org quotes)
20
21 Thu Aug 11 00:04:31 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
22
23   * Patches from "Alexey I. Froloff" <raorn@altlinux.ru>
24         * Do not use "/home/#{Etc.getlogin}/" for default home directory, use
25         "#{Etc.getpwnam(Etc.getlogin).dir}/" instead.
26         * Do not try to load same plugin from different locations.  Added ability
27         to disable system-wide plugins - create PLUGIN.rb.disabled in user's
28         plugins directory.
29         * For example, to disable freshmeat plugin installed in /usr/share/rbot/plugins/freshmeat.rb one can create empty file ~/.rbot/plugins/freshmeat.rb.disabled
30
31 Mon Aug 08 23:08:01 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
32
33   * new markov plugin for random inane chat
34
35 Sun Aug 07 18:20:24 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
36
37   * stop insult plugin being used to insult the bot
38
39 Sun Aug 07 17:53:06 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
40
41   * workaround for people without YAML::load_file
42         * quit message for restart
43
44 Sun Aug 07 15:11:07 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
45
46   * fix address_prefix, broken in 0.9.9, reported by ruskie.
47
48 Sat Aug 06 00:54:34 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
49
50   * Released 0.9.9
51
52 Fri Aug 05 23:55:20 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
53
54   * few more tweaks preparing to release 0.9.9
55
56 Thu Aug 04 23:03:30 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
57
58   * Improved ircd recognition of rfc2812.rb
59         * de-string'd, de-cap'd rfc2812.rb, looks less shouty now
60         * moved the Q auth stuff (for quakenet) into a new qauth plugin (untested!)
61         * finish fixing the httputil
62
63 Thu Aug 04 00:11:52 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
64
65   * Tweaked the debug() stuff a bit. Need to do this more cleanly really
66         * Added a fair bit of documentation for some of the new features
67
68 Wed Aug 03 15:25:07 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
69
70   * Added french language file (TODO most of the plugins just talk english)
71         * The way the Enum configs were set up, it wasn't possible to add language
72         files to rbot at runtime (the directory was only scanned at startup). Now
73         you can set a values Proc, which is called to return a list of allowed
74         values whenever it's queried.
75         * Added Config module for determining where we were installed.
76         Unfortunately rubygems is a total whore in this regard, and I hope the
77         current hackery I have to do to support it becomes redundant in the
78         future.
79
80 Wed Aug 03 00:31:41 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
81
82   * Added Rakefile, tweaked gemspec
83
84 Tue Aug 02 16:27:36 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
85
86   * Fixed the new http.proxy* settings, they work!
87         * Fixed a bug with auth-checking for the config module
88         * misc tweaks
89
90 Sun Jul 31 02:20:08 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
91
92   * Updated docgen to generate rdoc again with the new repo structure
93         * added new restart command to the core bot, quits irc and reexecs the
94         bot, to pick up new code/libraries etc.
95
96 Sat Jul 30 22:33:36 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
97
98   * Config items are now objects, various types are available.
99         * The config wizard will now use registered config items if :wizard is set
100     to true for those items. It will ask questions in the order they were
101                 registered.
102         * The config module now works for doing runtime configuration.
103         * misc refactoring
104
105 Sat Jul 30 01:19:32 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
106
107   * config module for configuring the running bot via IRC
108         * BotConfig.register method for various modules and any plugin to register
109         bot configuration which the new config module will expose for them.
110         * various other tweaks as I continue to refactor..
111
112 Fri Jul 29 13:07:56 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
113
114   * Moved some stuff out of util.rb into the plugins that actually need
115         them. Those methods didn't belong in util as they were plugin-specific.
116         * moved a few more plugins to use map() where appropriate
117         * made the url plugin only store unique urls
118
119 Thu Jul 28 23:45:26 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
120
121   * Reworked the Timer module. The Timer now has a smart thread manager to
122         start/stop the tick() thread. This means the timer isn't called every 0.1
123         seconds to see what needs doing, which is much more efficient
124   * reworked the ircsocket queue mechanism to use a Timer
125         * reworked the nickserv plugin to use maps
126         * made server.reconnect_wait configurable
127         * added Class tracing mechanism to bin/rbot, use --trace Classname for
128         debugging
129
130 Tue Jul 26 14:41:34 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
131
132   * Prevent multiple plugin registrations of the same name
133         * reworking the config system to use yaml for persistence
134         * reworking the config system key names
135         * on first startup, the bot will prompt for the essential startup config
136         * new config module for configuring the bot at runtime
137         * new config module includes new configurables, for example changing the
138         bot's language at runtime.
139         * various other fixes
140         * New way of mapping plugins to strings, using maps. These may be
141         familiar to rails users. This is to reduce the amount of regexps plugins
142         currently need to do to parse arguments. The old method (privmsg) is still
143         supported, of course. Example plugin now:
144           def MyPlugin < Plugin
145                   def foo(m, params)
146                           m.reply "bar"
147                         end
148
149                         def complexfoo(m, params)
150                           m.reply "qux! (#{params[:bar]} #{params[:baz]})"
151                         end
152                 end
153                 plugin = MyPlugin.new
154                 # simple map
155                 plugin.map 'foo'
156
157     # this will match "rbot: foo somestring otherstring" and pass the
158                 # parameters as a hash using the names in the map.
159                 plugin.map 'foo :bar :baz', :action => 'complexfoo'
160                 # this means :foo is an optional parameter
161                 plugin.map 'foo :foo', :defaults => {:foo => 'bar'}
162     # you can also gobble up into an array
163                 plugin.map 'foo *bar' # params[:bar] will be an array of string elements
164     # and you can validate, here the first param must be a number
165                 plugin.map 'foo :bar', :requirements => {:foo => /^\d+$/}
166
167
168 Sat Jul 23 01:39:08 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
169
170   * Changed BotConfig to use yaml storage, method syntax instead of hash for
171         get/set, to allow more flexibility and encapsulation
172         * Added convenience method Message.okay (m.okay is the same as the
173         old-style @bot.okay m.replyto)
174
175 Wed Jul 20 23:30:01 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
176
177   * Move some core plugins to use the new httputil
178         * fix wserver's redirection handling for relative (i.e. broken) redirects
179         * fix tube plugin's html parsing
180
181 Wed Jul 20 01:18:06 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
182
183         * Add new httputil object to the bot object, to be used by plugins etc
184         that wish to make http requests. It sets up all the proxies etc for them
185         according to bot config.
186
187 Sat Jul 16 02:23:13 BST 2005  Tom Gilbert <tom@linuxbrit.co.uk>
188
189   * Apply most of Rene's patch and fix various plugins.
190         * New plugin: autoop (auto ops via hostmask)
191         * New feature: karmastats
192
193 Wed Oct 13 16:16:31 BST 2004  Tom Gilbert <tom@linuxbrit.co.uk>
194
195   * Fix bug with quotes plugin where it gets confused and sees both a quote
196   and a keyword, both plugins are triggered by, for example "addquote foo is
197   bar"
198   * fixed this by implementing the "has_responded" flag on a message. When a
199   plugin replied to a message (or it manually sets m.replied to true), the
200   keywords plugin will honour that flag and not examine the message for
201   keywords. This flag can also be checked by listen plugins that don't want to
202   interfere with other plugin commands.
203
204 Mon Oct 11 00:37:52 BST 2004  Tom Gilbert <tom@linuxbrit.co.uk>
205
206   * Fixes to the NickServ plugin
207
208 Sat Oct 09 23:23:24 BST 2004  Tom Gilbert <tom@linuxbrit.co.uk>
209
210   * Keyword searching
211
212 Fri Oct 08 00:40:07 BST 2004  Tom Gilbert <tom@linuxbrit.co.uk>
213
214   * fixed insult plugin
215   * fixed excuse plugin
216
217 Thu Oct 07 23:28:05 BST 2004  Tom Gilbert <tom@linuxbrit.co.uk>
218
219   * searching for urls in the url plugin
220   * roshambo (rock/paper/scissors) plugin from Hans Fugal <hans@fugal.net>
221
222 Sat Apr 17 20:56:50 BST 2004  Tom Gilbert <tom@linuxbrit.co.uk>
223
224   * Oh, found new tv plugin in my inbox from ages ago, but it's still not
225   working so I guess it changed again since then
226   * New eightball plugin from Daniel Free
227
228 Sat Apr 17 20:44:43 BST 2004  Tom Gilbert <tom@linuxbrit.co.uk>
229
230   * Fixed the babelfish parser so translate works again.
231   * Misc other fixes
232   * Note some plugins are broken (excuse,insult) because the server they use
233     went away. I don't know of a replacement right now.
234   * tv plugin seems broken, perhaps the html changed.
235
236 Thu Jan 15 21:37:38 GMT 2004  Tom Gilbert <tom@linuxbrit.co.uk>
237
238   * Fixes for ruby 1.8
239
240 0.9.8
241 * new plugin from Alan Third <alan@idiocy.org>, allows you to search and list
242   UK TV programmes.
243
244 0.9.7
245 * various plugin updates
246 * fix (again) for C to F temp conversion in weather plugin
247 * channel topic patch from Peter Suschlik, gives plugin better access to topic
248   changes and related information
249
250 0.9.6
251 * changes to layout of slashdot plugin output
252 * freshmeat plugin, show latest updates or search
253 * fix to C to F temp conversion in weather plugin
254 * status command returns some bot status
255 * fortune plugin
256 * using BDB::Btree everywhere now, instead of BDB::Hash, because the Btree api
257   allows me to set my own key comparison function. This is needed to keep
258   supporting case insensitivity (vital for IRC), which was sadly broken in
259   0.9.5 :( All existing dbs will be upgraded automatically.
260 * roulette plugin - play russian roulette :) also keeps game stats.
261 * new config option, NO_KEYWORD_ADDRESS. If set to "true", the bot will always
262   respond to keywords it knows even when not addressed and the message doesn't
263   start with '. Message must end with "?" however.
264 * hopefully fixed welcome message parsing from certain server types
265
266 0.9.5
267 * plugin object registry
268   This provides persistant storage for plugins via a hash interface. The
269   default mode is an object store, so you can store ruby objects and reference
270   them with hash keys. This is because the default store/restore methods of
271   the plugins' RegistryAccessor are calls to Marshal.dump and Marshal.restore,
272   for example:
273     blah = Hash.new
274     blah[:foo] = "fum"
275     @registry[:blah] = blah
276   then, even after the bot is shut down and disconnected, on the next run you
277   can access the blah object as it was, with:
278     blah = @registry[:blah]
279   The registry can of course be used to store simple strings, fixnums, etc as
280   well, and should be useful to store or cache plugin data or dynamic plugin
281   configuration. 
282
283   If you don't need to store objects, and strictly want a persistant hash of
284   strings, you can override the store/restore methods to suit your needs, for
285   example (in your plugin):
286     def initialize
287       class << @registry
288         def store(val)
289           val
290         end
291         def restore(val)
292           val
293         end
294       end
295     end
296   Your plugins section of the registry is private, it has its own namespace
297   (derived from the plugin's class name, so change it and lose your data).
298   Calls to registry.each etc, will only iterate over your namespace.
299
300   The nickserv and karma plugins use the new registry and should serve as a
301   useful example. Basic usage of the registry is simple, just treat it as a
302   hash, with values that never die (unless you delete() them).
303 * Change to the nickserv plugin. The old method of putting the nickserv
304   password in rbot.conf was useless for multiple nicks or easy updates. The
305   plugin now uses the plugin registry to store passwords for any nicks it
306   owns. The plugin can be told to register the current nick (supply a password
307   or it'll generate one), identify for the current nick (if the password is
308   known), and can be told the passwords for other nicks. If NickServ asks the
309   bot to identify, it will automatically do so if it knows the appropriate
310   password.
311 * karma plugin now uses the plugin registry, it should automatically import
312   your existing, stored karma data into the registry.
313 * The babelfish plugin now caches results in the bot registry to speed up
314   common lookups.
315 * New message types and plugin methods to grab them,
316   quit(QuitMessage):   Called when a user (or the bot) quits IRC
317   nick(NickMessage):   Called when a user (or the bot) changes Nick
318   topic(TopicMessage): Called when a user (or the bot) changes a channel topic
319 * A plugin's listen() method will now receive any kind of Message, e.g.
320   PrivMessage, NoticeMessage, NickMessage, JoinMessage, etc
321 * New plugins:
322   seen: the usual "seen" stuff: 
323         rbot: seen giblet?
324         giblet was last seen xxx ago doing xxx
325   cal:  calls the unix cal program to display a calendar
326   math: evaluates mathematical expressions:
327         rbot: math 2+2
328         rbot: math 4 to the power of 8
329         rbot: math ((232+432) - 4) / 2
330         (ported from infobot. Thanks to Kevin Lenzo, who wrote the
331         original infobot math module)
332   slashdot: displays latest headlines or searches for articles
333   url:  stores urls mentioned in channels for regurgitation later
334   weather: grabs and parses METAR weather data, will remember the last weather
335            code you asked for so you don't have to :)
336 * New utility function, Util.http_get(url) for getting remote data via http,
337   just dumps response.body into a string and returns it, or nil if anything at
338   all goes wrong. Useful for simple plugins.
339 * random quit messages if none specified, messages set in language description
340   file
341 * keywords are now stored in bdb databases - your old keywords.rbot will be
342   imported. Static keywords (fact packs) are also stored in bdb databases, and
343   rbot will automatically convert any text .fact file dropped in the confdir's
344   keywords subdirectory, at startup, into a bdb file. If both a db and a text
345   file exist of the same name (except the extension), the text file will be
346   imported and merged into the database.
347   static keywords will be looked up in each factpack db in turn, in
348   alphabetical filename order - so you can prioritise using the filename if
349   you wish.
350 * fixed a bug with autsplitting long sent lines, the last line was often being
351   split unnecessarily.
352
353 0.9.4
354 * Massive cleanup of rfc2812.rb, contributed by Lars Christensen
355   <dsl8950@vip.cybercity.dk>, gets rid of a lot of regexps
356 * Fixed bug reading static keyword files - "foo <=is=> bar" may not have
357   worked for a couple of releases, only "foo<=is=>bar" was working - this was
358   not intended and should be fixed now
359 * Experimental send queue, to prevent the bot from flooding out, the delay
360   between sending messages to the server defaults to 2s, but is configurable
361   in conf.rbot, set SENDQ_DELAY (0 to disable queueing). You can also set/get
362   the value from the bot, "rbot: options get sendq_delay", and 
363   "rbot: options set sendq_delay 1.5", if you have sufficient auth for "config"
364   This is a bursting sendq, most ircd's allow bursts of up to 5
365   lines, with non-burst limits of 512 bytes/2 seconds. To set the burst limit,
366   configure SENDQ_BURST in conf.rbot, or do the same kind of stuff with
367   "rbot: options set sendq_burst 2", etc.
368   The defaults are 2s/4 burst, which seem to work okay for me.
369 * support for multiple, customisable, addressing prefixes. Set ADDRESS_PREFIX
370   in conf.rbot to a space separate list of addressing prefixes, e.g
371   ADDRESS_PREFIX = | ! =>
372   Would mean that all of the following in channel messages would cause the bot
373   to respond:
374               rbot: version
375               |version
376               !version
377               =>version
378 * bb plugin removed, bb is nearly over and it doesn't work 100% anyway
379 * Two plugins from brailsmt (from #ruby-lang on openprojects), a stats plugin
380   which monitors usage of 1-word sentences, and lart, which allows you to ask
381   rbot to lart people - with an optional reason - larts are user-definable and
382   can be added on the fly.
383 * made google.rb work for people with 1.6 ruby's net/http
384
385 0.9.3
386
387 * fix quit messages
388 * new plugin for handling nickserv-protected nicks, use NICKSERV_PASSWORD in
389   the config file.
390 * fixes to a few other buglets
391 * new plugin to grab bigbrother headlines, still buggy and only useful for UK
392   folks who love bb :-)
393 * fixes to various plugins
394 * Patch from akira yamada <akira@ruby-lang.org>
395   DNS plugin: Use resolv-replace if found, do lookup in new thread
396   Fix bug joining channels with keys
397
398 0.9.2
399
400 * better "connect failure" error message
401 * better option parsing, and --debug option
402 * access to bot's online help via commandline, eg:
403   ./rbot.rb --help
404   ./rbot.rb --help core
405   ./rbot.rb --help "core save"
406 * Fix broken help from last point release
407 * Plugin API modification and cleanup. You no longer need to set @listen to
408   true in order to get all NOTICE and PRIVMSGs, you just need to define the
409   method. The method is now called listen(), renamed from listener(). This
410   should be the last time the plugin api is changed incompatibly.
411 * New plugin method kick(). Use it to see kicks (duh :))
412 * New plugin methods join(), part(). Obvious uses.
413 * Example plugin autorejoin.rb, uses kick event to rejoin channel and insult
414   kicker
415 * fix bug in remind plugins "remind me no more" recognition.
416
417 0.9.1
418
419 * Fix welcome message recognition for certain IRCd's.
420
421 0.9
422
423 * Allow keyword definitions which end in '?', like this:
424   bot: foo is bar\?
425 * rdoc documentation!
426 * fixed broken address regexp, "rbot: .foo" was being treated as an addressed
427   form of "foo" (lost the .)
428 * fix stupid bug in last release (looking for wrong default conf dir)
429
430 0.8
431
432 * Tarball layout change. modules all in rbot/ now, and the rbot/ default
433   configuration moved to rbotconf/. This lets the thing run from an unpacked
434   tarball while also being ready to run with the modules installed somewhere
435   else.
436 * change hashbang to /usr/bin/env ruby, in order to use PATH looking for ruby,
437   it's BSD friendly!
438 * allow "botnick : foo" style addressing, and even "botnick... foo"
439 * slap plugin (contributed by oct)
440 * renamed bot.send to bot.sendmsg, I didn't really want to override send() ;D
441   (thanks Kero)
442
443 0.7.1
444 * Made sane for packagers. Looks in the right places for plugins and language
445   files now, so extra effort shouldn't be needed there.
446
447 0.7
448
449 * Fixed "nick taken on join" bug
450 * Dice plugin patch from David Dorward
451 * fix searchquote regexp
452 * conf.rbot: PASSWORD -> SERVER_PASSWORD, to prevent confusion with PASSWD,
453   which is for master auth.
454
455 0.6
456
457 * Fixed addquote (was incrementing quote ID twice)
458 * now strips colour/bold escapes from incoming messages (rbot was ignoring
459   messages addressed using a bolded colon, for example).
460 * minor bugfixes
461 * more language breadth
462 * Addressing works better now
463 * Can autojoin channels with keys, conf.rbot line is:
464   autojoin_channels #chan1, #chan2, #chan3 key, #chan4 key, #chan5
465 * dice plugin fixes
466
467 0.5
468
469 * Initial release