Import the rest of the 3.0.20 changes and remove the ones from 3.0.19
[privoxy.git] / doc / webserver / announce.txt
1               Announcing Privoxy v.3.0.20 beta
2 --------------------------------------------------------------------
3
4 This is a beta release that introduces some new features and fixes a number of bugs, some of which are reasonably significant. One new feature (tolerate-pipelining) is enabled by default. See below for details.
5
6 --------------------------------------------------------------------
7 ChangeLog for Privoxy
8 --------------------------------------------------------------------
9 *** Version 3.0.20 Beta ***
10
11 - Bug fixes:
12   - Client sockets are now properly shutdown and drained before being
13     closed. This fixes page truncation issues with clients that aggressively
14     pipeline data on platforms that otherwise discard already written data.
15     The issue mainly affected Opera users and was initially reported
16     by Kevin in #3464439, szotsaki provided additional information to track
17     down the cause.
18   - Fix latency calculation for shared connections (disabled by default).
19     It was broken since their introduction in 2009. The calculated latency
20     for most connections would be 0 in which case the timeout detection
21     failed to account for the real latency.
22   - Reject URLs with invalid port. Previously they were parsed incorrectly and
23     characters between the port number and the first slash were silently
24     dropped as shown by curl test 187.
25   - The default-server-timeout and socket-timeout directives accept 0 as
26     valid value.
27   - Fix a race condition on Windows that could cause Privoxy to become
28     unresponsive after toggling it on or off through the taskbar icon.
29     Reported by Tim H. in #3525694.
30   - Fix the compilation on Windows when configured without IPv6 support.
31   - Fix an assertion that could cause debug builds to abort() in case of
32     socks5 connection failures with "debug 2" enabled.
33   - Fix an assertion that could cause debug builds to abort() if a filter
34     contained nul bytes in the replacement text.
35
36 - General improvements:
37   - Significantly improved keep-alive support for both client and server
38     connections.
39   - New debug log level 65536 which logs all actions that were applied to
40     the request.
41   - New directive client-header-order to forward client headers in a
42     different order than the one in which they arrived.
43   - New directive tolerate-pipelining to allow client-side pipelining.
44     If enabled (3.0.20 beta enables it by default), Privoxy will keep
45     pipelined client requests around to deal with them once the current
46     request has been served.
47   - New --config-test option to let Privoxy exit after checking whether or not
48     the configuration seems valid. The limitations noted in TODO #22 and #23
49     still apply. Based on a patch by Ramkumar Chinchani.
50   - New limit-cookie-lifetime{} action to let cookies expire before the end
51     of the session. Suggested by Rick Sykes in #1049575.
52   - Increase the hard-coded maximum number of actions and filter files from
53     10 to 30 (each). It doesn't significantly affect Privoxy's memory usage
54     and recompiling wasn't an option for all Privoxy users that reached the
55     limit.
56   - Add support for chunk-encoded client request bodies. Previously
57     chunk-encoded request bodies weren't guaranteed to be forwarded correctly,
58     so this can also be considered a bug fix although chunk-encoded request
59     bodies aren't commonly used in the real world.
60   - Add support for Tor's optimistic-data SOCKS extension, which can reduce the
61     latency for requests on newly created connections. Currently only the
62     headers are sent optimistically and only if the client request has already
63     been read completely which rules out requests with large bodies.
64   - After preventing the client from pipelining, don't signal keep-alive
65     intentions. When looking at the response headers alone, it previously
66     wasn't obvious from the client's perspective that no additional responses
67     should be expected.
68   - Stop considering client sockets tainted after receving a request with body.
69     It hasn't been necessary for a while now and unnecessarily causes test
70     failures when using curl's test suite.
71   - Allow HTTP/1.0 clients to signal interest in keep-alive through the
72     Proxy-Connection header. While such client are rare in the real world, it
73     doesn't hurt and couple of curl tests rely on it.
74   - Only remove duplicated Content-Type headers when filters are enabled.
75     If they are not it doesn't cause ill effects and the user might not want it.
76     Downgrade the removal message to LOG_LEVEL_HEADER to clarify that it's not
77     an error in Privoxy and is unlikely to cause any problems in general.
78     Anonymously reported in #3599335.
79   - Set the socket option SO_LINGER for the client socket.
80   - Move several variable declarations to the beginning of their code block.
81     It's required when compiling with gcc 2.95 which is still used on some
82     platforms. Initial patch submitted by Simon South in #3564815.
83   - Optionally try to sanity-check strptime() results before trusting them.
84     Broken strptime() implementations have caused problems in the past and
85     the most recent offender seems to be FreeBSD's libc (standards/173421).
86   - When filtering is enabled, let Range headers pass if the range starts at
87     the beginning. This should work around (or at least reduce ) the video
88     playback issues with various Apple clients as reported by Duc in #3426305.
89   - Do not confuse a client hanging up with a connection time out. If a client
90     closes its side of the connection without sending a request line, do not
91     send the CLIENT_CONNECTION_TIMEOUT_RESPONSE, but report the condition
92     properly.
93   - Allow closing curly braces as part of action values as long as they are
94     escaped.
95   - On Windows, the logfile is now written before showing the GUI error
96     message which blocks until the user acknowledges it.
97     Reported by Adriaan in #3593603.
98   - Remove an unreasonable parameter limit in the CGI interface. The new
99     parameter limit depends on the memory available and is currently unlikely
100     to be reachable, due to other limits in both Privoxy and common clients.
101     Reported by Andrew on ijbswa-users@.
102   - Decrease the chances of parse failures after requests with unsupported
103     methods were sent to the CGI interface.
104
105 - Action file improvements:
106   - Remove the comment that indicated that updated default.action versions
107     are released on their own.
108   - Block 'optimize.indieclick.com/' and 'optimized-by.rubiconproject.com/'
109   - Unblock 'adjamblog.wordpress.com/' and 'adjamblog.files.wordpress.com/'.
110     Reported by Ryan Farmer in #3496116.
111   - Unblock '/.*Bugtracker'. Reported by pwhk in #3522341.
112   - Add test URLs for '.freebsd.org' and '.watson.org'.
113   - Unblock '.urbandictionary.com/popular'.
114   - Block '.adnxs.com/'.
115   - Block 'farm.plista.com/widgetdata.php'.
116   - Block 'rotation.linuxnewmedia.com/'.
117   - Block 'reklamy.sfd.pl/'. Reported by kacperdominik in #3399948.
118   - Block 'g.adspeed.net/'.
119   - Unblock 'websupport.wdc.com/'. Reported by Adam Piggot in #3577851.
120   - Block '/openx/www/delivery/'.
121   - Disable fast-redirects for '.googleapis.com/'.
122   - Block 'imp.double.net/'. Reported by David Bo in #3070411.
123   - Block 'gm-link.com/' whis is used for email tracking.
124     Reported by David Bo in #1812733.
125   - Verify that requests to "bwp." are blocked. URL taken from #1736879
126     submitted by Francois Marier.
127   - Block '/.*bannerid='. Reported by Adam Piggott in #2975779.
128   - Block 'cltomedia.info/delivery/' and '.adexprt.com/'.
129     Anonymously reported in #2965254.
130   - Block 'de17a.com/'. Reported by David Bo in #3061472.
131   - Block 'oskar.tradera.com/'. Reported by David Bo in #3060596.
132   - Block '/scripts/webtrends\.js'. Reported by johnd16 in #3002729.
133   - Block requests for 'pool.*.adhese.com/'. Reported by johnd16 in #3002716.
134   - Update path pattern for Coremetrics and add tests.
135     Pattern and URLs submitted by Adam Piggott #3168443.
136   - Enable +fast-redirects{check-decoded-url} for 'tr.anp.se/'.
137     Reported by David Bo in #3268832.
138   - Unblock '.conrad.se/newsletter/banners/'. Reported by David Bo in #3413824.
139   - Block '.tynt.com/'. Reported by Dan Stahlke in #3421767.
140   - Unblock '.bbci.co.uk/radio/'. Reported by Adam Piggott in #3569603.
141   - Block requests to 'service.maxymiser.net/'.
142     Reported by johnd16 in #3118401 (with a previous URL).
143   - Disable fast-redirects for Google's "let's pretend your computer is
144     infected" page.
145   - Unblock '/.*download' to resolve actionsfile feedback #3498129.
146     Submitted by Steven Kolins (soundcloud.com not working).
147   - Unblock '.wlxrs.com/' which is required by hotmail.com.
148     Fixes #3413827 submitted by David Bo.
149   - Add two unblock patterns for popup radio and TV players.
150     Submitted by Adam Piggott in #3596089.
151
152 - Filter file improvements & bug fixes:
153   - Add a referer tagger.
154   - Reduce the likelihood that the google filter messes up HTML-generating
155     JavaScript. Reported by Zeno Kugy in #3520260.
156
157 - Documentation improvements:
158   - Revised all OS X sections due to new packaging module (OSXPackageBuilder).
159   - Update the list of supported operating systems to clarify that all Windows
160     versions after 95 are expected to work and note that the platform-specific
161     code for AmigaOS and QNX currently isn't maintained.
162   - Update 'Signals' section, the only explicitly handled signals are SIGINT,
163     SIGTERM and SIGHUP.
164   - Add Haiku to the list of operating systems on which Privoxy is known to
165     run.
166   - Add DragonFly to the list of BSDs on which Privoxy is known to run.
167   - Removed references to redhat-specific documentation set since it no longer
168     exists.
169   - Removed references to building PDFs since we no longer do so.
170   - Multiple listen-address directives are supported since 3.0.18, correct the
171     documentation to say so.
172   - Remove bogus section about long and short being preferable to int.
173   - Corrected some Internet JunkBuster references to Privoxy.
174   - Removed references to www.junkbusters.com since it is no longer
175     maintained. Reported by Angelina Matson.
176   - Various grammar and spelling corrections
177   - Add a client-header-tagger{} example for disabling filtering for range
178     requests.
179   - Correct a URL in the "Privoxy with Tor" FAQ.
180   - Spell 'refresh-tags' correctly. Reported by Don in #3571927.
181   - Sort manpage options alphabetically.
182   - Remove an incorrect sentence in the toggle section. The toggle state
183     doesn't affect whether or not the Windows version uses the tray icon.
184     Reported by Zeno Kugy in #3596395.
185   - Add new contributors since 3.0.19.
186
187 - Log message improvements:
188   - When stopping to watch a client socket due to pipelining, additionally log
189     the socket number.
190   - Log the client socket and its condition before closing it. This makes it
191     more obvious that the socket actually gets closed and should help when
192     diagnosing problems like #3464439.
193   - In case of SOCKS5 failures, do not explicitly log the server's response.
194     It hasn't helped so far and the response can already be logged by enabling
195     "debug 32768" anyway. This reverts v1.81 and the follow-up bug fix v1.84.
196   - Relocate the connection-accepted message from listen_loop() to serve().
197     This way it's printed by the thread that is actually serving the
198     connection which is nice when grepping for thread ids in log files.
199
200 - Code cleanups:
201   - Remove compatibility layer for versions prior to 3.0 since it has been
202     obsolete for more than 10 years now.
203   - Remove the ijb_isupper() and ijb_tolower() macros from parsers.c since
204     they aren't used in this file.
205   - Removed the 'Functions declared include:' comment sections since they tend
206     to be incomplete, incorrect and out of date and the benefit seems
207     questionable.
208   - Various comment grammar and comprehensibility improvements.
209   - Remove a pointless fflush() call in chat(). Flushing all streams pretty
210     much all the time for no obvious reason is ridiculous.
211   - Relocate ijb_isupper()'s definition to project.h and get the ijb_tolower()
212     definition from there, too.
213   - Relocate ijb_isdigit()'s definition to project.h.
214   - Rename ijb_foo macros to privoxy_foo.
215   - Add malloc_or_die() which will allow to simplify code paths where malloc()
216     failures don't need to be handled gracefully.
217   - Add strdup_or_die() which will allow to simplify code paths where strdup()
218     failures don't need to be handled gracefully.
219   - Replace strdup() calls with strdup_or_die() calls where it's safe and
220     simplifies the code.
221   - Fix white-space around parentheses.
222   - Add missing white-space behind if's and the following parentheses.
223   - Unwrap a memcpy() call in resolve_hostname_to_ip().
224   - Declare pcrs_get_delimiter()'s delimiters[] static const.
225   - Various optimisations to remove dead code and merge inefficient code
226     structures for improved clarity, performance or code compactness.
227   - Various data type corrections.
228   - Change visibility of several code segments when compiling without
229     FEATURE_CONNECTION_KEEP_ALIVE enabled for clarity.
230   - In pcrs_get_delimiter(), do not use delimiters ouside the ASCII range.
231     Fixes a clang complaint.
232   - Fix an error message in get_last_url() nobody is supposed to see.
233     Reported by Matthew Fischer in #3507301.
234   - Fix a typo in the no-zlib-support complaint. Patch submitted by Matthew
235     Fischer in #3507304.
236   - Shorten ssplit()'s prototype by removing the last two arguments. We always
237     want to skip empty fields and ignore leading delimiters, so having
238     parameters for this only complicates the API.
239   - Use an enum for the type of the action value.
240   - Rename action_name's member takes_value to value_type as it isn't used as
241     boolean.
242   - Turn family mismatches in match_sockaddr() into fatal errors.
243   - Let enlist_unique_header() verify that the caller didn't pass a header
244     containing either \r or \n.
245   - Change the hashes used in load_config() to unsigned int. That's what
246     hash_string() actually returns and using a potentiallly larger type
247     is at best useless.
248   - Use privoxy_tolower() instead of vanilla tolower() with manual casting of
249     the argument.
250   - Catch ssplit() failures in parse_cgi_parameters().
251
252 - Privoxy-Regression-Test:
253   - Add an 'Overwrite condition' directive to skip any matching tests before
254     it. As it has a global scope, using it is more convenient than clowning
255     around with the Ignore directive.
256   - Log to STDOUT instead of STDERR.
257   - Include the Privoxy version in the output.
258   - Various grammar and spelling corrections in documentation and code.
259   - Additional tests for range requests with filtering enabled.
260   - Tests with mostly invalid range request.
261   - Add a couple of hide-if-modified-since{} tests with different date formats.
262   - Cleaned up the format of the regression-tests.action file to match the
263     format of default.action.
264   - Remove the "Copyright" line from print_version(). When using --help, every
265     line of screen space matters and thus shouldn't be wasted on things the
266     user doesn't care about.
267
268 - Privoxy-Log-Parser:
269   - Improve the --statistics performance by skipping sanity checks for input
270     that shouldn't affect the results anyway. Add a --strict-checks option
271     that enables some of the checks again, just in case anybody cares.
272   - The distribution of client requests per connection is included in
273     the --statistic output.
274   - The --accept-unknown-messages option has been removed and the behavior
275     is now the default.
276   - Accept and (mostly) highlight new log messages introduced with
277     Privoxy 3.0.20.
278
279 - uagen:
280   - Bump generated Firefox version to 17.
281
282 - GNUmakefile improvements:
283   - The dok-tidy target no longer taints documents with a tidy-mark
284   - Change RA_MODE from 0664 to 0644. Suggested by Markus Dittrich in
285     #3505445.
286   - Remove tidy's clean flag as it changes the scope of attributes.
287     Link-specific colors end up being applied to all text. Reported by Adam
288     Piggott in #3569551.
289   - Leave it up to the user whether or not smart tags are inserted.
290   - Let w3m itself do the line wrapping for the config file. It works better
291     than fmt as it can honour pre tags causing less unintentional line breaks.
292   - Ditch a pointless '-r' passed to rm to delete files.
293   - The config-file target now requires less manual intervention and updates
294     the original config.
295   - Change WDUMP to generate ASCII. Add WDUMP_UTF8 to allow UTF-8 in the
296     AUTHORS file so the names are right.
297   - Stop pretending that lynx and links are supported for the documentation.
298
299 - configure improvements:
300   - On Haiku, do not pass -lpthread to the compiler. Haiku's pthreads
301     implementation is contained in its system library, libroot, so no
302     additional library needs to be searched.
303     Patch submitted by Simon South in #3564815.
304   - Additional Haiku-specific improvements. Disable checks intended for
305     multi-user systems as Haiku is presently single-user. Group Haiku-specific
306     settings in their own section, following the pattern for Solaris, OS/2 and
307     AmigaOS. Add additional library-related settings to remove the need for
308     providing configure with custom LDFLAGS.
309     Submitted by Simon South in #3574538.
310
311 -----------------------------------------------------------------
312 About Privoxy:
313 -----------------------------------------------------------------
314
315 Privoxy is a non-caching web proxy with advanced filtering capabilities for
316 enhancing privacy, modifying web page data and HTTP headers, controlling
317 access, and removing ads and other obnoxious Internet junk. Privoxy has a
318 flexible configuration and can be customized to suit individual needs and
319 tastes. It has application for both stand-alone systems and multi-user
320 networks.
321
322 Privoxy is Free Software and licensed under the GNU GPLv2.
323
324 Privoxy is an associated project of Software in the Public Interest (SPI).
325
326 Helping hands and donations are welcome:
327
328   * http://www.privoxy.org/faq/general.html#PARTICIPATE
329
330   * http://www.privoxy.org/faq/general.html#DONATE
331
332 At present, Privoxy is known to run on Windows(95, 98, ME, 2000,
333 XP, Vista), GNU/Linux (Ubuntu, RedHat, SuSE, Debian, Fedora, Gentoo and
334 others), Mac OSX, OS/2, AmigaOS, FreeBSD, NetBSD, OpenBSD, Solaris, and
335 various other flavors of Unix.
336
337 In addition to the core features of ad blocking and cookie management,
338 Privoxy provides many supplemental features, that give the end-user
339 more control, more privacy and more freedom:
340
341
342     *  Supports "Connection: keep-alive". Outgoing connections can be kept
343        alive independently from the client. Currently not available on all
344        platforms.
345
346     *  Supports IPv6, provided the operating system does so too,
347        and the configure script detects it.
348
349     *  Supports tagging which allows to change the behaviour based on client
350        and server headers.
351
352     *  Can be run as an "intercepting" proxy, which obviates the need to
353        configure browsers individually.
354
355     *  Sophisticated actions and filters for manipulating both server and
356        client headers.
357
358     *  Can be chained with other proxies.
359
360     *  Integrated browser based configuration and control utility at
361        http://config.privoxy.org/ (shortcut: http://p.p/). Browser-based
362        tracing of rule and filter effects. Remote toggling.
363
364     *  Web page filtering (text replacements, removes banners based on size,
365        invisible <quote>web-bugs</quote> and HTML annoyances, etc.)
366
367     *  Modularized configuration that allows for standard settings and user
368        settings to reside in separate files, so that installing updated actions
369        files won't overwrite individual user settings.
370
371     *  Support for Perl Compatible Regular Expressions in the configuration
372        files, and a more sophisticated and flexible configuration syntax.
373
374     *  GIF de-animation.
375
376     *  Bypass many click-tracking scripts (avoids script redirection).
377
378     *  User-customizable HTML templates for most proxy-generated pages (e.g.
379        "blocked" page).
380
381     *  Auto-detection and re-reading of config file changes.
382     
383     *  Most features are controllable on a per-site or per-location basis.
384     
385
386 Download location: 
387    http://sourceforge.net/project/showfiles.php?group_id=11118
388  
389 Home Page: 
390    http://www.privoxy.org/
391
392
393   - Privoxy Developers <ijbswa-developers@lists.sourceforge.net>