doc/source/changelog.sgml

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