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