Rebuild for 3.0.17 stable
[privoxy.git] / doc / webserver / user-manual / whatsnew.html
index 99f1c3c..eeb32d2 100644 (file)
@@ -7,7 +7,7 @@
 NAME="GENERATOR"
 CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
 REL="HOME"
-TITLE="Privoxy 3.0.7 User Manual"
+TITLE="Privoxy 3.0.17 User Manual"
 HREF="index.html"><LINK
 REL="PREVIOUS"
 TITLE="Installation"
@@ -17,7 +17,10 @@ TITLE="Quickstart to Using Privoxy"
 HREF="quickstart.html"><LINK
 REL="STYLESHEET"
 TYPE="text/css"
-HREF="../p_doc.css">
+HREF="../p_doc.css"><META
+HTTP-EQUIV="Content-Type"
+CONTENT="text/html;
+charset=ISO-8859-1">
 <LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
 </head
 ><BODY
@@ -39,7 +42,7 @@ CELLSPACING="0"
 ><TH
 COLSPAN="3"
 ALIGN="center"
->Privoxy 3.0.7 User Manual</TH
+>Privoxy 3.0.17 User Manual</TH
 ></TR
 ><TR
 ><TD
@@ -79,211 +82,513 @@ NAME="WHATSNEW"
 >3. What's New in this Release</A
 ></H1
 ><P
-> There are many improvements and new features since <SPAN
+> <SPAN
 CLASS="APPLICATION"
->Privoxy 3.0.6</SPAN
->, the last stable release:</P
+>Privoxy 3.0.16</SPAN
+> is a stable release.
+ The changes since 3.0.15 beta are:</P
 ><P
 > <P
 ></P
 ><UL
 ><LI
 ><P
->    Two new actions <A
-HREF="actions-file.html#SERVER-HEADER-TAGGER"
->server-header-tagger</A
->
-          and <A
-HREF="actions-file.html#CLIENT-HEADER-TAGGER"
->client-header-tagger</A
->
-          that can be used to create arbitrary <SPAN
-CLASS="QUOTE"
->"tags"</SPAN
->
-          based on client and server headers.
-          These <SPAN
-CLASS="QUOTE"
->"tags"</SPAN
-> can then subsequently be used
-          to control the other actions used for the current request,
-          greatly increasing <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
->'s flexibility and selectivity. See <A
-HREF="actions-file.html#TAG-PATTERN"
->tag patterns</A
-> for more information on tags.
+>    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.
    </P
 ></LI
 ><LI
 ><P
->    Header filtering is done with dedicated header filters now. As a result
-    the actions <SPAN
-CLASS="QUOTE"
->"filter-client-headers"</SPAN
-> and <SPAN
-CLASS="QUOTE"
->"filter-server-headers"</SPAN
->
-    that were introduced with <SPAN
-CLASS="APPLICATION"
->Privoxy 3.0.5</SPAN
-> to apply
-    content filters to the headers have been removed.
-    See the new actions <A
-HREF="actions-file.html#SERVER-HEADER-FILTER"
->server-header-filter</A
->
-          and <A
-HREF="actions-file.html#CLIENT-HEADER-FILTER"
->client-header-filter</A
-> for details.
+>    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.
    </P
 ></LI
 ><LI
 ><P
->     There are four new options for the main <TT
-CLASS="FILENAME"
->config</TT
-> file:
+>    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.
+   </P
+></LI
+><LI
+><P
+>    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.
+   </P
+></LI
+><LI
+><P
+>    The IPv6 code is enabled by default on Windows versions that support it.
+    Patch submitted by oCameLo in #2942729.
+   </P
+></LI
+><LI
+><P
+>    In mingw32 versions, the user.filter file is reachable through the
+    GUI, just like default.filter is. Feature request 3040263.
+   </P
+></LI
+><LI
+><P
+>    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.
+   </P
+></LI
+><LI
+><P
+>    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.
+   </P
+></LI
+><LI
+><P
+>    Privoxy logs when reading an action, filter or trust file.
+   </P
+></LI
+><LI
+><P
+>    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.
    </P
+></LI
+><LI
 ><P
+>    CGI interface improvements:
+    <P
 ></P
 ><UL
 ><LI
 ><P
->          <A
-HREF="config.html#ALLOW-CGI-REQUEST-CRUNCHING"
->allow-cgi-request-crunching</A
->
-          which allows requests for Privoxy's internal CGI pages to be
-          blocked, redirected or (un)trusted like ordinary requests.
-        </P
+>      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.
+     </P
 ></LI
 ><LI
 ><P
