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