Update ancillary documentation for release
[clinton/bobotpp.git] / NEWS
1 (-*- text -*-)
2 User Visible Changes In Bobot++
3
4 IMPORTANT NOTES:
5 As of version 1.98 unknown_lamer is the new maintainer. Also as of
6 version 1.98, you must have Guile 1.5.6+ or 1.6.x in order to
7 compile scripting support.
8
9 As of version 2.2.0 no new updates are promised. I am splitting out
10 the Parser and a few other well written bits and using them from
11 Scheme to implement most of the Bobot++ functionality in pure
12 Scheme. The time spent maintaining this not terribly good C++ (a
13 good bit of which is my fault due to my inexperience when I began
14 maintaing Bobot++) is a waste to me now. I would rather be hacking
15 on a Lisp program instead.
16
17 I will still accept patches, and may fix bugs if I have time (and
18 people report them). I may finish the manual since the scripting
19 section is all that remains, and that will apply to the new bot as
20 well.
21
22 =====================================================================
23 ====== The News =====================================================
24 =====================================================================
25
26 Version 2.2.3 (2008-11-12):
27 - Building with Guile in a non-standard location now works
28 - Building without Guile now works again
29 - Building with GCC 4.x now works
30 + GCC prior to 4.x's libc headers exported the libc symbols from
31 both :: and std:: leading to a few unqualified libc calls sneaking
32 into Bobot++'s source
33 - All uses of the long deprecated GH API have been removed
34 + Building against libguile 1.8 built with --disable-deprecated now
35 works
36 + Building against Guile 1.6 likely no longer works
37 + However, building against guile-vm libguile does work and Bobot++
38 is the first application built this way
39 - This will be the last of the 2.2.x series; a 2.3.x series /might/ be
40 started to enhance the scripting interface and finish the manual
41
42 Version 2.2.2 (2006-06-28):
43 - No longer segfaults when loading bobot-utils.scm
44 - bot:match-to-me produces a valid regexp again
45 - scripts/uname now properly uses (ice-9 rdelim) instead of redelim
46 - bot:load now loads files properly
47
48 Version 2.2.1 (2006-06-28):
49 - If the log directory does not exist the bot creates it
50 - If there are lines with only whitespace on them in the config file
51 and error message is no longer printed to the log
52
53 Version 2.2.0 (2006-05-24):
54 - Scripting
55 + Hooks
56 * hooks/disconnect now takes an additonal argument that specifies
57 whether the disconnect was intentional or not.
58 * Added hooks/send/who
59 * Added hooks/send/whois
60 + The deprecated scripting procedure and hook names are now in a
61 `begin-deprecated' block. If your guile is built without
62 deprecated feature support, they will not be available.
63 + Renamed Functions
64 * bot:send-ctcp was renamed to bot:ctcp
65 * bot:send-ctcp-reply was renamed to bot:ctcp-reply
66 + New Functions
67 * bot:who (send WHO request)
68 * bot:whois (send WHOIS request)
69 + New Constants
70 * bot:shit/none, bot:shit/no-op, bot:shit/no-join,
71 bot:shit/no-deban shit list constants
72 - Documention
73 + Reorganized a few sections
74 + Every hook is now documented
75 + Using bot section is now much more usable
76 + Every config file is now documented
77 - The code was cleaned up a bit
78
79 Version 2.1.8:
80 - Scripting
81 + Hooks
82 * Added bot:protection/[none|ban|kick|deop] and bot:aop/[yes|no]
83 constants to the Scheme scripting interface
84 * hooks/timer argument is now zero padded instead of space padded
85 (e.g. "11:01" instead of "11: 1")
86 * hooks/disconnect is now called when the bot is disconnected from the
87 server unintentionally (network connection timeout, server died,
88 etc.)
89 * hooks/action is now passed the user's nick instead of the full
90 address like all other hooks
91 + Message Sending
92 * Implemented bot:notice
93 * bot:msg and bot:say may both send to channels and users (instead
94 of bot:msg for users and bot:say for channels)
95 * Renamed bot:send-CTCP to bot:send-ctcp
96 * Added bot:send-ctcp-reply to send a ctcp-reply
97 + Misc
98 * Added (bobotpp bot) module that modules may use to gain access
99 to the bobot++ functions
100 + Debugging
101 * The debugging evaluator is now enabled when --debug is passed to
102 the bot
103 * New command line option: --debug-scripts enables the debugging
104 evaluator while running everything else normally
105 * Merged error handling patch from Dale Smith. This adds detailed
106 errors and backtraces when --debug/--debug-scripts is passed to
107 Bobot++.
108 - Documentation
109 + Merged documentation patch from Dale Smith (thanks)
110 - Misc
111 + NOTICEs and PRIVMSGs are now sent correctly if they contain an
112 embedded newline
113 + Max nick length is now configurable via 'maxnicklength' option in
114 bot.conf (defaults to 9)
115 - The bot now builds with --disable-scripting again (this is my fault,
116 I haven't built without it in a long time)
117
118
119 Version 2.1.7:
120 - Fixed a number of small bugs and corner cases
121 - Should compile without warnings (GCC 3.4)
122
123 Version 2.1.6:
124 - The String class implementation has been redone and replaced by one
125 based on std::string (eventually String will be gone entirely, but
126 it a lot of work)
127 - Patches from Jos Hulzink <josh@stack.nl> were applied which fix a
128 few major bugs in the StringTokenizer (thanks)
129
130 Version 2.1.5: Cleanups
131 - A DCC CHAT with the bot may now only be initiated if the user is a
132 Friend of the bot
133 - Implemented bot:ctcp-quote
134 - The Bot Configuration section of the manual has been completed.
135 - Fixed a potential (but unlikely) buffer overflow in Utils::strToTime
136 (if there were more than 512 digits in part of the string form of
137 the time the buffer would overflow)
138 - Misc. Bugfixes
139
140 Version 2.1.4: DCC Support Enhancements
141 - Internal Change: DCCConnection is now an abstract class
142 - Internal Change: DCCChatConnection provides the functionality of
143 the old DCCConnection so that DCC FILE support can be added
144 - New Scheme Procedure: (bot:sent-to-me? message), checks to see if a
145 message was addressed to the bot. This is better than using
146 bot:match-to-me because the hook will continue to function if the
147 bot's nick changes. The only downside to using it is that there may
148 be an increased overhead of calling more hooks than could be called,
149 but that shouldn't be much of a problem.
150 - New Scheme Procedure: (bot:change-command-level command level),
151 changes the level a user command to allow a user of `level' level or
152 above to run it.
153
154 Version 2.1.3: Something
155 - The flood rate can now be set using !setfloodrate INTEGER. The
156 default is two messages per second before the bot will ignore
157 you. (thanks to Björn Gustavsson for requesting this)
158 - The flood rate may also be set from Scheme using (bot:setfloodrate
159 integer)
160 - A very large crash bug has been fixed. Previously, if an undefined
161 command was called, any attempts to call a subsequent command would
162 cause the bot to crash. Now the bot doesn't crash.
163
164 Version 2.1.2: Llama
165
166 - match-to-me and match-not-channel are now bot:match-to-me and
167 bot:match-not-channel. Just use perl -pi -e
168 "s/match-to-me/bot:match-to-me" SCRIPTS (change to match-not-channel
169 for match-not-channel).
170 - Each script is now loaded into its own module so namespace clashes
171 should no longer occur
172 - New procedure: (bot:load-module INTERFACE-SPEC) will load a "bot
173 module" with the specified INTERFACE-SPEC (e.g. (foo bar)). A bot
174 module is the same as a system module except that you don't use
175 define-module to define it. The %bot:loadpath is searched for
176 INTERFACE-SPEC (when converted to a string) with an extension in
177 %bot:load-extensions. E.g. (foo bar) becomes "foo/bar".
178 - New procedure: (bot:use-module INTERFACE-SPEC) is the same as
179 bot:load-module except it will make the exported bindings from
180 INTERFACE-SPEC available in the current-module.
181 - Updated example bot and new example scripts included with the bot.
182
183 Version 2.1.1: foom
184
185 - Host masks are now case insensitive when matched. At least one other
186 person thought this was a good idea since IRC is case preserving but
187 not case sensitive.
188 - You can now "name" a hook using an extra arg to bot:addhook. This
189 name can be used to have multiple hooks of the same type with the
190 same regexp. The default name is "DEFAULT" so don't use that as the
191 name for your hooks.
192 - Logging now works again (oops, I didn't realize I broke it until I
193 started to work on DCC).
194 - DCC CHAT now "works." You can connect to the bot and talk to to it
195 and use Scheme hooks to talk to the user.
196 - New hooks: hooks/dcc/chat-begin and hooks/dcc/chat-message. These
197 are called when a new DCC Chat begin and when the user sends a
198 message.
199 - New Function: bot:dcc-chat-send TO MESSAGE, sends a MESSAGE to the
200 person at address TO
201 - New hooks: hooks/send/... where ... is one of action, ctcp, public,
202 or message. These are triggered when the bot does an
203 ACTION, sends a CTCP (_not_ a ctcp-reply), sends a PRIVMSG to a
204 channel, or sends a PRIVMSG to another user, respectively. There
205 will be more send hooks added later.
206 - New hooks: hooks/dcc/chat-begin and
207 hooks/dcc/chat-message. chat-begin is called when the chat starts
208 and has one argument: the address (in user!nick@host
209 format). chat-message has two arguments: from (user!nick@host) and
210 message, which is the raw message (since there is no real protocol
211 for DCC). chat-start hooks are matched against the address and
212 chat-message hooks are matched against the text "ADDRESS MESSAGE"
213 where ADDRESS is the sender's address and MESSAGE is the message.
214
215 Version 2.1.0: Zug Zug
216 - Hooks can now be fallthrough or non fallthrough. You can set a hooks
217 priority and whether or not it falls through (i.e. continues hook
218 matching after it has been executed) using two optional args to
219 (bot-addhook). The new args are pri (integer priority) and fallthru
220 (#t or #f) and are at the end. Higher priority hooks are executed
221 before lower priority hooks, and fallthrough hooks are executed
222 before non-fallthrough hooks.
223 - The default config is read from ~/.bobotpp/config/default/ or
224 /etc/bobotpp/default/ if the user config is not found. Put your
225 default config in either dir. You may also specify a specific config
226 under these dirs using the --config or -c arg to bobotpp (see
227 bobotpp --help for the full list of commands you may use and how to
228 use them).
229 - Scripts are now stored in ~/.bobotpp/scripts/ or
230 PREFIX/share/bobotpp/scripts/ (where PREFIX is /usr/local unless you
231 changed it with the --prefix arg to configure). The new function
232 bot-load will take a filename and load it from these dirs, returning
233 #t if the file was loaded and #f if it wasn't. You can modify the
234 search list by appending to %bot-loadpath.
235 - bobot-utils.scm is now autoloaded, so you don't need to
236 load it if you want to use its functions.
237 - Logs are now in ~/.bobotpp/logs/
238 - bot-* procedures in Scheme are now bot:*. The old bot-* functions
239 are defined as aliases in bobot-utils.scm
240 - You can now use lambda's for new commands (oops, I wasn't protecting
241 the objects from garbage collection)
242
243
244 Version 2.0: Stable release / CVS merges
245 - Merged stuff from Etienne Bernard's dev tree that he was working on
246 before I took over (not much)
247 - bot-adduser and bot-addshit now work from Scheme
248
249 Version 1.99: Configure joy
250 - You can now disable scripting using --disable-scripting or
251 --enable-scripting=no
252 - Crypt can also be disabled with --disable-crypt or --enable-crypt=no
253 - Old hooks behavior has been restored (new hooks are added to the end
254 of the hooks list and processing does not stop at the first matched
255 hook). The hook behavior will change radically in 2.1.
256
257 Version 1.98: Unknown_lamer made a large number of changes
258 - Code is now ISO C++ and compiles with GCC 3.1
259 - Converted makefile system to use automake
260 - configure.ac now requires autoconf 2.50 (this is only a problem if
261 you modify it, but I should be the only one doing that)
262 - Transition to new Guile 1.6 API has begun
263 - Scripting must always be enabled for now (known "bug")
264 - first hook of a given type to match is the only hook executed, all
265 others are ignored. Note that the last hook to be registered is the
266 first in the list!
267
268
269 Version 1.97: lots of changes, especially guile's scripting support, which
270 is not yet documented. See in the scripts/ directory for
271 examples, and in Interp.C (the Startup() function) for the
272 list of all available commands.
273
274 Version 1.30: Syntax change for "channel =" in bot.conf. See examples/bot.conf.
275 Rewrite of ident/password system. Should be more secure and
276 flexible.