->          <A
-HREF="config.html#SPLIT-LARGE-FORMS"
->split-large-forms</A
->
-          that will work around a browser bug that caused IE6 and IE7 to
-          ignore the Submit button on the Privoxy's edit-actions-for-url CGI
-          page.
-          </P
+>      Apostrophes in block messages no longer cause parse errors
+      when the blocked page is viewed with JavaScript enabled.
+      Reported by dg1727 in #3062296.
+     </P
 ></LI
 ><LI
 ><P
->          <A
-HREF="config.html#ACCEPT-INTERCEPTED-REQUESTS"
->accept-intercepted-requests</A
->
-          which allows to combine Privoxy with any packet filter to create an
-          intercepting proxy for HTTP/1.1 requests (and for HTTP/1.0 requests
-          with Host header set). This means clients can be forced to use
-          <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> even if their proxy settings are configured differently.
-         </P
+>      Fix a bunch of anchors that used underscores instead of dashes.
+     </P
 ></LI
 ><LI
 ><P
->          <A
-HREF="config.html#TEMPLDIR"
->templdir</A
->
-          to designate an alternate location for <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
->'s 
-          locally customized CGI templates so that
-          these are not overwritten during upgrades.         
-        </P
+>      Allow to keep the client connection alive after crunching the previous request.
+      Already opened server connections can be kept alive, too.
+     </P
 ></LI
-></UL
+><LI
+><P
+>      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.
+     </P
 ></LI
 ><LI
 ><P
->   A new command line option <TT
-CLASS="LITERAL"
->--pre-chroot-nslookup hostname</TT
-> to
-   initialize the resolver library before chroot'ing. On some systems this
-   reduces the number of files that must be copied into the chroot tree.
-   (Patch provided by Stephen Gildea)
+>      Show the 404 CGI page if cgi_send_user_manual() is called while
+      local user manual delivery is disabled.
+     </P
+></LI
+></UL
+>
    </P
 ></LI
 ><LI
 ><P
->     The <A
-HREF="actions-file.html#FORWARD-OVERRIDE"
->forward-override</A
-> action 
-     allows changing of the forwarding settings through the actions files.
-     Combined with tags, this allows to choose the forwarder based on
-     client headers like the <TT
-CLASS="LITERAL"
->User-Agent</TT
->, or the request origin.
-  </P
+>    Action file improvements:
+    <P
+></P
+><UL
+><LI
+><P
+>      Enable user.filter by default. Suggested by David White in #3001830.
+     </P
 ></LI
 ><LI
 ><P
->     The  <A
-HREF="actions-file.html#REDIRECT"
->redirect</A
-> action can now use regular
-          expression substitutions against the original URL.
-   </P
+>      Block .sitestat.com/. Reported by johnd16 in #3002725.
+     </P
 ></LI
 ><LI
 ><P
->     <SPAN
-CLASS="APPLICATION"
->zlib</SPAN
-> support is now available as a compile
-     time option to filter compressed content. Patch provided by Wil Mahan.
-   </P
+>      Block .atemda.com/. Reported by johnd16 in #3002723.
+     </P
+></LI
+><LI
+><P
+>      Block js.adlink.net/. Reported by johnd16 in #3002720.
+     </P
+></LI
+><LI
+><P
+>      Block .analytics.yahoo.com/. Reported by johnd16 in #3002713.
+     </P
+></LI
+><LI
+><P
+>      Block sb.scorecardresearch.com, too. Reported by dg1727 in #2992652.
+     </P
 ></LI
 ><LI
 ><P
->     Improve various filters, and add new ones.
+>      Fix problems noticed on Yahoo mail and news pages.
+     </P
+></LI
+><LI
+><P
+>      Remove the too broad yahoo section, only keeping the
+      fast-redirects exception as discussed on ijbswa-devel@.
+     </P
+></LI
+><LI
+><P
+>      Don't block adesklets.sourceforge.net. Reported in #2974204.
+     </P
+></LI
+><LI
+><P
+>      Block chartbeat ping tracking. Reported in #2975895.
+     </P
+></LI
+><LI
+><P
+>      Tag CSS and image requests with cautious and medium settings, too.
+     </P
+></LI
+><LI
+><P
+>      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.
+     </P
+></LI
+><LI
+><P
+>      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.
+     </P
+></LI
+><LI
+><P
+>      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
+     </P
+></LI
+><LI
+><P
+>      ijbswa-Feature Requests-3006719 - Block 160x578 Banners.
+     </P
+></LI
+><LI
+><P
+>      Block another omniture tracking domain
+     </P
+></LI
+><LI
+><P
+>      Added a range-requests tagger.
+     </P
+></LI
+><LI
+><P
+>      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@
+     </P
+></LI
+></UL
+>
    </P
 ></LI
 ><LI
 ><P
