Rebuild user-manual, developer-manual and faq.
[privoxy.git] / doc / webserver / user-manual / whatsnew.html
index e2cc1f1..ac293a0 100644 (file)
@@ -7,7 +7,7 @@
 NAME="GENERATOR"
 CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
 REL="HOME"
-TITLE="Privoxy 3.0.11 User Manual"
+TITLE="Privoxy 3.0.18 User Manual"
 HREF="index.html"><LINK
 REL="PREVIOUS"
 TITLE="Installation"
@@ -42,7 +42,7 @@ CELLSPACING="0"
 ><TH
 COLSPAN="3"
 ALIGN="center"
->Privoxy 3.0.11 User Manual</TH
+>Privoxy 3.0.18 User Manual</TH
 ></TR
 ><TR
 ><TD
@@ -82,153 +82,541 @@ NAME="WHATSNEW"
 >3. What's New in this Release</A
 ></H1
 ><P
-> There are only a few improvements and new features since
- <SPAN
+> <SPAN
 CLASS="APPLICATION"
->Privoxy 3.0.10</SPAN
->, the last stable release:</P
+>Privoxy 3.0.17</SPAN
+> is a stable release.
+ The changes since 3.0.16 stable are:</P
 ><P
 > <P
 ></P
 ><UL
 ><LI
 ><P
->    On most platforms, outgoing connections can be kept alive and
-    reused if the server supports it. Whether or not this improves
-    things depends on the connection.
+>    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 or the
+    request timed out. Reported by "Karsten" in #3028326.
    </P
 ></LI
 ><LI
 ><P
->    When dropping privileges, membership in supplementary groups
-    is given up as well. Not doing that can lead to Privoxy running
-    with more rights than necessary and violates the principle of
-    least privilege. Users of the --user option are advised to update.
-    Thanks to Matthias Drochner for reporting the problem,
-    providing the initial patch and testing the final version.
+>    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
+    or the request timed out. 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
->    Passing invalid users or groups with the --user option
-    didn't lead to program exit. Regression introduced in 3.0.7.
+>    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
->    The match all section has been moved from default.action
-    to a new file called match-all.action. As a result the
-    default.action no longer needs to be touched by the user
-    and can be safely overwritten by updates.
+>    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 standard.action file has been removed. Its content
-    is now part of the default.action file.
+>    The IPv6 code is enabled by default on Windows versions that support it.
+    Patch submitted by oCameLo in #2942729.
    </P
 ></LI
 ><LI
 ><P
->    In some situations the logged content length was slightly too low.
+>    In mingw32 versions, the user.filter file is reachable through the
+    GUI, just like default.filter is. Feature request 3040263.
    </P
 ></LI
 ><LI
 ><P
->    Crunched requests are logged with their own log level.
-    If you used "debug 1" in the past, you'll probably want
-    to additionally enable "debug 1024", otherwise only passed
-    requests will be logged. If you only care about crunched
-    requests, simply replace "debug 1" with "debug 1024".
+>    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
->    The crunch reason has been moved to the beginning of the
-    crunch message. For HTTP URLs, the protocol is logged as well.
+>    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
->    Log messages are shortened by printing the thread id on its
-    own (as opposed to putting it inside the string "Privoxy()").
+>    Privoxy logs when reading an action, filter or trust file.
    </P
 ></LI
 ><LI
 ><P
->    The config option socket-timeout has been added to control
-    the time Privoxy waits for data to arrive on a socket.
+>    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
->    Support for remote toggling is controlled by the configure
-    option --disable-toggle only. In previous versions it also
-    depended on the action editor and thus configuring with the
-    --disable-editor option would disable remote toggling support
-    as well.
-   </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
->    Requests with invalid HTTP versions are rejected.
-   </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 template symbol @date@ can be used to include a date(1)-like
-    time string. Initial patch submitted by Endre Szabo.
-   </P
+>      Fix a bunch of anchors that used underscores instead of dashes.
+     </P
 ></LI
 ><LI
 ><P
->    Responses from shoutcast servers are accepted again.
-    Problem reported and fix suggested by Stefan.
-   </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 hide-forwarded-for-headers action has been replaced with
-    the change-x-forwarded-for{} action which can also be used to
-    add X-Forwarded-For headers. The latter functionality already
-    existed in Privoxy versions prior to 3.0.7 but has been removed
-    as it was often used unintentionally (by not using the
-    hide-forwarded-for-headers action).
+>      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
+>      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
->    A "clear log" view option was added to the mingw32 version
-    to clear out all of the lines in the Privoxy log window.
-    Based on a patch submitted by T Ford.
+>    Action file improvements:
+    <P
+></P
+><UL
+><LI
+><P
+>      Enable user.filter by default. Suggested by David White in #3001830.
+     </P
+></LI
+><LI
+><P
+>      Block .sitestat.com/. Reported by johnd16 in #3002725.
+     </P
+></LI
+><LI
+><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
+>      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
->    The mingw32 version uses "critical sections" now, which prevents
-    log message corruption under load. As a side effect, the
-    "no thread-safe PRNG" warning could be removed as well.
+>    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
+><LI
+><P
+>      Fixed a link to the 'intercepting' entry and add another one.
+     </P
+></LI
+><LI
+><P
+>      Rename the 'Other' section to 'Mailing Lists' and reword it
+      to make it clear that nobody is forced to use the trackers
+     </P
+></LI
+><LI
+><P
+>      Note that 'anonymously' posting on the trackers may not always
+      be possible.
+     </P
+></LI
+><LI
+><P
+>      Suggest to enable debug 32768 when suspecting parsing problems.
+     </P
+></LI
+></UL
+>
    </P
 ></LI
 ><LI
 ><P
->    The mingw32 version's task bar icon is crossed out and
-    the color changed to gray if Privoxy is toggled off.
+>    Privoxy-Log-Parser improvements:
+    <P
+></P
+><UL
+><LI
+><P
+>      Gather statistics for ressources, methods, and HTTP versions
+      used by the client.
+     </P
+></LI
+><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
+>      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
+>    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
+      cannot-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
+><LI
+><P
+>      Fix white-space in a log message in remove_chunked_transfer_coding().
+      While at it, add a note that the message doesn't seem to
+      be entirely correct and should be improved later on.
+     </P
+></LI
 ></UL
+>
+   </P
+></LI
+><LI
+><P
+>    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
-> This release marks a departure for Privoxy development.</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
-> Previously, odd numbered releases were considered beta versions and
- were only released at the end of the development cycle when the code
- was already believed to be stable. Usually it was, so the stable release
- contained pretty much the same code, but got a higher version number.
- In the future we intend to release several snapshots between stable releases.
- There will probably still be about two stable releases per year,
- but hopefully about six snapshots instead of the two betas we have now.
- The intentions is to make testing without CVS access easier.</P
+>      Removed GNUisms in the webserver and webactions targets so they
+      work with standard tar.
+     </P
+></LI
+></UL
+>
+   </P
+></LI
+></UL
+></P
 ><DIV
 CLASS="SECT2"
 ><H2