This is the traditional "fix announcement after tagging and releasing the tarball...
[privoxy.git] / doc / webserver / announce.txt
1               Announcing Privoxy v.3.0.16 stable
2 -----------------------------------------------------------------
3
4 This is the first stable release since 3.0.12. It mainly contains
5 bugfixes for the previous betas which introduced IPv6 support,
6 improved keep-alive support and a bunch of minor improvements.
7
8 See http://www.privoxy.org/3.0.16/user-manual/whatsnew.html for details.
9
10 --------------------------------------------------------------------
11 ChangeLog for Privoxy
12 --------------------------------------------------------------------
13 *** Version 3.0.16 stable ***
14
15 - Added the config file option handle-as-empty-doc-returns-ok to
16   work around Firefox bug #492459, which causes Firefox to hang
17   if JavaScripts are blocked in certain situations. The option is
18   enabled in the default config file.
19 - Added the config file option default-server-timeout to control the
20   assumed default server timeout. Since Privoxy no longer returns
21   an error message for connection resets on reused client connections,
22   assuming larger server timeout values appears to actually work
23   pretty well as long as connections aren't shared.
24 - Added optional support for FreeBSD's accf_http(9). Use the
25   configure option --enable-accept-filter to enable it.
26 - Added fancier Privoxy icons for win32. Contributed by Jeff H.
27 - In daemon mode, fd 0, 1 and 2 are bound to /dev/null.
28 - Resolve localhost using whatever address family the operating
29   system feels like. Previous betas would try to use IPv4 as this
30   is what most users expect, but this didn't work reliably on
31   GNU/Linux systems.
32 - In the action lists on CGI pages, actions and their parameters are
33   no longer separated with a space. The action file parser doesn't
34   actually allow this and will throw an invalid syntax error if actions
35   and parameters in the action files are separated. Not adding the
36   spaces means copy and pasting CGI output into the action files works.
37 - The default keep-alive timeout has been reduced to 5 seconds to work
38   around hangs in clients that treat the proxy like any other host and
39   stop allowing any new connections if the "maximum number of
40   connections per host" is reached.
41 - Several webbug URLs that look like they are leading to images are now
42   blocked as image instead of empty documents. Doing the latter causes
43   WebKit-based clients to show a "missing image" icon which may mess up
44   the layout.
45 - The no-such-domain template is used for DNS resolution
46   problems with FEATURE_IPV6_SUPPORT enabled. Previously the
47   connect-failed template was used. Reported by 'zebul666'.
48 - Accepts quoted expiration dates even though RFC 2109 10.1.2
49   doesn't seem to allow them. Reported anonymously.
50 - Don't try to forget connections if connection sharing is disabled.
51   This wasn't a real problem but caused an unnecessary log message.
52 - The still undocumented --enable-extended-host-patterns configure
53   option has a better description.
54 - Fixed an error message that would claim a write to the server
55   failed when actually writing to the client failed.
56 - Log the crunch reason before trying to write to the client.
57   The log is easier to read that way.
58 - Several log messages about client connections also mention
59   the socket number.
60 - handle-as-empty-document no longer depends on the image blocking
61   code being enabled.
62 - Privoxy-Log-Parser is roughly 40% faster in highlighting mode.
63 - uagen, a Firefox User-Agent generator for Privoxy and Mozilla
64   browsers has been imported and is available in the tarball's
65   tools directory.
66 - The scripts in the tools directory treat unknown parameters
67   as fatal errors.
68
69 *** Version 3.0.15 beta ***
70
71 - In case of missing server data, no error message is send to the
72   client if the request arrived on a reused connection. The client
73   is then supposed to silently retry the request without bothering
74   the user. This should significantly reduce the frequency of the
75   "No server or forwarder data received" error message many users
76   reported.
77 - More reliable detection of prematurely closed client sockets
78   with keep-alive enabled.
79 - FEATURE_CONNECTION_KEEP_ALIVE is decoupled from
80   FEATURE_CONNECTION_SHARING and now available on
81   all platforms.
82 - Improved handling of POST requests on reused connections.
83   Should fix problems with stalled connections after submitting
84   form data with some browser configurations.
85 - Fixed various latency calculation issues.
86 - Allows the client to pass NTLM authentication requests to a
87   forwarding proxy. This was already assumed and hinted to work
88   in 3.0.13 beta but actually didn't. Now it's confirmed to work
89   with IE, Firefox and Chrome.
90   Thanks to Francois Botha and Wan-Teh Chang
91 - Fixed a calculation problem if receiving the server headers
92   takes more than two reads, that could cause Privoxy to terminate
93   the connection prematurely. Reported by Oliver.
94 - Compiles again on platforms such as OpenBSD and systems
95   using earlier glibc version that don't support AI_ADDRCONFIG.
96   Anonymously submitted in #2872591.
97 - A bunch of MS VC project files and Suse and Redhat RPM spec
98   files have been removed as they were no longer maintained for
99   quite some time.
100 - Overly long action lines are properly rejected with a proper
101   error message. Previously they would be either rejected as
102   invalid or cause a core dump through abort().
103 - Already timed-out connections are no longer temporarily remembered.
104   They weren't reused anyway, but wasted a socket slot.
105 - len refers to the number of bytes actually read which might
106   differ from the ones received. Adjust log messages accordingly.
107 - The optional JavaScript on the CGI page uses encodeURIComponent()
108   instead of escape() which doesn't encode all characters that matter.
109   Anonymously reported in #2832722.
110 - Fix gcc45 warnings in decompress_iob().
111 - Various log message improvements.
112 - Privoxy-Regression-Test supports redirect tests.
113 - Privoxy-Log-Parser can gather some connection statistics.
114
115 *** Version 3.0.14 beta ***
116
117 - The latency is taken into account when evaluating whether or not to
118   reuse a connection. This should significantly reduce the number of
119   connections problems several users reported.
120 - If the server doesn't specify how long the connection stays alive,
121   Privoxy errs on the safe side of caution and assumes it's only a second.
122 - The error pages for connection timeouts or missing server data use a
123   Last-Modified date in the past. Retry attempts are detected and Privoxy
124   removes the If-Modified-Since header to prevent the server from responding
125   with status code 304 in which case the client would reuse the error message.
126 - Setting keep-alive-timeout to 0 disables keep-alive support. Previously
127   Privoxy would claim to allow persistence but not reuse the connection.
128 - Pipelined requests are less likely to be mistaken for the request
129   body of the previous request. Note that Privoxy still has no real
130   pipeline support and will either serialize pipelined requests or
131   drop them in which case the client has to resent them.
132 - Fixed a crash on some Windows versions when header randomization
133   is enabled and the date couldn't be parsed.
134 - Privoxy's keep-alive timeout for the current connection is reduced
135   to the one specified in the client's Keep-Alive header.
136 - For HTTP/1.1 requests, Privoxy implies keep-alive support by not
137   setting any Connection header instead of using 'Connection: keep-alive'.
138 - If the socket isn't reusable, Privoxy doesn't temporarily waste
139   a socket slot to remember the connection.
140 - If keep-alive support is disabled but compiled in, the client's
141   Keep-Alive header is removed.
142 - Fixed a bug on mingw32 where downloading large files failed if
143   keep-alive support was enabled.
144 - Fixed a bug that (at least theoretically) could cause log
145   timestamps to be occasionally off by about a second.
146 - No Proxy-Connection header if added if there already is one.
147 - The configure script respects the $PATH variable when searching
148   for groups and id.
149
150 *** Version 3.0.13 beta ***
151
152 - Added IPv6 support. Thanks to Petr Pisar who not only provided
153   the initial patch but also helped a lot with the integration.
154 - Added client-side keep-alive support.
155 - The connection sharing code is only used if the connection-sharing
156   option is enabled.
157 - The max-client-connections option has been added to restrict
158   the number of client connections below a value enforced by
159   the operating system.
160 - Fixed a regression reintroduced in 3.0.12 that could cause
161   crashes on mingw32 if header date randomization was enabled.
162 - Compressed content with extra fields couldn't be decompressed
163   and would get passed to the client unfiltered. This problem
164   has only be detected through statical analysis with clang as
165   nobody seems to be using extra fields anyway.
166 - If the server resets the Connection after sending only the headers
167   Privoxy forwards what it got to the client. Previously Privoxy
168   would deliver an error message instead.
169 - Error messages in case of connection timeouts use the right
170   HTTP status code.
171 - If spawning a child to handle a request fails, the client
172   gets an error message and Privoxy continues to listen for
173   new requests right away.
174 - The error messages in case of server-connection timeouts or
175   prematurely closed server connections are now template-based.
176 - If zlib support isn't compiled in, Privoxy no longer tries to
177   filter compressed content unless explicitly asked to do so.
178 - In case of connections that are denied based on ACL directives,
179   the memory used for the client IP is no longer leaked.
180 - Fixed another small memory leak if the client request times out
181   while waiting for client headers other than the request line.
182 - The client socket is kept open until the server socket has
183   been marked as unused. This should increase the chances that
184   the still-open connection will be reused for the client's next
185   request to the same destination. Note that this only matters
186   if connection-sharing is enabled.
187 - A TODO list has been added to the source tarball to give potential
188   volunteers a better idea of what the current goals are.
189
190 -----------------------------------------------------------------
191 About Privoxy:
192 -----------------------------------------------------------------
193
194 Privoxy is a non-caching web proxy with advanced filtering capabilities for
195 enhancing privacy, modifying web page data and HTTP headers, controlling
196 access, and removing ads and other obnoxious Internet junk. Privoxy has a
197 flexible configuration and can be customized to suit individual needs and
198 tastes. It has application for both stand-alone systems and multi-user
199 networks.
200
201 Privoxy is Free Software and licensed under the GNU GPLv2.
202
203 Privoxy is an associated project of Software in the Public Interest (SPI).
204
205 Helping hands and donations are welcome:
206
207   * http://www.privoxy.org/faq/general.html#PARTICIPATE
208
209   * http://www.privoxy.org/faq/general.html#DONATE
210
211 At present, Privoxy is known to run on Windows(95, 98, ME, 2000,
212 XP, Vista), Linux (Ubuntu, RedHat, SuSE, Debian, Fedora, Gentoo and
213 others), Mac OSX, OS/2, AmigaOS, FreeBSD, NetBSD, OpenBSD, Solaris, and
214 various other flavors of Unix.
215
216 In addition to the core features of ad blocking and cookie management,
217 Privoxy provides many supplemental features, that give the end-user
218 more control, more privacy and more freedom:
219
220
221     *  Supports "Connection: keep-alive". Outgoing connections can be kept
222        alive independently from the client. Currently not available on all
223        platforms.
224
225     *  Supports IPv6, provided the operating system does so too,
226        and the configure script detects it.
227
228     *  Supports tagging which allows to change the behaviour based on client
229        and server headers.
230
231     *  Can be run as an "intercepting" proxy, which obviates the need to
232        configure browsers individually.
233
234     *  Sophisticated actions and filters for manipulating both server and
235        client headers.
236
237     *  Can be chained with other proxies.
238
239     *  Integrated browser based configuration and control utility at
240        http://config.privoxy.org/ (shortcut: http://p.p/). Browser-based
241        tracing of rule and filter effects. Remote toggling.
242
243     *  Web page filtering (text replacements, removes banners based on size,
244        invisible <quote>web-bugs</quote> and HTML annoyances, etc.)
245
246     *  Modularized configuration that allows for standard settings and user
247        settings to reside in separate files, so that installing updated actions
248        files won't overwrite individual user settings.
249
250     *  Support for Perl Compatible Regular Expressions in the configuration
251        files, and a more sophisticated and flexible configuration syntax.
252
253     *  GIF de-animation.
254
255     *  Bypass many click-tracking scripts (avoids script redirection).
256
257     *  User-customizable HTML templates for most proxy-generated pages (e.g.
258        "blocked" page).
259
260     *  Auto-detection and re-reading of config file changes.
261     
262     *  Most features are controllable on a per-site or per-location basis.
263     
264
265 Download location: 
266    http://sourceforge.net/project/showfiles.php?group_id=11118
267  
268 Home Page: 
269    http://www.privoxy.org/
270
271
272   - Privoxy Developers <ijbswa-developers@lists.sourceforge.net>