->    Include support for RFC 3253 so that <TT
-CLASS="FILENAME"
->Subversion</TT
-> works
-    with <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
->. Patch provided by Petr Kadlec.
+>    Documentation improvements:
+    <P
+></P
+><UL
+><LI
+><P
+>      Explicitly mention how to match all URLs.
+     </P
+></LI
+><LI
+><P
+>      Consistently recommend socks5 in the Tor FAQ entry and mention
+      its advantage compared to socks4a. Reported by David in #2960129.
+     </P
+></LI
+><LI
+><P
+>      Slightly improve the explanation of why filtering may appear
+      slower than it is.
+     </P
+></LI
+><LI
+><P
+>      Grammar fixes for the ACL section.
+     </P
+></LI
+></UL
+>
    </P
 ></LI
 ><LI
 ><P
->     Logging can be completely turned off by not specifying a logfile directive.
+>    Privoxy-Log-Parser improvements:
+    <P
+></P
+><UL
+><LI
+><P
+>      Also gather statistics for blocked and redirected requests.
+     </P
+></LI
+><LI
+><P
+>      Provide the percentage of keep-alive offers the client accepted.
+     </P
+></LI
+><LI
+><P
+>      Add a --url-statistics-threshold option.
+     </P
+></LI
+><LI
+><P
+>      Also gather statistics for ressources, methods, and HTTP versions
+      used by the client.
+     </P
+></LI
+><LI
+><P
+>      Add a --host-statistics-threshold option to also gather
+      statistics about how many request where made per host.
+     </P
+></LI
+><LI
+><P
+>      Fix a bug in handle_loglevel_header() where a 'scan: ' got lost.
+     </P
+></LI
+><LI
+><P
+>      Add a --shorten-thread-ids option to replace the thread id with
+      a decimal number.
+     </P
+></LI
+><LI
+><P
+>      Accept and ignore: Looks like we got the last chunk together
+      with the server headers. We better stop reading.
+     </P
+></LI
+><LI
+><P
+>      Accept and ignore: Continue hack in da house.
+     </P
+></LI
+><LI
+><P
+>      Accept and higlight: Rejecting connection from 10.0.0.2.
+      Maximum number of connections reached.
+     </P
+></LI
+><LI
+><P
+>      Accept and highlight: Loading actions file: /usr/local/etc/privoxy/default.action
+     </P
+></LI
+><LI
+><P
+>      Accept and highlight: Loading filter file: /usr/local/etc/privoxy/default.filter
+     </P
+></LI
+><LI
+><P
+>      Accept and highlight: Killed all-caps Host header line: HOST: bestproxydb.com
+     </P
+></LI
+><LI
+><P
+>      Accept and highlight: Reducing expected bytes to 0. Marking
+      the server socket tainted after throwing 4 bytes away.
+     </P
+></LI
+><LI
+><P
+>      Accept: Merged multiple header lines to: 'X-FORWARDED-PROTO: http X-HOST: 127.0.0.1'
+     </P
+></LI
+></UL
+>
    </P
 ></LI
 ><LI
 ><P
->     A number of improvements to Privoxy's internal CGI pages, including the
-     use of favicons for error and control pages.
+>    Code cleanups:
+    <P
+></P
+><UL
+><LI
+><P
+>      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.
+     </P
+></LI
+><LI
+><P
+>      Garbage-collect request_contains_null_bytes().
+     </P
+></LI
+><LI
+><P
+>      Ditch redundant code in unload_configfile().
+     </P
+></LI
+><LI
+><P
+>      Ditch LogGetURLUnderCursor() which doesn't seem to be used anywhere.
+     </P
+></LI
+><LI
+><P
+>      In write_socket(), remove the write-only variable write_len in
+      an ifdef __OS2__ block. Spotted by cppcheck.
+     </P
+></LI
+><LI
+><P
+>      In connect_to(), don't declare the variable 'flags' on OS/2 where
+      it isn't used. Spotted by cppcheck.
+     </P
+></LI
+><LI
+><P
+>      Limit the scope of various variables. Spotted by cppcheck.
+     </P
+></LI
+><LI
+><P
+>      In add_to_iob(), turn an interestingly looking for loop into a
+      boring while loop.
+     </P
+></LI
+><LI
+><P
+>      Code cleanup in preparation for external filters.
+     </P
+></LI
+><LI
+><P
+>      In listen_loop(), mention the socket on which we accepted the
+      connection, not just the source IP address.
+     </P
+></LI
+><LI
+><P
+>      In write_socket(), also log the socket we're writing to.
+     </P
+></LI
+><LI
+><P
+>      In log_error(), assert that escaped characters get logged
+      completely or not at all.
+     </P
+></LI
+><LI
+><P
+>      In log_error(), assert that ival and sval have reasonable values.
+      There's no reason not to abort() if they don't.
+     </P
+></LI
+><LI
+><P
+>      Remove an incorrect cgi_error_unknown() call in a
+      cannnot-happen-situation in send_crunch_response().
+     </P
+></LI
+><LI
+><P
+>      Clean up white-space in http_response definition and
+      move the crunch_reason to the beginning.
+     </P
+></LI
+><LI
+><P
+>      Turn http_response.reason into an enum and rename it
+      to http_response.crunch_reason.
+     </P
+></LI
+><LI
+><P
+>      Silence a 'gcc (Debian 4.3.2-1.1) 4.3.2' warning on i686 GNU/Linux.
+     </P
+></LI
+></UL
+>
    </P
 ></LI
 ><LI
 ><P
