This is the traditional "fix announcement after tagging and releasing the tarball...
[privoxy.git] / doc / webserver / announce.txt
index 4f46196..98afc45 100644 (file)
-                 Announcing Privoxy v.3.0.12
+              Announcing Privoxy v.3.0.16 stable
 -----------------------------------------------------------------
 
 -----------------------------------------------------------------
 
-Privoxy 3.0.12-stable is primarily a bugfix release.
+This is the first stable release since 3.0.12. It mainly contains
+bugfixes for the previous betas which introduced IPv6 support,
+improved keep-alive support and a bunch of minor improvements.
 
 
-See http://www.privoxy.org/3.0.12/user-manual/whatsnew.html for details.
+See http://www.privoxy.org/3.0.16/user-manual/whatsnew.html for details.
 
 --------------------------------------------------------------------
 ChangeLog for Privoxy
 --------------------------------------------------------------------
 
 --------------------------------------------------------------------
 ChangeLog for Privoxy
 --------------------------------------------------------------------
-*** Version 3.0.12  ***
-
-- The socket-timeout option now also works on platforms whose
-  select() implementation modifies the timeout structure.
-  Previously the timeout was triggered even if the connection
-  didn't stall. Reported by cyberpatrol.
-- The Connection: keep-alive code properly deals with files
-  larger than 2GB. Previously the connection was closed too
-  early.
-- The content length for files above 2GB is logged correctly.
-- The user-manual directive on the show-status page links to
-  the documentation location specified with the directive,
-  not to the Privoxy website.
-- When running in daemon mode, Privoxy doesn't log anything
-  to the console unless there are errors before the logfile
-  has been opened.
-- The show-status page prints warnings about invalid directives
-  on the same line as the directives themselves.
-- Fixed several justified (but harmless) compiler warnings,
-  mostly on 64 bit platforms.
-- The mingw32 version explicitly requests the default charset
-  to prevent display problems with some fonts available on more
-  recent Windows versions. Patch by Burberry.
-- The mingw32 version uses the Privoxy icon in the alt-tab
-  windows. Patch by Burberry.
-- The timestamp and the thread id is omitted in the "Fatal error"
-  message box on mingw32.
-- Fixed two related mingw32-only buffer overflows. Triggering
-  them required control over the configuration file, therefore
-  this isn't seen as a security issue.
-- In verbose mode, or if the new option --show-skipped-tests
-  is used, Privoxy-Regression-Test logs skipped tests and the
-  skip reason.
+*** Version 3.0.16 stable ***
 
 
+- Added the config file option handle-as-empty-doc-returns-ok to
+  work around Firefox bug #492459, which causes Firefox to hang
+  if JavaScripts are blocked in certain situations. The option is
+  enabled in the default config file.
+- Added the config file option default-server-timeout to control the
+  assumed default server timeout. Since Privoxy no longer returns
+  an error message for connection resets on reused client connections,
+  assuming larger server timeout values appears to actually work
+  pretty well as long as connections aren't shared.
+- Added optional support for FreeBSD's accf_http(9). Use the
+  configure option --enable-accept-filter to enable it.
+- Added fancier Privoxy icons for win32. Contributed by Jeff H.
+- In daemon mode, fd 0, 1 and 2 are bound to /dev/null.
+- Resolve localhost using whatever address family the operating
+  system feels like. Previous betas would try to use IPv4 as this
+  is what most users expect, but this didn't work reliably on
+  GNU/Linux systems.
+- In the action lists on CGI pages, actions and their parameters are
+  no longer separated with a space. The action file parser doesn't
+  actually allow this and will throw an invalid syntax error if actions
+  and parameters in the action files are separated. Not adding the
+  spaces means copy and pasting CGI output into the action files works.
+- The default keep-alive timeout has been reduced to 5 seconds to work
+  around hangs in clients that treat the proxy like any other host and
+  stop allowing any new connections if the "maximum number of
+  connections per host" is reached.
+- Several webbug URLs that look like they are leading to images are now
+  blocked as image instead of empty documents. Doing the latter causes
+  WebKit-based clients to show a "missing image" icon which may mess up
+  the layout.
+- The no-such-domain template is used for DNS resolution
+  problems with FEATURE_IPV6_SUPPORT enabled. Previously the
+  connect-failed template was used. Reported by 'zebul666'.
+- Accepts quoted expiration dates even though RFC 2109 10.1.2
+  doesn't seem to allow them. Reported anonymously.
+- Don't try to forget connections if connection sharing is disabled.
+  This wasn't a real problem but caused an unnecessary log message.
+- The still undocumented --enable-extended-host-patterns configure
+  option has a better description.
+- Fixed an error message that would claim a write to the server
+  failed when actually writing to the client failed.
+- Log the crunch reason before trying to write to the client.
+  The log is easier to read that way.
+- Several log messages about client connections also mention
+  the socket number.
+- handle-as-empty-document no longer depends on the image blocking
+  code being enabled.
+- Privoxy-Log-Parser is roughly 40% faster in highlighting mode.
+- uagen, a Firefox User-Agent generator for Privoxy and Mozilla
+  browsers has been imported and is available in the tarball's
+  tools directory.
+- The scripts in the tools directory treat unknown parameters
+  as fatal errors.
+
+*** Version 3.0.15 beta ***
+
+- In case of missing server data, no error message is send to the
+  client if the request arrived on a reused connection. The client
+  is then supposed to silently retry the request without bothering
+  the user. This should significantly reduce the frequency of the
+  "No server or forwarder data received" error message many users
+  reported.
+- More reliable detection of prematurely closed client sockets
+  with keep-alive enabled.
+- FEATURE_CONNECTION_KEEP_ALIVE is decoupled from
+  FEATURE_CONNECTION_SHARING and now available on
+  all platforms.
+- Improved handling of POST requests on reused connections.
+  Should fix problems with stalled connections after submitting
+  form data with some browser configurations.
+- Fixed various latency calculation issues.
+- Allows the client to pass NTLM authentication requests to a
+  forwarding proxy. This was already assumed and hinted to work
+  in 3.0.13 beta but actually didn't. Now it's confirmed to work
+  with IE, Firefox and Chrome.
+  Thanks to Francois Botha and Wan-Teh Chang
+- Fixed a calculation problem if receiving the server headers
+  takes more than two reads, that could cause Privoxy to terminate
+  the connection prematurely. Reported by Oliver.
+- Compiles again on platforms such as OpenBSD and systems
+  using earlier glibc version that don't support AI_ADDRCONFIG.
+  Anonymously submitted in #2872591.
+- A bunch of MS VC project files and Suse and Redhat RPM spec
+  files have been removed as they were no longer maintained for
+  quite some time.
+- Overly long action lines are properly rejected with a proper
+  error message. Previously they would be either rejected as
+  invalid or cause a core dump through abort().
+- Already timed-out connections are no longer temporarily remembered.
+  They weren't reused anyway, but wasted a socket slot.
+- len refers to the number of bytes actually read which might
+  differ from the ones received. Adjust log messages accordingly.
+- The optional JavaScript on the CGI page uses encodeURIComponent()
+  instead of escape() which doesn't encode all characters that matter.
+  Anonymously reported in #2832722.
+- Fix gcc45 warnings in decompress_iob().
+- Various log message improvements.
+- Privoxy-Regression-Test supports redirect tests.
+- Privoxy-Log-Parser can gather some connection statistics.
+
+*** Version 3.0.14 beta ***
+
+- The latency is taken into account when evaluating whether or not to
+  reuse a connection. This should significantly reduce the number of
+  connections problems several users reported.
+- If the server doesn't specify how long the connection stays alive,
+  Privoxy errs on the safe side of caution and assumes it's only a second.
+- The error pages for connection timeouts or missing server data use a
+  Last-Modified date in the past. Retry attempts are detected and Privoxy
+  removes the If-Modified-Since header to prevent the server from responding
+  with status code 304 in which case the client would reuse the error message.
+- Setting keep-alive-timeout to 0 disables keep-alive support. Previously
+  Privoxy would claim to allow persistence but not reuse the connection.
+- Pipelined requests are less likely to be mistaken for the request
+  body of the previous request. Note that Privoxy still has no real
+  pipeline support and will either serialize pipelined requests or
+  drop them in which case the client has to resent them.
+- Fixed a crash on some Windows versions when header randomization
+  is enabled and the date couldn't be parsed.
+- Privoxy's keep-alive timeout for the current connection is reduced
+  to the one specified in the client's Keep-Alive header.
+- For HTTP/1.1 requests, Privoxy implies keep-alive support by not
+  setting any Connection header instead of using 'Connection: keep-alive'.
+- If the socket isn't reusable, Privoxy doesn't temporarily waste
+  a socket slot to remember the connection.
+- If keep-alive support is disabled but compiled in, the client's
+  Keep-Alive header is removed.
+- Fixed a bug on mingw32 where downloading large files failed if
+  keep-alive support was enabled.
+- Fixed a bug that (at least theoretically) could cause log
+  timestamps to be occasionally off by about a second.
+- No Proxy-Connection header if added if there already is one.
+- The configure script respects the $PATH variable when searching
+  for groups and id.
+
+*** Version 3.0.13 beta ***
+
+- Added IPv6 support. Thanks to Petr Pisar who not only provided
+  the initial patch but also helped a lot with the integration.
+- Added client-side keep-alive support.
+- The connection sharing code is only used if the connection-sharing
+  option is enabled.
+- The max-client-connections option has been added to restrict
+  the number of client connections below a value enforced by
+  the operating system.
+- Fixed a regression reintroduced in 3.0.12 that could cause
+  crashes on mingw32 if header date randomization was enabled.
+- Compressed content with extra fields couldn't be decompressed
+  and would get passed to the client unfiltered. This problem
+  has only be detected through statical analysis with clang as
+  nobody seems to be using extra fields anyway.
+- If the server resets the Connection after sending only the headers
+  Privoxy forwards what it got to the client. Previously Privoxy
+  would deliver an error message instead.
+- Error messages in case of connection timeouts use the right
+  HTTP status code.
+- If spawning a child to handle a request fails, the client
+  gets an error message and Privoxy continues to listen for
+  new requests right away.
+- The error messages in case of server-connection timeouts or
+  prematurely closed server connections are now template-based.
+- If zlib support isn't compiled in, Privoxy no longer tries to
+  filter compressed content unless explicitly asked to do so.
+- In case of connections that are denied based on ACL directives,
+  the memory used for the client IP is no longer leaked.
+- Fixed another small memory leak if the client request times out
+  while waiting for client headers other than the request line.
+- The client socket is kept open until the server socket has
+  been marked as unused. This should increase the chances that
+  the still-open connection will be reused for the client's next
+  request to the same destination. Note that this only matters
+  if connection-sharing is enabled.
+- A TODO list has been added to the source tarball to give potential
+  volunteers a better idea of what the current goals are.
 
 -----------------------------------------------------------------
 About Privoxy:
 
 -----------------------------------------------------------------
 About Privoxy:
@@ -54,7 +198,15 @@ flexible configuration and can be customized to suit individual needs and
 tastes. It has application for both stand-alone systems and multi-user
 networks.
 
 tastes. It has application for both stand-alone systems and multi-user
 networks.
 
-Privoxy is Free Software and licensed under the GPL2.
+Privoxy is Free Software and licensed under the GNU GPLv2.
+
+Privoxy is an associated project of Software in the Public Interest (SPI).
+
+Helping hands and donations are welcome:
+
+  * http://www.privoxy.org/faq/general.html#PARTICIPATE
+
+  * http://www.privoxy.org/faq/general.html#DONATE
 
 At present, Privoxy is known to run on Windows(95, 98, ME, 2000,
 XP, Vista), Linux (Ubuntu, RedHat, SuSE, Debian, Fedora, Gentoo and
 
 At present, Privoxy is known to run on Windows(95, 98, ME, 2000,
 XP, Vista), Linux (Ubuntu, RedHat, SuSE, Debian, Fedora, Gentoo and
@@ -66,7 +218,12 @@ Privoxy provides many supplemental features, that give the end-user
 more control, more privacy and more freedom:
 
 
 more control, more privacy and more freedom:
 
 
-    *  Can keep outgoing connections alive and reuse them later on.
+    *  Supports "Connection: keep-alive". Outgoing connections can be kept
+       alive independently from the client. Currently not available on all
+       platforms.
+
+    *  Supports IPv6, provided the operating system does so too,
+       and the configure script detects it.
 
     *  Supports tagging which allows to change the behaviour based on client
        and server headers.
 
     *  Supports tagging which allows to change the behaviour based on client
        and server headers.
@@ -84,8 +241,7 @@ more control, more privacy and more freedom:
        tracing of rule and filter effects. Remote toggling.
 
     *  Web page filtering (text replacements, removes banners based on size,
        tracing of rule and filter effects. Remote toggling.
 
     *  Web page filtering (text replacements, removes banners based on size,
-       invisible "web-bugs", JavaScript and HTML annoyances, pop-up windows,
-       etc.)
+       invisible <quote>web-bugs</quote> and HTML annoyances, etc.)
 
     *  Modularized configuration that allows for standard settings and user
        settings to reside in separate files, so that installing updated actions
 
     *  Modularized configuration that allows for standard settings and user
        settings to reside in separate files, so that installing updated actions
@@ -94,23 +250,16 @@ more control, more privacy and more freedom:
     *  Support for Perl Compatible Regular Expressions in the configuration
        files, and a more sophisticated and flexible configuration syntax.
 
     *  Support for Perl Compatible Regular Expressions in the configuration
        files, and a more sophisticated and flexible configuration syntax.
 
-    *  Improved cookie management features (e.g. session based cookies).
-
     *  GIF de-animation.
 
     *  Bypass many click-tracking scripts (avoids script redirection).
 
     *  GIF de-animation.
 
     *  Bypass many click-tracking scripts (avoids script redirection).
 
-    *  Multi-threaded (POSIX and native threads).
-
     *  User-customizable HTML templates for most proxy-generated pages (e.g.
        "blocked" page).
 
     *  Auto-detection and re-reading of config file changes.
     *  User-customizable HTML templates for most proxy-generated pages (e.g.
        "blocked" page).
 
     *  Auto-detection and re-reading of config file changes.
-
-    *  Improved signal handling, and a true daemon mode (Unix).
     
     
-    *  Every feature now controllable on a per-site or per-location basis,
-       configuration more powerful and versatile over-all.
+    *  Most features are controllable on a per-site or per-location basis.
     
 
 Download location: 
     
 
 Download location: