Rebuild for 3.0.17 stable
[privoxy.git] / doc / webserver / user-manual / whatsnew.html
index 11ba4ae..eeb32d2 100644 (file)
@@ -7,7 +7,7 @@
 NAME="GENERATOR"
 CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
 REL="HOME"
-TITLE="Privoxy 3.0.10 User Manual"
+TITLE="Privoxy 3.0.17 User Manual"
 HREF="index.html"><LINK
 REL="PREVIOUS"
 TITLE="Installation"
@@ -42,7 +42,7 @@ CELLSPACING="0"
 ><TH
 COLSPAN="3"
 ALIGN="center"
->Privoxy 3.0.10 User Manual</TH
+>Privoxy 3.0.17 User Manual</TH
 ></TR
 ><TR
 ><TD
@@ -82,182 +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.8</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
->    Added SOCKS5 support (with address resolution done by
-    the SOCKS5 server). Patch provided by Eric M. Hopper.
+>    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
->    The "blocked" CGI pages include a block reason that was
-    provided as argument to the last-applying block action.
+>    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
->    If enable-edit-actions is disabled (the default since 3.0.7 beta)
-    the show-status page hides the edit buttons and explains why.
-    Previously the user would get the "this feature has been disabled"
-    message after using the edit button.
+>    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
->    Forbidden CONNECT requests are treated like blocks by default.
-    The now-pointless treat-forbidden-connects-like-blocks action
-    has been removed.
+>    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
->    Not enabling limit-connect now allows CONNECT requests to all ports.
-    In previous versions it would only allow CONNECT requests to port 443.
-    Use +limit-connect{443} if you think you need the old default behaviour.
+>    The IPv6 code is enabled by default on Windows versions that support it.
+    Patch submitted by oCameLo in #2942729.
    </P
 ></LI
 ><LI
 ><P
->    The CGI editor gets turned off after three edit requests with invalid
-    file modification timestamps. This makes life harder for attackers
-    who can leverage browser bugs to send fake Referers and intend to
-    brute-force edit URLs.
+>    In mingw32 versions, the user.filter file is reachable through the
+    GUI, just like default.filter is. Feature request 3040263.
    </P
 ></LI
 ><LI
 ><P
->    Action settings for multiple patterns in the same section are
-    shared in memory. As a result these sections take up less space
-    (and are loaded slightly faster). Problem reported by Franz Schwartau.
+>    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
->    Linear white space in HTTP headers will be normalized to single
-    spaces before parsing the header's content, headers split across
-    multiple lines get merged first.
+>    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
->    Host information is gathered outside the main thread so it's less
-    likely to delay other incoming connections if the host is misconfigured.
+>    Privoxy logs when reading an action, filter or trust file.
    </P
 ></LI
 ><LI
 ><P
->    New config option "hostname" to use a hostname other than
-    the one returned by the operating system. Useful to speed-up responses
-    for CGI requests on misconfigured systems. Requested by Max Khon.
+>    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
->    The CGI editor supports the "disable all filters of this type"
-    directives "-client-header-filter", "-server-header-filter",
-    "-client-header-tagger" and "-server-header-tagger".
-   </P
+>    CGI interface improvements:
+    <P
+></P
+><UL
+><LI
+><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
->    Fixed false-positives with the link-by-url filter and URLs that
-    contain the pattern "/jump/".
-   </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
->    The less-download-windows filter no longer messes
-    "Content-Type: application/x-shockwave-flash" headers up.
-   </P
+>      Fix a bunch of anchors that used underscores instead of dashes.
+     </P
 ></LI
 ><LI
 ><P
->    In the show-url-info page's "Final results" section active and
-    inactive actions are listed separately. Patch provided by Lee.
-   </P
+>      Allow to keep the client connection alive after crunching the previous request.
+      Already opened server connections can be kept alive, too.
+     </P
 ></LI
 ><LI
 ><P
->    The GNUmakefile supports the DESTDIR variable. Patch for
-    the install target submitted by Radoslaw Zielinski.
-   </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
->    Embedding the content of configuration files in the show-status
-    page is significantly faster now. For a largish action file (1 MB)
-    a speedup of about 2450 times has been measured. This is mostly
-    interesting if you are using large action files or regularly use
-    Privoxy-Regression-Test while running Privoxy through Valgrind,
-    for stock configuration files it doesn't really matter.
+>      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
->    If zlib support is unavailable and there are content
-    filters active but the prevent-compression action is disabled,
-    the show-url-info page includes a warning that compression
-    might prevent filtering.
-   </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 show-url-info page provides an OpenSearch Description that
-    allows to access the page through browser search plugins.
-   </P
+>      Block .sitestat.com/. Reported by johnd16 in #3002725.
+     </P
 ></LI
 ><LI
 ><P
->    The obsolete kill-popups action has been removed as the
-    PCRS-based popup filters can do the same and are slightly
-    less unreliable.
-   </P
+>      Block .atemda.com/. Reported by johnd16 in #3002723.
+     </P
 ></LI
 ><LI
 ><P
->    The inspect-jpegs action has been removed.
-   </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
->    The send-wafer and send-vanilla-wafer actions have been removed.
-    They weren't particular useful and their behaviour could be emulated
-    with add-header anyway.
+>      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
->    Privoxy-Regression-Test has been significantly improved.
+>    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
->    Most sections in the default.action file contain tests for
-    Privoxy-Regression-Test to verify that they are working as intended.
+>    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
->    Parts of Privoxy have been refactored to increase maintainability.
+>    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
->    Building with zlib (if available) is done by default.
+>    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
@@ -330,8 +661,11 @@ 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
@@ -368,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
@@ -453,4 +766,4 @@ VALIGN="top"
 ></DIV
 ></BODY
 ></HTML
->
\ No newline at end of file
+>