add version 3.0.26 change log
[privoxy.git] / doc / source / changelog.sgml
1 <!--
2  File        :  $Source: /cvsroot/ijbswa/current/doc/source/changelog.sgml,v $
3
4  Purpose     :  Entity included in other project documents.
5
6  $Id: changelog.sgml,v 2.20 2016/05/27 17:27:55 fabiankeil Exp $
7
8  Copyright (C) 2013-2016 Privoxy Developers https://www.privoxy.org/
9  See LICENSE.
10
11  ======================================================================
12   This file used for inclusion with other documents only.
13  ======================================================================
14
15  If you make changes to this file, please verify the finished
16  docs all display as intended.
17
18  This file is included into:
19
20   user-manual
21 -->
22
23
24 <!--
25  The SGML ChangeLog can be generated with: utils/changelog2doc.pl ChangeLog
26 -->
27
28 <para>
29   <application>Privoxy 3.0.26</application> changes
30   <itemizedlist>
31     <listitem>
32       <para>
33         Bug fixes:
34         <itemizedlist>
35           <listitem>
36             <para>
37               accept_connection(): Fix crashes with "listen-addr :8118"
38             </para>
39             <para>
40               After jbsockets.c v1.136 a valid text representation of
41               the host address is required for the $listen-address
42               variable. If no host address has been specified, use an
43               empty string to prevent NULL pointer dereferences.
44             </para>
45             <para>
46               The problem was reported by Marvin Renich in Debian bug #834941,
47               the offending commit was tracked down by Roland in SF Bug #902.
48             </para>
49           </listitem>
50         </itemizedlist>
51       </para>
52     </listitem>
53
54     <listitem>
55       <para>
56         General improvements:
57         <itemizedlist>
58           <listitem>
59             <para>
60               Log when privoxy is toggled on or off via cgi interface.
61             </para>
62           </listitem>
63           <listitem>
64             <para>
65               Highlight the "Info: Now toggled " on/off log message in the windows log viewer.
66             </para>
67           </listitem>
68           <listitem>
69             <para>
70               Highlight the loading actions/filter file log message in the windows log viewer.
71             </para>
72           </listitem>
73           <listitem>
74             <para>
75               Mention client-specific tags on the toggle page as a potentionally more appropriate alternative.
76             </para>
77           </listitem>
78         </itemizedlist>
79       </para>
80     </listitem>
81
82     <listitem>
83       <para>
84         Documentation improvements:
85         <itemizedlist>
86           <listitem>
87             <para>
88               Update download section on the homepage.
89               The downloads are available from the website now.
90             </para>
91           </listitem>
92           <listitem>
93             <para>
94               Add sponsor FAQ
95             </para>
96           </listitem>
97           <listitem>
98             <para>
99               Remove obsolete reference to mailing lists hosted at SourceForge
100             </para>
101           </listitem>
102           <listitem>
103             <para>
104               Update the "Before the Release" section of the developer manual.
105             </para>
106           </listitem>
107         </itemizedlist>
108       </para>
109     </listitem>
110
111     <listitem>
112       <para>
113         Infrastructure improvements:
114         <itemizedlist>
115           <listitem>
116             <para>
117               Add perl script to generate an RSS feed for the packages
118             </para>
119             <para>
120               Submitted by "Unknown":
121               https://lists.privoxy.org/pipermail/privoxy-devel/2016-July/000068.html
122             </para>
123           </listitem>
124         </itemizedlist>
125       </para>
126     </listitem>
127
128     <listitem>
129       <para>
130         Build system improvements:
131         <itemizedlist>
132           <listitem>
133             <para>
134               strptime.h: fix a compiler warning about ambiguous else
135             </para>
136           </listitem>
137           <listitem>
138             <para>
139               configure.in: Check for Docbook goo on the BSDs as well
140             </para>
141           </listitem>
142           <listitem>
143             <para>
144               GNUMakefile.in: Let the dok-user target remove temporary files
145             </para>
146           </listitem>
147         </itemizedlist>
148       </para>
149     </listitem>
150   </itemizedlist>
151 </para>
152
153
154
155 <para>
156   <application>Privoxy 3.0.25</application> beta introduces client-specific
157   tags and includes a couple of minor improvements. It will be followed
158   by a stable release in the near future.
159 </para>
160 <para>
161  <itemizedlist>
162   <listitem>
163    <para>
164     Bug fixes:
165     <itemizedlist>
166     <listitem>
167      <para>
168       Always use the current toggle state for new requests.
169       Previously new requests on reused connections inherited
170       the toggle state from the previous request even though
171       the toggle state could have changed.
172       Reported by Robert Klemme.
173      </para>
174     </listitem>
175     <listitem>
176      <para>
177       Fixed two buffer-overflows in the (deprecated) static
178       pcre code. These bugs are not considered security issues
179       as the input is trusted.
180       Found with afl-fuzz and ASAN.
181      </para>
182      </listitem>
183     </itemizedlist>
184    </para>
185   </listitem>
186   <listitem>
187    <para>
188     General improvements:
189     <itemizedlist>
190     <listitem>
191      <para>
192       Added support for client-specific tags which allow Privoxy
193       admins to pre-define tags that are set for all requests from
194       clients that previously opted in through the CGI interface.
195       They are useful in multi-user setups where admins may
196       want to allow users to disable certain actions and filters
197       for themselves without affecting others.
198       In single-user setups they are useful to allow more fine-grained
199       toggling. For example to disable request blocking while still
200       crunching cookies, or to disable experimental filters only.
201       This is an experimental feature, the syntax and behaviour may
202       change in future versions.
203       Sponsored by Robert Klemme.
204      </para>
205     </listitem>
206     <listitem>
207      <para>
208       Dynamic filters and taggers now support a $listen-address variable
209       which contains the address the request came in on.
210       For external filters the variable is called $PRIVOXY_LISTEN_ADDRESS.
211       Original patch contributed by pursievro.
212      </para>
213     </listitem>
214     <listitem>
215      <para>
216       Add client-header-tagger 'listen-address'.
217      </para>
218     </listitem>
219     <listitem>
220      <para>
221       Include the listen-address in the log message when logging new requests.
222       Patch contributed by pursievro.
223      </para>
224     </listitem>
225     <listitem>
226      <para>
227       Turn invalid max-client-connections values into fatal errors.
228      </para>
229     </listitem>
230     <listitem>
231      <para>
232       The show-status page now shows whether or not dates before 1970
233       and after 2038 are expected to be handled properly.
234       This is mainly useful for Privoxy-Regression-Test but could
235       also come handy when dealing with time-related support requests.
236      </para>
237     </listitem>
238     <listitem>
239      <para>
240       On Mac OS X the thread id in log messages are more likely to
241       be unique now.
242      </para>
243     </listitem>
244     <listitem>
245      <para>
246       When complaining about missing filters, the filter type is logged
247       as well.
248      </para>
249     </listitem>
250     <listitem>
251      <para>
252       A couple of harmless coverity warnings were silenced
253       (CID #161202, CID #161203, CID #161211).
254      </para>
255      </listitem>
256     </itemizedlist>
257    </para>
258   </listitem>
259   <listitem>
260    <para>
261     Action file improvements:
262     <itemizedlist>
263     <listitem>
264      <para>
265       Filtering is disabled for Range requests to let download resumption
266       and Windows updates work with the default configuration.
267      </para>
268     </listitem>
269     <listitem>
270      <para>
271       Unblock ".ardmediathek.de/".
272       Reported by ThTomate in #932.
273      </para>
274      </listitem>
275     </itemizedlist>
276    </para>
277   </listitem>
278   <listitem>
279    <para>
280     Documentation improvements:
281     <itemizedlist>
282     <listitem>
283      <para>
284       Add FAQ entry for crashes caused by memory limits.
285      </para>
286     </listitem>
287     <listitem>
288      <para>
289       Remove obsolete FAQ entry about a bug in PHP 4.2.3.
290      </para>
291     </listitem>
292     <listitem>
293      <para>
294       Mention the new mailing lists were appropriate.
295       As the archives have not been migrated, continue to
296       mention the archives at SF in the contacting section
297       for now.
298      </para>
299     </listitem>
300     <listitem>
301      <para>
302       Note that the templates should be adjusted if Privoxy is
303       running as intercepting proxy without getting all requests.
304      </para>
305     </listitem>
306     <listitem>
307      <para>
308       A bunch of links were converted to https://.
309      </para>
310     </listitem>
311     <listitem>
312      <para>
313       Rephrase onion service paragraph to make it more obvious
314       that Tor is involved and that the whole website (and not
315       just the homepage) is available as onion service.
316      </para>
317     </listitem>
318     <listitem>
319      <para>
320       Streamline the "More information" section on the homepage further
321       by additionally ditching the link to the 'See also' section
322       of the user manual. The section contains mostly links that are
323       directly reachable from the homepage already and the rest is
324       not significant enough to get a link from the homepage.
325      </para>
326     </listitem>
327     <listitem>
328      <para>
329       Change the add-header{} example to set the DNT header
330       and use a complete section to make copy and pasting
331       more convenient.
332       Add a comment to make it obvious that adding the
333       header is not recommended for obvious reasons.
334       Using the DNT header as example was suggested by
335       Leo Wzukw.
336      </para>
337     </listitem>
338     <listitem>
339      <para>
340       Streamline the support-and-service template
341       Instead of linking to the various support trackers
342       (whose URLs hopefully change soon), link to the
343       contact section of the user manual to increase the
344       chances that users actually read it.
345      </para>
346     </listitem>
347     <listitem>
348      <para>
349       Add a FAQ entry for tainted sockets.
350      </para>
351     </listitem>
352     <listitem>
353      <para>
354       More sections in the documentation have stable URLs now.
355      </para>
356     </listitem>
357     <listitem>
358      <para>
359       FAQ: Explain why 'ping config.privoxy.org' is not expected
360       to reach a local Privoxy installation.
361      </para>
362     </listitem>
363     <listitem>
364      <para>
365       Note that donations done through Zwiebelfreunde e.V. currently
366       can't be checked automatically.
367      </para>
368     </listitem>
369     <listitem>
370      <para>
371       Updated section regarding starting Privoxy under OS X.
372      </para>
373     </listitem>
374     <listitem>
375      <para>
376       Use dedicated start instructions for FreeBSD and ElectroBSD.
377      </para>
378     </listitem>
379     <listitem>
380      <para>
381       Removed release instructions for AIX. They haven't been working
382       for years and unsurprisingly nobody seems to care.
383      </para>
384     </listitem>
385     <listitem>
386      <para>
387       Removed obsolete reference to the solaris-dist target.
388      </para>
389     </listitem>
390     <listitem>
391      <para>
392       Updated the release instructions for FreeBSD.
393      </para>
394     </listitem>
395     <listitem>
396      <para>
397       Removed unfinished release instructions for Amiga OS and HP-UX 11.
398      </para>
399     </listitem>
400     <listitem>
401      <para>
402       Added a pointer to the Cygwin Time Machine for getting the last release of
403       Cygwin version 1.5 to use for building Privoxy on Windows.
404      </para>
405     </listitem>
406     <listitem>
407      <para>
408       Various typos have been fixed.
409      </para>
410      </listitem>
411     </itemizedlist>
412    </para>
413   </listitem>
414   <listitem>
415    <para>
416     Infrastructure improvements:
417     <itemizedlist>
418     <listitem>
419      <para>
420       The website is no longer hosted at SourceForge and
421       can be reached through https now.
422      </para>
423     </listitem>
424     <listitem>
425      <para>
426       The mailing lists at SourceForge have been deprecated,
427       you can subscribe to the new ones at: https://lists.privoxy.org/
428      </para>
429     </listitem>
430     <listitem>
431      <para>
432       Migrating the remaining services from SourceForge is
433       work in progress (TODO list item #53).
434      </para>
435      </listitem>
436     </itemizedlist>
437    </para>
438   </listitem>
439   <listitem>
440    <para>
441     Build system improvements:
442     <itemizedlist>
443     <listitem>
444      <para>
445       Add configure argument to optimistically redefine FD_SETSIZE
446       with the intent to change the maximum number of client
447       connections Privoxy can handle. Only works with some libcs.
448       Sponsored by Robert Klemme.
449      </para>
450     </listitem>
451     <listitem>
452      <para>
453       Let the tarball-dist target skip files in ".git".
454      </para>
455     </listitem>
456     <listitem>
457      <para>
458       Let the tarball-dist target work in cwds other than current.
459      </para>
460     </listitem>
461     <listitem>
462      <para>
463       Make the 'clean' target faster when run from a git repository.
464      </para>
465     </listitem>
466     <listitem>
467      <para>
468       Include tools in the generic distribution.
469      </para>
470     </listitem>
471     <listitem>
472      <para>
473       Let the gen-dist target work in cwds other than current.
474      </para>
475     </listitem>
476     <listitem>
477      <para>
478       Sort find output that is used for distribution tarballs
479       to get reproducible results.
480      </para>
481     </listitem>
482     <listitem>
483      <para>
484       Don't add '-src' to the name of the tar ball generated by the
485       gen-dist target. The package isn't a source distribution but a
486       binary package.
487       While at it, use a variable for the name to reduce the chances
488       that the various references get out of sync and fix the gen-upload
489       target which was looking in the wrong directory.
490      </para>
491     </listitem>
492     <listitem>
493      <para>
494       Add regression-tests.action to the files that are distributed.
495      </para>
496     </listitem>
497     <listitem>
498      <para>
499       The gen-dist target which was broken since 2002 (r1.92) has been fixed.
500      </para>
501     </listitem>
502     <listitem>
503      <para>
504       Remove genclspec.sh which has been obsolete since 2009.
505      </para>
506     </listitem>
507     <listitem>
508      <para>
509       Remove obsolete reference to Redhat spec file.
510      </para>
511     </listitem>
512     <listitem>
513      <para>
514       Remove the obsolete announce target which has been commented out years ago.
515      </para>
516     </listitem>
517     <listitem>
518      <para>
519       Let rsync skip files if the checksums match.
520      </para>
521      </listitem>
522     </itemizedlist>
523    </para>
524   </listitem>
525   <listitem>
526    <para>
527     Privoxy-Regression-Test:
528     <itemizedlist>
529     <listitem>
530      <para>
531       Add a "Default level offset" directive which can be used to
532       change the default level by a given value.
533       This directive affects all tests located after it until the end
534       of the file or a another "Default level offset" directive is reached.
535       The purpose of this directive is to make it more convenient to skip
536       similar tests in a given file without having to remove or disable
537       the tests completely.
538      </para>
539     </listitem>
540     <listitem>
541      <para>
542       Let test level 17 depend on FEATURE_64_BIT_TIME_T
543       instead of FEATURE_PTHREAD which has no direct connection
544       to the time_t size.
545      </para>
546     </listitem>
547     <listitem>
548      <para>
549       Fix indentation in perldoc examples.
550      </para>
551     </listitem>
552     <listitem>
553      <para>
554       Don't overlook directives in the first line of the action file.
555      </para>
556     </listitem>
557     <listitem>
558      <para>
559       Bump version to 0.7.
560      </para>
561     </listitem>
562     <listitem>
563      <para>
564       Fix detection of the Privoxy version now that https://
565       is used for the website.
566      </para>
567      </listitem>
568     </itemizedlist>
569    </para>
570   </listitem>
571  </itemizedlist>
572 </para>