->     Many bugfixes, memory leaks addressed, code improvements, and logging 
-     improvements.
+>    GNUmakefile improvements:
+    <P
+></P
+><UL
+><LI
+><P
+>      Use $(SSH) instead of ssh, so one only needs to specify a username once.
+     </P
+></LI
+><LI
+><P
+>      Removed references to the action feedback thingy that hasn't been
+      working for years.
+     </P
+></LI
+><LI
+><P
+>      Consistently use shell.sourceforge.net instead of shell.sf.net so
+      one doesn't need to check server fingerprints twice.
+     </P
+></LI
+><LI
+><P
+>      Removed GNUisms in the webserver and webactions targets so they
+      work with standard tar.
+     </P
+></LI
+></UL
+>
    </P
 ></LI
 ></UL
 ></P
-><P
-> For a more detailed list of changes please have a look at the ChangeLog.</P
 ><DIV
 CLASS="SECT2"
 ><H2
@@ -304,20 +609,50 @@ CLASS="APPLICATION"
 ><UL
 ><LI
 ><P
+>   The recommended way to upgrade <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> is to backup your old 
+   configuration files, install the new ones, verify that <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>
+   is working correctly and finally merge back your changes using
+   <SPAN
+CLASS="APPLICATION"
+>diff</SPAN
+> and maybe <SPAN
+CLASS="APPLICATION"
+>patch</SPAN
+>.
+  </P
+><P
+>   There are a number of new features in each <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> release and
+   most of them have to be explicitly enabled in the configuration
+   files. Old configuration files obviously don't do that and due
+   to syntax changes using old configuration files with a new
+   <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> isn't always possible anyway.
+  </P
+></LI
+><LI
+><P
 >  
-    Some installers may remove earlier versions completely, including 
-    configuration files. Save any important configuration files!
+    Note that some installers remove earlier versions completely,
+    including configuration files, therefore you should really save
+    any important configuration files!
   </P
 ></LI
 ><LI
 ><P
 >  
-   On the other hand, other installers may not overwrite any existing configuration 
-   files, thinking you will want to do that. You may want to manually check 
-   your saved files against the newer versions to see if the improvements have
-   merit, or whether there are new options that you may want to consider.
-   There are a number of new features, but most won't be available unless 
-   these features are incorporated into your configuration somehow.
+   On the other hand, other installers don't overwrite existing configuration 
+   files, thinking you will want to do that yourself.
   </P
 ></LI
 ><LI
@@ -326,18 +661,27 @@ CLASS="APPLICATION"
    <TT
 CLASS="FILENAME"
 >standard.action</TT
-> now only includes the enabled actions.
-   Not all actions as before.
+> has been merged into
+   the <TT
+CLASS="FILENAME"
+>default.action</TT
+> file.
   </P
 ></LI
 ><LI
 ><P
->     Logging is off by default now. If you need logging, it can be turned on
-     in the <A
-HREF="config.html#LOGFILE"
->config file</A
->.
-    </P
+>   In the default configuration only fatal errors are logged now.
+   You can change that in the <A
+HREF="config.html#DEBUG"
+>debug section</A
+>
+   of the configuration file. You may also want to enable more verbose
+   logging until you verified that the new <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> version is working
+   as expected.
+  </P
 ></LI
 ><LI
 ><P
@@ -358,27 +702,6 @@ HREF="config.html#ENABLE-EDIT-ACTIONS"
      be aware of the security issues involved. 
     </P
 ></LI
-><LI
-><P
->    The <SPAN
-CLASS="QUOTE"
->"filter-client-headers"</SPAN
-> and
-    <SPAN
-CLASS="QUOTE"
->"filter-server-headers"</SPAN
-> actions that were introduced with
-    <SPAN
-CLASS="APPLICATION"
->Privoxy 3.0.5</SPAN
-> to apply content filters to
-    the headers  have been removed and replaced with new actions.
-    See the <A
-HREF="whatsnew.html"
->What's New section</A
-> above.
-   </P
-></LI
 ></UL
 ></P
 ></DIV
@@ -443,4 +766,4 @@ VALIGN="top"
 ></DIV
 ></BODY
 ></HTML
->
\ No newline at end of file
+>