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