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