Consistently use 'client-specific tags' when referring to the new tag type
[privoxy.git] / doc / webserver / announce.txt
index 14cedb2..dc3de52 100644 (file)
-              Announcing Privoxy v.3.0.17 stable
------------------------------------------------------------------
-
-This is mainly a bug-fix release for the previously released Privoxy 3.0.16.
-
-It contains fixes for two bugs that could cause connections to hang under
-certain circumstances when keep-alive support was enabled, until they timed
-out or where closed by the server.
-
-See http://www.privoxy.org/3.0.17/user-manual/whatsnew.html for details.
+               Announcing Privoxy 3.0.25 beta
+--------------------------------------------------------------------
 
+Privoxy 3.0.25 beta introduces client-specific tags and includes
+a couple of minor improvements. It will be followed by a stable
+release in the near future.
 --------------------------------------------------------------------
 ChangeLog for Privoxy
 --------------------------------------------------------------------
-*** Version 3.0.17 Stable ***
-
-- Fixed last-chunk-detection for responses where the content was small
-  enough to be read with the body, causing Privoxy to wait for the
-  end of the content until the server closed the connection.
-  Reported by "Karsten" in #3028326.
-- Responses with status code 204 weren't properly detected as body-less
-  like RFC2616 mandates. Like the previous bug, this caused Privoxy
-  to wait for the end of the content until the server closed the connection.
-  Fixes #3022042 and #3025553, reported by a user with no visible name.
-  Most likely also fixes a bunch of other AJAX-related problem reports
-  that got closed in the past due to insufficient information and lack
-  of feedback.
-- Fixed an ACL bug that made it impossible to build a blacklist.
-  Usually the ACL directives are used in a whitelist, which worked
-  as expected, but blacklisting is still useful for public proxies
-  where one only needs to deny known abusers access.
-- Added LOG_LEVEL_RECEIVED to log the not-yet-parsed data read from the
-  network. This should make debugging various parsing issues a lot easier.
-- The IPv6 code is enabled by default on Windows versions that support it.
-  Patch submitted by oCameLo in #2942729.
-- In mingw32 versions, the user.filter file is reachable through the
-  GUI, just like default.filter is. Feature request 3040263.
-- Added the configure option --enable-large-file-support to set a few
-  defines that are required by platforms like GNU/Linux to support files
-  larger then 2GB. Mainly interesting for users without proper logfile
-  management.
-- Logging with "debug 16" no longer stops at the first nul byte which is
-  pretty useless. Non-printable characters are replaced with their hex value
-  so the result can't span multiple lines making parsing them harder then
-  necessary.
-- Privoxy logs when reading an action, filter or trust file.
-- Fixed incorrect regression test markup which caused a test in
-  3.0.16 to fail while Privoxy itself was working correctly.
-  While Privoxy accepts hide-referer, too, the action name is actually
-  hide-referrer which is also the name used one the final results page,
-  where the test expected the alias.
-
-- CGI interface improvements:
-  - In finish_http_response(), continue to add the 'Connection: close'
-    header if the client connection will not be kept alive.
-    Anonymously pointed out in #2987454.
-  - Apostrophes in block messages no longer cause parse errors
-    when the blocked page is viewed with JavaScript enabled.
-    Reported by dg1727 in #3062296.
-  - Fix a bunch of anchors that used underscores instead of dashes.
-  - Allow to keep the client connection alive after crunching the previous request.
-    Already opened server connections can be kept alive, too.
-  - In cgi_show_url_info(), don't forget to prefix URLs that only contain
-    http:// or https:// in the path. Fixes #2975765 reported by Adam Piggott.
-  - Show the 404 CGI page if cgi_send_user_manual() is called while
-    local user manual delivery is disabled.
+- Bug fixes:
+  - Always use the current toggle state for new requests.
+    Previously new requests on reused connections inherited
+    the toggle state from the previous request even though
+    the toggle state could have changed.
+    Reported by Robert Klemme.
+  - Fixed two buffer-overflows in the (deprecated) static
+    pcre code. These bugs are not considered security issues
+    as the input is trusted.
+    Found with afl-fuzz and ASAN.
+
+- General improvements:
+  - Added support for client-specific tags which allow Privoxy
+    admins to pre-define tags that are set for all requests from
+    clients that previously opted in through the CGI interface.
+    They are useful in multi-user setups where admins may
+    want to allow users to disable certain actions and filters
+    for themselves without affecting others.
+    In single-user setups they are useful to allow more fine-grained
+    toggling. For example to disable request blocking while still
+    crunching cookies, or to disable experimental filters only.
+    This is an experimental feature, the syntax and behaviour may
+    change in future versions.
+    Sponsored by Robert Klemme.
+  - Dynamic filters and taggers now support a $listen-address variable
+    which contains the address the request came in on.
+    For external filters the variable is called $PRIVOXY_LISTEN_ADDRESS.
+    Original patch contributed by pursievro.
+  - Add client-header-tagger 'listen-address'.
+  - Include the listen-address in the log message when logging new requests.
+    Patch contributed by pursievro.
+  - Turn invalid max-client-connections values into fatal errors.
+  - The show-status page now shows whether or not dates before 1970
+    and after 2038 are expected to be handled properly.
+    This is mainly useful for Privoxy-Regression-Test but could
+    also come handy when dealing with time-related support requests.
+  - On Mac OS X the thread id in log messages are more likely to
+    be unique now.
+  - When complaining about missing filters, the filter type is logged
+    as well.
+  - A couple of harmless coverity warnings were silenced
+    (CID #161202, CID #161203, CID #161211).
 
 - Action file improvements:
-  - Enable user.filter by default. Suggested by David White in #3001830.
-  - Block .sitestat.com/. Reported by johnd16 in #3002725.
-  - Block .atemda.com/. Reported by johnd16 in #3002723.
-  - Block js.adlink.net/. Reported by johnd16 in #3002720.
-  - Block .analytics.yahoo.com/. Reported by johnd16 in #3002713.
-  - Block sb.scorecardresearch.com, too. Reported by dg1727 in #2992652.
-  - Fix problems noticed on Yahoo mail and news pages.
-  - Remove the too broad yahoo section, only keeping the
-    fast-redirects exception as discussed on ijbswa-devel@.
-  - Don't block adesklets.sourceforge.net. Reported in #2974204.
-  - Block chartbeat ping tracking. Reported in #2975895.
-  - Tag CSS and image requests with cautious and medium settings, too.
-  - Don't handle view.atdmt.com as image. It's used for click-throughs
-    so users should be able to "go there anyway".
-    Reported by Adam Piggott in #2975927.
-  - Also let the refresh-tags filter remove invalid refresh tags where
-    the 'url=' part is missing. Anonymously reported in #2986382.
-    While at it, update the description to mention the fact that only
-    refresh tags with refresh times above 9 seconds are covered.
-  - javascript needs to be blocked with +handle-as-empty-document to
-    work around Firefox bug 492459.  So move .js blockers from
-    +block{Might be a web-bug.} -handle-as-empty-document
-    to
-    +block{Might be a web-bug.} +handle-as-empty-document
-  - ijbswa-Feature Requests-3006719 - Block 160x578 Banners.
-  - Block another omniture tracking domain
-  - Added a range-requests tagger.
-  - Added two sections to get Flickr's Ajax interface working with
-    default pre-settings. If you change the configuration to block
-    cookies by default, you'll need additional exceptions.
-    Reported by Mathias Homann in #3101419 and by Patrick on ijbswa-users@
+  - Filtering is disabled for Range requests to let download resumption
+    and Windows updates work with the default configuration.
+  - Unblock ".ardmediathek.de/".
+    Reported by ThTomate in #932.
 
 - Documentation improvements:
-  - Explicitly mention how to match all URLs.
-  - Consistently recommend socks5 in the Tor FAQ entry and mention
-    its advantage compared to socks4a. Reported by David in #2960129.
-  - Slightly improve the explanation of why filtering may appear
-    slower than it is.
-  - Grammar fixes for the ACL section.
-
-- Privoxy-Log-Parser improvements:
-  - Also gather statistics for blocked and redirected requests.
-  - Provide the percentage of keep-alive offers the client accepted.
-  - Add a --url-statistics-threshold option.
-  - Also gather statistics for ressources, methods, and HTTP versions
-    used by the client.
-  - Add a --host-statistics-threshold option to also gather
-    statistics about how many request where made per host.
-  - Fix a bug in handle_loglevel_header() where a 'scan: ' got lost.
-  - Add a --shorten-thread-ids option to replace the thread id with
-    a decimal number.
-  - Accept and ignore: Looks like we got the last chunk together
-    with the server headers. We better stop reading.
-  - Accept and ignore: Continue hack in da house.
-  - Accept and higlight: Rejecting connection from 10.0.0.2.
-    Maximum number of connections reached.
-  - Accept and highlight: Loading actions file: /usr/local/etc/privoxy/default.action
-  - Accept and highlight: Loading filter file: /usr/local/etc/privoxy/default.filter
-  - Accept and highlight: Killed all-caps Host header line: HOST: bestproxydb.com
-  - Accept and highlight: Reducing expected bytes to 0. Marking
-    the server socket tainted after throwing 4 bytes away.
-  - Accept: Merged multiple header lines to: 'X-FORWARDED-PROTO: http X-HOST: 127.0.0.1'
-
-- Code cleanups:
-  - Remove the next member from the client_state struct. Only the main
-    thread needs access to all client states so give it its own struct.
-  - Garbage-collect request_contains_null_bytes().
-  - Ditch redundant code in unload_configfile().
-  - Ditch LogGetURLUnderCursor() which doesn't seem to be used anywhere.
-  - In write_socket(), remove the write-only variable write_len in
-    an ifdef __OS2__ block. Spotted by cppcheck.
-  - In connect_to(), don't declare the variable 'flags' on OS/2 where
-    it isn't used. Spotted by cppcheck.
-  - Limit the scope of various variables. Spotted by cppcheck.
-  - In add_to_iob(), turn an interestingly looking for loop into a
-    boring while loop.
-  - Code cleanup in preparation for external filters.
-  - In listen_loop(), mention the socket on which we accepted the
-    connection, not just the source IP address.
-  - In write_socket(), also log the socket we're writing to.
-  - In log_error(), assert that escaped characters get logged
-    completely or not at all.
-  - In log_error(), assert that ival and sval have reasonable values.
-    There's no reason not to abort() if they don't.
-  - Remove an incorrect cgi_error_unknown() call in a
-    cannnot-happen-situation in send_crunch_response().
-  - Clean up white-space in http_response definition and
-    move the crunch_reason to the beginning.
-  - Turn http_response.reason into an enum and rename it
-    to http_response.crunch_reason.
-  - Silence a 'gcc (Debian 4.3.2-1.1) 4.3.2' warning on i686 GNU/Linux.
-
-- GNUmakefile improvements:
-  - Use $(SSH) instead of ssh, so one only needs to specify a username once.
-  - Removed references to the action feedback thingy that hasn't been
-    working for years.
-  - Consistently use shell.sourceforge.net instead of shell.sf.net so
-    one doesn't need to check server fingerprints twice.
-  - Removed GNUisms in the webserver and webactions targets so they
-    work with standard tar.
+  - Add FAQ entry for crashes caused by memory limits.
+  - Remove obsolete FAQ entry about a bug in PHP 4.2.3.
+  - Mention the new mailing lists were appropriate.
+    As the archives have not been migrated, continue to
+    mention the archives at SF in the contacting section
+    for now.
+  - Note that the templates should be adjusted if Privoxy is
+    running as intercepting proxy without getting all requests.
+  - A bunch of links were converted to https://.
+  - Rephrase onion service paragraph to make it more obvious
+    that Tor is involved and that the whole website (and not
+    just the homepage) is available as onion service.
+  - Streamline the "More information" section on the homepage further
+    by additionally ditching the link to the 'See also' section
+    of the user manual. The section contains mostly links that are
+    directly reachable from the homepage already and the rest is
+    not significant enough to get a link from the homepage.
+  - Change the add-header{} example to set the DNT header
+    and use a complete section to make copy and pasting
+    more convenient.
+    Add a comment to make it obvious that adding the
+    header is not recommended for obvious reasons.
+    Using the DNT header as example was suggested by
+    Leo Wzukw.
+  - Streamline the support-and-service template
+    Instead of linking to the various support trackers
+    (whose URLs hopefully change soon), link to the
+    contact section of the user manual to increase the
+    chances that users actually read it.
+  - Add a FAQ entry for tainted sockets.
+  - More sections in the documentation have stable URLs now.
+  - FAQ: Explain why 'ping config.privoxy.org' is not expected
+    to reach a local Privoxy installation.
+  - Note that donations done through Zwiebelfreunde e.V. currently
+    can't be checked automatically.
+  - Updated section regarding starting Privoxy under OS X.
+  - Use dedicated start instructions for FreeBSD and ElectroBSD.
+  - Removed release instructions for AIX. They haven't been working
+    for years and unsurprisingly nobody seems to care.
+  - Removed obsolete reference to the solaris-dist target.
+  - Updated the release instructions for FreeBSD.
+  - Removed unfinished release instructions for Amiga OS and HP-UX 11.
+  - Added a pointer to the Cygwin Time Machine for getting the last release of
+    Cygwin version 1.5 to use for building Privoxy on Windows.
+  - Various typos have been fixed.
+
+- Infrastructure improvements:
+  - The website is no longer hosted at SourceForge and
+    can be reached through https now.
+  - The mailing lists at SourceForge have been deprecated,
+    you can subscribe to the new ones at: https://lists.privoxy.org/
+  - Migrating the remaining services from SourceForge is
+    work in progress (TODO list item #53).
+
+- Build system improvements:
+  - Add configure argument to optimistically redefine FD_SETSIZE
+    with the intent to change the maximum number of client
+    connections Privoxy can handle. Only works with some libcs.
+    Sponsored by Robert Klemme.
+  - Let the tarball-dist target skip files in ".git".
+  - Let the tarball-dist target work in cwds other than current.
+  - Make the 'clean' target faster when run from a git repository.
+  - Include tools in the generic distribution.
+  - Let the gen-dist target work in cwds other than current.
+  - Sort find output that is used for distribution tarballs
+    to get reproducible results.
+  - Don't add '-src' to the name of the tar ball generated by the
+    gen-dist target. The package isn't a source distribution but a
+    binary package.
+    While at it, use a variable for the name to reduce the chances
+    that the various references get out of sync and fix the gen-upload
+    target which was looking in the wrong directory.
+  - Add regression-tests.action to the files that are distributed.
+  - The gen-dist target which was broken since 2002 (r1.92) has been fixed.
+  - Remove genclspec.sh which has been obsolete since 2009.
+  - Remove obsolete reference to Redhat spec file.
+  - Remove the obsolete announce target which has been commented out years ago.
+  - Let rsync skip files if the checksums match.
+
+- Privoxy-Regression-Test:
+  - Add a "Default level offset" directive which can be used to
+    change the default level by a given value.
+    This directive affects all tests located after it until the end
+    of the file or a another "Default level offset" directive is reached.
+    The purpose of this directive is to make it more convenient to skip
+    similar tests in a given file without having to remove or disable
+    the tests completely.
+  - Let test level 17 depend on FEATURE_64_BIT_TIME_T
+    instead of FEATURE_PTHREAD which has no direct connection
+    to the time_t size.
+  - Fix indentation in perldoc examples.
+  - Don't overlook directives in the first line of the action file.
+  - Bump version to 0.7.
+  - Fix detection of the Privoxy version now that https://
+    is used for the website.
 
 -----------------------------------------------------------------
 About Privoxy:
@@ -180,73 +166,67 @@ networks.
 
 Privoxy is Free Software and licensed under the GNU GPLv2.
 
-Privoxy is an associated project of Software in the Public Interest (SPI).
+Our TODO list is rather long. Helping hands and donations are welcome:
 
-Helping hands and donations are welcome:
+  * https://www.privoxy.org/faq/general.html#PARTICIPATE
 
-  * http://www.privoxy.org/faq/general.html#PARTICIPATE
+  * https://www.privoxy.org/faq/general.html#DONATE
 
-  * 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
-others), Mac OSX, OS/2, AmigaOS, FreeBSD, NetBSD, OpenBSD, Solaris, and
-various other flavors of Unix.
+At present, Privoxy is known to run on Windows 95 and later versions
+(98, ME, 2000, XP, Vista, Windows 7 etc.), GNU/Linux (RedHat, SuSE,
+Debian, Fedora, Gentoo, Slackware and others), Mac OS X (10.4 and
+upwards on PPC and Intel processors), OS/2, Haiku, DragonFly, ElectroBSD,
+FreeBSD, NetBSD, OpenBSD, Solaris, and various other flavors of Unix.
 
 In addition to the core features of ad blocking and cookie management,
 Privoxy provides many supplemental features, that give the end-user
 more control, more privacy and more freedom:
 
+  *  Supports "Connection: keep-alive". Outgoing connections can be kept
+     alive independently from the client. Currently not available on all
+     platforms.
 
-    *  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 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.
 
-    *  Can be run as an "intercepting" proxy, which obviates the need to
-       configure browsers individually.
+  *  Can be run as an "intercepting" proxy, which obviates the need to
+     configure browsers individually.
 
-    *  Sophisticated actions and filters for manipulating both server and
-       client headers.
+  *  Sophisticated actions and filters for manipulating both server and
+     client headers.
 
-    *  Can be chained with other proxies.
+  *  Can be chained with other proxies.
 
-    *  Integrated browser based configuration and control utility at
-       http://config.privoxy.org/ (shortcut: http://p.p/). Browser-based
-       tracing of rule and filter effects. Remote toggling.
+  *  Integrated browser based configuration and control utility at
+     http://config.privoxy.org/ (shortcut: http://p.p/). Browser-based
+     tracing of rule and filter effects. Remote toggling.
 
-    *  Web page filtering (text replacements, removes banners based on size,
-       invisible <quote>web-bugs</quote> and HTML annoyances, etc.)
+  *  Web page filtering (text replacements, removes banners based on size,
+     invisible "web-bugs" and HTML annoyances, etc.)
 
-    *  Modularized configuration that allows for standard settings and user
-       settings to reside in separate files, so that installing updated actions
-       files won't overwrite individual user settings.
+  *  Modularized configuration that allows for standard settings and user
+     settings to reside in separate files, so that installing updated actions
+     files won't overwrite individual user settings.
 
-    *  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.
 
-    *  GIF de-animation.
+  *  GIF de-animation.
 
-    *  Bypass many click-tracking scripts (avoids script redirection).
+  *  Bypass many click-tracking scripts (avoids script redirection).
 
-    *  User-customizable HTML templates for most proxy-generated pages (e.g.
-       "blocked" page).
+  *  User-customizable HTML templates for most proxy-generated pages (e.g.
+     "blocked" page).
 
-    *  Auto-detection and re-reading of config file changes.
-    
-    *  Most features are controllable on a per-site or per-location basis.
+  *  Auto-detection and re-reading of config file changes.
     
+  *  Most features are controllable on a per-site or per-location basis.
 
-Download location: 
-   http://sourceforge.net/project/showfiles.php?group_id=11118
-Home Page: 
-   http://www.privoxy.org/
 
+Home Page: 
+   https://www.privoxy.org/
 
-  - Privoxy Developers <ijbswa-developers@lists.sourceforge.net>
+  - Privoxy Developers <privoxy-devel@lists.privoxy.org>